Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/proud-lions-allow.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/backend': patch
---

Strip `private_metadata` from the backend resource `_raw` payload in `stripPrivateDataFromObject`, preventing it from leaking into `__clerk_ssr_state` when a `User`/`Organization` resource is passed to `buildClerkProps`.
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,121 @@
import { describe, expect, it } from 'vitest';

import { Organization } from '../../api/resources/Organization';
import { User } from '../../api/resources/User';
import { stripPrivateDataFromObject } from '../decorateObjectWithResources';

describe('stripPrivateDataFromObject', () => {
it('removes top-level private metadata from user and organization', () => {
const result = stripPrivateDataFromObject({
user: { id: 'user_1', privateMetadata: { secret: 'a' } } as any,
organization: { id: 'org_1', privateMetadata: { secret: 'b' } } as any,
});

expect(result.user).not.toHaveProperty('privateMetadata');
expect(result.organization).not.toHaveProperty('privateMetadata');
});

it('strips private_metadata nested under the backend resource `_raw` payload', () => {
const user = User.fromJSON({
id: 'user_1',
object: 'user',
private_metadata: { ssn: '000-00-0000' },
public_metadata: { plan: 'pro' },
email_addresses: [],
phone_numbers: [],
web3_wallets: [],
external_accounts: [],
enterprise_accounts: [],
} as any);

const organization = Organization.fromJSON({
id: 'org_1',
object: 'organization',
name: 'Acme',
slug: 'acme',
private_metadata: { billingCustomerId: 'cus_secret' },
public_metadata: { tier: 'enterprise' },
} as any);

const result = stripPrivateDataFromObject({ user, organization });

// Serialize the way `buildClerkProps` embeds the state into the HTML response.
const serialized = JSON.stringify(result);
expect(serialized).not.toContain('000-00-0000');
expect(serialized).not.toContain('cus_secret');

expect((result.user as any)._raw).not.toHaveProperty('private_metadata');
expect((result.organization as any)._raw).not.toHaveProperty('private_metadata');

// Public metadata under `_raw` is intentionally preserved.
expect((result.user as any)._raw.public_metadata).toEqual({ plan: 'pro' });
expect((result.organization as any)._raw.public_metadata).toEqual({ tier: 'enterprise' });
});

it('recursively strips private_metadata nested under `_raw.organization_memberships`', () => {
const user = User.fromJSON({
id: 'user_1',
object: 'user',
private_metadata: { ssn: '000-00-0000' },
public_metadata: { plan: 'pro' },
email_addresses: [],
phone_numbers: [],
web3_wallets: [],
external_accounts: [],
enterprise_accounts: [],
organization_memberships: [
{
id: 'orgmem_1',
object: 'organization_membership',
role: 'admin',
permissions: [],
private_metadata: { membershipSecret: 'mem_secret' },
public_metadata: { seat: 'a' },
created_at: 1,
updated_at: 1,
organization: {
id: 'org_1',
object: 'organization',
name: 'Acme',
slug: 'acme',
private_metadata: { billingCustomerId: 'cus_secret' },
public_metadata: { tier: 'enterprise' },
},
},
],
} as any);

const result = stripPrivateDataFromObject({ user });

const serialized = JSON.stringify(result);
expect(serialized).not.toContain('000-00-0000');
expect(serialized).not.toContain('mem_secret');
expect(serialized).not.toContain('cus_secret');

const membership = (result.user as any)._raw.organization_memberships[0];
expect(membership).not.toHaveProperty('private_metadata');
expect(membership.organization).not.toHaveProperty('private_metadata');

// Public metadata throughout the nested payload is intentionally preserved.
expect(membership.public_metadata).toEqual({ seat: 'a' });
expect(membership.organization.public_metadata).toEqual({ tier: 'enterprise' });
});

it('does not mutate the original resource `raw` payload', () => {
const user = User.fromJSON({
id: 'user_1',
object: 'user',
private_metadata: { ssn: '000-00-0000' },
email_addresses: [],
phone_numbers: [],
web3_wallets: [],
external_accounts: [],
enterprise_accounts: [],
} as any);

stripPrivateDataFromObject({ user });

// The server-side `raw` getter must still expose the full payload.
expect(user.raw?.private_metadata).toEqual({ ssn: '000-00-0000' });
});
});
33 changes: 32 additions & 1 deletion packages/backend/src/util/decorateObjectWithResources.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -52,7 +52,7 @@ export function stripPrivateDataFromObject<T extends WithResources<object>>(auth
return { ...authObject, user, organization };
}

function prunePrivateMetadata(resource?: { private_metadata: any } | { privateMetadata: any } | null) {
function prunePrivateMetadata(resource?: { private_metadata?: any; privateMetadata?: any; _raw?: any } | null) {

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟡 Minor | ⚡ Quick win

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

Repository: clerk/javascript

Length of output: 1441


🏁 Script executed:

#!/bin/bashset -euo pipefail
sed -n '40,100p' packages/backend/src/util/decorateObjectWithResources.ts | cat -n

Repository: 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.

// Delete sensitive private metadata from resource before rendering in SSR
if (resource) {
if ('privateMetadata' in resource) {
Expand All@@ -61,7 +61,38 @@ function prunePrivateMetadata(resource?: { private_metadata: any } | { privateMe
if ('private_metadata' in resource) {
delete resource['private_metadata'];
}
// Backend resources (`User`, `Organization`) retain the full Backend API
// payload on the enumerable `_raw` property, which still contains
// `private_metadata`. The payload is also nested (e.g. a `User`'s
// `organization_memberships[*]` each carry their own `private_metadata`
// and a nested `organization.private_metadata`), so redact recursively on
// a deep clone — leaving the original resource (and its `raw` getter)
// untouched.
if ('_raw' in resource && resource['_raw']) {
resource['_raw'] = redactPrivateMetadataDeep(resource['_raw']);
}
}

return resource;
}

/**
* Returns a deep clone of `value` with every `private_metadata` / `privateMetadata`
* property removed at any depth.
*/
function redactPrivateMetadataDeep(value: any): any {
if (Array.isArray(value)) {
return value.map(redactPrivateMetadataDeep);
}
if (value && typeof value === 'object') {
const clone: Record<string, any> = {};
for (const key of Object.keys(value)) {
if (key === 'private_metadata' || key === 'privateMetadata') {
continue;
}
clone[key] = redactPrivateMetadataDeep(value[key]);
}
return clone;
}
return value;
}
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
fix(backend): strip private_metadata from resource _raw in SSR sanitizer by dominic-clerk · Pull Request #8702 · clerk/javascript · GitHub
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/proud-lions-allow.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/backend': patch
---

Strip `private_metadata` from the backend resource `_raw` payload in `stripPrivateDataFromObject`, preventing it from leaking into `__clerk_ssr_state` when a `User`/`Organization` resource is passed to `buildClerkProps`.
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,121 @@
import { describe, expect, it } from 'vitest';

import { Organization } from '../../api/resources/Organization';
import { User } from '../../api/resources/User';
import { stripPrivateDataFromObject } from '../decorateObjectWithResources';

describe('stripPrivateDataFromObject', () => {
it('removes top-level private metadata from user and organization', () => {
const result = stripPrivateDataFromObject({
user: { id: 'user_1', privateMetadata: { secret: 'a' } } as any,
organization: { id: 'org_1', privateMetadata: { secret: 'b' } } as any,
});

expect(result.user).not.toHaveProperty('privateMetadata');
expect(result.organization).not.toHaveProperty('privateMetadata');
});

it('strips private_metadata nested under the backend resource `_raw` payload', () => {
const user = User.fromJSON({
id: 'user_1',
object: 'user',
private_metadata: { ssn: '000-00-0000' },
public_metadata: { plan: 'pro' },
email_addresses: [],
phone_numbers: [],
web3_wallets: [],
external_accounts: [],
enterprise_accounts: [],
} as any);

const organization = Organization.fromJSON({
id: 'org_1',
object: 'organization',
name: 'Acme',
slug: 'acme',
private_metadata: { billingCustomerId: 'cus_secret' },
public_metadata: { tier: 'enterprise' },
} as any);

const result = stripPrivateDataFromObject({ user, organization });

// Serialize the way `buildClerkProps` embeds the state into the HTML response.
const serialized = JSON.stringify(result);
expect(serialized).not.toContain('000-00-0000');
expect(serialized).not.toContain('cus_secret');

expect((result.user as any)._raw).not.toHaveProperty('private_metadata');
expect((result.organization as any)._raw).not.toHaveProperty('private_metadata');

// Public metadata under `_raw` is intentionally preserved.
expect((result.user as any)._raw.public_metadata).toEqual({ plan: 'pro' });
expect((result.organization as any)._raw.public_metadata).toEqual({ tier: 'enterprise' });
});

it('recursively strips private_metadata nested under `_raw.organization_memberships`', () => {
const user = User.fromJSON({
id: 'user_1',
object: 'user',
private_metadata: { ssn: '000-00-0000' },
public_metadata: { plan: 'pro' },
email_addresses: [],
phone_numbers: [],
web3_wallets: [],
external_accounts: [],
enterprise_accounts: [],
organization_memberships: [
{
id: 'orgmem_1',
object: 'organization_membership',
role: 'admin',
permissions: [],
private_metadata: { membershipSecret: 'mem_secret' },
public_metadata: { seat: 'a' },
created_at: 1,
updated_at: 1,
organization: {
id: 'org_1',
object: 'organization',
name: 'Acme',
slug: 'acme',
private_metadata: { billingCustomerId: 'cus_secret' },
public_metadata: { tier: 'enterprise' },
},
},
],
} as any);

const result = stripPrivateDataFromObject({ user });

const serialized = JSON.stringify(result);
expect(serialized).not.toContain('000-00-0000');
expect(serialized).not.toContain('mem_secret');
expect(serialized).not.toContain('cus_secret');

const membership = (result.user as any)._raw.organization_memberships[0];
expect(membership).not.toHaveProperty('private_metadata');
expect(membership.organization).not.toHaveProperty('private_metadata');

// Public metadata throughout the nested payload is intentionally preserved.
expect(membership.public_metadata).toEqual({ seat: 'a' });
expect(membership.organization.public_metadata).toEqual({ tier: 'enterprise' });
});

it('does not mutate the original resource `raw` payload', () => {
const user = User.fromJSON({
id: 'user_1',
object: 'user',
private_metadata: { ssn: '000-00-0000' },
email_addresses: [],
phone_numbers: [],
web3_wallets: [],
external_accounts: [],
enterprise_accounts: [],
} as any);

stripPrivateDataFromObject({ user });

// The server-side `raw` getter must still expose the full payload.
expect(user.raw?.private_metadata).toEqual({ ssn: '000-00-0000' });
});
});
33 changes: 32 additions & 1 deletion packages/backend/src/util/decorateObjectWithResources.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -52,7 +52,7 @@ export function stripPrivateDataFromObject<T extends WithResources<object>>(auth
return { ...authObject, user, organization };
}

function prunePrivateMetadata(resource?: { private_metadata: any } | { privateMetadata: any } | null) {
function prunePrivateMetadata(resource?: { private_metadata?: any; privateMetadata?: any; _raw?: any } | null) {

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟡 Minor | ⚡ Quick win

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

Repository: clerk/javascript

Length of output: 1441


🏁 Script executed:

#!/bin/bashset -euo pipefail
sed -n '40,100p' packages/backend/src/util/decorateObjectWithResources.ts | cat -n

Repository: 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.

// Delete sensitive private metadata from resource before rendering in SSR
if (resource) {
if ('privateMetadata' in resource) {
Expand All@@ -61,7 +61,38 @@ function prunePrivateMetadata(resource?: { private_metadata: any } | { privateMe
if ('private_metadata' in resource) {
delete resource['private_metadata'];
}
// Backend resources (`User`, `Organization`) retain the full Backend API
// payload on the enumerable `_raw` property, which still contains
// `private_metadata`. The payload is also nested (e.g. a `User`'s
// `organization_memberships[*]` each carry their own `private_metadata`
// and a nested `organization.private_metadata`), so redact recursively on
// a deep clone — leaving the original resource (and its `raw` getter)
// untouched.
if ('_raw' in resource && resource['_raw']) {
resource['_raw'] = redactPrivateMetadataDeep(resource['_raw']);
}
}

return resource;
}

/**
* Returns a deep clone of `value` with every `private_metadata` / `privateMetadata`
* property removed at any depth.
*/
function redactPrivateMetadataDeep(value: any): any {
if (Array.isArray(value)) {
return value.map(redactPrivateMetadataDeep);
}
if (value && typeof value === 'object') {
const clone: Record<string, any> = {};
for (const key of Object.keys(value)) {
if (key === 'private_metadata' || key === 'privateMetadata') {
continue;
}
clone[key] = redactPrivateMetadataDeep(value[key]);
}
return clone;
}
return value;
}
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Force GitHub README to respect dark mode (function() { var style = document.createElement('style'); style.textContent = ' .markdown-body { color-scheme: dark light; } .markdown-body pre { background: #161b22 !important; } .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; } .markdown-body table th, .markdown-body table td { border-color: #30363d !important; } .markdown-body img { background: #0d1117; } .markdown-body blockquote { border-left-color: #8b949e; } .markdown-body hr { border-color: #30363d; } '; document.head.appendChild(style); })(); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' fix(backend): strip private_metadata from resource _raw in SSR sanitizer by dominic-clerk · Pull Request #8702 · clerk/javascript · GitHub
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/proud-lions-allow.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/backend': patch
---

Strip `private_metadata` from the backend resource `_raw` payload in `stripPrivateDataFromObject`, preventing it from leaking into `__clerk_ssr_state` when a `User`/`Organization` resource is passed to `buildClerkProps`.
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,121 @@
import { describe, expect, it } from 'vitest';

import { Organization } from '../../api/resources/Organization';
import { User } from '../../api/resources/User';
import { stripPrivateDataFromObject } from '../decorateObjectWithResources';

describe('stripPrivateDataFromObject', () => {
it('removes top-level private metadata from user and organization', () => {
const result = stripPrivateDataFromObject({
user: { id: 'user_1', privateMetadata: { secret: 'a' } } as any,
organization: { id: 'org_1', privateMetadata: { secret: 'b' } } as any,
});

expect(result.user).not.toHaveProperty('privateMetadata');
expect(result.organization).not.toHaveProperty('privateMetadata');
});

it('strips private_metadata nested under the backend resource `_raw` payload', () => {
const user = User.fromJSON({
id: 'user_1',
object: 'user',
private_metadata: { ssn: '000-00-0000' },
public_metadata: { plan: 'pro' },
email_addresses: [],
phone_numbers: [],
web3_wallets: [],
external_accounts: [],
enterprise_accounts: [],
} as any);

const organization = Organization.fromJSON({
id: 'org_1',
object: 'organization',
name: 'Acme',
slug: 'acme',
private_metadata: { billingCustomerId: 'cus_secret' },
public_metadata: { tier: 'enterprise' },
} as any);

const result = stripPrivateDataFromObject({ user, organization });

// Serialize the way `buildClerkProps` embeds the state into the HTML response.
const serialized = JSON.stringify(result);
expect(serialized).not.toContain('000-00-0000');
expect(serialized).not.toContain('cus_secret');

expect((result.user as any)._raw).not.toHaveProperty('private_metadata');
expect((result.organization as any)._raw).not.toHaveProperty('private_metadata');

// Public metadata under `_raw` is intentionally preserved.
expect((result.user as any)._raw.public_metadata).toEqual({ plan: 'pro' });
expect((result.organization as any)._raw.public_metadata).toEqual({ tier: 'enterprise' });
});

it('recursively strips private_metadata nested under `_raw.organization_memberships`', () => {
const user = User.fromJSON({
id: 'user_1',
object: 'user',
private_metadata: { ssn: '000-00-0000' },
public_metadata: { plan: 'pro' },
email_addresses: [],
phone_numbers: [],
web3_wallets: [],
external_accounts: [],
enterprise_accounts: [],
organization_memberships: [
{
id: 'orgmem_1',
object: 'organization_membership',
role: 'admin',
permissions: [],
private_metadata: { membershipSecret: 'mem_secret' },
public_metadata: { seat: 'a' },
created_at: 1,
updated_at: 1,
organization: {
id: 'org_1',
object: 'organization',
name: 'Acme',
slug: 'acme',
private_metadata: { billingCustomerId: 'cus_secret' },
public_metadata: { tier: 'enterprise' },
},
},
],
} as any);

const result = stripPrivateDataFromObject({ user });

const serialized = JSON.stringify(result);
expect(serialized).not.toContain('000-00-0000');
expect(serialized).not.toContain('mem_secret');
expect(serialized).not.toContain('cus_secret');

const membership = (result.user as any)._raw.organization_memberships[0];
expect(membership).not.toHaveProperty('private_metadata');
expect(membership.organization).not.toHaveProperty('private_metadata');

// Public metadata throughout the nested payload is intentionally preserved.
expect(membership.public_metadata).toEqual({ seat: 'a' });
expect(membership.organization.public_metadata).toEqual({ tier: 'enterprise' });
});

it('does not mutate the original resource `raw` payload', () => {
const user = User.fromJSON({
id: 'user_1',
object: 'user',
private_metadata: { ssn: '000-00-0000' },
email_addresses: [],
phone_numbers: [],
web3_wallets: [],
external_accounts: [],
enterprise_accounts: [],
} as any);

stripPrivateDataFromObject({ user });

// The server-side `raw` getter must still expose the full payload.
expect(user.raw?.private_metadata).toEqual({ ssn: '000-00-0000' });
});
});
33 changes: 32 additions & 1 deletion packages/backend/src/util/decorateObjectWithResources.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -52,7 +52,7 @@ export function stripPrivateDataFromObject<T extends WithResources<object>>(auth
return { ...authObject, user, organization };
}

function prunePrivateMetadata(resource?: { private_metadata: any } | { privateMetadata: any } | null) {
function prunePrivateMetadata(resource?: { private_metadata?: any; privateMetadata?: any; _raw?: any } | null) {

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟡 Minor | ⚡ Quick win

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

Repository: clerk/javascript

Length of output: 1441


🏁 Script executed:

#!/bin/bashset -euo pipefail
sed -n '40,100p' packages/backend/src/util/decorateObjectWithResources.ts | cat -n

Repository: 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.

// Delete sensitive private metadata from resource before rendering in SSR
if (resource) {
if ('privateMetadata' in resource) {
Expand All@@ -61,7 +61,38 @@ function prunePrivateMetadata(resource?: { private_metadata: any } | { privateMe
if ('private_metadata' in resource) {
delete resource['private_metadata'];
}
// Backend resources (`User`, `Organization`) retain the full Backend API
// payload on the enumerable `_raw` property, which still contains
// `private_metadata`. The payload is also nested (e.g. a `User`'s
// `organization_memberships[*]` each carry their own `private_metadata`
// and a nested `organization.private_metadata`), so redact recursively on
// a deep clone — leaving the original resource (and its `raw` getter)
// untouched.
if ('_raw' in resource && resource['_raw']) {
resource['_raw'] = redactPrivateMetadataDeep(resource['_raw']);
}
}

return resource;
}

/**
* Returns a deep clone of `value` with every `private_metadata` / `privateMetadata`
* property removed at any depth.
*/
function redactPrivateMetadataDeep(value: any): any {
if (Array.isArray(value)) {
return value.map(redactPrivateMetadataDeep);
}
if (value && typeof value === 'object') {
const clone: Record<string, any> = {};
for (const key of Object.keys(value)) {
if (key === 'private_metadata' || key === 'privateMetadata') {
continue;
}
clone[key] = redactPrivateMetadataDeep(value[key]);
}
return clone;
}
return value;
}
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Highlight search terms from Google/DuckDuckGo/Bing referrer (function() { var ref = document.referrer; var terms = []; if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) { var url = new URL(ref); var q = url.searchParams.get('q') || url.searchParams.get('p'); if (q) { terms = q.split(/\s+/).filter(function(t) { return t.length > 2; }); } } if (terms.length === 0) return; var style = document.createElement('style'); style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }'; document.head.appendChild(style); function highlight(node) { if (node.nodeType === 3) { // text node var text = node.textContent; var found = false; terms.forEach(function(term) { var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\]\\]/g, '\\') + ')', 'gi'); if (regex.test(text)) { found = true; var frag = document.createDocumentFragment(); var parts = text.split(regex); parts.forEach(function(part, i) { if (i % 2 === 0) { frag.appendChild(document.createTextNode(part)); } else { var span = document.createElement('span'); span.className = 'userscript-highlight'; span.textContent = part; frag.appendChild(span); } }); node.parentNode.replaceChild(frag, node); } }); } else if (node.nodeType === 1 && node.childNodes) { // element var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT']; if (!skipTags.includes(node.tagName)) { Array.from(node.childNodes).forEach(highlight); } } } highlight(document.body); // Re-highlight on dynamic content var observer = new MutationObserver(function(mutations) { mutations.forEach(function(m) { m.addedNodes.forEach(function(node) { if (node.nodeType === 1 || node.nodeType === 3) highlight(node); }); }); }); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' fix(backend): strip private_metadata from resource _raw in SSR sanitizer by dominic-clerk · Pull Request #8702 · clerk/javascript · GitHub
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/proud-lions-allow.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/backend': patch
---

Strip `private_metadata` from the backend resource `_raw` payload in `stripPrivateDataFromObject`, preventing it from leaking into `__clerk_ssr_state` when a `User`/`Organization` resource is passed to `buildClerkProps`.
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,121 @@
import { describe, expect, it } from 'vitest';

import { Organization } from '../../api/resources/Organization';
import { User } from '../../api/resources/User';
import { stripPrivateDataFromObject } from '../decorateObjectWithResources';

describe('stripPrivateDataFromObject', () => {
it('removes top-level private metadata from user and organization', () => {
const result = stripPrivateDataFromObject({
user: { id: 'user_1', privateMetadata: { secret: 'a' } } as any,
organization: { id: 'org_1', privateMetadata: { secret: 'b' } } as any,
});

expect(result.user).not.toHaveProperty('privateMetadata');
expect(result.organization).not.toHaveProperty('privateMetadata');
});

it('strips private_metadata nested under the backend resource `_raw` payload', () => {
const user = User.fromJSON({
id: 'user_1',
object: 'user',
private_metadata: { ssn: '000-00-0000' },
public_metadata: { plan: 'pro' },
email_addresses: [],
phone_numbers: [],
web3_wallets: [],
external_accounts: [],
enterprise_accounts: [],
} as any);

const organization = Organization.fromJSON({
id: 'org_1',
object: 'organization',
name: 'Acme',
slug: 'acme',
private_metadata: { billingCustomerId: 'cus_secret' },
public_metadata: { tier: 'enterprise' },
} as any);

const result = stripPrivateDataFromObject({ user, organization });

// Serialize the way `buildClerkProps` embeds the state into the HTML response.
const serialized = JSON.stringify(result);
expect(serialized).not.toContain('000-00-0000');
expect(serialized).not.toContain('cus_secret');

expect((result.user as any)._raw).not.toHaveProperty('private_metadata');
expect((result.organization as any)._raw).not.toHaveProperty('private_metadata');

// Public metadata under `_raw` is intentionally preserved.
expect((result.user as any)._raw.public_metadata).toEqual({ plan: 'pro' });
expect((result.organization as any)._raw.public_metadata).toEqual({ tier: 'enterprise' });
});

it('recursively strips private_metadata nested under `_raw.organization_memberships`', () => {
const user = User.fromJSON({
id: 'user_1',
object: 'user',
private_metadata: { ssn: '000-00-0000' },
public_metadata: { plan: 'pro' },
email_addresses: [],
phone_numbers: [],
web3_wallets: [],
external_accounts: [],
enterprise_accounts: [],
organization_memberships: [
{
id: 'orgmem_1',
object: 'organization_membership',
role: 'admin',
permissions: [],
private_metadata: { membershipSecret: 'mem_secret' },
public_metadata: { seat: 'a' },
created_at: 1,
updated_at: 1,
organization: {
id: 'org_1',
object: 'organization',
name: 'Acme',
slug: 'acme',
private_metadata: { billingCustomerId: 'cus_secret' },
public_metadata: { tier: 'enterprise' },
},
},
],
} as any);

const result = stripPrivateDataFromObject({ user });

const serialized = JSON.stringify(result);
expect(serialized).not.toContain('000-00-0000');
expect(serialized).not.toContain('mem_secret');
expect(serialized).not.toContain('cus_secret');

const membership = (result.user as any)._raw.organization_memberships[0];
expect(membership).not.toHaveProperty('private_metadata');
expect(membership.organization).not.toHaveProperty('private_metadata');

// Public metadata throughout the nested payload is intentionally preserved.
expect(membership.public_metadata).toEqual({ seat: 'a' });
expect(membership.organization.public_metadata).toEqual({ tier: 'enterprise' });
});

it('does not mutate the original resource `raw` payload', () => {
const user = User.fromJSON({
id: 'user_1',
object: 'user',
private_metadata: { ssn: '000-00-0000' },
email_addresses: [],
phone_numbers: [],
web3_wallets: [],
external_accounts: [],
enterprise_accounts: [],
} as any);

stripPrivateDataFromObject({ user });

// The server-side `raw` getter must still expose the full payload.
expect(user.raw?.private_metadata).toEqual({ ssn: '000-00-0000' });
});
});
33 changes: 32 additions & 1 deletion packages/backend/src/util/decorateObjectWithResources.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -52,7 +52,7 @@ export function stripPrivateDataFromObject<T extends WithResources<object>>(auth
return { ...authObject, user, organization };
}

function prunePrivateMetadata(resource?: { private_metadata: any } | { privateMetadata: any } | null) {
function prunePrivateMetadata(resource?: { private_metadata?: any; privateMetadata?: any; _raw?: any } | null) {

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟡 Minor | ⚡ Quick win

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

Repository: clerk/javascript

Length of output: 1441


🏁 Script executed:

#!/bin/bashset -euo pipefail
sed -n '40,100p' packages/backend/src/util/decorateObjectWithResources.ts | cat -n

Repository: 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.

// Delete sensitive private metadata from resource before rendering in SSR
if (resource) {
if ('privateMetadata' in resource) {
Expand All@@ -61,7 +61,38 @@ function prunePrivateMetadata(resource?: { private_metadata: any } | { privateMe
if ('private_metadata' in resource) {
delete resource['private_metadata'];
}
// Backend resources (`User`, `Organization`) retain the full Backend API
// payload on the enumerable `_raw` property, which still contains
// `private_metadata`. The payload is also nested (e.g. a `User`'s
// `organization_memberships[*]` each carry their own `private_metadata`
// and a nested `organization.private_metadata`), so redact recursively on
// a deep clone — leaving the original resource (and its `raw` getter)
// untouched.
if ('_raw' in resource && resource['_raw']) {
resource['_raw'] = redactPrivateMetadataDeep(resource['_raw']);
}
}

return resource;
}

/**
* Returns a deep clone of `value` with every `private_metadata` / `privateMetadata`
* property removed at any depth.
*/
function redactPrivateMetadataDeep(value: any): any {
if (Array.isArray(value)) {
return value.map(redactPrivateMetadataDeep);
}
if (value && typeof value === 'object') {
const clone: Record<string, any> = {};
for (const key of Object.keys(value)) {
if (key === 'private_metadata' || key === 'privateMetadata') {
continue;
}
clone[key] = redactPrivateMetadataDeep(value[key]);
}
return clone;
}
return value;
}
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Strip utm_, fbclid, gclid, etc. from all links on page (function() { var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content', 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid', 'ref', 'ref_src', 'source', 'medium', 'campaign']; function cleanUrl(url) { try { var u = new URL(url, window.location.origin); var changed = false; trackingParams.forEach(function(p) { if (u.searchParams.has(p)) { u.searchParams.delete(p); changed = true; } }); return changed ? u.toString() : url; } catch (e) { return url; } } function cleanLinks() { document.querySelectorAll('a[href]').forEach(function(a) { var clean = cleanUrl(a.href); if (clean !== a.href) a.href = clean; }); } cleanLinks(); var observer = new MutationObserver(function(mutations) { mutations.forEach(function(m) { m.addedNodes.forEach(function(node) { if (node.nodeType === 1) { if (node.tagName === 'A') cleanLinks(); node.querySelectorAll('a[href]').forEach(function(a) { var clean = cleanUrl(a.href); if (clean !== a.href) a.href = clean; }); } }); }); }); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + ' fix(backend): strip private_metadata from resource _raw in SSR sanitizer by dominic-clerk · Pull Request #8702 · clerk/javascript · GitHub
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/proud-lions-allow.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/backend': patch
---

Strip `private_metadata` from the backend resource `_raw` payload in `stripPrivateDataFromObject`, preventing it from leaking into `__clerk_ssr_state` when a `User`/`Organization` resource is passed to `buildClerkProps`.
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,121 @@
import { describe, expect, it } from 'vitest';

import { Organization } from '../../api/resources/Organization';
import { User } from '../../api/resources/User';
import { stripPrivateDataFromObject } from '../decorateObjectWithResources';

describe('stripPrivateDataFromObject', () => {
it('removes top-level private metadata from user and organization', () => {
const result = stripPrivateDataFromObject({
user: { id: 'user_1', privateMetadata: { secret: 'a' } } as any,
organization: { id: 'org_1', privateMetadata: { secret: 'b' } } as any,
});

expect(result.user).not.toHaveProperty('privateMetadata');
expect(result.organization).not.toHaveProperty('privateMetadata');
});

it('strips private_metadata nested under the backend resource `_raw` payload', () => {
const user = User.fromJSON({
id: 'user_1',
object: 'user',
private_metadata: { ssn: '000-00-0000' },
public_metadata: { plan: 'pro' },
email_addresses: [],
phone_numbers: [],
web3_wallets: [],
external_accounts: [],
enterprise_accounts: [],
} as any);

const organization = Organization.fromJSON({
id: 'org_1',
object: 'organization',
name: 'Acme',
slug: 'acme',
private_metadata: { billingCustomerId: 'cus_secret' },
public_metadata: { tier: 'enterprise' },
} as any);

const result = stripPrivateDataFromObject({ user, organization });

// Serialize the way `buildClerkProps` embeds the state into the HTML response.
const serialized = JSON.stringify(result);
expect(serialized).not.toContain('000-00-0000');
expect(serialized).not.toContain('cus_secret');

expect((result.user as any)._raw).not.toHaveProperty('private_metadata');
expect((result.organization as any)._raw).not.toHaveProperty('private_metadata');

// Public metadata under `_raw` is intentionally preserved.
expect((result.user as any)._raw.public_metadata).toEqual({ plan: 'pro' });
expect((result.organization as any)._raw.public_metadata).toEqual({ tier: 'enterprise' });
});

it('recursively strips private_metadata nested under `_raw.organization_memberships`', () => {
const user = User.fromJSON({
id: 'user_1',
object: 'user',
private_metadata: { ssn: '000-00-0000' },
public_metadata: { plan: 'pro' },
email_addresses: [],
phone_numbers: [],
web3_wallets: [],
external_accounts: [],
enterprise_accounts: [],
organization_memberships: [
{
id: 'orgmem_1',
object: 'organization_membership',
role: 'admin',
permissions: [],
private_metadata: { membershipSecret: 'mem_secret' },
public_metadata: { seat: 'a' },
created_at: 1,
updated_at: 1,
organization: {
id: 'org_1',
object: 'organization',
name: 'Acme',
slug: 'acme',
private_metadata: { billingCustomerId: 'cus_secret' },
public_metadata: { tier: 'enterprise' },
},
},
],
} as any);

const result = stripPrivateDataFromObject({ user });

const serialized = JSON.stringify(result);
expect(serialized).not.toContain('000-00-0000');
expect(serialized).not.toContain('mem_secret');
expect(serialized).not.toContain('cus_secret');

const membership = (result.user as any)._raw.organization_memberships[0];
expect(membership).not.toHaveProperty('private_metadata');
expect(membership.organization).not.toHaveProperty('private_metadata');

// Public metadata throughout the nested payload is intentionally preserved.
expect(membership.public_metadata).toEqual({ seat: 'a' });
expect(membership.organization.public_metadata).toEqual({ tier: 'enterprise' });
});

it('does not mutate the original resource `raw` payload', () => {
const user = User.fromJSON({
id: 'user_1',
object: 'user',
private_metadata: { ssn: '000-00-0000' },
email_addresses: [],
phone_numbers: [],
web3_wallets: [],
external_accounts: [],
enterprise_accounts: [],
} as any);

stripPrivateDataFromObject({ user });

// The server-side `raw` getter must still expose the full payload.
expect(user.raw?.private_metadata).toEqual({ ssn: '000-00-0000' });
});
});
33 changes: 32 additions & 1 deletion packages/backend/src/util/decorateObjectWithResources.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -52,7 +52,7 @@ export function stripPrivateDataFromObject<T extends WithResources<object>>(auth
return { ...authObject, user, organization };
}

function prunePrivateMetadata(resource?: { private_metadata: any } | { privateMetadata: any } | null) {
function prunePrivateMetadata(resource?: { private_metadata?: any; privateMetadata?: any; _raw?: any } | null) {

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟡 Minor | ⚡ Quick win

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

Repository: clerk/javascript

Length of output: 1441


🏁 Script executed:

#!/bin/bashset -euo pipefail
sed -n '40,100p' packages/backend/src/util/decorateObjectWithResources.ts | cat -n

Repository: 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.

// Delete sensitive private metadata from resource before rendering in SSR
if (resource) {
if ('privateMetadata' in resource) {
Expand All@@ -61,7 +61,38 @@ function prunePrivateMetadata(resource?: { private_metadata: any } | { privateMe
if ('private_metadata' in resource) {
delete resource['private_metadata'];
}
// Backend resources (`User`, `Organization`) retain the full Backend API
// payload on the enumerable `_raw` property, which still contains
// `private_metadata`. The payload is also nested (e.g. a `User`'s
// `organization_memberships[*]` each carry their own `private_metadata`
// and a nested `organization.private_metadata`), so redact recursively on
// a deep clone — leaving the original resource (and its `raw` getter)
// untouched.
if ('_raw' in resource && resource['_raw']) {
resource['_raw'] = redactPrivateMetadataDeep(resource['_raw']);
}
}

return resource;
}

/**
* Returns a deep clone of `value` with every `private_metadata` / `privateMetadata`
* property removed at any depth.
*/
function redactPrivateMetadataDeep(value: any): any {
if (Array.isArray(value)) {
return value.map(redactPrivateMetadataDeep);
}
if (value && typeof value === 'object') {
const clone: Record<string, any> = {};
for (const key of Object.keys(value)) {
if (key === 'private_metadata' || key === 'privateMetadata') {
continue;
}
clone[key] = redactPrivateMetadataDeep(value[key]);
}
return clone;
}
return value;
}
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Auto-enable theater mode on YouTube (function() { function tryTheater() { var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]'); if (btn && !btn.classList.contains('activated')) { btn.click(); } } // Try immediately tryTheater(); // Try after navigation (SPA) var lastUrl = location.href; setInterval(function() { if (location.href !== lastUrl) { lastUrl = location.href; setTimeout(tryTheater, 500); } }, 1000); // Also try on player load var observer = new MutationObserver(tryTheater); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' fix(backend): strip private_metadata from resource _raw in SSR sanitizer by dominic-clerk · Pull Request #8702 · clerk/javascript · GitHub
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/proud-lions-allow.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/backend': patch
---

Strip `private_metadata` from the backend resource `_raw` payload in `stripPrivateDataFromObject`, preventing it from leaking into `__clerk_ssr_state` when a `User`/`Organization` resource is passed to `buildClerkProps`.
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,121 @@
import { describe, expect, it } from 'vitest';

import { Organization } from '../../api/resources/Organization';
import { User } from '../../api/resources/User';
import { stripPrivateDataFromObject } from '../decorateObjectWithResources';

describe('stripPrivateDataFromObject', () => {
it('removes top-level private metadata from user and organization', () => {
const result = stripPrivateDataFromObject({
user: { id: 'user_1', privateMetadata: { secret: 'a' } } as any,
organization: { id: 'org_1', privateMetadata: { secret: 'b' } } as any,
});

expect(result.user).not.toHaveProperty('privateMetadata');
expect(result.organization).not.toHaveProperty('privateMetadata');
});

it('strips private_metadata nested under the backend resource `_raw` payload', () => {
const user = User.fromJSON({
id: 'user_1',
object: 'user',
private_metadata: { ssn: '000-00-0000' },
public_metadata: { plan: 'pro' },
email_addresses: [],
phone_numbers: [],
web3_wallets: [],
external_accounts: [],
enterprise_accounts: [],
} as any);

const organization = Organization.fromJSON({
id: 'org_1',
object: 'organization',
name: 'Acme',
slug: 'acme',
private_metadata: { billingCustomerId: 'cus_secret' },
public_metadata: { tier: 'enterprise' },
} as any);

const result = stripPrivateDataFromObject({ user, organization });

// Serialize the way `buildClerkProps` embeds the state into the HTML response.
const serialized = JSON.stringify(result);
expect(serialized).not.toContain('000-00-0000');
expect(serialized).not.toContain('cus_secret');

expect((result.user as any)._raw).not.toHaveProperty('private_metadata');
expect((result.organization as any)._raw).not.toHaveProperty('private_metadata');

// Public metadata under `_raw` is intentionally preserved.
expect((result.user as any)._raw.public_metadata).toEqual({ plan: 'pro' });
expect((result.organization as any)._raw.public_metadata).toEqual({ tier: 'enterprise' });
});

it('recursively strips private_metadata nested under `_raw.organization_memberships`', () => {
const user = User.fromJSON({
id: 'user_1',
object: 'user',
private_metadata: { ssn: '000-00-0000' },
public_metadata: { plan: 'pro' },
email_addresses: [],
phone_numbers: [],
web3_wallets: [],
external_accounts: [],
enterprise_accounts: [],
organization_memberships: [
{
id: 'orgmem_1',
object: 'organization_membership',
role: 'admin',
permissions: [],
private_metadata: { membershipSecret: 'mem_secret' },
public_metadata: { seat: 'a' },
created_at: 1,
updated_at: 1,
organization: {
id: 'org_1',
object: 'organization',
name: 'Acme',
slug: 'acme',
private_metadata: { billingCustomerId: 'cus_secret' },
public_metadata: { tier: 'enterprise' },
},
},
],
} as any);

const result = stripPrivateDataFromObject({ user });

const serialized = JSON.stringify(result);
expect(serialized).not.toContain('000-00-0000');
expect(serialized).not.toContain('mem_secret');
expect(serialized).not.toContain('cus_secret');

const membership = (result.user as any)._raw.organization_memberships[0];
expect(membership).not.toHaveProperty('private_metadata');
expect(membership.organization).not.toHaveProperty('private_metadata');

// Public metadata throughout the nested payload is intentionally preserved.
expect(membership.public_metadata).toEqual({ seat: 'a' });
expect(membership.organization.public_metadata).toEqual({ tier: 'enterprise' });
});

it('does not mutate the original resource `raw` payload', () => {
const user = User.fromJSON({
id: 'user_1',
object: 'user',
private_metadata: { ssn: '000-00-0000' },
email_addresses: [],
phone_numbers: [],
web3_wallets: [],
external_accounts: [],
enterprise_accounts: [],
} as any);

stripPrivateDataFromObject({ user });

// The server-side `raw` getter must still expose the full payload.
expect(user.raw?.private_metadata).toEqual({ ssn: '000-00-0000' });
});
});
33 changes: 32 additions & 1 deletion packages/backend/src/util/decorateObjectWithResources.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -52,7 +52,7 @@ export function stripPrivateDataFromObject<T extends WithResources<object>>(auth
return { ...authObject, user, organization };
}

function prunePrivateMetadata(resource?: { private_metadata: any } | { privateMetadata: any } | null) {
function prunePrivateMetadata(resource?: { private_metadata?: any; privateMetadata?: any; _raw?: any } | null) {

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟡 Minor | ⚡ Quick win

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

Repository: clerk/javascript

Length of output: 1441


🏁 Script executed:

#!/bin/bashset -euo pipefail
sed -n '40,100p' packages/backend/src/util/decorateObjectWithResources.ts | cat -n

Repository: 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.

// Delete sensitive private metadata from resource before rendering in SSR
if (resource) {
if ('privateMetadata' in resource) {
Expand All@@ -61,7 +61,38 @@ function prunePrivateMetadata(resource?: { private_metadata: any } | { privateMe
if ('private_metadata' in resource) {
delete resource['private_metadata'];
}
// Backend resources (`User`, `Organization`) retain the full Backend API
// payload on the enumerable `_raw` property, which still contains
// `private_metadata`. The payload is also nested (e.g. a `User`'s
// `organization_memberships[*]` each carry their own `private_metadata`
// and a nested `organization.private_metadata`), so redact recursively on
// a deep clone — leaving the original resource (and its `raw` getter)
// untouched.
if ('_raw' in resource && resource['_raw']) {
resource['_raw'] = redactPrivateMetadataDeep(resource['_raw']);
}
}

return resource;
}

/**
* Returns a deep clone of `value` with every `private_metadata` / `privateMetadata`
* property removed at any depth.
*/
function redactPrivateMetadataDeep(value: any): any {
if (Array.isArray(value)) {
return value.map(redactPrivateMetadataDeep);
}
if (value && typeof value === 'object') {
const clone: Record<string, any> = {};
for (const key of Object.keys(value)) {
if (key === 'private_metadata' || key === 'privateMetadata') {
continue;
}
clone[key] = redactPrivateMetadataDeep(value[key]);
}
return clone;
}
return value;
}
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Remove or un-stick sticky/fixed headers that block content (function() { function unstick() { document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) { if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') { el.style.position = 'static'; el.style.top = 'auto'; el.style.zIndex = 'auto'; } }); } unstick(); var observer = new MutationObserver(unstick); observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] }); })(); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' fix(backend): strip private_metadata from resource _raw in SSR sanitizer by dominic-clerk · Pull Request #8702 · clerk/javascript · GitHub
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/proud-lions-allow.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/backend': patch
---

Strip `private_metadata` from the backend resource `_raw` payload in `stripPrivateDataFromObject`, preventing it from leaking into `__clerk_ssr_state` when a `User`/`Organization` resource is passed to `buildClerkProps`.
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,121 @@
import { describe, expect, it } from 'vitest';

import { Organization } from '../../api/resources/Organization';
import { User } from '../../api/resources/User';
import { stripPrivateDataFromObject } from '../decorateObjectWithResources';

describe('stripPrivateDataFromObject', () => {
it('removes top-level private metadata from user and organization', () => {
const result = stripPrivateDataFromObject({
user: { id: 'user_1', privateMetadata: { secret: 'a' } } as any,
organization: { id: 'org_1', privateMetadata: { secret: 'b' } } as any,
});

expect(result.user).not.toHaveProperty('privateMetadata');
expect(result.organization).not.toHaveProperty('privateMetadata');
});

it('strips private_metadata nested under the backend resource `_raw` payload', () => {
const user = User.fromJSON({
id: 'user_1',
object: 'user',
private_metadata: { ssn: '000-00-0000' },
public_metadata: { plan: 'pro' },
email_addresses: [],
phone_numbers: [],
web3_wallets: [],
external_accounts: [],
enterprise_accounts: [],
} as any);

const organization = Organization.fromJSON({
id: 'org_1',
object: 'organization',
name: 'Acme',
slug: 'acme',
private_metadata: { billingCustomerId: 'cus_secret' },
public_metadata: { tier: 'enterprise' },
} as any);

const result = stripPrivateDataFromObject({ user, organization });

// Serialize the way `buildClerkProps` embeds the state into the HTML response.
const serialized = JSON.stringify(result);
expect(serialized).not.toContain('000-00-0000');
expect(serialized).not.toContain('cus_secret');

expect((result.user as any)._raw).not.toHaveProperty('private_metadata');
expect((result.organization as any)._raw).not.toHaveProperty('private_metadata');

// Public metadata under `_raw` is intentionally preserved.
expect((result.user as any)._raw.public_metadata).toEqual({ plan: 'pro' });
expect((result.organization as any)._raw.public_metadata).toEqual({ tier: 'enterprise' });
});

it('recursively strips private_metadata nested under `_raw.organization_memberships`', () => {
const user = User.fromJSON({
id: 'user_1',
object: 'user',
private_metadata: { ssn: '000-00-0000' },
public_metadata: { plan: 'pro' },
email_addresses: [],
phone_numbers: [],
web3_wallets: [],
external_accounts: [],
enterprise_accounts: [],
organization_memberships: [
{
id: 'orgmem_1',
object: 'organization_membership',
role: 'admin',
permissions: [],
private_metadata: { membershipSecret: 'mem_secret' },
public_metadata: { seat: 'a' },
created_at: 1,
updated_at: 1,
organization: {
id: 'org_1',
object: 'organization',
name: 'Acme',
slug: 'acme',
private_metadata: { billingCustomerId: 'cus_secret' },
public_metadata: { tier: 'enterprise' },
},
},
],
} as any);

const result = stripPrivateDataFromObject({ user });

const serialized = JSON.stringify(result);
expect(serialized).not.toContain('000-00-0000');
expect(serialized).not.toContain('mem_secret');
expect(serialized).not.toContain('cus_secret');

const membership = (result.user as any)._raw.organization_memberships[0];
expect(membership).not.toHaveProperty('private_metadata');
expect(membership.organization).not.toHaveProperty('private_metadata');

// Public metadata throughout the nested payload is intentionally preserved.
expect(membership.public_metadata).toEqual({ seat: 'a' });
expect(membership.organization.public_metadata).toEqual({ tier: 'enterprise' });
});

it('does not mutate the original resource `raw` payload', () => {
const user = User.fromJSON({
id: 'user_1',
object: 'user',
private_metadata: { ssn: '000-00-0000' },
email_addresses: [],
phone_numbers: [],
web3_wallets: [],
external_accounts: [],
enterprise_accounts: [],
} as any);

stripPrivateDataFromObject({ user });

// The server-side `raw` getter must still expose the full payload.
expect(user.raw?.private_metadata).toEqual({ ssn: '000-00-0000' });
});
});
33 changes: 32 additions & 1 deletion packages/backend/src/util/decorateObjectWithResources.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -52,7 +52,7 @@ export function stripPrivateDataFromObject<T extends WithResources<object>>(auth
return { ...authObject, user, organization };
}

function prunePrivateMetadata(resource?: { private_metadata: any } | { privateMetadata: any } | null) {
function prunePrivateMetadata(resource?: { private_metadata?: any; privateMetadata?: any; _raw?: any } | null) {

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟡 Minor | ⚡ Quick win

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

Repository: clerk/javascript

Length of output: 1441


🏁 Script executed:

#!/bin/bashset -euo pipefail
sed -n '40,100p' packages/backend/src/util/decorateObjectWithResources.ts | cat -n

Repository: 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.

// Delete sensitive private metadata from resource before rendering in SSR
if (resource) {
if ('privateMetadata' in resource) {
Expand All@@ -61,7 +61,38 @@ function prunePrivateMetadata(resource?: { private_metadata: any } | { privateMe
if ('private_metadata' in resource) {
delete resource['private_metadata'];
}
// Backend resources (`User`, `Organization`) retain the full Backend API
// payload on the enumerable `_raw` property, which still contains
// `private_metadata`. The payload is also nested (e.g. a `User`'s
// `organization_memberships[*]` each carry their own `private_metadata`
// and a nested `organization.private_metadata`), so redact recursively on
// a deep clone — leaving the original resource (and its `raw` getter)
// untouched.
if ('_raw' in resource && resource['_raw']) {
resource['_raw'] = redactPrivateMetadataDeep(resource['_raw']);
}
}

return resource;
}

/**
* Returns a deep clone of `value` with every `private_metadata` / `privateMetadata`
* property removed at any depth.
*/
function redactPrivateMetadataDeep(value: any): any {
if (Array.isArray(value)) {
return value.map(redactPrivateMetadataDeep);
}
if (value && typeof value === 'object') {
const clone: Record<string, any> = {};
for (const key of Object.keys(value)) {
if (key === 'private_metadata' || key === 'privateMetadata') {
continue;
}
clone[key] = redactPrivateMetadataDeep(value[key]);
}
return clone;
}
return value;
}
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Universal Dark Mode - works on any site (function() { var enabled = true; function applyDarkMode() { if (!enabled) return; // Create style element if it doesn't exist var style = document.getElementById('universal-dark-mode-style'); if (!style) { style = document.createElement('style'); style.id = 'universal-dark-mode-style'; document.head.appendChild(style); } // Dark mode CSS - inverts colors but preserves images/video style.textContent = ' /* Invert everything except media */ html { filter: invert(1) hue-rotate(180deg) !important; background: #1a1a2e !important; } /* Restore images, videos, iframes, canvas */ img, video, iframe, canvas, svg, picture, [style*="background-image"] { filter: invert(1) hue-rotate(180deg) !important; } /* Preserve specific elements that should not be inverted */ .no-dark-mode, .no-dark-mode *, [data-theme="light"], [data-theme="light"], .ace_editor, .ace_editor *, .CodeMirror, .CodeMirror *, .monaco-editor, .monaco-editor *, .markdown-body pre, .markdown-body pre *, .highlight, .highlight *, pre code, pre code * { filter: none !important; } /* Fix common UI elements */ .modal, .popup, .dropdown-menu, .tooltip, .popover { filter: invert(1) hue-rotate(180deg) !important; background: #2d2d44 !important; border-color: #444 !important; } /* Scrollbars */ ::-webkit-scrollbar { background: #1a1a2e !important; } ::-webkit-scrollbar-thumb { background: #444 !important; } ::-webkit-scrollbar-thumb:hover { background: #555 !important; } /* Selection */ ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; } ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; } '; } function removeDarkMode() { var style = document.getElementById('universal-dark-mode-style'); if (style) style.remove(); } // Toggle with Alt+Shift+D document.addEventListener('keydown', function(e) { if (e.altKey && e.shiftKey && e.key === 'D') { e.preventDefault(); enabled = !enabled; if (enabled) { applyDarkMode(); console.log('[Universal Dark Mode] Enabled'); } else { removeDarkMode(); console.log('[Universal Dark Mode] Disabled'); } } }); // Apply on load applyDarkMode(); // Re-apply on dynamic content var observer = new MutationObserver(function(mutations) { if (enabled && !document.getElementById('universal-dark-mode-style')) { applyDarkMode(); } }); observer.observe(document.head, { childList: true }); console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle'); })(); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })(); fix(backend): strip private_metadata from resource _raw in SSR sanitizer by dominic-clerk · Pull Request #8702 · clerk/javascript · GitHub
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/proud-lions-allow.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/backend': patch
---

Strip `private_metadata` from the backend resource `_raw` payload in `stripPrivateDataFromObject`, preventing it from leaking into `__clerk_ssr_state` when a `User`/`Organization` resource is passed to `buildClerkProps`.
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,121 @@
import { describe, expect, it } from 'vitest';

import { Organization } from '../../api/resources/Organization';
import { User } from '../../api/resources/User';
import { stripPrivateDataFromObject } from '../decorateObjectWithResources';

describe('stripPrivateDataFromObject', () => {
it('removes top-level private metadata from user and organization', () => {
const result = stripPrivateDataFromObject({
user: { id: 'user_1', privateMetadata: { secret: 'a' } } as any,
organization: { id: 'org_1', privateMetadata: { secret: 'b' } } as any,
});

expect(result.user).not.toHaveProperty('privateMetadata');
expect(result.organization).not.toHaveProperty('privateMetadata');
});

it('strips private_metadata nested under the backend resource `_raw` payload', () => {
const user = User.fromJSON({
id: 'user_1',
object: 'user',
private_metadata: { ssn: '000-00-0000' },
public_metadata: { plan: 'pro' },
email_addresses: [],
phone_numbers: [],
web3_wallets: [],
external_accounts: [],
enterprise_accounts: [],
} as any);

const organization = Organization.fromJSON({
id: 'org_1',
object: 'organization',
name: 'Acme',
slug: 'acme',
private_metadata: { billingCustomerId: 'cus_secret' },
public_metadata: { tier: 'enterprise' },
} as any);

const result = stripPrivateDataFromObject({ user, organization });

// Serialize the way `buildClerkProps` embeds the state into the HTML response.
const serialized = JSON.stringify(result);
expect(serialized).not.toContain('000-00-0000');
expect(serialized).not.toContain('cus_secret');

expect((result.user as any)._raw).not.toHaveProperty('private_metadata');
expect((result.organization as any)._raw).not.toHaveProperty('private_metadata');

// Public metadata under `_raw` is intentionally preserved.
expect((result.user as any)._raw.public_metadata).toEqual({ plan: 'pro' });
expect((result.organization as any)._raw.public_metadata).toEqual({ tier: 'enterprise' });
});

it('recursively strips private_metadata nested under `_raw.organization_memberships`', () => {
const user = User.fromJSON({
id: 'user_1',
object: 'user',
private_metadata: { ssn: '000-00-0000' },
public_metadata: { plan: 'pro' },
email_addresses: [],
phone_numbers: [],
web3_wallets: [],
external_accounts: [],
enterprise_accounts: [],
organization_memberships: [
{
id: 'orgmem_1',
object: 'organization_membership',
role: 'admin',
permissions: [],
private_metadata: { membershipSecret: 'mem_secret' },
public_metadata: { seat: 'a' },
created_at: 1,
updated_at: 1,
organization: {
id: 'org_1',
object: 'organization',
name: 'Acme',
slug: 'acme',
private_metadata: { billingCustomerId: 'cus_secret' },
public_metadata: { tier: 'enterprise' },
},
},
],
} as any);

const result = stripPrivateDataFromObject({ user });

const serialized = JSON.stringify(result);
expect(serialized).not.toContain('000-00-0000');
expect(serialized).not.toContain('mem_secret');
expect(serialized).not.toContain('cus_secret');

const membership = (result.user as any)._raw.organization_memberships[0];
expect(membership).not.toHaveProperty('private_metadata');
expect(membership.organization).not.toHaveProperty('private_metadata');

// Public metadata throughout the nested payload is intentionally preserved.
expect(membership.public_metadata).toEqual({ seat: 'a' });
expect(membership.organization.public_metadata).toEqual({ tier: 'enterprise' });
});

it('does not mutate the original resource `raw` payload', () => {
const user = User.fromJSON({
id: 'user_1',
object: 'user',
private_metadata: { ssn: '000-00-0000' },
email_addresses: [],
phone_numbers: [],
web3_wallets: [],
external_accounts: [],
enterprise_accounts: [],
} as any);

stripPrivateDataFromObject({ user });

// The server-side `raw` getter must still expose the full payload.
expect(user.raw?.private_metadata).toEqual({ ssn: '000-00-0000' });
});
});
33 changes: 32 additions & 1 deletion packages/backend/src/util/decorateObjectWithResources.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -52,7 +52,7 @@ export function stripPrivateDataFromObject<T extends WithResources<object>>(auth
return { ...authObject, user, organization };
}

function prunePrivateMetadata(resource?: { private_metadata: any } | { privateMetadata: any } | null) {
function prunePrivateMetadata(resource?: { private_metadata?: any; privateMetadata?: any; _raw?: any } | null) {

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟡 Minor | ⚡ Quick win

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

Repository: clerk/javascript

Length of output: 1441


🏁 Script executed:

#!/bin/bashset -euo pipefail
sed -n '40,100p' packages/backend/src/util/decorateObjectWithResources.ts | cat -n

Repository: 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.

// Delete sensitive private metadata from resource before rendering in SSR
if (resource) {
if ('privateMetadata' in resource) {
Expand All@@ -61,7 +61,38 @@ function prunePrivateMetadata(resource?: { private_metadata: any } | { privateMe
if ('private_metadata' in resource) {
delete resource['private_metadata'];
}
// Backend resources (`User`, `Organization`) retain the full Backend API
// payload on the enumerable `_raw` property, which still contains
// `private_metadata`. The payload is also nested (e.g. a `User`'s
// `organization_memberships[*]` each carry their own `private_metadata`
// and a nested `organization.private_metadata`), so redact recursively on
// a deep clone — leaving the original resource (and its `raw` getter)
// untouched.
if ('_raw' in resource && resource['_raw']) {
resource['_raw'] = redactPrivateMetadataDeep(resource['_raw']);
}
}

return resource;
}

/**
* Returns a deep clone of `value` with every `private_metadata` / `privateMetadata`
* property removed at any depth.
*/
function redactPrivateMetadataDeep(value: any): any {
if (Array.isArray(value)) {
return value.map(redactPrivateMetadataDeep);
}
if (value && typeof value === 'object') {
const clone: Record<string, any> = {};
for (const key of Object.keys(value)) {
if (key === 'private_metadata' || key === 'privateMetadata') {
continue;
}
clone[key] = redactPrivateMetadataDeep(value[key]);
}
return clone;
}
return value;
}
Loading