chore(clerk-js): Refactor snapshot tests #6094

jacekradko · 2025-06-10T02:32:16Z

Description

Updating tests to use .toMatchObject instead of full snapshot comparisons for entire objects. This change improves test clarity and resilience by focusing assertions on only the relevant parts of the object being tested.

Snapshot tests often capture unnecessary details, leading to noisy diffs and fragile tests when object structures change in unrelated ways. By switching to .toMatchObject, we ensure the tests remain meaningful and maintainable, asserting only what’s essential to the behavior under test.

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

Tests
- Updated test assertions across multiple areas to use explicit property and structure checks instead of snapshot-based comparisons, resulting in clearer and more precise test validations.
Chores
- Added an empty changeset file for tracking future changes.

changeset-bot · 2025-06-10T02:32:21Z

🦋 Changeset detected

Latest commit: 53e504b

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

This PR includes changesets to release 0 packages

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

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-06-10T02:32:21Z

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
clerk-js-sandbox	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Jun 10, 2025 2:47am

coderabbitai · 2025-06-10T02:32:24Z

📝 Walkthrough

Walkthrough

This change replaces all snapshot-based test assertions in resource-related test files with explicit, structured assertions. The updated tests now verify object shapes, property values, and types directly using toMatchObject, toEqual, or similar matchers. No exported or public entity declarations were modified; changes are confined to test assertion logic.

Changes

Files (grouped)	Change Summary
`.../__tests__/Client.test.ts`, `.../__tests__/Environment.test.ts`, `.../__tests__/Organization.test.ts`, `.../__tests__/OrganizationDomain.test.ts`, `.../__tests__/OrganizationInvitation.test.ts`, `.../__tests__/OrganizationMembership.test.ts`, `.../__tests__/OrganizationMembershipRequest.test.ts`, `.../__tests__/OrganizationSuggestion.test.ts`, `.../__tests__/PublicUserData.test.ts`, `.../__tests__/Session.test.ts`, `.../__tests__/UserSettings.test.ts`, `.../__tests__/Waitlist.test.ts`	Replaced all `toMatchSnapshot()` assertions with explicit object structure and value checks using `toMatchObject`, `toEqual`, or similar matchers. Assertions now verify key properties, types, and nested structures directly, removing reliance on Jest snapshots. Fixed a variable naming typo in one test. No changes to exported or public API signatures.
`.changeset/gentle-crews-warn.md`	Added an empty changeset file containing only YAML front matter delimiters without content or metadata.

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between b5e9683 and 53e504b.

📒 Files selected for processing (1)

packages/clerk-js/src/core/resources/__tests__/PublicUserData.test.ts (1 hunks)

🚧 Files skipped from review as they are similar to previous changes (1)

packages/clerk-js/src/core/resources/tests/PublicUserData.test.ts

⏰ Context from checks skipped due to timeout of 90000ms (12)

GitHub Check: Integration Tests (astro, chrome)
GitHub Check: Integration Tests (tanstack-react-start, chrome)
GitHub Check: Integration Tests (express, chrome)
GitHub Check: Integration Tests (localhost, chrome)
GitHub Check: Publish with pkg-pr-new
GitHub Check: Unit Tests (22, **)
GitHub Check: Unit Tests (18, --filter=@clerk/astro --filter=@clerk/backend --filter=@clerk/express --filter=@c...
GitHub Check: Static analysis
GitHub Check: semgrep-cloud-platform/scan
GitHub Check: Formatting | Dedupe | Changeset
GitHub Check: semgrep/ci
GitHub Check: Analyze (javascript-typescript)

✨ Finishing Touches

📝 Generate Docstrings

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>, please review it.
- Explain this complex logic.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai explain this code block.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
- @coderabbitai read src/utils.ts and explain its main purpose.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai generate docstrings to generate docstrings for this PR.
@coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Other keywords and placeholders

Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

pkg-pr-new · 2025-06-10T02:35:04Z

Open in StackBlitz

@clerk/agent-toolkit

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

@clerk/astro

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

@clerk/backend

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

@clerk/chrome-extension

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

@clerk/clerk-js

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

@clerk/dev-cli

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

@clerk/elements

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

@clerk/clerk-expo

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

@clerk/expo-passkeys

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

@clerk/express

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

@clerk/fastify

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

@clerk/localizations

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

@clerk/nextjs

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

@clerk/nuxt

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

@clerk/clerk-react

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

@clerk/react-router

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

@clerk/remix

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

@clerk/shared

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

@clerk/tanstack-react-start

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

@clerk/testing

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

@clerk/themes

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

@clerk/types

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

@clerk/upgrade

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

@clerk/vue

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

commit: 53e504b

Copilot

Pull Request Overview

This PR replaces brittle full-object Jest snapshots with targeted object matching assertions for clearer, more resilient tests.

Removed generated snapshot files under __snapshots__
Updated individual tests to use toMatchObject/toEqual with explicit property checks
Introduced an (empty) changeset file for future release tracking

Reviewed Changes

Copilot reviewed 25 out of 25 changed files in this pull request and generated 1 comment.

Show a summary per file

File	Description
packages/clerk-js/src/core/resources/tests/snapshots/PublicUserData.test.ts.snap	Removed full snapshot export
packages/clerk-js/src/core/resources/tests/snapshots/OrganizationSuggestion.test.ts.snap	Removed full snapshot export
packages/clerk-js/src/core/resources/tests/snapshots/OrganizationMembershipRequest.test.ts.snap	Removed full snapshot export
packages/clerk-js/src/core/resources/tests/snapshots/OrganizationMembership.test.ts.snap	Removed full snapshot export
packages/clerk-js/src/core/resources/tests/snapshots/OrganizationInvitation.test.ts.snap	Removed full snapshot export
packages/clerk-js/src/core/resources/tests/snapshots/OrganizationDomain.test.ts.snap	Removed full snapshot export
packages/clerk-js/src/core/resources/tests/snapshots/Organization.test.ts.snap	Removed full snapshot export
packages/clerk-js/src/core/resources/tests/Waitlist.test.ts	Switched from `toMatchSnapshot` to `toMatchObject`
packages/clerk-js/src/core/resources/tests/UserSettings.test.ts	Switched from `toMatchSnapshot` to `toMatchObject`
packages/clerk-js/src/core/resources/tests/Session.test.ts	Switched from `toMatchSnapshot` to `toEqual`
packages/clerk-js/src/core/resources/tests/PublicUserData.test.ts	Switched from string snapshot to `toEqual`
packages/clerk-js/src/core/resources/tests/OrganizationSuggestion.test.ts	Switched from `toMatchSnapshot` to `toMatchObject`
packages/clerk-js/src/core/resources/tests/OrganizationMembershipRequest.test.ts	Switched from `toMatchSnapshot` to `toMatchObject`
packages/clerk-js/src/core/resources/tests/OrganizationMembership.test.ts	Switched from `toMatchSnapshot` to `toMatchObject`
packages/clerk-js/src/core/resources/tests/OrganizationInvitation.test.ts	Switched from `toMatchSnapshot` to `toMatchObject`
packages/clerk-js/src/core/resources/tests/OrganizationDomain.test.ts	Switched from `toMatchSnapshot` to `toMatchObject`
packages/clerk-js/src/core/resources/tests/Organization.test.ts	Switched from `toMatchSnapshot` to `toMatchObject`
packages/clerk-js/src/core/resources/tests/Environment.test.ts	Switched from `toMatchSnapshot` to `toMatchObject`
packages/clerk-js/src/core/resources/tests/Client.test.ts	Switched from `toMatchSnapshot` to `toMatchObject`
.changeset/gentle-crews-warn.md	Added empty changeset file

Comments suppressed due to low confidence (2)

.changeset/gentle-crews-warn.md:1

The changeset file is empty; please add a summary of the refactoring changes to ensure proper release notes generation.

+---

packages/clerk-js/src/core/resources/tests/Session.test.ts:50

The test asserts only the first dispatch call; consider adding an assertion for dispatchSpy.mock.calls[1] to maintain coverage of both emitted events.

expect(dispatchSpy.mock.calls[0]).toEqual([

packages/clerk-js/src/core/resources/__tests__/PublicUserData.test.ts

…test.ts Co-authored-by: Copilot <[email protected]>

wobsoriano

🧹

chore(clerk-js): Refactor snapshot tests

244c5be

clerk-cookie added the clerk-js label Jun 10, 2025

chore: empty changeset

b5e9683

vercel bot deployed to Preview June 10, 2025 02:36 View deployment

jacekradko requested a review from Copilot June 10, 2025 02:41

Copilot AI reviewed Jun 10, 2025

View reviewed changes

packages/clerk-js/src/core/resources/__tests__/PublicUserData.test.ts Outdated Show resolved Hide resolved

Update packages/clerk-js/src/core/resources/__tests__/PublicUserData.…

53e504b

…test.ts Co-authored-by: Copilot <[email protected]>

vercel bot deployed to Preview June 10, 2025 02:47 View deployment

tmilewski approved these changes Jun 10, 2025

View reviewed changes

wobsoriano approved these changes Jun 10, 2025

View reviewed changes

jacekradko merged commit a5d86bf into main Jun 11, 2025
39 checks passed

jacekradko deleted the jr.chore/refactor-snapshot-tests branch June 11, 2025 02:37

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

chore(clerk-js): Refactor snapshot tests #6094

chore(clerk-js): Refactor snapshot tests #6094

Uh oh!

jacekradko commented Jun 10, 2025 •

edited by coderabbitai bot

Loading

Uh oh!

changeset-bot bot commented Jun 10, 2025 •

edited

Loading

Uh oh!

vercel bot commented Jun 10, 2025 •

edited

Loading

Uh oh!

coderabbitai bot commented Jun 10, 2025 •

edited

Loading

Walkthrough

Changes

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

Uh oh!

pkg-pr-new bot commented Jun 10, 2025 •

edited

Loading

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

wobsoriano left a comment

Uh oh!

Uh oh!

Uh oh!

chore(clerk-js): Refactor snapshot tests #6094

chore(clerk-js): Refactor snapshot tests #6094

Uh oh!

Conversation

jacekradko commented Jun 10, 2025 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Checklist

Type of change

Summary by CodeRabbit

Summary by CodeRabbit

Uh oh!

changeset-bot bot commented Jun 10, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🦋 Changeset detected

Uh oh!

vercel bot commented Jun 10, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

coderabbitai bot commented Jun 10, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

pkg-pr-new bot commented Jun 10, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Uh oh!

wobsoriano left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

jacekradko commented Jun 10, 2025 •

edited by coderabbitai bot

Loading

changeset-bot bot commented Jun 10, 2025 •

edited

Loading

vercel bot commented Jun 10, 2025 •

edited

Loading

coderabbitai bot commented Jun 10, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)

pkg-pr-new bot commented Jun 10, 2025 •

edited

Loading