[No QA] Improve workflow failure notifier by rayane-d · Pull Request #41124 · Expensify/App

rayane-d · 2024-04-26T23:56:30Z

Details

Fixed Issues

$ #40612
PROPOSAL: N/A
https://expensify.slack.com/archives/C01GTK53T8Q/p1713557143833969?thread_ts=1713554811.796439&cid=C01GTK53T8Q

Tests

Test on a sample repo: https://github.com/rayane-djouah/testworkflow

Verify that no errors appear in the JS console

Offline tests

N/A

QA Steps

N/A

Verify that no errors appear in the JS console

PR Author Checklist

I linked the correct issue in the ### Fixed Issues section above
I wrote clear testing steps that cover the changes made in this PR
- I added steps for local testing in the Tests section
- I added steps for the expected offline behavior in the Offline steps section
- I added steps for Staging and/or Production testing in the QA steps section
- I added steps to cover 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 tested this PR with a High Traffic account against the staging or production API to ensure there are no regressions (e.g. long loading states that impact usability).
I included screenshots or videos for tests on all platforms
I ran the tests on all platforms & verified they passed on:
- Android: Native
- Android: mWeb Chrome
- iOS: Native
- iOS: mWeb Safari
- MacOS: Chrome / Safari
- MacOS: Desktop
I verified there are no console errors (if there's a console error not related to the PR, report it or open an issue for it to be fixed)
I followed proper code patterns (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 the left part of a conditional rendering a React component is a boolean and NOT a string, e.g. myBool && <MyComponent />.
- 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 is localized by adding it to src/languages/* files and using the translation method
  - If any non-english text was added/modified, I verified the translation was requested/reviewed in #expensify-open-source and it was approved by an internal Expensify engineer. Link to Slack message:
- I verified all numbers, amounts, dates and phone numbers shown in the product are using the localization methods
- I verified any copy / text that was added to the app is grammatically correct in English. It adheres to proper capitalization guidelines (note: only the first word of header/labels should be capitalized), and is either coming verbatim from figma or has been approved by marketing (in order to get marketing approval, ask the Bug Zero team member to add the Waiting for copy label to the issue)
- 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 followed the guidelines as stated in the Review Guidelines
I tested other components that can be impacted by my changes (i.e. if the PR modifies a shared library or component like Avatar, I verified the components using Avatar are working as expected)
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
I verified that if a function's arguments changed that all usages have also been updated correctly
If any new file was added I verified that:
- The file has a description of what it does and/or why is needed at the top of the file if the code is not self explanatory
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(theme.componentBG))
If the PR modifies code that runs when editing or sending messages, I tested and verified there is no unexpected behavior for all supported markdown - URLs, single line code, code blocks, quotes, headings, bold, strikethrough, and italic.
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.
If the PR modifies a component or page that can be accessed by a direct deeplink, I verified that the code functions as expected when the deeplink is used - from a logged in and logged out account.
If the PR modifies the UI (e.g. new buttons, new UI components, changing the padding/spacing/sizing, moving components, etc) or modifies the form input styles:
- I verified that all the inputs inside a form are aligned with each other.
- I added Design label and/or tagged @Expensify/design so the design team can review the changes.
If a new page is added, I verified it's using the ScrollView component to make it scrollable when more elements are added to the page.
If the main branch was merged into this PR after a review, I tested again and verified the outcome was still expected according to the Test steps.

Screenshots/Videos

Screen.Recording.2024-04-28.at.4.22.10.PM.mov

Android: Native

Android: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

MacOS: Desktop

…revious workflow run and jobs

melvin-bot · 2024-04-28T16:02:00Z

@jjcoffee 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]

jjcoffee · 2024-04-29T09:57:51Z

+            if (previousRun.actor.login === 'OSBotify') {
+              return allRuns.data.workflow_runs.find(run => run.run_number === run_number - 2);
+            }


I don't think this will work if multiple runs are from OSBotify. Can we just filter out any runs with actor.login === 'OSBotify' first before getting the last one? Do we also need to filter out cancelled runs?

jjcoffee · 2024-04-29T10:02:48Z

-                const existingIssue = issues.data.find(issue => issue.title.includes(jobName));
-                if (!existingIssue) {
+                const previousJob = previousRunJobs.jobs.find(job => job.name === jobName);
+                previousJobSucceeded = previousJob.conclusion === 'success';


Suggested change

previousJobSucceeded = previousJob.conclusion === 'success';

previousJobSucceeded = previousJob?.conclusion === 'success';

I guess it's possible that previousJob could return false for some reason.

jjcoffee · 2024-04-29T10:03:29Z

-                if (!existingIssue) {
+                const previousJob = previousRunJobs.jobs.find(job => job.name === jobName);
+                previousJobSucceeded = previousJob.conclusion === 'success';
+                if (previousJobSucceeded) {


Suggested change

if (previousJobSucceeded) {

if (previousJob?.conclusion === 'success') {

I don't think there's much benefit to having previousJobSucceeded since we don't use it anywhere else.

jjcoffee · 2024-04-29T10:05:01Z

+            });
+            const run = allRuns.data.workflow_runs.find(run => run.id === runId);
+            const run_number = run.run_number;
+            const previousRun = allRuns.data.workflow_runs.find(run => run.run_number === run_number - 1);


I guess run_number is always consecutive? I wonder if it's safer to use findIndex to get the current run and then select the previous run using the index?

jjcoffee

Looking good! Just a few comments to address.

jjcoffee · 2024-04-29T10:11:31Z

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:
- Android: Native
- Android: mWeb Chrome
- iOS: Native
- iOS: mWeb Safari
- MacOS: Chrome / Safari
- 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 the left part of a conditional rendering a React component is a boolean and NOT a string, e.g. myBool && <MyComponent />.
- 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 is localized by adding it to src/languages/* files and using the translation method
- I verified all numbers, amounts, dates and phone numbers shown in the product are using the localization methods
- I verified any copy / text that was added to the app is grammatically correct in English. It adheres to proper capitalization guidelines (note: only the first word of header/labels should be capitalized), and is either coming verbatim from figma or has been approved by marketing (in order to get marketing approval, ask the Bug Zero team member to add the Waiting for copy label to the issue)
- 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 any new file was added I verified that:
- The file has a description of what it does and/or why is needed at the top of the file if the code is not self explanatory
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(theme.componentBG)
If the PR modifies code that runs when editing or sending messages, I tested and verified there is no unexpected behavior for all supported markdown - URLs, single line code, code blocks, quotes, headings, bold, strikethrough, and italic.
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.
If the PR modifies a component or page that can be accessed by a direct deeplink, I verified that the code functions as expected when the deeplink is used - from a logged in and logged out account.
If the PR modifies the UI (e.g. new buttons, new UI components, changing the padding/spacing/sizing, moving components, etc) or modifies the form input styles:
- I verified that all the inputs inside a form are aligned with each other.
- I added Design label and/or tagged @Expensify/design so the design team can review the changes.
If a new page is added, I verified it's using the ScrollView component to make it scrollable when more elements are added to the page.
If the main branch was merged into this PR after a review, I tested again and verified the outcome was still expected according to the Test steps.
I have checked off every checkbox in the PR reviewer checklist, including those that don't apply to this PR.

Screenshots/Videos

Android: Native

Android: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

MacOS: Desktop

rayane-d · 2024-04-29T18:54:55Z

Comments addressed in aa13921

rayane-d · 2024-04-29T19:01:50Z

+            });
+            const filteredRuns = allRuns.data.workflow_runs.filter(run => run.actor.login !== 'OSBotify' && run.status !== 'cancelled');
+            const currentIndex = filteredRuns.findIndex(run => run.id === runId);
+            const previousRun = filteredRuns[currentIndex + 1];


The array is sorted by most recent first:
https://api.github.com/repos/Expensify/App/actions/workflows/preDeploy.yml/runs

jjcoffee

Code LGTM and tests well!

blimpich

LGTM! Thank you! 🚀

OSBotify · 2024-04-30T17:11:36Z

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

OSBotify · 2024-05-01T03:02:19Z

🚀 Deployed to staging by https://github.com/blimpich in version: 1.4.69-0 🚀

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

OSBotify · 2024-05-02T13:05:54Z

🚀 Deployed to production by https://github.com/Beamanator in version: 1.4.69-2 🚀

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

Improve workflow failiure notifier - Add logic to fetch and process p…

37999e8

…revious workflow run and jobs

rayane-d changed the title ~~Improve workflow failiure notifier - Add logic to fetch and process p…~~ Improve workflow failiure notifier Apr 26, 2024

rayane-d changed the title ~~Improve workflow failiure notifier~~ Improve workflow failure notifier Apr 26, 2024

rayane-d added 2 commits April 28, 2024 16:12

fixes

23c48b2

fixes

7e4c70d

rayane-d changed the title ~~Improve workflow failure notifier~~ [No QA] Improve workflow failure notifier Apr 28, 2024

rayane-d added 2 commits April 28, 2024 16:41

fix mocks

c1eeff7

prettier

47adcd9

rayane-d marked this pull request as ready for review April 28, 2024 16:01

rayane-d requested a review from a team as a code owner April 28, 2024 16:01

melvin-bot Bot requested review from jjcoffee and removed request for a team April 28, 2024 16:01

jjcoffee reviewed Apr 29, 2024

View reviewed changes

jjcoffee suggested changes Apr 29, 2024

View reviewed changes

adress review comments

aa13921

rayane-d requested a review from jjcoffee April 29, 2024 18:55

rayane-d commented Apr 29, 2024

View reviewed changes

jjcoffee approved these changes Apr 30, 2024

View reviewed changes

melvin-bot Bot requested a review from blimpich April 30, 2024 09:51

blimpich approved these changes Apr 30, 2024

View reviewed changes

blimpich merged commit 942c851 into Expensify:main Apr 30, 2024

rayane-d deleted the improve-workflow-failure-notifier branch April 30, 2024 17:12

github-actions Bot mentioned this pull request May 1, 2024

Deploy Checklist: New Expensify 2024-05-01 #41376

Closed

59 tasks

melvin-bot Bot mentioned this pull request May 2, 2024

[HOLD for payment 2024-05-09] [$250] improve failureNotifier.yml to catch more failures #40612

Closed

	previousJobSucceeded = previousJob.conclusion === 'success';
	previousJobSucceeded = previousJob?.conclusion === 'success';

	if (previousJobSucceeded) {
	if (previousJob?.conclusion === 'success') {

Conversation

rayane-d commented Apr 26, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

Uh oh!

melvin-bot Bot commented Apr 28, 2024

Uh oh!

jjcoffee Apr 29, 2024

Choose a reason for hiding this comment

Uh oh!

jjcoffee Apr 29, 2024

Choose a reason for hiding this comment

Uh oh!

jjcoffee Apr 29, 2024

Choose a reason for hiding this comment

Uh oh!

jjcoffee Apr 29, 2024

Choose a reason for hiding this comment

Uh oh!

jjcoffee left a comment

Choose a reason for hiding this comment

Uh oh!

jjcoffee commented Apr 29, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Reviewer Checklist

Screenshots/Videos

Uh oh!

rayane-d commented Apr 29, 2024

Uh oh!

rayane-d Apr 29, 2024

Choose a reason for hiding this comment

Uh oh!

jjcoffee left a comment

Choose a reason for hiding this comment

Uh oh!

blimpich left a comment

Choose a reason for hiding this comment

Uh oh!

OSBotify commented Apr 30, 2024

Uh oh!

OSBotify commented May 1, 2024

Uh oh!

OSBotify commented May 2, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

rayane-d commented Apr 26, 2024 •

edited

Loading

jjcoffee commented Apr 29, 2024 •

edited

Loading