Skip to content

Create SaaStr Demo flow #24535

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

Merged
merged 36 commits into from
Aug 23, 2023
Merged

Create SaaStr Demo flow #24535

merged 36 commits into from
Aug 23, 2023

Conversation

Beamanator
Copy link
Contributor

@Beamanator Beamanator commented Aug 14, 2023

cc @cristipaval since you're working on the API command in the BE

Details

A few notes:

  1. I didn't think it was worth it to optimistically tie a reimbursement account to the saastr workspace, I don't think that needs to be done offline
  2. I thought it would be "fine" if "created" report actions were optimistically "owned" by the user, since eventually they'll own these workspaces & therefore it's like they created the workspace themselves
  3. Similar ^ with the expense chat report, we will need to test if this makes a difference
  4. This PR created a SaaStr landing page, but didn't account for actions that need to be taken following signing in, so I gutted a bit of the logic so we could have it be an Auth screen (so we return there after logging in)

Fixed Issues

$ https://github.com/Expensify/Expensify/issues/307946

Tests

Before running these tests, you'll want to create some accounts in your dev environment with the emails [email protected] and [email protected]. Then you'll want to update your local .env file with EXPENSIFY_ACCOUNT_ID_SAASTR=<your-saastr-account-ID> and EXPENSIFY_ACCOUNT_ID_SBE=<your-sbe-account-ID>

  1. Sign out of the app
  2. Verify you see the standard welcome message in the sign in screen, "Get started below."
  3. Navigate to http://localhost:8082/saastr
  4. Verify you're still back on the signin screen, but now the welcome message header has been updated:
Screen.Recording.2023-08-22.at.12.08.15.PM.mov
  1. Sign in
  2. Verify you're navigated to a brand new workspace chat. This workspace should have the following properties in Onyx:
    1. Owned by [email protected]
    2. Admin'd by [email protected], the user you just signed in as should be just a member (role = user)
  3. Verify, after API response comes back, you're still on the workspace chat and everything looks good
  4. Verify you see a pre-loaded welcome message in the workspace chat
    1. Text:
    2. From the SaaStr account
  5. Try navigating to the workspace, make sure you can't see it in your workspace list (since you're not an admin)
  6. Verify you CAN see the new workspace announce room & you can send messages in it
  7. Verify you CANNOT see an #admins room for that workspace (since, again, you're not an admin)
  8. Navigate to a settings page (ex: /settings/profile) then manually navigate back to http://localhost:8082/saastr again
  9. Verify you are dropped back into the SaaStr workspace chat, and you don't see another network request for CreateSaastrDemoWorkspace

Test steps for SBE

  1. Same first few steps as above, you should see this intro message on the signin page:
Screen.Recording.2023-08-22.at.12.22.05.PM.mov
  1. Similarly, make sure after signing in you get navigated to your workspace chat
  2. Verify the welcome message is as expected and everything is working good like the other flow
  • Verify that no errors appear in the JS console

Offline tests

  1. Sign in while online, the normal way
  2. Send this link in any chat: http://localhost:8082/saastr
  3. Go offline
  4. Click the link - I think you should be navigated to that route even though you're offline?
  5. Verify you're navigated to an optimistic workspace chat room & you should see an #announce room in the LHN
  6. Verify you don't see a new #admins room in the LHN

QA Steps

Same as main test 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 / Chrome
    • iOS / native
    • iOS / 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 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
    • If we are not using the full Onyx data that we loaded, I've added the proper selector in order to ensure the component only re-renders when the data it is using changes
    • 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(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.
  • I have checked off every checkbox in the PR author checklist, including those that don't apply to this PR.

Screenshots/Videos

Web
Mobile Web - Chrome
Mobile Web - Safari
Desktop
iOS
Android

@Beamanator Beamanator requested a review from a team as a code owner August 14, 2023 14:02
@Beamanator Beamanator self-assigned this Aug 14, 2023
@melvin-bot melvin-bot bot requested review from burczu and removed request for a team August 14, 2023 14:02
@melvin-bot
Copy link

melvin-bot bot commented Aug 14, 2023

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

@Beamanator Beamanator marked this pull request as draft August 14, 2023 14:02
@Beamanator
Copy link
Contributor Author

@burczu please don't review yet, this is still WIP 🙏

@cristipaval cristipaval self-requested a review August 15, 2023 17:13
@cristipaval
Copy link
Contributor

cristipaval commented Aug 22, 2023

just resolved.
While testing this locally, I realised that there is an issue. The name of the newly created workspace is Unavailable workspace instead of Saastr Workspace. This is because we have a bug in Web-E. I have a PR to fix that.

Co-authored-by: Abdelhafidh Belalia <[email protected]>
@cristipaval cristipaval requested a review from s77rt August 22, 2023 20:19
@s77rt
Copy link
Contributor

s77rt commented Aug 22, 2023

Tried SBE flow and got stuck at loader. The BE returned a 404
Screenshot from 2023-08-22 21-20-24

@s77rt
Copy link
Contributor

s77rt commented Aug 22, 2023

Before running these tests, you'll want to create some accounts in your dev environment with the emails [email protected] and [email protected]. Then you'll want to update your local .env file with EXPENSIFY_ACCOUNT_ID_SAASTR= and EXPENSIFY_ACCOUNT_ID_SBE=

This is not required, right? I can seem to test without passing through this

@cristipaval
Copy link
Contributor

Tried SBE flow and got stuck at loader. The BE returned a 404 Screenshot from 2023-08-22 21-20-24

Hmm.. I think there's no [email protected] account created yet. @dylanexpensify could you confirm?

@cristipaval
Copy link
Contributor

cristipaval commented Aug 22, 2023

Before running these tests, you'll want to create some accounts in your dev environment with the emails [email protected] and [email protected]. Then you'll want to update your local .env file with EXPENSIFY_ACCOUNT_ID_SAASTR= and EXPENSIFY_ACCOUNT_ID_SBE=

This is not required, right? I can seem to test without passing through this

I think you're right, this is not required anymore given that we got rid off the optimistic pattern, @Beamanator.

@s77rt
Copy link
Contributor

s77rt commented Aug 22, 2023

If we navigate offline to the saastr page the welcome message is not visible instead a skeleton is shown

Kooha-2023-08-22-22-08-17.webm

@s77rt
Copy link
Contributor

s77rt commented Aug 22, 2023

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 / Chrome
    • iOS / native
    • iOS / 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 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 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(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.
  • I have checked off every checkbox in the PR reviewer checklist, including those that don't apply to this PR.

Screenshots/Videos

Web
web.webm
Mobile Web - Chrome
mweb-chrome-1.webm
mweb-chrome-2.webm
Mobile Web - Safari
mweb-safari.webm
Desktop
desktop.mp4
iOS
ios.webm
Android
android.webm

@s77rt
Copy link
Contributor

s77rt commented Aug 22, 2023

@cristipaval I'm approving the PR for now. I don't think #24535 (comment) is a blocker (can be addressed in a follow up). We can wait for https://github.com/Expensify/Web-Expensify/pull/38593 if required. (same thing for #24535 (comment))

Copy link
Contributor

@s77rt s77rt left a comment

Choose a reason for hiding this comment

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

LGTM! 🚀

@melvin-bot melvin-bot bot requested a review from deetergp August 22, 2023 22:01
@melvin-bot
Copy link

melvin-bot bot commented Aug 22, 2023

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

melvin-bot bot commented Aug 22, 2023

🎯 @s77rt, thanks for reviewing and testing this PR! 🎉

An E/App issue has been created to issue payment here: #25725.

@Beamanator
Copy link
Contributor Author

There should already be an [email protected] account, I can supportal into that account @cristipaval

Thanks so much for the tests so far y'all 🙏

@Beamanator Beamanator closed this Aug 23, 2023
@Beamanator Beamanator reopened this Aug 23, 2023
@cristipaval cristipaval merged commit 9a0dd42 into main Aug 23, 2023
@cristipaval cristipaval deleted the beaman-createSaastrDemoFeatures branch August 23, 2023 11:04
@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.

@OSBotify
Copy link
Contributor

🚀 Deployed to staging by https://github.com/cristipaval in version: 1.3.57-0 🚀

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

@OSBotify
Copy link
Contributor

🚀 Deployed to staging by https://github.com/cristipaval in version: 1.3.58-0 🚀

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

@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/luacmartins in version: 1.3.57-6 🚀

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

@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/luacmartins in version: 1.3.58-5 🚀

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.

5 participants