[github] Improve log entries when retrieving github files #16635
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
easyCZ
commented
Mar 2, 2023
Comment on lines
69
to
+81
| if (response.status === 200) { | ||
| if (typeof response.data === "string") { | ||
| return response.data; | ||
| } | ||
| console.warn("GithubFileProvider.getFileContent – unexpected response type.", { | ||
| headers: response.headers, | ||
| type: typeof response.data, | ||
| log.warn("GithubFileProvider.getFileContent – unexpected response type.", { | ||
| request: params, | ||
| response: { | ||
| headers: { | ||
| "content-encoding": response.headers["content-encoding"], | ||
| "content-type": response.headers["content-type"], | ||
| }, | ||
| type: typeof response.data, | ||
| }, |
There was a problem hiding this comment.
The log here will allow us to possibly improve the response checking. We should, in theory, be able to check that the returned content-type matches the one we expected rather than having to read the response type. Reading the response type means we actually have to consume the body of the request and hence more bandwidth/work for us.
geropl
reviewed
Mar 6, 2023
| }); | ||
| } | ||
| return undefined; | ||
| } catch (err) { | ||
| log.debug(err); |
There was a problem hiding this comment.
There might have been a reason for the debug here (probably surfaces a ton of user errors as well), but as this has no comment... let's try. 🙂
geropl
approved these changes
Mar 6, 2023
roboquat
added
deployed: webapp
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
See logs here
Related Issue(s)
Fixes #
How to test
Release Notes
Documentation
Build Options:
Experimental feature to run the build with GitHub Actions (and not in Werft).
leeway-target=components:all
Run Leeway with
--dont-testPublish Options
Installer Options
Add desired feature flags to the end of the line above, space separated
Preview Environment Options:
If enabled this will build
install/previewIf enabled this will create the environment on GCE infra
Valid options are
all,workspace,webapp,ide,jetbrains,vscode,ssh