feat(svc): create Run method to encapsulate most of whats in func main #533
+444
−609
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
This PR extracts most of the main function provided by stencil-golang into a function clients can call instead. QSS runs a number of peripheral services-- CDC, Ingest, Polaroid, SmartWorker, etc., each of which need to set up their own main function. To do this, they basically copy whats in stencil-golang. Wouldn't it be better if we could use a library function instead? I think it would be, since it eases the burden when it comes time to update any service-wide behavior. Of course, we'll still want stencil to provide the kubernetes objects, e.g. trace.yaml for example, and my hope is we'll stencil in depending on this method instead of just doing what it does currently inline.
malept
requested changes
Aug 12, 2024
There was a problem hiding this comment.
Shouldn't templates/cmd/main.go.tpl also be changed in this PR?
pkg/run/run.go
Outdated
Comment on lines
5
to
9
| // Package run provides a function that can be invoked inside of main to set up | ||
| // all the service-standard components we expect every service to run. | ||
| // | ||
| // clients should provide any runners they require as part of the app to the | ||
| // Run function with OptAddRunner, and then call `Run` in their main function. |
There was a problem hiding this comment.
suggestion: it might be worth adding an example of how to use this.
There was a problem hiding this comment.
Added a testable example... should probably add a note that it exists here.
george-e-shaw-iv
approved these changes
Aug 13, 2024
I had thought not, I'd like to merge it, use it some test services, and then circle back. |
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.
Please read CONTRIBUTING.md for additional information on contributing to this repository!
What this PR does / why we need it
This PR extracts most of the main function provided by stencil-golang into a
function clients can call instead.
QSS runs a number of peripheral services-- CDC, Ingest, Polaroid, SmartWorker,
etc., each of which need to set up their own main function. To do this, they
basically copy whats in stencil-golang. Wouldn't it be better if we could use a
library function instead? I think it would be, since it eases the burden when
it comes time to update any service-wide behavior.
Of course, we'll still want stencil to provide the kubernetes objects, e.g.
trace.yaml for example, and my hope is we'll stencil in depending on this
method instead of just doing what it does currently inline.
Jira ID
[XX-XX]
Notes for your reviewers