Refactor of failed reviews objects #112
Merged
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
All of the failed reports can be unified in this classes
This simplifies the code quite a lot
Now it will simply return an error object or a null object.
It is easier to track the object itself
Now they simply return an error object or a null one
So that the name of structs is more consistent
Bullrich
commented
Jan 25, 2024
Comment on lines
-12
to
-25
| type ReviewReport = { | ||
| /** The amount of missing reviews to fulfill the requirements */ | ||
| missingReviews: number; | ||
| /** The users who would qualify to complete those reviews */ | ||
| missingUsers: string[]; | ||
| /** If applicable, the teams that should be requested to review */ | ||
| teamsToRequest?: string[]; | ||
| /** If applicable, the users that should be requested to review */ | ||
| usersToRequest?: string[]; | ||
| /** If applicable, the missing minimum fellows rank required to review */ | ||
| missingRank?: number; | ||
| /** If applicable, reviews that count towards this rule */ | ||
| countingReviews: string[]; | ||
| }; |
There was a problem hiding this comment.
This piece has been moved to the failure/types.ts file and split into smaller sections.
Comment on lines
-276
to
+248
| let text = summary | ||
| .emptyBuffer() | ||
| .addHeading(report.name, 2) | ||
| .addHeading(`Missing ${report.missingReviews} review${report.missingReviews > 1 ? "s" : ""}`, 4) | ||
| .addDetails( | ||
| "Rule explanation", | ||
| `${ruleExplanation( | ||
| report.type, | ||
| )}\n\nFor more info found out how the rules work in [Review-bot types](https://github.com/paritytech/review-bot#types)`, | ||
| ); | ||
| if (report.usersToRequest && report.usersToRequest.length > 0) { | ||
| text = text | ||
| .addHeading("Missing users", 3) | ||
| .addList(report.usersToRequest.filter((u) => !caseInsensitiveEqual(u, this.prApi.getAuthor()))); | ||
| } | ||
| if (report.teamsToRequest && report.teamsToRequest.length > 0) { | ||
| text = text.addHeading("Missing reviews from teams", 3).addList(report.teamsToRequest); | ||
| } | ||
| if (report.missingRank) { | ||
| text = text | ||
| .addHeading("Missing reviews from Fellows", 3) | ||
| .addEOL() | ||
| .addRaw(`Missing reviews from rank \`${report.missingRank}\` or above`) | ||
| .addEOL(); | ||
| } | ||
| if (report.countingReviews.length > 0) { | ||
| text = text | ||
| .addHeading("Users approvals that counted towards this rule", 3) | ||
| .addEOL() | ||
| .addList(report.countingReviews) | ||
| .addEOL(); | ||
| } | ||
|
|
||
| check.output.text += text.stringify() + "\n"; | ||
| check.output.text += report.generateSummary().stringify() + "\n"; |
There was a problem hiding this comment.
All of this is done inside each error, removing a lot of ifs when not applicable
mordamax
approved these changes
Jan 25, 2024
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.
This creates a new type of object:
ReviewFailure. This object is an abstract class that contains all the information of the errors. By having each kind of error implementing it, we can customize the reports.This was done because reporting problems in the PR is basically the most exposed part (and the clearer it is, the less that people will ask for help).
Each class has it's own summary to generate and returns the reviewers that should be requested. It allows customization per class. It can solve a lot of problems in the future.
Two error classes were created:
CommonRuleFailureandFellowMissingRankFailureCommonRuleFailure
Wraps all the errors for all the non fellows rules and list what users are required (and which reviews counted towards fulfilling the rule).
FellowMissingRankFailure
Quite similar to the
CommonRuleFailureerror, but also handles the rank required.In the future I'll add one for
Fellow Score, which will be a requirement for detailing the information in #110.Other changes
generateCheckRunDataifchecks are done inside the errorsevaluateConditionandandDistinctEvaluationreturn type.[true] | [false, ErrorStruct]tuple. After thinking about it, it is simpler to return aErrorStruct | nulltype and simply checking if it's null.truecondition I could have keep it, but for this case it was over engineered.fellowsEvaluation