feat: add note to clarify the workspace join link functionality #45374

dominictb · 2024-07-13T11:55:44Z

Details

Fixed Issues

$ #45303
PROPOSAL: #45303 (comment)

Tests

Open workspace profile, click on Share button show the workspace share modal

Verify that the note appear on top as design

Verify that no errors appear in the JS console

Offline tests

QA Steps

Open workspace profile, click on Share button show the workspace share modal

Verify that the note appear on top as design

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

Screenshots/Videos

Android: Native

android.webm

Android: mWeb Chrome

aweb.webm

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

MacOS: Desktop

Signed-off-by: dominictb <[email protected]>

melvin-bot · 2024-07-13T11:55:49Z

@shawnborton @DylanDylann One of you needs to 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]

dominictb · 2024-07-13T11:56:07Z

Need to confirm the translation.

src/pages/workspace/WorkspaceProfileSharePage.tsx

Signed-off-by: dominictb <[email protected]>

dominictb · 2024-07-15T08:09:23Z

@shawnborton does it look better?

shawnborton · 2024-07-15T09:48:08Z

Nice, I think that feels better - thanks!

shawnborton · 2024-07-16T10:02:28Z

@DylanDylann I think this one is ready for final review.

src/pages/workspace/WorkspaceProfileSharePage.tsx

DylanDylann · 2024-07-17T09:02:11Z

src/languages/en.ts

@@ -2061,6 +2061,11 @@ export default {
            lineItemLevel: 'Line-item level',
            reportLevel: 'Report level',
            appliedOnExport: 'Not imported into Expensify, applied on export',
+            shareNote: {
+                header: 'Easily share your workspace with other members.',
+                content:


@dominictb I think it is better to divide this text into two parts:

Share this QR code or copy the link below to make it easy for members to request access to your workspace. All requests to join the workspace will show up in the

room for your review.

With this approach, we don't need to apply logic to split the content in the component

dominictb · 2024-07-17T15:42:23Z

@DylanDylann updated.

DylanDylann · 2024-07-18T09:49:07Z

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

mountiny

Looks great, thank you!

DylanDylann · 2024-07-19T02:31:58Z

@dominictb Please resolve conflict

dominictb · 2024-07-19T07:38:54Z

@mountiny it should be good now.

mountiny

Thank you!

OSBotify · 2024-07-19T22:12:42Z

✋ 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 · 2024-07-23T08:35:56Z

🚀 Deployed to staging by https://github.com/mountiny in version: 9.0.11-0 🚀

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

OSBotify · 2024-07-24T00:16:14Z

🚀 Cherry-picked to staging by https://github.com/francoisl in version: 9.0.11-2 🚀

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

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

OSBotify · 2024-07-25T03:14:48Z

🚀 Deployed to production by https://github.com/francoisl in version: 9.0.11-5 🚀

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

OSBotify · 2024-07-26T05:13:37Z

🚀 Deployed to production by https://github.com/francoisl in version: 9.0.12-0 🚀

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

ikevin127 · 2024-11-26T22:43:45Z

src/pages/workspace/WorkspaceProfileSharePage.tsx

+                                        if (!adminRoom?.reportID) {
+                                            return;
+                                        }
+                                        Navigation.navigate(ROUTES.REPORT_WITH_ID.getRoute(adminRoom.reportID));


The navigation logic from this line led to the following issue:

[HOLD for payment 2024-12-03] [$125] Share Code - Inconsistent profile pic shape in admin room when accessed via #Admin hyperlink #52258

because the RHP modal was not being closed before navigating. We fixed the issue by using Navigation.dismissModal() like so:

Navigation.dismissModal(adminRoom.reportID);

which does both, dismiss the modal and then navigate to the room.

feat: add note to clarify the workspace join link functionality

8848236

Signed-off-by: dominictb <[email protected]>

dominictb requested a review from a team as a code owner July 13, 2024 11:55

melvin-bot bot removed the request for review from a team July 13, 2024 11:55

melvin-bot bot requested review from DylanDylann and shawnborton July 13, 2024 11:55

shawnborton reviewed Jul 15, 2024

View reviewed changes

src/pages/workspace/WorkspaceProfileSharePage.tsx Outdated Show resolved Hide resolved

fix: update padding

da87f49

Signed-off-by: dominictb <[email protected]>

Merge remote-tracking branch 'origin/main' into fix/45303-note-join

c3a1164

DylanDylann reviewed Jul 17, 2024

View reviewed changes

dominictb added 2 commits July 17, 2024 22:32

Merge remote-tracking branch 'origin/main' into fix/45303-note-join

13a3243

chore: update translation msg

4e43547

DylanDylann approved these changes Jul 18, 2024

View reviewed changes

melvin-bot bot requested a review from mountiny July 18, 2024 09:49

mountiny assigned dominictb Jul 18, 2024

mountiny previously approved these changes Jul 19, 2024

View reviewed changes

Merge remote-tracking branch 'origin/main' into fix/45303-note-join

5c33ee3

dominictb dismissed mountiny’s stale review via 5c33ee3 July 19, 2024 04:53

Merge remote-tracking branch 'origin/main' into fix/45303-note-join

d5f54b7

mountiny approved these changes Jul 19, 2024

View reviewed changes

mountiny merged commit b7a3deb into Expensify:main Jul 19, 2024
14 checks passed

github-actions bot mentioned this pull request Jul 23, 2024

Deploy Checklist: New Expensify 2024-07-23 #45991

Closed

95 tasks

melvin-bot bot mentioned this pull request Jul 25, 2024

[HOLD for payment 2024-08-01] [$125] Add note to clarify the workspace join link functionality #45303

Closed

dominictb deleted the fix/45303-note-join branch August 21, 2024 02:19

ikevin127 reviewed Nov 26, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: add note to clarify the workspace join link functionality #45374

feat: add note to clarify the workspace join link functionality #45374

dominictb commented Jul 13, 2024

melvin-bot bot commented Jul 13, 2024

dominictb commented Jul 13, 2024

dominictb commented Jul 15, 2024

shawnborton commented Jul 15, 2024

shawnborton commented Jul 16, 2024

DylanDylann Jul 17, 2024

DylanDylann Jul 17, 2024

dominictb commented Jul 17, 2024

DylanDylann commented Jul 18, 2024

mountiny left a comment

DylanDylann commented Jul 19, 2024

dominictb commented Jul 19, 2024

mountiny left a comment

OSBotify commented Jul 19, 2024

OSBotify commented Jul 23, 2024

OSBotify commented Jul 24, 2024

OSBotify commented Jul 25, 2024

OSBotify commented Jul 26, 2024

ikevin127 Nov 26, 2024

feat: add note to clarify the workspace join link functionality #45374

feat: add note to clarify the workspace join link functionality #45374

Conversation

dominictb commented Jul 13, 2024

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Jul 13, 2024

dominictb commented Jul 13, 2024

dominictb commented Jul 15, 2024

shawnborton commented Jul 15, 2024

shawnborton commented Jul 16, 2024

DylanDylann Jul 17, 2024

Choose a reason for hiding this comment

DylanDylann Jul 17, 2024

Choose a reason for hiding this comment

dominictb commented Jul 17, 2024

DylanDylann commented Jul 18, 2024

Reviewer Checklist

Screenshots/Videos

mountiny left a comment

Choose a reason for hiding this comment

DylanDylann commented Jul 19, 2024

dominictb commented Jul 19, 2024

mountiny left a comment

Choose a reason for hiding this comment

OSBotify commented Jul 19, 2024

OSBotify commented Jul 23, 2024

OSBotify commented Jul 24, 2024

OSBotify commented Jul 25, 2024

OSBotify commented Jul 26, 2024

ikevin127 Nov 26, 2024

Choose a reason for hiding this comment