Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

On-demand feature struct allocation #696

Merged
merged 1 commit into from
Aug 19, 2024
Merged

On-demand feature struct allocation #696

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 4 additions & 16 deletions core/feature.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,10 +28,6 @@ type Features struct {
BlueprintEmbed interface{}
}

type singleFeature struct {
BlueprintEmbed interface{}
}

func typesOf(list ...interface{}) []reflect.Type {
types := make([]reflect.Type, len(list))
for i, element := range list {
Expand Down Expand Up @@ -71,20 +67,14 @@ func (f *Features) Init(properties *config.Properties, list ...interface{}) {
for i, featureName := range properties.FeatureList {
fields[i] = reflect.StructField{
Name: featurePropertyName(featureName),
Type: reflect.TypeOf(singleFeature{}),
Type: reflect.PtrTo(propsType),
}
}

bpFeatureStruct := reflect.StructOf(fields)
instancePtr := reflect.New(bpFeatureStruct)
f.BlueprintEmbed = instancePtr.Interface()

instance := reflect.Indirect(instancePtr)
for i := range properties.FeatureList {
propsInFeature := instance.Field(i).Addr().Interface().(*singleFeature)
propsInFeature.BlueprintEmbed = reflect.New(propsType).Interface()
}

}

// Set internal `BlueprintEmbed` field to nil.
Expand Down Expand Up @@ -174,13 +164,11 @@ func (f *Features) AppendProps(dst []interface{}, properties *config.Properties)
if !featureStruct.IsValid() {
utils.Die("Field returned for property %s isn't valid\n", featureFieldName)
}
// AppendProperties expects a pointer to a struct.
featureStructPointer := featureStruct.FieldByName("BlueprintEmbed").Interface()

// If featureProps is nil then we've determined that we can skip this,
// so avoid calling AppendProperties
if featureStructPointer != nil {
err := AppendMatchingProperties(dst, featureStructPointer)
// so avoid calling AppendMatchingProperties
if !featureStruct.IsNil() {
err := AppendMatchingProperties(dst, featureStruct.Interface())
if err != nil {
return err
}
Expand Down
32 changes: 22 additions & 10 deletions core/feature_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,14 +56,19 @@ func (features *Features) injectData(featureName string, path string, data inter
panic(fmt.Sprintf("invalid '%s'\n", path))
}

propsInFeatureVal := allFeatures.FieldByName(featureName)
if !propsInFeatureVal.IsValid() {
value := allFeatures.FieldByName(featureName)
if !value.IsValid() {
printDebug(reflect.ValueOf(allFeatures))
panic(fmt.Sprintf("Couldn't find struct for feature '%s'", featureName))
}
propsInFeature := propsInFeatureVal.Interface().(singleFeature)

value := reflect.ValueOf(propsInFeature.BlueprintEmbed).Elem()
if value.IsNil() {
// Blueprint would automatically allocate structs when their
// pointers are nil - do the same here
value.Set(reflect.New(value.Type().Elem()))
}
// Dereference the pointer to the property struct
value = value.Elem()

for _, name := range strings.Split(path, ".") {
previous := value
Expand Down Expand Up @@ -121,7 +126,7 @@ func createTestModuleAndFeatures() (testProps, config.Properties) {

properties := enabledFeatures(featuresNames...)

module.Init(&properties,
module.Features.Init(&properties,
testPropsGroupA{},
testPropsGroupB{},
testPropsGroupC{},
Expand Down Expand Up @@ -164,7 +169,7 @@ func Test_should_not_change_when_appending_empty_features(t *testing.T) {
module, properties := createTestModuleAndFeatures()

// BlueprintEmbed must be inited! So BlueprintEmbed can't be nil!
module.Init( // Just make new Init so we will have "empty structure"
module.Features.Init( // Just make new Init so we will have "empty structure"
&properties,
testPropsGroupA{},
testPropsGroupB{},
Expand Down Expand Up @@ -436,13 +441,14 @@ func Test_should_composite_new_type(t *testing.T) {

// We need to init all available features (important)
properties := enabledFeatures("feature_compose")
module.Init(&properties,
module.Features.Init(&properties,
testPropsGroupA{},
testPropsGroupB{},
)

featuresStruct := reflect.ValueOf(module.Features.BlueprintEmbed).Elem()
// Uncomment if you want to "view for development purposes"
//printDebug(reflect.ValueOf(module.BlueprintEmbed).Elem())
//printDebug(featuresStruct)
// Above function will print:
// {
// Feature_compose: struct { FieldA string; FieldC string; FieldF string; FieldB string }
Expand All @@ -454,9 +460,15 @@ func Test_should_composite_new_type(t *testing.T) {
// }
// }

feature := featuresStruct.FieldByName("Feature_compose")
// Allocate the property struct for this feature so we can set its
// properties
feature.Set(reflect.New(feature.Type().Elem()))

// Dereference the pointer to the property struct
feature = feature.Elem()

// Below code shouldn't fail
propsInFeature := reflect.ValueOf(module.BlueprintEmbed).Elem().FieldByName("Feature_compose").Interface().(singleFeature)
feature := reflect.ValueOf(propsInFeature.BlueprintEmbed).Elem()
feature.FieldByName("FieldA").SetString("+value_a")
feature.FieldByName("FieldB").SetString("+value_b")
}
Loading