fix: 26657 Another error message for a short time when opening archived chat from search bar

[tienifr]

Details

Fixed Issues

$ #26657
PROPOSAL: #26657 (comment)

Tests

1. Open app
2. Click on search icon and find any archived workspace that has some messages in it so that it should be loaded for a short time.
3. If there's no archived workspace that is not loaded before, sign out and sign in again
4. Verify that the skeleton is shown at the bottom where the reason for the chat being archived will show until the message is loaded

• Verify that no errors appear in the JS console

Offline tests

QA Steps

1. Open app
2. Click on search icon and find any archived workspace that has some messages in it so that it should be loaded for a short time.
3. If there's no archived workspace that is not loaded before, sign out and sign in again
4. Verify that the skeleton is shown at the bottom where the reason for the chat being archived will show until the message is loaded

• 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

Screen.Recording.2023-09-14.at.15.35.59.mov

Mobile Web - Chrome

Screenrecorder-2023-09-14-15-41-13-792.mp4

Mobile Web - Safari

Screen.Recording.2023-09-14.at.15.39.57.mov

Desktop

Screen.Recording.2023-09-14.at.15.46.26.mov

iOS

Screen.Recording.2023-09-14.at.15.59.51.mov

Android

Screen.Recording.2023-09-14.at.15.59.51.mov

[melvin-bot]

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

[jjcoffee]

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

chrome-desktop-2023-10-05_15.39.36.mp4

Mobile Web - Chrome

android-chrome.mp4

Mobile Web - Safari

ios-safari-2023-10-05_16.32.09.mp4

Desktop

mac-desktop-2023-10-05_16.37.34.mp4

iOS

ios-native-2023-10-05_16.40.13.mp4

Android

android-native.mp4

[jjcoffee]

@tienifr Please can you update the last step to clarify that we're verifying that a skeleton is showing at the bottom where the reason for the chat being archived will show? Thanks!

[jjcoffee]

@robertjchen Should we get some design eyes on the look of the skeleton at this stage?

[jjcoffee]

@tienifr Also another test step to help reproducing is to sign out if you're already signed in - I wasn't able to get the skeleton to show otherwise! Could you add that?

[robertjchen]

@jjcoffee That would be great! Is there a visual screenshot for Design to evaluate/tweak, or would we need them to design something entirely new specifically for this?

[tienifr]

@jjcoffee Thanks. I updated the test steps

[jjcoffee]

@robertjchen Sure here's a screengrab from one of the videos:

[tienifr]

@robertjchen any updates?

[jjcoffee]

Hey @shawnborton or @dannymcclain we need some design eyes on a new skeleton we're adding for displaying the reason why a chat is archived. See still screenshot here (at the very bottom of the RHP). Thanks!

[dannymcclain]

I think this is fine. IMO it feels a tad heavier than necessary but it totally works, and it's not something that I'm super passionate/concerned about. @shawnborton can weigh in too if he has strong feels.

[shawnborton]

Can we see what it looks like if we have the reason box but no skeleton line in it? I feel like we might be fine if it's just the highlighted box at the bottom.

[tienifr]

@shawnborton Here you are. I think the skeleton line is better

[shawnborton]

Ah sorry, I meant just no skeleton line within the box at the bottom. But we'd still use skeletons above it right?

[tienifr]

The image below I use skeletons for it. Is it your mean? @shawnborton

[shawnborton]

Ah no, apologies. I meant in this screen here:

Keep the message skeletons, but in the archived reason box, remove the skeleton line and just use the box BG.

[tienifr]

I already posted this here #27420 (comment). I just removed the skeleton line and keep the box BG @shawnborton

[shawnborton]

Okay, yeah, I think I prefer that more though because in this screenshot here, the single skeleton line in the archived reason box feels like it's out of place compared to the other lines above it:

So I think not having it might feel more subtle. cc @Expensify/design for thoughts though, as I don't feel strongly.

[tienifr]

any updates @shawnborton

[shawnborton]

Can you get me a side-by-side comparison, where one screenshot has the skeleton in the archive box and the other does not? Basically this screenshot, but no skeleton in the archive reason box. Thanks!

[tienifr]

@shawnborton Here you are

[shawnborton]

Okay cool, I don't feel too strongly here. I guess the line version makes more sense. Curious if @Expensify/design has any strong opinions here, what do you think?

[dannymcclain]

What if we just made that bottom box have the same color/gradient effect as the avatar and message skeleton? I feel like we could just use that as our "skeleton style" for everything. I don't see a strong reason for it to be different. But I also don't feel super super strongly.

[shawnborton]

Oh nice, I like that idea!

[tienifr]

@dannymcclain @shawnborton Just want to confirm it's your idea? If yes, I'll record the video for other platforms. Thanks

Screen.Recording.2023-09-29.at.10.44.51.mov

[dannymcclain]

@tienifr That bottom box doesn't look like it's matching the same color as the avatar/message skeleton. The concept is right though, we just want ALL of the skeleton UI elements to share the same color/gradient effect.

[tienifr]

@dannymcclain I believe it's the same. I also use the same component as the avatar/message.

[dannymcclain]

Hmm, it's not looking the same to me by eye or when I sample the hex codes. Maybe something unexpected it happening?

[tienifr]

@dannymcclain Ah I see, sorry for this confusion, I've update the PR a bit. Can you please help take a look at the result below. Thanks

Screen.Recording.2023-10-02.at.11.05.25.mov

[shawnborton]

Nice, that's feelin' better for sure!

[dannymcclain]

Yeah lookin' good!

[tienifr]

@jjcoffee Can you please help take a look when you have a chance? Thanks

[jjcoffee]

@tienifr Yes, thanks for the bump - reviewing today!

[jjcoffee]

LGTM!

[robertjchen]

Looks great!

[OSBotify]

✋ 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]

🚀 Deployed to staging by https://github.com/robertjchen in version: 1.3.79-0 🚀

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

[amyevans]

👋 This PR was reverted here: #29106

[OSBotify]

🚀 Deployed to production by https://github.com/jasperhuangg in version: 1.3.79-5 🚀

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

[OSBotify]

🚀 Deployed to production by https://github.com/jasperhuangg in version: 1.3.79-5 🚀

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

[OSBotify]

🚀 Deployed to production by https://github.com/jasperhuangg in version: 1.3.79-5 🚀

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