Skip to content

Perf: Add diagnostic sub-spans to ManualOpenSearchRouter #83076

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

Open
mountiny wants to merge 1 commit into
base: main
Choose a base branch
from
+212 −178
Open

Perf: Add diagnostic sub-spans to ManualOpenSearchRouter #83076

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions src/CONST/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1808,6 +1808,10 @@ const CONST = {
SPAN_OD_ND_TRANSITION: 'ManualOdNdTransition',
SPAN_OD_ND_TRANSITION_LOGGED_OUT: 'ManualOdNdTransitionLoggedOut',
SPAN_OPEN_SEARCH_ROUTER: 'ManualOpenSearchRouter',
SPAN_SEARCH_ROUTER_MODAL_CLOSE_WAIT: 'SearchRouter.ModalCloseWait',
SPAN_SEARCH_ROUTER_OPTIONS_INIT: 'SearchRouter.OptionsInit',
SPAN_SEARCH_ROUTER_COMPUTE_OPTIONS: 'SearchRouter.ComputeOptions',
SPAN_SEARCH_ROUTER_LIST_RENDER: 'SearchRouter.ListRender',
SPAN_OPEN_CREATE_EXPENSE: 'ManualOpenCreateExpense',
SPAN_SUBMIT_EXPENSE: 'ManualCreateExpenseSubmit',
SPAN_NAVIGATE_AFTER_EXPENSE_CREATE: 'ManualCreateExpenseNavigation',
Expand Down
54 changes: 33 additions & 21 deletions src/components/OptionListContextProvider.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,15 +1,17 @@
import React, {createContext, useCallback, useContext, useEffect, useMemo, useRef, useState} from 'react';
import type {OnyxCollection, OnyxEntry} from 'react-native-onyx';
import React, { createContext, useCallback, useContext, useEffect, useMemo, useRef, useState } from 'react';
import type { OnyxCollection, OnyxEntry } from 'react-native-onyx';
import useCurrentUserPersonalDetails from '@hooks/useCurrentUserPersonalDetails';
import useOnyx from '@hooks/useOnyx';
import usePrevious from '@hooks/usePrevious';
import usePrivateIsArchivedMap from '@hooks/usePrivateIsArchivedMap';
import {createOptionFromReport, createOptionList, processReport, shallowOptionsListCompare} from '@libs/OptionsListUtils';
import type {OptionList, SearchOption} from '@libs/OptionsListUtils';
import {isSelfDM} from '@libs/ReportUtils';
import { createOptionFromReport, createOptionList, processReport, shallowOptionsListCompare } from '@libs/OptionsListUtils';
import type { OptionList, SearchOption } from '@libs/OptionsListUtils';
import { isSelfDM } from '@libs/ReportUtils';
import { endSpan, getSpan, startSpan } from '@libs/telemetry/activeSpans';
import CONST from '@src/CONST';
import ONYXKEYS from '@src/ONYXKEYS';
import type {PersonalDetails, Report} from '@src/types/onyx';
import {usePersonalDetails} from './OnyxListItemProvider';
import type { PersonalDetails, Report } from '@src/types/onyx';
import { usePersonalDetails } from './OnyxListItemProvider';

type OptionsListContextProps = {
/** List of options for reports and personal details */
Expand Down Expand Up @@ -43,17 +45,17 @@ const isEqualPersonalDetail = (prevPersonalDetail: PersonalDetails, personalDeta
prevPersonalDetail?.login === personalDetail?.login &&
prevPersonalDetail?.displayName === personalDetail?.displayName;

function OptionsListContextProvider({children}: OptionsListProviderProps) {
function OptionsListContextProvider({ children }: OptionsListProviderProps) {
const areOptionsInitialized = useRef(false);
const [options, setOptions] = useState<OptionList>({
reports: [],
personalDetails: [],
});
const [reportAttributes] = useOnyx(ONYXKEYS.DERIVED.REPORT_ATTRIBUTES, {canBeMissing: true});
const [reportAttributes] = useOnyx(ONYXKEYS.DERIVED.REPORT_ATTRIBUTES, { canBeMissing: true });
const prevReportAttributesLocale = usePrevious(reportAttributes?.locale);
const [reports, {sourceValue: changedReports}] = useOnyx(ONYXKEYS.COLLECTION.REPORT, {canBeMissing: true});
const [reports, { sourceValue: changedReports }] = useOnyx(ONYXKEYS.COLLECTION.REPORT, { canBeMissing: true });
const prevReports = usePrevious(reports);
const [, {sourceValue: changedReportActions}] = useOnyx(ONYXKEYS.COLLECTION.REPORT_ACTIONS, {canBeMissing: true});
const [, { sourceValue: changedReportActions }] = useOnyx(ONYXKEYS.COLLECTION.REPORT_ACTIONS, { canBeMissing: true });
const personalDetails = usePersonalDetails();
const prevPersonalDetails = usePrevious(personalDetails);
const privateIsArchivedMap = usePrivateIsArchivedMap();
Expand Down Expand Up @@ -123,7 +125,7 @@ function OptionsListContextProvider({children}: OptionsListProviderProps) {
for (const reportKey of changedReportKeys) {
const report = changedReportsEntries[reportKey];
const reportID = reportKey.replace(ONYXKEYS.COLLECTION.REPORT, '');
const {reportOption} = processReport(report, personalDetails, currentUserAccountID, reportAttributes?.reports);
const { reportOption } = processReport(report, personalDetails, currentUserAccountID, reportAttributes?.reports);

if (reportOption) {
updatedReportsMap.set(reportID, reportOption);
Expand Down Expand Up @@ -157,7 +159,7 @@ function OptionsListContextProvider({children}: OptionsListProviderProps) {
}

const reportID = key.replace(ONYXKEYS.COLLECTION.REPORT_ACTIONS, '');
const {reportOption} = processReport(updatedReportsMap.get(reportID)?.item, personalDetails, currentUserAccountID, reportAttributes?.reports);
const { reportOption } = processReport(updatedReportsMap.get(reportID)?.item, personalDetails, currentUserAccountID, reportAttributes?.reports);

if (reportOption) {
updatedReportsMap.set(reportID, reportOption);
Expand Down Expand Up @@ -187,7 +189,7 @@ function OptionsListContextProvider({children}: OptionsListProviderProps) {
// Handle initial personal details load. This initialization is required here specifically to prevent
// UI freezing that occurs when resetting the app from the troubleshooting page.
if (!prevPersonalDetails) {
const {personalDetails: newPersonalDetailsOptions, reports: newReports} = createOptionList(
const { personalDetails: newPersonalDetailsOptions, reports: newReports } = createOptionList(
personalDetails,
currentUserAccountID,
privateIsArchivedMap,
Expand Down Expand Up @@ -227,7 +229,7 @@ function OptionsListContextProvider({children}: OptionsListProviderProps) {
}

const privateIsArchived = privateIsArchivedMap[`${ONYXKEYS.COLLECTION.REPORT_NAME_VALUE_PAIRS}${report.reportID}`];
const newReportOption = createOptionFromReport(report, personalDetails, currentUserAccountID, privateIsArchived, reportAttributes?.reports, {showPersonalDetails: true});
const newReportOption = createOptionFromReport(report, personalDetails, currentUserAccountID, privateIsArchived, reportAttributes?.reports, { showPersonalDetails: true });
const replaceIndex = options.reports.findIndex((option) => option.reportID === report.reportID);
newReportOptions.push({
newReportOption,
Expand All @@ -240,7 +242,7 @@ function OptionsListContextProvider({children}: OptionsListProviderProps) {
const newPersonalDetailsOptions = createOptionList(personalDetails, currentUserAccountID, privateIsArchivedMap, reports, reportAttributes?.reports).personalDetails;

setOptions((prevOptions) => {
const newOptions = {...prevOptions};
const newOptions = { ...prevOptions };
newOptions.personalDetails = newPersonalDetailsOptions;
for (const newReportOption of newReportOptions) {
newOptions.reports[newReportOption.replaceIndex] = newReportOption.newReportOption;
Expand All @@ -253,8 +255,18 @@ function OptionsListContextProvider({children}: OptionsListProviderProps) {
}, [personalDetails]);

const initializeOptions = useCallback(() => {
const isSearchRouterSpanActive = !!getSpan(CONST.TELEMETRY.SPAN_OPEN_SEARCH_ROUTER);
if (isSearchRouterSpanActive) {
startSpan(CONST.TELEMETRY.SPAN_SEARCH_ROUTER_OPTIONS_INIT, {
name: CONST.TELEMETRY.SPAN_SEARCH_ROUTER_OPTIONS_INIT,
op: 'function',
});
}
loadOptions();
areOptionsInitialized.current = true;
if (isSearchRouterSpanActive) {
endSpan(CONST.TELEMETRY.SPAN_SEARCH_ROUTER_OPTIONS_INIT);
}
}, [loadOptions]);

const resetOptions = useCallback(() => {
Expand All @@ -271,7 +283,7 @@ function OptionsListContextProvider({children}: OptionsListProviderProps) {

return (
<OptionsListContext.Provider
value={useMemo(() => ({options, initializeOptions, areOptionsInitialized: areOptionsInitialized.current, resetOptions}), [options, initializeOptions, resetOptions])}
value={useMemo(() => ({ options, initializeOptions, areOptionsInitialized: areOptionsInitialized.current, resetOptions }), [options, initializeOptions, resetOptions])}
>
{children}
</OptionsListContext.Provider>
Expand All @@ -281,9 +293,9 @@ function OptionsListContextProvider({children}: OptionsListProviderProps) {
const useOptionsListContext = () => useContext(OptionsListContext);

// Hook to use the OptionsListContext with an initializer to load the options
const useOptionsList = (options?: {shouldInitialize: boolean}) => {
const {shouldInitialize = true} = options ?? {};
const {initializeOptions, options: optionsList, areOptionsInitialized, resetOptions} = useOptionsListContext();
const useOptionsList = (options?: { shouldInitialize: boolean }) => {
const { shouldInitialize = true } = options ?? {};
const { initializeOptions, options: optionsList, areOptionsInitialized, resetOptions } = useOptionsListContext();
const [internalOptions, setInternalOptions] = useState<OptionList>(optionsList);
const prevOptions = useRef<OptionList>(null);
const [areInternalOptionsInitialized, setAreInternalOptionsInitialized] = useState(false);
Expand Down Expand Up @@ -340,4 +352,4 @@ const useOptionsList = (options?: {shouldInitialize: boolean}) => {

export default OptionsListContextProvider;

export {useOptionsList, OptionsListContext};
export { useOptionsList, OptionsListContext };
Loading
Loading