Make NewRecorder a proper singleton
#4210
Merged
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
`NewRecorder` cannot be called twice safely because it would result in the same view being registered twice, which always returns an error. The tests work around this by themselves manually unregistering the metrics that `NewRecorder` registers, so an alternative here might be to have `NewRecorder` also return a `context.CancelFunc` to unregister things, or to have `NewRecorder` take `ctx` so that it can unregister the metrics on context-cancellation. This change simply opts for making `NewRecorder` a proper singleton with a `sync.Once` and private globals for the `Recorder` and the possible error, so multiple calls to `NewRecorder` return the same singleton `Recorder` (or its error). I've updated the tests to clear this new singleton state (as well as continuing to manually unregistering the metrics).
tekton-robot
added
release-note-none
tekton-robot
added
the
size/L
|
The following is the coverage report on the affected files.
|
vdemeester
approved these changes
Sep 2, 2021
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: vdemeester The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
tekton-robot
added
the
approved
|
/lgtm |
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.
NewRecordercannot be called twice safely because it would result in the same view being registered twice, which always returns an error.The tests work around this by themselves manually unregistering the metrics that
NewRecorderregisters, so an alternative here might be to haveNewRecorderalso return acontext.CancelFuncto unregister things, or to haveNewRecordertakectxso that it can unregister the metrics on context-cancellation.This change simply opts for making
NewRecordera proper singleton with async.Onceand private globals for theRecorderand the possible error, so multiple calls toNewRecorderreturn the same singletonRecorder(or its error).I've updated the tests to clear this new singleton state (as well as continuing to manually unregistering the metrics).
/kind cleanup
Submitter Checklist
As the author of this PR, please check off the items in this checklist:
functionality, content, code)
Release Notes