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

improvement: Add "Workspace" to Profile and Name at the workspace level for clarity. #53800

Merged
merged 9 commits into from
Dec 23, 2024

Conversation

Krishna2323
Copy link
Contributor

@Krishna2323 Krishna2323 commented Dec 10, 2024

Explanation of Change

Fixed Issues

$ #53399
PROPOSAL: #53399 (comment)

Tests

  1. Go to setting > Workspaces > Select a workspace
  2. Verify Workspace profile is shown in the LNH
  3. On profile page, verify Workspace profile is shown as the title and the icon is updated to Building
  4. On profile page, verify the label on the workspace name field is Workspace name
  5. Open workspace name edit page > Verify Workspace name is shown on the header and as the input label
  • Verify that no errors appear in the JS console

Offline tests

  1. Go to setting > Workspaces > Select a workspace
  2. Verify Workspace profile is shown in the LNH
  3. On profile page, verify Workspace profile is shown as the title and the icon is updated to Building
  4. On profile page, verify the label on the workspace name field is Workspace name
  5. Open workspace name edit page > Verify Workspace name is shown on the header and as the input label

QA Steps

  1. Go to setting > Workspaces > Select a workspace
  2. Verify Workspace profile is shown in the LNH
  3. On profile page, verify Workspace profile is shown as the title and the icon is updated to Building
  4. On profile page, verify the label on the workspace name field is Workspace name
  5. Open workspace name edit page > Verify Workspace name is shown on the header and as the input label
  • 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
    • 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_native.mp4
Android: mWeb Chrome
android_chrome.mp4
iOS: Native
ios_native.mp4
iOS: mWeb Safari
ios_safari.mp4
MacOS: Chrome / Safari
web_chrome.mp4
MacOS: Desktop
desktop_app.mp4

@Krishna2323 Krishna2323 requested review from a team as code owners December 10, 2024 00:04
@melvin-bot melvin-bot bot requested review from dannymcclain and eh2077 December 10, 2024 00:04
Copy link

melvin-bot bot commented Dec 10, 2024

@dannymcclain @eh2077 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]

@melvin-bot melvin-bot bot removed the request for review from a team December 10, 2024 00:04
@Krishna2323
Copy link
Contributor Author

Asked for translation verification here.

@shawnborton
Copy link
Contributor

@dannymcclain did you want to change the small icon used in the LHN too? From Home -> Building?

Signed-off-by: krishna2323 <[email protected]>
@Krishna2323
Copy link
Contributor Author

@dannymcclain did you want to change the small icon used in the LHN too? From Home -> Building?

Yes, sorry I missed that, updated now.

Second screenshot has the same label updates but also includes an icon and illustration update to tie into the visual language we typically use for workspaces:

Monosnap.screencast.2024-12-10.06-22-08.mp4

@dubielzyk-expensify
Copy link
Contributor

That looks right to me now 👍

@shawnborton
Copy link
Contributor

Nice, looks good to me too!

@eh2077
Copy link
Contributor

eh2077 commented Dec 10, 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 image image image
Android: mWeb Chrome image image image
iOS: Native image image image
iOS: mWeb Safari image image image
MacOS: Chrome / Safari image image
MacOS: Desktop image image

@dannymcclain
Copy link
Contributor

Looks good to me three—send it! 🚀

Also, @Expensify/design this is a bit of a tangent but is related... Now the Workspaces menu item and Workspace profile menu item use the same icon, but we do have this buildings icon we recently added. How would you both feel about swapping the Workspaces menu item icon for the buildings icon to add some distinction? Not super critical, just an idea!

CleanShot 2024-12-10 at 08 37 45@2x

@shawnborton
Copy link
Contributor

Super down with that, and I would say let's also replace the rocket ship with a building here too?

CleanShot 2024-12-10 at 09 41 49@2x

@dannymcclain
Copy link
Contributor

dannymcclain commented Dec 10, 2024

Super down with that, and I would say let's also replace the rocket ship with a building here too?

Great shout. We could even make the simple illustration multiple buildings too
CleanShot 2024-12-10 at 08 47 27@2x

@shawnborton
Copy link
Contributor

Big fan. Maybe we can squeeze those changes in here?

@dannymcclain
Copy link
Contributor

Big fan. Maybe we can squeeze those changes in here?

@Krishna2323 what do you think?

Summary for easiness:

  • Update the icon for the Workspaces menu item to be a buildings icon
  • Update the illustration in the Workspaces header to be a buildings illustration

Files ☺️

image

@Krishna2323
Copy link
Contributor Author

@Expensify/design, please check the update video below and let me know if I'm missing something 😅.

Monosnap.screencast.2024-12-11.08-43-10.mp4

@dubielzyk-expensify
Copy link
Contributor

Awesome! That looks pretty correct to me 👍

@eh2077
Copy link
Contributor

eh2077 commented Dec 11, 2024

Screen.Recording.2024-12-11.at.9.39.00.PM.mov

Looks good to me too!

@Krishna2323 It seems the PR author checklist workflow is failing. Can you check if it's up-to-date?

@dannymcclain
Copy link
Contributor

@Krishna2323 :chefkiss: lovely! Consider this approved from a design standpoint. 🚀

@Krishna2323
Copy link
Contributor Author

@eh2077, waiting for the translation verification.

@Krishna2323
Copy link
Contributor Author

@eh2077, translation has been confirmed, we are good to go.

@melvin-bot melvin-bot bot requested a review from carlosmiceli December 17, 2024 01:07
@eh2077
Copy link
Contributor

eh2077 commented Dec 19, 2024

@Krishna2323 There're conflicts need to be resolved, thank you

@Krishna2323
Copy link
Contributor Author

conflicts resolved.

@carlosmiceli carlosmiceli merged commit 5c8a21f into Expensify:main Dec 23, 2024
16 checks passed
@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.

Copy link
Contributor

🚀 Deployed to staging by https://github.com/carlosmiceli in version: 9.0.78-0 🚀

platform result
🤖 android 🤖 cancelled 🔪
🖥 desktop 🖥 cancelled 🔪
🍎 iOS 🍎 cancelled 🔪
🕸 web 🕸 success ✅
🤖🔄 android HybridApp 🤖🔄 cancelled 🔪
🍎🔄 iOS HybridApp 🍎🔄 cancelled 🔪

Copy link
Contributor

🚀 Deployed to staging by https://github.com/carlosmiceli in version: 9.0.78-0 🚀

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

2 similar comments
Copy link
Contributor

🚀 Deployed to staging by https://github.com/carlosmiceli in version: 9.0.78-0 🚀

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

Copy link
Contributor

🚀 Deployed to staging by https://github.com/carlosmiceli in version: 9.0.78-0 🚀

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

Copy link
Contributor

🚀 Deployed to staging by https://github.com/carlosmiceli in version: 9.0.78-0 🚀

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

@izarutskaya
Copy link

izarutskaya commented Dec 24, 2024

Copy link
Contributor

🚀 Deployed to staging by https://github.com/carlosmiceli in version: 9.0.78-0 🚀

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

Copy link
Contributor

🚀 Deployed to staging by https://github.com/carlosmiceli in version: 9.0.78-0 🚀

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

Copy link
Contributor

🚀 Deployed to production by https://github.com/jasperhuangg in version: 9.0.78-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
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

8 participants