-
Notifications
You must be signed in to change notification settings - Fork 3.9k
Refactor ONYXKEYS.NVP_ACTIVE_POLICY_ID in src/libs/OptionsListUtils.ts #70137
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
Open
parasharrajat
wants to merge
4
commits into
Expensify:main
Choose a base branch
from
parasharrajat:onyx/66382
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
42072cd
Refactor ONYXKEYS.NVP_ACTIVE_POLICY_ID in src/libs/OptionsListUtils.ts
parasharrajat 41924d3
Merge branch 'main' of github.com:Expensify/App into onyx/66382
parasharrajat 5fd47b6
Apply suggestion from @DylanDylann
parasharrajat b6aaf8f
Remove extras
parasharrajat File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -185,7 +185,7 @@ | |
| */ | ||
| let currentUserLogin: string | undefined; | ||
| let currentUserAccountID: number | undefined; | ||
| Onyx.connect({ | ||
| key: ONYXKEYS.SESSION, | ||
| callback: (value) => { | ||
| currentUserLogin = value?.email; | ||
|
|
@@ -194,19 +194,19 @@ | |
| }); | ||
|
|
||
| let loginList: OnyxEntry<Login>; | ||
| Onyx.connect({ | ||
| key: ONYXKEYS.LOGIN_LIST, | ||
| callback: (value) => (loginList = isEmptyObject(value) ? {} : value), | ||
| }); | ||
|
|
||
| let allPersonalDetails: OnyxEntry<PersonalDetailsList>; | ||
| Onyx.connect({ | ||
| key: ONYXKEYS.PERSONAL_DETAILS_LIST, | ||
| callback: (value) => (allPersonalDetails = isEmptyObject(value) ? {} : value), | ||
| }); | ||
|
|
||
| const policies: OnyxCollection<Policy> = {}; | ||
| Onyx.connect({ | ||
| key: ONYXKEYS.COLLECTION.POLICY, | ||
| callback: (policy, key) => { | ||
| if (!policy || !key || !policy.name) { | ||
|
|
@@ -218,14 +218,14 @@ | |
| }); | ||
|
|
||
| let allPolicies: OnyxCollection<Policy> = {}; | ||
| Onyx.connect({ | ||
| key: ONYXKEYS.COLLECTION.POLICY, | ||
| waitForCollectionCallback: true, | ||
| callback: (val) => (allPolicies = val), | ||
| }); | ||
|
|
||
| let allReports: OnyxCollection<Report>; | ||
| Onyx.connect({ | ||
| key: ONYXKEYS.COLLECTION.REPORT, | ||
| waitForCollectionCallback: true, | ||
| callback: (value) => { | ||
|
|
@@ -234,7 +234,7 @@ | |
| }); | ||
|
|
||
| let allReportNameValuePairs: OnyxCollection<ReportNameValuePairs>; | ||
| Onyx.connect({ | ||
| key: ONYXKEYS.COLLECTION.REPORT_NAME_VALUE_PAIRS, | ||
| waitForCollectionCallback: true, | ||
| callback: (value) => { | ||
|
|
@@ -246,7 +246,7 @@ | |
| const allSortedReportActions: Record<string, ReportAction[]> = {}; | ||
| let allReportActions: OnyxCollection<ReportActions>; | ||
| const lastVisibleReportActions: ReportActions = {}; | ||
| Onyx.connect({ | ||
| key: ONYXKEYS.COLLECTION.REPORT_ACTIONS, | ||
| waitForCollectionCallback: true, | ||
| callback: (actions) => { | ||
|
|
@@ -305,14 +305,8 @@ | |
| }, | ||
| }); | ||
|
|
||
| let activePolicyID: OnyxEntry<string>; | ||
| Onyx.connect({ | ||
| key: ONYXKEYS.NVP_ACTIVE_POLICY_ID, | ||
| callback: (value) => (activePolicyID = value), | ||
| }); | ||
|
|
||
| let nvpDismissedProductTraining: OnyxEntry<DismissedProductTraining>; | ||
| Onyx.connect({ | ||
| key: ONYXKEYS.NVP_DISMISSED_PRODUCT_TRAINING, | ||
| callback: (value) => (nvpDismissedProductTraining = value), | ||
| }); | ||
|
|
@@ -1214,6 +1208,7 @@ | |
| function orderReportOptionsWithSearch( | ||
| options: SearchOptionData[], | ||
| searchValue: string, | ||
| activePolicyID?: string, | ||
| {preferChatRoomsOverThreads = false, preferPolicyExpenseChat = false, preferRecentExpenseReports = false}: OrderReportOptionsConfig = {}, | ||
| ) { | ||
| const orderedByDate = orderReportOptions(options); | ||
|
|
@@ -1260,7 +1255,7 @@ | |
| ); | ||
| } | ||
|
|
||
| function orderWorkspaceOptions(options: SearchOptionData[]): SearchOptionData[] { | ||
| function orderWorkspaceOptions(options: SearchOptionData[], activePolicyID: string | undefined): SearchOptionData[] { | ||
| return options.sort((a, b) => { | ||
| // Check if `a` is the default workspace | ||
| if (a.isPolicyExpenseChat && a.policyID === activePolicyID) { | ||
|
|
@@ -1289,21 +1284,21 @@ | |
| /** | ||
| * Sorts reports and personal details independently. | ||
| */ | ||
| function orderOptions(options: ReportAndPersonalDetailOptions): ReportAndPersonalDetailOptions; | ||
| function orderOptions(options: ReportAndPersonalDetailOptions, activePolicyID?: string): ReportAndPersonalDetailOptions; | ||
|
|
||
| /** | ||
| * Sorts reports and personal details independently, but prioritizes the search value. | ||
| */ | ||
| function orderOptions(options: ReportAndPersonalDetailOptions, searchValue: string, config?: OrderReportOptionsConfig): ReportAndPersonalDetailOptions; | ||
| function orderOptions(options: ReportAndPersonalDetailOptions, searchValue?: string, config?: OrderReportOptionsConfig): ReportAndPersonalDetailOptions { | ||
| function orderOptions(options: ReportAndPersonalDetailOptions, activePolicyID: string, searchValue: string, config?: OrderReportOptionsConfig): ReportAndPersonalDetailOptions; | ||
| function orderOptions(options: ReportAndPersonalDetailOptions, activePolicyID?: string, searchValue?: string, config?: OrderReportOptionsConfig): ReportAndPersonalDetailOptions { | ||
| let orderedReportOptions: SearchOptionData[]; | ||
| if (searchValue) { | ||
| orderedReportOptions = orderReportOptionsWithSearch(options.recentReports, searchValue, config); | ||
| orderedReportOptions = orderReportOptionsWithSearch(options.recentReports, searchValue, activePolicyID, config); | ||
| } else { | ||
| orderedReportOptions = orderReportOptions(options.recentReports); | ||
| } | ||
| const orderedPersonalDetailsOptions = orderPersonalDetailsOptions(options.personalDetails); | ||
| const orderedWorkspaceChats = orderWorkspaceOptions(options?.workspaceChats ?? []); | ||
| const orderedWorkspaceChats = orderWorkspaceOptions(options?.workspaceChats ?? [], activePolicyID); | ||
|
|
||
| return { | ||
| recentReports: orderedReportOptions, | ||
|
|
@@ -2458,16 +2453,17 @@ | |
| function combineOrderingOfReportsAndPersonalDetails( | ||
| options: ReportAndPersonalDetailOptions, | ||
| searchInputValue: string, | ||
| activePolicyID?: string, | ||
| {maxRecentReportsToShow, sortByReportTypeInSearch, ...orderReportOptionsConfig}: AllOrderConfigs = {}, | ||
| ): ReportAndPersonalDetailOptions { | ||
| // sortByReportTypeInSearch will show the personal details as part of the recent reports | ||
| if (sortByReportTypeInSearch) { | ||
| const personalDetailsWithoutDMs = filteredPersonalDetailsOfRecentReports(options.recentReports, options.personalDetails); | ||
| const reportsAndPersonalDetails = options.recentReports.concat(personalDetailsWithoutDMs); | ||
| return orderOptions({recentReports: reportsAndPersonalDetails, personalDetails: []}, searchInputValue, orderReportOptionsConfig); | ||
| return orderOptions({recentReports: reportsAndPersonalDetails, personalDetails: []}, activePolicyID ?? '', searchInputValue, orderReportOptionsConfig); | ||
|
Check failure on line 2463 in src/libs/OptionsListUtils/index.ts
|
||
| } | ||
|
|
||
| let orderedReports = orderReportOptionsWithSearch(options.recentReports, searchInputValue, orderReportOptionsConfig); | ||
| let orderedReports = orderReportOptionsWithSearch(options.recentReports, searchInputValue, activePolicyID, orderReportOptionsConfig); | ||
| if (typeof maxRecentReportsToShow === 'number') { | ||
| orderedReports = orderedReports.slice(0, maxRecentReportsToShow); | ||
| } | ||
|
|
@@ -2485,13 +2481,13 @@ | |
| * Filters and orders the options based on the search input value. | ||
| * Note that personal details that are part of the recent reports will always be shown as part of the recent reports (ie. DMs). | ||
| */ | ||
| function filterAndOrderOptions(options: Options, searchInputValue: string, countryCode: OnyxEntry<number>, config: FilterAndOrderConfig = {}): Options { | ||
| function filterAndOrderOptions(options: Options, searchInputValue: string, countryCode: OnyxEntry<number>, activePolicyID?: string, config: FilterAndOrderConfig = {}): Options { | ||
| let filterResult = options; | ||
| if (searchInputValue.trim().length > 0) { | ||
| filterResult = filterOptions(options, searchInputValue, countryCode, config); | ||
| } | ||
|
|
||
| const orderedOptions = combineOrderingOfReportsAndPersonalDetails(filterResult, searchInputValue, config); | ||
| const orderedOptions = combineOrderingOfReportsAndPersonalDetails(filterResult, searchInputValue, activePolicyID, config); | ||
|
|
||
| // on staging server, in specific cases (see issue) BE returns duplicated personalDetails entries | ||
| const uniqueLogins = new Set<string>(); | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Do not default string IDs to any value
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This parameter is required, so how do we manage that? I had to make this parameter required because of the different types this function support.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is lint error message 😄
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
But as I said, the param to the function is required but the
activePolicyIDis optional so we need to make sure it is not undefined but the value of this param can be empty which is a fine case.So to satisfy ts, we need to pass a default value.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@DylanDylann What do you suggest on how we handle this?
Here are 2 variants of this function.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@parasharrajat Why do we need to make activePolicyID as required while It could be undefined?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
In the second function declaration above, third param
searchValueis required so we have to makesecond paramrequired and as we needactivePolicyIDin all 3 declarations, I have to position it assecond param.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Do you agree with this?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@parasharrajat Sorry for the delay. Thanks for bump
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Initially, this function overload provided type safety and improved IntelliSense. However, in this PR, the returned type was unified across the overloads.
Because of that, the overload now seems redundant. I suggest removing it, which would also resolve the issue we’re facing here. Let me know what you think.