App icon indicating copy to clipboard operation
App copied to clipboard

Migrate index.native.js to function component

Open kadiealexander opened this issue 1 year ago • 36 comments

Details

Fixed Issues

$ https://github.com/Expensify/App/issues/16187 PROPOSAL:

Tests

  1. Upload a password-protected PDF to an Expensify chat
  2. Open the PDF
  3. Click to enter the password
  4. Enter the correct password
  5. Verify the PDF appears
  6. Close the PDF
  7. Open the PDF
  8. Click to enter the password
  9. Enter an incorrect password
  10. Verify that an incorrect password error occurs
  • [x] Verify that no errors appear in the JS console

Offline tests

If you go offline once the PDF is uploaded, you should be able to still complete the steps above.

QA Steps

  • [ ] 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 / Chrome
    • [x] iOS / native
    • [x] iOS / 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 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] 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
      • [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(themeColors.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 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 author checklist, including those that don't apply to this PR.

Screenshots/Videos

Web

https://github.com/Expensify/App/assets/59587260/fdca4dc1-3f09-4e50-a18b-ea241b5c191d

Mobile Web - Chrome

https://github.com/Expensify/App/pull/24615#issuecomment-1797941582

Mobile Web - Safari

https://github.com/Expensify/App/assets/59587260/1dfbed07-b661-46b4-9892-5362a9b7d22a

Desktop

https://github.com/Expensify/App/assets/59587260/0bff4df1-8299-443d-9b09-ebe8920c0a53

iOS

https://github.com/Expensify/App/assets/59587260/7d98cb69-cb43-4ce0-8033-863111466886

Android

https://github.com/Expensify/App/pull/24615#issuecomment-1797941582

kadiealexander avatar Aug 16 '23 07:08 kadiealexander

Deploying with  Cloudflare Pages  Cloudflare Pages

Latest commit: 3597be6
Status: ✅  Deploy successful!
Preview URL: https://14bcf6fc.helpdot.pages.dev
Branch Preview URL: https://kadie-native-index-update.helpdot.pages.dev

View logs

@0xmiroslav @puneetlath I'd love your thoughts on this! When testing this, I get stuck in a "invalid password" loop even though I know my PDF password is valid. I don't get any console errors or anything to help me debug, it just declines my password every time. Could either of you take a look and see what might be causing this? 🙏 I'm at a loss!

kadiealexander avatar Oct 17 '23 03:10 kadiealexander

No issue for me. Also tested this branch. Can you try with this pdf? (password is 12345678)

test_pwd.pdf

0xmiroslav avatar Oct 17 '23 07:10 0xmiroslav

@0xmiroslav I'm still getting the "wrong password" error when using your PDF:

image

Are you also testing on iOS?

kadiealexander avatar Oct 20 '23 03:10 kadiealexander

yes, iOS. So you cannot reproduce on main but only on this branch?

0xmiroslav avatar Oct 20 '23 04:10 0xmiroslav

Yup, works fine on main!

image

kadiealexander avatar Oct 20 '23 04:10 kadiealexander

@Puneetlath @0xmiroslav any thoughts on what might be causing this issue? Puneet, could you please try testing my branch and see if you run into the same issue?

kadiealexander avatar Oct 27 '23 05:10 kadiealexander

Fixed it! @0xmiroslav I'm not able to test on Android, my dev environment is busted. Are you please able to test on Android mWeb and Native for me?

kadiealexander avatar Nov 07 '23 07:11 kadiealexander

Fixed it! @0xmiroslav I'm not able to test on Android, my dev environment is busted. Are you please able to test on Android mWeb and Native for me?

yes. Please mark ready for review when ready

0xmiroslav avatar Nov 07 '23 07:11 0xmiroslav

@ 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 Nov 13 '23 07:11 melvin-bot[bot]

Please pull main. The branch conflicts

0xmiroslav avatar Nov 13 '23 10:11 0xmiroslav

@0xmiroslav I've addressed the comments you left, could you please review again?

kadiealexander avatar Nov 27 '23 22:11 kadiealexander

@0xmiroslav bump for review please!!

kadiealexander avatar Dec 04 '23 20:12 kadiealexander

reviewing now

0xmiroslav avatar Dec 04 '23 20:12 0xmiroslav

@0xmiroslav I've addressed your comments, please review again when you get a chance.

kadiealexander avatar Dec 11 '23 22:12 kadiealexander

@0xmiroslav bump!

kadiealexander avatar Dec 18 '23 06:12 kadiealexander

There's conflict

0xmiroslav avatar Dec 18 '23 06:12 0xmiroslav

@0xmiroslav could you please check this one again?

kadiealexander avatar Jan 08 '24 20:01 kadiealexander

can you please fix lint error and jest unit tests?

0xmiroslav avatar Jan 11 '24 04:01 0xmiroslav

Also pull main to fix reassure performance tests

0xmiroslav avatar Jan 11 '24 04:01 0xmiroslav

@0xmiroslav could you please take another look? :)

kadiealexander avatar Jan 11 '24 06:01 kadiealexander

@0xmiroslav bump!

kadiealexander avatar Jan 11 '24 21:01 kadiealexander

Thanks @0xmiroslav, hopefully this one is the ticket!

kadiealexander avatar Jan 17 '24 05:01 kadiealexander

Jest Units Tests are failing

0xmiroslav avatar Jan 17 '24 13:01 0xmiroslav

Please merge main and let's see if it fixes unit test

0xmiroslav avatar Jan 17 '24 13:01 0xmiroslav

@0xmiroslav I'm getting a notification saying it's already up to date. Any other ideas for fixing the error?

image

kadiealexander avatar Jan 18 '24 05:01 kadiealexander

Screenshot 2024-01-18 at 6 32 20 am

0xmiroslav avatar Jan 18 '24 05:01 0xmiroslav

@0xmiroslav please review, hopefully for the last time!

kadiealexander avatar Jan 19 '24 04:01 kadiealexander

@kadiealexander I got these console warnings because they're not removed in pdfViewPropTypes.js. But they cannot be deprecated yet as they're still being used in PDFView/index.js as class component, which will be migrated to function in https://github.com/Expensify/App/pull/31281 (I can review this as well if you want 🙂).

Simulator Screenshot - iPhone 15 Pro - 2024-01-19 at 07 00 11 Simulator Screenshot - iPhone 15 Pro - 2024-01-19 at 07 01 56 Simulator Screenshot - iPhone 15 Pro - 2024-01-19 at 07 02 04

0xmiroslav avatar Jan 19 '24 06:01 0xmiroslav

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 / Chrome
    • [x] iOS / native
    • [x] iOS / 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(themeColors.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

https://github.com/Expensify/App/assets/97473779/7348ff56-ceb7-41a9-af9d-462858dcb94e

Android: mWeb Chrome
iOS: Native

https://github.com/Expensify/App/assets/97473779/2467e309-d4b9-4ecc-885b-3121bb1fc9ae

iOS: mWeb Safari
MacOS: Chrome / Safari
MacOS: Desktop

0xmiroslav avatar Jan 19 '24 06:01 0xmiroslav