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][HybridApp] Fix is-hybrid-app.sh script #57484

Open
wants to merge 10 commits into
base: main
Choose a base branch
from

Conversation

mateuuszzzzz
Copy link
Contributor

@mateuuszzzzz mateuuszzzzz commented Feb 26, 2025

Explanation of Change

Slack thread: https://swmansion.slack.com/archives/C01GTK53T8Q/p1740565655682309

is-hybrid-app.sh was exiting every time any command failed with a non-zero status due to set -e at the beginning. This script is used in many other scripts to control the flow. The previous approach led to mysterious issues that were hard to debug.

The PR changes the implementation of is-hybrid-app.sh:

  1. set -e is no longer used and we handle more cases explicitly and verbosely
  2. we check if the non-standard command jq is installed. If it isn't, we prompt the user with an error
  3. The error is redirected to stderr, so even if we assign the output to a variable, it should now be verbose in case of any errors.

Fixed Issues

$
PROPOSAL:

Tests

  1. Verify that is-hybrid-app.sh, npm i, npm run {ios,android} works correctly when:
    a) Mobile-Expensify directory does not exist (assumes standalone NewDot)
    b) Mobile-Expensify directory exists and is empty (assumes standalone NewDot)
    c) Mobile-Expensify directory exists and Mobile-Expensify/package.json exists (assumes HybridApp)
    d) Mobile-Expensify directory exists and Mobile-Expensify/package.json exists, but somehow package name is incorrect. (assumes standalone NewDot)

  2. When jq is not installed run-build.sh, clean.sh, postInstall.sh should exit immediately when we reach jq check in is-hybrid-app.sh. jq is not installed. Please install jq and try again should be printed.

Offline tests

QA Steps

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 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 used JaimeGPT to get English > Spanish translation. I then posted it 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.ts 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.
  • I added unit tests for any new feature or bug fix in this PR to help automatically prevent regressions in this user flow.
  • 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

@mateuuszzzzz mateuuszzzzz changed the title [HybridApp] Fix is-hybrid-app.sh script [No QA][HybridApp] Fix is-hybrid-app.sh script Feb 26, 2025
@mateuuszzzzz mateuuszzzzz marked this pull request as ready for review February 27, 2025 13:10
@mateuuszzzzz mateuuszzzzz requested a review from a team as a code owner February 27, 2025 13:10
@melvin-bot melvin-bot bot requested review from MonilBhavsar and removed request for a team February 27, 2025 13:11
Copy link

melvin-bot bot commented Feb 27, 2025

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

@mateuuszzzzz
Copy link
Contributor Author

mateuuszzzzz commented Feb 27, 2025

I think we should run the builds here to verify if the script changes didn't break the deployment on CI overall

@mateuuszzzzz mateuuszzzzz marked this pull request as draft February 27, 2025 13:20
@mateuuszzzzz mateuuszzzzz marked this pull request as ready for review February 27, 2025 13:57
Copy link
Contributor

@Swor71 Swor71 left a comment

Choose a reason for hiding this comment

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

lgtm 👍🏻

@hungvu193
Copy link
Contributor

Nice It's working well for both case with jq installed and uninstalled 🎉

Screenshot 2025-02-27 at 22 46 39

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