This repository has been archived by the owner on Dec 15, 2022. It is now read-only.
empty all queues in reporterProxy once data has been sent.
#1659
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
smashwilson
reviewed
Aug 23, 2018
| @@ -109,6 +109,11 @@ describe('reporterProxy', function() { | |||
| assert.deepEqual(addTimingArgs[2], {gitHubPackageVersion: version}); | |||
|
|
|||
| assert.deepEqual(incrementCounterStub.lastCall.args, [counterName]); | |||
|
|
|||
| assert.deepEqual(reporterProxy.events.length, 0); | |||
There was a problem hiding this comment.
For future reference: you can do assert.lengthOf(thing, 0) to get a slightly more informative error message when it fails. 🌠
There was a problem hiding this comment.
oh, thanks! I'll clean this up.
There was a problem hiding this comment.
Haha that wasn't meant as "you have to fix this"! It was just a random note because I'm tired 👀
There was a problem hiding this comment.
totally, didn't think you meant it that way, just want to get in the habit of using better assertions <3
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Description of the Change
Recently, I was working on some improvements to the
welcomepackage in atom/welcome#67. I noticed that thewelcomepackage, which also consumes thereporterservice, empties all queues after the reporter has been set. I believe the queues are emptied to guard against the possibility of the queued data being sent again if the reporter service is re-set.This change empties the queues in the github package's
ReporterProxyafter data has been sent. This change also adds unit tests to verify this new functionality works as expected.Alternate Designs
Is re-sending the same data actually something we need to worry about?
I tried to reproduce a situation where data might be re-sent to see if this is really a problem. I put a
setTimeoutin themetricspackage so that it loads in a deferred fashion, and performed some actions that are instrumented (staging and unstaging changes). This adds data to the queues before the reporter has been set. It appears that a newReporterProxyclass is created in memory each time Atom reloads, so old events sticking around isn't a problem. However, I'm not super confident that I'm testing this in the same conditions that would occur in the wild. Clearing the queues is a simple enough change that I'd just rather do this and put any lingering worries to rest about the accuracy of our data.Benefits
Guard against the possibility that we are re-sending data that has already been sent, which keeps our metrics accurate.
Possible Drawbacks
I can't think of any but am open to feedback.