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

chore(cli): log SDK calls when using -vvv #32308

Open
wants to merge 5 commits into
base: main
Choose a base branch
from
Open

Conversation

rix0rrr
Copy link
Contributor

@rix0rrr rix0rrr commented Nov 27, 2024

(This work came out of the proxy issue research)

The logging of what SDK calls were being performed was lost during the migration of SDKv2 -> SDKv3. Add it back.

Also in this PR:

  • Set a timeout on npm view; if for network isolation reasons NPM can't connect to the server, it will make the CLI hang for a minute.
  • Work around an issue where the CLI entirely fails if it is run as a user that doesn't have a home directory.

Closes #32306.


By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license

(This work came out of the proxy issue research)

The logging of what SDK calls were being performed was lost during the
migration of SDKv2 -> SDKv3.  Add it back.

Also in this PR:

- Set a timeout on `npm view`; if for network isolation reasons NPM
  can't connect to the server, it will make the CLI hang for a minute.
- Work around an issue where the CLI entirely fails if it is run as
  a user that doesn't have a home directory.
@github-actions github-actions bot added bug This issue is a bug. p2 labels Nov 27, 2024
@aws-cdk-automation aws-cdk-automation requested a review from a team November 27, 2024 12:04
@mergify mergify bot added the contribution/core This is a PR that came from AWS. label Nov 27, 2024
@rix0rrr
Copy link
Contributor Author

rix0rrr commented Nov 27, 2024

Still a Draft because I'm not happy with how the messages are being formatted; there is too much detail in them as they include the entire API call payloads and responses (including somewhat-sensitive information).

But creating a PR already anyway because I want to store this code somewhere safe.

@rix0rrr rix0rrr changed the title chore(cli): improve SDK logging chore(cli): log SDK calls when using -vvv Nov 27, 2024
Copy link
Collaborator

@aws-cdk-automation aws-cdk-automation left a comment

Choose a reason for hiding this comment

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

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 aws-cdk-automation added the pr/needs-cli-test-run This PR needs CLI tests run against it. label Nov 27, 2024
Copy link

codecov bot commented Nov 27, 2024

Codecov Report

Attention: Patch coverage is 27.08333% with 35 lines in your changes missing coverage. Please review.

Project coverage is 77.12%. Comparing base (6c0f74e) to head (7fc7c9a).
Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main   #32308      +/-   ##
==========================================
- Coverage   77.46%   77.12%   -0.35%     
==========================================
  Files         105      106       +1     
  Lines        7168     7209      +41     
  Branches     1314     1323       +9     
==========================================
+ Hits         5553     5560       +7     
- Misses       1433     1467      +34     
  Partials      182      182              
Flag Coverage Δ
suite.unit 77.12% <27.08%> (-0.35%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

Components Coverage Δ
packages/aws-cdk 77.12% <27.08%> (-0.35%) ⬇️

@rix0rrr rix0rrr marked this pull request as ready for review November 27, 2024 13:17
@rix0rrr rix0rrr requested a review from a team as a code owner November 27, 2024 13:18
@aws-cdk-automation
Copy link
Collaborator

The pull request linter fails with the following errors:

❌ CLI code has changed. A maintainer must run the code through the testing pipeline (git fetch origin pull/32308/head && git push -f origin FETCH_HEAD:test-main-pipeline), then add the 'pr-linter/cli-integ-tested' label when the pipeline succeeds.

PRs must pass status checks before we can provide a meaningful review.

If you would like to request an exemption from the status checks or clarification on feedback, please leave a comment on this PR containing Exemption Request and/or Clarification Request.

@aws-cdk-automation
Copy link
Collaborator

AWS CodeBuild CI Report

  • CodeBuild project: AutoBuildv2Project1C6BFA3F-wQm2hXv2jqQv
  • Commit ID: 7fc7c9a
  • Result: SUCCEEDED
  • Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug This issue is a bug. contribution/core This is a PR that came from AWS. p2 pr/needs-cli-test-run This PR needs CLI tests run against it.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

CLI: SDK call logging doesn't work anymore since SDKv3
2 participants