diff --git a/.changeset/native-session-lifetime.md b/.changeset/native-session-lifetime.md new file mode 100644 index 00000000000..df5ee01a35b --- /dev/null +++ b/.changeset/native-session-lifetime.md @@ -0,0 +1,6 @@ +--- +'@clerk/clerk-js': minor +'@clerk/shared': minor +--- + +Add `hasMaximumLifetime` to `SessionResource` and `SessionWithActivitiesResource`. It is `false` for sessions without a maximum lifetime, whose `expireAt` and `abandonAt` now stay at Unix epoch zero instead of being replaced with the current time. diff --git a/packages/backend/src/api/resources/Session.ts b/packages/backend/src/api/resources/Session.ts index 968be156748..41f32d54f7b 100644 --- a/packages/backend/src/api/resources/Session.ts +++ b/packages/backend/src/api/resources/Session.ts @@ -52,9 +52,13 @@ export class Session { readonly status: string, /** The time the session was last active on the [`Client`](https://clerk.com/docs/reference/backend/types/backend-client). */ readonly lastActiveAt: number, - /** The Unix timestamp when the `Session` will expire. */ + /** + * The Unix timestamp when the `Session` will expire. For an indefinite native session, this is `0`, meaning no expiration deadline. Check `status` to determine whether the session is active. + */ readonly expireAt: number, - /** The Unix timestamp when the `Session` will be abandoned. */ + /** + * The Unix timestamp when the `Session` will be abandoned. For an indefinite native session, this is `0`, meaning no abandonment deadline. + */ readonly abandonAt: number, /** The Unix timestamp when the `Session` was first created. */ readonly createdAt: number, diff --git a/packages/clerk-js/src/core/resources/Session.ts b/packages/clerk-js/src/core/resources/Session.ts index 1a2c4023e65..fcdec0d1468 100644 --- a/packages/clerk-js/src/core/resources/Session.ts +++ b/packages/clerk-js/src/core/resources/Session.ts @@ -44,7 +44,7 @@ import type { } from '@clerk/shared/types'; import { isWebAuthnSupported as isWebAuthnSupportedOnWindow } from '@clerk/shared/webauthn'; -import { unixEpochToDate } from '@/utils/date'; +import { unixEpochToDate, unixEpochToDeadline } from '@/utils/date'; import { debugLogger } from '@/utils/debug'; import { getTabState, isTabFocused } from '@/utils/isTabFocused'; import { TokenId } from '@/utils/tokenId'; @@ -89,6 +89,10 @@ export class Session extends BaseResource implements SessionResource { return !!resource && resource instanceof Session; } + get hasMaximumLifetime(): boolean { + return this.expireAt.getTime() > 0; + } + constructor(data: SessionJSON | SessionJSONSnapshot) { super(); @@ -438,8 +442,8 @@ export class Session extends BaseResource implements SessionResource { this.id = data.id; this.status = data.status; - this.expireAt = unixEpochToDate(data.expire_at); - this.abandonAt = unixEpochToDate(data.abandon_at); + this.expireAt = unixEpochToDeadline(data.expire_at); + this.abandonAt = unixEpochToDeadline(data.abandon_at); this.factorVerificationAge = data.factor_verification_age; this.lastActiveAt = unixEpochToDate(data.last_active_at || undefined); this.lastActiveOrganizationId = data.last_active_organization_id; diff --git a/packages/clerk-js/src/core/resources/SessionWithActivities.ts b/packages/clerk-js/src/core/resources/SessionWithActivities.ts index 23c8ababed2..23ef01de808 100644 --- a/packages/clerk-js/src/core/resources/SessionWithActivities.ts +++ b/packages/clerk-js/src/core/resources/SessionWithActivities.ts @@ -6,7 +6,7 @@ import type { SessionWithActivitiesResource, } from '@clerk/shared/types'; -import { unixEpochToDate } from '../../utils/date'; +import { unixEpochToDate, unixEpochToDeadline } from '../../utils/date'; import { BaseResource } from './internal'; const mapSessionActivityJSONToSessionActivity = (data: SessionActivityJSON): SessionActivity => ({ @@ -30,6 +30,10 @@ export class SessionWithActivities extends BaseResource implements SessionWithAc latestActivity!: SessionActivity; actor!: ActClaim | null; + get hasMaximumLifetime(): boolean { + return this.expireAt.getTime() > 0; + } + constructor(data: SessionWithActivitiesJSON, pathRoot: string) { super(); this.pathRoot = pathRoot; @@ -65,8 +69,8 @@ export class SessionWithActivities extends BaseResource implements SessionWithAc this.id = data.id; this.status = data.status; - this.expireAt = unixEpochToDate(data.expire_at); - this.abandonAt = unixEpochToDate(data.abandon_at); + this.expireAt = unixEpochToDeadline(data.expire_at); + this.abandonAt = unixEpochToDeadline(data.abandon_at); this.lastActiveAt = unixEpochToDate(data.last_active_at || undefined); this.latestActivity = mapSessionActivityJSONToSessionActivity(data.latest_activity ?? ({} as SessionActivityJSON)); this.actor = data.actor; diff --git a/packages/clerk-js/src/core/resources/__tests__/Client.test.ts b/packages/clerk-js/src/core/resources/__tests__/Client.test.ts index 5514e1cc855..34261720ebf 100644 --- a/packages/clerk-js/src/core/resources/__tests__/Client.test.ts +++ b/packages/clerk-js/src/core/resources/__tests__/Client.test.ts @@ -193,6 +193,32 @@ describe('Client Singleton', () => { expect(client.signIn.status).toBe('needs_second_factor'); }); + it('restores a session without a maximum lifetime from a client snapshot', () => { + const user = createUser({ first_name: 'John', last_name: 'Doe', id: 'user_1' }); + const clientJSON: ClientJSON = { + object: 'client', + id: 'test_id', + status: 'active', + last_active_session_id: 'session_1', + sign_in: null, + sign_up: null, + sessions: [{ ...createSession({ id: 'session_1', status: 'active' }, user), expire_at: 0, abandon_at: 0 }], + created_at: Date.now() - 1000, + updated_at: Date.now(), + } as any; + + // @ts-expect-error We cannot mess with the singleton when tests are running in parallel + const snapshot = new Client(clientJSON).__internal_toSnapshot(); + // @ts-expect-error We cannot mess with the singleton when tests are running in parallel + const [restored] = new Client(snapshot).sessions; + + expect(snapshot.sessions[0]).toMatchObject({ expire_at: 0, abandon_at: 0 }); + expect(restored.expireAt.getTime()).toBe(0); + expect(restored.abandonAt.getTime()).toBe(0); + expect(restored.hasMaximumLifetime).toBe(false); + expect(restored.status).toBe('active'); + }); + it('replaces sign up and sign in identity when fromJSON receives new ids', () => { const user = createUser({ first_name: 'John', last_name: 'Doe', id: 'user_1' }); const session = createSession({ id: 'session_1' }, user); diff --git a/packages/clerk-js/src/core/resources/__tests__/Session.test.ts b/packages/clerk-js/src/core/resources/__tests__/Session.test.ts index b776ddd1753..b34c06543c6 100644 --- a/packages/clerk-js/src/core/resources/__tests__/Session.test.ts +++ b/packages/clerk-js/src/core/resources/__tests__/Session.test.ts @@ -16,6 +16,7 @@ import { eventBus } from '../../events'; import { createFapiClient } from '../../fapiClient'; import { SessionTokenCache } from '../../tokenCache'; import { BaseResource, Client, Organization, Session } from '../internal'; +import { SessionWithActivities } from '../SessionWithActivities'; const baseFapiClientOptions = { frontendApi: 'clerk.example.com', @@ -40,6 +41,45 @@ describe('Session', () => { vi.useRealTimers(); }); + it.each([0, 2000000000000])('preserves a session deadline of %s through snapshots', deadline => { + const session = new Session({ + id: 'session_lifetime', + status: 'active', + expire_at: deadline, + abandon_at: deadline, + public_user_data: { user_id: 'user_1' }, + } as SessionJSON); + expect(session.expireAt.getTime()).toBe(deadline); + expect(session.abandonAt.getTime()).toBe(deadline); + expect(session.hasMaximumLifetime).toBe(deadline > 0); + const restored = new Session(session.__internal_toSnapshot()); + expect(restored.expireAt.getTime()).toBe(deadline); + expect(restored.hasMaximumLifetime).toBe(deadline > 0); + const withActivities = new SessionWithActivities( + { id: session.id, expire_at: deadline, abandon_at: deadline } as any, + '/me/sessions', + ); + expect(withActivities.hasMaximumLifetime).toBe(deadline > 0); + expect(withActivities.abandonAt.getTime()).toBe(deadline); + }); + + it('keeps zero only for session deadlines', () => { + const session = new Session({ + id: 'session_lifetime', + status: 'active', + expire_at: 0, + abandon_at: 0, + created_at: 0, + updated_at: 0, + public_user_data: { user_id: 'user_1' }, + } as SessionJSON); + + expect(session.expireAt.getTime()).toBe(0); + expect(session.abandonAt.getTime()).toBe(0); + expect(session.createdAt.getTime()).toBe(Date.now()); + expect(session.updatedAt.getTime()).toBe(Date.now()); + }); + describe('getToken()', () => { let dispatchSpy; diff --git a/packages/clerk-js/src/utils/__tests__/date.test.ts b/packages/clerk-js/src/utils/__tests__/date.test.ts index 3c1ff3a3ca7..0b8a303999e 100644 --- a/packages/clerk-js/src/utils/__tests__/date.test.ts +++ b/packages/clerk-js/src/utils/__tests__/date.test.ts @@ -1,6 +1,6 @@ import { afterAll, beforeAll, describe, expect, it, vi } from 'vitest'; -import { unixEpochToDate } from '../date'; +import { unixEpochToDate, unixEpochToDeadline } from '../date'; describe('date utilities', () => { beforeAll(() => { @@ -13,6 +13,10 @@ describe('date utilities', () => { }); describe('unixEpochToDate', () => { + it('fallbacks to current date for zero', function () { + expect(unixEpochToDate(0).getTime()).toBe(Date.now()); + }); + it('converts a unix epoch to Date', function () { const epoch = 1622575087; const date = unixEpochToDate(epoch); @@ -29,4 +33,18 @@ describe('date utilities', () => { expect(date.getTime()).toBe(Date.now()); }); }); + + describe('unixEpochToDeadline', () => { + it('keeps zero as Unix epoch zero', () => { + expect(unixEpochToDeadline(0).getTime()).toBe(0); + }); + + it('converts a unix epoch to Date', () => { + expect(unixEpochToDeadline(1622575087).getTime()).toBe(1622575087); + }); + + it('fallbacks to current date for undefined values', () => { + expect(unixEpochToDeadline(undefined).getTime()).toBe(Date.now()); + }); + }); }); diff --git a/packages/clerk-js/src/utils/date.ts b/packages/clerk-js/src/utils/date.ts index 9541ca70bab..f785cbe118e 100644 --- a/packages/clerk-js/src/utils/date.ts +++ b/packages/clerk-js/src/utils/date.ts @@ -6,3 +6,7 @@ export function unixEpochToDate(epochInSeconds?: number): Date { const date = new Date(epochInSeconds || new Date()); return isValidDate(date) ? date : new Date(); } + +export function unixEpochToDeadline(epoch?: number): Date { + return epoch === 0 ? new Date(0) : unixEpochToDate(epoch); +} diff --git a/packages/shared/src/types/session.ts b/packages/shared/src/types/session.ts index 82af54419d5..0d6430b37fd 100644 --- a/packages/shared/src/types/session.ts +++ b/packages/shared/src/types/session.ts @@ -221,11 +221,15 @@ export interface SessionResource extends ClerkResource { */ status: SessionStatus; /** - * The date and time when the session will expire. + * The date and time when the session will expire. For an indefinite native session, this represents Unix epoch zero, meaning no expiration deadline is configured. */ expireAt: Date; /** - * The date and time when the session was abandoned by the user. + * Whether the session has a maximum lifetime. `false` when `expireAt` is Unix epoch zero. A session without a maximum lifetime can still end through sign-out or revocation, so use `status` to check whether it is active. `undefined` in ClerkJS versions that predate this property. + */ + readonly hasMaximumLifetime?: boolean; + /** + * The abandonment deadline. For an indefinite native session, this represents Unix epoch zero, meaning no abandonment deadline is configured. */ abandonAt: Date; /** @@ -386,6 +390,10 @@ export interface SessionWithActivitiesResource extends ClerkResource { id: string; status: string; expireAt: Date; + /** + * Whether the session has a maximum lifetime. `false` when `expireAt` is Unix epoch zero. `undefined` in ClerkJS versions that predate this property. + */ + readonly hasMaximumLifetime?: boolean; abandonAt: Date; lastActiveAt: Date; latestActivity: SessionActivity;