Add cutoff repos and counts to error message#1408
Merged
robertbrignull merged 1 commit intomainfrom Jun 28, 2022
Merged
Conversation
charisk
approved these changes
Jun 28, 2022
Contributor
charisk
left a comment
There was a problem hiding this comment.
Messages look good to me!
elenatanasoiu
approved these changes
Jun 28, 2022
| if (response.errors.private_repositories?.length) { | ||
| logMessage += `${eol2}Non-public repositories:${eol}${response.errors.private_repositories.join(', ')}`; | ||
| if (private_repositories?.length) { | ||
| logMessage += `${eol2}${private_repositories.length} repositories are not public:${eol}${private_repositories.join(', ')}`; |
Contributor
There was a problem hiding this comment.
Since we're building a log message from:
- two end of lines
- a number
- a message
- another eol
- a list
in three separate situations, extracting those lines into a method might improve readability.
e.g.
logMessage += buildCutOffMessage(private_repositories, "repositories are not public");
let buildCutOffMessage = (list, message) => `${eol2}${list.length} ${message}:${eol}${list.join(', ')}`;
Contributor
Author
There was a problem hiding this comment.
I like this suggestion but I think I'll just get the PR merged first so I can get this and the API change done today. Then potentially come back to this and see how it works out. Definitely the potential to make the area more understandable, but also could spend a lot of time messing with it.
This file contains hidden or 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
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.
The queries API is changing so that it won't fail when you try to run a query on more than 1000 repos. Instead it'll cap the repos off at 1000 and tell you in the response which repos weren't queried (up to a limit of 100 repos).
This PR is for handling that change in the API and display the information in the log message. While there I also updated the log message in general to include the counts of the repositories in the various states. I think this makes it more consistent if we're including the count for the cutoff repositories case.
Any input on the wording of the log message is very welcome. Writing these messages is very hard 😢
Checklist
ready-for-doc-reviewlabel there.