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] Fix too-big checklists #31458

Merged
merged 25 commits into from
Nov 20, 2023
Merged

[No QA] Fix too-big checklists #31458

merged 25 commits into from
Nov 20, 2023

Conversation

roryabraham
Copy link
Contributor

@roryabraham roryabraham commented Nov 16, 2023

Details

This PR should hopefully fix #27123, but includes a few changes:

  1. The primary/most important change here is that it uses the same "base tag" in --shallow-exclude for both the fromTag and the toTag (see testing details for why I think this change will fix the issue).
  2. Makes a callable workflow for createDeployChecklist.yml. That way, we can re-create or refresh the checklist whenever we want.
  3. Simplifies the createOrUpdateStagingDeploy JS action by removing the NPM_VERSION input. It always just needs to compare the most recent version to the previous version on the checklist (previous checklist in the case of a production deploy / new checklist, current checklist in the case of updating an existing checklist)
  4. DRYs up the CIGitLogicTest.sh and adds a new test case w/ rebase + force-push.
  5. Renames an outdated function name from the workflow_tests stuff. That stuff is pretty cool but needs a bit of work to be really usable imo (separate convo).

Fixed Issues

$ #27123

Tests

Slack context: https://expensify.slack.com/archives/C07J32337/p1700246543029419

The background here is bad workflow runs that cause deploy checklists to include PRs from the previous checklist. For example this one. In that example, #31066 was originally cherry-picked in 1.3.96-15. So it should not appear in this log:

git log --oneline --grep "Merge pull request #" 1.3.97-7...1.3.98-0

But in the workflow run, it does. In order to reproduce the problem locally, do the following:

# Follow the steps in actions/checkout, sort of
cd ~
mkdir TestApp
cd TestApp
git init
git remote add origin git@github.com:Expensify/App.git
git -c protocol.version=2 fetch --no-tags --prune --progress --no-recurse-submodules --depth=1 origin +bd9ab871c632399dede829c3b71984db801dd936:refs/tags/1.3.98-0
git checkout --progress --force refs/tags/1.3.98-0

# Then createOrUpdateStagingDeploy does this
git fetch origin tag 1.3.97-7 --no-tags --shallow-exclude=1.3.96-0
git fetch origin tag 1.3.98-0 --no-tags --shallow-exclude=1.3.97-0

# Then run this command, and it will include PR #31066 :boom:
git log --oneline --grep "Merge pull request #31066" 1.3.97-7...1.3.98-0

Now, if you run the following:

# Fetch with an older --shallow-exclude
git repack -d
git fetch origin tag 1.3.98-0 --no-tags --shallow-exclude=1.3.96-0

# Then re-run this command, and it does not include #31066 :yay:
git log --oneline --grep "Merge pull request #31066" 1.3.97-7...1.3.98-0
  • Verify that no errors appear in the JS console

Offline tests

None.

QA Steps

None – monitor checklist creation and verify that they no longer contain old PRs.

  • 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(themeColors.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 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

@roryabraham roryabraham changed the title [WIP] Explore fix for checklist woes [No QA] Fix too-big checklists Nov 17, 2023
@roryabraham roryabraham self-assigned this Nov 18, 2023
@roryabraham roryabraham marked this pull request as ready for review November 18, 2023 00:04
@roryabraham roryabraham requested a review from a team as a code owner November 18, 2023 00:04
@melvin-bot melvin-bot bot requested review from situchan and removed request for a team November 18, 2023 00:04
Copy link

melvin-bot bot commented Nov 18, 2023

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

@roryabraham roryabraham removed the request for review from situchan November 18, 2023 00:05
@roryabraham
Copy link
Contributor Author

No C+ review needed here

mountiny
mountiny previously approved these changes Nov 20, 2023
Copy link
Contributor

@mountiny mountiny left a comment

Choose a reason for hiding this comment

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

Thanks @roryabraham for digging into this one, this is last thing holding the deploy, the changes make sense to me and automated tests have been added, I will go ahead and merge this to get the deploy going sooner than later.

@@ -6,27 +6,19 @@ on:
- labeled

jobs:
updateChecklist:
if: github.event.label.name == 'DeployBlockerCash'
uses: ./.github/workflows/createDeployChecklist.yml
Copy link
Contributor

Choose a reason for hiding this comment

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

I think it would be cleaner to call this create or update too

Suggested change
uses: ./.github/workflows/createDeployChecklist.yml
uses: ./.github/workflows/createOrUpdateDeployChecklist.yml

@mountiny
Copy link
Contributor

Had to resolve merge conflicts

Copy link
Contributor

@Julesssss Julesssss left a comment

Choose a reason for hiding this comment

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

Reviewing @mountiny's addition

@mountiny mountiny merged commit 9631cb9 into main Nov 20, 2023
16 of 18 checks passed
@mountiny mountiny deleted the Rory-CallableChecklistJob branch November 20, 2023 13:23
@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/luacmartins in version: 1.4.1-13 🚀

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

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.

Race condition can cause big checklists
4 participants