test(backend): Add `authenticateRequest` return type tests #6096

wobsoriano · 2025-06-10T04:10:10Z

Description

Adds authenticateRequest() return type tests
Prefer expectTypeOf for expressive property type checks and assertType for negative assertions.

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 type assertion methods in existing tests for improved clarity and accuracy.
- Added new tests to verify TypeScript return types for authentication-related functions.
Chores
- Added an empty changeset file for release tracking.

changeset-bot · 2025-06-10T04:10:14Z

🦋 Changeset detected

Latest commit: 9f31379

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-10T04:10:14Z

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 4:41am

coderabbitai · 2025-06-10T04:10:17Z

📝 Walkthrough

Walkthrough

A new empty changeset file was added. In the backend tokens test suite, type assertion checks for getAuth were updated to use expectTypeOf instead of assertType. Additionally, a new test file was introduced to verify the TypeScript return types of the authenticateRequest function for various token scenarios.

Changes

Files/Groups	Change Summary
.changeset/great-windows-collect.md	Added an empty changeset file with only YAML front matter delimiters.
packages/backend/src/tokens/tests/getAuth.test-d.ts	Updated type assertions: replaced `assertType` with `expectTypeOf` and `toMatchTypeOf`; replaced `@ts-expect-error` with explicit type checks.
packages/backend/src/tokens/tests/request.test-d.ts	Added new test file to assert TypeScript return types of `authenticateRequest` for various `acceptsToken` options.

📜 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 42182f9 and 9f31379.

📒 Files selected for processing (1)

packages/backend/src/tokens/__tests__/request.test-d.ts (1 hunks)

✅ Files skipped from review due to trivial changes (1)

packages/backend/src/tokens/tests/request.test-d.ts

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

GitHub Check: semgrep-cloud-platform/scan
GitHub Check: Formatting | Dedupe | Changeset
GitHub Check: Build Packages
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-10T04:15:33Z

Open in StackBlitz

@clerk/agent-toolkit

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

@clerk/astro

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

@clerk/backend

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

@clerk/chrome-extension

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

@clerk/clerk-js

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

@clerk/dev-cli

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

@clerk/elements

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

@clerk/clerk-expo

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

@clerk/expo-passkeys

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

@clerk/express

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

@clerk/fastify

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

@clerk/localizations

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

@clerk/nextjs

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

@clerk/nuxt

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

@clerk/clerk-react

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

@clerk/react-router

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

@clerk/remix

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

@clerk/shared

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

@clerk/tanstack-react-start

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

@clerk/testing

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

@clerk/themes

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

@clerk/types

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

@clerk/upgrade

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

@clerk/vue

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

commit: 9f31379

coderabbitai

Actionable comments posted: 2

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 06df74d and 5b7d8d5.

📒 Files selected for processing (3)

.changeset/great-windows-collect.md (1 hunks)
packages/backend/src/tokens/__tests__/getAuth.test-d.ts (3 hunks)
packages/backend/src/tokens/types.ts (1 hunks)

🧰 Additional context used

🧬 Code Graph Analysis (1)

packages/backend/src/tokens/types.ts (3)

packages/nextjs/src/app-router/server/auth.ts (1)

AuthOptions (49-49)

packages/types/src/session.ts (1)

PendingSessionOptions (34-40)

packages/backend/src/internal.ts (1)

AuthenticateRequestOptions (11-11)

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

GitHub Check: Integration Tests (nextjs, chrome, 15)
GitHub Check: Integration Tests (nextjs, chrome, 14)
GitHub Check: Integration Tests (tanstack-react-start, chrome)
GitHub Check: Integration Tests (expo-web, chrome)
GitHub Check: Integration Tests (billing, chrome)
GitHub Check: Integration Tests (astro, chrome)
GitHub Check: Integration Tests (quickstart, chrome)
GitHub Check: Integration Tests (localhost, chrome)
GitHub Check: Integration Tests (nextjs, chrome, 13)
GitHub Check: Integration Tests (tanstack-react-router, chrome)
GitHub Check: Integration Tests (nuxt, chrome)
GitHub Check: Integration Tests (vue, chrome)
GitHub Check: Integration Tests (elements, chrome)
GitHub Check: Integration Tests (ap-flows, chrome)
GitHub Check: Integration Tests (react-router, chrome)
GitHub Check: Integration Tests (express, chrome)
GitHub Check: Integration Tests (sessions, chrome)
GitHub Check: Integration Tests (generic, chrome)
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: Publish with pkg-pr-new
GitHub Check: semgrep-cloud-platform/scan
GitHub Check: Formatting | Dedupe | Changeset
GitHub Check: semgrep/ci
GitHub Check: Analyze (javascript-typescript)

🔇 Additional comments (5)

.changeset/great-windows-collect.md (1)

1-2: Empty changeset file follows standard conventions.

This empty changeset file is correctly formatted for tracking changes in the monorepo.

packages/backend/src/tokens/__tests__/getAuth.test-d.ts (4)

15-32: Excellent use of expectTypeOf for positive type assertions.

The switch from assertType to expectTypeOf().toMatchTypeOf() provides more expressive and clear type checking for positive assertions.

40-59: Improved property type assertions.

The use of expectTypeOf().toMatchTypeOf() for checking property types is more descriptive and follows the PR objectives correctly.

63-65: Appropriate use of assertType for negative assertions.

Using assertType with @ts-expect-error for properties that should NOT exist follows the PR objective of reserving assertType for negative assertions only.

75-105: Consistent assertion pattern in discriminated union tests.

The combination of expectTypeOf().toMatchTypeOf() for positive assertions and assertType with @ts-expect-error for negative assertions is correctly applied throughout the discriminated union tests.

packages/backend/src/tokens/types.ts

packages/backend/src/tokens/__tests__/getAuth.test-d.ts

wobsoriano · 2025-06-10T20:25:39Z

!snapshot

clerk-cookie · 2025-06-10T20:28:07Z

Hey @wobsoriano - the snapshot version command generated the following package versions:

Package	Version
@clerk/agent-toolkit	0.1.1-snapshot.v20250610202614
@clerk/astro	2.9.1-snapshot.v20250610202614
@clerk/backend	2.0.1-snapshot.v20250610202614
@clerk/chrome-extension	2.4.12-snapshot.v20250610202614
@clerk/clerk-js	5.68.1-snapshot.v20250610202614
@clerk/elements	0.23.33-snapshot.v20250610202614
@clerk/clerk-expo	2.13.1-snapshot.v20250610202614
@clerk/expo-passkeys	0.3.10-snapshot.v20250610202614
@clerk/express	1.7.0-snapshot.v20250610202614
@clerk/fastify	2.4.0-snapshot.v20250610202614
@clerk/localizations	3.16.5-snapshot.v20250610202614
@clerk/nextjs	6.21.1-snapshot.v20250610202614
@clerk/nuxt	1.7.1-snapshot.v20250610202614
@clerk/clerk-react	5.31.10-snapshot.v20250610202614
@clerk/react-router	1.6.0-snapshot.v20250610202614
@clerk/remix	4.8.1-snapshot.v20250610202614
@clerk/shared	3.9.7-snapshot.v20250610202614
@clerk/tanstack-react-start	0.17.0-snapshot.v20250610202614
@clerk/testing	1.8.1-snapshot.v20250610202614
@clerk/themes	2.2.50-snapshot.v20250610202614
@clerk/types	4.60.1-snapshot.v20250610202614
@clerk/vue	1.8.8-snapshot.v20250610202614

Tip: Use the snippet copy button below to quickly install the required packages.
@clerk/agent-toolkit

npm i @clerk/[email protected] --save-exact

@clerk/astro

npm i @clerk/[email protected] --save-exact

@clerk/backend

npm i @clerk/[email protected] --save-exact

@clerk/chrome-extension

npm i @clerk/[email protected] --save-exact

@clerk/clerk-js

npm i @clerk/[email protected] --save-exact

@clerk/elements

npm i @clerk/[email protected] --save-exact

@clerk/clerk-expo

npm i @clerk/[email protected] --save-exact

@clerk/expo-passkeys

npm i @clerk/[email protected] --save-exact

@clerk/express

npm i @clerk/[email protected] --save-exact

@clerk/fastify

npm i @clerk/[email protected] --save-exact

@clerk/localizations

npm i @clerk/[email protected] --save-exact

@clerk/nextjs

npm i @clerk/[email protected] --save-exact

@clerk/nuxt

npm i @clerk/[email protected] --save-exact

@clerk/clerk-react

npm i @clerk/[email protected] --save-exact

@clerk/react-router

npm i @clerk/[email protected] --save-exact

@clerk/remix

npm i @clerk/[email protected] --save-exact

@clerk/shared

npm i @clerk/[email protected] --save-exact

@clerk/tanstack-react-start

npm i @clerk/[email protected] --save-exact

@clerk/testing

npm i @clerk/[email protected] --save-exact

@clerk/themes

npm i @clerk/[email protected] --save-exact

@clerk/types

npm i @clerk/[email protected] --save-exact

@clerk/vue

npm i @clerk/[email protected] --save-exact

test: use assertType for negative assertions only

d2c8573

wobsoriano changed the title ~~repo(backend): use assertType for negative assertions only~~ test(backend): use assertType for negative assertions only Jun 10, 2025

clerk-cookie added the backend label Jun 10, 2025

wobsoriano changed the title ~~test(backend): use assertType for negative assertions only~~ test(backend): Use assertType for negative assertions only Jun 10, 2025

chore: add empty changeset

5b7d8d5

vercel bot deployed to Preview June 10, 2025 04:13 View deployment

coderabbitai bot reviewed Jun 10, 2025

View reviewed changes

packages/backend/src/tokens/types.ts Outdated Show resolved Hide resolved

packages/backend/src/tokens/__tests__/getAuth.test-d.ts Outdated Show resolved Hide resolved

test: add authenticateRequest type tests

256deaa

wobsoriano changed the title ~~test(backend): Use assertType for negative assertions only~~ test(backend): Add authenticateRequest return type tests Jun 10, 2025

vercel bot deployed to Preview June 10, 2025 04:31 View deployment

wobsoriano added 2 commits June 9, 2025 21:32

chore: add missing import

19f0f02

chore: revert exported type

42182f9

vercel bot deployed to Preview June 10, 2025 04:34 View deployment

chore: move type test to d.ts file

9f31379

vercel bot deployed to Preview June 10, 2025 04:41 View deployment

panteliselef approved these changes Jun 10, 2025

View reviewed changes

wobsoriano merged commit 2fe813f into main Jun 10, 2025
39 checks passed

wobsoriano deleted the rob/get-auth-type-improvement branch June 10, 2025 08:45

jacekradko pushed a commit that referenced this pull request Jun 10, 2025

test(backend): Add authenticateRequest return type tests (#6096)

0c12da3

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

test(backend): Add `authenticateRequest` return type tests #6096

test(backend): Add `authenticateRequest` return type tests #6096

Uh oh!

wobsoriano 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!

coderabbitai bot left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

wobsoriano commented Jun 10, 2025

Uh oh!

clerk-cookie commented Jun 10, 2025

Uh oh!

Uh oh!

test(backend): Add authenticateRequest return type tests #6096

test(backend): Add authenticateRequest return type tests #6096

Uh oh!

Conversation

wobsoriano 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

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!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

wobsoriano commented Jun 10, 2025

Uh oh!

clerk-cookie commented Jun 10, 2025

Uh oh!

Uh oh!

test(backend): Add `authenticateRequest` return type tests #6096

test(backend): Add `authenticateRequest` return type tests #6096

wobsoriano 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