Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[No QA] Create Automation for when main fail #34262

Merged

Conversation

rayane-djouah
Copy link
Contributor

Details

Fixed Issues

$ #34110
PROPOSAL:

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

  • 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 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 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 form input styles:
    • I verified that all the inputs inside a form are aligned with each other.
    • I added Design label 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

Android: Native
Android: mWeb Chrome
iOS: Native
iOS: mWeb Safari
MacOS: Chrome / Safari
MacOS: Desktop

@rayane-djouah rayane-djouah requested a review from a team as a code owner January 10, 2024 16:31
@melvin-bot melvin-bot bot requested review from jjcoffee and removed request for a team January 10, 2024 16:31
Copy link

melvin-bot bot commented Jan 10, 2024

@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
Copy link
Contributor

@rayane-djouah Thanks for the PR! Would you mind sharing how you tested it?

@rayane-djouah
Copy link
Contributor Author

rayane-djouah commented Jan 10, 2024

@rayane-djouah
Copy link
Contributor Author

@jjcoffee I tested the workflow on my sample repo and it is working correctly.
Here is the created issue:
rayane-djouah/testworkflow#71
and the "Notify on Workflow Failure" github actions job run:
https://github.com/rayane-djouah/testworkflow/actions/runs/7479177460/job/20355771683

The PR is now ready for review!

@rayane-djouah
Copy link
Contributor Author

review comments addressed by 10baa72

Copy link
Contributor

@pecanoro pecanoro left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would love to see automated tests in workflow_test if it is possible

.github/workflows/failureNotifier.yml Show resolved Hide resolved
@pecanoro
Copy link
Contributor

@rayane-djouah friendly reminder to address the comments from the review!

@rayane-djouah
Copy link
Contributor Author

Sorry for the delay, updating today

@pecanoro
Copy link
Contributor

@rayane-djouah Another friendly reminder 😄

});
const existingIssue = issues.data.find(issue => issue.title.includes(jobName));
if (!existingIssue) {
const issueTitle = `🔍 Investigation Needed: ${ jobName } Failure due to PR Merge 🔍`;
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
const issueTitle = `🔍 Investigation Needed: ${ jobName } Failure due to PR Merge 🔍`;
const issueTitle = `Investigate workflow job failing on main: ${ jobName }`;

I think it's a bit tidier to phrase the title like this. We should maybe also prepend a priority in square brackets, e.g. [HIGH] but I'm unsure if there's an internal process for assigning the level? cc @pecanoro

Co-authored-by: Joel Davies <joeld.dev@gmail.com>
@melvin-bot melvin-bot bot requested a review from pecanoro January 24, 2024 09:32
@jjcoffee
Copy link
Contributor

I don't know if you also want to give this a quick look @blimpich?

@pecanoro
Copy link
Contributor

@rayane-djouah Can we add some tests to workflow_test?

@pecanoro
Copy link
Contributor

@rayane-djouah Friendly bump on my last comment!

@rayane-djouah
Copy link
Contributor Author

Hi, I apologize for the delay. I've been working on setting up the environment, and it's taken me some time. I'm not too familiar with workflow tests, but I'll do my best to complete them by Friday. Thanks for your understanding!

@pecanoro
Copy link
Contributor

pecanoro commented Feb 2, 2024

@rayane-djouah It's been a week already, could you please take a look at those tests asap? You can find some examples in the folder https://github.com/Expensify/App/tree/672d6ff35fcad63128cc1a23f7584ac6ce85b34a/workflow_tests, it should make it easier to figure out

@rayane-djouah
Copy link
Contributor Author

Sorry for the delay, I'm working on it them today

@rayane-djouah
Copy link
Contributor Author

Updated

workflow_tests/mocks/failureNotifierMocks.js Outdated Show resolved Hide resolved
workflow_tests/mocks/failureNotifierMocks.js Outdated Show resolved Hide resolved
@pecanoro
Copy link
Contributor

pecanoro commented Feb 6, 2024

@jjcoffee Can you double check the last changes and reapprove if it looks good? I will approve and merge after

Copy link
Contributor

@jjcoffee jjcoffee left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@pecanoro pecanoro merged commit c2dc5b6 into Expensify:main Feb 7, 2024
17 checks passed
@OSBotify
Copy link
Contributor

OSBotify commented Feb 7, 2024

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

@rayane-djouah rayane-djouah deleted the Create-Automation-for-when-main-fails branch February 7, 2024 15:47
@rayane-djouah rayane-djouah restored the Create-Automation-for-when-main-fails branch February 7, 2024 16:39
@OSBotify
Copy link
Contributor

OSBotify commented Feb 8, 2024

🚀 Deployed to staging by https://github.com/pecanoro in version: 1.4.39-0 🚀

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

@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/Beamanator in version: 1.4.39-8 🚀

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants