[No QA] Add console logs to investigate where the Reviewer Checklist check is failing #12771

dangrous · 2022-11-16T14:52:19Z

Details

Currently the PR Reviewer checklist will always pass, which is not ideal. Adding console logs so we can see what's going wrong. Also updated it so that if there's an error, the test will fail.

Fixed Issues

N/A

Tests

Verify that no errors appear in the JS console

Offline tests

QA Steps

Verify that no errors appear in the JS console

PR Author Checklist

PR Reviewer Checklist

The reviewer will copy/paste it into a new comment and complete it after the author checklist is completed

Screenshots

Not needed, fully internal tooling

.github/actions/javascript/reviewerChecklist/index.js

.github/actions/javascript/reviewerChecklist/reviewerChecklist.js

melvin-bot · 2022-11-17T15:32:25Z

@neil-marcellini Please copy/paste the Reviewer Checklist from here into a new comment on this PR and complete it. If you have the K2 extension, you can simply click: [this button]

tgolen

Just this small change and then it's good to merge!

tgolen · 2022-11-17T16:19:09Z

.github/actions/javascript/reviewerChecklist/index.js

-            .on('error', reject);
+            .on('error', (err) => {
+                console.error(err);
+                reject();


Suggested change

reject();

reject(err);

Need to keep passing the error down

tgolen · 2022-11-17T16:19:43Z

.github/actions/javascript/reviewerChecklist/reviewerChecklist.js

-            .on('error', reject);
+            .on('error', (err) => {
+                console.error(err);
+                reject();


neil-marcellini

Looks good to me as far as I can tell. I agree with Tim's comments.

dangrous · 2022-11-17T16:50:48Z

Updated!

tgolen · 2022-11-17T17:08:10Z

Oh, oops... one last thing before I merge. I think you also need to build the gh actions (there is an npm run ... for it) and commit the built files.

tgolen · 2022-11-17T17:08:23Z

Reviewer Checklist

I have verified the author checklist is complete (all boxes are checked off).
I verified the correct issue is linked in the ### Fixed Issues section above
I verified testing steps are clear and they cover the changes made in this PR
- I verified the steps for local testing are in the Tests section
- I verified the steps for Staging and/or Production testing are in the QA steps section
- I verified the steps cover any possible failure scenarios (i.e. verify an input displays the correct error message if the entered data is not correct)
- I turned off my network connection and tested it while offline to ensure it matches the expected behavior (i.e. verify the default avatar icon is displayed if app is offline)
I checked that screenshots or videos are included for tests on all platforms
I included screenshots or videos for tests on all platforms
I verified tests pass on all platforms & I tested again on:
- iOS / native
- Android / native
- iOS / Safari
- Android / Chrome
- MacOS / Chrome
- MacOS / Desktop
If there are any errors in the console that are unrelated to this PR, I either fixed them (preferred) or linked to where I reported them in Slack
I verified proper code patterns were followed (see Reviewing the code)
- I verified that any callback methods that were added or modified are named for what the method does and never what callback they handle (i.e. toggleReport and not onIconClick).
- I verified that comments were added to code that is not self explanatory
- I verified that any new or modified comments were clear, correct English, and explained "why" the code was doing something instead of only explaining "what" the code was doing.
- I verified any copy / text shown in the product was added in all src/languages/* files
- I verified any copy / text that was added to the app is correct English and approved by marketing by adding the Waiting for Copy label for a copy review on the original GH to get the correct copy.
- I verified proper file naming conventions were followed for any new files or renamed files. All non-platform specific files are named after what they export and are not named "index.js". All platform-specific files are named for the platform the code supports as outlined in the README.
- I verified the JSDocs style guidelines (in STYLE.md) were followed
If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
I verified that this PR follows the guidelines as stated in the Review Guidelines
I verified other components that can be impacted by these changes have been tested, and I retested again (i.e. if the PR modifies a shared library or component like Avatar, I verified the components using Avatar have been tested & I retested again)
I verified all code is DRY (the PR doesn't include any logic written more than once, with the exception of tests)
I verified any variables that can be defined as constants (ie. in CONST.js or at the top of the file that uses the constant) are defined as such
If a new component is created I verified that:
- A similar component doesn't exist in the codebase
- All props are defined accurately and each prop has a /** comment above it */
- The file is named correctly
- The component has a clear name that is non-ambiguous and the purpose of the component can be inferred from the name alone
- The only data being stored in the state is data necessary for rendering and nothing else
- For Class Components, any internal methods passed to components event handlers are bound to this properly so there are no scoping issues (i.e. for onClick={this.submit} the method this.submit should be bound to this in the constructor)
- Any internal methods bound to this are necessary to be bound (i.e. avoid this.submit = this.submit.bind(this); if this.submit is never passed to a component event handler like onClick)
- All JSX used for rendering exists in the render method
- The component has the minimum amount of code necessary for its purpose, and it is broken down into smaller components in order to separate concerns and functions
If a new CSS style is added I verified that:
- A similar style doesn't already exist
- The style can't be created with an existing StyleUtils function (i.e. StyleUtils.getBackgroundAndBorderStyle(themeColors.componentBG)
If the PR modifies a generic component, I tested and verified that those changes do not break usages of that component in the rest of the App (i.e. if a shared library or component like Avatar is modified, I verified that Avatar is working as expected in all cases)
If the PR modifies a component related to any of the existing Storybook stories, I tested and verified all stories for that component are still working as expected.
I have checked off every checkbox in the PR reviewer checklist, including those that don't apply to this PR.

Screenshots/Videos

Screenshots are not necessary since this is only a change to the github actions

dangrous · 2022-11-17T17:40:50Z

Oh, oops... one last thing before I merge. I think you also need to build the gh actions (there is an npm run ... for it) and commit the built files.

Yep! I did - that's where the /index.js files came from (they're created/changed when you run npm run gh-actions-build)

tgolen · 2022-11-18T14:18:21Z

Oh, sorry! I overlooked those for some reason.

melvin-bot · 2022-11-18T14:18:32Z

@tgolen looks like this was merged without the checklist test passing. Please add a note explaining why this was done and remove the Emergency label if this is not an emergency.

OSBotify · 2022-11-18T14:23:20Z

✋ This PR was not deployed to staging yet because QA is ongoing. It will be automatically deployed to staging after the next production release.

dangrous · 2022-11-18T17:11:12Z

Oh - it's this, right?

App/.github/actions/javascript/reviewerChecklist/reviewerChecklist.js

Line 59 in e1fceb3

return;

If it finds the checklist (assuming it's not the last comment) it just returns the function on the next run and never actually checks anything. This should be continue or break? (The logs just stop after it finds the checklist, that's how I noticed it. Thanks, logs!)

tgolen · 2022-11-18T21:10:33Z

ohhhh, yes. that should be a break 🤦

tgolen · 2022-11-21T15:53:32Z

@dangrous Do you want to submit a fix for that?

OSBotify · 2022-11-22T16:37:06Z

🚀 Deployed to staging by @tgolen in version: 1.2.30-0 🚀

platform	result
🤖 android 🤖	success ✅
🖥 desktop 🖥	success ✅
🍎 iOS 🍎	failure ❌
🕸 web 🕸	success ✅

OSBotify · 2022-11-22T17:46:50Z

🚀 Deployed to staging by @tgolen in version: 1.2.30-0 🚀

platform	result
🤖 android 🤖	success ✅
🖥 desktop 🖥	success ✅
🍎 iOS 🍎	success ✅
🕸 web 🕸	success ✅

OSBotify · 2022-11-24T00:05:12Z

🚀 Deployed to production by @luacmartins in version: 1.2.30-0 🚀

platform	result
🤖 android 🤖	success ✅
🖥 desktop 🖥	success ✅
🍎 iOS 🍎	success ✅
🕸 web 🕸	success ✅

add console logs to find where it is failing

af523f3

dangrous requested a review from roryabraham November 16, 2022 14:52

dangrous self-assigned this Nov 16, 2022

dangrous changed the title ~~Add console logs to investigate where this is failing~~ [No QA] Add console logs to investigate where this is failing Nov 16, 2022

dangrous changed the title ~~[No QA] Add console logs to investigate where this is failing~~ [No QA] Add console logs to investigate where the Reviewer Checklist check is failing Nov 16, 2022

dangrous mentioned this pull request Nov 16, 2022

IGNORE - QA for https://github.com/Expensify/App/pull/12429 #12756

Closed

92 tasks

tgolen mentioned this pull request Nov 16, 2022

Add a lot of debugging to the reviewer checklist action #12801

Closed

92 tasks

tgolen requested changes Nov 16, 2022

View reviewed changes

roryabraham reviewed Nov 16, 2022

View reviewed changes

.github/actions/javascript/reviewerChecklist/reviewerChecklist.js Show resolved Hide resolved

address comments

4b21b7a

dangrous marked this pull request as ready for review November 17, 2022 15:31

dangrous requested a review from a team as a code owner November 17, 2022 15:31

melvin-bot bot requested review from neil-marcellini and removed request for a team November 17, 2022 15:32

tgolen reviewed Nov 17, 2022

View reviewed changes

neil-marcellini reviewed Nov 17, 2022

View reviewed changes

pass down error

9eff654

neil-marcellini approved these changes Nov 17, 2022

View reviewed changes

tgolen approved these changes Nov 17, 2022

View reviewed changes

tgolen merged commit e1fceb3 into main Nov 18, 2022

tgolen deleted the dangrous-reviewer-checklist-logs branch November 18, 2022 14:18

melvin-bot bot added the Emergency label Nov 18, 2022

tgolen removed the Emergency label Nov 18, 2022

OSBotify mentioned this pull request Nov 22, 2022

Deploy Checklist: New Expensify 2022-11-22 #12934

Closed

40 tasks

tgolen mentioned this pull request Nov 22, 2022

[Internal QA] Fix the way the reviewer checklist is found #12936

Merged

96 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[No QA] Add console logs to investigate where the Reviewer Checklist check is failing #12771

[No QA] Add console logs to investigate where the Reviewer Checklist check is failing #12771

dangrous commented Nov 16, 2022 •

edited

Loading

melvin-bot bot commented Nov 17, 2022

tgolen left a comment

tgolen Nov 17, 2022

tgolen Nov 17, 2022

neil-marcellini left a comment

dangrous commented Nov 17, 2022

tgolen commented Nov 17, 2022

tgolen commented Nov 17, 2022 •

edited

Loading

dangrous commented Nov 17, 2022

tgolen commented Nov 18, 2022

melvin-bot bot commented Nov 18, 2022

OSBotify commented Nov 18, 2022

dangrous commented Nov 18, 2022 •

edited

Loading

tgolen commented Nov 18, 2022

tgolen commented Nov 21, 2022

OSBotify commented Nov 22, 2022

OSBotify commented Nov 22, 2022

OSBotify commented Nov 24, 2022

[No QA] Add console logs to investigate where the Reviewer Checklist check is failing #12771

[No QA] Add console logs to investigate where the Reviewer Checklist check is failing #12771

Conversation

dangrous commented Nov 16, 2022 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

PR Reviewer Checklist

Screenshots

melvin-bot bot commented Nov 17, 2022

tgolen left a comment

Choose a reason for hiding this comment

tgolen Nov 17, 2022

Choose a reason for hiding this comment

tgolen Nov 17, 2022

Choose a reason for hiding this comment

neil-marcellini left a comment

Choose a reason for hiding this comment

dangrous commented Nov 17, 2022

tgolen commented Nov 17, 2022

tgolen commented Nov 17, 2022 • edited Loading

Reviewer Checklist

Screenshots/Videos

dangrous commented Nov 17, 2022

tgolen commented Nov 18, 2022

melvin-bot bot commented Nov 18, 2022

OSBotify commented Nov 18, 2022

dangrous commented Nov 18, 2022 • edited Loading

tgolen commented Nov 18, 2022

tgolen commented Nov 21, 2022

OSBotify commented Nov 22, 2022

OSBotify commented Nov 22, 2022

OSBotify commented Nov 24, 2022

dangrous commented Nov 16, 2022 •

edited

Loading

tgolen commented Nov 17, 2022 •

edited

Loading

dangrous commented Nov 18, 2022 •

edited

Loading