fix: fixing failing tests for `OptionsListUtils` and `ReportUtils` suites #20371

BeeMargarida · 2023-06-07T14:43:19Z

Details

Fixes failing tests for OptionsListUtils and ReportUtils unit test suites.
Regarding the topic of the fake accountID, I created a method but it's more as a placeholder until all the logic regarding the mentioned fix is done.

Fixed Issues

$ #19007

Tests

Verify that no errors appear in the JS console

Offline tests

QA Steps

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

Beamanator

Looks great! Got a few little comments, so if you have time to adjust a few small things today let's do that, but once you're done we can merge into my branch and keep going from there!

Beamanator · 2023-06-07T16:00:30Z

src/CONST.js

@@ -872,6 +872,10 @@ const CONST = {
        GUIDES_DOMAIN: 'team.expensify.com',
    },

+    ACCOUNT_ID: {
+        CONCIERGE: '8392101',


I thinkkkk this is one thing we'll have to modify - because in expensify employee dev environments this account ID is definitely different - so we'll have to read the account ID from the .env file.

Is this being extracted anywhere? I tried looking at CONFIG.js to see the name of the variable, but there's no mentioned of a concierge account id

Not yet, I just think we'll need to do that in our migration since the email will always stay the same, but account IDs won't 😅

It issss possible we can have AppInit send the concierge accountID instead and store that in Onyx or something 🤔

Oh right, it makes sense. Hum, I'll add a note here, so that this not get forgotten.

That sounds fantastic, thanks!

src/libs/OptionsListUtils.js

Beamanator · 2023-06-07T16:02:18Z

src/libs/OptionsListUtils.js

-                    login,
-                    displayName: LocalePhoneNumber.formatPhoneNumber(login),
-                    avatar: UserUtils.getDefaultAvatar(login),
+                    accountID,


One thing @puneetlath and I are thinking is: If we don't have a display name to show we maybbbe want to just show "hidden" everywhere, OR we want to hide this - this is something we'll have to keep in mind when doing final testing

Ah, have the displayName be 'hidden'? Do we want to change this right now, or is it something still being discussed?

Well we will plan to show "hidden" on the the profile page that we're updating (PR: #20144) - IFF you don't have that person's personal details in Onyx. So we were just "thinking" this may apply to other pages in the app, but I'd say let's just see what happens as we go - I think it would be better if we try to figure out "why" personal details may or may not be available in this scenario, and handle it from there, not just add "hidden" everywhere this happens and gloss over the why 😅

src/libs/ReportUtils.js

src/libs/UserUtils.js

tests/unit/OptionsListUtilsTest.js

BeeMargarida · 2023-06-07T16:25:08Z

@Beamanator Not sure what's going on, I've pushed a commit to the branch with fixes for the review points, but the commit is not showing on the PR 🤨 It's definitely pushed

Beamanator · 2023-06-07T16:26:50Z

@BeeMargarida Thaaaaaat's super weird 😅

BeeMargarida · 2023-06-07T16:44:02Z

Well, it kinda fixed itself after another commit 🤷‍♀️

melvin-bot · 2023-06-07T17:20:13Z

@neil-marcellini @rushatgabhane One of you needs to 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]

OSBotify · 2023-06-16T18:52:40Z

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

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

OSBotify · 2023-06-21T02:20:10Z

🚀 Deployed to production by https://github.com/luacmartins in version: 1.3.29-11 🚀

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

BeeMargarida added 5 commits June 7, 2023 15:41

fix: start migration for getSearchOptions, getOptions and createOption

ef3d955

fix: complete migration of some report utils to accountID

5c395d0

fix: generate random accountID for users info not in Onyx

5f5789b

Merge branch 'beaman-continueMigration' into migration-OptionsListUtils

8261127

fix: update ReportUtils to use accountID and fix tests

cf0b245

BeeMargarida changed the title ~~fix: fixing failing tests for OptionsListUtils suite~~ fix: fixing failing tests for OptionsListUtils and ReportUtils suites Jun 7, 2023

Beamanator approved these changes Jun 7, 2023

View reviewed changes

fix: add notes and fix small issues

9d30f05

style: prettier

3ca4e0d

Beamanator marked this pull request as ready for review June 7, 2023 17:20

Beamanator requested a review from a team as a code owner June 7, 2023 17:20

melvin-bot bot requested review from neil-marcellini and rushatgabhane and removed request for a team June 7, 2023 17:20

Beamanator merged commit fde3aff into Expensify:beaman-continueMigration Jun 7, 2023

Beamanator mentioned this pull request Jun 7, 2023

Continue personalDetails -> personalDetailsList migration #20328

Merged

55 tasks

OSBotify mentioned this pull request Jun 16, 2023

Deploy Checklist: New Expensify 2023-06-16 #20928

Closed

melvin-bot bot mentioned this pull request Jun 21, 2023

[HOLD for payment 2023-06-28] [Secure Logins] Replace login uses with accountIDs throughout App (when accessing Onyx) #19007

Closed

daordonez11 mentioned this pull request Jul 5, 2023

[$1000] Web - User details tooltip in workspace members list is different #22062

Closed

6 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix: fixing failing tests for `OptionsListUtils` and `ReportUtils` suites #20371

fix: fixing failing tests for `OptionsListUtils` and `ReportUtils` suites #20371

BeeMargarida commented Jun 7, 2023 •

edited

Loading

Beamanator left a comment

Beamanator Jun 7, 2023

BeeMargarida Jun 7, 2023

Beamanator Jun 7, 2023

BeeMargarida Jun 7, 2023

Beamanator Jun 7, 2023

Beamanator Jun 7, 2023

BeeMargarida Jun 7, 2023

Beamanator Jun 7, 2023

BeeMargarida commented Jun 7, 2023 •

edited

Loading

Beamanator commented Jun 7, 2023

BeeMargarida commented Jun 7, 2023

melvin-bot bot commented Jun 7, 2023

OSBotify commented Jun 16, 2023

OSBotify commented Jun 21, 2023

fix: fixing failing tests for OptionsListUtils and ReportUtils suites #20371

fix: fixing failing tests for OptionsListUtils and ReportUtils suites #20371

Conversation

BeeMargarida commented Jun 7, 2023 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

Beamanator left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

BeeMargarida commented Jun 7, 2023 • edited Loading

Beamanator commented Jun 7, 2023

BeeMargarida commented Jun 7, 2023

melvin-bot bot commented Jun 7, 2023

OSBotify commented Jun 16, 2023

OSBotify commented Jun 21, 2023

fix: fixing failing tests for `OptionsListUtils` and `ReportUtils` suites #20371

fix: fixing failing tests for `OptionsListUtils` and `ReportUtils` suites #20371

BeeMargarida commented Jun 7, 2023 •

edited

Loading

BeeMargarida commented Jun 7, 2023 •

edited

Loading