Uh oh!
There was an error while loading. Please reload this page.
fix(backend): strip private_metadata from resource _raw in SSR sanitizer - #8702
Conversation
stripPrivateDataFromObject now removes private_metadata from the backend resource _raw payload, preventing it from leaking into __clerk_ssr_state when a User/Organization resource is passed to buildClerkProps. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Snapi: no API changes detected in |
@clerk/astro@clerk/backend@clerk/chrome-extension@clerk/clerk-js@clerk/expo@clerk/expo-passkeys@clerk/express@clerk/fastify@clerk/hono@clerk/localizations@clerk/nextjs@clerk/nuxt@clerk/react@clerk/react-router@clerk/shared@clerk/tanstack-react-start@clerk/testing@clerk/ui@clerk/upgrade@clerk/vuecommit: |
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Repository YAML (base), Organization UI (inherited) Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (2)
📝 WalkthroughWalkthroughThis PR expands private-data stripping to backend resource _raw payloads: the prune helper accepts optional _raw and uses redactPrivateMetadataDeep to recursively remove both private_metadata and privateMetadata keys from arrays and objects, replacing resource._raw with a sanitized clone. Tests confirm top-level and nested private keys are removed (including inside organization_memberships), public_metadata is preserved, and the original raw objects are not mutated. A changeset documents the fix to prevent leakage into __clerk_ssr_state during buildClerkProps. Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes 🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (1)
packages/backend/src/util/__tests__/decorateObjectWithResources.test.ts (1)
10-11: ⚡ Quick winReduce
as anyusage in tests for safer fixtures.These casts can be replaced with typed fixtures (e.g.,
Parameters<typeof User.fromJSON>[0]/Parameters<typeof Organization.fromJSON>[0]) to keep test intent while preserving type checks.As per coding guidelines: "
**/*.{ts,tsx}: Avoidanytype - preferunknownwhen type is uncertain, then narrow with type guards" and "Noanytypes without justification in code review".Also applies to: 29-29, 38-38, 47-48, 51-52, 65-65
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@packages/backend/src/util/__tests__/decorateObjectWithResources.test.ts` around lines 10 - 11, Replace the unsafe "as any" casts in the test fixtures with properly typed fixture objects by using the parameter types of the model deserializers (e.g., use Parameters<typeof User.fromJSON>[0] for the user fixture and Parameters<typeof Organization.fromJSON>[0] for the organization fixture) and adjust other occurrences similarly (lines referencing the same test fixtures at the other locations) so the test inputs retain type checking; update the test variable declarations to use those parameter types and pass the objects through the existing fromJSON constructors (User.fromJSON, Organization.fromJSON) or narrow with appropriate type guards instead of casting to any.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@packages/backend/src/util/decorateObjectWithResources.ts`:
- Line 55: The parameter types for prunePrivateMetadata should avoid any: change
the signature to use unknown for scalar-ish fields and Record<string, unknown>
for object-like fields (e.g., replace private_metadata?: any, privateMetadata?:
any, _raw?: any with private_metadata?: unknown | Record<string, unknown>,
privateMetadata?: unknown | Record<string, unknown>, _raw?: unknown |
Record<string, unknown>); update prunePrivateMetadata to use narrowings/type
guards (typeof checks and Object.prototype.toString or Array.isArray where
appropriate) or safe casts before accessing properties so the sanitizer remains
type-safe while preserving existing behavior for private_metadata,
privateMetadata, and _raw.
---
Nitpick comments:
In `@packages/backend/src/util/__tests__/decorateObjectWithResources.test.ts`:
- Around line 10-11: Replace the unsafe "as any" casts in the test fixtures with
properly typed fixture objects by using the parameter types of the model
deserializers (e.g., use Parameters<typeof User.fromJSON>[0] for the user
fixture and Parameters<typeof Organization.fromJSON>[0] for the organization
fixture) and adjust other occurrences similarly (lines referencing the same test
fixtures at the other locations) so the test inputs retain type checking; update
the test variable declarations to use those parameter types and pass the objects
through the existing fromJSON constructors (User.fromJSON,
Organization.fromJSON) or narrow with appropriate type guards instead of casting
to any.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Repository YAML (base), Organization UI (inherited)
Review profile: CHILL
Plan: Pro
Run ID: b1fc3d27-ae40-4507-881c-74abc9301b8e
📒 Files selected for processing (3)
.changeset/proud-lions-allow.mdpackages/backend/src/util/__tests__/decorateObjectWithResources.test.tspackages/backend/src/util/decorateObjectWithResources.ts
| } | ||
| function prunePrivateMetadata(resource?: { private_metadata: any } | { privateMetadata: any } | null) { | ||
| function prunePrivateMetadata(resource?: { private_metadata?: any; privateMetadata?: any; _raw?: any } | null) { |
There was a problem hiding this comment.
🧩 Analysis chain
🏁 Script executed:
#!/bin/bash# Verify current `any` usage in the touched sanitizer and related test file.
rg -nP --type=ts '\bany\b' packages/backend/src/util/decorateObjectWithResources.ts packages/backend/src/util/__tests__/decorateObjectWithResources.test.tsRepository: clerk/javascript
Length of output: 1441
🏁 Script executed:
#!/bin/bashset -euo pipefail
sed -n '40,100p' packages/backend/src/util/decorateObjectWithResources.ts | cat -nRepository: clerk/javascript
Length of output: 1648
Replace any types in prunePrivateMetadata input
packages/backend/src/util/decorateObjectWithResources.ts uses any for private_metadata, privateMetadata, and _raw in the sanitizer signature (line 16); replace with unknown/Record<string, unknown> to keep the sanitization type-safe.
Suggested typed alternative
-function prunePrivateMetadata(resource?: { private_metadata?: any; privateMetadata?: any; _raw?: any } | null) {+type PrunableResource = {+ private_metadata?: unknown;+ privateMetadata?: unknown;+ _raw?: Record<string, unknown>;+} | null;++function prunePrivateMetadata(resource?: PrunableResource) {🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@packages/backend/src/util/decorateObjectWithResources.ts` at line 55, The
parameter types for prunePrivateMetadata should avoid any: change the signature
to use unknown for scalar-ish fields and Record<string, unknown> for object-like
fields (e.g., replace private_metadata?: any, privateMetadata?: any, _raw?: any
with private_metadata?: unknown | Record<string, unknown>, privateMetadata?:
unknown | Record<string, unknown>, _raw?: unknown | Record<string, unknown>);
update prunePrivateMetadata to use narrowings/type guards (typeof checks and
Object.prototype.toString or Array.isArray where appropriate) or safe casts
before accessing properties so the sanitizer remains type-safe while preserving
existing behavior for private_metadata, privateMetadata, and _raw.
jacekradko
commented
May 29, 2026
AI finding (P1): Please recursively redact Relevant spots:
|
…n SSR sanitizer The previous fix only removed the top-level `_raw.private_metadata`, but a `User`'s `_raw` payload nests further private metadata — each `organization_memberships[*]` carries its own `private_metadata` plus a nested `organization.private_metadata` — which still serialized into `__clerk_ssr_state`. Redact `private_metadata`/`privateMetadata` recursively on a deep clone of `_raw` so nested fields are stripped while the original resource (and its `raw` getter) is left untouched. Adds a regression test for the `organization_memberships` shape. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
🦋 Changeset detectedLatest commit: cc7bcbc The changes in this PR will be included in the next version bump. This PR includes changesets to release 10 packages
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
dominic-clerk
commented
May 29, 2026
New commit addresses the finding |
Description
stripPrivateDataFromObjectnow removesprivate_metadatafrom the backend resource_rawpayload, preventing it from leaking into__clerk_ssr_statewhen a User/Organization resource is passed tobuildClerkProps.Checklist
pnpm testruns as expected.pnpm buildruns as expected.Type of change