[No QA] Fix checkDeploymentSuccess job in deploy workflow #49432

rayane-djouah · 2024-09-19T00:01:22Z

Details

We were defining IS_ALL_PLATFORMS_DEPLOYED and IS_AT_LEAST_ONE_PLATFORM_DEPLOYED as "true" or "false" strings. This caused fromJSON(needs.checkDeploymentSuccess.outputs.IS_ALL_PLATFORMS_DEPLOYED) and fromJSON(needs.checkDeploymentSuccess.outputs.IS_AT_LEAST_ONE_PLATFORM_DEPLOYED) to always evaluate as true, since any non-empty string is considered truthy. As a result, even if a platform failed, both IS_AT_LEAST_ONE_PLATFORM_DEPLOYED and IS_ALL_PLATFORMS_DEPLOYED would be true.

App/.github/workflows/deploy.yml

Lines 480 to 481 in 37bf6b2

    
                     echo "IS_AT_LEAST_ONE_PLATFORM_DEPLOYED=\"$isAtLeastOnePlatformDeployed\"" >> "$GITHUB_OUTPUT" 
        
                     echo "IS_ALL_PLATFORMS_DEPLOYED=\"$isAllPlatformsDeployed\"" >> "$GITHUB_OUTPUT"

App/.github/workflows/deploy.yml

Lines 592 to 595 in 37bf6b2

    
           name: Post a Slack message when all platforms deploy successfully 
        
           runs-on: ubuntu-latest 
        
           if: ${{ always() && fromJSON(needs.checkDeploymentSuccess.outputs.IS_ALL_PLATFORMS_DEPLOYED) }} 
        
           needs: [prep, android, desktop, iOS, web, checkDeploymentSuccess, createPrerelease, finalizeRelease]

This PR ensures that both variables are properly set as booleans.

Additionally, this PR adds always() to the createPrerelease and finalizeRelease jobs conditions, similar to what was done for other jobs. This guarantees that these conditions are always evaluated, ensuring the jobs are not skipped if any platform deploy job fails.

Fixed Issues

$ #49430
PROPOSAL: N/A

Tests

N/A

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

Screenshots/Videos

N/A

Android: Native

Android: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

MacOS: Desktop

rayane-djouah · 2024-09-19T00:03:46Z

cc @AndrewGable @roryabraham

melvin-bot · 2024-09-19T00:03:55Z

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

rayane-djouah · 2024-09-19T00:04:47Z

C+ review is not needed here

rayane-djouah · 2024-09-19T00:44:42Z

PR ready for review

allgandalf · 2024-09-19T03:42:10Z

C+ review is not needed here

Can someone please dismiss my review request

mountiny

@rayane-djouah thanks for the PR, can you please update the PR body with detailed explanation of the root cause and hence your changes/ why they should fix this? It is not clear to me how the issue is addressed. Thank you!

mountiny · 2024-09-19T09:57:54Z

.github/workflows/deploy.yml

@@ -540,7 +546,7 @@ jobs:

  finalizeRelease:
    runs-on: ubuntu-latest
-    if: ${{ github.ref == 'refs/heads/production' && fromJSON(needs.checkDeploymentSuccess.outputs.IS_AT_LEAST_ONE_PLATFORM_DEPLOYED) }}
+    if: ${{ always() && github.ref == 'refs/heads/production' && fromJSON(needs.checkDeploymentSuccess.outputs.IS_AT_LEAST_ONE_PLATFORM_DEPLOYED) }}


Why do you add the always here?

The always() was added to ensure the condition is evaluated even if some platform deployments fail. Without it, these jobs could be skipped

mountiny · 2024-09-19T09:59:30Z

.github/workflows/deploy.yml

          if [ "${{ needs.android.result }}" == "success" ] && \
            [ "${{ needs.iOS.result }}" == "success" ] && \
            [ "${{ needs.desktop.result }}" == "success" ] && \
            [ "${{ needs.web.result }}" == "success" ]; then
            isAllPlatformsDeployed="true"
          fi
-          echo "IS_AT_LEAST_ONE_PLATFORM_DEPLOYED=\"$isAtLeastOnePlatformDeployed\"" >> "$GITHUB_OUTPUT"
-          echo "IS_ALL_PLATFORMS_DEPLOYED=\"$isAllPlatformsDeployed\"" >> "$GITHUB_OUTPUT"
+          echo "IS_ALL_PLATFORMS_DEPLOYED=$isAllPlatformsDeployed" >> "$GITHUB_OUTPUT"


So this seems to be the main difference here; otherwise, splitting this up into two steps does not seem like much of a logical change, right?

Yes, the main change is removing the quotes to set the values as booleans, avoiding the truthy string issue. Splitting into two steps is just for clarity.

rayane-djouah · 2024-09-19T14:29:43Z

@mountiny - I've added a detailed explanation of the root cause and the changes made in the PR body. Please take a look. Thank you!

roryabraham

Thanks for this @rayane-djouah! I didn't realize that always() is necessary if any upstream job failed. createPrerelease is only directly dependent on prep and checkDeploymentSuccess, and both of those passed. The issue is that checkDeploymentSuccess was dependent on android, which failed. Without always(), it won't run because any transitively dependent job failed.

Confirmed this with local testing. Running this workflow with act, the third job does not run:

on: push
jobs:
  firstJobFails:
    runs-on: ubuntu-latest
    steps:
      - run: exit 1

  secondJobAlways:
    runs-on: ubuntu-latest
    needs: firstJobFails
    if: always()
    steps:
      - run: echo "Second job"

  thirdJobTransitive:
    runs-on: ubuntu-latest
    needs: secondJobAlways
    steps:
      - run: echo "Third job"

But if you make the first job succeed, or add if: always() on the third job, then all jobs run.

roryabraham · 2024-09-19T17:49:32Z

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

OSBotify · 2024-09-19T18:01:01Z

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

…ne-platform-fails [No QA] Fix checkDeploymentSuccess job in deploy workflow (cherry picked from commit ff5e1cf) (CP triggered by roryabraham)

OSBotify · 2024-09-19T18:48:57Z

🚀 Cherry-picked to staging by https://github.com/roryabraham in version: 9.0.38-3 🚀

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

OSBotify · 2024-09-19T23:35:39Z

🚀 Deployed to production by https://github.com/grgia in version: 9.0.38-4 🚀

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

don't skip jobs if one platform fails

631bd2a

rayane-djouah changed the title ~~don't skip jobs if one platform fails~~ [No QA] Fix deploy workflow: Don't skip createPrerelease and finalizeRelease jobs if one platform fails Sep 19, 2024

rayane-djouah marked this pull request as ready for review September 19, 2024 00:03

rayane-djouah requested a review from a team as a code owner September 19, 2024 00:03

melvin-bot bot requested review from allgandalf and removed request for a team September 19, 2024 00:03

rayane-djouah marked this pull request as draft September 19, 2024 00:17

fix checkDeploymentSuccess job

d4031c8

rayane-djouah changed the title ~~[No QA] Fix deploy workflow: Don't skip createPrerelease and finalizeRelease jobs if one platform fails~~ [No QA] Fix checkDeploymentSuccess job in deploy workflow Sep 19, 2024

rayane-djouah marked this pull request as ready for review September 19, 2024 00:44

mountiny removed the request for review from allgandalf September 19, 2024 09:55

mountiny assigned rayane-djouah Sep 19, 2024

mountiny requested review from AndrewGable and roryabraham September 19, 2024 09:55

mountiny reviewed Sep 19, 2024

View reviewed changes

rayane-djouah requested a review from mountiny September 19, 2024 14:33

AndrewGable approved these changes Sep 19, 2024

View reviewed changes

roryabraham approved these changes Sep 19, 2024

View reviewed changes

roryabraham merged commit ff5e1cf into Expensify:main Sep 19, 2024
14 of 19 checks passed

rayane-djouah deleted the fix-skipping-jobs-when-one-platform-fails branch September 19, 2024 17:58

github-actions bot added the CP Staging marks PRs that have been CP'd to staging label Sep 19, 2024

github-actions bot mentioned this pull request Sep 19, 2024

Deploy Checklist: New Expensify 2024-09-18 #49427

Closed

43 tasks

rayane-djouah mentioned this pull request Sep 23, 2024

[PAY][$250] Combine deploy.yml and platformDeploy.yml #48432

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[No QA] Fix checkDeploymentSuccess job in deploy workflow #49432

[No QA] Fix checkDeploymentSuccess job in deploy workflow #49432

rayane-djouah commented Sep 19, 2024 •

edited

Loading

rayane-djouah commented Sep 19, 2024

melvin-bot bot commented Sep 19, 2024

rayane-djouah commented Sep 19, 2024

rayane-djouah commented Sep 19, 2024

allgandalf commented Sep 19, 2024

mountiny left a comment

mountiny Sep 19, 2024

rayane-djouah Sep 19, 2024

mountiny Sep 19, 2024

rayane-djouah Sep 19, 2024

rayane-djouah commented Sep 19, 2024

roryabraham left a comment

roryabraham commented Sep 19, 2024

OSBotify commented Sep 19, 2024

OSBotify commented Sep 19, 2024

OSBotify commented Sep 19, 2024

	echo "IS_AT_LEAST_ONE_PLATFORM_DEPLOYED=\"$isAtLeastOnePlatformDeployed\"" >> "$GITHUB_OUTPUT"
	echo "IS_ALL_PLATFORMS_DEPLOYED=\"$isAllPlatformsDeployed\"" >> "$GITHUB_OUTPUT"

	name: Post a Slack message when all platforms deploy successfully
	runs-on: ubuntu-latest
	if: ${{ always() && fromJSON(needs.checkDeploymentSuccess.outputs.IS_ALL_PLATFORMS_DEPLOYED) }}
	needs: [prep, android, desktop, iOS, web, checkDeploymentSuccess, createPrerelease, finalizeRelease]

[No QA] Fix checkDeploymentSuccess job in deploy workflow #49432

[No QA] Fix checkDeploymentSuccess job in deploy workflow #49432

Conversation

rayane-djouah commented Sep 19, 2024 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

rayane-djouah commented Sep 19, 2024

melvin-bot bot commented Sep 19, 2024

rayane-djouah commented Sep 19, 2024

rayane-djouah commented Sep 19, 2024

allgandalf commented Sep 19, 2024

mountiny left a comment

Choose a reason for hiding this comment

mountiny Sep 19, 2024

Choose a reason for hiding this comment

rayane-djouah Sep 19, 2024

Choose a reason for hiding this comment

mountiny Sep 19, 2024

Choose a reason for hiding this comment

rayane-djouah Sep 19, 2024

Choose a reason for hiding this comment

rayane-djouah commented Sep 19, 2024

roryabraham left a comment

Choose a reason for hiding this comment

roryabraham commented Sep 19, 2024

Reviewer Checklist

Screenshots/Videos

OSBotify commented Sep 19, 2024

OSBotify commented Sep 19, 2024

OSBotify commented Sep 19, 2024

rayane-djouah commented Sep 19, 2024 •

edited

Loading