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

fix(auth): Autodetect IDE usage and fallback to API token based authentication #5241

Merged
merged 3 commits into from
May 17, 2024

Conversation

PeterSchafer
Copy link
Collaborator

@PeterSchafer PeterSchafer commented May 16, 2024

Pull Request Submission

Please check the boxes once done.

The pull request must:

  • Reviewer Documentation
    • follow CONTRIBUTING rules
    • be accompanied by a detailed description of the changes
    • contain a risk assessment of the change (Low | Medium | High) with regards to breaking existing functionality. A change e.g. of an underlying language plugin can completely break the functionality for that language, but appearing as only a version change in the dependencies.
    • highlight breaking API if applicable
    • contain a link to the automatic tests that cover the updated functionality.
    • contain testing instructions in case that the reviewer wants to manual verify as well, to add to the manual testing done by the author.
    • link to the link to the PR for the User-facing documentation
  • User facing Documentation
    • update any relevant documentation in gitbook by submitting a gitbook PR, and including the PR link here
    • ensure that the message of the final single commit is descriptive and prefixed with either feat: or fix: , others might be used in rare occasions as well, if there is no need to document the changes in the release notes. The changes or fixes should be described in detail in the commit message for the changelog & release notes.
  • Testing
    • Changes, removals and additions to functionality must be covered by acceptance / integration tests or smoke tests - either already existing ones, or new ones, created by the author of the PR.

Pull Request Review

All pull requests must undergo a thorough review process before being merged.
The review process of the code PR should include code review, testing, and any necessary feedback or revisions.
Pull request reviews of functionality developed in other teams only review the given documentation and test reports.

Manual testing will not be performed by the reviewing team, and is the responsibility of the author of the PR.

For Node projects: It’s important to make sure changes in package.json are also affecting package-lock.json correctly.

If a dependency is not necessary, don’t add it.

When adding a new package as a dependency, make sure that the change is absolutely necessary. We would like to refrain from adding new dependencies when possible.
Documentation PRs in gitbook are reviewed by Snyk's content team. They will also advise on the best phrasing and structuring if needed.

Pull Request Approval

Once a pull request has been reviewed and all necessary revisions have been made, it is approved for merging into
the main codebase. The merging of the code PR is performed by the code owners, the merging of the documentation PR
by our content writers.

What does this PR do?

When defaulting snyk auth to oauth, we are breaking an implicit contract with IDE plugins, which assume that they can access the API token after running snyk auth. This PR is an attempt to fix forward and detect if the CLI is being run from within an IDE and then switches back to API token based authentication.

Where should the reviewer start?

How should this be manually tested?

SNYK_INTEGRATION_NAME=VS_CODE snyk auth -d
...
> 2024-05-16T08:52:42Z auth:1 - Authentication Type: token
...

Any background context you want to provide?

What are the relevant tickets?

Supersedes: snyk/snyk-ls#509

Screenshots

Additional questions

@PeterSchafer PeterSchafer requested a review from a team as a code owner May 16, 2024 08:53
Copy link
Contributor

github-actions bot commented May 16, 2024

Warnings
⚠️

"fix(auth): Autodetect IDE usage and fallback to API token based authentication" is too long. Keep the first line of your commit message under 72 characters.

⚠️

"fix(auth): Autodetect IDE usage and fallback to API token based authentication" is too long. Keep the first line of your commit message under 72 characters.

Generated by 🚫 dangerJS against 0bb78ad

@PeterSchafer PeterSchafer marked this pull request as draft May 16, 2024 09:59
@PeterSchafer PeterSchafer marked this pull request as ready for review May 16, 2024 16:29
@PeterSchafer PeterSchafer enabled auto-merge (squash) May 17, 2024 08:38
@PeterSchafer PeterSchafer merged commit 4c795e0 into main May 17, 2024
15 checks passed
@PeterSchafer PeterSchafer deleted the fix/CLI-326_detect_ide branch May 17, 2024 09:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants