Skip to content

Add workspace rules PDF document upload, view, and management UI#89414

Open
ishpaul777 wants to merge 5 commits intoExpensify:mainfrom
ishpaul777:revert-89362-revert-87684-ishpaul/workspace-rules-document-upload
Open

Add workspace rules PDF document upload, view, and management UI#89414
ishpaul777 wants to merge 5 commits intoExpensify:mainfrom
ishpaul777:revert-89362-revert-87684-ishpaul/workspace-rules-document-upload

Conversation

@ishpaul777
Copy link
Copy Markdown
Contributor

@ishpaul777 ishpaul777 commented May 1, 2026

Explanation of Change

Adds frontend support for workspace admins to upload, replace, view, and delete a PDF rules document on the workspace overview page. Non-admins can view/download the document. This is the frontend (App) portion of a multi-repo change.

Key changes:

  • New rulesDocumentURL field on the Policy Onyx type
  • updatePolicyRulesDocument / deletePolicyRulesDocument action functions with optimistic/failure/finally Onyx updates
  • PDF thumbnail preview with three-dots menu (replace/remove) overlaid on thumbnail with circular background
  • Full-screen PDF viewer via WORKSPACE_DOCUMENT route and WorkspaceDocumentModalContent
  • getRulesDocumentSourceURL utility routing remote URLs through authenticated GetPolicyRulesDocument streaming endpoint with cache-busting
  • Translation keys added to all 3 locales (en, zh-hans, pt-BR)

Key decisions:

  • Field named rulesDocumentURL (not policyDocumentURL) — policy prefix is redundant inside a policy object
  • Optimistic updates use file.uri (local blob URL) for instant display — same pattern as workspace avatar
  • Cache-busting via &cacheBuster= encoding the full rulesDocumentURL — ensures unique streaming URL per PDF version
  • Dedicated WORKSPACE_DOCUMENT route instead of reusing REPORT_ATTACHMENTS
  • PDF served through authenticated streaming endpoint for CORS compatibility with pdfjs and privacy (private S3 bucket)

Companion PRs:

Fixed Issues

$ https://github.com/Expensify/Expensify/issues/610806
PROPOSAL: N/A (internal feature implementation)

Tests

  1. Navigate to workspace overview (Settings > Workspaces > [workspace] > Overview)
  2. As admin: scroll to "Expense policy" section, click "Choose file", select a PDF
  3. Verify PDF thumbnail renders with three-dots menu overlaid (circular white background, top-right)
  4. Click thumbnail to open full-screen PDF viewer — verify it loads correctly
  5. Use three-dots > Replace to upload a different PDF — verify thumbnail updates immediately (optimistic)
  6. Use three-dots > Remove — verify thumbnail disappears and "Choose file" button returns
  7. Try uploading a non-PDF file — verify error is shown
  8. As non-admin member: verify the thumbnail is visible and clickable (view-only), three-dots menu is hidden
  9. Verify the "Policy text" field (custom rules text input) still works as before
  • Verify that no errors appear in the JS console

Offline tests

  1. Upload a PDF while online, then go offline
  2. Verify the thumbnail remains visible (cached locally)
  3. While offline, attempt to replace the PDF — verify the optimistic update shows but a pending indicator is displayed
  4. Go back online — verify the change syncs

QA Steps

  1. Navigate to a workspace overview page
  2. Upload a PDF rules document as an admin
  3. Verify PDF thumbnail renders correctly with three-dots overlay
  4. Replace the document, verify the new PDF loads
  5. Remove the document, verify it clears
  6. As a non-admin, verify the document is viewable but not editable
  • 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
      • If any non-english text was added/modified, I used JaimeGPT to get English > Spanish translation. I then posted it 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 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
Screen.Recording.2026-05-02.at.10.02.39.PM.mov
Android: mWeb Chrome
Screen.Recording.2026-05-03.at.1.00.04.AM.mov
iOS: Native
Screen.Recording.2026-04-16.at.1.10.39.AM.mov
iOS: mWeb Safari
Screen.Recording.2026-04-16.at.1.10.02.AM.mov
MacOS: Chrome / Safari
Screen.Recording.2026-05-02.at.9.49.24.PM.mov
Screen.Recording.2026-05-02.at.9.49.24.PM.mov

… rules PDF document upload, view, and management UI""
@ishpaul777 ishpaul777 requested review from a team as code owners May 1, 2026 23:49
@melvin-bot
Copy link
Copy Markdown

melvin-bot Bot commented May 1, 2026

Hey, I noticed you changed src/languages/en.ts in a PR from a fork. For security reasons, translations are not generated automatically for PRs from forks.

If you want to automatically generate translations for other locales, an Expensify employee will have to:

  1. Look at the code and make sure there are no malicious changes.
  2. Run the Generate static translations GitHub workflow. If you have write access and the K2 extension, you can simply click: [this button]

Alternatively, if you are an external contributor, you can run the translation script locally with your own OpenAI API key. To learn more, try running:

npx ts-node ./scripts/generateTranslations.ts --help

Typically, you'd want to translate only what you changed by running npx ts-node ./scripts/generateTranslations.ts --compare-ref main

@melvin-bot melvin-bot Bot requested review from flaviadefaria and removed request for a team May 1, 2026 23:49
@ishpaul777 ishpaul777 changed the title Revert "[CP Staging] Revert "[Payment due @abzokhattab] Add workspace rules PDF document upload, view, and management UI"" Add workspace rules PDF document upload, view, and management UI May 1, 2026
@melvin-bot melvin-bot Bot requested review from carlosmiceli and removed request for a team May 1, 2026 23:50
@melvin-bot
Copy link
Copy Markdown

melvin-bot Bot commented May 1, 2026

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

@ishpaul777
Copy link
Copy Markdown
Contributor Author

@MelvinBot below this 2 issues were caused by this Changes and were reverted in #89362, can you summarize and suggest fixes

$ #89345
$ #89341

@MelvinBot
Copy link
Copy Markdown
Contributor

Summary & Suggested Fixes

Both issues were caused by #87684 (workspace rules PDF document upload) and reverted in #89362.


Issue #89345 — Password-protected PDFs accepted + modal loop

Problem: handleRulesDocumentPicked passes the file straight to updatePolicyRulesDocument with no password-protection check. Once a protected PDF is stored as rulesDocumentURL, the PDFThumbnail re-triggers the password prompt on every mount (tab switch → remount → modal reappears).

Fix: Before calling updatePolicyRulesDocument, validate the picked file using an invisible PDFThumbnail with an onPassword callback (same pattern useFilesValidation already uses for receipts). If onPassword fires, reject the file with the existing PROTECTED_FILE error. Only proceed on onLoadSuccess.


Issue #89341 — Blank PDF preview on Android (native)

Problem: The PressableWithoutFeedback wrapping the thumbnail uses alignItemsCenter, which prevents children from stretching horizontally in RN's column flex layout. The native PDFThumbnail relies on percentage-based sizing (w100/h100), so it resolves to 0 width. Web works because react-pdf renders a <canvas> with intrinsic pixel dimensions.

Fix: Add styles.w100 to the PDFThumbnail style prop so it gets explicit full width regardless of the parent's alignItemsCenter:

<PDFThumbnail
    previewSourceURL={rulesDocumentSourceURL}
    style={[styles.flex1, styles.w100]}
/>

Both fixes are small and can be included in this PR before re-landing.

@codecov
Copy link
Copy Markdown

codecov Bot commented May 1, 2026

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/CONST/index.ts 92.30% <ø> (ø)
src/SCREENS.ts 100.00% <ø> (ø)
src/libs/API/types.ts 100.00% <ø> (ø)
src/libs/Navigation/AppNavigator/AuthScreens.tsx 82.97% <100.00%> (+0.18%) ⬆️
...ateRootStackNavigator/GetStateForActionHandlers.ts 24.59% <ø> (ø)
src/libs/Navigation/linkingConfig/config.ts 76.92% <ø> (ø)
...ntModalScreen/AttachmentModalBaseContent/index.tsx 89.90% <100.00%> (-0.92%) ⬇️
src/styles/variables.ts 100.00% <ø> (ø)
src/ROUTES.ts 17.34% <0.00%> (-0.02%) ⬇️
src/pages/media/AttachmentModalScreen/index.tsx 22.91% <0.00%> (-2.67%) ⬇️
... and 5 more
... and 6 files with indirect coverage changes

Copy link
Copy Markdown

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

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: 2b66c649d9

ℹ️ About Codex in GitHub

Your team has set up Codex to 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 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment on lines +277 to +284
const mappedTypes = acceptedFileTypes.reduce<string[]>((result, extension) => {
const nativeType = EXTENSION_TO_NATIVE_TYPE[String(extension)];
if (nativeType !== undefined && !result.includes(nativeType)) {
result.push(nativeType);
}
return result;
}, []);
pickerTypes = mappedTypes.length > 0 ? mappedTypes : [types.allFiles];
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 Keep allowed extensions selectable on native picker

When acceptedFileTypes includes a mix of mapped and unmapped extensions, this reducer silently drops the unmapped ones and still applies a restricted pickerTypes list. In this repo, receipt uploads pass CONST.API_ATTACHMENT_VALIDATIONS.ALLOWED_RECEIPT_EXTENSIONS (which includes values like html, xml, rtf, and message), so those backend-allowed file types become unselectable on native because they are not represented in EXTENSION_TO_NATIVE_TYPE. This is a regression from the prior behavior where native used types.allFiles and relied on validation afterward.

Useful? React with 👍 / 👎.

ishpaul777 and others added 2 commits May 2, 2026 19:48
…ve WorkspaceOverviewPage with pending rules document management and error handling for protected PDFs.
@ishpaul777 ishpaul777 removed the request for review from carlosmiceli May 2, 2026 16:18
@ishpaul777 ishpaul777 requested a review from abzokhattab May 2, 2026 19:30
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.

3 participants