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.

Sign up for GitHub

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

Jump to bottom

feat: implement dynamic resizing array buffers #54656

Merged
merged 14 commits into from
Jan 13, 2025
Merged

feat: implement dynamic resizing array buffers #54656

merged 14 commits into from
Jan 13, 2025

Conversation

hannojg
Copy link
Contributor

@hannojg hannojg commented Dec 30, 2024 •
edited
Loading

Explanation of Change

The search is represented as a big string which gets converted to a purely numerical representation. That representation is an ArrayBuffer. Earlier, the ArrayBuffer had a fixed length of 400,000 chars. Meaning that if the user's search string was larger than that items may not be found.

This PR fixes this by adding dynamic array buffer resizing. The PR adds two things:

  1. Estimate the length of the search string based on the amount of items to search and assuming an average length
  2. For the case that our estimation was too low, implemented a dynamic resizing array buffer that is used in the search

The resizing can be pretty fast, this is from my Mac in Chrome:

Resizing to 700000
Using ArrayBuffer.transfer
Resized in 0.10000002384185791 ms

Fixed Issues

$ #54594
PROPOSAL: #54594 (comment)

Tests

  • Verify that no errors appear in the JS console

Offline tests

QA Steps

Precondition:

  1. User is logged in to Expensifail account (many contacts).
  2. Open search router.
  3. Enter current email address (expect to find your account)
  4. Close the search router.
  5. Open FAB > Start chat.
  6. Create a group chat with a few users.
  7. Open search router.
  8. Enter the group name. (expect to find the just created group)

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 used JaimeGPT to get English > Spanish translation. I then posted it 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.ts 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.
  • I added unit tests for any new feature or bug fix in this PR to help automatically prevent regressions in this user flow.
  • 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
CleanShot.2024-12-30.at.17.24.29.mp4
Android: mWeb Chrome
CleanShot.2024-12-30.at.17.24.29.mp4
iOS: Native
CleanShot.2024-12-30.at.17.24.29.mp4
iOS: mWeb Safari
CleanShot.2024-12-30.at.17.24.29.mp4
MacOS: Chrome / Safari
CleanShot.2024-12-30.at.17.24.29.mp4
MacOS: Desktop
CleanShot.2024-12-30.at.17.24.29.mp4

@hannojg hannojg marked this pull request as ready for review December 30, 2024 16:30
@hannojg hannojg requested a review from a team as a code owner December 30, 2024 16:30
@melvin-bot melvin-bot bot requested a review from allgandalf December 30, 2024 16:30
@melvin-bot Melvin Bot
Copy link

melvin-bot bot commented Dec 30, 2024

@allgandalf 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 December 30, 2024 16:30
This was referenced Dec 30, 2024
Closed
Closed
@hannojg
Copy link
Contributor Author

hannojg commented Dec 30, 2024

Unfortunately I didn't had time to record videos for all platforms 🙇‍♂️
Would appreciate if the reviewer finds time for that, otherwise I can do that tmrw

@allgandalf
Copy link
Contributor

allgandalf commented Dec 30, 2024 •
edited
Loading

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.ts 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.
  • For any bug fix or new feature in this PR, I verified that sufficient unit tests are included to prevent regressions in this flow.
  • 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
Screen.Recording.2025-01-07.at.3.18.23.PM.mov
Android: mWeb Chrome
Screen.Recording.2025-01-07.at.3.24.22.PM.mov
iOS: Native
Screen.Recording.2025-01-07.at.3.07.43.PM.mov
iOS: mWeb Safari
Screen.Recording.2025-01-07.at.3.13.43.PM.mov
MacOS: Chrome / Safari
Screen.Recording.2025-01-07.at.2.51.50.PM.mov
MacOS: Desktop
Screen.Recording.2025-01-07.at.2.56.06.PM.mov

@allgandalf
Copy link
Contributor

@hannojg is this ready for review ?

@hannojg
Copy link
Contributor Author

hannojg commented Dec 31, 2024

Yeah sorry, was just pushing one little perf optimization

@allgandalf
Copy link
Contributor

allgandalf commented Dec 31, 2024 •
edited
Loading

No worries sirrr 🙇

@allgandalf
Copy link
Contributor

almost done with testing, I will complete checklist tomorrow

allgandalf
allgandalf approved these changes Jan 7, 2025
View reviewed changes
Copy link
Contributor

@allgandalf allgandalf left a comment

Choose a reason for hiding this comment

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

Tests well and LGTM!

@melvin-bot melvin-bot bot requested a review from Beamanator January 7, 2025 09:55
@Beamanator
Copy link
Contributor

There seems to be something funky going on with Jest Unit Tests / test (job 2)...

The first time this was running (here) it ran for 6 HOURS 🤣 and had to be manually cancelled... I just retried and it has been running for 13 minutes, stuck on the same spot 🤔

@Beamanator
Copy link
Contributor

@hannojg would you be able to see if that test runs fine locally?

@allgandalf
Copy link
Contributor

bump @hannojg 🙇

@hannojg
Copy link
Contributor Author

hannojg commented Jan 13, 2025

Hm, after merging with main it seems to be stuck again (can you cancel please?).
Will check whats going on!

@hannojg
Copy link
Contributor Author

hannojg commented Jan 13, 2025

I had a test case that was trying to use negative indexes for the array buffer. before I added boundary checks for it, but later felt that it was complicating the code too much. Also because the DynamicArrayBuffer is only accessed through safe interfaces, I think it's okay removing that extra code, thats not applicable for our use cases.

If you tried to set values at negative indexes you would run into an endless loop, thus the tests never finished. Its fixed now!

@Beamanator
Copy link
Contributor

Nice find & fix @hannojg ! Do you think we need to retest this on main to be safe or are we good to proceed with final approve & merge? 🙏

@hannojg
Copy link
Contributor Author

hannojg commented Jan 13, 2025

Should be safe! 😇

Beamanator
Beamanator approved these changes Jan 13, 2025
View reviewed changes
Copy link
Contributor

@Beamanator Beamanator left a comment

Choose a reason for hiding this comment

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

Looking great!

@Beamanator Beamanator merged commit 9ac6356 into Expensify:main Jan 13, 2025
16 checks passed
@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.

@github-actions github-actions bot mentioned this pull request Jan 14, 2025
Closed
38 tasks
@github-actions GitHub Actions
Copy link
Contributor

🚀 Deployed to staging by https://github.com/Beamanator in version: 9.0.85-0 🚀

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

3 similar comments
@github-actions GitHub Actions
Copy link
Contributor

🚀 Deployed to staging by https://github.com/Beamanator in version: 9.0.85-0 🚀

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

@github-actions GitHub Actions
Copy link
Contributor

🚀 Deployed to staging by https://github.com/Beamanator in version: 9.0.85-0 🚀

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

@github-actions GitHub Actions
Copy link
Contributor

🚀 Deployed to staging by https://github.com/Beamanator in version: 9.0.85-0 🚀

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

@github-actions GitHub Actions
Copy link
Contributor

🚀 Deployed to staging by https://github.com/Beamanator in version: 9.0.85-0 🚀

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

@github-actions GitHub Actions
Copy link
Contributor

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

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

@github-actions GitHub Actions
Copy link
Contributor

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

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Beamanator Beamanator Beamanator approved these changes

@allgandalf allgandalf allgandalf approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@hannojg @allgandalf @Beamanator @OSBotify