Add a new ProtoMessageConverter provider interface to convert entities to typed protobuf messages #4469
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
…s to typed protobuf messages This will help us get rid of database and/or property calls in the webhook handler. Related: mindersec#4327
jhrozek
commented
Sep 12, 2024
| if err != nil { | ||
| return nil, fmt.Errorf("error converting artifact to protobuf: %w", err) | ||
| } | ||
|
|
||
| pbArtifact, ok := pbMsg.(*pb.Artifact) |
There was a problem hiding this comment.
this typing is a bit awkward, but as a follow-up (that I already have in another branch), I wanted to add a more generic WithEntityID that would replace WithRepositoryID and WithEntity that would replace WithRepository etc.
jhrozek
commented
Sep 12, 2024
| @@ -55,6 +56,10 @@ const ( | |||
|
|
|||
| // PropertiesService is the interface for the properties service | |||
| type PropertiesService interface { | |||
| // EntityWithPropertiesAsProto calls the provider to convert the entity with properties to the appropriate proto message | |||
| EntityWithPropertiesAsProto( | |||
There was a problem hiding this comment.
At first I wanted to add this as a function to models instead of the service, but having it as a method makes testing easier as we generate mocks for the PropertiesService interface
jhrozek
commented
Sep 12, 2024
|
|
||
| // EntityWithPropertiesAsProto converts the entity with properties to a protobuf message | ||
| func (_ *propertiesService) EntityWithPropertiesAsProto( | ||
| ctx context.Context, ewp *models.EntityWithProperties, provMgr manager.ProviderManager, |
There was a problem hiding this comment.
We could make the method more generic and instead of requiring EntityWithProperties let he caller just pass the provider ID and entity type
JAORMX
approved these changes
Sep 12, 2024
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.
Summary
This will help us get rid of database and/or property calls in the
webhook handler.
Related: #4327
Change Type
Testing
make test
Review Checklist: