Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[FIX 17237] Updated usages of source. #19107

Merged
merged 10 commits into from
May 22, 2023
Merged

[FIX 17237] Updated usages of source. #19107

merged 10 commits into from
May 22, 2023

Conversation

DanutGavrus
Copy link
Contributor

@DanutGavrus DanutGavrus commented May 17, 2023

Details

The old picture appeared in preview if the Details Page was being opened before. Updated usages of source.

Fixed Issues

$ #17237
PROPOSAL: #17237 (comment)

Tests

Same as QA Steps.

  • Verify that no errors appear in the JS console

Offline tests

Same as QA Steps, but at step 6. userA will see old userB's picture.

QA Steps

Test 1:

  1. Log in with 2 users that have chat history: userA and userB;
  2. From userA, click up on userB's name to open the Details Page;
  3. From userB, change your profile picture;
  4. From userA, click up on userB's profile picture.
  5. Verify that a window opens showing the new updated picture in the preview.

Test 2:

  1. Open any chat;
  2. Press down left on the "+" icon, then select 'Add attachment';
  3. Select a picture from your pc;
  4. Verify that a window opens showing the selected picture. You may proceed to send that inside the chat.

Test 3:

  1. Click on any sent picture inside a chat;
  2. In the window that opens, click up right on the download button;
  3. Verify that the image you've just downloaded opens on your local machine.
  • 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 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 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 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 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 author checklist, including those that don't apply to this PR.

Screenshots/Videos

Web
Mobile Web - Chrome
Mobile Web - Safari
Desktop
iOS
Android

@github-actions
Copy link
Contributor

github-actions bot commented May 17, 2023

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

@DanutGavrus
Copy link
Contributor Author

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

onToggleKeyboard={this.updateConfirmButtonVisibility}
/>
) : (
Boolean(this.state.source) &&
this.state.shouldLoadAttachment && (
Boolean(source) && this.state.shouldLoadAttachment && (
Copy link
Contributor

Choose a reason for hiding this comment

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

why this is needed here ?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

It's not needed, I was thinking to update the usage to source there and let this.state.shouldLoadAttachment be managed for uploading files. I may revert it back if you say so, maybe it's unnecessary. Let me know

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Update: as we are using source={source} 3 lines below in the AttachmentView which shows only if the previous conditions are true, I think it's ok to update it like this.

@fedirjh
Copy link
Contributor

fedirjh commented May 18, 2023

cc @DanutGavrus Is it ready for review ? Do you still need help setting up a HT account ?

@DanutGavrus
Copy link
Contributor Author

@fedirjh I still need help with setting a HT account. I've requested it yesterday, and I've requested it again ~40mins ago. Still waiting

@@ -274,7 +274,7 @@ class AttachmentModal extends PureComponent {
title={this.props.headerTitle || this.props.translate('common.attachment')}
shouldShowBorderBottom
shouldShowDownloadButton={this.props.allowDownload}
onDownloadButtonPress={() => this.downloadAttachment(source)}
onDownloadButtonPress={() => this.downloadAttachment(this.state.source)}
Copy link
Contributor Author

Choose a reason for hiding this comment

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

source from here was previously set to this.state.source and the download functionality was working properly. By updating this, after I was downloading an image, I couldn't open it locally because it was wrongly downloaded. Updated it back to fix this & updated the QA steps with this use case.

Copy link
Contributor

Choose a reason for hiding this comment

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

Can you elaborate more on the issue ? how is it "wrongly downloaded" ?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Trying to open the file after downloading it shows me this:
image

Copy link
Contributor

Choose a reason for hiding this comment

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

Ah I see it , the downloadAttachment require urls to be singed ( with auth signature ) , if url isn’t signed you can’t download them

@DanutGavrus DanutGavrus marked this pull request as ready for review May 18, 2023 13:42
@DanutGavrus DanutGavrus requested a review from a team as a code owner May 18, 2023 13:42
@melvin-bot melvin-bot bot requested review from joelbettner and removed request for a team May 18, 2023 13:43
@melvin-bot
Copy link

melvin-bot bot commented May 18, 2023

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

@DanutGavrus
Copy link
Contributor Author

@fedirjh
It took quite some time to get the HT account and to be able to run the native iOS application on Scaleway, but I've completed all my checks. So, that's it from my side for now, waiting for your updates.

@DanutGavrus
Copy link
Contributor Author

DanutGavrus commented May 19, 2023

@fedirjh @joelbettner
I've updated this with the latest main and re-tested the QA steps

@fedirjh
Copy link
Contributor

fedirjh commented May 19, 2023

Reviewing shortly

@fedirjh
Copy link
Contributor

fedirjh commented May 20, 2023

@joelbettner Please request a review from @chiragsalian as he is assigned to the linked issue. Thank you.

@fedirjh
Copy link
Contributor

fedirjh commented May 20, 2023

While testing , I noticed this behaviour where the an indicator is shown when the file upload finish. This is doesn’t seem to be related to this PR as it’s reproducible on Profile avatar as well

Loading.mov
Profile.mov

This doesn't appear to be a bug, as when the newly uploaded image hasn't finished loading yet, the indicator or placeholder is displayed.

@fedirjh
Copy link
Contributor

fedirjh commented May 20, 2023

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 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(themeColors.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 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

Web
Web.mov
Mobile Web - Chrome
Chrome_.mov
Mobile Web - Safari
Safari.mov
Desktop
Desktop.mov
iOS
IOS.mov
Android
Andoid_.mov

@fedirjh
Copy link
Contributor

fedirjh commented May 20, 2023

@DanutGavrus Please merge main

@DanutGavrus
Copy link
Contributor Author

@fedirjh main merged

@fedirjh
Copy link
Contributor

fedirjh commented May 20, 2023

I have got a console error , but it is not related to this PR , I have reported in slack https://expensify.slack.com/archives/C049HHMV9SM/p1684623711702359

Screenshot 2023-05-20 at 9 48 12 PM

fedirjh
fedirjh previously approved these changes May 20, 2023
Copy link
Contributor

@fedirjh fedirjh left a comment

Choose a reason for hiding this comment

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

Looks good and tests well.

cc @chiragsalian

@fedirjh
Copy link
Contributor

fedirjh commented May 20, 2023

@DanutGavrus Please update the testing steps :

Test 1:

  1. Open App for two users which have chat history
  2. From userA , click on userB name to see details
  3. From userB, change profile pic
  4. From userA , click on userB’s updated profile pic to preview
  5. Verify the new uploaded profile pic is previewed

Test 2:

  1. Open any chat
  2. Open attachement modal
  3. Select any pic
  4. Verify the selected pic is previewed in modal

@DanutGavrus
Copy link
Contributor Author

@fedirjh The testing steps are the same as the QA steps and they already include Test1, Test2 and also the download image case.

@fedirjh
Copy link
Contributor

fedirjh commented May 21, 2023

@DanutGavrus The test steps you provided are unclear and difficult to understand. Please revise them to make them more concise and straightforward.

@DanutGavrus
Copy link
Contributor Author

Rule of thumb: Over-explain what the tester needs to do. Do not rely on the tester having existing knowledge of the app.

I was following the guideline from here where's also an example of bad and good test steps.

I've revised them and now they are more concise and straightforward. I may revise them again if needed.

@fedirjh
Copy link
Contributor

fedirjh commented May 21, 2023

Thanks! It looks good. I just have one additional change. The tester needs to verify the expected result for each test. Therefore, I suggest updating the last step of each test to start with Verify.

@DanutGavrus
Copy link
Contributor Author

Sure, I've updated that too just now.

@fedirjh
Copy link
Contributor

fedirjh commented May 21, 2023

Looks good and tests well.

cc @chiragsalian

🎀👀🎀 C+ reviewed

joelbettner
joelbettner previously approved these changes May 22, 2023
@joelbettner
Copy link
Contributor

joelbettner commented May 22, 2023

@DanutGavrus there is a linting problem. Looks like you might need to run npm run prettier. Other than that, looks good.

@DanutGavrus DanutGavrus dismissed stale reviews from joelbettner and fedirjh via a4a6569 May 22, 2023 16:00
@DanutGavrus
Copy link
Contributor Author

@fedirjh @joelbettner
Done

@joelbettner joelbettner merged commit 23e5de4 into Expensify:main May 22, 2023
@OSBotify
Copy link
Contributor

✋ 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
Copy link
Contributor

🚀 Deployed to staging by https://github.com/joelbettner in version: 1.3.17-0 🚀

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

@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/chiragsalian in version: 1.3.17-5 🚀

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

@DanutGavrus DanutGavrus deleted the fix/17237-old-picture-in-preview branch July 3, 2023 10:46
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.

4 participants