Fixes issue description and octokit pagination #28
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
…s previous queryOrganization funtion.
jeramysoucy
commented
Dec 27, 2023
|
|
||
| const baseV1Url = 'https://snyk.io/api/v1' | ||
| const baseRestUrl = 'https://api.snyk.io' | ||
| const baseRestUrl = 'https://api.snyk.io/rest' |
There was a problem hiding this comment.
I decided to include the full base here and just remove the '/rest' in the one place where it is redundant.
There was a problem hiding this comment.
@jeramysoucy I think this is now introducing this when used Error: Failed to paginate request for get https://api.snyk.io/rest/rest/orgs/, notice the double /rest
jeramysoucy
changed the title
kc13greiner
approved these changes
Dec 27, 2023
Closed
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.
Closes #27
Closes #29
Summary
This PR resolves the issue of undefined project links manifest version (see #27), as well as the issue where
octokitpagination with API calls caused improper headers in low-level fetch in node >= 18 (see #29)Details
Undefined Values
The project links were derived from the response of the deprecated v1 all projects API - each project body contained a
browseUrlproperty. According to the API migration documentation it:But this is inaccurate. The URL can be constructed from the organization name in lower-case and the project ID as such:
https://app.snyk.io/org/[org name]/project/[projectId]The manifest version used to be populated from the
imageTagproperty return from the deprecated v1 all projects API. The API migration documentation claims that it:But I found that this did not work. Example for several projects:
Originally, I removed the
manifest versionfrom the output issue description, as it is not included in our other issue-generation automations. However, I found that I could still properly query forimageTagwith the non-deprecated v1 single project API. As this API also returns thebrowseUrlproperty, it is not necessary to query for the organization name and manually construct the URL.Fetch Header Issue
This PR fixes the fetch header issue by replacing the
octokitAPI call within theoctokitpagination call for querying issue labels with a raw request URL. This seems to resolve this issue and executes correctly in node 16, 18, and 20.Additional
Lastly, error reporting around requests has been improved throughout the codebase. Previously, only low-level exceptions were being displayed if something went wrong, which did not include a path or reference back to which high-level operation caused the error. Error reports will now include a better description, along with a response status code and response details if available.