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

[CP Staging] fix: onboarding modal is not displayed in web #54329

Merged
merged 5 commits into from
Dec 19, 2024

Conversation

nkdengineer
Copy link
Contributor

@nkdengineer nkdengineer commented Dec 18, 2024

Explanation of Change

Fixed Issues

$ #54322
PROPOSAL: #54322 (comment)

Tests

  1. Sign in with a new account
  2. Verify that the onboarding modal is displayed
  3. Complete the onboarding flow
  4. Go to the settings tab.
  5. Open the workspaces list.
  6. Create a new workspace if we don't have any workspace
  7. Open any workspace.
  8. Resize the app to the narrow layout.
  9. Go back to the workspace initial page.
  10. Resize the app to the wide layout.
  11. Verify if the Workspace Profile page is displayed.
  • Verify that no errors appear in the JS console

Offline tests

None

QA Steps

// TODO: These must be filled out, or the issue title must include "[No QA]."

  1. Sign in with a new account
  2. Verify that the onboarding modal is displayed
  3. Complete the onboarding flow
  4. Go to the settings tab.
  5. Open the workspaces list.
  6. Create a new workspace if we don't have any workspace
  7. Open any workspace.
  8. Resize the app to the narrow layout.
  9. Go back to the workspace initial page.
  10. Resize the app to the wide layout.
  11. Verify if the Workspace Profile page is displayed.
  • 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 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
Screen.Recording.2024-12-19.at.05.20.16.mov
Android: mWeb Chrome
Screen.Recording.2024-12-19.at.04.49.13.mov
iOS: Native
Screen.Recording.2024-12-19.at.05.37.39.mov
iOS: mWeb Safari
Screen.Recording.2024-12-19.at.04.49.47.mov
MacOS: Chrome / Safari
Screen.Recording.2024-12-19.at.04.48.35.mov
Screen.Recording.2024-12-19.at.05.15.44.mov
MacOS: Desktop
Screen.Recording.2024-12-19.at.05.18.19.mov
Screen.Recording.2024-12-19.at.05.18.38.mov

Copy link
Contributor

🚧 @mountiny has triggered a test build. You can view the workflow run here.

@s77rt
Copy link
Contributor

s77rt commented Dec 18, 2024

Bug: After resizing to wide layout the report screen is empty

Screen.Recording.2024-12-18.at.10.53.41.PM.mov

(BTW this fixes the bug)

@nkdengineer
Copy link
Contributor Author

@s77rt The API is live now. I'm completing the checklist.

This comment has been minimized.

@nkdengineer nkdengineer marked this pull request as ready for review December 18, 2024 22:22
@nkdengineer nkdengineer requested a review from a team as a code owner December 18, 2024 22:22
@melvin-bot melvin-bot bot requested a review from s77rt December 18, 2024 22:22
Copy link

melvin-bot bot commented Dec 18, 2024

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

@melvin-bot melvin-bot bot removed the request for review from a team December 18, 2024 22:22
@nkdengineer
Copy link
Contributor Author

@s77rt The PR is ready.

@s77rt
Copy link
Contributor

s77rt commented Dec 18, 2024

@nkdengineer Did you check this bug #54329 (comment)

@nkdengineer
Copy link
Contributor Author

nkdengineer commented Dec 18, 2024

@s77rt I can't reproduce this bug in this PR.

Screen.Recording.2024-12-19.at.05.27.43.mov

@s77rt
Copy link
Contributor

s77rt commented Dec 18, 2024

Interesting. The bug is reproducible but not reliably. Maybe that's the case on main too

@s77rt
Copy link
Contributor

s77rt commented Dec 18, 2024

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 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.ts 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.
  • For any bug fix or new feature in this PR, I verified that sufficient unit tests are included to prevent regressions in this 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.
  • 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.mov
Android: mWeb Chrome
mweb-chrome.mov
iOS: Native
ios.mov
iOS: mWeb Safari
mweb-safari.mov
MacOS: Chrome / Safari
web.mov
MacOS: Desktop
desktop.mov

@s77rt
Copy link
Contributor

s77rt commented Dec 18, 2024

Screen.Recording.2024-12-19.at.12.28.46.AM.mov

Copy link
Contributor

🚧 @mountiny has triggered a test build. You can view the workflow run here.

@nkdengineer
Copy link
Contributor Author

@mountiny Sorry this new commit doesn't fix the empty bug above.

@mountiny mountiny changed the title fix: onboarding modal is not displayed in web [CP Staging] fix: onboarding modal is not displayed in web Dec 19, 2024
mountiny
mountiny previously approved these changes Dec 19, 2024
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.

This is working well for me now

Copy link
Contributor

🧪🧪 Use the links below to test this adhoc build on Android, iOS, Desktop, and Web. Happy testing! 🧪🧪

Android 🤖 iOS 🍎
https://ad-hoc-expensify-cash.s3.amazonaws.com/android/54329/index.html ❌ FAILED ❌
Android The QR code can't be generated, because the iOS build failed
Desktop 💻 Web 🕸️
https://ad-hoc-expensify-cash.s3.amazonaws.com/desktop/54329/NewExpensify.dmg https://54329.pr-testing.expensify.com
Desktop Web

👀 View the workflow run that generated this build 👀

@mountiny
Copy link
Contributor

Actually still having the issue with empty report screen after testing more

@nkdengineer
Copy link
Contributor Author

Yes this issue here #54329 (comment) only happens on this PR.

Copy link
Contributor

🚧 @mountiny has triggered a test build. You can view the workflow run here.

@@ -160,6 +165,7 @@ function ReportScreen({route, currentReportID = '', navigation}: ReportScreenPro
}

Log.info(`[ReportScreen] no reportID found in params, setting it to lastAccessedReportID: ${lastAccessedReportID}`);
lastAccessedReportIDRef.current = lastAccessedReportID;
navigation.setParams({reportID: lastAccessedReportID});
Copy link
Contributor Author

Choose a reason for hiding this comment

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

While the param is updating in the route, this useEffect can be triggered again, and navigation.setParams is called again with the outdated state that can cause the navigation stack to be overridden to the old state.

Copy link
Contributor

🧪🧪 Use the links below to test this adhoc build on Android, iOS, Desktop, and Web. Happy testing! 🧪🧪

Android 🤖 iOS 🍎
https://ad-hoc-expensify-cash.s3.amazonaws.com/android/54329/index.html ❌ FAILED ❌
Android The QR code can't be generated, because the iOS build failed
Desktop 💻 Web 🕸️
https://ad-hoc-expensify-cash.s3.amazonaws.com/desktop/54329/NewExpensify.dmg https://54329.pr-testing.expensify.com
Desktop Web

👀 View the workflow run that generated this build 👀

@nkdengineer
Copy link
Contributor Author

Work well on dev now.

Screen.Recording.2024-12-19.at.18.58.23.mp4

@melvin-bot melvin-bot bot requested a review from mountiny December 19, 2024 12:25
@s77rt
Copy link
Contributor

s77rt commented Dec 19, 2024

Please fix the lint. We can use just a boolean for that ref

@nkdengineer
Copy link
Contributor Author

@s77rt The lint is related to the default value lint rule. I think we can skip here to prevent regression.

@nkdengineer
Copy link
Contributor Author

We can use just a boolean for that ref

Updated.

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!

@mountiny mountiny merged commit dd93c76 into Expensify:main Dec 19, 2024
15 of 16 checks passed
@melvin-bot melvin-bot bot added the Emergency label Dec 19, 2024
Copy link

melvin-bot bot commented Dec 19, 2024

@mountiny looks like this was merged without a test passing. Please add a note explaining why this was done and remove the Emergency label if this is not an emergency.

@mountiny
Copy link
Contributor

Not an emergency, the eslint failures are related to the default id and we are not going to change it here as this is fixing a deploy blocker

@OSBotify
Copy link
Contributor

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

@Julesssss
Copy link
Contributor

Hey @nkdengineer @s77rt. Sharing another bug report here which seems like it should be resolved with these changes?

@s77rt
Copy link
Contributor

s77rt commented Dec 19, 2024

Unrelated. We are looking in that one as well, it's a regression from #51681

OSBotify pushed a commit that referenced this pull request Dec 19, 2024
[CP Staging] fix: onboarding modal is not displayed in web

(cherry picked from commit dd93c76)

(CP triggered by mountiny)
@github-actions github-actions bot added the CP Staging marks PRs that have been CP'd to staging label Dec 19, 2024
Copy link
Contributor

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

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

@Expensify/applauseleads please QA this PR and check it off on the deploy checklist if it passes.

Copy link
Contributor

🚀 Deployed to production by https://github.com/jasperhuangg in version: 9.0.77-6 🚀

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CP Staging marks PRs that have been CP'd to staging Ready To Build
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants