Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Use enums for telemetry event names #3992

Merged
merged 2 commits into from Jan 17, 2019

Conversation

DonJayamanne
Copy link

For #2904 (part 1 for #2904)

  • Pull request represents a single change (i.e. not fixing disparate/unrelated things in a single PR)
  • Title summarizes what is changing
  • Has a news entry file (remember to thank yourself!)
  • [n/a] Unit tests & system/integration tests are added/updated
  • [n/a] Test plan is updated as appropriate
  • [n/a] package-lock.json has been regenerated by running npm install (if dependencies have changed)

@codecov
Copy link

codecov bot commented Jan 15, 2019

Codecov Report

Merging #3992 into master will decrease coverage by 24%.
The diff coverage is 84%.

Impacted file tree graph

@@           Coverage Diff            @@
##           master   #3992     +/-   ##
========================================
- Coverage      78%     55%    -23%     
========================================
  Files         406     327     -79     
  Lines       18929   13770   -5159     
  Branches     3034    2137    -897     
========================================
- Hits        14659    7486   -7173     
- Misses       4268    5793   +1525     
- Partials        2     491    +489
Flag Coverage Δ
#Linux ?
#Windows ?
#macOS ?
Impacted Files Coverage Δ
...lient/unittests/common/managers/baseTestManager.ts 8% <10%> (-74%) ⬇️
...nguageServer/languageServerCompatibilityService.ts 100% <100%> (+7%) ⬆️
src/client/telemetry/constants.ts 100% <100%> (ø) ⬆️
src/client/workspaceSymbols/provider.ts 94% <100%> (-3%) ⬇️
.../extension/configuration/providers/djangoLaunch.ts 87% <100%> (+1%) ⬆️
.../client/application/diagnostics/commands/ignore.ts 100% <100%> (+10%) ⬆️
.../extension/configuration/providers/moduleLaunch.ts 88% <100%> (-1%) ⬇️
...reter/locators/services/cacheableLocatorService.ts 82% <100%> (-15%) ⬇️
...debugger/extension/configuration/resolvers/base.ts 96% <100%> (ø) ⬇️
...r/extension/configuration/providers/flaskLaunch.ts 86% <100%> (+5%) ⬆️
... and 370 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 5f0153c...a384752. Read the comment docs.

@codecov
Copy link

codecov bot commented Jan 15, 2019

Codecov Report

Merging #3992 into master will increase coverage by 1%.
The diff coverage is 85%.

@@           Coverage Diff           @@
##           master   #3992    +/-   ##
=======================================
+ Coverage      79%     79%    +1%     
=======================================
  Files         409     410     +1     
  Lines       19024   19124   +100     
  Branches     3035    3052    +17     
=======================================
+ Hits        14845   14926    +81     
- Misses       4177    4190    +13     
- Partials        2       8     +6
Flag Coverage Δ
#Linux 68% <73%> (ø) ⬇️
#Windows 68% <74%> (ø) ⬇️
#macOS 68% <74%> (ø) ⬇️

Copy link

@d3r3kk d3r3kk left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have a question about this change. Why wouldn't we also consider changing /src/telemetry/index.ts to make the captureTelemetry function look like so?

export function captureTelemetry(
    eventName: EventName, // <= take advantage of this new enum...
    properties?: TelemetryProperties,
...

It's not strictly necessary to make this change of course, but I expected to see this and was wondering why it isn't there.

(This also applies to the other exported functions in .../telemetry/index.ts: sendTelemetryEvent and sendTelemetryWhenDone)

@DonJayamanne
Copy link
Author

@d3r3kk

I have a question about this change. Why wouldn't we also consider changing /src/telemetry/index.ts to make the captureTelemetry function look like so?

That's part 2,
If you look at the comments in the PR i've mentioned this is Part 1, smaller PR easier to review. Else the changes get bigger...

@DonJayamanne DonJayamanne force-pushed the issue2904 branch 2 times, most recently from c9d39c3 to 008268d Compare January 17, 2019 08:40
@DonJayamanne
Copy link
Author

Please re-review

@DonJayamanne DonJayamanne added the no-changelog No news entry required label Jan 17, 2019
@DonJayamanne DonJayamanne merged commit 3eb481f into microsoft:master Jan 17, 2019
@DonJayamanne DonJayamanne deleted the issue2904 branch May 24, 2019 20:22
@lock lock bot locked as resolved and limited conversation to collaborators Jul 30, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
no-changelog No news entry required
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants