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

[No QA] method to randomly generate 64 bit int as string #10436

Merged
merged 17 commits into from
Aug 24, 2022

Conversation

srikarparsi
Copy link
Contributor

@srikarparsi srikarparsi commented Aug 17, 2022

Details

New Dot section of design doc: https://docs.google.com/document/d/125xZPDi7v6jmS-GKEcvcpdAwpDRPPGsq_iEOCl9RQFw/edit#bookmark=id.3ifommrba4g8

Fixed Issues

$ https://github.com/Expensify/Expensify/issues/223137

Tests

  • Verify that no errors appear in the JS console

PR Review Checklist

Contributor (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 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 included screenshots or videos for tests on all platforms
  • I ran the tests on all platforms & verified they passed on:
    • iOS / native
    • Android / native
    • iOS / Safari
    • Android / Chrome
    • MacOS / Chrome
    • 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 was added in all src/languages/* files
    • I verified any copy / text that was added to the app is correct English and approved by marketing by tagging the marketing team 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
  • 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 */
    • Any functional components have the displayName property
    • 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 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.
  • I have checked off every checkbox in the PR author checklist, including those that don't apply to this PR.

PR Reviewer Checklist

The Contributor+ will copy/paste it into a new comment and complete it after the author checklist is completed

  • 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 verified tests pass on all platforms & I tested again on:
    • iOS / native
    • Android / native
    • iOS / Safari
    • Android / Chrome
    • MacOS / Chrome
    • 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 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 was added in all src/languages/* files
    • I verified any copy / text that was added to the app is correct English and approved by marketing by tagging the marketing team 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 */
    • Any functional components have the displayName property
    • 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 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.
  • I have checked off every checkbox in the PR reviewer checklist, including those that don't apply to this PR.

QA Steps

  • Verify that no errors appear in the JS console

Screenshots

Web

Mobile Web

Desktop

iOS

Android

@srikarparsi srikarparsi self-assigned this Aug 17, 2022
@srikarparsi srikarparsi requested a review from a team as a code owner August 17, 2022 20:35
@melvin-bot melvin-bot bot requested review from arosiclair and removed request for a team August 17, 2022 20:35
Copy link
Contributor

@flodnv flodnv left a comment

Choose a reason for hiding this comment

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

Can we add unit tests to this? 🤔

@srikarparsi srikarparsi requested a review from arosiclair August 18, 2022 18:57
Copy link
Contributor

@stitesExpensify stitesExpensify left a comment

Choose a reason for hiding this comment

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

LGTM! We can ignore the linter error since we know it's not getting used yet

@luacmartins
Copy link
Contributor

@flodnv I tried to think of some unit tests for this, but couldn't come up with anything useful. Did you have anything in mind?

@flodnv
Copy link
Contributor

flodnv commented Aug 19, 2022

We could at least verify that the generated number is in the range we expect it to be (and is a string)

@luacmartins
Copy link
Contributor

luacmartins commented Aug 19, 2022

Ooh I thought it would be tricky to test the range, but string comparison seems to work! We need to make sure that each char is 0-9 though.

Screen Shot 2022-08-19 at 9 44 18 AM

@srikarparsi
Copy link
Contributor Author

srikarparsi commented Aug 19, 2022

I think the lowest number we can get with this function is 1,000,000,000. I don't think it matters that much since 64 bits is very very big but I don't know if this was discussed so I wanted to bring it up. @tylerkaraszewski

@luacmartins
Copy link
Contributor

Good point! I think we should add first and then multiply on the left part, so the range is 0-MAX_64BIT_LEFT_HALF. For the right part we could multiply and then add so the range is 1-MAX_64BIT_RIGHT_HALF

@luacmartins
Copy link
Contributor

@srikarparsi can we add unit tests as Flo suggested?

@JmillsExpensify
Copy link

@srikarparsi I wanted to check in on this PR? We've had some great process thus far, so let's do everything we can to keep that same momentum this week. When do you think it'll be ready for re-review?

@srikarparsi
Copy link
Contributor Author

I'll add unit tests, clean up the warnings and change the bounds by the end of today :)

@luacmartins luacmartins reopened this Aug 23, 2022
@stitesExpensify
Copy link
Contributor

Updated! All comments addressed

@stitesExpensify
Copy link
Contributor

cc @tylerkaraszewski @roryabraham

@stitesExpensify stitesExpensify self-assigned this Aug 24, 2022
Copy link
Contributor

@roryabraham roryabraham left a comment

Choose a reason for hiding this comment

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

LGTM, I'm not worried about using BigInt in tests. If it passes locally and passes in GitHub Actions, then we're good.

@luacmartins luacmartins merged commit d7f2b38 into main Aug 24, 2022
@luacmartins luacmartins deleted the srikar-64bitRandom branch August 24, 2022 15:23
@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.

@ctkochan22
Copy link
Contributor

hmm this was breaking when I was running the desktop locally. Could be me though?

App [main] :> npm run desktop

> [email protected] desktop
> scripts/set-pusher-suffix.sh && node desktop/start.js

Using PUSHER_DEV_SUFFIX from ../Web-Expensify/_config.local.php
Found suffix: 69db2c8c04e54064a2d1ca48a515d180
Updating .env
[Renderer] ℹ 「wds」: Project is running at http://localhost:8080/
[Renderer] ℹ 「wds」: webpack output is served from /
[Renderer] ℹ 「wds」: Content not from webpack is served from /Users/kosuke/Expensidev/App/dist
[Renderer] ℹ 「wds」: 404s will fallback to /index.html
[Main] Hash: 93c0b04638346214ccf0
[Main] Version: webpack 4.46.0
[Main] Time: 530ms
[Main] Built at: 08/24/2022 4:04:49 PM
[Main]            Asset      Size         Chunks             Chunk Names
[Main] contextBridge.js   306 KiB  contextBridge  [emitted]  contextBridge
[Main]          main.js  2.61 MiB           main  [emitted]  main
[Main] Entrypoint main = main.js
[Main] Entrypoint contextBridge = contextBridge.js
[Main] [./desktop/ELECTRON_EVENTS.js] 356 bytes {main} {contextBridge} [built]
[Main] [./desktop/contextBridge.js] 2.39 KiB {contextBridge} [built]
[Main] [./desktop/main.js] 13.7 KiB {main} [built]
[Main] [./node_modules/webpack/buildin/module.js] (webpack)/buildin/module.js 497 bytes {main} [built]
[Main] [./src/CONFIG.js] 3.37 KiB {main} [built]
[Main] [./src/CONST.js] 416 bytes {main} [built] [failed] [1 error]
[Main] [./src/libs/Url.js] 321 bytes {main} [built]
[Main] [./src/libs/checkForUpdates.js] 630 bytes {main} [built]
[Main] [./src/libs/getPlatform/index.desktop.js] 111 bytes {main} [built]
[Main] [electron] external "electron" 42 bytes {main} {contextBridge} [built]
[Main] [electron-context-menu] external "electron-context-menu" 42 bytes {main} [built]
[Main] [electron-log] external "electron-log" 42 bytes {main} [built]
[Main] [electron-serve] external "electron-serve" 42 bytes {main} [built]
[Main] [electron-updater] external "electron-updater" 42 bytes {main} [built]
[Main]     + 457 hidden modules
[Main]
[Main] ERROR in ./src/CONST.js 793:26
[Main] Module parse failed: Identifier directly after number (793:26)
[Main] You may need an appropriate loader to handle this file type, currently no loaders are configured to process this file. See https://webpack.js.org/concepts#loaders
[Main] |         LEAVE_ROOM: 'leaveRoom',
[Main] |     },
[Main] >     MAX_64BIT_LEFT_HALF: 9_223_372_036,
[Main] |     MAX_64BIT_RIGHT_HALF: 854_775_807,
[Main] |     IOS_KEYBOARD_SPACE_OFFSET: -30,
[Main]  @ ./src/CONFIG.js 6:0-28 9:53-58 23:20-25
[Main]  @ ./desktop/main.js
[Main] webpack --config config/webpack/webpack.desktop.js --config-name desktop-main --mode=development && wait-port localhost:8080 && electron desktop/dist/main.js exited with code 2
--> Sending SIGTERM to other processes..
^C^[[B^[[A[Renderer] webpack-dev-server --config config/webpack/webpack.dev.js --port 8080 --env.platform desktop exited with code 0

@luacmartins
Copy link
Contributor

@ctkochan22 there's a thread here if you want to follow

@mountiny mountiny changed the title method to randomly generate 64 bit int as string [No QA] method to randomly generate 64 bit int as string Aug 25, 2022
@OSBotify
Copy link
Contributor

🚀 Deployed to staging by @luacmartins in version: 1.1.90-0 🚀

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

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.

10 participants