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

Upgrade react-native-pager-view to 6.5.0 #52166

Conversation

MrRefactor
Copy link
Contributor

@MrRefactor MrRefactor commented Nov 7, 2024

Explanation of Change

Bumping react-native-pager-view to a 6.5.0 version containing changes incorrect page change.

Fixed Issues

$ #50349

PROPOSAL:

Tests

  • Verify that no errors appear in the JS console
  1. Open a chat
  2. Go offline
  3. Upload an image
  4. Open the image
  5. Go online
  6. Verify that image preview modal not dismissed

Offline tests

N/A

QA Steps

  • Verify that no errors appear in the JS console
  1. Open a chat
  2. Go offline
  3. Upload an image
  4. Open the image
  5. Go online
  6. Verify that image preview modal not dismissed

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 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 either coming verbatim from figma or has been approved by marketing (in order to get marketing approval, ask the Bug Zero team member to add the Waiting for copy label to the issue)
    • 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 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(theme.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 the PR modifies the UI (e.g. new buttons, new UI components, changing the padding/spacing/sizing, moving components, etc) or modifies the form input styles:
    • I verified that all the inputs inside a form are aligned with each other.
    • I added Design label and/or tagged @Expensify/design so the design team can review the changes.
  • 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.

Screenshots/Videos

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

@MrRefactor MrRefactor requested a review from a team as a code owner November 7, 2024 09:22
@melvin-bot melvin-bot bot requested a review from hungvu193 November 7, 2024 09:22
Copy link

melvin-bot bot commented Nov 7, 2024

@hungvu193 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 melvin-bot bot removed the request for review from a team November 7, 2024 09:22
@MrRefactor
Copy link
Contributor Author

@AndrewGable @thienlnam could we have a adhoc build for that one so we could test if its working as expected?

@hungvu193
Copy link
Contributor

@MrRefactor Can you fill the QA, Tests, and Offline test section on your author checklist?

@MrRefactor
Copy link
Contributor Author

With 6.5.0 version this issue has been fixed: #49832 (comment)

Copy link
Contributor

github-actions bot commented Nov 7, 2024

@hungvu193
Copy link
Contributor

hungvu193 commented Nov 8, 2024

@MrRefactor Can you update the screenshots/videos please?
I think I still can reproduce the issue on IOS:

Screen.Recording.2024-11-08.at.11.27.52.mov
Screen.Recording.2024-11-08.at.11.26.21.mov

@MrRefactor
Copy link
Contributor Author

MrRefactor commented Nov 8, 2024

Hey @hungvu193 version 6.5.0 of react-native-pager-view contains fix for an issue reported here -> #49832 (comment) as I was asked to resolve problems with dynamic change of content on pages after pager is mounted.

Right now we have two scenarios:

Scenario 1 -> Current implementation in Expensify

Screen.Recording.2024-11-08.at.09.27.38.mov

We start with 3 pages, after we modify page 3 whole pager-view rerenders which causes switching page to page nr 2.
We dont keep reference to the newly added attachment so its forcing pager to rerender.

Minimum reproducible code
import React from 'react';
import { useState } from 'react';
import { Button, SafeAreaView, Text, View, StyleSheet } from 'react-native';
import PagerView from 'react-native-pager-view';

const ids = ['1', '2', '3'];

function getNewArray() {
  const newArray = [...ids];
  newArray[2] = Math.random().toString(36).substring(7); // Generate a random string
  return newArray;
}
export const BasicPagerViewExample = () => {

  const [pagesContent, setPagesContent] = useState<string[]>(getNewArray());
  const [page, setPage] = useState<number>(2);

  console.log(pagesContent);

  return (
    <SafeAreaView style={{ flex: 1 }}>
      <Text style={{ textAlign: 'center' }}>{pagesContent.length}</Text>
      <PagerView orientation="horizontal" style={{ flex: 1, backgroundColor: 'yellow' }} initialPage={page}
        onPageSelected={(e) => {
          console.log('onPageSelected ~ e.nativeEvent.position:', e.nativeEvent.position);
        }}
      >
        {pagesContent.map((content) => (
          <View key={content} style={{ flex: 1,backgroundColor: 'green' }}>
            <View style={{ flex: 1, justifyContent: 'center', alignItems: 'center' , backgroundColor:'red'}}>
              <Text style={{ fontSize: 30 }}>{content}</Text>
            </View>
          </View>
        ))}
      </PagerView>
      <Button
        title={'Replace third page content'}
        onPress={() => {
          setPagesContent(getNewArray());
          setPage(2);
        }}
      />
    </SafeAreaView>
  );
};

export default BasicPagerViewExample

Scenario 2 ->

Screen.Recording.2024-11-08.at.10.25.41.mov

We modify mounted page without rerender of pager-view by applying key value to each page so last page stays in the same place. This part it on project's side to refactor a bit behaviour of how we process attachments and provide them to pager-view.

Minimum reproducible code
import React from 'react';
import { useState } from 'react';
import { Button, SafeAreaView, Text, View, StyleSheet } from 'react-native';
import PagerView from 'react-native-pager-view';

const pages = [{key: '1', content: '1'}, {key: '2', content:'2'}, {key:'3', content:'3333'}]

function getNewArray() {
  const newArray = [...pages];
  newArray[2].content = Math.random().toString(36).substring(7); // Generate a random string
  return newArray;
}

type Pages = {
  key: string,
  content:string
}

export const BasicPagerViewExample = () => {

  const [pagesContent, setPagesContent] = useState<Pages[]>(pages);
  const [page, setPage] = useState<number>(2);

  console.log(pagesContent);

  return (
    <SafeAreaView style={{ flex: 1 }}>
      <Text style={{ textAlign: 'center' }}>{pagesContent.length}</Text>
      <PagerView orientation="horizontal" style={{ flex: 1, backgroundColor: 'red'}} initialPage={page} 

        onPageSelected={(e) => {
          console.log('onPageSelected ~ e.nativeEvent.position:', e.nativeEvent.position);
        }}
      >
        {pagesContent.map((item) => (
          <View key={item.key} style={{ flex: 1,backgroundColor: 'green' }}>
            <View style={{ flex: 1, justifyContent: 'center', alignItems: 'center' , backgroundColor:'red'}}>
              <Text style={{ fontSize: 30 }}>{item.content}</Text>
            </View>
          </View>
        ))}
      </PagerView>
      <Button
        title={'Replace third page content'}
        onPress={() => {
          setPagesContent(getNewArray());
          setPage(2);
        }}
      />
    </SafeAreaView>
  );
};

export default BasicPagerViewExample

Apart of the bump there should be a followup to the issue I posted above directly on the project's side.

Videos with the bug you provided are connected to associated issue that will be resolved separately. -> #50296

@hungvu193
Copy link
Contributor

hungvu193 commented Nov 9, 2024

Got it! Thanks for your explanation 🙏

@hungvu193
Copy link
Contributor

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: mWeb Chrome
    • iOS: Native
    • iOS: mWeb 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 grammatically correct in English. It adheres to proper capitalization guidelines (note: only the first word of header/labels should be capitalized), and is either coming verbatim from figma or has been approved by marketing (in order to get marketing approval, ask the Bug Zero team member to add the Waiting for copy label to the issue)
    • 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(theme.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 the PR modifies the UI (e.g. new buttons, new UI components, changing the padding/spacing/sizing, moving components, etc) or modifies the form input styles:
    • I verified that all the inputs inside a form are aligned with each other.
    • I added Design label and/or tagged @Expensify/design so the design team can review the changes.
  • 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

Android: Native
Android.mov
Android: mWeb Chrome
mChrome.mov
iOS: Native
ios.mov
iOS: mWeb Safari
mSafari.mov
MacOS: Chrome / Safari
Chrome.mov
MacOS: Desktop
Desktop.mov

Copy link
Contributor

@thienlnam thienlnam left a comment

Choose a reason for hiding this comment

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

Double checking if this patch needs to be updated in hybrid app as well

@thienlnam
Copy link
Contributor

thienlnam commented Nov 12, 2024

Looks like we need to update it there as well - https://github.com/Expensify/Mobile-Expensify/tree/main/patches/new-dot

@AndrewGable What's the recommended way to handle these? Should they be merged at the same time or does one need to go out before the other?

@AndrewGable
Copy link
Contributor

@war-in @mateuuszzzzz - Correct me if I am wrong, but we only need to apply patches in HybridApp if they are exclusive to HybridApp, otherwise no additional changes are required.

@war-in
Copy link
Contributor

war-in commented Nov 13, 2024

Andrew's right, the patches/new-dot directory keeps HybridApp-related patches, so if the created patch is NewDot-exclusive there's no need to put it there.
In other words, we shouldn't put the same patches in the patches/new-dot and patches directory in ND

@thienlnam
Copy link
Contributor

Okay great, thanks for the confirmation

@thienlnam thienlnam merged commit 49937dd into Expensify:main Nov 13, 2024
19 checks passed
Copy link
Contributor

🚀 Deployed to staging by https://github.com/thienlnam in version: 9.0.62-0 🚀

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

Copy link
Contributor

🚀 Deployed to production by https://github.com/mountiny in version: 9.0.62-4 🚀

platform result
🤖 android 🤖 success ✅
🖥 desktop 🖥 success ✅
🍎 iOS 🍎 success ✅
🕸 web 🕸 success ✅
🤖🔄 android HybridApp 🤖🔄 skipped 🚫
🍎🔄 iOS HybridApp 🍎🔄 skipped 🚫

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants