Add app/version useragent for tracking clients in runtime #814
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
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #814 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 57 57
Lines 3323 3324 +1
Branches 641 641
=========================================
+ Hits 3323 3324 +1 ☔ View full report in Codecov by Sentry. |
shazron
approved these changes
Oct 9, 2024
| @@ -42,6 +42,7 @@ class BaseCommand extends Command { | |||
| await super.init() | |||
| // setup a prompt that outputs to stderr | |||
| this.prompt = inquirer.createPromptModule({ output: process.stderr }) | |||
| process.env.__OW_USER_AGENT = 'aio-cli-plugin-app@' + require('../package.json').version | |||
There was a problem hiding this comment.
just a reviewer note: even though it's not documented in oclif, the command's init function is always called before a run is called: https://github.com/oclif/core/blob/68110ee2a4839f0b3ab299ae775d3af1f0c107bc/src/command.ts#L359
If we want to add more details (behave similar like a browser user agent), we can get it from .config.versionDetails() (but this is not documented): https://github.com/oclif/core/blob/68110ee2a4839f0b3ab299ae775d3af1f0c107bc/src/config/config.ts#L187
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.
Description
Related Issue
Motivation and Context
How Has This Been Tested?
Screenshots (if appropriate):
Types of changes
Checklist: