refactor common proto resource (un)marshallers into generic functions #41562
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
nklaassen
added
backport/branch/v13
backport/branch/v14
no-changelog
jakule
approved these changes
May 14, 2024
|
|
||
| cp := proto.Clone(r).(T) | ||
| //nolint:staticcheck // SA1019. Id is deprecated, but still needed. | ||
| cp.GetMetadata().Id = 0 |
There was a problem hiding this comment.
AFAIK no one is using this anymore
There was a problem hiding this comment.
I think it's fine to leave this for now, we'll be removing Id entirely in the near future
rosstimothy
approved these changes
May 15, 2024
lib/services/resource_test.go
Outdated
|
|
||
| unmarshalled, err := tc.unmarshalFunc(marshaled) | ||
| require.NoError(t, err) | ||
| require.Empty(t, cmp.Diff(resource, unmarshalled, cmpopts.IgnoreUnexported(vnet.VnetConfig{}, vnet.VnetConfigSpec{}, headerv1.Metadata{}))) |
There was a problem hiding this comment.
Suggested change
| require.Empty(t, cmp.Diff(resource, unmarshalled, cmpopts.IgnoreUnexported(vnet.VnetConfig{}, vnet.VnetConfigSpec{}, headerv1.Metadata{}))) | |
| require.Empty(t, cmp.Diff(resource, unmarshalled, protocmp.Transform())) |
public-teleport-github-review-bot
bot
removed the request for review
from EdwardDowling
|
@nklaassen See the table below for backport results.
|
nklaassen
added a commit
that referenced
this pull request
May 15, 2024
…ctions Backport #41562 to branch/v15
nklaassen
added a commit
that referenced
this pull request
May 15, 2024
…ctions Backport #41562 to branch/v14
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.
We have many implementations of resource marshallers and unmarshallers that are basically identical aside from the types. Most developers just find an existing resource and copy whatever it does.
This PR adds new generic marshal and unmarshal functions that should work for all new RFD153-style resources based on protobuf types generated with
buf. The recommendation for new types going forward is to useservices.MarshalProtoResourceandservices.UnmarshalProtoResourcefor your type.services.FastMarshalProtoResourceDeprecatedandservices.FastUnmarshalProtoResourceDeprecatedwere also added since 7 of the new types already wrote their (un)marshal functions based onutils.FastMarshal, which does not support some protobuf features likeoneof. If someone takes the time to check if it would be safe to convert these types to the new protojson-based marshaler, they could potentially be converted.For now in this PR, I am keeping all functionality identical and just refactoring common code into shared functions. The one exception to this is MarshalAccessMonitoringRule which previously just called
utils.FastMarshalwithout considering theMarshalOptions, it now usesFastMarshalProtoResourceDeprecatedwhich does respect the marshal options.