Skip to content

Add receipt capture-to-upload observability logging#94212

Closed
adhorodyski wants to merge 3 commits into
Expensify:mainfrom
callstack-internal:durable-receipts
Closed

Add receipt capture-to-upload observability logging#94212
adhorodyski wants to merge 3 commits into
Expensify:mainfrom
callstack-internal:durable-receipts

Conversation

@adhorodyski

@adhorodyski adhorodyski commented Jun 22, 2026

Copy link
Copy Markdown
Contributor

Explanation of Change

Adds structured logging so we can follow a single receipt from capture through to upload. Each receipt gets a unique trace id at capture time, and we log [Receipt] lines at three points: captured, submitted to the API, and enqueued in the network queue. We also log a snapshot of any still-pending receipts at sign-out, app backgrounding, and foregrounding.

The trace id and transaction id are also sent to Sentry as a breadcrumb and tag, so if the app crashes mid-upload the crash report shows the receipt's trail.

Fixed Issues

$ #92139
PROPOSAL:

Tests

  • Verify that no errors appear in the JS console

Offline tests

N/A

QA Steps

Same as tests

  • 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: mWeb Chrome
    • iOS: Native
    • iOS: mWeb Safari
    • MacOS: Chrome / Safari
  • 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 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)
  • 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)
  • 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 new assets were added or existing ones were modified, I verified that:
    • The assets are optimized and compressed (for SVG files, run npm run compress-svg)
    • The assets load correctly across all supported platforms.
  • 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.
  • I added unit tests for any new feature or bug fix in this PR to help automatically prevent regressions in this user 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.

Screenshots/Videos

Android: Native
Android: mWeb Chrome
iOS: Native
iOS: mWeb Safari
MacOS: Chrome / Safari

adhorodyski and others added 2 commits June 22, 2026 21:15
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
# Conflicts:
#	src/libs/Network/SequentialQueue.ts
#	src/libs/actions/IOU/Receipt.ts
@codecov

codecov Bot commented Jun 22, 2026

Copy link
Copy Markdown

Codecov Report

❌ Looks like you've decreased code coverage for some files. Please write tests to increase, or at least maintain, the existing level of code coverage. See our documentation here for how to interpret this table.

Files with missing lines Coverage Δ
src/libs/DebugUtils.ts 68.44% <ø> (ø)
src/libs/Network/SequentialQueue.ts 87.31% <100.00%> (+0.89%) ⬆️
src/libs/actions/IOU/MoneyRequest.ts 68.21% <100.00%> (+0.34%) ⬆️
src/libs/actions/IOU/Receipt.ts 79.12% <100.00%> (+0.46%) ⬆️
src/libs/actions/Session/index.ts 41.40% <100.00%> (+0.12%) ⬆️
src/libs/telemetry/forwardLogsToSentry.ts 86.20% <100.00%> (+5.07%) ⬆️
...step/IOURequestStepScan/utils/buildReceiptFiles.ts 88.88% <100.00%> (+2.22%) ⬆️
...request/step/confirmation/ReceiptFileValidator.tsx 60.00% <ø> (ø)
src/libs/actions/App.ts 52.28% <0.00%> (-0.37%) ⬇️
src/libs/telemetry/ReceiptObservability.ts 91.89% <91.89%> (ø)
... and 315 files with indirect coverage changes

@adhorodyski

Copy link
Copy Markdown
Contributor Author

@codex review

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: c46f9e481b

ℹ️ About Codex in GitHub

Codex has been enabled to automatically review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

When you sign up for Codex through ChatGPT, Codex can also answer questions or update the PR, like "@codex address that feedback".

Comment on lines 71 to 74
const receiptTraceId = mintAndStampReceiptTraceId(file);
logReceiptCaptured({file, captureSource, receiptTraceId});
receiptFiles.push({file, source, transactionID});
setMoneyRequestReceipt(transactionID, source, file.name ?? '', true, file.type);

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P2 Badge Persist the trace ID before leaving scan

When a receipt is captured through the scan flow, this stamps only the transient File object, but the confirmation screen does not reuse that object; ReceiptFileValidator rebuilds receiptFiles from the draft transaction.receipt written by setMoneyRequestReceipt. Because the saved draft receipt still contains only source/name/type, normal scan submissions lose receiptTraceId, so the later submitted/enqueued logs and Sentry breadcrumbs cannot be correlated back to the captured line. Persist the trace ID in the draft receipt and copy it onto the validated file before submit.

Useful? React with 👍 / 👎.

const now = Date.now();
const pendingTransactionIDs = new Set<string>();

for (const request of getAllPersistedRequests()) {

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P2 Badge Include ongoing requests in lifecycle snapshots

When the app backgrounds or signs out while a receipt upload is actively being processed, processNextRequest() has already moved that request out of getAll() and into the ongoing request slot. Since this snapshot iterates only getAllPersistedRequests(), it skips the riskiest mid-upload receipt and then treats its timing entry as drained during cleanup, leaving no lifecycle snapshot for a crash/kill during the actual upload. Include getOngoingRequest() in the snapshot and pending-ID cleanup.

Useful? React with 👍 / 👎.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@rinej

rinej commented Jun 30, 2026

Copy link
Copy Markdown
Contributor

The copy of this PR with recent fixes - ready for review -> #94950

@adhorodyski

Copy link
Copy Markdown
Contributor Author

closing here since we have another copy

@adhorodyski adhorodyski closed this Jul 3, 2026
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.

2 participants