fix(cli): user agent is reported as undefined/undefined
#24663
Conversation
It should not be possible, but I'm seeing `undefined/undefined` as the user agent in CloudTrail logs, and it looks like it is the CLI causing this. Add a test (which succeeds) and some fallback behavior to help and debug this some more if we see it again in the future.
There was a problem hiding this comment.
The pull request linter has failed. See the aws-cdk-automation comment below for failure reasons. If you believe this pull request should receive an exemption, please comment and provide a justification.
A comment requesting an exemption should contain the text Exemption Request. Additionally, if clarification is needed add Clarification Request to a comment.
aws-cdk-automation
added
the
pr/needs-cli-test-run
rix0rrr
changed the title
undefined/undefined in user agentundefined/undefined
rix0rrr
added
pr-linter/exempt-integ-test
aws-cdk-automation
dismissed
their stale review
✅ Updated pull request passes all PRLinter validations. Dissmissing previous PRLinter review.
aws-cdk-automation
removed
the
pr/needs-cli-test-run
|
Thank you for contributing! Your pull request will be updated from main and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork). |
AWS CodeBuild CI Report
Powered by github-codebuild-logs, available on the AWS Serverless Application Repository |
|
Thank you for contributing! Your pull request will be updated from main and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork). |
Our CLI's user agent is reported as `undefined/undefined`. This is because we are reading the package name and version from the CLI's `package.json` by using a relative path to the source file (using `__dirname`). However, since a good long while, our production CLI is being bundled using `esbuild` into a single JavaScript file. This means that at runtime, `__dirname` points to a completely different directory than the one it's been coded against, and so reading the `package.json` fails. Account for this by using a function that searches for `package.json`; still do it defensively so that if some other condition we didn't predict causes the search to fail, our CLI doesn't fail. ---- *By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
Our CLI's user agent is reported as
undefined/undefined. This is because we are reading the package name and version from the CLI'spackage.jsonby using a relative path to the source file (using__dirname). However, since a good long while, our production CLI is being bundled usingesbuildinto a single JavaScript file. This means that at runtime,__dirnamepoints to a completely different directory than the one it's been coded against, and so reading thepackage.jsonfails.Account for this by using a function that searches for
package.json; still do it defensively so that if some other condition we didn't predict causes the search to fail, our CLI doesn't fail.By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license