fix(clerk-js): Mark SignIn/SignUpFuture resource properties as private #7321

dstaley · 2025-11-26T16:17:54Z

Description

This PR fixes an issue where SignIn and SignUp instances were unable to be serialized with JSON.stringify due to a circular reference between themselves and their Future classes. The issue was resolved by marking resource as a private field, which excludes it from serialization.

Checklist

pnpm test runs as expected.
pnpm build runs as expected.
(If applicable) JSDoc comments have been added or updated for any package exports
(If applicable) Documentation has been updated

Type of change

Summary by CodeRabbit

Bug Fixes

Fixed a circular reference that prevented SignIn and SignUp instances from being serialized with JSON.stringify. These objects can now be properly serialized for caching, storage, transmission, or logging purposes.

_{✏️ Tip: You can customize this high-level summary in your review settings.}

changeset-bot · 2025-11-26T16:17:59Z

🦋 Changeset detected

Latest commit: 2b6d58c

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 3 packages

Name	Type
@clerk/clerk-js	Patch
@clerk/chrome-extension	Patch
@clerk/clerk-expo	Patch

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

vercel · 2025-11-26T16:18:01Z

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

Project	Deployment	Preview	Comments	Updated (UTC)
clerk-js-sandbox	Ready	Preview	Comment	Nov 26, 2025 4:18pm

coderabbitai · 2025-11-26T16:18:07Z

Walkthrough

This PR fixes a JSON serialization issue in @clerk/clerk-js by converting public resource fields in SignInFuture and SignUpFuture classes to private fields, eliminating circular references that prevented JSON.stringify() from working. Serialization tests are added to verify the fix.

Changes

Cohort / File(s)	Summary
Changeset `.changeset/dark-sides-beg.md`	Adds patch release note documenting fix for JSON serialization of SignIn and SignUp instances due to circular reference.
Core Resource Refactoring `packages/clerk-js/src/core/resources/SignIn.ts`, `packages/clerk-js/src/core/resources/SignUp.ts`	Converts public `resource` field to private field `#resource` in `SignInFuture` and `SignUpFuture` classes respectively. Updates all internal references to use the private field. Constructor parameter in `SignUpFuture` no longer exposed as readonly public field.
Serialization Tests `packages/clerk-js/src/core/resources/__tests__/SignIn.test.ts`, `packages/clerk-js/src/core/resources/__tests__/SignUp.test.ts`	Adds tests verifying `JSON.stringify()` successfully serializes `SignIn`, `SignInFuture`, `SignUp`, and `SignUpFuture` instances.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

Homogeneous refactoring pattern applied consistently across two similar classes
Field visibility changes are straightforward with mechanical updates to all references
New tests are simple snapshot/defined assertions with no complex logic
Primary attention: verify all this.resource references were correctly converted to this.#resource in both files

Poem

🐰 A circular loop once broke the code,
Round and round the data flowed.
Private fields mend the way,
Now JSON strings will work today!
*hops excitedly* 🎉

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title accurately describes the main change: marking SignIn/SignUpFuture resource properties as private to fix JSON serialization issues caused by circular references.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✨ Finishing touches

📝 Generate docstrings

🧪 Generate unit tests (beta)

Create PR with unit tests
Post copyable unit tests in a comment
Commit unit tests in branch ds.fix/private-resource-future

Tip

📝 Customizable high-level summaries are now available in beta!

You can now customize how CodeRabbit generates the high-level summary in your pull requests — including its content, structure, tone, and formatting.

Provide your own instructions using the high_level_summary_instructions setting.
Format the summary however you like (bullet lists, tables, multi-section layouts, contributor stats, etc.).
Use high_level_summary_in_walkthrough to move the summary from the description to the walkthrough section.

Example instruction:

"Divide the high-level summary into five sections:

📝 Description — Summarize the main change in 50–60 words, explaining what was done.

📓 References — List relevant issues, discussions, documentation, or related PRs.

📦 Dependencies & Requirements — Mention any new/updated dependencies, environment variable changes, or configuration updates.

📊 Contributor Summary — Include a Markdown table showing contributions:
| Contributor | Lines Added | Lines Removed | Files Changed |

✔️ Additional Notes — Add any extra reviewer context.
Keep each section concise (under 200 words) and use bullet or numbered lists for clarity."

Note: This feature is currently in beta for Pro-tier users, and pricing will be announced later.

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

pkg-pr-new · 2025-11-26T16:21:07Z

Open in StackBlitz

@clerk/agent-toolkit

npm i https://pkg.pr.new/@clerk/agent-toolkit@7321

@clerk/astro

npm i https://pkg.pr.new/@clerk/astro@7321

@clerk/backend

npm i https://pkg.pr.new/@clerk/backend@7321

@clerk/chrome-extension

npm i https://pkg.pr.new/@clerk/chrome-extension@7321

@clerk/clerk-js

npm i https://pkg.pr.new/@clerk/clerk-js@7321

@clerk/dev-cli

npm i https://pkg.pr.new/@clerk/dev-cli@7321

@clerk/elements

npm i https://pkg.pr.new/@clerk/elements@7321

@clerk/clerk-expo

npm i https://pkg.pr.new/@clerk/clerk-expo@7321

@clerk/expo-passkeys

npm i https://pkg.pr.new/@clerk/expo-passkeys@7321

@clerk/express

npm i https://pkg.pr.new/@clerk/express@7321

@clerk/fastify

npm i https://pkg.pr.new/@clerk/fastify@7321

@clerk/localizations

npm i https://pkg.pr.new/@clerk/localizations@7321

@clerk/nextjs

npm i https://pkg.pr.new/@clerk/nextjs@7321

@clerk/nuxt

npm i https://pkg.pr.new/@clerk/nuxt@7321

@clerk/clerk-react

npm i https://pkg.pr.new/@clerk/clerk-react@7321

@clerk/react-router

npm i https://pkg.pr.new/@clerk/react-router@7321

@clerk/remix

npm i https://pkg.pr.new/@clerk/remix@7321

@clerk/shared

npm i https://pkg.pr.new/@clerk/shared@7321

@clerk/tanstack-react-start

npm i https://pkg.pr.new/@clerk/tanstack-react-start@7321

@clerk/testing

npm i https://pkg.pr.new/@clerk/testing@7321

@clerk/themes

npm i https://pkg.pr.new/@clerk/themes@7321

@clerk/types

npm i https://pkg.pr.new/@clerk/types@7321

@clerk/upgrade

npm i https://pkg.pr.new/@clerk/upgrade@7321

@clerk/vue

npm i https://pkg.pr.new/@clerk/vue@7321

commit: 2b6d58c

coderabbitai

Actionable comments posted: 0

🧹 Nitpick comments (3)

packages/clerk-js/src/core/resources/__tests__/SignIn.test.ts (2)
19-23: Consider enhancing the serialization test.

The test successfully verifies that JSON.stringify doesn't throw an error (which would occur with circular references). However, it could be more robust by also validating that the serialized output contains expected properties.

Optional enhancement:
 it('can be serialized with JSON.stringify', () => {
   const signIn = new SignIn();
   const snapshot = JSON.stringify(signIn);
   expect(snapshot).toBeDefined();
+  const parsed = JSON.parse(snapshot);
+  expect(parsed).toBeTypeOf('object');
 });
80-84: Consider enhancing the SignInFuture serialization test.

Similar to the SignIn test, this could be enhanced to validate the JSON structure.

Optional enhancement:
 it('can be serialized with JSON.stringify', () => {
   const signIn = new SignIn();
   const snapshot = JSON.stringify(signIn.__internal_future);
   expect(snapshot).toBeDefined();
+  const parsed = JSON.parse(snapshot);
+  expect(parsed).toBeTypeOf('object');
 });
packages/clerk-js/src/core/resources/__tests__/SignUp.test.ts (1)
29-40: LGTM! Serialization tests provide good coverage.

The tests verify that both SignUp and SignUpFuture can be serialized without circular reference errors. The test structure is consistent with the SignIn tests.

Optional enhancement (similar to SignIn tests):
 it('can be serialized with JSON.stringify', () => {
   const signUp = new SignUp();
   const snapshot = JSON.stringify(signUp);
   expect(snapshot).toBeDefined();
+  const parsed = JSON.parse(snapshot);
+  expect(parsed).toBeTypeOf('object');
 });

📜 Review details

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Disabled knowledge base sources:

Linear integration is disabled by default for public repositories

You can enable these sources in your CodeRabbit configuration.

📥 Commits

Reviewing files that changed from the base of the PR and between ef7b024 and 2b6d58c.

📒 Files selected for processing (5)

.changeset/dark-sides-beg.md (1 hunks)
packages/clerk-js/src/core/resources/SignIn.ts (32 hunks)
packages/clerk-js/src/core/resources/SignUp.ts (13 hunks)
packages/clerk-js/src/core/resources/__tests__/SignIn.test.ts (2 hunks)
packages/clerk-js/src/core/resources/__tests__/SignUp.test.ts (1 hunks)

🧰 Additional context used

📓 Path-based instructions (9)

**/*.{js,jsx,ts,tsx}