[NoQA] Add logs to help debug a NotFound issue

[lakchote]

Explanation of Change

Add logs to help debug a NotFound issue

Context

Fixed Issues

$ #77575
PROPOSAL:

Tests

• Verify that no errors appear in the JS console

NA, it's just logs added

Offline tests

NA

QA Steps

// TODO: These must be filled out, or the issue title must include "[No QA]."

• Verify that no errors appear in the JS console

NA, it's just logs added

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
  • If we are not using the full Onyx data that we loaded, I've added the proper selector in order to ensure the component only re-renders when the data it is using changes
    • 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 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 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

Android: Native

Android: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

[codecov]

Codecov Report

✅ Changes either increased or maintained existing code coverage, great job!

Files with missing lines	Coverage Δ
src/pages/Search/SearchMoneyRequestReportPage.tsx	0.00% <0.00%> (ø)
... and 5 files with indirect coverage changes

[melvin-bot]

@akinwale 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]

@MarioExpensify 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]

[github-actions]

❌ PERF-11 (docs)

The useOnyx hook is being called with the entire PERSONAL_DETAILS_LIST collection, but only a single personal detail entry (for ownerAccountID) is needed. This causes the component to subscribe to changes for ALL personal details in the system, leading to unnecessary re-renders whenever any user's personal details change.

Suggested fix:
Use a more specific Onyx key that targets only the owner's personal details:

const ownerPersonalDetailsKey = `${ONYXKEYS.PERSONAL_DETAILS_LIST}${ownerAccountID}` as const;
const [ownerPersonalDetails] = useOnyx(ownerPersonalDetailsKey, {canBeMissing: true});

If the collection pattern is required, consider using allowStaleData: true to reduce re-render frequency.

[lakchote]

PERSONAL_DETAILS_LIST is not a collection key (link). Collection keys are here:

App/src/ONYXKEYS.ts

Lines 653 to 772 in b756143

	/** Collection Keys */
	COLLECTION: {
	DOMAIN: 'domain_',
	DOWNLOAD: 'download_',
	POLICY: 'policy_',
	POLICY_DRAFTS: 'policyDrafts_',
	POLICY_JOIN_MEMBER: 'policyJoinMember_',
	POLICY_CATEGORIES: 'policyCategories_',
	POLICY_CATEGORIES_DRAFT: 'policyCategoriesDraft_',
	POLICY_RECENTLY_USED_CATEGORIES: 'policyRecentlyUsedCategories_',
	POLICY_TAGS: 'policyTags_',
	POLICY_RECENTLY_USED_TAGS: 'nvp_recentlyUsedTags_',
	POLICY_RECENTLY_USED_DESTINATIONS: 'nvp_recentlyUsedDestinations_',
	// Whether the policy's connection data was attempted to be fetched in
	// the current user session. As this state only exists client-side, it
	// should not be included as part of the policy object. The policy
	// object should mirror the data as it's stored in the database.
	POLICY_HAS_CONNECTIONS_DATA_BEEN_FETCHED: 'policyHasConnectionsDataBeenFetched_',
	POLICY_CONNECTION_SYNC_PROGRESS: 'policyConnectionSyncProgress_',
	WORKSPACE_INVITE_MEMBERS_DRAFT: 'workspaceInviteMembersDraft_',
	WORKSPACE_INVITE_MESSAGE_DRAFT: 'workspaceInviteMessageDraft_',
	WORKSPACE_INVITE_ROLE_DRAFT: 'workspaceInviteRoleDraft_',
	REPORT: 'report_',
	REPORT_NAME_VALUE_PAIRS: 'reportNameValuePairs_',
	REPORT_DRAFT: 'reportDraft_',
	// REPORT_METADATA is a perf optimization used to hold loading states (isLoadingInitialReportActions, isLoadingOlderReportActions, isLoadingNewerReportActions).
	// A lot of components are connected to the Report entity and do not care about the actions. Setting the loading state
	// directly on the report caused a lot of unnecessary re-renders
	REPORT_METADATA: 'reportMetadata_',
	REPORT_ACTIONS: 'reportActions_',
	REPORT_ACTIONS_DRAFTS: 'reportActionsDrafts_',
	REPORT_ACTIONS_PAGES: 'reportActionsPages_',
	REPORT_ACTIONS_REACTIONS: 'reportActionsReactions_',
	REPORT_DRAFT_COMMENT: 'reportDraftComment_',
	REPORT_IS_COMPOSER_FULL_SIZE: 'reportIsComposerFullSize_',
	REPORT_USER_IS_TYPING: 'reportUserIsTyping_',
	REPORT_USER_IS_LEAVING_ROOM: 'reportUserIsLeavingRoom_',
	REPORT_VIOLATIONS: 'reportViolations_',
	SECURITY_GROUP: 'securityGroup_',
	TRANSACTION: 'transactions_',
	TRANSACTION_VIOLATIONS: 'transactionViolations_',
	TRANSACTION_DRAFT: 'transactionsDraft_',
	SKIP_CONFIRMATION: 'skipConfirmation_',
	TRANSACTION_BACKUP: 'transactionsBackup_',
	SPLIT_TRANSACTION_DRAFT: 'splitTransactionDraft_',
	MERGE_TRANSACTION: 'mergeTransaction_',
	PRIVATE_NOTES_DRAFT: 'privateNotesDraft_',
	NEXT_STEP: 'reportNextStep_',
	// Manual expense tab selector
	SELECTED_TAB: 'selectedTab_',
	// Manual expense tab selector
	SELECTED_DISTANCE_REQUEST_TAB: 'selectedDistanceRequestTab_',
	/** This is deprecated, but needed for a migration, so we still need to include it here so that it will be initialized in Onyx.init */
	DEPRECATED_POLICY_MEMBER_LIST: 'policyMemberList_',
	// Search Page related
	SNAPSHOT: 'snapshot_',
	// Shared NVPs
	/** Collection of objects where each object represents the owner of the workspace that is past due billing AND the user is a member of. */
	SHARED_NVP_PRIVATE_USER_BILLING_GRACE_PERIOD_END: 'sharedNVP_private_billingGracePeriodEnd_',
	/** The collection of card feeds */
	SHARED_NVP_PRIVATE_DOMAIN_MEMBER: 'sharedNVP_private_domain_member_',
	/**
	* Stores the card list for a given fundID and feed in the format: cards_<fundID>_<bankName>
	* So for example: cards_12345_Expensify Card
	*/
	WORKSPACE_CARDS_LIST: 'cards_',
	/** Collection of objects where each object represents the card assignment that failed because we can't store errors in cardList or card feed due to server-provided IDs that aren't optimistic. */
	FAILED_COMPANY_CARDS_ASSIGNMENTS: 'failedCompanyCardsAssignments_',
	/** Expensify cards settings */
	PRIVATE_EXPENSIFY_CARD_SETTINGS: 'private_expensifyCardSettings_',
	/** Expensify cards bank account for a given workspace */
	EXPENSIFY_CARD_BANK_ACCOUNT_METADATA: 'expensifyCardBankAccountMetadata_',
	/** Expensify cards manual billing setting */
	PRIVATE_EXPENSIFY_CARD_MANUAL_BILLING: 'private_expensifyCardManualBilling_',
	/** Stores which connection is set up to use Continuous Reconciliation */
	EXPENSIFY_CARD_CONTINUOUS_RECONCILIATION_CONNECTION: 'expensifyCard_continuousReconciliationConnection_',
	/** The value that indicates whether Continuous Reconciliation should be used on the domain */
	EXPENSIFY_CARD_USE_CONTINUOUS_RECONCILIATION: 'expensifyCard_useContinuousReconciliation_',
	/** Currently displaying feed */
	LAST_SELECTED_FEED: 'lastSelectedFeed_',
	/** Currently displaying Expensify Card feed */
	LAST_SELECTED_EXPENSIFY_CARD_FEED: 'lastSelectedExpensifyCardFeed_',
	/** Whether the bank account chosen for Expensify Card in on verification waitlist */
	NVP_EXPENSIFY_ON_CARD_WAITLIST: 'nvp_expensify_onCardWaitlist_',
	NVP_EXPENSIFY_REPORT_PDF_FILENAME: 'nvp_expensify_report_PDFFilename_',
	/** Stores the information about the state of issuing a new card */
	ISSUE_NEW_EXPENSIFY_CARD: 'issueNewExpensifyCard_',
	/** Used for identifying user as admin of a domain */
	SHARED_NVP_PRIVATE_ADMIN_ACCESS: 'sharedNVP_private_admin_access_',
	/** Stored the user information with whom bank account is being shared */
	BANK_ACCOUNT_SHARE_DETAILS: 'expensify_bankAccountShare_',
	/** SAML login metadata for a domain */
	SAML_METADATA: 'saml_metadata_',
	/** Pending actions for a domain */
	DOMAIN_PENDING_ACTIONS: 'domainPendingActions_',
	/** Errors related to a domain */
	DOMAIN_ERRORS: 'domainErrors_',
	},

[s77rt]

Not sure if this is a real problem because I see this pattern a lot but it still concerns me. Does usePrevious works as expected when we use its value inside another hook?

Here is what I'm thinking
Render phase:

• shouldShowAccessErrorPage is false
• prevShouldShowAccessErrorPage is undefined

Side-effects phase:

• useEffect (inside usePrevious) updates prevShouldShowAccessErrorPage to false
• useEffect (the checker) returns early because shouldShowAccessErrorPage is false

Render phase 2:

• shouldShowAccessErrorPage is true
• prevShouldShowAccessErrorPage is false

Side-effects phase 2:

• useEffect (inside usePrevious) updates prevShouldShowAccessErrorPage to true
• useEffect (the checker) returns early because prevShouldShowAccessErrorPage is true

And we don't end up sending the log? Or am I missing something?

[lakchote]

@s77rt closures capture values at render time, not effect time.

RENDER PHASE:

1. shouldShowAccessErrorPage = true
2. usePrevious(true) called -> but ref.current is still false (effect from render 1 set it)
3. prevShouldShowAccessErrorPage = false (captured in effect closure)

EFFECT PHASE:

1. usePrevious effect runs first: ref.current = true
2. Logging effect runs with closure values from render: shouldShowAccessErrorPage=true, prevShouldShowAccessErrorPage=false
3. Condition: !true || false = false -> log is sent

prevShouldShowAccessErrorPage is false not undefined, as it initializes with useRef<T>(value).

I've created a code sandbox to illustrate it: https://codesandbox.io/p/sandbox/zl53xr

Also here's the proof in App:

[s77rt]

Thank you! That makes sense. In the effect we modified the ref value but the value we have in hand was captured before and that internal change does not affect us.

[trjExpensify]

Don't think we need a product review on a logging PR, unassigned myself 👍

[mountiny]

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 that the composer does not automatically focus or open the keyboard on mobile unless explicitly intended. This includes checking that returning the app from the background does not unexpectedly open the keyboard.
• I verified tests pass on all platforms & I tested again on:
  • Android: HybridApp
  • Android: mWeb Chrome
  • iOS: HybridApp
  • iOS: mWeb Safari
  • MacOS: Chrome / Safari
• 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 there are no new alerts related to the canBeMissing param for useOnyx
• 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: HybridApp

Android: mWeb Chrome

iOS: HybridApp

iOS: mWeb Safari

MacOS: Chrome / Safari

[mountiny]

let's keen an eye on this to see how often this log happens?

[lakchote]

Sure thing!

[s77rt]

FWIW, the bug may have been caused by useOnyx since it was looking at the snapshot_ collection (since we are on a search page) but the report was only available in the report_ collection. If that was the case, this PR #79506 would fix that

[lakchote]

FWIW, the bug may have been caused by useOnyx since it was looking at the snapshot_ collection (since we are on a search page) but the report was only available in the report_ collection. If that was the case, this PR #79506 would fix that

Let's see if we have any other occurrences of this bug; otherwise, it's likely the cause.

I still think these logs will help us down the line for tricky bugs 😄

[OSBotify]

✋ This PR was not deployed to staging yet because QA is ongoing. It will be automatically deployed to staging after the next production release.

[OSBotify]

🚀 Deployed to staging by https://github.com/lakchote in version: 9.3.5-0 🚀

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

[OSBotify]

🚀 Deployed to production by https://github.com/Beamanator in version: 9.3.5-7 🚀

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