Skip to content

New welcome message for deleted #admins/#announce rooms #8239

Closed
thesahindia wants to merge 6 commits intoExpensify:mainfrom
thesahindia:thesahindia/room-welcome-text
Closed

New welcome message for deleted #admins/#announce rooms #8239
thesahindia wants to merge 6 commits intoExpensify:mainfrom
thesahindia:thesahindia/room-welcome-text

Conversation

@thesahindia
Copy link
Member

@thesahindia thesahindia commented Mar 19, 2022

Details

Used RenderHTML for little refactor and added a new welcome text for deleted #admins/#announce rooms

Fixed Issues

$ #7625

Tests | QA Steps

  1. Create a workspace
  2. Delete that workspace
  3. Search #announce or #admins
  4. Choose the #announce(deleted) or #admins (deleted)
  5. Verify it says "You missed the party in #annouce(deleted), there's nothing to see here."
  • Verify that no errors appear in the JS console

PR Review Checklist

Contributor (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 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 included screenshots or videos for tests on all platforms
  • I ran the tests on all platforms & verified they passed on:
    • iOS / native
    • Android / native
    • iOS / Safari
    • Android / Chrome
    • MacOS / Chrome
    • 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 was added in all src/languages/* files
    • I verified any copy / text that was added to the app is correct english and approved by marketing by tagging the marketing team 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
  • I verified any variables that can be defined as constants (ie. in CONST.js) 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 */
    • Any functional components have the displayName property
    • 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
    • Any internal methods are bound to “this” properly so there are no scoping issues
    • Any internal methods bound to “this” are necessary to be bound
    • 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
  • 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)

PR Reviewer Checklist

  • 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 verified tests pass on all platforms & I tested again on:
    • iOS / native
    • Android / native
    • iOS / Safari
    • Android / Chrome
    • MacOS / Chrome
    • 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 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 was added in all src/languages/* files
    • I verified any copy / text that was added to the app is correct english and approved by marketing by tagging the marketing team 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 are not impacted by changes in this PR (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
  • I verified any variables that can be defined as constants (ie. in CONST.js) 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 */
    • Any functional components have the displayName property
    • 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
    • Any internal methods are bound to “this” properly so there are no scoping issues
    • Any internal methods bound to “this” are necessary to be bound
    • 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 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)

Screenshots

Web

Screenshot 2022-03-22 at 7 02 24 PM

Mobile Web

Screenshot 2022-03-22 at 7 01 48 PM

Desktop

Screenshot 2022-03-22 at 7 05 12 PM

iOS

Screenshot 2022-03-22 at 7 06 20 PM

Android

Screenshot 2022-03-22 at 7 00 57 PM

@thesahindia thesahindia requested a review from a team as a code owner March 19, 2022 11:46
@AndrewGable AndrewGable requested review from a team and removed request for a team March 21, 2022 22:22
@melvin-bot melvin-bot bot requested review from roryabraham and rushatgabhane and removed request for a team March 21, 2022 22:22
@thesahindia
Copy link
Member Author

@rushatgabhane, it's ready for the review now.

Copy link
Member

@rushatgabhane rushatgabhane left a comment

Choose a reason for hiding this comment

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

@thesahindia looking good 🎉 I've requested some code style changes. Let me know if we can do even better.

Also, please add screenshot for iOS - Safari because we have a style change.
Thanks!!

const policyName = lodashGet(props.policies, [`${ONYXKEYS.COLLECTION.POLICY}${props.report.policyID}`, 'name'], Localize.translateLocal('workspace.common.unavailable'));

// Show different welcome messages depending on if the room is archived or not and its visiblity.
function chatRoomWelcomeText() {
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
function chatRoomWelcomeText() {
function getWelcomeMessage() {

// Use the policyName or fallback to default text if it's unavailable.
const policyName = lodashGet(props.policies, [`${ONYXKEYS.COLLECTION.POLICY}${props.report.policyID}`, 'name'], Localize.translateLocal('workspace.common.unavailable'));

// Show different welcome messages depending on if the room is archived or not and its visiblity.
Copy link
Member

@rushatgabhane rushatgabhane Mar 23, 2022

Choose a reason for hiding this comment

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

What do you think about this?

Suggested change
// Show different welcome messages depending on if the room is archived or not and its visiblity.
/**
* Get welcome message based on room visiblity and archive state.
* @returns ..
*/


// Show different welcome messages depending on if the room is archived or not and its visiblity.
function chatRoomWelcomeText() {
// eslint-disable-next-line no-nested-ternary
Copy link
Member

Choose a reason for hiding this comment

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

@thesahindia let's not do this, it's hard to read.
How about using if else?

defaultTextProps={{
style: styles.textAlignCenter,
}}
source={{html: props.translate('reportActionsView.beginningOfChatHistoryPrivate', {reportName: props.report.reportName})}}
Copy link
Member

Choose a reason for hiding this comment

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

@thesahindia I believe we can DRY RenderHTML. Because only the source prop is different.

: `${props.translate('reportActionsView.beginningOfChatHistoryPrivatePartTwo')}`}
</Text>
</>
<RenderHTML
Copy link
Member

Choose a reason for hiding this comment

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

Let's move this to getWelcomeMessage()

@roryabraham
Copy link
Contributor

roryabraham commented Mar 23, 2022

Sorry @rushatgabhane @thesahindia, please pause development here. It has come to my attention that using react-native-render-html in this manner is a pattern that does not have wide consensus. (context)

Sorry for potentially leading you down the wrong path here. I'm going to bring this question up in Slack in the next few days and get consensus on the best way to handle this pattern going forward.

@thesahindia If you don't want to wait until next week to keep working on this, you can go back to the original solution you posted in the issue (using plain text only). As that is an existing pattern in this codebase, we can use it without needing to gain broader consensus.

@thesahindia
Copy link
Member Author

@thesahindia If you don't want to wait until next week to keep working on this, you can go back to the original solution you posted in the issue (using plain text only). As that is an existing pattern in this codebase, we can use it without needing to gain broader consensus.

It's fine by me, I can wait here.

@rushatgabhane
Copy link
Member

I'm going to bring this question up in Slack in the next few days and get consensus on the best way to handle this pattern going forward.

This is good. Yeah, let's wait

@thesahindia
Copy link
Member Author

I am having some problems when merging main, also the code needs to be change here so I am closing this one and will raise a new PR.

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.

3 participants