Skip to content

fix: pass workspace policyID when exporting with account-level custom templates#92131

Merged
madmax330 merged 4 commits into
Expensify:mainfrom
aswin-s:fix/issue-89388
Jun 8, 2026
Merged

fix: pass workspace policyID when exporting with account-level custom templates#92131
madmax330 merged 4 commits into
Expensify:mainfrom
aswin-s:fix/issue-89388

Conversation

@aswin-s

@aswin-s aswin-s commented May 30, 2026

Copy link
Copy Markdown
Contributor

Explanation of Change

Account-level export templates have policyID: undefined by design (returned by getExportTemplates). Both export paths — the single-report path in useExportActions.beginExportWithTemplate and the bulk path in useSearchBulkActions.beginExportWithTemplate — were forwarding that undefined directly to queueExportSearchWithTemplate. The backend QueueExportSearchWithTemplate command needs a workspace policy ID to resolve GL codes from policy category/tag data, so it returned blank GL code columns.

Fix:

  • src/hooks/useExportActions.ts: Fall back to moneyRequestReport.policyID when the template has no policyID: policyID: policyID ?? moneyRequestReport.policyID
  • src/hooks/useSearchBulkActions.ts: Compute an effective export policy ID from the query/selection context before calling queueExportSearchWithTemplate, so account-level templates still resolve GL codes when the selected expenses belong to a single workspace. When the selection spans multiple workspaces, policyID is intentionally left undefined to avoid resolving GL codes against the wrong workspace.

Fixed Issues

$ #89388
PROPOSAL: #89388 (comment)

Tests

Preconditions:

  • An account-level custom export template (created in Classic via Settings → Account → Preferences → CSV Export Formats, or Reports → Export to → Create new CSV export layout — not a workspace-scoped Export Format) containing a column with the formula {expense:category:glcode} or {expense:tag:glcode}.
  • A workspace with GL codes assigned to at least one category or tag.
  • Expenses on that workspace categorized/tagged with those entries.

Bulk export path (useSearchBulkActions):

  1. Go to Search/Expenses view, filter to a single workspace (the one with GL codes), select expenses, and export using the account-level custom template
  2. Verify the exported file contains the correct GL codes (matching Classic Expensify output)
  3. Repeat without the workspace filter so the selection spans multiple workspaces, export with the same template, and verify no errors occur and the export still completes (GL codes may be unresolved by design when selection is multi-workspace — this is expected)

Single-report export path (useExportActions):
4. Open an expense report on a workspace with GL codes, use the report header menu → Export → choose the account-level custom template
5. Verify the exported file contains the correct GL codes

Verification at the network layer (optional but definitive):
6. With DevTools Network tab open, trigger an export and inspect the QueueExportSearchWithTemplate request body. With this fix on a single-workspace selection, policyID is present and matches the workspace ID. With a multi-workspace selection, policyID is absent (intentional).

  • Verify that no errors appear in the JS console

Offline tests

  1. Turn off network connection
  2. Attempt to export using a custom template
  3. Verify the offline modal appears and no export is triggered

QA Steps

Preconditions (same as Tests):

  • Account-level custom export template with a column using {expense:category:glcode} or {expense:tag:glcode}
  • Workspace with GL codes set on categories or tags
  • Expenses categorized/tagged accordingly

Bulk export path:

  1. In New Expensify, go to Search/Expenses, filter to the workspace that has GL codes (single workspace in scope), select expenses, export using the account-level template
  2. Verify the exported file contains the correct GL codes, matching the output from Classic Expensify
  3. Repeat with a selection that spans multiple workspaces and verify the export completes without errors

Single-report path:
4. Open an expense report on the same workspace, use the report header menu → Export → choose the account-level template
5. Verify the exported file contains the correct GL codes

  • 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 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 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.ts 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 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.
  • 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.
  • 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

CSV files can be verified on desktop only

Android: mWeb Chrome

CSV files can be verified on desktop only

iOS: Native

CSV files can be verified on desktop only

iOS: mWeb Safari CSV files can be verified on desktop only
MacOS: Chrome / Safari
Screen.Recording.2026-06-02.at.8.31.56.AM.mp4

… templates

Account-level export templates have policyID undefined by design, but the
backend needs a workspace policy ID to resolve GL codes from category/tag data.
Fall back to the report's policyID in useExportActions and compute an effective
export policy from the query/selection context in useSearchBulkActions.
@codecov

codecov Bot commented May 30, 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/hooks/useExportActions.ts 0.00% <0.00%> (ø)
src/hooks/useSearchBulkActions.ts 45.29% <0.00%> (-0.23%) ⬇️
... and 11 files with indirect coverage changes

@aswin-s aswin-s marked this pull request as ready for review June 2, 2026 03:15
@aswin-s aswin-s requested review from a team as code owners June 2, 2026 03:15
@melvin-bot melvin-bot Bot requested review from ShridharGoel and heyjennahay and removed request for a team June 2, 2026 03:15
@melvin-bot

melvin-bot Bot commented Jun 2, 2026

Copy link
Copy Markdown

@ShridharGoel 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 melvin-bot Bot removed the request for review from a team June 2, 2026 03:16

@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: c935ee82f3

ℹ️ 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 thread src/hooks/useSearchBulkActions.ts Outdated
When a selection mixes a workspace expense with policy-less (personal/
unreported) expenses, selectedPolicyIDs.filter(Boolean) collapses to a
single ID and the fallback wrongly sent that workspace as the export
policyID, resolving GL codes against the wrong scope. Require every
selected transaction to have a policyID before applying the fallback.
@ShridharGoel

ShridharGoel commented Jun 3, 2026

Copy link
Copy Markdown
Contributor

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
Screen.Recording.2026-06-05.at.6.00.27.PM.mov
Screen.Recording.2026-06-05.at.5.58.59.PM.mov

@ShridharGoel

Copy link
Copy Markdown
Contributor

GL codes may be unresolved by design when selection is multi-workspace — this is expected

@aswin-s Are we sure about this? Was this mentioned somewhere?

@aswin-s

aswin-s commented Jun 4, 2026

Copy link
Copy Markdown
Contributor Author

3. Repeat without the workspace filter so the selection spans multiple workspaces, export with the same template, and verify no errors occur and the export still completes (GL codes may be unresolved by design when selection is multi-workspace — this is expected)

@ShridharGoel Each workspace owns its own categories/tags, and the GL code lives on those category/tag definitions inside that workspace's policy. QueueExportSearchWithTemplate accepts only a single policyID (ExportSearchWithTemplateParams.ts:9), so for multi-workspace selections we deliberately send undefined rather than guess one workspace. Picking any single ID would resolve GL codes against the wrong scope. That's why I made the assumption above.

@melvin-bot melvin-bot Bot requested a review from madmax330 June 5, 2026 12:36
@ShridharGoel

Copy link
Copy Markdown
Contributor

@aswin-s Can you merge main here so that the failing test gets fixed?

@aswin-s

aswin-s commented Jun 5, 2026

Copy link
Copy Markdown
Contributor Author

@aswin-s Can you merge main here so that the failing test gets fixed?

@ShridharGoel Done.

@madmax330 madmax330 merged commit 4228253 into Expensify:main Jun 8, 2026
32 checks passed
@github-actions

github-actions Bot commented Jun 8, 2026

Copy link
Copy Markdown
Contributor

🚧 @madmax330 has triggered a test Expensify/App build. You can view the workflow run here.

@OSBotify

OSBotify commented Jun 8, 2026

Copy link
Copy Markdown
Contributor

✋ 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

OSBotify commented Jun 9, 2026

Copy link
Copy Markdown
Contributor

🚀 Deployed to staging by https://github.com/madmax330 in version: 9.4.1-0 🚀

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

Bundle Size Analysis (Sentry):

@MelvinBot

Copy link
Copy Markdown
Contributor

🤖 Help site review: no documentation changes required.

This PR is a backend-only bug fix. It changes which policyID is forwarded to the QueueExportSearchWithTemplate command so that account-level custom export templates correctly resolve GL codes ({expense:category:glcode} / {expense:tag:glcode}) against the relevant workspace, instead of returning blank columns.

There is no user-facing change to document:

  • No UI elements, labels, tabs, buttons, or workflows changed — the export flow (Spend → Expenses/Reports → SelectedExport → choose template) is identical.
  • No new feature was added. Account-level custom templates and GL-code formulas were already documented behavior.
  • The help site never documented the broken "blank GL codes" symptom, so there is nothing to correct.

The relevant articles remain accurate as-is:

Because no help site changes are needed, I did not create a draft docs PR. If you'd like a troubleshooting/FAQ note added anyway (e.g., "GL codes appear blank in custom template exports"), let me know with @MelvinBot and I'll draft one.

@aswin-s — please confirm you agree no help site updates are needed here. If you'd prefer a docs PR after all, reply and I'll create it.

@jponikarchuk

Copy link
Copy Markdown

Deploy Blocker #93088 was identified to be related to this PR.

@ShridharGoel

Copy link
Copy Markdown
Contributor

@madmax330 This has been working fine when we had tested.

@jponikarchuk Can you test on the adhoc build once?

@OSBotify

Copy link
Copy Markdown
Contributor

🚀 Deployed to production by https://github.com/Julesssss in version: 9.4.1-6 🚀

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

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.

6 participants