Fix missing odata type for externalTenants configuration #264
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Without setting the correct @odata.type for both possible values all and enumerated, a patch will fail when first enumerating and setting members and then changing to type all because the stored object is of the wrong type. References manicminer#261
manicminer
requested changes
Oct 26, 2023
There was a problem hiding this comment.
@agileknight Thanks again for working on this. This mostly LGTM, just a couple of refactoring suggestions below if you can take a look?
msgraph/models.go
Outdated
Comment on lines
735
to
754
| const externalTenantsTypeAll = "#microsoft.graph.conditionalAccessAllExternalTenants" | ||
| const externalTenantsTypeEnumerated = "#microsoft.graph.conditionalAccessEnumeratedExternalTenants" | ||
| setExternalTenantsObjectType := func(c *conditionalAccessGuestsOrExternalUsers) { | ||
| if c == nil { | ||
| return | ||
| } | ||
| if c.ExternalTenants == nil { | ||
| return | ||
| } | ||
| if c.ExternalTenants.MembershipKind == nil { | ||
| return | ||
| } | ||
| switch *c.ExternalTenants.MembershipKind { | ||
| case ConditionalAccessExternalTenantsMembershipKindAll: | ||
| c.ExternalTenants.ODataType = utils.StringPtr(externalTenantsTypeAll) | ||
| case ConditionalAccessExternalTenantsMembershipKindEnumerated: | ||
| c.ExternalTenants.ODataType = utils.StringPtr(externalTenantsTypeEnumerated) | ||
| } | ||
| } | ||
| setExternalTenantsObjectType(guestOrExternalUsers.conditionalAccessGuestsOrExternalUsers) |
There was a problem hiding this comment.
As there's no need for reusability here, could we simplify this by forgoing the constant declarations and move the if+switch blocks out into the parent method, dropping the anonymous func? The anonymous struct embeds a pointer to the original struct so this should work?
Suggested change
| const externalTenantsTypeAll = "#microsoft.graph.conditionalAccessAllExternalTenants" | |
| const externalTenantsTypeEnumerated = "#microsoft.graph.conditionalAccessEnumeratedExternalTenants" | |
| setExternalTenantsObjectType := func(c *conditionalAccessGuestsOrExternalUsers) { | |
| if c == nil { | |
| return | |
| } | |
| if c.ExternalTenants == nil { | |
| return | |
| } | |
| if c.ExternalTenants.MembershipKind == nil { | |
| return | |
| } | |
| switch *c.ExternalTenants.MembershipKind { | |
| case ConditionalAccessExternalTenantsMembershipKindAll: | |
| c.ExternalTenants.ODataType = utils.StringPtr(externalTenantsTypeAll) | |
| case ConditionalAccessExternalTenantsMembershipKindEnumerated: | |
| c.ExternalTenants.ODataType = utils.StringPtr(externalTenantsTypeEnumerated) | |
| } | |
| } | |
| setExternalTenantsObjectType(guestOrExternalUsers.conditionalAccessGuestsOrExternalUsers) | |
| if c.ExternalTenants != nil && c.ExternalTenants.MembershipKind != nil { | |
| switch *c.ExternalTenants.MembershipKind { | |
| case ConditionalAccessExternalTenantsMembershipKindAll: | |
| c.ExternalTenants.ODataType = utils.StringPtr("#microsoft.graph.conditionalAccessAllExternalTenants") | |
| case ConditionalAccessExternalTenantsMembershipKindEnumerated: | |
| c.ExternalTenants.ODataType = utils.StringPtr("#microsoft.graph.conditionalAccessEnumeratedExternalTenants") | |
| } | |
| } |
Comment on lines
203
to
212
| func assertJsonMarshalEquals(t *testing.T, value interface{}, expected string) { | ||
| bytes, err := json.MarshalIndent(value, "", " ") | ||
| if err != nil { | ||
| t.Fatalf("Marshalling failed with error %s", err) | ||
| } | ||
| actual := string(bytes) | ||
| if actual != expected { | ||
| t.Errorf("Expected marshalled json to equal %s but was %s", expected, actual) | ||
| } | ||
| } |
There was a problem hiding this comment.
This might be a useful function to move into the internal/test package?
…per function to test package
manicminer
approved these changes
Oct 26, 2023
There was a problem hiding this comment.
@agileknight I hope you don't mind, in the interest of getting this in for a release today, I've committed my review suggestions and will tag this shortly. Appreciate the work on this!
|
@manicminer Thanks, I like the changes you made! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Without setting the correct @odata.type for both
possible values all and enumerated, a patch will fail when first enumerating and setting members and then changing to type all because the stored object
is of the wrong type.
References #261