[NO QA] explanation for changes in #14728 #14895

Prince-Mendiratta · 2023-02-07T05:40:35Z

Signed-off-by: Prince Mendiratta [email protected]

Details

Adds a comment explaining the changes made in #14728 as a comment.

Tests

N/A

Verify that no errors appear in the JS console

Offline tests

N/A

QA Steps

N/A

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 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 correct English and 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
- 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 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 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.
I have checked off every checkbox in the PR author checklist, including those that don't apply to this PR.

Screenshots/Videos

N/A

MelvinBot · 2023-02-07T05:41:15Z

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

aimane-chnaif · 2023-02-07T15:42:16Z

src/components/PDFView/index.js

@@ -148,6 +148,9 @@ class PDFView extends Component {
                                width={pageWidth}
                                key={`page_${index + 1}`}
                                pageNumber={index + 1}
+
+                                // This needs to be empty because we do not want to display text while a page is loading


The main reason is not that we do not want to display loading. We finally landed on this but this is just for simple solution and platform consistency.
As stated in issue title, the main reason is to prevent multiple loading texts which show per each page and look ugly.

@aimane-chnaif ah right, updated!

Signed-off-by: Prince Mendiratta <[email protected]>

aimane-chnaif · 2023-02-07T16:08:09Z

src/components/PDFView/index.js

@@ -148,6 +148,9 @@ class PDFView extends Component {
                                width={pageWidth}
                                key={`page_${index + 1}`}
                                pageNumber={index + 1}
+
+                                // This needs to be empty to avoid multiple loading texts which show per page and look ugly


Looks good to me.
cc: @marcaaron if you have better copy

LGTM thanks

stitesExpensify · 2023-02-07T16:20:45Z

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 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 correct English and 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 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 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.
I have checked off every checkbox in the PR reviewer checklist, including those that don't apply to this PR.

Screenshots/Videos

Web

Mobile Web - Chrome

Mobile Web - Safari

Desktop

iOS

Android

aimane-chnaif

Since this is just comment change, no need QA as long as no lint error

OSBotify · 2023-02-07T16:28:21Z

✋ 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 · 2023-02-07T18:46:38Z

🚀 Deployed to staging by https://github.com/stitesExpensify in version: 1.2.67-0 🚀

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

OSBotify · 2023-02-08T23:42:04Z

🚀 Deployed to production by https://github.com/mountiny in version: 1.2.67-7 🚀

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

Prince-Mendiratta requested a review from a team as a code owner February 7, 2023 05:40

melvin-bot bot requested review from stitesExpensify and removed request for a team February 7, 2023 05:41

Prince-Mendiratta mentioned this pull request Feb 7, 2023

[PDFView] no separate text for loading page #14728

Merged

54 tasks

aimane-chnaif reviewed Feb 7, 2023

View reviewed changes

explanation for changes in #14728

52024e1

Signed-off-by: Prince Mendiratta <[email protected]>

aimane-chnaif reviewed Feb 7, 2023

View reviewed changes

stitesExpensify approved these changes Feb 7, 2023

View reviewed changes

stitesExpensify changed the title ~~explanation for changes in #14728~~ [NO QA] explanation for changes in #14728 Feb 7, 2023

aimane-chnaif approved these changes Feb 7, 2023

View reviewed changes

stitesExpensify assigned Prince-Mendiratta Feb 7, 2023

stitesExpensify merged commit 555a101 into Expensify:main Feb 7, 2023

Prince-Mendiratta deleted the empty-prop-comment branch February 7, 2023 16:29

OSBotify mentioned this pull request Feb 7, 2023

Deploy Checklist: New Expensify 2023-02-07 #14911

Closed

21 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[NO QA] explanation for changes in #14728 #14895

[NO QA] explanation for changes in #14728 #14895

Prince-Mendiratta commented Feb 7, 2023

MelvinBot commented Feb 7, 2023

aimane-chnaif Feb 7, 2023

Prince-Mendiratta Feb 7, 2023

aimane-chnaif Feb 7, 2023

marcaaron Feb 7, 2023

stitesExpensify commented Feb 7, 2023 •

edited

Loading

aimane-chnaif left a comment

OSBotify commented Feb 7, 2023

OSBotify commented Feb 7, 2023

OSBotify commented Feb 8, 2023

[NO QA] explanation for changes in #14728 #14895

[NO QA] explanation for changes in #14728 #14895

Conversation

Prince-Mendiratta commented Feb 7, 2023

Details

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

MelvinBot commented Feb 7, 2023

aimane-chnaif Feb 7, 2023

Choose a reason for hiding this comment

Prince-Mendiratta Feb 7, 2023

Choose a reason for hiding this comment

aimane-chnaif Feb 7, 2023

Choose a reason for hiding this comment

marcaaron Feb 7, 2023

Choose a reason for hiding this comment

stitesExpensify commented Feb 7, 2023 • edited Loading

Reviewer Checklist

Screenshots/Videos

aimane-chnaif left a comment

Choose a reason for hiding this comment

OSBotify commented Feb 7, 2023

OSBotify commented Feb 7, 2023

OSBotify commented Feb 8, 2023

stitesExpensify commented Feb 7, 2023 •

edited

Loading