add testID to chat title for applause automation #34858

gireinvent · 2024-01-21T00:38:24Z

Details

Fixed Issues

$
PROPOSAL:

Tests

Verify that no errors appear in the JS console

Offline tests

QA 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: 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 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 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 form input styles:
- I verified that all the inputs inside a form are aligned with each other.
- I added Design label 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: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

MacOS: Desktop

github-actions · 2024-01-21T00:38:39Z

CLA Assistant Lite bot All contributors have signed the CLA ✍️ ✅

melvin-bot · 2024-01-21T00:38:54Z

@hayata-suenaga 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]

gireinvent · 2024-01-22T01:40:06Z

Details

Fixed Issues
$ n/a

Tests
Run the web app and verify that data-testID is set correctly.

hayata-suenaga · 2024-01-22T14:09:46Z

@gireinvent can you sign the CLA as instructed in this comment? You just have to post a comment.

allroundexperts · 2024-01-23T01:22:05Z

@hayata-suenaga Whats up with these so many failing checks?

allroundexperts · 2024-01-23T01:22:41Z

@gireinvent Can you please fix lint issues?

allroundexperts · 2024-01-23T19:37:01Z

Bump on above @gireinvent. Also, @hayata-suenaga can you please add me as a reviewer here so that I can track this?

gireinvent · 2024-01-24T02:05:34Z

I have read the CLA Document and I hereby sign the CLA

roryabraham · 2024-01-24T02:31:18Z

Slack context: https://expensify.slack.com/archives/C9YU7BX5M/p1706063359592199?thread_ts=1705076728.473699&cid=C9YU7BX5M

roryabraham · 2024-01-24T02:32:28Z

Actually, not 100% sure if we need C+ here. Let me get back to you @allroundexperts

hayata-suenaga · 2024-01-24T18:27:59Z

@gireinvent did you get a chance to see Rory's comment on Slack about passing the test ID to native components?

do you have any idea why the tests are failing here?

gireinvent · 2024-01-24T18:34:25Z

@hayata-suenaga I do not have access to that slack space.

hayata-suenaga · 2024-01-24T22:27:08Z

ah sorry about that 🙇 here is the copy of the message

If we have to add testID at element level like continue or SignIN is it good enough if i add it at View, some thing like

I think I've already answered this question, but just for good measure: the example you showed would not work because the TextInput component in question is not a core component. You can see from the import that it's defined here. So in order for that example to work you would have to update our custom TextInput component to accept a testID prop, and pass that to a core component. On the web platform, that might be here.

gireinvent · 2024-01-24T22:36:04Z

@hayata-suenaga I have added testids as per rory's suggestion. I am not sure why tests are failing as i have only added test id's there should be no changes to behavior.

hayata-suenaga · 2024-01-24T22:43:13Z

did you add IDs to root components/elements?

hayata-suenaga · 2024-01-24T22:43:54Z

@roryabraham if you could help us here a little bit, I'd appreciate it 🙇

gireinvent · 2024-01-24T22:51:18Z

did you add IDs to root components/elements?

Yes i added to the root components which are implementing native react components

hayata-suenaga · 2024-01-25T16:14:48Z

@gireinvent by the way, could you link the GH issue for this PR in the original post? There is a section called Fixed Issues at the beginning of the issue template.

hayata-suenaga · 2024-01-25T16:15:00Z

@allroundexperts do you have an idea why these tests are failing?

allroundexperts · 2024-01-25T18:55:03Z

@hayata-suenaga I think the following explains why the above are failing:

Checklist: Failing because its incomplete. There seem to be 2 missing items.
Typescript: We're adding testId as a required parameter in DisplayNames/types.ts file but we're not always passing its value which causes the TS errors.
As you can clearly see below, the commits are unsigned. The user needs to redo all his commits with a new GPG key.

hayata-suenaga · 2024-01-26T15:33:33Z

@gireinvent

could you check the points by @allroundexperts and fix the issues?

roryabraham

Also pay attention to the other failing typescript errors (you can check these locally by running npm run typecheck after running npm install once).

You made testID a required prop of the DisplayNames component, but failed to provide that prop in many places where it was used.

roryabraham · 2024-01-29T20:31:39Z

src/components/DisplayNames/DisplayNamesTooltipItem.tsx

@@ -41,6 +43,7 @@ function DisplayNamesTooltipItem({
    displayName = '',
    textStyles = [],
    childRefs = {current: []},
+    testID = 'displayName',


const displayName = 'DisplayNamesTooltipItem'; function DisplayNamesTooltipItem({ ... testID = displayName, }): DisplayNameTooltipItemProps) { ... } DisplayNameTooltipItem.displayName = displayName;

Removed the testID prop as it is no longer needed

allroundexperts · 2024-01-30T20:39:22Z

I can take this over and do the changes if needed.

gireinvent · 2024-01-30T20:55:35Z

@roryabraham Yeah i realized this after submitting PR, i am making changes actively but its taking time as it has to change in multiple places.

roryabraham · 2024-02-02T17:11:55Z

@gireinvent feel free to ping me when this is ready for review again. in the meantime, I'm going to mark it as WIP

roryabraham · 2024-02-05T22:33:38Z

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 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(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 form input styles:
- I verified that all the inputs inside a form are aligned with each other.
- I added Design label 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

hayata-suenaga · 2024-02-06T00:15:16Z

There appear to be some unsigned commits.

hayata-suenaga

🟢

gireinvent · 2024-02-06T00:19:30Z

i rebased and force pushed commits as per @roryabraham suggestion.

gireinvent · 2024-02-06T00:19:58Z

@hayata-suenaga is the PR good to merge?

roryabraham

We still will not be able to merge this because the GPG key you signed the commits with is not registered with your GitHub account. In order to be able to merge this, each commit must show that it's Verified:

gireinvent

commit after rebase

roryabraham

@gireinvent getting closer – you need to rebase onto main, squashing all your commits into a single, signed commit. Then you can force-push to replace the 6 commits from this branch with a single, signed commit:

roryabraham

@gireinvent still have unverified commits here. Try this:

# This rewinds 5 commits in the history, keeping your latest changes
git reset --soft HEAD~5

# This adds a new commit, overwriting the commits you rewinded past
git commit -m "Add testID to DisplayNamesWithTooltips"

# Then push your changes to the remote branch
git push origin addtestIds_applause

gireinvent · 2024-02-08T22:18:14Z

@roryabraham Narrowed it down to one commit.

OSBotify · 2024-02-08T22:53:49Z

✋ 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-02-12T14:20:13Z

🚀 Deployed to staging by https://github.com/roryabraham in version: 1.4.40-0 🚀

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

OSBotify · 2024-02-13T18:25:34Z

🚀 Deployed to production by https://github.com/mountiny in version: 1.4.40-5 🚀

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

gireinvent requested a review from a team as a code owner January 21, 2024 00:38

melvin-bot bot removed the request for review from a team January 21, 2024 00:38

melvin-bot bot requested a review from hayata-suenaga January 21, 2024 00:38

roryabraham requested a review from allroundexperts January 24, 2024 02:30

roryabraham requested changes Jan 29, 2024

View reviewed changes

roryabraham changed the title ~~add testID to chat title for applause automation~~ [WIP] add testID to chat title for applause automation Feb 2, 2024

Expensify deleted a comment from allroundexperts Feb 5, 2024

hayata-suenaga previously approved these changes Feb 6, 2024

View reviewed changes

gireinvent force-pushed the addtestIds_applause branch from e27c94d to b8eb63e Compare February 6, 2024 00:17

roryabraham requested changes Feb 6, 2024

View reviewed changes

gireinvent commented Feb 6, 2024

View reviewed changes

gireinvent force-pushed the addtestIds_applause branch from b8eb63e to 301fbd1 Compare February 6, 2024 00:55

roryabraham requested changes Feb 6, 2024

View reviewed changes

gireinvent dismissed hayata-suenaga’s stale review via 1d3ec7e February 6, 2024 01:14

gireinvent force-pushed the addtestIds_applause branch 3 times, most recently from 3d4ad92 to 7d27853 Compare February 6, 2024 23:47

roryabraham requested changes Feb 7, 2024

View reviewed changes

gireinvent force-pushed the addtestIds_applause branch from 7d27853 to fca8eb5 Compare February 7, 2024 18:34

Reset with main and added testID

f9ec12f

gireinvent force-pushed the addtestIds_applause branch from fca8eb5 to f9ec12f Compare February 8, 2024 20:37

roryabraham approved these changes Feb 8, 2024

View reviewed changes

roryabraham changed the title ~~[WIP] add testID to chat title for applause automation~~ add testID to chat title for applause automation Feb 8, 2024

roryabraham merged commit 176675b into Expensify:main Feb 8, 2024
16 checks passed

add testID to chat title for applause automation #34858

add testID to chat title for applause automation #34858

Conversation

gireinvent commented Jan 21, 2024 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

github-actions bot commented Jan 21, 2024 • edited Loading

melvin-bot bot commented Jan 21, 2024

gireinvent commented Jan 22, 2024

hayata-suenaga commented Jan 22, 2024

allroundexperts commented Jan 23, 2024

allroundexperts commented Jan 23, 2024

allroundexperts commented Jan 23, 2024

gireinvent commented Jan 24, 2024

roryabraham commented Jan 24, 2024

roryabraham commented Jan 24, 2024

hayata-suenaga commented Jan 24, 2024

gireinvent commented Jan 24, 2024

hayata-suenaga commented Jan 24, 2024 • edited Loading

gireinvent commented Jan 24, 2024

hayata-suenaga commented Jan 24, 2024

hayata-suenaga commented Jan 24, 2024

gireinvent commented Jan 24, 2024

hayata-suenaga commented Jan 25, 2024

hayata-suenaga commented Jan 25, 2024

allroundexperts commented Jan 25, 2024

hayata-suenaga commented Jan 26, 2024

roryabraham left a comment

Choose a reason for hiding this comment

roryabraham Jan 29, 2024

Choose a reason for hiding this comment

gireinvent Feb 4, 2024

Choose a reason for hiding this comment

allroundexperts commented Jan 30, 2024

gireinvent commented Jan 30, 2024 • edited Loading

roryabraham commented Feb 2, 2024

roryabraham commented Feb 5, 2024

Reviewer Checklist

Screenshots/Videos

hayata-suenaga commented Feb 6, 2024

hayata-suenaga left a comment

Choose a reason for hiding this comment

gireinvent commented Feb 6, 2024

gireinvent commented Feb 6, 2024

roryabraham left a comment

Choose a reason for hiding this comment

gireinvent left a comment

Choose a reason for hiding this comment

roryabraham left a comment

Choose a reason for hiding this comment

roryabraham left a comment • edited Loading

Choose a reason for hiding this comment

gireinvent commented Feb 8, 2024

OSBotify commented Feb 8, 2024

OSBotify commented Feb 12, 2024

OSBotify commented Feb 13, 2024

gireinvent commented Jan 21, 2024 •

edited

Loading

github-actions bot commented Jan 21, 2024 •

edited

Loading

hayata-suenaga commented Jan 24, 2024 •

edited

Loading

gireinvent commented Jan 30, 2024 •

edited

Loading

roryabraham left a comment •

edited

Loading