[ENG-2735] Add "download troubleshooting data" action to privacy request admin UI by nreyes-dev · Pull Request #7548 · ethyca/fides

nreyes-dev · 2026-03-03T13:27:34Z

Ticket ENG-2735

Description Of Changes

Add "download troubleshooting data" action to privacy request admin UI

Code Changes

Add diagnostics export query: Introduce getPrivacyRequestDiagnostics in fides/clients/admin-ui/src/features/privacy-requests/privacy-requests.slice.ts (GET privacy-request/${privacy_request_id}/diagnostics) and export useLazyGetPrivacyRequestDiagnosticsQuery.
Add download hook: Add useDownloadPrivacyRequestDiagnostics in fides/clients/admin-ui/src/features/privacy-requests/hooks/useDownloadPrivacyRequestDiagnostics.ts to:
- Fetch download_url via useLazyGetPrivacyRequestDiagnosticsQuery
- Gate visibility by ScopeRegistryEnum.PRIVACY_REQUEST_READ
- Show toast errors when the URL can’t be resolved
- Show an info message when diagnostics are stored locally (non-HTTP URL)
- Open the download URL in a new tab when it’s a remote URL
Wire into request details actions: Update fides/clients/admin-ui/src/features/privacy-requests/PrivacyRequestActionsDropdown.tsx to add a “Download troubleshooting data” action (disabled while the request is fetching) with data-testid="download-troubleshooting-data-btn. This dropdown is rendered on the privacy request details page (fides/clients/admin-ui/src/pages/privacy-requests/[id].tsx).

Steps to Confirm

Start the OSS backend + Admin UI, and ensure at least one privacy request exists (e.g. create one via Privacy Center so it appears in Request Manager).
In Admin UI, go to Privacy requests → Request manager and open any request’s Request details page.
Click the Actions dropdown (top right).
Confirm Download troubleshooting data is present.
Click Download troubleshooting data and confirm behavior:
- Remote storage: a new tab opens / file download starts (uses returned download_url).
- Local storage: a toast appears saying “Troubleshooting data stored locally cannot be downloaded” and nothing downloads.
Simulate an API failure (temporarily stop the backend or block the endpoint) and confirm an error toast appears (e.g. “Unable to resolve download URL”) and the action becomes clickable again after the request completes.
Verify the action is not shown for a user lacking PRIVACY_REQUEST_READ.

Pre-Merge Checklist

Summary by CodeRabbit

New Features
- Added a "Download troubleshooting data" action to the privacy request Admin UI, allowing administrators to retrieve diagnostic export files for investigating privacy request issues. The action appears conditionally and indicates progress while the export is being prepared.

vercel · 2026-03-03T13:27:40Z

The latest updates on your projects. Learn more about Vercel for GitHub.

Project	Deployment	Actions	Updated (UTC)
fides-plus-nightly	Ready	Preview, Comment	Mar 4, 2026 7:46pm

1 Skipped Deployment

Project	Deployment	Actions	Updated (UTC)
fides-privacy-center	Ignored		Mar 4, 2026 7:46pm

(delete empty trailing line)

coderabbitai · 2026-03-04T19:11:12Z

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: fef70049-d312-4d37-8d38-51c21afe1e05

📥 Commits

Reviewing files that changed from the base of the PR and between 315a8cb and 750208d.

📒 Files selected for processing (1)

clients/admin-ui/src/features/privacy-requests/hooks/useDownloadPrivacyRequestDiagnostics.ts

📝 Walkthrough

Walkthrough

Adds a "Download troubleshooting data" action to the Admin UI privacy request workflow: new hook to fetch diagnostics and perform downloads, dropdown integration to surface the action, new API lazy endpoint to retrieve diagnostics, and a response type for the diagnostics export.

Changes

Cohort / File(s)	Summary
Hook Implementation `clients/admin-ui/src/features/privacy-requests/hooks/useDownloadPrivacyRequestDiagnostics.ts`	New default-exported React hook that checks read permission, uses a lazy diagnostics query, exposes `showDownloadTroubleshootingData`, `downloadTroubleshootingData()` and `isLoading`, handles errors, and triggers programmatic browser downloads for remote URLs.
Dropdown Integration `clients/admin-ui/src/features/privacy-requests/PrivacyRequestActionsDropdown.tsx`	Integrates the new hook into the actions dropdown, conditionally adds a "Download troubleshooting data" menu item, ties disabled state to loading, and updates memo dependencies.
API Slice & Types `clients/admin-ui/src/features/privacy-requests/privacy-requests.slice.ts`, `clients/admin-ui/src/features/privacy-requests/types.ts`	Adds `getPrivacyRequestDiagnostics` endpoint with `useLazyGetPrivacyRequestDiagnosticsQuery` and introduces `PrivacyRequestDiagnosticsExportResponse` type (`download_url`, `storage_type`, `object_key`, `created_at`).
Changelog `changelog/ENG-2735-download-troubleshooting-data.yaml`	New changelog entry documenting the added "Download troubleshooting data" action in the privacy request Admin UI (PR 7548).

Sequence Diagram

sequenceDiagram
    participant Admin as Admin User
    participant Dropdown as PrivacyRequestActionsDropdown
    participant Hook as useDownloadPrivacyRequestDiagnostics
    participant API as Privacy Request API
    participant Storage as Remote Storage

    Admin->>Dropdown: Click "Download troubleshooting data"
    Dropdown->>Hook: call downloadTroubleshootingData()
    Hook->>API: GET /privacy-request/{id}/diagnostics
    API->>Storage: generate/upload diagnostics (if needed)
    Storage-->>API: return download_url
    API-->>Hook: return PrivacyRequestDiagnosticsExportResponse
    Hook->>Hook: validate download_url & storage_type
    Hook->>Storage: fetch diagnostics file (remote URL)
    Storage-->>Hook: return file stream/url
    Hook->>Admin: trigger browser download (anchor click)

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

Poem

🐰 A nibble, a hop, a diagnostic trail,

Click once and the troubleshooting sails.
Bundled logs in a neat little pack,
Downloaded swiftly—no rabbit backtrack! 🥕

🚥 Pre-merge checks | ✅ 3

✅ Passed checks (3 passed)

Check name	Status	Explanation
Title check	✅ Passed	The pull request title clearly and specifically describes the main change: adding a 'download troubleshooting data' action to the privacy request admin UI, with ticket reference.
Description check	✅ Passed	The pull request description comprehensively covers required template sections: ticket reference, detailed code changes, clear confirmation steps, and completed pre-merge checklist items.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

📝 Generate docstrings (stacked PR)
📝 Generate docstrings (commit on current branch)

🧪 Generate unit tests (beta)

Create PR with unit tests
Post copyable unit tests in a comment
Commit unit tests in branch nreyes/eng-2735

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

greptile-apps · 2026-03-04T19:15:52Z

Greptile Summary

This PR adds a "Download troubleshooting data" action to the privacy request admin UI. It introduces a new RTK Query endpoint (GET privacy-request/{id}/diagnostics), a custom hook (useDownloadPrivacyRequestDiagnostics) that fetches the download URL and triggers a browser download or shows an appropriate toast, and wires this into the existing PrivacyRequestActionsDropdown.

The overall approach is well-structured and consistent with the existing useDownloadPrivacyRequestResults hook. Two issues require attention:

preferCacheValue: true (line 29 of the hook): Passing true as the second argument instructs RTK Query to serve previously cached responses instead of re-fetching. If the backend returns time-limited presigned URLs (e.g., AWS S3 pre-signed URLs), repeated clicks within the same session will silently reuse the cached — and potentially expired — URL, causing download failures.
Dead code in error handler (lines 32-41): The inner if (result.error) check is always true within the outer if ("error" in result) block due to RTK Query's type guarantees, making the else branch unreachable. This can be simplified by removing the redundant inner check.

Confidence Score: 2/5

Not safe to merge — the preferCacheValue: true argument in line 29 causes stale/expired presigned URLs to be served on repeated clicks, which is a real functional bug for time-limited download URLs.
The PR implementation is well-structured and consistent with existing patterns, but contains a critical logic issue with preferCacheValue: true that will cause stale URLs to be reused on repeated clicks. This is a real-world problem for backends returning time-limited presigned URLs. Additionally, there's unnecessary dead code in error handling (a minor style issue). Both require fixes before merge.
clients/admin-ui/src/features/privacy-requests/hooks/useDownloadPrivacyRequestDiagnostics.ts — specifically lines 27-30 (preferCacheValue argument) and lines 32-41 (dead code branch).

_{Last reviewed commit: 315a8cb}

clients/admin-ui/src/features/privacy-requests/hooks/useDownloadPrivacyRequestDiagnostics.ts

coderabbitai

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents

Verify each finding against the current code and only fix it if needed.

Inline comments:
In
`@clients/admin-ui/src/features/privacy-requests/hooks/useDownloadPrivacyRequestDiagnostics.ts`:
- Around line 27-30: The code is passing preferCacheValue=true to
fetchDiagnostics which may return stale presigned download_url; update the call
in useDownloadPrivacyRequestDiagnostics (the fetchDiagnostics trigger) to omit
the second boolean argument so it always fetches fresh data: replace
fetchDiagnostics({ privacy_request_id: privacyRequest.id }, true) with a
single-argument call fetchDiagnostics({ privacy_request_id: privacyRequest.id })
(or otherwise remove/disable the preferCacheValue flag) so presigned URLs are
not served from cache.

ℹ️ Review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: bea76d71-61be-4a68-a00c-6c87fee13ccf

📥 Commits

Reviewing files that changed from the base of the PR and between 2c0ee18 and 315a8cb.

📒 Files selected for processing (5)

changelog/ENG-2735-download-troubleshooting-data.yaml
clients/admin-ui/src/features/privacy-requests/PrivacyRequestActionsDropdown.tsx
clients/admin-ui/src/features/privacy-requests/hooks/useDownloadPrivacyRequestDiagnostics.ts
clients/admin-ui/src/features/privacy-requests/privacy-requests.slice.ts
clients/admin-ui/src/features/privacy-requests/types.ts

clients/admin-ui/src/features/privacy-requests/hooks/useDownloadPrivacyRequestDiagnostics.ts

jpople

Looks good overall, couple nits about the code.

jpople · 2026-03-05T19:31:24Z

clients/admin-ui/src/features/privacy-requests/types.ts

+  storage_type: string;
+  object_key: string;
+  created_at: string;
+}


Can we use an auto-generated type for this?

jpople · 2026-03-05T19:33:42Z

clients/admin-ui/src/features/privacy-requests/PrivacyRequestActionsDropdown.tsx

+      menu.push({
+        key: "download-troubleshooting-data",
+        label: (
+          <span data-testid="download-troubleshooting-data-btn">


This doesn't seem to be used in any tests, so we shouldn't need the span wrapper with the test ID.

add "download troubleshooting data" action to privacy request admin UI

a041e41

nreyes-dev and others added 2 commits March 3, 2026 10:29

changelog

ac7590a

Merge branch 'main' into nreyes/eng-2735

dbabc24

vercel bot deployed to Preview – fides-plus-nightly March 3, 2026 13:35 View deployment

formatting

315a8cb

(delete empty trailing line)

nreyes-dev marked this pull request as ready for review March 4, 2026 19:11

nreyes-dev requested a review from a team as a code owner March 4, 2026 19:11

nreyes-dev requested review from jpople and removed request for a team March 4, 2026 19:11

vercel bot deployed to Preview – fides-plus-nightly March 4, 2026 19:15 View deployment

greptile-apps bot reviewed Mar 4, 2026

View reviewed changes

clients/admin-ui/src/features/privacy-requests/hooks/useDownloadPrivacyRequestDiagnostics.ts Outdated Show resolved Hide resolved

clients/admin-ui/src/features/privacy-requests/hooks/useDownloadPrivacyRequestDiagnostics.ts Show resolved Hide resolved

coderabbitai bot reviewed Mar 4, 2026

View reviewed changes

clients/admin-ui/src/features/privacy-requests/hooks/useDownloadPrivacyRequestDiagnostics.ts Outdated Show resolved Hide resolved

fix presigned url caching bug

750208d

vercel bot deployed to Preview – fides-plus-nightly March 4, 2026 19:46 View deployment

jpople approved these changes Mar 5, 2026

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[ENG-2735] Add "download troubleshooting data" action to privacy request admin UI#7548

[ENG-2735] Add "download troubleshooting data" action to privacy request admin UI#7548
nreyes-dev wants to merge 5 commits intomainfrom
nreyes/eng-2735

nreyes-dev commented Mar 3, 2026 •

edited by coderabbitai bot

Loading

Uh oh!

vercel bot commented Mar 3, 2026 •

edited

Loading

Uh oh!

coderabbitai bot commented Mar 4, 2026 •

edited

Loading

Walkthrough

Changes

Sequence Diagram

Estimated code review effort

Poem

Uh oh!

greptile-apps bot commented Mar 4, 2026

Uh oh!

Uh oh!

Uh oh!

coderabbitai bot left a comment

Uh oh!

Uh oh!

jpople left a comment

Uh oh!

jpople Mar 5, 2026

Uh oh!

jpople Mar 5, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Conversation

nreyes-dev commented Mar 3, 2026 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description Of Changes

Code Changes

Steps to Confirm

Pre-Merge Checklist

Summary by CodeRabbit

Uh oh!

vercel bot commented Mar 3, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

coderabbitai bot commented Mar 4, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Sequence Diagram

Estimated code review effort

Poem

Uh oh!

greptile-apps bot commented Mar 4, 2026

Greptile Summary

Confidence Score: 2/5

Uh oh!

Uh oh!

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

jpople left a comment

Choose a reason for hiding this comment

Uh oh!

jpople Mar 5, 2026

Choose a reason for hiding this comment

Uh oh!

jpople Mar 5, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

nreyes-dev commented Mar 3, 2026 •

edited by coderabbitai bot

Loading

vercel bot commented Mar 3, 2026 •

edited

Loading

coderabbitai bot commented Mar 4, 2026 •

edited

Loading