App icon indicating copy to clipboard operation
App copied to clipboard

[WIP] add testID to chat title for applause automation

Open gireinvent opened this issue 1 year ago • 31 comments

Details

Fixed Issues

$ PROPOSAL:

Tests

  • [x] Verify that no errors appear in the JS console

Offline tests

QA Steps

  • [x] Verify that no errors appear in the JS console

PR Author Checklist

  • [x] I linked the correct issue in the ### Fixed Issues section above
  • [x] I wrote clear testing steps that cover the changes made in this PR
    • [x] I added steps for local testing in the Tests section
    • [x] I added steps for the expected offline behavior in the Offline steps section
    • [x] I added steps for Staging and/or Production testing in the QA steps section
    • [x] I added steps to cover failure scenarios (i.e. verify an input displays the correct error message if the entered data is not correct)
    • [x] 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)
    • [x] 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).
  • [x] I included screenshots or videos for tests on all platforms
  • [x] I ran the tests on all platforms & verified they passed on:
    • [x] Android: Native
    • [x] Android: mWeb Chrome
    • [x] iOS: Native
    • [x] iOS: mWeb Safari
    • [x] MacOS: Chrome / Safari
    • [x] MacOS: Desktop
  • [x] 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)
  • [x] I followed proper code patterns (see Reviewing the code)
    • [x] 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)
    • [x] I verified that the left part of a conditional rendering a React component is a boolean and NOT a string, e.g. myBool && <MyComponent />.
    • [x] I verified that comments were added to code that is not self explanatory
    • [x] 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.
    • [x] I verified any copy / text shown in the product is localized by adding it to src/languages/* files and using the translation method
      • [x] 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:
    • [x] I verified all numbers, amounts, dates and phone numbers shown in the product are using the localization methods
    • [x] 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.
    • [x] 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.
    • [x] I verified the JSDocs style guidelines (in STYLE.md) were followed
  • [x] If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
  • [x] I followed the guidelines as stated in the Review Guidelines
  • [x] 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)
  • [x] I verified all code is DRY (the PR doesn't include any logic written more than once, with the exception of tests)
  • [x] 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
  • [x] I verified that if a function's arguments changed that all usages have also been updated correctly
  • [x] If any new file was added I verified that:
    • [x] 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
  • [x] If a new CSS style is added I verified that:
    • [x] A similar style doesn't already exist
    • [x] The style can't be created with an existing StyleUtils function (i.e. StyleUtils.getBackgroundAndBorderStyle(theme.componentBG))
  • [x] 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.
  • [x] 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)
  • [x] 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.
  • [x] 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.
  • [x] If the PR modifies the form input styles:
    • [x] I verified that all the inputs inside a form are aligned with each other.
    • [x] I added Design label so the design team can review the changes.
  • [x] 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.
  • [x] 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

gireinvent avatar Jan 21 '24 00:01 gireinvent

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

github-actions[bot] avatar Jan 21 '24 00:01 github-actions[bot]

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

melvin-bot[bot] avatar Jan 21 '24 00:01 melvin-bot[bot]

Details

Fixed Issues $ n/a

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

gireinvent avatar Jan 22 '24 01:01 gireinvent

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

hayata-suenaga avatar Jan 22 '24 14:01 hayata-suenaga

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

allroundexperts avatar Jan 23 '24 01:01 allroundexperts

@gireinvent Can you please fix lint issues?

allroundexperts avatar Jan 23 '24 01:01 allroundexperts

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

allroundexperts avatar Jan 23 '24 19:01 allroundexperts

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

gireinvent avatar Jan 24 '24 02:01 gireinvent

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

roryabraham avatar Jan 24 '24 02:01 roryabraham

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

roryabraham avatar Jan 24 '24 02:01 roryabraham

@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?

hayata-suenaga avatar Jan 24 '24 18:01 hayata-suenaga

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

gireinvent avatar Jan 24 '24 18:01 gireinvent

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.

hayata-suenaga avatar Jan 24 '24 22:01 hayata-suenaga

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

gireinvent avatar Jan 24 '24 22:01 gireinvent

did you add IDs to root components/elements?

hayata-suenaga avatar Jan 24 '24 22:01 hayata-suenaga

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

hayata-suenaga avatar Jan 24 '24 22:01 hayata-suenaga

did you add IDs to root components/elements?

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

gireinvent avatar Jan 24 '24 22:01 gireinvent

@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 avatar Jan 25 '24 16:01 hayata-suenaga

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

hayata-suenaga avatar Jan 25 '24 16:01 hayata-suenaga

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

  1. Checklist: Failing because its incomplete. There seem to be 2 missing items.
  2. 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.
  3. As you can clearly see below, the commits are unsigned. The user needs to redo all his commits with a new GPG key. Screenshot 2024-01-25 at 11 53 38 PM

allroundexperts avatar Jan 25 '24 18:01 allroundexperts

@gireinvent

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

hayata-suenaga avatar Jan 26 '24 15:01 hayata-suenaga

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

allroundexperts avatar Jan 30 '24 20:01 allroundexperts

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

gireinvent avatar Jan 30 '24 20:01 gireinvent

@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 avatar Feb 02 '24 17:02 roryabraham

Sure @roryabraham, for now i am reverting the testID from DisplayNames because its cascading a lot of changes in the other components. Will submit new commit soon.

gireinvent avatar Feb 02 '24 17:02 gireinvent

@roryabraham I have narrowed down to just one change. I have also verified that are no errors: image

and its signed: Pasted Graphic 1

gireinvent avatar Feb 04 '24 23:02 gireinvent

I checked all the items on the checklist, looks like checklist is passing now.

gireinvent avatar Feb 05 '24 18:02 gireinvent

Reviewer Checklist

  • [x] I have verified the author checklist is complete (all boxes are checked off).
  • [x] I verified the correct issue is linked in the ### Fixed Issues section above
  • [x] I verified testing steps are clear and they cover the changes made in this PR
    • [x] I verified the steps for local testing are in the Tests section
    • [x] I verified the steps for Staging and/or Production testing are in the QA steps section
    • [x] 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)
    • [x] 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)
  • [x] I checked that screenshots or videos are included for tests on all platforms
  • [x] I included screenshots or videos for tests on all platforms
  • [x] I verified tests pass on all platforms & I tested again on:
    • [x] Android: Native
    • [x] Android: mWeb Chrome
    • [x] iOS: Native
    • [x] iOS: mWeb Safari
    • [x] MacOS: Chrome / Safari
    • [x] MacOS: Desktop
  • [x] 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
  • [x] I verified proper code patterns were followed (see Reviewing the code)
    • [x] 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).
    • [x] I verified that the left part of a conditional rendering a React component is a boolean and NOT a string, e.g. myBool && <MyComponent />.
    • [x] I verified that comments were added to code that is not self explanatory
    • [x] 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.
    • [x] I verified any copy / text shown in the product is localized by adding it to src/languages/* files and using the translation method
    • [x] I verified all numbers, amounts, dates and phone numbers shown in the product are using the localization methods
    • [x] 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.
    • [x] 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.
    • [x] I verified the JSDocs style guidelines (in STYLE.md) were followed
  • [x] If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
  • [x] I verified that this PR follows the guidelines as stated in the Review Guidelines
  • [x] 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)
  • [x] I verified all code is DRY (the PR doesn't include any logic written more than once, with the exception of tests)
  • [x] 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
  • [x] If a new component is created I verified that:
    • [x] A similar component doesn't exist in the codebase
    • [x] All props are defined accurately and each prop has a /** comment above it */
    • [x] The file is named correctly
    • [x] The component has a clear name that is non-ambiguous and the purpose of the component can be inferred from the name alone
    • [x] The only data being stored in the state is data necessary for rendering and nothing else
    • [x] 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)
    • [x] 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)
    • [x] All JSX used for rendering exists in the render method
    • [x] 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
  • [x] If any new file was added I verified that:
    • [x] 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
  • [x] If a new CSS style is added I verified that:
    • [x] A similar style doesn't already exist
    • [x] The style can't be created with an existing StyleUtils function (i.e. StyleUtils.getBackgroundAndBorderStyle(theme.componentBG)
  • [x] 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.
  • [x] 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)
  • [x] 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.
  • [x] 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.
  • [x] If the PR modifies the form input styles:
    • [x] I verified that all the inputs inside a form are aligned with each other.
    • [x] I added Design label so the design team can review the changes.
  • [x] 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.
  • [x] 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.
  • [x] 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

roryabraham avatar Feb 05 '24 22:02 roryabraham

There appear to be some unsigned commits.

hayata-suenaga avatar Feb 06 '24 00:02 hayata-suenaga

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

gireinvent avatar Feb 06 '24 00:02 gireinvent