Skip to content

feat(backend): Set cookies from the refresh token flow#4884

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
brkalow merged 5 commits into from
Jan 15, 2025
Merged

feat(backend): Set cookies from the refresh token flow #4884

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
2e9888f
Set cookies from the refresh token flow
brkalow Jan 13, 2025
9bd2134
Use proper format values, and pass in body instead of query parmeter
brkalow Jan 13, 2025
1f755ae
Adds missing file
brkalow Jan 13, 2025
19d2ada
Adds changeset
brkalow Jan 14, 2025
3998837
Update packages/backend/src/api/endpoints/SessionApi.ts
brkalow Jan 15, 2025
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/good-eggs-retire.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/backend': minor
---

`authenticateRequest()` will now set a refreshsed session cookie on the response when an expired session token is refreshed via the Clerk API.
14 changes: 11 additions & 3 deletions packages/backend/src/api/endpoints/SessionApi.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
import type { ClerkPaginationRequest, SessionStatus } from '@clerk/types';

import { joinPaths } from '../../util/path';
import type { Cookies } from '../resources/Cookies';
import type { PaginatedResourceResponse } from '../resources/Deserializer';
import type { Session } from '../resources/Session';
import type { Token } from '../resources/Token';
Expand All@@ -20,6 +21,8 @@ type RefreshTokenParams = {
request_origin: string;
request_originating_ip?: string;
request_headers?: Record<string, string[]>;
suffixed_cookies?: boolean;
format?: 'token' | 'cookie';
};

export class SessionAPI extends AbstractAPI {
Expand DownExpand Up@@ -64,12 +67,17 @@ export class SessionAPI extends AbstractAPI {
});
}

public async refreshSession(sessionId: string, params: RefreshTokenParams) {
public async refreshSession(sessionId: string, params: RefreshTokenParams & { format: 'token' }): Promise<Token>;
public async refreshSession(sessionId: string, params: RefreshTokenParams & { format: 'cookie' }): Promise<Cookies>;
public async refreshSession(sessionId: string, params: RefreshTokenParams): Promise<Token>;
public async refreshSession(sessionId: string, params: RefreshTokenParams): Promise<Token | Cookies> {
this.requireId(sessionId);
return this.request<Token>({
const { suffixed_cookies, ...restParams } = params;
return this.request({
method: 'POST',
path: joinPaths(basePath, sessionId, 'refresh'),
bodyParams: params,
bodyParams: restParams,
queryParams: { suffixed_cookies },
});
}
}
9 changes: 9 additions & 0 deletions packages/backend/src/api/resources/Cookies.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
import type { CookiesJSON } from './JSON';

export class Cookies {
constructor(readonly cookies: string[]) {}

static fromJSON(data: CookiesJSON): Cookies {
return new Cookies(data.cookies);
}
}
3 changes: 3 additions & 0 deletions packages/backend/src/api/resources/Deserializer.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
import {
AllowlistIdentifier,
Client,
Cookies,
DeletedObject,
Email,
EmailAddress,
Expand DownExpand Up@@ -72,6 +73,8 @@ function jsonToObject(item: any): any {
return AllowlistIdentifier.fromJSON(item);
case ObjectType.Client:
return Client.fromJSON(item);
case ObjectType.Cookies:
return Cookies.fromJSON(item);
case ObjectType.EmailAddress:
return EmailAddress.fromJSON(item);
case ObjectType.Email:
Expand Down
6 changes: 6 additions & 0 deletions packages/backend/src/api/resources/JSON.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -10,6 +10,7 @@ export const ObjectType = {
AccountlessApplication: 'accountless_application',
AllowlistIdentifier: 'allowlist_identifier',
Client: 'client',
Cookies: 'cookies',
Email: 'email',
EmailAddress: 'email_address',
ExternalAccount: 'external_account',
Expand DownExpand Up@@ -44,6 +45,11 @@ export interface ClerkResourceJSON {
id: string;
}

export interface CookiesJSON {
object: typeof ObjectType.Cookies;
cookies: string[];
}

export interface TokenJSON {
object: typeof ObjectType.Token;
jwt: string;
Expand Down
1 change: 1 addition & 0 deletions packages/backend/src/api/resources/index.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
export * from './AccountlessApplication';
export * from './AllowlistIdentifier';
export * from './Client';
export * from './Cookies';
export * from './DeletedObject';
export * from './Email';
export * from './EmailAddress';
Expand Down
252 changes: 130 additions & 122 deletions packages/backend/src/tokens/__tests__/request.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -972,130 +972,138 @@ describe('tokens.authenticateRequest(options)', () => {
expect(requestState.toAuth()).toBeSignedInToAuth();
});

test('refreshToken: returns signed in with valid refresh token cookie if token is expired and refresh token exists', async () => {
server.use(
http.get('https://api.clerk.test/v1/jwks', () => {
return HttpResponse.json(mockJwks);
}),
);

// return cookies from endpoint
const refreshSession = vi.fn(() => ({
object: 'token',
jwt: mockJwt,
}));

const requestState = await authenticateRequest(
mockRequestWithCookies(
{
...defaultHeaders,
origin: 'https://example.com',
},
{ __client_uat: `12345`, __session: mockExpiredJwt, __refresh_MqCvchyS: 'can_be_anything' },
),
mockOptions({
secretKey: 'test_deadbeef',
publishableKey: PK_LIVE,
apiClient: { sessions: { refreshSession } },
}),
);

expect(requestState).toBeSignedIn();
expect(requestState.toAuth()).toBeSignedInToAuth();
expect(refreshSession).toHaveBeenCalled();
});

test('refreshToken: does not try to refresh if refresh token does not exist', async () => {
server.use(
http.get('https://api.clerk.test/v1/jwks', () => {
return HttpResponse.json(mockJwks);
}),
);

// return cookies from endpoint
const refreshSession = vi.fn(() => ({
object: 'token',
jwt: mockJwt,
}));

await authenticateRequest(
mockRequestWithCookies(
{
...defaultHeaders,
origin: 'https://example.com',
},
{ __client_uat: `12345`, __session: mockExpiredJwt },
),
mockOptions({
secretKey: 'test_deadbeef',
publishableKey: PK_LIVE,
apiClient: { sessions: { refreshSession } },
}),
);
expect(refreshSession).not.toHaveBeenCalled();
});

test('refreshToken: does not try to refresh if refresh exists but token is not expired', async () => {
// return cookies from endpoint
const refreshSession = vi.fn(() => ({
object: 'token',
jwt: mockJwt,
}));

await authenticateRequest(
mockRequestWithCookies(
{
...defaultHeaders,
origin: 'https://example.com',
},
// client_uat is missing, need to handshake not to refresh
{ __session: mockJwt, __refresh_MqCvchyS: 'can_be_anything' },
),
mockOptions({
secretKey: 'test_deadbeef',
publishableKey: PK_LIVE,
apiClient: { sessions: { refreshSession } },
}),
);

expect(refreshSession).not.toHaveBeenCalled();
});

test('refreshToken: uses suffixed refresh cookie even if un-suffixed is present', async () => {
server.use(
http.get('https://api.clerk.test/v1/jwks', () => {
return HttpResponse.json(mockJwks);
}),
);
describe('refreshToken', async () => {

@brkalowbrkalowJan 14, 2025

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

I moved these tests into a separate describe block, consider looking at the diff without whitespace to see the actual changes: https://github.com/clerk/javascript/pull/4884/files?w=1

test('returns signed in with valid refresh token cookie if token is expired and refresh token exists', async () => {
server.use(
http.get('https://api.clerk.test/v1/jwks', () => {
return HttpResponse.json(mockJwks);
}),
);

// return cookies from endpoint
const refreshSession = vi.fn(() => ({
object: 'cookies',
cookies: [`__session_MqCvchyS=${mockJwt}; Path=/; Secure; SameSite=Lax`],
}));

const requestState = await authenticateRequest(
mockRequestWithCookies(
{
...defaultHeaders,
origin: 'https://example.com',
},
{ __client_uat: `12345`, __session: mockExpiredJwt, __refresh_MqCvchyS: 'can_be_anything' },
),
mockOptions({
secretKey: 'test_deadbeef',
publishableKey: PK_LIVE,
apiClient: { sessions: { refreshSession } },
}),
);

expect(requestState).toBeSignedIn();
expect(requestState.toAuth()).toBeSignedInToAuth();
expect(requestState.headers.getSetCookie()).toContain(
`__session_MqCvchyS=${mockJwt}; Path=/; Secure; SameSite=Lax`,
);
expect(refreshSession).toHaveBeenCalled();
});

// return cookies from endpoint
const refreshSession = vi.fn(() => ({
object: 'token',
jwt: mockJwt,
}));
test('does not try to refresh if refresh token does not exist', async () => {
server.use(
http.get('https://api.clerk.test/v1/jwks', () => {
return HttpResponse.json(mockJwks);
}),
);

// return cookies from endpoint
const refreshSession = vi.fn(() => ({
object: 'cookies',
cookies: [`__session_MqCvchyS=${mockJwt}; Path=/; Secure; SameSite=Lax`],
}));

await authenticateRequest(
mockRequestWithCookies(
{
...defaultHeaders,
origin: 'https://example.com',
},
{ __client_uat: `12345`, __session: mockExpiredJwt },
),
mockOptions({
secretKey: 'test_deadbeef',
publishableKey: PK_LIVE,
apiClient: { sessions: { refreshSession } },
}),
);
expect(refreshSession).not.toHaveBeenCalled();
});

const requestState = await authenticateRequest(
mockRequestWithCookies(
{
...defaultHeaders,
origin: 'https://example.com',
},
{
__client_uat: `12345`,
__session: mockExpiredJwt,
__refresh_MqCvchyS: 'can_be_anything',
__refresh: 'should_not_be_used',
},
),
mockOptions({
secretKey: 'test_deadbeef',
publishableKey: PK_LIVE,
apiClient: { sessions: { refreshSession } },
}),
);
test('does not try to refresh if refresh exists but token is not expired', async () => {
// return cookies from endpoint
const refreshSession = vi.fn(() => ({
object: 'cookies',
cookies: [`__session_MqCvchyS=${mockJwt}; Path=/; Secure; SameSite=Lax`],
}));

await authenticateRequest(
mockRequestWithCookies(
{
...defaultHeaders,
origin: 'https://example.com',
},
// client_uat is missing, need to handshake not to refresh
{ __session: mockJwt, __refresh_MqCvchyS: 'can_be_anything' },
),
mockOptions({
secretKey: 'test_deadbeef',
publishableKey: PK_LIVE,
apiClient: { sessions: { refreshSession } },
}),
);

expect(refreshSession).not.toHaveBeenCalled();
});

expect(requestState).toBeSignedIn();
expect(requestState.toAuth()).toBeSignedInToAuth();
expect(refreshSession).toHaveBeenCalled();
test('uses suffixed refresh cookie even if un-suffixed is present', async () => {
server.use(
http.get('https://api.clerk.test/v1/jwks', () => {
return HttpResponse.json(mockJwks);
}),
);

// return cookies from endpoint
const refreshSession = vi.fn(() => ({
object: 'cookies',
cookies: [`__session_MqCvchyS=${mockJwt}; Path=/; Secure; SameSite=Lax`],
}));

const requestState = await authenticateRequest(
mockRequestWithCookies(
{
...defaultHeaders,
origin: 'https://example.com',
},
{
__client_uat: `12345`,
__session: mockExpiredJwt,
__refresh_MqCvchyS: 'can_be_anything',
__refresh: 'should_not_be_used',
},
),
mockOptions({
secretKey: 'test_deadbeef',
publishableKey: PK_LIVE,
apiClient: { sessions: { refreshSession } },
}),
);

expect(requestState).toBeSignedIn();
expect(requestState.toAuth()).toBeSignedInToAuth();
expect(requestState.headers.getSetCookie()).toContain(
`__session_MqCvchyS=${mockJwt}; Path=/; Secure; SameSite=Lax`,
);
expect(refreshSession).toHaveBeenCalled();
});
});
});
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" + '
feat(backend): Set cookies from the refresh token flow by brkalow · Pull Request #4884 · clerk/javascript · GitHub
Skip to content
feat(backend): Set cookies from the refresh token flow#4884

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

brkalow
merged 5 commits into

from

Jan 15, 2025
 Merged


feat(backend): Set cookies from the refresh token flow
#4884
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


5 commits


Select commit
Hold shift + click to select a range
2e9888f

Set cookies from the refresh token flow


brkalow Jan 13, 2025
9bd2134

Use proper format values, and pass in body instead of query parmeter


brkalow Jan 13, 2025
1f755ae

Adds missing file


brkalow Jan 13, 2025
19d2ada

Adds changeset


brkalow Jan 14, 2025
3998837

Update packages/backend/src/api/endpoints/SessionApi.ts


brkalow Jan 15, 2025

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/good-eggs-retire.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/backend': minor
---

`authenticateRequest()` will now set a refreshsed session cookie on the response when an expired session token is refreshed via the Clerk API.

14 changes: 11 additions & 3 deletions
packages/backend/src/api/endpoints/SessionApi.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
import type { ClerkPaginationRequest, SessionStatus } from '@clerk/types';

import { joinPaths } from '../../util/path';
import type { Cookies } from '../resources/Cookies';
import type { PaginatedResourceResponse } from '../resources/Deserializer';
import type { Session } from '../resources/Session';
import type { Token } from '../resources/Token';
Expand All@@ -20,6 +21,8 @@ type RefreshTokenParams = {
 request_origin: string;
 request_originating_ip?: string;
 request_headers?: Record<string, string[]>;
 suffixed_cookies?: boolean;
 format?: 'token' | 'cookie';
};

export class SessionAPI extends AbstractAPI {
Expand DownExpand Up@@ -64,12 +67,17 @@ export class SessionAPI extends AbstractAPI {
 });
 }

 public async refreshSession(sessionId: string, params: RefreshTokenParams) {
 public async refreshSession(sessionId: string, params: RefreshTokenParams & { format: 'token' }): Promise<Token>;
 public async refreshSession(sessionId: string, params: RefreshTokenParams & { format: 'cookie' }): Promise<Cookies>;
 public async refreshSession(sessionId: string, params: RefreshTokenParams): Promise<Token>;
 public async refreshSession(sessionId: string, params: RefreshTokenParams): Promise<Token | Cookies> {
 this.requireId(sessionId);
 return this.request<Token>({
 const { suffixed_cookies, ...restParams } = params;
 return this.request({
 method: 'POST',
 path: joinPaths(basePath, sessionId, 'refresh'),
 bodyParams: params,
 bodyParams: restParams,
 queryParams: { suffixed_cookies },
 });
 }
}

9 changes: 9 additions & 0 deletions
packages/backend/src/api/resources/Cookies.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
import type { CookiesJSON } from './JSON';

export class Cookies {
 constructor(readonly cookies: string[]) {}

 static fromJSON(data: CookiesJSON): Cookies {
 return new Cookies(data.cookies);
 }
}

3 changes: 3 additions & 0 deletions
packages/backend/src/api/resources/Deserializer.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
import {
 AllowlistIdentifier,
 Client,
 Cookies,
 DeletedObject,
 Email,
 EmailAddress,
Expand DownExpand Up@@ -72,6 +73,8 @@ function jsonToObject(item: any): any {
 return AllowlistIdentifier.fromJSON(item);
 case ObjectType.Client:
 return Client.fromJSON(item);
 case ObjectType.Cookies:
 return Cookies.fromJSON(item);
 case ObjectType.EmailAddress:
 return EmailAddress.fromJSON(item);
 case ObjectType.Email:
Expand Down

6 changes: 6 additions & 0 deletions
packages/backend/src/api/resources/JSON.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,6 +10,7 @@ export const ObjectType = {
 AccountlessApplication: 'accountless_application',
 AllowlistIdentifier: 'allowlist_identifier',
 Client: 'client',
 Cookies: 'cookies',
 Email: 'email',
 EmailAddress: 'email_address',
 ExternalAccount: 'external_account',
Expand DownExpand Up@@ -44,6 +45,11 @@ export interface ClerkResourceJSON {
 id: string;
}

export interface CookiesJSON {
 object: typeof ObjectType.Cookies;
 cookies: string[];
}

export interface TokenJSON {
 object: typeof ObjectType.Token;
 jwt: string;
Expand Down

1 change: 1 addition & 0 deletions
packages/backend/src/api/resources/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
export * from './AccountlessApplication';
export * from './AllowlistIdentifier';
export * from './Client';
export * from './Cookies';
export * from './DeletedObject';
export * from './Email';
export * from './EmailAddress';
Expand Down

252 changes: 130 additions & 122 deletions
packages/backend/src/tokens/__tests__/request.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -972,130 +972,138 @@ describe('tokens.authenticateRequest(options)', () => {
 expect(requestState.toAuth()).toBeSignedInToAuth();
 });

 test('refreshToken: returns signed in with valid refresh token cookie if token is expired and refresh token exists', async () => {
 server.use(
 http.get('https://api.clerk.test/v1/jwks', () => {
 return HttpResponse.json(mockJwks);
 }),
 );

 // return cookies from endpoint
 const refreshSession = vi.fn(() => ({
 object: 'token',
 jwt: mockJwt,
 }));

 const requestState = await authenticateRequest(
 mockRequestWithCookies(
 {
 ...defaultHeaders,
 origin: 'https://example.com',
 },
 { __client_uat: `12345`, __session: mockExpiredJwt, __refresh_MqCvchyS: 'can_be_anything' },
 ),
 mockOptions({
 secretKey: 'test_deadbeef',
 publishableKey: PK_LIVE,
 apiClient: { sessions: { refreshSession } },
 }),
 );

 expect(requestState).toBeSignedIn();
 expect(requestState.toAuth()).toBeSignedInToAuth();
 expect(refreshSession).toHaveBeenCalled();
 });

 test('refreshToken: does not try to refresh if refresh token does not exist', async () => {
 server.use(
 http.get('https://api.clerk.test/v1/jwks', () => {
 return HttpResponse.json(mockJwks);
 }),
 );

 // return cookies from endpoint
 const refreshSession = vi.fn(() => ({
 object: 'token',
 jwt: mockJwt,
 }));

 await authenticateRequest(
 mockRequestWithCookies(
 {
 ...defaultHeaders,
 origin: 'https://example.com',
 },
 { __client_uat: `12345`, __session: mockExpiredJwt },
 ),
 mockOptions({
 secretKey: 'test_deadbeef',
 publishableKey: PK_LIVE,
 apiClient: { sessions: { refreshSession } },
 }),
 );
 expect(refreshSession).not.toHaveBeenCalled();
 });

 test('refreshToken: does not try to refresh if refresh exists but token is not expired', async () => {
 // return cookies from endpoint
 const refreshSession = vi.fn(() => ({
 object: 'token',
 jwt: mockJwt,
 }));

 await authenticateRequest(
 mockRequestWithCookies(
 {
 ...defaultHeaders,
 origin: 'https://example.com',
 },
 // client_uat is missing, need to handshake not to refresh
 { __session: mockJwt, __refresh_MqCvchyS: 'can_be_anything' },
 ),
 mockOptions({
 secretKey: 'test_deadbeef',
 publishableKey: PK_LIVE,
 apiClient: { sessions: { refreshSession } },
 }),
 );

 expect(refreshSession).not.toHaveBeenCalled();
 });

 test('refreshToken: uses suffixed refresh cookie even if un-suffixed is present', async () => {
 server.use(
 http.get('https://api.clerk.test/v1/jwks', () => {
 return HttpResponse.json(mockJwks);
 }),
 );
 describe('refreshToken', async () => {
@brkalowbrkalowJan 14, 2025

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

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

I moved these tests into a separate describe block, consider looking at the diff without whitespace to see the actual changes: https://github.com/clerk/javascript/pull/4884/files?w=1
 test('returns signed in with valid refresh token cookie if token is expired and refresh token exists', async () => {
 server.use(
 http.get('https://api.clerk.test/v1/jwks', () => {
 return HttpResponse.json(mockJwks);
 }),
 );

 // return cookies from endpoint
 const refreshSession = vi.fn(() => ({
 object: 'cookies',
 cookies: [`__session_MqCvchyS=${mockJwt}; Path=/; Secure; SameSite=Lax`],
 }));

 const requestState = await authenticateRequest(
 mockRequestWithCookies(
 {
 ...defaultHeaders,
 origin: 'https://example.com',
 },
 { __client_uat: `12345`, __session: mockExpiredJwt, __refresh_MqCvchyS: 'can_be_anything' },
 ),
 mockOptions({
 secretKey: 'test_deadbeef',
 publishableKey: PK_LIVE,
 apiClient: { sessions: { refreshSession } },
 }),
 );

 expect(requestState).toBeSignedIn();
 expect(requestState.toAuth()).toBeSignedInToAuth();
 expect(requestState.headers.getSetCookie()).toContain(
 `__session_MqCvchyS=${mockJwt}; Path=/; Secure; SameSite=Lax`,
 );
 expect(refreshSession).toHaveBeenCalled();
 });

 // return cookies from endpoint
 const refreshSession = vi.fn(() => ({
 object: 'token',
 jwt: mockJwt,
 }));
 test('does not try to refresh if refresh token does not exist', async () => {
 server.use(
 http.get('https://api.clerk.test/v1/jwks', () => {
 return HttpResponse.json(mockJwks);
 }),
 );

 // return cookies from endpoint
 const refreshSession = vi.fn(() => ({
 object: 'cookies',
 cookies: [`__session_MqCvchyS=${mockJwt}; Path=/; Secure; SameSite=Lax`],
 }));

 await authenticateRequest(
 mockRequestWithCookies(
 {
 ...defaultHeaders,
 origin: 'https://example.com',
 },
 { __client_uat: `12345`, __session: mockExpiredJwt },
 ),
 mockOptions({
 secretKey: 'test_deadbeef',
 publishableKey: PK_LIVE,
 apiClient: { sessions: { refreshSession } },
 }),
 );
 expect(refreshSession).not.toHaveBeenCalled();
 });

 const requestState = await authenticateRequest(
 mockRequestWithCookies(
 {
 ...defaultHeaders,
 origin: 'https://example.com',
 },
 {
 __client_uat: `12345`,
 __session: mockExpiredJwt,
 __refresh_MqCvchyS: 'can_be_anything',
 __refresh: 'should_not_be_used',
 },
 ),
 mockOptions({
 secretKey: 'test_deadbeef',
 publishableKey: PK_LIVE,
 apiClient: { sessions: { refreshSession } },
 }),
 );
 test('does not try to refresh if refresh exists but token is not expired', async () => {
 // return cookies from endpoint
 const refreshSession = vi.fn(() => ({
 object: 'cookies',
 cookies: [`__session_MqCvchyS=${mockJwt}; Path=/; Secure; SameSite=Lax`],
 }));

 await authenticateRequest(
 mockRequestWithCookies(
 {
 ...defaultHeaders,
 origin: 'https://example.com',
 },
 // client_uat is missing, need to handshake not to refresh
 { __session: mockJwt, __refresh_MqCvchyS: 'can_be_anything' },
 ),
 mockOptions({
 secretKey: 'test_deadbeef',
 publishableKey: PK_LIVE,
 apiClient: { sessions: { refreshSession } },
 }),
 );

 expect(refreshSession).not.toHaveBeenCalled();
 });

 expect(requestState).toBeSignedIn();
 expect(requestState.toAuth()).toBeSignedInToAuth();
 expect(refreshSession).toHaveBeenCalled();
 test('uses suffixed refresh cookie even if un-suffixed is present', async () => {
 server.use(
 http.get('https://api.clerk.test/v1/jwks', () => {
 return HttpResponse.json(mockJwks);
 }),
 );

 // return cookies from endpoint
 const refreshSession = vi.fn(() => ({
 object: 'cookies',
 cookies: [`__session_MqCvchyS=${mockJwt}; Path=/; Secure; SameSite=Lax`],
 }));

 const requestState = await authenticateRequest(
 mockRequestWithCookies(
 {
 ...defaultHeaders,
 origin: 'https://example.com',
 },
 {
 __client_uat: `12345`,
 __session: mockExpiredJwt,
 __refresh_MqCvchyS: 'can_be_anything',
 __refresh: 'should_not_be_used',
 },
 ),
 mockOptions({
 secretKey: 'test_deadbeef',
 publishableKey: PK_LIVE,
 apiClient: { sessions: { refreshSession } },
 }),
 );

 expect(requestState).toBeSignedIn();
 expect(requestState.toAuth()).toBeSignedInToAuth();
 expect(requestState.headers.getSetCookie()).toContain(
 `__session_MqCvchyS=${mockJwt}; Path=/; Secure; SameSite=Lax`,
 );
 expect(refreshSession).toHaveBeenCalled();
 });
 });
});
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('^' + ".*" + '
feat(backend): Set cookies from the refresh token flow by brkalow · Pull Request #4884 · clerk/javascript · GitHub
Skip to content
feat(backend): Set cookies from the refresh token flow#4884

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

brkalow
merged 5 commits into

from

Jan 15, 2025
 Merged


feat(backend): Set cookies from the refresh token flow
#4884
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


5 commits


Select commit
Hold shift + click to select a range
2e9888f

Set cookies from the refresh token flow


brkalow Jan 13, 2025
9bd2134

Use proper format values, and pass in body instead of query parmeter


brkalow Jan 13, 2025
1f755ae

Adds missing file


brkalow Jan 13, 2025
19d2ada

Adds changeset


brkalow Jan 14, 2025
3998837

Update packages/backend/src/api/endpoints/SessionApi.ts


brkalow Jan 15, 2025

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/good-eggs-retire.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/backend': minor
---

`authenticateRequest()` will now set a refreshsed session cookie on the response when an expired session token is refreshed via the Clerk API.

14 changes: 11 additions & 3 deletions
packages/backend/src/api/endpoints/SessionApi.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
import type { ClerkPaginationRequest, SessionStatus } from '@clerk/types';

import { joinPaths } from '../../util/path';
import type { Cookies } from '../resources/Cookies';
import type { PaginatedResourceResponse } from '../resources/Deserializer';
import type { Session } from '../resources/Session';
import type { Token } from '../resources/Token';
Expand All@@ -20,6 +21,8 @@ type RefreshTokenParams = {
 request_origin: string;
 request_originating_ip?: string;
 request_headers?: Record<string, string[]>;
 suffixed_cookies?: boolean;
 format?: 'token' | 'cookie';
};

export class SessionAPI extends AbstractAPI {
Expand DownExpand Up@@ -64,12 +67,17 @@ export class SessionAPI extends AbstractAPI {
 });
 }

 public async refreshSession(sessionId: string, params: RefreshTokenParams) {
 public async refreshSession(sessionId: string, params: RefreshTokenParams & { format: 'token' }): Promise<Token>;
 public async refreshSession(sessionId: string, params: RefreshTokenParams & { format: 'cookie' }): Promise<Cookies>;
 public async refreshSession(sessionId: string, params: RefreshTokenParams): Promise<Token>;
 public async refreshSession(sessionId: string, params: RefreshTokenParams): Promise<Token | Cookies> {
 this.requireId(sessionId);
 return this.request<Token>({
 const { suffixed_cookies, ...restParams } = params;
 return this.request({
 method: 'POST',
 path: joinPaths(basePath, sessionId, 'refresh'),
 bodyParams: params,
 bodyParams: restParams,
 queryParams: { suffixed_cookies },
 });
 }
}

9 changes: 9 additions & 0 deletions
packages/backend/src/api/resources/Cookies.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
import type { CookiesJSON } from './JSON';

export class Cookies {
 constructor(readonly cookies: string[]) {}

 static fromJSON(data: CookiesJSON): Cookies {
 return new Cookies(data.cookies);
 }
}

3 changes: 3 additions & 0 deletions
packages/backend/src/api/resources/Deserializer.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
import {
 AllowlistIdentifier,
 Client,
 Cookies,
 DeletedObject,
 Email,
 EmailAddress,
Expand DownExpand Up@@ -72,6 +73,8 @@ function jsonToObject(item: any): any {
 return AllowlistIdentifier.fromJSON(item);
 case ObjectType.Client:
 return Client.fromJSON(item);
 case ObjectType.Cookies:
 return Cookies.fromJSON(item);
 case ObjectType.EmailAddress:
 return EmailAddress.fromJSON(item);
 case ObjectType.Email:
Expand Down

6 changes: 6 additions & 0 deletions
packages/backend/src/api/resources/JSON.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,6 +10,7 @@ export const ObjectType = {
 AccountlessApplication: 'accountless_application',
 AllowlistIdentifier: 'allowlist_identifier',
 Client: 'client',
 Cookies: 'cookies',
 Email: 'email',
 EmailAddress: 'email_address',
 ExternalAccount: 'external_account',
Expand DownExpand Up@@ -44,6 +45,11 @@ export interface ClerkResourceJSON {
 id: string;
}

export interface CookiesJSON {
 object: typeof ObjectType.Cookies;
 cookies: string[];
}

export interface TokenJSON {
 object: typeof ObjectType.Token;
 jwt: string;
Expand Down

1 change: 1 addition & 0 deletions
packages/backend/src/api/resources/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
export * from './AccountlessApplication';
export * from './AllowlistIdentifier';
export * from './Client';
export * from './Cookies';
export * from './DeletedObject';
export * from './Email';
export * from './EmailAddress';
Expand Down

252 changes: 130 additions & 122 deletions
packages/backend/src/tokens/__tests__/request.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -972,130 +972,138 @@ describe('tokens.authenticateRequest(options)', () => {
 expect(requestState.toAuth()).toBeSignedInToAuth();
 });

 test('refreshToken: returns signed in with valid refresh token cookie if token is expired and refresh token exists', async () => {
 server.use(
 http.get('https://api.clerk.test/v1/jwks', () => {
 return HttpResponse.json(mockJwks);
 }),
 );

 // return cookies from endpoint
 const refreshSession = vi.fn(() => ({
 object: 'token',
 jwt: mockJwt,
 }));

 const requestState = await authenticateRequest(
 mockRequestWithCookies(
 {
 ...defaultHeaders,
 origin: 'https://example.com',
 },
 { __client_uat: `12345`, __session: mockExpiredJwt, __refresh_MqCvchyS: 'can_be_anything' },
 ),
 mockOptions({
 secretKey: 'test_deadbeef',
 publishableKey: PK_LIVE,
 apiClient: { sessions: { refreshSession } },
 }),
 );

 expect(requestState).toBeSignedIn();
 expect(requestState.toAuth()).toBeSignedInToAuth();
 expect(refreshSession).toHaveBeenCalled();
 });

 test('refreshToken: does not try to refresh if refresh token does not exist', async () => {
 server.use(
 http.get('https://api.clerk.test/v1/jwks', () => {
 return HttpResponse.json(mockJwks);
 }),
 );

 // return cookies from endpoint
 const refreshSession = vi.fn(() => ({
 object: 'token',
 jwt: mockJwt,
 }));

 await authenticateRequest(
 mockRequestWithCookies(
 {
 ...defaultHeaders,
 origin: 'https://example.com',
 },
 { __client_uat: `12345`, __session: mockExpiredJwt },
 ),
 mockOptions({
 secretKey: 'test_deadbeef',
 publishableKey: PK_LIVE,
 apiClient: { sessions: { refreshSession } },
 }),
 );
 expect(refreshSession).not.toHaveBeenCalled();
 });

 test('refreshToken: does not try to refresh if refresh exists but token is not expired', async () => {
 // return cookies from endpoint
 const refreshSession = vi.fn(() => ({
 object: 'token',
 jwt: mockJwt,
 }));

 await authenticateRequest(
 mockRequestWithCookies(
 {
 ...defaultHeaders,
 origin: 'https://example.com',
 },
 // client_uat is missing, need to handshake not to refresh
 { __session: mockJwt, __refresh_MqCvchyS: 'can_be_anything' },
 ),
 mockOptions({
 secretKey: 'test_deadbeef',
 publishableKey: PK_LIVE,
 apiClient: { sessions: { refreshSession } },
 }),
 );

 expect(refreshSession).not.toHaveBeenCalled();
 });

 test('refreshToken: uses suffixed refresh cookie even if un-suffixed is present', async () => {
 server.use(
 http.get('https://api.clerk.test/v1/jwks', () => {
 return HttpResponse.json(mockJwks);
 }),
 );
 describe('refreshToken', async () => {
@brkalowbrkalowJan 14, 2025

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

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

I moved these tests into a separate describe block, consider looking at the diff without whitespace to see the actual changes: https://github.com/clerk/javascript/pull/4884/files?w=1
 test('returns signed in with valid refresh token cookie if token is expired and refresh token exists', async () => {
 server.use(
 http.get('https://api.clerk.test/v1/jwks', () => {
 return HttpResponse.json(mockJwks);
 }),
 );

 // return cookies from endpoint
 const refreshSession = vi.fn(() => ({
 object: 'cookies',
 cookies: [`__session_MqCvchyS=${mockJwt}; Path=/; Secure; SameSite=Lax`],
 }));

 const requestState = await authenticateRequest(
 mockRequestWithCookies(
 {
 ...defaultHeaders,
 origin: 'https://example.com',
 },
 { __client_uat: `12345`, __session: mockExpiredJwt, __refresh_MqCvchyS: 'can_be_anything' },
 ),
 mockOptions({
 secretKey: 'test_deadbeef',
 publishableKey: PK_LIVE,
 apiClient: { sessions: { refreshSession } },
 }),
 );

 expect(requestState).toBeSignedIn();
 expect(requestState.toAuth()).toBeSignedInToAuth();
 expect(requestState.headers.getSetCookie()).toContain(
 `__session_MqCvchyS=${mockJwt}; Path=/; Secure; SameSite=Lax`,
 );
 expect(refreshSession).toHaveBeenCalled();
 });

 // return cookies from endpoint
 const refreshSession = vi.fn(() => ({
 object: 'token',
 jwt: mockJwt,
 }));
 test('does not try to refresh if refresh token does not exist', async () => {
 server.use(
 http.get('https://api.clerk.test/v1/jwks', () => {
 return HttpResponse.json(mockJwks);
 }),
 );

 // return cookies from endpoint
 const refreshSession = vi.fn(() => ({
 object: 'cookies',
 cookies: [`__session_MqCvchyS=${mockJwt}; Path=/; Secure; SameSite=Lax`],
 }));

 await authenticateRequest(
 mockRequestWithCookies(
 {
 ...defaultHeaders,
 origin: 'https://example.com',
 },
 { __client_uat: `12345`, __session: mockExpiredJwt },
 ),
 mockOptions({
 secretKey: 'test_deadbeef',
 publishableKey: PK_LIVE,
 apiClient: { sessions: { refreshSession } },
 }),
 );
 expect(refreshSession).not.toHaveBeenCalled();
 });

 const requestState = await authenticateRequest(
 mockRequestWithCookies(
 {
 ...defaultHeaders,
 origin: 'https://example.com',
 },
 {
 __client_uat: `12345`,
 __session: mockExpiredJwt,
 __refresh_MqCvchyS: 'can_be_anything',
 __refresh: 'should_not_be_used',
 },
 ),
 mockOptions({
 secretKey: 'test_deadbeef',
 publishableKey: PK_LIVE,
 apiClient: { sessions: { refreshSession } },
 }),
 );
 test('does not try to refresh if refresh exists but token is not expired', async () => {
 // return cookies from endpoint
 const refreshSession = vi.fn(() => ({
 object: 'cookies',
 cookies: [`__session_MqCvchyS=${mockJwt}; Path=/; Secure; SameSite=Lax`],
 }));

 await authenticateRequest(
 mockRequestWithCookies(
 {
 ...defaultHeaders,
 origin: 'https://example.com',
 },
 // client_uat is missing, need to handshake not to refresh
 { __session: mockJwt, __refresh_MqCvchyS: 'can_be_anything' },
 ),
 mockOptions({
 secretKey: 'test_deadbeef',
 publishableKey: PK_LIVE,
 apiClient: { sessions: { refreshSession } },
 }),
 );

 expect(refreshSession).not.toHaveBeenCalled();
 });

 expect(requestState).toBeSignedIn();
 expect(requestState.toAuth()).toBeSignedInToAuth();
 expect(refreshSession).toHaveBeenCalled();
 test('uses suffixed refresh cookie even if un-suffixed is present', async () => {
 server.use(
 http.get('https://api.clerk.test/v1/jwks', () => {
 return HttpResponse.json(mockJwks);
 }),
 );

 // return cookies from endpoint
 const refreshSession = vi.fn(() => ({
 object: 'cookies',
 cookies: [`__session_MqCvchyS=${mockJwt}; Path=/; Secure; SameSite=Lax`],
 }));

 const requestState = await authenticateRequest(
 mockRequestWithCookies(
 {
 ...defaultHeaders,
 origin: 'https://example.com',
 },
 {
 __client_uat: `12345`,
 __session: mockExpiredJwt,
 __refresh_MqCvchyS: 'can_be_anything',
 __refresh: 'should_not_be_used',
 },
 ),
 mockOptions({
 secretKey: 'test_deadbeef',
 publishableKey: PK_LIVE,
 apiClient: { sessions: { refreshSession } },
 }),
 );

 expect(requestState).toBeSignedIn();
 expect(requestState.toAuth()).toBeSignedInToAuth();
 expect(requestState.headers.getSetCookie()).toContain(
 `__session_MqCvchyS=${mockJwt}; Path=/; Secure; SameSite=Lax`,
 );
 expect(refreshSession).toHaveBeenCalled();
 });
 });
});
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('^' + ".*" + '
feat(backend): Set cookies from the refresh token flow by brkalow · Pull Request #4884 · clerk/javascript · GitHub
Skip to content
feat(backend): Set cookies from the refresh token flow#4884

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

brkalow
merged 5 commits into

from

Jan 15, 2025
 Merged


feat(backend): Set cookies from the refresh token flow
#4884
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


5 commits


Select commit
Hold shift + click to select a range
2e9888f

Set cookies from the refresh token flow


brkalow Jan 13, 2025
9bd2134

Use proper format values, and pass in body instead of query parmeter


brkalow Jan 13, 2025
1f755ae

Adds missing file


brkalow Jan 13, 2025
19d2ada

Adds changeset


brkalow Jan 14, 2025
3998837

Update packages/backend/src/api/endpoints/SessionApi.ts


brkalow Jan 15, 2025

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/good-eggs-retire.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/backend': minor
---

`authenticateRequest()` will now set a refreshsed session cookie on the response when an expired session token is refreshed via the Clerk API.

14 changes: 11 additions & 3 deletions
packages/backend/src/api/endpoints/SessionApi.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
import type { ClerkPaginationRequest, SessionStatus } from '@clerk/types';

import { joinPaths } from '../../util/path';
import type { Cookies } from '../resources/Cookies';
import type { PaginatedResourceResponse } from '../resources/Deserializer';
import type { Session } from '../resources/Session';
import type { Token } from '../resources/Token';
Expand All@@ -20,6 +21,8 @@ type RefreshTokenParams = {
 request_origin: string;
 request_originating_ip?: string;
 request_headers?: Record<string, string[]>;
 suffixed_cookies?: boolean;
 format?: 'token' | 'cookie';
};

export class SessionAPI extends AbstractAPI {
Expand DownExpand Up@@ -64,12 +67,17 @@ export class SessionAPI extends AbstractAPI {
 });
 }

 public async refreshSession(sessionId: string, params: RefreshTokenParams) {
 public async refreshSession(sessionId: string, params: RefreshTokenParams & { format: 'token' }): Promise<Token>;
 public async refreshSession(sessionId: string, params: RefreshTokenParams & { format: 'cookie' }): Promise<Cookies>;
 public async refreshSession(sessionId: string, params: RefreshTokenParams): Promise<Token>;
 public async refreshSession(sessionId: string, params: RefreshTokenParams): Promise<Token | Cookies> {
 this.requireId(sessionId);
 return this.request<Token>({
 const { suffixed_cookies, ...restParams } = params;
 return this.request({
 method: 'POST',
 path: joinPaths(basePath, sessionId, 'refresh'),
 bodyParams: params,
 bodyParams: restParams,
 queryParams: { suffixed_cookies },
 });
 }
}

9 changes: 9 additions & 0 deletions
packages/backend/src/api/resources/Cookies.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
import type { CookiesJSON } from './JSON';

export class Cookies {
 constructor(readonly cookies: string[]) {}

 static fromJSON(data: CookiesJSON): Cookies {
 return new Cookies(data.cookies);
 }
}

3 changes: 3 additions & 0 deletions
packages/backend/src/api/resources/Deserializer.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
import {
 AllowlistIdentifier,
 Client,
 Cookies,
 DeletedObject,
 Email,
 EmailAddress,
Expand DownExpand Up@@ -72,6 +73,8 @@ function jsonToObject(item: any): any {
 return AllowlistIdentifier.fromJSON(item);
 case ObjectType.Client:
 return Client.fromJSON(item);
 case ObjectType.Cookies:
 return Cookies.fromJSON(item);
 case ObjectType.EmailAddress:
 return EmailAddress.fromJSON(item);
 case ObjectType.Email:
Expand Down

6 changes: 6 additions & 0 deletions
packages/backend/src/api/resources/JSON.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,6 +10,7 @@ export const ObjectType = {
 AccountlessApplication: 'accountless_application',
 AllowlistIdentifier: 'allowlist_identifier',
 Client: 'client',
 Cookies: 'cookies',
 Email: 'email',
 EmailAddress: 'email_address',
 ExternalAccount: 'external_account',
Expand DownExpand Up@@ -44,6 +45,11 @@ export interface ClerkResourceJSON {
 id: string;
}

export interface CookiesJSON {
 object: typeof ObjectType.Cookies;
 cookies: string[];
}

export interface TokenJSON {
 object: typeof ObjectType.Token;
 jwt: string;
Expand Down

1 change: 1 addition & 0 deletions
packages/backend/src/api/resources/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
export * from './AccountlessApplication';
export * from './AllowlistIdentifier';
export * from './Client';
export * from './Cookies';
export * from './DeletedObject';
export * from './Email';
export * from './EmailAddress';
Expand Down

252 changes: 130 additions & 122 deletions
packages/backend/src/tokens/__tests__/request.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -972,130 +972,138 @@ describe('tokens.authenticateRequest(options)', () => {
 expect(requestState.toAuth()).toBeSignedInToAuth();
 });

 test('refreshToken: returns signed in with valid refresh token cookie if token is expired and refresh token exists', async () => {
 server.use(
 http.get('https://api.clerk.test/v1/jwks', () => {
 return HttpResponse.json(mockJwks);
 }),
 );

 // return cookies from endpoint
 const refreshSession = vi.fn(() => ({
 object: 'token',
 jwt: mockJwt,
 }));

 const requestState = await authenticateRequest(
 mockRequestWithCookies(
 {
 ...defaultHeaders,
 origin: 'https://example.com',
 },
 { __client_uat: `12345`, __session: mockExpiredJwt, __refresh_MqCvchyS: 'can_be_anything' },
 ),
 mockOptions({
 secretKey: 'test_deadbeef',
 publishableKey: PK_LIVE,
 apiClient: { sessions: { refreshSession } },
 }),
 );

 expect(requestState).toBeSignedIn();
 expect(requestState.toAuth()).toBeSignedInToAuth();
 expect(refreshSession).toHaveBeenCalled();
 });

 test('refreshToken: does not try to refresh if refresh token does not exist', async () => {
 server.use(
 http.get('https://api.clerk.test/v1/jwks', () => {
 return HttpResponse.json(mockJwks);
 }),
 );

 // return cookies from endpoint
 const refreshSession = vi.fn(() => ({
 object: 'token',
 jwt: mockJwt,
 }));

 await authenticateRequest(
 mockRequestWithCookies(
 {
 ...defaultHeaders,
 origin: 'https://example.com',
 },
 { __client_uat: `12345`, __session: mockExpiredJwt },
 ),
 mockOptions({
 secretKey: 'test_deadbeef',
 publishableKey: PK_LIVE,
 apiClient: { sessions: { refreshSession } },
 }),
 );
 expect(refreshSession).not.toHaveBeenCalled();
 });

 test('refreshToken: does not try to refresh if refresh exists but token is not expired', async () => {
 // return cookies from endpoint
 const refreshSession = vi.fn(() => ({
 object: 'token',
 jwt: mockJwt,
 }));

 await authenticateRequest(
 mockRequestWithCookies(
 {
 ...defaultHeaders,
 origin: 'https://example.com',
 },
 // client_uat is missing, need to handshake not to refresh
 { __session: mockJwt, __refresh_MqCvchyS: 'can_be_anything' },
 ),
 mockOptions({
 secretKey: 'test_deadbeef',
 publishableKey: PK_LIVE,
 apiClient: { sessions: { refreshSession } },
 }),
 );

 expect(refreshSession).not.toHaveBeenCalled();
 });

 test('refreshToken: uses suffixed refresh cookie even if un-suffixed is present', async () => {
 server.use(
 http.get('https://api.clerk.test/v1/jwks', () => {
 return HttpResponse.json(mockJwks);
 }),
 );
 describe('refreshToken', async () => {
@brkalowbrkalowJan 14, 2025

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

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

I moved these tests into a separate describe block, consider looking at the diff without whitespace to see the actual changes: https://github.com/clerk/javascript/pull/4884/files?w=1
 test('returns signed in with valid refresh token cookie if token is expired and refresh token exists', async () => {
 server.use(
 http.get('https://api.clerk.test/v1/jwks', () => {
 return HttpResponse.json(mockJwks);
 }),
 );

 // return cookies from endpoint
 const refreshSession = vi.fn(() => ({
 object: 'cookies',
 cookies: [`__session_MqCvchyS=${mockJwt}; Path=/; Secure; SameSite=Lax`],
 }));

 const requestState = await authenticateRequest(
 mockRequestWithCookies(
 {
 ...defaultHeaders,
 origin: 'https://example.com',
 },
 { __client_uat: `12345`, __session: mockExpiredJwt, __refresh_MqCvchyS: 'can_be_anything' },
 ),
 mockOptions({
 secretKey: 'test_deadbeef',
 publishableKey: PK_LIVE,
 apiClient: { sessions: { refreshSession } },
 }),
 );

 expect(requestState).toBeSignedIn();
 expect(requestState.toAuth()).toBeSignedInToAuth();
 expect(requestState.headers.getSetCookie()).toContain(
 `__session_MqCvchyS=${mockJwt}; Path=/; Secure; SameSite=Lax`,
 );
 expect(refreshSession).toHaveBeenCalled();
 });

 // return cookies from endpoint
 const refreshSession = vi.fn(() => ({
 object: 'token',
 jwt: mockJwt,
 }));
 test('does not try to refresh if refresh token does not exist', async () => {
 server.use(
 http.get('https://api.clerk.test/v1/jwks', () => {
 return HttpResponse.json(mockJwks);
 }),
 );

 // return cookies from endpoint
 const refreshSession = vi.fn(() => ({
 object: 'cookies',
 cookies: [`__session_MqCvchyS=${mockJwt}; Path=/; Secure; SameSite=Lax`],
 }));

 await authenticateRequest(
 mockRequestWithCookies(
 {
 ...defaultHeaders,
 origin: 'https://example.com',
 },
 { __client_uat: `12345`, __session: mockExpiredJwt },
 ),
 mockOptions({
 secretKey: 'test_deadbeef',
 publishableKey: PK_LIVE,
 apiClient: { sessions: { refreshSession } },
 }),
 );
 expect(refreshSession).not.toHaveBeenCalled();
 });

 const requestState = await authenticateRequest(
 mockRequestWithCookies(
 {
 ...defaultHeaders,
 origin: 'https://example.com',
 },
 {
 __client_uat: `12345`,
 __session: mockExpiredJwt,
 __refresh_MqCvchyS: 'can_be_anything',
 __refresh: 'should_not_be_used',
 },
 ),
 mockOptions({
 secretKey: 'test_deadbeef',
 publishableKey: PK_LIVE,
 apiClient: { sessions: { refreshSession } },
 }),
 );
 test('does not try to refresh if refresh exists but token is not expired', async () => {
 // return cookies from endpoint
 const refreshSession = vi.fn(() => ({
 object: 'cookies',
 cookies: [`__session_MqCvchyS=${mockJwt}; Path=/; Secure; SameSite=Lax`],
 }));

 await authenticateRequest(
 mockRequestWithCookies(
 {
 ...defaultHeaders,
 origin: 'https://example.com',
 },
 // client_uat is missing, need to handshake not to refresh
 { __session: mockJwt, __refresh_MqCvchyS: 'can_be_anything' },
 ),
 mockOptions({
 secretKey: 'test_deadbeef',
 publishableKey: PK_LIVE,
 apiClient: { sessions: { refreshSession } },
 }),
 );

 expect(refreshSession).not.toHaveBeenCalled();
 });

 expect(requestState).toBeSignedIn();
 expect(requestState.toAuth()).toBeSignedInToAuth();
 expect(refreshSession).toHaveBeenCalled();
 test('uses suffixed refresh cookie even if un-suffixed is present', async () => {
 server.use(
 http.get('https://api.clerk.test/v1/jwks', () => {
 return HttpResponse.json(mockJwks);
 }),
 );

 // return cookies from endpoint
 const refreshSession = vi.fn(() => ({
 object: 'cookies',
 cookies: [`__session_MqCvchyS=${mockJwt}; Path=/; Secure; SameSite=Lax`],
 }));

 const requestState = await authenticateRequest(
 mockRequestWithCookies(
 {
 ...defaultHeaders,
 origin: 'https://example.com',
 },
 {
 __client_uat: `12345`,
 __session: mockExpiredJwt,
 __refresh_MqCvchyS: 'can_be_anything',
 __refresh: 'should_not_be_used',
 },
 ),
 mockOptions({
 secretKey: 'test_deadbeef',
 publishableKey: PK_LIVE,
 apiClient: { sessions: { refreshSession } },
 }),
 );

 expect(requestState).toBeSignedIn();
 expect(requestState.toAuth()).toBeSignedInToAuth();
 expect(requestState.headers.getSetCookie()).toContain(
 `__session_MqCvchyS=${mockJwt}; Path=/; Secure; SameSite=Lax`,
 );
 expect(refreshSession).toHaveBeenCalled();
 });
 });
});
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" + '
feat(backend): Set cookies from the refresh token flow by brkalow · Pull Request #4884 · clerk/javascript · GitHub
Skip to content
feat(backend): Set cookies from the refresh token flow#4884

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

brkalow
merged 5 commits into

from

Jan 15, 2025
 Merged


feat(backend): Set cookies from the refresh token flow
#4884
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


5 commits


Select commit
Hold shift + click to select a range
2e9888f

Set cookies from the refresh token flow


brkalow Jan 13, 2025
9bd2134

Use proper format values, and pass in body instead of query parmeter


brkalow Jan 13, 2025
1f755ae

Adds missing file


brkalow Jan 13, 2025
19d2ada

Adds changeset


brkalow Jan 14, 2025
3998837

Update packages/backend/src/api/endpoints/SessionApi.ts


brkalow Jan 15, 2025

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/good-eggs-retire.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/backend': minor
---

`authenticateRequest()` will now set a refreshsed session cookie on the response when an expired session token is refreshed via the Clerk API.

14 changes: 11 additions & 3 deletions
packages/backend/src/api/endpoints/SessionApi.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
import type { ClerkPaginationRequest, SessionStatus } from '@clerk/types';

import { joinPaths } from '../../util/path';
import type { Cookies } from '../resources/Cookies';
import type { PaginatedResourceResponse } from '../resources/Deserializer';
import type { Session } from '../resources/Session';
import type { Token } from '../resources/Token';
Expand All@@ -20,6 +21,8 @@ type RefreshTokenParams = {
 request_origin: string;
 request_originating_ip?: string;
 request_headers?: Record<string, string[]>;
 suffixed_cookies?: boolean;
 format?: 'token' | 'cookie';
};

export class SessionAPI extends AbstractAPI {
Expand DownExpand Up@@ -64,12 +67,17 @@ export class SessionAPI extends AbstractAPI {
 });
 }

 public async refreshSession(sessionId: string, params: RefreshTokenParams) {
 public async refreshSession(sessionId: string, params: RefreshTokenParams & { format: 'token' }): Promise<Token>;
 public async refreshSession(sessionId: string, params: RefreshTokenParams & { format: 'cookie' }): Promise<Cookies>;
 public async refreshSession(sessionId: string, params: RefreshTokenParams): Promise<Token>;
 public async refreshSession(sessionId: string, params: RefreshTokenParams): Promise<Token | Cookies> {
 this.requireId(sessionId);
 return this.request<Token>({
 const { suffixed_cookies, ...restParams } = params;
 return this.request({
 method: 'POST',
 path: joinPaths(basePath, sessionId, 'refresh'),
 bodyParams: params,
 bodyParams: restParams,
 queryParams: { suffixed_cookies },
 });
 }
}

9 changes: 9 additions & 0 deletions
packages/backend/src/api/resources/Cookies.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
import type { CookiesJSON } from './JSON';

export class Cookies {
 constructor(readonly cookies: string[]) {}

 static fromJSON(data: CookiesJSON): Cookies {
 return new Cookies(data.cookies);
 }
}

3 changes: 3 additions & 0 deletions
packages/backend/src/api/resources/Deserializer.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
import {
 AllowlistIdentifier,
 Client,
 Cookies,
 DeletedObject,
 Email,
 EmailAddress,
Expand DownExpand Up@@ -72,6 +73,8 @@ function jsonToObject(item: any): any {
 return AllowlistIdentifier.fromJSON(item);
 case ObjectType.Client:
 return Client.fromJSON(item);
 case ObjectType.Cookies:
 return Cookies.fromJSON(item);
 case ObjectType.EmailAddress:
 return EmailAddress.fromJSON(item);
 case ObjectType.Email:
Expand Down

6 changes: 6 additions & 0 deletions
packages/backend/src/api/resources/JSON.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,6 +10,7 @@ export const ObjectType = {
 AccountlessApplication: 'accountless_application',
 AllowlistIdentifier: 'allowlist_identifier',
 Client: 'client',
 Cookies: 'cookies',
 Email: 'email',
 EmailAddress: 'email_address',
 ExternalAccount: 'external_account',
Expand DownExpand Up@@ -44,6 +45,11 @@ export interface ClerkResourceJSON {
 id: string;
}

export interface CookiesJSON {
 object: typeof ObjectType.Cookies;
 cookies: string[];
}

export interface TokenJSON {
 object: typeof ObjectType.Token;
 jwt: string;
Expand Down

1 change: 1 addition & 0 deletions
packages/backend/src/api/resources/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
export * from './AccountlessApplication';
export * from './AllowlistIdentifier';
export * from './Client';
export * from './Cookies';
export * from './DeletedObject';
export * from './Email';
export * from './EmailAddress';
Expand Down

252 changes: 130 additions & 122 deletions
packages/backend/src/tokens/__tests__/request.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -972,130 +972,138 @@ describe('tokens.authenticateRequest(options)', () => {
 expect(requestState.toAuth()).toBeSignedInToAuth();
 });

 test('refreshToken: returns signed in with valid refresh token cookie if token is expired and refresh token exists', async () => {
 server.use(
 http.get('https://api.clerk.test/v1/jwks', () => {
 return HttpResponse.json(mockJwks);
 }),
 );

 // return cookies from endpoint
 const refreshSession = vi.fn(() => ({
 object: 'token',
 jwt: mockJwt,
 }));

 const requestState = await authenticateRequest(
 mockRequestWithCookies(
 {
 ...defaultHeaders,
 origin: 'https://example.com',
 },
 { __client_uat: `12345`, __session: mockExpiredJwt, __refresh_MqCvchyS: 'can_be_anything' },
 ),
 mockOptions({
 secretKey: 'test_deadbeef',
 publishableKey: PK_LIVE,
 apiClient: { sessions: { refreshSession } },
 }),
 );

 expect(requestState).toBeSignedIn();
 expect(requestState.toAuth()).toBeSignedInToAuth();
 expect(refreshSession).toHaveBeenCalled();
 });

 test('refreshToken: does not try to refresh if refresh token does not exist', async () => {
 server.use(
 http.get('https://api.clerk.test/v1/jwks', () => {
 return HttpResponse.json(mockJwks);
 }),
 );

 // return cookies from endpoint
 const refreshSession = vi.fn(() => ({
 object: 'token',
 jwt: mockJwt,
 }));

 await authenticateRequest(
 mockRequestWithCookies(
 {
 ...defaultHeaders,
 origin: 'https://example.com',
 },
 { __client_uat: `12345`, __session: mockExpiredJwt },
 ),
 mockOptions({
 secretKey: 'test_deadbeef',
 publishableKey: PK_LIVE,
 apiClient: { sessions: { refreshSession } },
 }),
 );
 expect(refreshSession).not.toHaveBeenCalled();
 });

 test('refreshToken: does not try to refresh if refresh exists but token is not expired', async () => {
 // return cookies from endpoint
 const refreshSession = vi.fn(() => ({
 object: 'token',
 jwt: mockJwt,
 }));

 await authenticateRequest(
 mockRequestWithCookies(
 {
 ...defaultHeaders,
 origin: 'https://example.com',
 },
 // client_uat is missing, need to handshake not to refresh
 { __session: mockJwt, __refresh_MqCvchyS: 'can_be_anything' },
 ),
 mockOptions({
 secretKey: 'test_deadbeef',
 publishableKey: PK_LIVE,
 apiClient: { sessions: { refreshSession } },
 }),
 );

 expect(refreshSession).not.toHaveBeenCalled();
 });

 test('refreshToken: uses suffixed refresh cookie even if un-suffixed is present', async () => {
 server.use(
 http.get('https://api.clerk.test/v1/jwks', () => {
 return HttpResponse.json(mockJwks);
 }),
 );
 describe('refreshToken', async () => {
@brkalowbrkalowJan 14, 2025

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

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

I moved these tests into a separate describe block, consider looking at the diff without whitespace to see the actual changes: https://github.com/clerk/javascript/pull/4884/files?w=1
 test('returns signed in with valid refresh token cookie if token is expired and refresh token exists', async () => {
 server.use(
 http.get('https://api.clerk.test/v1/jwks', () => {
 return HttpResponse.json(mockJwks);
 }),
 );

 // return cookies from endpoint
 const refreshSession = vi.fn(() => ({
 object: 'cookies',
 cookies: [`__session_MqCvchyS=${mockJwt}; Path=/; Secure; SameSite=Lax`],
 }));

 const requestState = await authenticateRequest(
 mockRequestWithCookies(
 {
 ...defaultHeaders,
 origin: 'https://example.com',
 },
 { __client_uat: `12345`, __session: mockExpiredJwt, __refresh_MqCvchyS: 'can_be_anything' },
 ),
 mockOptions({
 secretKey: 'test_deadbeef',
 publishableKey: PK_LIVE,
 apiClient: { sessions: { refreshSession } },
 }),
 );

 expect(requestState).toBeSignedIn();
 expect(requestState.toAuth()).toBeSignedInToAuth();
 expect(requestState.headers.getSetCookie()).toContain(
 `__session_MqCvchyS=${mockJwt}; Path=/; Secure; SameSite=Lax`,
 );
 expect(refreshSession).toHaveBeenCalled();
 });

 // return cookies from endpoint
 const refreshSession = vi.fn(() => ({
 object: 'token',
 jwt: mockJwt,
 }));
 test('does not try to refresh if refresh token does not exist', async () => {
 server.use(
 http.get('https://api.clerk.test/v1/jwks', () => {
 return HttpResponse.json(mockJwks);
 }),
 );

 // return cookies from endpoint
 const refreshSession = vi.fn(() => ({
 object: 'cookies',
 cookies: [`__session_MqCvchyS=${mockJwt}; Path=/; Secure; SameSite=Lax`],
 }));

 await authenticateRequest(
 mockRequestWithCookies(
 {
 ...defaultHeaders,
 origin: 'https://example.com',
 },
 { __client_uat: `12345`, __session: mockExpiredJwt },
 ),
 mockOptions({
 secretKey: 'test_deadbeef',
 publishableKey: PK_LIVE,
 apiClient: { sessions: { refreshSession } },
 }),
 );
 expect(refreshSession).not.toHaveBeenCalled();
 });

 const requestState = await authenticateRequest(
 mockRequestWithCookies(
 {
 ...defaultHeaders,
 origin: 'https://example.com',
 },
 {
 __client_uat: `12345`,
 __session: mockExpiredJwt,
 __refresh_MqCvchyS: 'can_be_anything',
 __refresh: 'should_not_be_used',
 },
 ),
 mockOptions({
 secretKey: 'test_deadbeef',
 publishableKey: PK_LIVE,
 apiClient: { sessions: { refreshSession } },
 }),
 );
 test('does not try to refresh if refresh exists but token is not expired', async () => {
 // return cookies from endpoint
 const refreshSession = vi.fn(() => ({
 object: 'cookies',
 cookies: [`__session_MqCvchyS=${mockJwt}; Path=/; Secure; SameSite=Lax`],
 }));

 await authenticateRequest(
 mockRequestWithCookies(
 {
 ...defaultHeaders,
 origin: 'https://example.com',
 },
 // client_uat is missing, need to handshake not to refresh
 { __session: mockJwt, __refresh_MqCvchyS: 'can_be_anything' },
 ),
 mockOptions({
 secretKey: 'test_deadbeef',
 publishableKey: PK_LIVE,
 apiClient: { sessions: { refreshSession } },
 }),
 );

 expect(refreshSession).not.toHaveBeenCalled();
 });

 expect(requestState).toBeSignedIn();
 expect(requestState.toAuth()).toBeSignedInToAuth();
 expect(refreshSession).toHaveBeenCalled();
 test('uses suffixed refresh cookie even if un-suffixed is present', async () => {
 server.use(
 http.get('https://api.clerk.test/v1/jwks', () => {
 return HttpResponse.json(mockJwks);
 }),
 );

 // return cookies from endpoint
 const refreshSession = vi.fn(() => ({
 object: 'cookies',
 cookies: [`__session_MqCvchyS=${mockJwt}; Path=/; Secure; SameSite=Lax`],
 }));

 const requestState = await authenticateRequest(
 mockRequestWithCookies(
 {
 ...defaultHeaders,
 origin: 'https://example.com',
 },
 {
 __client_uat: `12345`,
 __session: mockExpiredJwt,
 __refresh_MqCvchyS: 'can_be_anything',
 __refresh: 'should_not_be_used',
 },
 ),
 mockOptions({
 secretKey: 'test_deadbeef',
 publishableKey: PK_LIVE,
 apiClient: { sessions: { refreshSession } },
 }),
 );

 expect(requestState).toBeSignedIn();
 expect(requestState.toAuth()).toBeSignedInToAuth();
 expect(requestState.headers.getSetCookie()).toContain(
 `__session_MqCvchyS=${mockJwt}; Path=/; Secure; SameSite=Lax`,
 );
 expect(refreshSession).toHaveBeenCalled();
 });
 });
});
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('^' + ".*" + '
feat(backend): Set cookies from the refresh token flow by brkalow · Pull Request #4884 · clerk/javascript · GitHub
Skip to content
feat(backend): Set cookies from the refresh token flow#4884

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

brkalow
merged 5 commits into

from

Jan 15, 2025
 Merged


feat(backend): Set cookies from the refresh token flow
#4884
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


5 commits


Select commit
Hold shift + click to select a range
2e9888f

Set cookies from the refresh token flow


brkalow Jan 13, 2025
9bd2134

Use proper format values, and pass in body instead of query parmeter


brkalow Jan 13, 2025
1f755ae

Adds missing file


brkalow Jan 13, 2025
19d2ada

Adds changeset


brkalow Jan 14, 2025
3998837

Update packages/backend/src/api/endpoints/SessionApi.ts


brkalow Jan 15, 2025

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/good-eggs-retire.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/backend': minor
---

`authenticateRequest()` will now set a refreshsed session cookie on the response when an expired session token is refreshed via the Clerk API.

14 changes: 11 additions & 3 deletions
packages/backend/src/api/endpoints/SessionApi.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
import type { ClerkPaginationRequest, SessionStatus } from '@clerk/types';

import { joinPaths } from '../../util/path';
import type { Cookies } from '../resources/Cookies';
import type { PaginatedResourceResponse } from '../resources/Deserializer';
import type { Session } from '../resources/Session';
import type { Token } from '../resources/Token';
Expand All@@ -20,6 +21,8 @@ type RefreshTokenParams = {
 request_origin: string;
 request_originating_ip?: string;
 request_headers?: Record<string, string[]>;
 suffixed_cookies?: boolean;
 format?: 'token' | 'cookie';
};

export class SessionAPI extends AbstractAPI {
Expand DownExpand Up@@ -64,12 +67,17 @@ export class SessionAPI extends AbstractAPI {
 });
 }

 public async refreshSession(sessionId: string, params: RefreshTokenParams) {
 public async refreshSession(sessionId: string, params: RefreshTokenParams & { format: 'token' }): Promise<Token>;
 public async refreshSession(sessionId: string, params: RefreshTokenParams & { format: 'cookie' }): Promise<Cookies>;
 public async refreshSession(sessionId: string, params: RefreshTokenParams): Promise<Token>;
 public async refreshSession(sessionId: string, params: RefreshTokenParams): Promise<Token | Cookies> {
 this.requireId(sessionId);
 return this.request<Token>({
 const { suffixed_cookies, ...restParams } = params;
 return this.request({
 method: 'POST',
 path: joinPaths(basePath, sessionId, 'refresh'),
 bodyParams: params,
 bodyParams: restParams,
 queryParams: { suffixed_cookies },
 });
 }
}

9 changes: 9 additions & 0 deletions
packages/backend/src/api/resources/Cookies.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
import type { CookiesJSON } from './JSON';

export class Cookies {
 constructor(readonly cookies: string[]) {}

 static fromJSON(data: CookiesJSON): Cookies {
 return new Cookies(data.cookies);
 }
}

3 changes: 3 additions & 0 deletions
packages/backend/src/api/resources/Deserializer.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
import {
 AllowlistIdentifier,
 Client,
 Cookies,
 DeletedObject,
 Email,
 EmailAddress,
Expand DownExpand Up@@ -72,6 +73,8 @@ function jsonToObject(item: any): any {
 return AllowlistIdentifier.fromJSON(item);
 case ObjectType.Client:
 return Client.fromJSON(item);
 case ObjectType.Cookies:
 return Cookies.fromJSON(item);
 case ObjectType.EmailAddress:
 return EmailAddress.fromJSON(item);
 case ObjectType.Email:
Expand Down

6 changes: 6 additions & 0 deletions
packages/backend/src/api/resources/JSON.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,6 +10,7 @@ export const ObjectType = {
 AccountlessApplication: 'accountless_application',
 AllowlistIdentifier: 'allowlist_identifier',
 Client: 'client',
 Cookies: 'cookies',
 Email: 'email',
 EmailAddress: 'email_address',
 ExternalAccount: 'external_account',
Expand DownExpand Up@@ -44,6 +45,11 @@ export interface ClerkResourceJSON {
 id: string;
}

export interface CookiesJSON {
 object: typeof ObjectType.Cookies;
 cookies: string[];
}

export interface TokenJSON {
 object: typeof ObjectType.Token;
 jwt: string;
Expand Down

1 change: 1 addition & 0 deletions
packages/backend/src/api/resources/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
export * from './AccountlessApplication';
export * from './AllowlistIdentifier';
export * from './Client';
export * from './Cookies';
export * from './DeletedObject';
export * from './Email';
export * from './EmailAddress';
Expand Down

252 changes: 130 additions & 122 deletions
packages/backend/src/tokens/__tests__/request.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -972,130 +972,138 @@ describe('tokens.authenticateRequest(options)', () => {
 expect(requestState.toAuth()).toBeSignedInToAuth();
 });

 test('refreshToken: returns signed in with valid refresh token cookie if token is expired and refresh token exists', async () => {
 server.use(
 http.get('https://api.clerk.test/v1/jwks', () => {
 return HttpResponse.json(mockJwks);
 }),
 );

 // return cookies from endpoint
 const refreshSession = vi.fn(() => ({
 object: 'token',
 jwt: mockJwt,
 }));

 const requestState = await authenticateRequest(
 mockRequestWithCookies(
 {
 ...defaultHeaders,
 origin: 'https://example.com',
 },
 { __client_uat: `12345`, __session: mockExpiredJwt, __refresh_MqCvchyS: 'can_be_anything' },
 ),
 mockOptions({
 secretKey: 'test_deadbeef',
 publishableKey: PK_LIVE,
 apiClient: { sessions: { refreshSession } },
 }),
 );

 expect(requestState).toBeSignedIn();
 expect(requestState.toAuth()).toBeSignedInToAuth();
 expect(refreshSession).toHaveBeenCalled();
 });

 test('refreshToken: does not try to refresh if refresh token does not exist', async () => {
 server.use(
 http.get('https://api.clerk.test/v1/jwks', () => {
 return HttpResponse.json(mockJwks);
 }),
 );

 // return cookies from endpoint
 const refreshSession = vi.fn(() => ({
 object: 'token',
 jwt: mockJwt,
 }));

 await authenticateRequest(
 mockRequestWithCookies(
 {
 ...defaultHeaders,
 origin: 'https://example.com',
 },
 { __client_uat: `12345`, __session: mockExpiredJwt },
 ),
 mockOptions({
 secretKey: 'test_deadbeef',
 publishableKey: PK_LIVE,
 apiClient: { sessions: { refreshSession } },
 }),
 );
 expect(refreshSession).not.toHaveBeenCalled();
 });

 test('refreshToken: does not try to refresh if refresh exists but token is not expired', async () => {
 // return cookies from endpoint
 const refreshSession = vi.fn(() => ({
 object: 'token',
 jwt: mockJwt,
 }));

 await authenticateRequest(
 mockRequestWithCookies(
 {
 ...defaultHeaders,
 origin: 'https://example.com',
 },
 // client_uat is missing, need to handshake not to refresh
 { __session: mockJwt, __refresh_MqCvchyS: 'can_be_anything' },
 ),
 mockOptions({
 secretKey: 'test_deadbeef',
 publishableKey: PK_LIVE,
 apiClient: { sessions: { refreshSession } },
 }),
 );

 expect(refreshSession).not.toHaveBeenCalled();
 });

 test('refreshToken: uses suffixed refresh cookie even if un-suffixed is present', async () => {
 server.use(
 http.get('https://api.clerk.test/v1/jwks', () => {
 return HttpResponse.json(mockJwks);
 }),
 );
 describe('refreshToken', async () => {
@brkalowbrkalowJan 14, 2025

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

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

I moved these tests into a separate describe block, consider looking at the diff without whitespace to see the actual changes: https://github.com/clerk/javascript/pull/4884/files?w=1
 test('returns signed in with valid refresh token cookie if token is expired and refresh token exists', async () => {
 server.use(
 http.get('https://api.clerk.test/v1/jwks', () => {
 return HttpResponse.json(mockJwks);
 }),
 );

 // return cookies from endpoint
 const refreshSession = vi.fn(() => ({
 object: 'cookies',
 cookies: [`__session_MqCvchyS=${mockJwt}; Path=/; Secure; SameSite=Lax`],
 }));

 const requestState = await authenticateRequest(
 mockRequestWithCookies(
 {
 ...defaultHeaders,
 origin: 'https://example.com',
 },
 { __client_uat: `12345`, __session: mockExpiredJwt, __refresh_MqCvchyS: 'can_be_anything' },
 ),
 mockOptions({
 secretKey: 'test_deadbeef',
 publishableKey: PK_LIVE,
 apiClient: { sessions: { refreshSession } },
 }),
 );

 expect(requestState).toBeSignedIn();
 expect(requestState.toAuth()).toBeSignedInToAuth();
 expect(requestState.headers.getSetCookie()).toContain(
 `__session_MqCvchyS=${mockJwt}; Path=/; Secure; SameSite=Lax`,
 );
 expect(refreshSession).toHaveBeenCalled();
 });

 // return cookies from endpoint
 const refreshSession = vi.fn(() => ({
 object: 'token',
 jwt: mockJwt,
 }));
 test('does not try to refresh if refresh token does not exist', async () => {
 server.use(
 http.get('https://api.clerk.test/v1/jwks', () => {
 return HttpResponse.json(mockJwks);
 }),
 );

 // return cookies from endpoint
 const refreshSession = vi.fn(() => ({
 object: 'cookies',
 cookies: [`__session_MqCvchyS=${mockJwt}; Path=/; Secure; SameSite=Lax`],
 }));

 await authenticateRequest(
 mockRequestWithCookies(
 {
 ...defaultHeaders,
 origin: 'https://example.com',
 },
 { __client_uat: `12345`, __session: mockExpiredJwt },
 ),
 mockOptions({
 secretKey: 'test_deadbeef',
 publishableKey: PK_LIVE,
 apiClient: { sessions: { refreshSession } },
 }),
 );
 expect(refreshSession).not.toHaveBeenCalled();
 });

 const requestState = await authenticateRequest(
 mockRequestWithCookies(
 {
 ...defaultHeaders,
 origin: 'https://example.com',
 },
 {
 __client_uat: `12345`,
 __session: mockExpiredJwt,
 __refresh_MqCvchyS: 'can_be_anything',
 __refresh: 'should_not_be_used',
 },
 ),
 mockOptions({
 secretKey: 'test_deadbeef',
 publishableKey: PK_LIVE,
 apiClient: { sessions: { refreshSession } },
 }),
 );
 test('does not try to refresh if refresh exists but token is not expired', async () => {
 // return cookies from endpoint
 const refreshSession = vi.fn(() => ({
 object: 'cookies',
 cookies: [`__session_MqCvchyS=${mockJwt}; Path=/; Secure; SameSite=Lax`],
 }));

 await authenticateRequest(
 mockRequestWithCookies(
 {
 ...defaultHeaders,
 origin: 'https://example.com',
 },
 // client_uat is missing, need to handshake not to refresh
 { __session: mockJwt, __refresh_MqCvchyS: 'can_be_anything' },
 ),
 mockOptions({
 secretKey: 'test_deadbeef',
 publishableKey: PK_LIVE,
 apiClient: { sessions: { refreshSession } },
 }),
 );

 expect(refreshSession).not.toHaveBeenCalled();
 });

 expect(requestState).toBeSignedIn();
 expect(requestState.toAuth()).toBeSignedInToAuth();
 expect(refreshSession).toHaveBeenCalled();
 test('uses suffixed refresh cookie even if un-suffixed is present', async () => {
 server.use(
 http.get('https://api.clerk.test/v1/jwks', () => {
 return HttpResponse.json(mockJwks);
 }),
 );

 // return cookies from endpoint
 const refreshSession = vi.fn(() => ({
 object: 'cookies',
 cookies: [`__session_MqCvchyS=${mockJwt}; Path=/; Secure; SameSite=Lax`],
 }));

 const requestState = await authenticateRequest(
 mockRequestWithCookies(
 {
 ...defaultHeaders,
 origin: 'https://example.com',
 },
 {
 __client_uat: `12345`,
 __session: mockExpiredJwt,
 __refresh_MqCvchyS: 'can_be_anything',
 __refresh: 'should_not_be_used',
 },
 ),
 mockOptions({
 secretKey: 'test_deadbeef',
 publishableKey: PK_LIVE,
 apiClient: { sessions: { refreshSession } },
 }),
 );

 expect(requestState).toBeSignedIn();
 expect(requestState.toAuth()).toBeSignedInToAuth();
 expect(requestState.headers.getSetCookie()).toContain(
 `__session_MqCvchyS=${mockJwt}; Path=/; Secure; SameSite=Lax`,
 );
 expect(refreshSession).toHaveBeenCalled();
 });
 });
});
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('^' + ".*" + '
feat(backend): Set cookies from the refresh token flow by brkalow · Pull Request #4884 · clerk/javascript · GitHub
Skip to content
feat(backend): Set cookies from the refresh token flow#4884

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

brkalow
merged 5 commits into

from

Jan 15, 2025
 Merged


feat(backend): Set cookies from the refresh token flow
#4884
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


5 commits


Select commit
Hold shift + click to select a range
2e9888f

Set cookies from the refresh token flow


brkalow Jan 13, 2025
9bd2134

Use proper format values, and pass in body instead of query parmeter


brkalow Jan 13, 2025
1f755ae

Adds missing file


brkalow Jan 13, 2025
19d2ada

Adds changeset


brkalow Jan 14, 2025
3998837

Update packages/backend/src/api/endpoints/SessionApi.ts


brkalow Jan 15, 2025

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/good-eggs-retire.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/backend': minor
---

`authenticateRequest()` will now set a refreshsed session cookie on the response when an expired session token is refreshed via the Clerk API.

14 changes: 11 additions & 3 deletions
packages/backend/src/api/endpoints/SessionApi.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
import type { ClerkPaginationRequest, SessionStatus } from '@clerk/types';

import { joinPaths } from '../../util/path';
import type { Cookies } from '../resources/Cookies';
import type { PaginatedResourceResponse } from '../resources/Deserializer';
import type { Session } from '../resources/Session';
import type { Token } from '../resources/Token';
Expand All@@ -20,6 +21,8 @@ type RefreshTokenParams = {
 request_origin: string;
 request_originating_ip?: string;
 request_headers?: Record<string, string[]>;
 suffixed_cookies?: boolean;
 format?: 'token' | 'cookie';
};

export class SessionAPI extends AbstractAPI {
Expand DownExpand Up@@ -64,12 +67,17 @@ export class SessionAPI extends AbstractAPI {
 });
 }

 public async refreshSession(sessionId: string, params: RefreshTokenParams) {
 public async refreshSession(sessionId: string, params: RefreshTokenParams & { format: 'token' }): Promise<Token>;
 public async refreshSession(sessionId: string, params: RefreshTokenParams & { format: 'cookie' }): Promise<Cookies>;
 public async refreshSession(sessionId: string, params: RefreshTokenParams): Promise<Token>;
 public async refreshSession(sessionId: string, params: RefreshTokenParams): Promise<Token | Cookies> {
 this.requireId(sessionId);
 return this.request<Token>({
 const { suffixed_cookies, ...restParams } = params;
 return this.request({
 method: 'POST',
 path: joinPaths(basePath, sessionId, 'refresh'),
 bodyParams: params,
 bodyParams: restParams,
 queryParams: { suffixed_cookies },
 });
 }
}

9 changes: 9 additions & 0 deletions
packages/backend/src/api/resources/Cookies.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
import type { CookiesJSON } from './JSON';

export class Cookies {
 constructor(readonly cookies: string[]) {}

 static fromJSON(data: CookiesJSON): Cookies {
 return new Cookies(data.cookies);
 }
}

3 changes: 3 additions & 0 deletions
packages/backend/src/api/resources/Deserializer.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
import {
 AllowlistIdentifier,
 Client,
 Cookies,
 DeletedObject,
 Email,
 EmailAddress,
Expand DownExpand Up@@ -72,6 +73,8 @@ function jsonToObject(item: any): any {
 return AllowlistIdentifier.fromJSON(item);
 case ObjectType.Client:
 return Client.fromJSON(item);
 case ObjectType.Cookies:
 return Cookies.fromJSON(item);
 case ObjectType.EmailAddress:
 return EmailAddress.fromJSON(item);
 case ObjectType.Email:
Expand Down

6 changes: 6 additions & 0 deletions
packages/backend/src/api/resources/JSON.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,6 +10,7 @@ export const ObjectType = {
 AccountlessApplication: 'accountless_application',
 AllowlistIdentifier: 'allowlist_identifier',
 Client: 'client',
 Cookies: 'cookies',
 Email: 'email',
 EmailAddress: 'email_address',
 ExternalAccount: 'external_account',
Expand DownExpand Up@@ -44,6 +45,11 @@ export interface ClerkResourceJSON {
 id: string;
}

export interface CookiesJSON {
 object: typeof ObjectType.Cookies;
 cookies: string[];
}

export interface TokenJSON {
 object: typeof ObjectType.Token;
 jwt: string;
Expand Down

1 change: 1 addition & 0 deletions
packages/backend/src/api/resources/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
export * from './AccountlessApplication';
export * from './AllowlistIdentifier';
export * from './Client';
export * from './Cookies';
export * from './DeletedObject';
export * from './Email';
export * from './EmailAddress';
Expand Down

252 changes: 130 additions & 122 deletions
packages/backend/src/tokens/__tests__/request.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -972,130 +972,138 @@ describe('tokens.authenticateRequest(options)', () => {
 expect(requestState.toAuth()).toBeSignedInToAuth();
 });

 test('refreshToken: returns signed in with valid refresh token cookie if token is expired and refresh token exists', async () => {
 server.use(
 http.get('https://api.clerk.test/v1/jwks', () => {
 return HttpResponse.json(mockJwks);
 }),
 );

 // return cookies from endpoint
 const refreshSession = vi.fn(() => ({
 object: 'token',
 jwt: mockJwt,
 }));

 const requestState = await authenticateRequest(
 mockRequestWithCookies(
 {
 ...defaultHeaders,
 origin: 'https://example.com',
 },
 { __client_uat: `12345`, __session: mockExpiredJwt, __refresh_MqCvchyS: 'can_be_anything' },
 ),
 mockOptions({
 secretKey: 'test_deadbeef',
 publishableKey: PK_LIVE,
 apiClient: { sessions: { refreshSession } },
 }),
 );

 expect(requestState).toBeSignedIn();
 expect(requestState.toAuth()).toBeSignedInToAuth();
 expect(refreshSession).toHaveBeenCalled();
 });

 test('refreshToken: does not try to refresh if refresh token does not exist', async () => {
 server.use(
 http.get('https://api.clerk.test/v1/jwks', () => {
 return HttpResponse.json(mockJwks);
 }),
 );

 // return cookies from endpoint
 const refreshSession = vi.fn(() => ({
 object: 'token',
 jwt: mockJwt,
 }));

 await authenticateRequest(
 mockRequestWithCookies(
 {
 ...defaultHeaders,
 origin: 'https://example.com',
 },
 { __client_uat: `12345`, __session: mockExpiredJwt },
 ),
 mockOptions({
 secretKey: 'test_deadbeef',
 publishableKey: PK_LIVE,
 apiClient: { sessions: { refreshSession } },
 }),
 );
 expect(refreshSession).not.toHaveBeenCalled();
 });

 test('refreshToken: does not try to refresh if refresh exists but token is not expired', async () => {
 // return cookies from endpoint
 const refreshSession = vi.fn(() => ({
 object: 'token',
 jwt: mockJwt,
 }));

 await authenticateRequest(
 mockRequestWithCookies(
 {
 ...defaultHeaders,
 origin: 'https://example.com',
 },
 // client_uat is missing, need to handshake not to refresh
 { __session: mockJwt, __refresh_MqCvchyS: 'can_be_anything' },
 ),
 mockOptions({
 secretKey: 'test_deadbeef',
 publishableKey: PK_LIVE,
 apiClient: { sessions: { refreshSession } },
 }),
 );

 expect(refreshSession).not.toHaveBeenCalled();
 });

 test('refreshToken: uses suffixed refresh cookie even if un-suffixed is present', async () => {
 server.use(
 http.get('https://api.clerk.test/v1/jwks', () => {
 return HttpResponse.json(mockJwks);
 }),
 );
 describe('refreshToken', async () => {
@brkalowbrkalowJan 14, 2025

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

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

I moved these tests into a separate describe block, consider looking at the diff without whitespace to see the actual changes: https://github.com/clerk/javascript/pull/4884/files?w=1
 test('returns signed in with valid refresh token cookie if token is expired and refresh token exists', async () => {
 server.use(
 http.get('https://api.clerk.test/v1/jwks', () => {
 return HttpResponse.json(mockJwks);
 }),
 );

 // return cookies from endpoint
 const refreshSession = vi.fn(() => ({
 object: 'cookies',
 cookies: [`__session_MqCvchyS=${mockJwt}; Path=/; Secure; SameSite=Lax`],
 }));

 const requestState = await authenticateRequest(
 mockRequestWithCookies(
 {
 ...defaultHeaders,
 origin: 'https://example.com',
 },
 { __client_uat: `12345`, __session: mockExpiredJwt, __refresh_MqCvchyS: 'can_be_anything' },
 ),
 mockOptions({
 secretKey: 'test_deadbeef',
 publishableKey: PK_LIVE,
 apiClient: { sessions: { refreshSession } },
 }),
 );

 expect(requestState).toBeSignedIn();
 expect(requestState.toAuth()).toBeSignedInToAuth();
 expect(requestState.headers.getSetCookie()).toContain(
 `__session_MqCvchyS=${mockJwt}; Path=/; Secure; SameSite=Lax`,
 );
 expect(refreshSession).toHaveBeenCalled();
 });

 // return cookies from endpoint
 const refreshSession = vi.fn(() => ({
 object: 'token',
 jwt: mockJwt,
 }));
 test('does not try to refresh if refresh token does not exist', async () => {
 server.use(
 http.get('https://api.clerk.test/v1/jwks', () => {
 return HttpResponse.json(mockJwks);
 }),
 );

 // return cookies from endpoint
 const refreshSession = vi.fn(() => ({
 object: 'cookies',
 cookies: [`__session_MqCvchyS=${mockJwt}; Path=/; Secure; SameSite=Lax`],
 }));

 await authenticateRequest(
 mockRequestWithCookies(
 {
 ...defaultHeaders,
 origin: 'https://example.com',
 },
 { __client_uat: `12345`, __session: mockExpiredJwt },
 ),
 mockOptions({
 secretKey: 'test_deadbeef',
 publishableKey: PK_LIVE,
 apiClient: { sessions: { refreshSession } },
 }),
 );
 expect(refreshSession).not.toHaveBeenCalled();
 });

 const requestState = await authenticateRequest(
 mockRequestWithCookies(
 {
 ...defaultHeaders,
 origin: 'https://example.com',
 },
 {
 __client_uat: `12345`,
 __session: mockExpiredJwt,
 __refresh_MqCvchyS: 'can_be_anything',
 __refresh: 'should_not_be_used',
 },
 ),
 mockOptions({
 secretKey: 'test_deadbeef',
 publishableKey: PK_LIVE,
 apiClient: { sessions: { refreshSession } },
 }),
 );
 test('does not try to refresh if refresh exists but token is not expired', async () => {
 // return cookies from endpoint
 const refreshSession = vi.fn(() => ({
 object: 'cookies',
 cookies: [`__session_MqCvchyS=${mockJwt}; Path=/; Secure; SameSite=Lax`],
 }));

 await authenticateRequest(
 mockRequestWithCookies(
 {
 ...defaultHeaders,
 origin: 'https://example.com',
 },
 // client_uat is missing, need to handshake not to refresh
 { __session: mockJwt, __refresh_MqCvchyS: 'can_be_anything' },
 ),
 mockOptions({
 secretKey: 'test_deadbeef',
 publishableKey: PK_LIVE,
 apiClient: { sessions: { refreshSession } },
 }),
 );

 expect(refreshSession).not.toHaveBeenCalled();
 });

 expect(requestState).toBeSignedIn();
 expect(requestState.toAuth()).toBeSignedInToAuth();
 expect(refreshSession).toHaveBeenCalled();
 test('uses suffixed refresh cookie even if un-suffixed is present', async () => {
 server.use(
 http.get('https://api.clerk.test/v1/jwks', () => {
 return HttpResponse.json(mockJwks);
 }),
 );

 // return cookies from endpoint
 const refreshSession = vi.fn(() => ({
 object: 'cookies',
 cookies: [`__session_MqCvchyS=${mockJwt}; Path=/; Secure; SameSite=Lax`],
 }));

 const requestState = await authenticateRequest(
 mockRequestWithCookies(
 {
 ...defaultHeaders,
 origin: 'https://example.com',
 },
 {
 __client_uat: `12345`,
 __session: mockExpiredJwt,
 __refresh_MqCvchyS: 'can_be_anything',
 __refresh: 'should_not_be_used',
 },
 ),
 mockOptions({
 secretKey: 'test_deadbeef',
 publishableKey: PK_LIVE,
 apiClient: { sessions: { refreshSession } },
 }),
 );

 expect(requestState).toBeSignedIn();
 expect(requestState.toAuth()).toBeSignedInToAuth();
 expect(requestState.headers.getSetCookie()).toContain(
 `__session_MqCvchyS=${mockJwt}; Path=/; Secure; SameSite=Lax`,
 );
 expect(refreshSession).toHaveBeenCalled();
 });
 });
});
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); }
})();
})();
feat(backend): Set cookies from the refresh token flow by brkalow · Pull Request #4884 · clerk/javascript · GitHub
Skip to content
feat(backend): Set cookies from the refresh token flow#4884

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

brkalow
merged 5 commits into

from

Jan 15, 2025
 Merged


feat(backend): Set cookies from the refresh token flow
#4884
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


5 commits


Select commit
Hold shift + click to select a range
2e9888f

Set cookies from the refresh token flow


brkalow Jan 13, 2025
9bd2134

Use proper format values, and pass in body instead of query parmeter


brkalow Jan 13, 2025
1f755ae

Adds missing file


brkalow Jan 13, 2025
19d2ada

Adds changeset


brkalow Jan 14, 2025
3998837

Update packages/backend/src/api/endpoints/SessionApi.ts


brkalow Jan 15, 2025

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/good-eggs-retire.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/backend': minor
---

`authenticateRequest()` will now set a refreshsed session cookie on the response when an expired session token is refreshed via the Clerk API.

14 changes: 11 additions & 3 deletions
packages/backend/src/api/endpoints/SessionApi.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
import type { ClerkPaginationRequest, SessionStatus } from '@clerk/types';

import { joinPaths } from '../../util/path';
import type { Cookies } from '../resources/Cookies';
import type { PaginatedResourceResponse } from '../resources/Deserializer';
import type { Session } from '../resources/Session';
import type { Token } from '../resources/Token';
Expand All@@ -20,6 +21,8 @@ type RefreshTokenParams = {
 request_origin: string;
 request_originating_ip?: string;
 request_headers?: Record<string, string[]>;
 suffixed_cookies?: boolean;
 format?: 'token' | 'cookie';
};

export class SessionAPI extends AbstractAPI {
Expand DownExpand Up@@ -64,12 +67,17 @@ export class SessionAPI extends AbstractAPI {
 });
 }

 public async refreshSession(sessionId: string, params: RefreshTokenParams) {
 public async refreshSession(sessionId: string, params: RefreshTokenParams & { format: 'token' }): Promise<Token>;
 public async refreshSession(sessionId: string, params: RefreshTokenParams & { format: 'cookie' }): Promise<Cookies>;
 public async refreshSession(sessionId: string, params: RefreshTokenParams): Promise<Token>;
 public async refreshSession(sessionId: string, params: RefreshTokenParams): Promise<Token | Cookies> {
 this.requireId(sessionId);
 return this.request<Token>({
 const { suffixed_cookies, ...restParams } = params;
 return this.request({
 method: 'POST',
 path: joinPaths(basePath, sessionId, 'refresh'),
 bodyParams: params,
 bodyParams: restParams,
 queryParams: { suffixed_cookies },
 });
 }
}

9 changes: 9 additions & 0 deletions
packages/backend/src/api/resources/Cookies.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
import type { CookiesJSON } from './JSON';

export class Cookies {
 constructor(readonly cookies: string[]) {}

 static fromJSON(data: CookiesJSON): Cookies {
 return new Cookies(data.cookies);
 }
}

3 changes: 3 additions & 0 deletions
packages/backend/src/api/resources/Deserializer.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
import {
 AllowlistIdentifier,
 Client,
 Cookies,
 DeletedObject,
 Email,
 EmailAddress,
Expand DownExpand Up@@ -72,6 +73,8 @@ function jsonToObject(item: any): any {
 return AllowlistIdentifier.fromJSON(item);
 case ObjectType.Client:
 return Client.fromJSON(item);
 case ObjectType.Cookies:
 return Cookies.fromJSON(item);
 case ObjectType.EmailAddress:
 return EmailAddress.fromJSON(item);
 case ObjectType.Email:
Expand Down

6 changes: 6 additions & 0 deletions
packages/backend/src/api/resources/JSON.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,6 +10,7 @@ export const ObjectType = {
 AccountlessApplication: 'accountless_application',
 AllowlistIdentifier: 'allowlist_identifier',
 Client: 'client',
 Cookies: 'cookies',
 Email: 'email',
 EmailAddress: 'email_address',
 ExternalAccount: 'external_account',
Expand DownExpand Up@@ -44,6 +45,11 @@ export interface ClerkResourceJSON {
 id: string;
}

export interface CookiesJSON {
 object: typeof ObjectType.Cookies;
 cookies: string[];
}

export interface TokenJSON {
 object: typeof ObjectType.Token;
 jwt: string;
Expand Down

1 change: 1 addition & 0 deletions
packages/backend/src/api/resources/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
export * from './AccountlessApplication';
export * from './AllowlistIdentifier';
export * from './Client';
export * from './Cookies';
export * from './DeletedObject';
export * from './Email';
export * from './EmailAddress';
Expand Down

252 changes: 130 additions & 122 deletions
packages/backend/src/tokens/__tests__/request.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -972,130 +972,138 @@ describe('tokens.authenticateRequest(options)', () => {
 expect(requestState.toAuth()).toBeSignedInToAuth();
 });

 test('refreshToken: returns signed in with valid refresh token cookie if token is expired and refresh token exists', async () => {
 server.use(
 http.get('https://api.clerk.test/v1/jwks', () => {
 return HttpResponse.json(mockJwks);
 }),
 );

 // return cookies from endpoint
 const refreshSession = vi.fn(() => ({
 object: 'token',
 jwt: mockJwt,
 }));

 const requestState = await authenticateRequest(
 mockRequestWithCookies(
 {
 ...defaultHeaders,
 origin: 'https://example.com',
 },
 { __client_uat: `12345`, __session: mockExpiredJwt, __refresh_MqCvchyS: 'can_be_anything' },
 ),
 mockOptions({
 secretKey: 'test_deadbeef',
 publishableKey: PK_LIVE,
 apiClient: { sessions: { refreshSession } },
 }),
 );

 expect(requestState).toBeSignedIn();
 expect(requestState.toAuth()).toBeSignedInToAuth();
 expect(refreshSession).toHaveBeenCalled();
 });

 test('refreshToken: does not try to refresh if refresh token does not exist', async () => {
 server.use(
 http.get('https://api.clerk.test/v1/jwks', () => {
 return HttpResponse.json(mockJwks);
 }),
 );

 // return cookies from endpoint
 const refreshSession = vi.fn(() => ({
 object: 'token',
 jwt: mockJwt,
 }));

 await authenticateRequest(
 mockRequestWithCookies(
 {
 ...defaultHeaders,
 origin: 'https://example.com',
 },
 { __client_uat: `12345`, __session: mockExpiredJwt },
 ),
 mockOptions({
 secretKey: 'test_deadbeef',
 publishableKey: PK_LIVE,
 apiClient: { sessions: { refreshSession } },
 }),
 );
 expect(refreshSession).not.toHaveBeenCalled();
 });

 test('refreshToken: does not try to refresh if refresh exists but token is not expired', async () => {
 // return cookies from endpoint
 const refreshSession = vi.fn(() => ({
 object: 'token',
 jwt: mockJwt,
 }));

 await authenticateRequest(
 mockRequestWithCookies(
 {
 ...defaultHeaders,
 origin: 'https://example.com',
 },
 // client_uat is missing, need to handshake not to refresh
 { __session: mockJwt, __refresh_MqCvchyS: 'can_be_anything' },
 ),
 mockOptions({
 secretKey: 'test_deadbeef',
 publishableKey: PK_LIVE,
 apiClient: { sessions: { refreshSession } },
 }),
 );

 expect(refreshSession).not.toHaveBeenCalled();
 });

 test('refreshToken: uses suffixed refresh cookie even if un-suffixed is present', async () => {
 server.use(
 http.get('https://api.clerk.test/v1/jwks', () => {
 return HttpResponse.json(mockJwks);
 }),
 );
 describe('refreshToken', async () => {
@brkalowbrkalowJan 14, 2025

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

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

I moved these tests into a separate describe block, consider looking at the diff without whitespace to see the actual changes: https://github.com/clerk/javascript/pull/4884/files?w=1
 test('returns signed in with valid refresh token cookie if token is expired and refresh token exists', async () => {
 server.use(
 http.get('https://api.clerk.test/v1/jwks', () => {
 return HttpResponse.json(mockJwks);
 }),
 );

 // return cookies from endpoint
 const refreshSession = vi.fn(() => ({
 object: 'cookies',
 cookies: [`__session_MqCvchyS=${mockJwt}; Path=/; Secure; SameSite=Lax`],
 }));

 const requestState = await authenticateRequest(
 mockRequestWithCookies(
 {
 ...defaultHeaders,
 origin: 'https://example.com',
 },
 { __client_uat: `12345`, __session: mockExpiredJwt, __refresh_MqCvchyS: 'can_be_anything' },
 ),
 mockOptions({
 secretKey: 'test_deadbeef',
 publishableKey: PK_LIVE,
 apiClient: { sessions: { refreshSession } },
 }),
 );

 expect(requestState).toBeSignedIn();
 expect(requestState.toAuth()).toBeSignedInToAuth();
 expect(requestState.headers.getSetCookie()).toContain(
 `__session_MqCvchyS=${mockJwt}; Path=/; Secure; SameSite=Lax`,
 );
 expect(refreshSession).toHaveBeenCalled();
 });

 // return cookies from endpoint
 const refreshSession = vi.fn(() => ({
 object: 'token',
 jwt: mockJwt,
 }));
 test('does not try to refresh if refresh token does not exist', async () => {
 server.use(
 http.get('https://api.clerk.test/v1/jwks', () => {
 return HttpResponse.json(mockJwks);
 }),
 );

 // return cookies from endpoint
 const refreshSession = vi.fn(() => ({
 object: 'cookies',
 cookies: [`__session_MqCvchyS=${mockJwt}; Path=/; Secure; SameSite=Lax`],
 }));

 await authenticateRequest(
 mockRequestWithCookies(
 {
 ...defaultHeaders,
 origin: 'https://example.com',
 },
 { __client_uat: `12345`, __session: mockExpiredJwt },
 ),
 mockOptions({
 secretKey: 'test_deadbeef',
 publishableKey: PK_LIVE,
 apiClient: { sessions: { refreshSession } },
 }),
 );
 expect(refreshSession).not.toHaveBeenCalled();
 });

 const requestState = await authenticateRequest(
 mockRequestWithCookies(
 {
 ...defaultHeaders,
 origin: 'https://example.com',
 },
 {
 __client_uat: `12345`,
 __session: mockExpiredJwt,
 __refresh_MqCvchyS: 'can_be_anything',
 __refresh: 'should_not_be_used',
 },
 ),
 mockOptions({
 secretKey: 'test_deadbeef',
 publishableKey: PK_LIVE,
 apiClient: { sessions: { refreshSession } },
 }),
 );
 test('does not try to refresh if refresh exists but token is not expired', async () => {
 // return cookies from endpoint
 const refreshSession = vi.fn(() => ({
 object: 'cookies',
 cookies: [`__session_MqCvchyS=${mockJwt}; Path=/; Secure; SameSite=Lax`],
 }));

 await authenticateRequest(
 mockRequestWithCookies(
 {
 ...defaultHeaders,
 origin: 'https://example.com',
 },
 // client_uat is missing, need to handshake not to refresh
 { __session: mockJwt, __refresh_MqCvchyS: 'can_be_anything' },
 ),
 mockOptions({
 secretKey: 'test_deadbeef',
 publishableKey: PK_LIVE,
 apiClient: { sessions: { refreshSession } },
 }),
 );

 expect(refreshSession).not.toHaveBeenCalled();
 });

 expect(requestState).toBeSignedIn();
 expect(requestState.toAuth()).toBeSignedInToAuth();
 expect(refreshSession).toHaveBeenCalled();
 test('uses suffixed refresh cookie even if un-suffixed is present', async () => {
 server.use(
 http.get('https://api.clerk.test/v1/jwks', () => {
 return HttpResponse.json(mockJwks);
 }),
 );

 // return cookies from endpoint
 const refreshSession = vi.fn(() => ({
 object: 'cookies',
 cookies: [`__session_MqCvchyS=${mockJwt}; Path=/; Secure; SameSite=Lax`],
 }));

 const requestState = await authenticateRequest(
 mockRequestWithCookies(
 {
 ...defaultHeaders,
 origin: 'https://example.com',
 },
 {
 __client_uat: `12345`,
 __session: mockExpiredJwt,
 __refresh_MqCvchyS: 'can_be_anything',
 __refresh: 'should_not_be_used',
 },
 ),
 mockOptions({
 secretKey: 'test_deadbeef',
 publishableKey: PK_LIVE,
 apiClient: { sessions: { refreshSession } },
 }),
 );

 expect(requestState).toBeSignedIn();
 expect(requestState.toAuth()).toBeSignedInToAuth();
 expect(requestState.headers.getSetCookie()).toContain(
 `__session_MqCvchyS=${mockJwt}; Path=/; Secure; SameSite=Lax`,
 );
 expect(refreshSession).toHaveBeenCalled();
 });
 });
});
Loading