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

handle unlimited api request #29150

Closed
wants to merge 3 commits into from
Closed

handle unlimited api request #29150

wants to merge 3 commits into from

Conversation

kaushiktd
Copy link
Contributor

@kaushiktd kaushiktd commented Oct 10, 2023

Details

Fixed Issues

$ #26904
PROPOSAL: #26904 (comment)

Tests

I've tested the scenarios with MacOS / Chrome / Safari
Steps to follow:

Open the Expensify URL in web browser and follow below steps:

  1. Open any report and attach an image.
  2. Go to Chrome Dev Tools Network tab and disable cache & offline.
  3. Open another report and reopen the report in which I attached the image.
  4. Check unlimited API requests are displayed in the console tab
  • Verify that no errors appear in the JS console

Offline tests

QA Steps

Open the Expensify URL in web browser and follow below steps:

  1. Open any report and attach an image.
  2. Go to Chrome Dev Tools Network tab and disable cache & offline.
  3. Open another report and reopen the report in which I attached the image.
  4. Check unlimited API requests are displayed in the console tab
  • 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 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
    • 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
    • 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 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 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

Android: Native
Android: mWeb Chrome
iOS: Native
iOS: mWeb Safari
MacOS: Chrome / Safari [reloadingimage.webm](https://github.com/Expensify/App/assets/43398804/6a35081b-787f-4cb8-bba2-883aff1fbbc0)
MacOS: Desktop

@kaushiktd kaushiktd requested a review from a team as a code owner October 10, 2023 05:06
@melvin-bot melvin-bot bot requested review from ntdiary and removed request for a team October 10, 2023 05:06
@melvin-bot
Copy link

melvin-bot bot commented Oct 10, 2023

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

@ntdiary
Copy link
Contributor

ntdiary commented Oct 11, 2023

Hi, @kaushiktd, can you please also take care of the fallback image case? We have already provided the SVG file.
#26904 (comment)
Receipt_Placeholder.svg.zip.

Maybe we can add a fallbackIcon prop to ThumbnailImage and ImageWithSizeCalculation, and pass the svg file to them here.

const receiptImageComponent = thumbnail ? (

For ImageWithSizeCalculation:
isLoadedRef and isLoading can be replaced with a single loadState, which can make our logic clearer. Its value can be initial/loading/loaded/errored, which can be defined as constants. If loadState is errored, we can show the fallback icon (for receipt message) or null (for generic image message).

Additionally, @dannymcclain, It seems the current svg icon is used for receipt messages.
We left slot above to also display one icon for generic attachment images in the future if needed, however their sizes don't seem to be fixed, so the situation could be more complex.

image

@kaushiktd
Copy link
Contributor Author

kaushiktd commented Oct 11, 2023

I will do that but this was added later. Can you please also clarify if I can do it tomorrow? If so, will it be counted as an extra day and extra pay since it is three days already, my PR is already done within 3 days and I am afraid it will cause me to lose bonus?

@ntdiary
Copy link
Contributor

ntdiary commented Oct 11, 2023

I will do that but this was added later. Can you please also clarify if I can do it tomorrow? If so, will it be counted as an extra day and extra pay since it is three days already, my PR is already done within 3 days and I am afraid it will cause me to lose bonus?

Will ask in slack for this case. : )

@ntdiary
Copy link
Contributor

ntdiary commented Oct 11, 2023

Hi @kaushiktd, I feel there are two points that need clarification:

  1. We highly value code quality. As I mentioned in my previous comment, this was a relatively small issue, and your original proposal was closer to the expected result, which is why it prevailed, but it still needs improvements.
  2. The bonus in PR focus on the assign time and final merge time. During our review, there needs to be back and forth communication, for example whether everyone is satisfied with the implementation size of the icons, whether there are potential bugs in the code, etc. This is teamwork, and will certainly take some time, which is why I said earlier the PR may last a few days.

In summary, we are still within the normal process, and can complete this PR within this week (with $500). Additionally, I also look forward to more and better proposals from you in the future! : )

@kaushiktd kaushiktd closed this by deleting the head repository Oct 13, 2023
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.

2 participants