Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
8 changes: 8 additions & 0 deletions .changeset/oauth-transport.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
---
'@clerk/shared': minor
'@clerk/clerk-js': minor
'@clerk/react': minor
'@clerk/ui': minor
---

Add internal OAuth transport support for native desktop SDK wrappers to run Clerk's prebuilt OAuth flows through a system browser.
133 changes: 133 additions & 0 deletions packages/clerk-js/src/core/__tests__/clerk.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -158,6 +158,41 @@ describe('Clerk singleton', () => {
});
});

describe('__internal_oauthTransport', () => {
it('defaults to null with no getter access errors', () => {
const sut = new Clerk(productionPublishableKey);

expect(sut.__internal_hasOAuthTransport).toBe(false);
expect(sut.__internal_oauthTransport).toBeNull();
});

it('exposes the transport registered via options after load', async () => {
const transport = {
getRedirectUrl: () => 'myapp://sso-callback',
open: async (_url: URL) => ({ callbackUrl: 'myapp://sso-callback' }),
};
const sut = new Clerk(productionPublishableKey);

await sut.load({ __internal_oauthTransport: transport });

expect(sut.__internal_hasOAuthTransport).toBe(true);
expect(sut.__internal_oauthTransport).toBe(transport);
});
});

describe('__internal_handleResourceCallback', () => {
it('handleGoogleOneTapCallback delegates to __internal_handleResourceCallback', async () => {
const clerk = new Clerk(productionPublishableKey);
await clerk.load();
const spy = vi.spyOn(clerk, '__internal_handleResourceCallback').mockResolvedValue(undefined);
const signInLike = { identifier: 'x' } as any;

await clerk.handleGoogleOneTapCallback(signInLike, { signInUrl: '/sign-in' });

expect(spy).toHaveBeenCalledWith(signInLike, { signInUrl: '/sign-in' }, undefined);
});
});

describe('.setActive', () => {
describe('with `active` session status', () => {
const mockSession = {
Expand DownExpand Up@@ -1205,6 +1240,104 @@ describe('Clerk singleton', () => {
});
});

it('uses __internal_navigateOnSetActive for completed sign in callbacks', async () => {
const sessionId = 'sess_123';
const mockSession = { id: sessionId, currentTask: null };
mockEnvironmentFetch.mockReturnValue(
Promise.resolve({
authConfig: {},
userSettings: mockUserSettings,
displayConfig: mockDisplayConfig,
isSingleSession: () => false,
isProduction: () => false,
isDevelopmentOrStaging: () => true,
onWindowLocationHost: () => false,
}),
);
mockClientFetch.mockReturnValue(
Promise.resolve({
signedInSessions: [],
signIn: new SignIn({
status: 'complete',
created_session_id: sessionId,
} as any as SignInJSON),
signUp: new SignUp(null),
}),
);

const internalNavigateOnSetActive = vi.fn(async ({ session, redirectUrl, decorateUrl }) => {
expect(session).toBe(mockSession);
expect(redirectUrl).toBe('http://test.host/after-sign-in');
expect(decorateUrl('/decorated')).toBe('/decorated');
});
const mockSetActive = vi.fn(async ({ navigate }) => navigate({ session: mockSession }));

const sut = new Clerk(productionPublishableKey);
await sut.load(mockedLoadOptions);
sut.setActive = mockSetActive as any;

await sut.handleRedirectCallback({
signInForceRedirectUrl: '/after-sign-in',
__internal_navigateOnSetActive: internalNavigateOnSetActive,
});

expect(mockSetActive).toHaveBeenCalledWith({
session: sessionId,
navigate: expect.any(Function),
});
expect(internalNavigateOnSetActive).toHaveBeenCalledTimes(1);
expect(mockNavigate).not.toHaveBeenCalled();
});

it('uses __internal_navigateOnSetActive for completed sign up callbacks', async () => {
const sessionId = 'sess_123';
const mockSession = { id: sessionId, currentTask: null };
mockEnvironmentFetch.mockReturnValue(
Promise.resolve({
authConfig: {},
userSettings: mockUserSettings,
displayConfig: mockDisplayConfig,
isSingleSession: () => false,
isProduction: () => false,
isDevelopmentOrStaging: () => true,
onWindowLocationHost: () => false,
}),
);
mockClientFetch.mockReturnValue(
Promise.resolve({
signedInSessions: [],
signIn: new SignIn(null),
signUp: new SignUp({
status: 'complete',
created_session_id: sessionId,
} as any as SignUpJSON),
}),
);

const internalNavigateOnSetActive = vi.fn(async ({ session, redirectUrl, decorateUrl }) => {
expect(session).toBe(mockSession);
expect(redirectUrl).toBe('http://test.host/after-sign-up');
expect(decorateUrl('/decorated')).toBe('/decorated');
});
const mockSetActive = vi.fn(async ({ navigate }) => navigate({ session: mockSession }));

const sut = new Clerk(productionPublishableKey);
await sut.load(mockedLoadOptions);
sut.setActive = mockSetActive as any;

await sut.handleRedirectCallback({
signUpForceRedirectUrl: '/after-sign-up',
__internal_navigateOnSetActive: internalNavigateOnSetActive,
});

expect(mockSetActive).toHaveBeenCalledWith({
session: sessionId,
navigate: expect.any(Function),
});
expect(internalNavigateOnSetActive).toHaveBeenCalledTimes(1);
expect(mockNavigate).not.toHaveBeenCalled();
});

it('does not initiate the transfer flow when transferable: false is passed', async () => {
mockEnvironmentFetch.mockReturnValue(
Promise.resolve({
Expand Down
55 changes: 50 additions & 5 deletions packages/clerk-js/src/core/clerk.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -98,6 +98,7 @@ import type {
LoadedClerk,
NavigateOptions,
OAuthApplicationNamespace,
OAuthTransport,
OrganizationListProps,
OrganizationProfileProps,
OrganizationResource,
Expand DownExpand Up@@ -269,6 +270,7 @@ export class Clerk implements ClerkInterface {
#listeners: Array<(emission: Resources) => void> = [];
#navigationListeners: Array<() => void> = [];
#options: ClerkOptions = {};
#oauthTransport: OAuthTransport | null = null;
#pageLifecycle: ReturnType<typeof createPageLifecycle> | null = null;
#touchThrottledUntil = 0;
#publicEventBus = createClerkEventBus();
Expand All@@ -295,6 +297,14 @@ export class Clerk implements ClerkInterface {
: undefined;
}

get __internal_hasOAuthTransport(): boolean {
return this.#oauthTransport !== null;
}

get __internal_oauthTransport(): OAuthTransport | null {
return this.#oauthTransport;
}

public __internal_getCachedResources:
| (() => Promise<{ client: ClientJSONSnapshot | null; environment: EnvironmentJSONSnapshot | null }>)
| undefined;
Expand DownExpand Up@@ -529,6 +539,7 @@ export class Clerk implements ClerkInterface {
}

this.#options = this.#initOptions(options);
this.#oauthTransport = this.#options.__internal_oauthTransport ?? null;

// Initialize ClerkUI if it was provided
if (this.#options.ui?.ClerkUI) {
Expand DownExpand Up@@ -2285,7 +2296,7 @@ export class Clerk implements ClerkInterface {
return null;
};

public handleGoogleOneTapCallback = async (
public __internal_handleResourceCallback = async (
signInOrUp: SignInResource | SignUpResource,
params: HandleOAuthCallbackParams,
customNavigate?: (to: string) => Promise<unknown>,
Expand All@@ -2310,6 +2321,14 @@ export class Clerk implements ClerkInterface {
});
};

public handleGoogleOneTapCallback = async (
signInOrUp: SignInResource | SignUpResource,
params: HandleOAuthCallbackParams,
customNavigate?: (to: string) => Promise<unknown>,
): Promise<unknown> => {
return this.__internal_handleResourceCallback(signInOrUp, params, customNavigate);
};

private _handleRedirectCallback = async (
params: HandleOAuthCallbackParams,
{
Expand DownExpand Up@@ -2421,6 +2440,7 @@ export class Clerk implements ClerkInterface {

const signInUrl = params.signInUrl || displayConfig.signInUrl;
const signUpUrl = params.signUpUrl || displayConfig.signUpUrl;
const internalNavigateOnSetActive = params.__internal_navigateOnSetActive;

const setActiveNavigate = async ({
session,
Expand All@@ -2431,6 +2451,15 @@ export class Clerk implements ClerkInterface {
baseUrl: string;
redirectUrl: string;
}) => {
if (internalNavigateOnSetActive) {
await internalNavigateOnSetActive({
session,
redirectUrl,
decorateUrl: url => this.buildUrlWithAuth(url),
});
return;
}

if (!session.currentTask) {
await this.navigate(redirectUrl);
return;
Expand All@@ -2446,7 +2475,11 @@ export class Clerk implements ClerkInterface {
return this.setActive({
session: si.sessionId,
navigate: async ({ session }) => {
await setActiveNavigate({ session, baseUrl: signInUrl, redirectUrl: redirectUrls.getAfterSignInUrl() });
await setActiveNavigate({
session,
baseUrl: signInUrl,
redirectUrl: redirectUrls.getAfterSignInUrl(),
});
},
});
}
Expand All@@ -2461,7 +2494,11 @@ export class Clerk implements ClerkInterface {
return this.setActive({
session: res.createdSessionId,
navigate: async ({ session }) => {
await setActiveNavigate({ session, baseUrl: signUpUrl, redirectUrl: redirectUrls.getAfterSignInUrl() });
await setActiveNavigate({
session,
baseUrl: signUpUrl,
redirectUrl: redirectUrls.getAfterSignInUrl(),
});
},
});
case 'needs_first_factor':
Expand DownExpand Up@@ -2512,7 +2549,11 @@ export class Clerk implements ClerkInterface {
return this.setActive({
session: res.createdSessionId,
navigate: async ({ session }) => {
await setActiveNavigate({ session, baseUrl: signUpUrl, redirectUrl: redirectUrls.getAfterSignUpUrl() });
await setActiveNavigate({
session,
baseUrl: signUpUrl,
redirectUrl: redirectUrls.getAfterSignUpUrl(),
});
},
});
case 'missing_requirements':
Expand All@@ -2526,7 +2567,11 @@ export class Clerk implements ClerkInterface {
return this.setActive({
session: su.sessionId,
navigate: async ({ session }) => {
await setActiveNavigate({ session, baseUrl: signUpUrl, redirectUrl: redirectUrls.getAfterSignUpUrl() });
await setActiveNavigate({
session,
baseUrl: signUpUrl,
redirectUrl: redirectUrls.getAfterSignUpUrl(),
});
},
});
}
Expand Down
13 changes: 13 additions & 0 deletions packages/clerk-js/src/core/resources/SignIn.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -83,6 +83,7 @@ import {
_futureAuthenticateWithPopup,
wrapWithPopupRoutes,
} from '../../utils/authenticateWithPopup';
import { _authenticateWithTransport } from '../../utils/authenticateWithTransport';
import { CaptchaChallenge } from '../../utils/captcha/CaptchaChallenge';
import { runAsyncResourceTask } from '../../utils/runAsyncResourceTask';
import { loadZxcvbn } from '../../utils/zxcvbn';
Expand DownExpand Up@@ -379,6 +380,18 @@ export class SignIn extends BaseResource implements SignInResource {
};

public authenticateWithRedirect = async (params: AuthenticateWithRedirectParams): Promise<void> => {
const transport = SignIn.clerk.__internal_oauthTransport;
if (transport) {
return _authenticateWithTransport({
clerk: SignIn.clerk,
transport,
resource: this,
authenticateMethod: this.authenticateWithRedirectOrPopup,
params,
callbackParams: params.__internal_callbackParams ?? {},
});
}
Comment on lines +383 to +393

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.

If no transport is registered, the existing redirect behavior is preserved. If a transport is registered, we reuse the same private authenticateWithRedirectOrPopup initiation path through _authenticateWithTransport


return this.authenticateWithRedirectOrPopup(params, windowNavigate);
};

Expand Down
13 changes: 13 additions & 0 deletions packages/clerk-js/src/core/resources/SignUp.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -54,6 +54,7 @@ import {
_futureAuthenticateWithPopup,
wrapWithPopupRoutes,
} from '../../utils/authenticateWithPopup';
import { _authenticateWithTransport } from '../../utils/authenticateWithTransport';
import { CaptchaChallenge } from '../../utils/captcha/CaptchaChallenge';
import { normalizeUnsafeMetadata } from '../../utils/resourceParams';
import { runAsyncResourceTask } from '../../utils/runAsyncResourceTask';
Expand DownExpand Up@@ -449,6 +450,18 @@ export class SignUp extends BaseResource implements SignUpResource {
unsafeMetadata?: SignUpUnsafeMetadata;
},
): Promise<void> => {
const transport = SignUp.clerk.__internal_oauthTransport;
if (transport) {
return _authenticateWithTransport({
clerk: SignUp.clerk,
transport,
resource: this,
authenticateMethod: this.authenticateWithRedirectOrPopup,
params,
callbackParams: params.__internal_callbackParams ?? {},
});
}

return this.authenticateWithRedirectOrPopup(params, windowNavigate);
};

Expand Down
41 changes: 41 additions & 0 deletions packages/clerk-js/src/core/resources/__tests__/SignIn.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -34,6 +34,47 @@ describe('SignIn', () => {
expect(snapshot).toBeDefined();
});

describe('authenticateWithRedirect with an OAuth transport', () => {
afterEach(() => {
vi.clearAllMocks();
SignIn.clerk = {} as any;
});

it('routes through the transport instead of windowNavigate when one is registered', async () => {
const open = vi.fn().mockResolvedValue({ callbackUrl: 'myapp://sso-callback' });
const handleResourceCallback = vi.fn().mockResolvedValue(undefined);
SignIn.clerk = {
buildUrlWithAuth: vi.fn(u => u),
__internal_oauthTransport: { getRedirectUrl: () => 'myapp://sso-callback', open },
__internal_handleResourceCallback: handleResourceCallback,
__internal_environment: { displayConfig: { captchaOauthBypass: [] } },
} as any;

const mockFetch = vi.fn().mockResolvedValueOnce({
client: null,
response: {
id: 'signin_123',
first_factor_verification: {
status: 'unverified',
external_verification_redirect_url: 'https://provider.example/auth',
},
},
});
BaseResource._fetch = mockFetch;

const signIn = new SignIn();
await signIn.authenticateWithRedirect({
strategy: 'oauth_google',
redirectUrl: '/sso-callback',
redirectUrlComplete: '/',
__internal_callbackParams: { signInUrl: '/sign-in' },
} as any);

expect(open).toHaveBeenCalledWith(new URL('https://provider.example/auth'));
expect(handleResourceCallback).toHaveBeenCalledWith(signIn, { signInUrl: '/sign-in' });
});
});

describe('signIn.create', () => {
afterEach(() => {
vi.clearAllMocks();
Expand Down
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n 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;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
8 changes: 8 additions & 0 deletions .changeset/oauth-transport.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
---
'@clerk/shared': minor
'@clerk/clerk-js': minor
'@clerk/react': minor
'@clerk/ui': minor
---

Add internal OAuth transport support for native desktop SDK wrappers to run Clerk's prebuilt OAuth flows through a system browser.
133 changes: 133 additions & 0 deletions packages/clerk-js/src/core/__tests__/clerk.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -158,6 +158,41 @@ describe('Clerk singleton', () => {
});
});

describe('__internal_oauthTransport', () => {
it('defaults to null with no getter access errors', () => {
const sut = new Clerk(productionPublishableKey);

expect(sut.__internal_hasOAuthTransport).toBe(false);
expect(sut.__internal_oauthTransport).toBeNull();
});

it('exposes the transport registered via options after load', async () => {
const transport = {
getRedirectUrl: () => 'myapp://sso-callback',
open: async (_url: URL) => ({ callbackUrl: 'myapp://sso-callback' }),
};
const sut = new Clerk(productionPublishableKey);

await sut.load({ __internal_oauthTransport: transport });

expect(sut.__internal_hasOAuthTransport).toBe(true);
expect(sut.__internal_oauthTransport).toBe(transport);
});
});

describe('__internal_handleResourceCallback', () => {
it('handleGoogleOneTapCallback delegates to __internal_handleResourceCallback', async () => {
const clerk = new Clerk(productionPublishableKey);
await clerk.load();
const spy = vi.spyOn(clerk, '__internal_handleResourceCallback').mockResolvedValue(undefined);
const signInLike = { identifier: 'x' } as any;

await clerk.handleGoogleOneTapCallback(signInLike, { signInUrl: '/sign-in' });

expect(spy).toHaveBeenCalledWith(signInLike, { signInUrl: '/sign-in' }, undefined);
});
});

describe('.setActive', () => {
describe('with `active` session status', () => {
const mockSession = {
Expand DownExpand Up@@ -1205,6 +1240,104 @@ describe('Clerk singleton', () => {
});
});

it('uses __internal_navigateOnSetActive for completed sign in callbacks', async () => {
const sessionId = 'sess_123';
const mockSession = { id: sessionId, currentTask: null };
mockEnvironmentFetch.mockReturnValue(
Promise.resolve({
authConfig: {},
userSettings: mockUserSettings,
displayConfig: mockDisplayConfig,
isSingleSession: () => false,
isProduction: () => false,
isDevelopmentOrStaging: () => true,
onWindowLocationHost: () => false,
}),
);
mockClientFetch.mockReturnValue(
Promise.resolve({
signedInSessions: [],
signIn: new SignIn({
status: 'complete',
created_session_id: sessionId,
} as any as SignInJSON),
signUp: new SignUp(null),
}),
);

const internalNavigateOnSetActive = vi.fn(async ({ session, redirectUrl, decorateUrl }) => {
expect(session).toBe(mockSession);
expect(redirectUrl).toBe('http://test.host/after-sign-in');
expect(decorateUrl('/decorated')).toBe('/decorated');
});
const mockSetActive = vi.fn(async ({ navigate }) => navigate({ session: mockSession }));

const sut = new Clerk(productionPublishableKey);
await sut.load(mockedLoadOptions);
sut.setActive = mockSetActive as any;

await sut.handleRedirectCallback({
signInForceRedirectUrl: '/after-sign-in',
__internal_navigateOnSetActive: internalNavigateOnSetActive,
});

expect(mockSetActive).toHaveBeenCalledWith({
session: sessionId,
navigate: expect.any(Function),
});
expect(internalNavigateOnSetActive).toHaveBeenCalledTimes(1);
expect(mockNavigate).not.toHaveBeenCalled();
});

it('uses __internal_navigateOnSetActive for completed sign up callbacks', async () => {
const sessionId = 'sess_123';
const mockSession = { id: sessionId, currentTask: null };
mockEnvironmentFetch.mockReturnValue(
Promise.resolve({
authConfig: {},
userSettings: mockUserSettings,
displayConfig: mockDisplayConfig,
isSingleSession: () => false,
isProduction: () => false,
isDevelopmentOrStaging: () => true,
onWindowLocationHost: () => false,
}),
);
mockClientFetch.mockReturnValue(
Promise.resolve({
signedInSessions: [],
signIn: new SignIn(null),
signUp: new SignUp({
status: 'complete',
created_session_id: sessionId,
} as any as SignUpJSON),
}),
);

const internalNavigateOnSetActive = vi.fn(async ({ session, redirectUrl, decorateUrl }) => {
expect(session).toBe(mockSession);
expect(redirectUrl).toBe('http://test.host/after-sign-up');
expect(decorateUrl('/decorated')).toBe('/decorated');
});
const mockSetActive = vi.fn(async ({ navigate }) => navigate({ session: mockSession }));

const sut = new Clerk(productionPublishableKey);
await sut.load(mockedLoadOptions);
sut.setActive = mockSetActive as any;

await sut.handleRedirectCallback({
signUpForceRedirectUrl: '/after-sign-up',
__internal_navigateOnSetActive: internalNavigateOnSetActive,
});

expect(mockSetActive).toHaveBeenCalledWith({
session: sessionId,
navigate: expect.any(Function),
});
expect(internalNavigateOnSetActive).toHaveBeenCalledTimes(1);
expect(mockNavigate).not.toHaveBeenCalled();
});

it('does not initiate the transfer flow when transferable: false is passed', async () => {
mockEnvironmentFetch.mockReturnValue(
Promise.resolve({
Expand Down
55 changes: 50 additions & 5 deletions packages/clerk-js/src/core/clerk.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -98,6 +98,7 @@ import type {
LoadedClerk,
NavigateOptions,
OAuthApplicationNamespace,
OAuthTransport,
OrganizationListProps,
OrganizationProfileProps,
OrganizationResource,
Expand DownExpand Up@@ -269,6 +270,7 @@ export class Clerk implements ClerkInterface {
#listeners: Array<(emission: Resources) => void> = [];
#navigationListeners: Array<() => void> = [];
#options: ClerkOptions = {};
#oauthTransport: OAuthTransport | null = null;
#pageLifecycle: ReturnType<typeof createPageLifecycle> | null = null;
#touchThrottledUntil = 0;
#publicEventBus = createClerkEventBus();
Expand All@@ -295,6 +297,14 @@ export class Clerk implements ClerkInterface {
: undefined;
}

get __internal_hasOAuthTransport(): boolean {
return this.#oauthTransport !== null;
}

get __internal_oauthTransport(): OAuthTransport | null {
return this.#oauthTransport;
}

public __internal_getCachedResources:
| (() => Promise<{ client: ClientJSONSnapshot | null; environment: EnvironmentJSONSnapshot | null }>)
| undefined;
Expand DownExpand Up@@ -529,6 +539,7 @@ export class Clerk implements ClerkInterface {
}

this.#options = this.#initOptions(options);
this.#oauthTransport = this.#options.__internal_oauthTransport ?? null;

// Initialize ClerkUI if it was provided
if (this.#options.ui?.ClerkUI) {
Expand DownExpand Up@@ -2285,7 +2296,7 @@ export class Clerk implements ClerkInterface {
return null;
};

public handleGoogleOneTapCallback = async (
public __internal_handleResourceCallback = async (
signInOrUp: SignInResource | SignUpResource,
params: HandleOAuthCallbackParams,
customNavigate?: (to: string) => Promise<unknown>,
Expand All@@ -2310,6 +2321,14 @@ export class Clerk implements ClerkInterface {
});
};

public handleGoogleOneTapCallback = async (
signInOrUp: SignInResource | SignUpResource,
params: HandleOAuthCallbackParams,
customNavigate?: (to: string) => Promise<unknown>,
): Promise<unknown> => {
return this.__internal_handleResourceCallback(signInOrUp, params, customNavigate);
};

private _handleRedirectCallback = async (
params: HandleOAuthCallbackParams,
{
Expand DownExpand Up@@ -2421,6 +2440,7 @@ export class Clerk implements ClerkInterface {

const signInUrl = params.signInUrl || displayConfig.signInUrl;
const signUpUrl = params.signUpUrl || displayConfig.signUpUrl;
const internalNavigateOnSetActive = params.__internal_navigateOnSetActive;

const setActiveNavigate = async ({
session,
Expand All@@ -2431,6 +2451,15 @@ export class Clerk implements ClerkInterface {
baseUrl: string;
redirectUrl: string;
}) => {
if (internalNavigateOnSetActive) {
await internalNavigateOnSetActive({
session,
redirectUrl,
decorateUrl: url => this.buildUrlWithAuth(url),
});
return;
}

if (!session.currentTask) {
await this.navigate(redirectUrl);
return;
Expand All@@ -2446,7 +2475,11 @@ export class Clerk implements ClerkInterface {
return this.setActive({
session: si.sessionId,
navigate: async ({ session }) => {
await setActiveNavigate({ session, baseUrl: signInUrl, redirectUrl: redirectUrls.getAfterSignInUrl() });
await setActiveNavigate({
session,
baseUrl: signInUrl,
redirectUrl: redirectUrls.getAfterSignInUrl(),
});
},
});
}
Expand All@@ -2461,7 +2494,11 @@ export class Clerk implements ClerkInterface {
return this.setActive({
session: res.createdSessionId,
navigate: async ({ session }) => {
await setActiveNavigate({ session, baseUrl: signUpUrl, redirectUrl: redirectUrls.getAfterSignInUrl() });
await setActiveNavigate({
session,
baseUrl: signUpUrl,
redirectUrl: redirectUrls.getAfterSignInUrl(),
});
},
});
case 'needs_first_factor':
Expand DownExpand Up@@ -2512,7 +2549,11 @@ export class Clerk implements ClerkInterface {
return this.setActive({
session: res.createdSessionId,
navigate: async ({ session }) => {
await setActiveNavigate({ session, baseUrl: signUpUrl, redirectUrl: redirectUrls.getAfterSignUpUrl() });
await setActiveNavigate({
session,
baseUrl: signUpUrl,
redirectUrl: redirectUrls.getAfterSignUpUrl(),
});
},
});
case 'missing_requirements':
Expand All@@ -2526,7 +2567,11 @@ export class Clerk implements ClerkInterface {
return this.setActive({
session: su.sessionId,
navigate: async ({ session }) => {
await setActiveNavigate({ session, baseUrl: signUpUrl, redirectUrl: redirectUrls.getAfterSignUpUrl() });
await setActiveNavigate({
session,
baseUrl: signUpUrl,
redirectUrl: redirectUrls.getAfterSignUpUrl(),
});
},
});
}
Expand Down
13 changes: 13 additions & 0 deletions packages/clerk-js/src/core/resources/SignIn.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -83,6 +83,7 @@ import {
_futureAuthenticateWithPopup,
wrapWithPopupRoutes,
} from '../../utils/authenticateWithPopup';
import { _authenticateWithTransport } from '../../utils/authenticateWithTransport';
import { CaptchaChallenge } from '../../utils/captcha/CaptchaChallenge';
import { runAsyncResourceTask } from '../../utils/runAsyncResourceTask';
import { loadZxcvbn } from '../../utils/zxcvbn';
Expand DownExpand Up@@ -379,6 +380,18 @@ export class SignIn extends BaseResource implements SignInResource {
};

public authenticateWithRedirect = async (params: AuthenticateWithRedirectParams): Promise<void> => {
const transport = SignIn.clerk.__internal_oauthTransport;
if (transport) {
return _authenticateWithTransport({
clerk: SignIn.clerk,
transport,
resource: this,
authenticateMethod: this.authenticateWithRedirectOrPopup,
params,
callbackParams: params.__internal_callbackParams ?? {},
});
}
Comment on lines +383 to +393

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.

If no transport is registered, the existing redirect behavior is preserved. If a transport is registered, we reuse the same private authenticateWithRedirectOrPopup initiation path through _authenticateWithTransport


return this.authenticateWithRedirectOrPopup(params, windowNavigate);
};

Expand Down
13 changes: 13 additions & 0 deletions packages/clerk-js/src/core/resources/SignUp.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -54,6 +54,7 @@ import {
_futureAuthenticateWithPopup,
wrapWithPopupRoutes,
} from '../../utils/authenticateWithPopup';
import { _authenticateWithTransport } from '../../utils/authenticateWithTransport';
import { CaptchaChallenge } from '../../utils/captcha/CaptchaChallenge';
import { normalizeUnsafeMetadata } from '../../utils/resourceParams';
import { runAsyncResourceTask } from '../../utils/runAsyncResourceTask';
Expand DownExpand Up@@ -449,6 +450,18 @@ export class SignUp extends BaseResource implements SignUpResource {
unsafeMetadata?: SignUpUnsafeMetadata;
},
): Promise<void> => {
const transport = SignUp.clerk.__internal_oauthTransport;
if (transport) {
return _authenticateWithTransport({
clerk: SignUp.clerk,
transport,
resource: this,
authenticateMethod: this.authenticateWithRedirectOrPopup,
params,
callbackParams: params.__internal_callbackParams ?? {},
});
}

return this.authenticateWithRedirectOrPopup(params, windowNavigate);
};

Expand Down
41 changes: 41 additions & 0 deletions packages/clerk-js/src/core/resources/__tests__/SignIn.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -34,6 +34,47 @@ describe('SignIn', () => {
expect(snapshot).toBeDefined();
});

describe('authenticateWithRedirect with an OAuth transport', () => {
afterEach(() => {
vi.clearAllMocks();
SignIn.clerk = {} as any;
});

it('routes through the transport instead of windowNavigate when one is registered', async () => {
const open = vi.fn().mockResolvedValue({ callbackUrl: 'myapp://sso-callback' });
const handleResourceCallback = vi.fn().mockResolvedValue(undefined);
SignIn.clerk = {
buildUrlWithAuth: vi.fn(u => u),
__internal_oauthTransport: { getRedirectUrl: () => 'myapp://sso-callback', open },
__internal_handleResourceCallback: handleResourceCallback,
__internal_environment: { displayConfig: { captchaOauthBypass: [] } },
} as any;

const mockFetch = vi.fn().mockResolvedValueOnce({
client: null,
response: {
id: 'signin_123',
first_factor_verification: {
status: 'unverified',
external_verification_redirect_url: 'https://provider.example/auth',
},
},
});
BaseResource._fetch = mockFetch;

const signIn = new SignIn();
await signIn.authenticateWithRedirect({
strategy: 'oauth_google',
redirectUrl: '/sso-callback',
redirectUrlComplete: '/',
__internal_callbackParams: { signInUrl: '/sign-in' },
} as any);

expect(open).toHaveBeenCalledWith(new URL('https://provider.example/auth'));
expect(handleResourceCallback).toHaveBeenCalledWith(signIn, { signInUrl: '/sign-in' });
});
});

describe('signIn.create', () => {
afterEach(() => {
vi.clearAllMocks();
Expand Down
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix"); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
8 changes: 8 additions & 0 deletions .changeset/oauth-transport.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
---
'@clerk/shared': minor
'@clerk/clerk-js': minor
'@clerk/react': minor
'@clerk/ui': minor
---

Add internal OAuth transport support for native desktop SDK wrappers to run Clerk's prebuilt OAuth flows through a system browser.
133 changes: 133 additions & 0 deletions packages/clerk-js/src/core/__tests__/clerk.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -158,6 +158,41 @@ describe('Clerk singleton', () => {
});
});

describe('__internal_oauthTransport', () => {
it('defaults to null with no getter access errors', () => {
const sut = new Clerk(productionPublishableKey);

expect(sut.__internal_hasOAuthTransport).toBe(false);
expect(sut.__internal_oauthTransport).toBeNull();
});

it('exposes the transport registered via options after load', async () => {
const transport = {
getRedirectUrl: () => 'myapp://sso-callback',
open: async (_url: URL) => ({ callbackUrl: 'myapp://sso-callback' }),
};
const sut = new Clerk(productionPublishableKey);

await sut.load({ __internal_oauthTransport: transport });

expect(sut.__internal_hasOAuthTransport).toBe(true);
expect(sut.__internal_oauthTransport).toBe(transport);
});
});

describe('__internal_handleResourceCallback', () => {
it('handleGoogleOneTapCallback delegates to __internal_handleResourceCallback', async () => {
const clerk = new Clerk(productionPublishableKey);
await clerk.load();
const spy = vi.spyOn(clerk, '__internal_handleResourceCallback').mockResolvedValue(undefined);
const signInLike = { identifier: 'x' } as any;

await clerk.handleGoogleOneTapCallback(signInLike, { signInUrl: '/sign-in' });

expect(spy).toHaveBeenCalledWith(signInLike, { signInUrl: '/sign-in' }, undefined);
});
});

describe('.setActive', () => {
describe('with `active` session status', () => {
const mockSession = {
Expand DownExpand Up@@ -1205,6 +1240,104 @@ describe('Clerk singleton', () => {
});
});

it('uses __internal_navigateOnSetActive for completed sign in callbacks', async () => {
const sessionId = 'sess_123';
const mockSession = { id: sessionId, currentTask: null };
mockEnvironmentFetch.mockReturnValue(
Promise.resolve({
authConfig: {},
userSettings: mockUserSettings,
displayConfig: mockDisplayConfig,
isSingleSession: () => false,
isProduction: () => false,
isDevelopmentOrStaging: () => true,
onWindowLocationHost: () => false,
}),
);
mockClientFetch.mockReturnValue(
Promise.resolve({
signedInSessions: [],
signIn: new SignIn({
status: 'complete',
created_session_id: sessionId,
} as any as SignInJSON),
signUp: new SignUp(null),
}),
);

const internalNavigateOnSetActive = vi.fn(async ({ session, redirectUrl, decorateUrl }) => {
expect(session).toBe(mockSession);
expect(redirectUrl).toBe('http://test.host/after-sign-in');
expect(decorateUrl('/decorated')).toBe('/decorated');
});
const mockSetActive = vi.fn(async ({ navigate }) => navigate({ session: mockSession }));

const sut = new Clerk(productionPublishableKey);
await sut.load(mockedLoadOptions);
sut.setActive = mockSetActive as any;

await sut.handleRedirectCallback({
signInForceRedirectUrl: '/after-sign-in',
__internal_navigateOnSetActive: internalNavigateOnSetActive,
});

expect(mockSetActive).toHaveBeenCalledWith({
session: sessionId,
navigate: expect.any(Function),
});
expect(internalNavigateOnSetActive).toHaveBeenCalledTimes(1);
expect(mockNavigate).not.toHaveBeenCalled();
});

it('uses __internal_navigateOnSetActive for completed sign up callbacks', async () => {
const sessionId = 'sess_123';
const mockSession = { id: sessionId, currentTask: null };
mockEnvironmentFetch.mockReturnValue(
Promise.resolve({
authConfig: {},
userSettings: mockUserSettings,
displayConfig: mockDisplayConfig,
isSingleSession: () => false,
isProduction: () => false,
isDevelopmentOrStaging: () => true,
onWindowLocationHost: () => false,
}),
);
mockClientFetch.mockReturnValue(
Promise.resolve({
signedInSessions: [],
signIn: new SignIn(null),
signUp: new SignUp({
status: 'complete',
created_session_id: sessionId,
} as any as SignUpJSON),
}),
);

const internalNavigateOnSetActive = vi.fn(async ({ session, redirectUrl, decorateUrl }) => {
expect(session).toBe(mockSession);
expect(redirectUrl).toBe('http://test.host/after-sign-up');
expect(decorateUrl('/decorated')).toBe('/decorated');
});
const mockSetActive = vi.fn(async ({ navigate }) => navigate({ session: mockSession }));

const sut = new Clerk(productionPublishableKey);
await sut.load(mockedLoadOptions);
sut.setActive = mockSetActive as any;

await sut.handleRedirectCallback({
signUpForceRedirectUrl: '/after-sign-up',
__internal_navigateOnSetActive: internalNavigateOnSetActive,
});

expect(mockSetActive).toHaveBeenCalledWith({
session: sessionId,
navigate: expect.any(Function),
});
expect(internalNavigateOnSetActive).toHaveBeenCalledTimes(1);
expect(mockNavigate).not.toHaveBeenCalled();
});

it('does not initiate the transfer flow when transferable: false is passed', async () => {
mockEnvironmentFetch.mockReturnValue(
Promise.resolve({
Expand Down
55 changes: 50 additions & 5 deletions packages/clerk-js/src/core/clerk.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -98,6 +98,7 @@ import type {
LoadedClerk,
NavigateOptions,
OAuthApplicationNamespace,
OAuthTransport,
OrganizationListProps,
OrganizationProfileProps,
OrganizationResource,
Expand DownExpand Up@@ -269,6 +270,7 @@ export class Clerk implements ClerkInterface {
#listeners: Array<(emission: Resources) => void> = [];
#navigationListeners: Array<() => void> = [];
#options: ClerkOptions = {};
#oauthTransport: OAuthTransport | null = null;
#pageLifecycle: ReturnType<typeof createPageLifecycle> | null = null;
#touchThrottledUntil = 0;
#publicEventBus = createClerkEventBus();
Expand All@@ -295,6 +297,14 @@ export class Clerk implements ClerkInterface {
: undefined;
}

get __internal_hasOAuthTransport(): boolean {
return this.#oauthTransport !== null;
}

get __internal_oauthTransport(): OAuthTransport | null {
return this.#oauthTransport;
}

public __internal_getCachedResources:
| (() => Promise<{ client: ClientJSONSnapshot | null; environment: EnvironmentJSONSnapshot | null }>)
| undefined;
Expand DownExpand Up@@ -529,6 +539,7 @@ export class Clerk implements ClerkInterface {
}

this.#options = this.#initOptions(options);
this.#oauthTransport = this.#options.__internal_oauthTransport ?? null;

// Initialize ClerkUI if it was provided
if (this.#options.ui?.ClerkUI) {
Expand DownExpand Up@@ -2285,7 +2296,7 @@ export class Clerk implements ClerkInterface {
return null;
};

public handleGoogleOneTapCallback = async (
public __internal_handleResourceCallback = async (
signInOrUp: SignInResource | SignUpResource,
params: HandleOAuthCallbackParams,
customNavigate?: (to: string) => Promise<unknown>,
Expand All@@ -2310,6 +2321,14 @@ export class Clerk implements ClerkInterface {
});
};

public handleGoogleOneTapCallback = async (
signInOrUp: SignInResource | SignUpResource,
params: HandleOAuthCallbackParams,
customNavigate?: (to: string) => Promise<unknown>,
): Promise<unknown> => {
return this.__internal_handleResourceCallback(signInOrUp, params, customNavigate);
};

private _handleRedirectCallback = async (
params: HandleOAuthCallbackParams,
{
Expand DownExpand Up@@ -2421,6 +2440,7 @@ export class Clerk implements ClerkInterface {

const signInUrl = params.signInUrl || displayConfig.signInUrl;
const signUpUrl = params.signUpUrl || displayConfig.signUpUrl;
const internalNavigateOnSetActive = params.__internal_navigateOnSetActive;

const setActiveNavigate = async ({
session,
Expand All@@ -2431,6 +2451,15 @@ export class Clerk implements ClerkInterface {
baseUrl: string;
redirectUrl: string;
}) => {
if (internalNavigateOnSetActive) {
await internalNavigateOnSetActive({
session,
redirectUrl,
decorateUrl: url => this.buildUrlWithAuth(url),
});
return;
}

if (!session.currentTask) {
await this.navigate(redirectUrl);
return;
Expand All@@ -2446,7 +2475,11 @@ export class Clerk implements ClerkInterface {
return this.setActive({
session: si.sessionId,
navigate: async ({ session }) => {
await setActiveNavigate({ session, baseUrl: signInUrl, redirectUrl: redirectUrls.getAfterSignInUrl() });
await setActiveNavigate({
session,
baseUrl: signInUrl,
redirectUrl: redirectUrls.getAfterSignInUrl(),
});
},
});
}
Expand All@@ -2461,7 +2494,11 @@ export class Clerk implements ClerkInterface {
return this.setActive({
session: res.createdSessionId,
navigate: async ({ session }) => {
await setActiveNavigate({ session, baseUrl: signUpUrl, redirectUrl: redirectUrls.getAfterSignInUrl() });
await setActiveNavigate({
session,
baseUrl: signUpUrl,
redirectUrl: redirectUrls.getAfterSignInUrl(),
});
},
});
case 'needs_first_factor':
Expand DownExpand Up@@ -2512,7 +2549,11 @@ export class Clerk implements ClerkInterface {
return this.setActive({
session: res.createdSessionId,
navigate: async ({ session }) => {
await setActiveNavigate({ session, baseUrl: signUpUrl, redirectUrl: redirectUrls.getAfterSignUpUrl() });
await setActiveNavigate({
session,
baseUrl: signUpUrl,
redirectUrl: redirectUrls.getAfterSignUpUrl(),
});
},
});
case 'missing_requirements':
Expand All@@ -2526,7 +2567,11 @@ export class Clerk implements ClerkInterface {
return this.setActive({
session: su.sessionId,
navigate: async ({ session }) => {
await setActiveNavigate({ session, baseUrl: signUpUrl, redirectUrl: redirectUrls.getAfterSignUpUrl() });
await setActiveNavigate({
session,
baseUrl: signUpUrl,
redirectUrl: redirectUrls.getAfterSignUpUrl(),
});
},
});
}
Expand Down
13 changes: 13 additions & 0 deletions packages/clerk-js/src/core/resources/SignIn.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -83,6 +83,7 @@ import {
_futureAuthenticateWithPopup,
wrapWithPopupRoutes,
} from '../../utils/authenticateWithPopup';
import { _authenticateWithTransport } from '../../utils/authenticateWithTransport';
import { CaptchaChallenge } from '../../utils/captcha/CaptchaChallenge';
import { runAsyncResourceTask } from '../../utils/runAsyncResourceTask';
import { loadZxcvbn } from '../../utils/zxcvbn';
Expand DownExpand Up@@ -379,6 +380,18 @@ export class SignIn extends BaseResource implements SignInResource {
};

public authenticateWithRedirect = async (params: AuthenticateWithRedirectParams): Promise<void> => {
const transport = SignIn.clerk.__internal_oauthTransport;
if (transport) {
return _authenticateWithTransport({
clerk: SignIn.clerk,
transport,
resource: this,
authenticateMethod: this.authenticateWithRedirectOrPopup,
params,
callbackParams: params.__internal_callbackParams ?? {},
});
}
Comment on lines +383 to +393

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.

If no transport is registered, the existing redirect behavior is preserved. If a transport is registered, we reuse the same private authenticateWithRedirectOrPopup initiation path through _authenticateWithTransport


return this.authenticateWithRedirectOrPopup(params, windowNavigate);
};

Expand Down
13 changes: 13 additions & 0 deletions packages/clerk-js/src/core/resources/SignUp.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -54,6 +54,7 @@ import {
_futureAuthenticateWithPopup,
wrapWithPopupRoutes,
} from '../../utils/authenticateWithPopup';
import { _authenticateWithTransport } from '../../utils/authenticateWithTransport';
import { CaptchaChallenge } from '../../utils/captcha/CaptchaChallenge';
import { normalizeUnsafeMetadata } from '../../utils/resourceParams';
import { runAsyncResourceTask } from '../../utils/runAsyncResourceTask';
Expand DownExpand Up@@ -449,6 +450,18 @@ export class SignUp extends BaseResource implements SignUpResource {
unsafeMetadata?: SignUpUnsafeMetadata;
},
): Promise<void> => {
const transport = SignUp.clerk.__internal_oauthTransport;
if (transport) {
return _authenticateWithTransport({
clerk: SignUp.clerk,
transport,
resource: this,
authenticateMethod: this.authenticateWithRedirectOrPopup,
params,
callbackParams: params.__internal_callbackParams ?? {},
});
}

return this.authenticateWithRedirectOrPopup(params, windowNavigate);
};

Expand Down
41 changes: 41 additions & 0 deletions packages/clerk-js/src/core/resources/__tests__/SignIn.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -34,6 +34,47 @@ describe('SignIn', () => {
expect(snapshot).toBeDefined();
});

describe('authenticateWithRedirect with an OAuth transport', () => {
afterEach(() => {
vi.clearAllMocks();
SignIn.clerk = {} as any;
});

it('routes through the transport instead of windowNavigate when one is registered', async () => {
const open = vi.fn().mockResolvedValue({ callbackUrl: 'myapp://sso-callback' });
const handleResourceCallback = vi.fn().mockResolvedValue(undefined);
SignIn.clerk = {
buildUrlWithAuth: vi.fn(u => u),
__internal_oauthTransport: { getRedirectUrl: () => 'myapp://sso-callback', open },
__internal_handleResourceCallback: handleResourceCallback,
__internal_environment: { displayConfig: { captchaOauthBypass: [] } },
} as any;

const mockFetch = vi.fn().mockResolvedValueOnce({
client: null,
response: {
id: 'signin_123',
first_factor_verification: {
status: 'unverified',
external_verification_redirect_url: 'https://provider.example/auth',
},
},
});
BaseResource._fetch = mockFetch;

const signIn = new SignIn();
await signIn.authenticateWithRedirect({
strategy: 'oauth_google',
redirectUrl: '/sso-callback',
redirectUrlComplete: '/',
__internal_callbackParams: { signInUrl: '/sign-in' },
} as any);

expect(open).toHaveBeenCalledWith(new URL('https://provider.example/auth'));
expect(handleResourceCallback).toHaveBeenCalledWith(signIn, { signInUrl: '/sign-in' });
});
});

describe('signIn.create', () => {
afterEach(() => {
vi.clearAllMocks();
Expand Down
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms"); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
8 changes: 8 additions & 0 deletions .changeset/oauth-transport.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
---
'@clerk/shared': minor
'@clerk/clerk-js': minor
'@clerk/react': minor
'@clerk/ui': minor
---

Add internal OAuth transport support for native desktop SDK wrappers to run Clerk's prebuilt OAuth flows through a system browser.
133 changes: 133 additions & 0 deletions packages/clerk-js/src/core/__tests__/clerk.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -158,6 +158,41 @@ describe('Clerk singleton', () => {
});
});

describe('__internal_oauthTransport', () => {
it('defaults to null with no getter access errors', () => {
const sut = new Clerk(productionPublishableKey);

expect(sut.__internal_hasOAuthTransport).toBe(false);
expect(sut.__internal_oauthTransport).toBeNull();
});

it('exposes the transport registered via options after load', async () => {
const transport = {
getRedirectUrl: () => 'myapp://sso-callback',
open: async (_url: URL) => ({ callbackUrl: 'myapp://sso-callback' }),
};
const sut = new Clerk(productionPublishableKey);

await sut.load({ __internal_oauthTransport: transport });

expect(sut.__internal_hasOAuthTransport).toBe(true);
expect(sut.__internal_oauthTransport).toBe(transport);
});
});

describe('__internal_handleResourceCallback', () => {
it('handleGoogleOneTapCallback delegates to __internal_handleResourceCallback', async () => {
const clerk = new Clerk(productionPublishableKey);
await clerk.load();
const spy = vi.spyOn(clerk, '__internal_handleResourceCallback').mockResolvedValue(undefined);
const signInLike = { identifier: 'x' } as any;

await clerk.handleGoogleOneTapCallback(signInLike, { signInUrl: '/sign-in' });

expect(spy).toHaveBeenCalledWith(signInLike, { signInUrl: '/sign-in' }, undefined);
});
});

describe('.setActive', () => {
describe('with `active` session status', () => {
const mockSession = {
Expand DownExpand Up@@ -1205,6 +1240,104 @@ describe('Clerk singleton', () => {
});
});

it('uses __internal_navigateOnSetActive for completed sign in callbacks', async () => {
const sessionId = 'sess_123';
const mockSession = { id: sessionId, currentTask: null };
mockEnvironmentFetch.mockReturnValue(
Promise.resolve({
authConfig: {},
userSettings: mockUserSettings,
displayConfig: mockDisplayConfig,
isSingleSession: () => false,
isProduction: () => false,
isDevelopmentOrStaging: () => true,
onWindowLocationHost: () => false,
}),
);
mockClientFetch.mockReturnValue(
Promise.resolve({
signedInSessions: [],
signIn: new SignIn({
status: 'complete',
created_session_id: sessionId,
} as any as SignInJSON),
signUp: new SignUp(null),
}),
);

const internalNavigateOnSetActive = vi.fn(async ({ session, redirectUrl, decorateUrl }) => {
expect(session).toBe(mockSession);
expect(redirectUrl).toBe('http://test.host/after-sign-in');
expect(decorateUrl('/decorated')).toBe('/decorated');
});
const mockSetActive = vi.fn(async ({ navigate }) => navigate({ session: mockSession }));

const sut = new Clerk(productionPublishableKey);
await sut.load(mockedLoadOptions);
sut.setActive = mockSetActive as any;

await sut.handleRedirectCallback({
signInForceRedirectUrl: '/after-sign-in',
__internal_navigateOnSetActive: internalNavigateOnSetActive,
});

expect(mockSetActive).toHaveBeenCalledWith({
session: sessionId,
navigate: expect.any(Function),
});
expect(internalNavigateOnSetActive).toHaveBeenCalledTimes(1);
expect(mockNavigate).not.toHaveBeenCalled();
});

it('uses __internal_navigateOnSetActive for completed sign up callbacks', async () => {
const sessionId = 'sess_123';
const mockSession = { id: sessionId, currentTask: null };
mockEnvironmentFetch.mockReturnValue(
Promise.resolve({
authConfig: {},
userSettings: mockUserSettings,
displayConfig: mockDisplayConfig,
isSingleSession: () => false,
isProduction: () => false,
isDevelopmentOrStaging: () => true,
onWindowLocationHost: () => false,
}),
);
mockClientFetch.mockReturnValue(
Promise.resolve({
signedInSessions: [],
signIn: new SignIn(null),
signUp: new SignUp({
status: 'complete',
created_session_id: sessionId,
} as any as SignUpJSON),
}),
);

const internalNavigateOnSetActive = vi.fn(async ({ session, redirectUrl, decorateUrl }) => {
expect(session).toBe(mockSession);
expect(redirectUrl).toBe('http://test.host/after-sign-up');
expect(decorateUrl('/decorated')).toBe('/decorated');
});
const mockSetActive = vi.fn(async ({ navigate }) => navigate({ session: mockSession }));

const sut = new Clerk(productionPublishableKey);
await sut.load(mockedLoadOptions);
sut.setActive = mockSetActive as any;

await sut.handleRedirectCallback({
signUpForceRedirectUrl: '/after-sign-up',
__internal_navigateOnSetActive: internalNavigateOnSetActive,
});

expect(mockSetActive).toHaveBeenCalledWith({
session: sessionId,
navigate: expect.any(Function),
});
expect(internalNavigateOnSetActive).toHaveBeenCalledTimes(1);
expect(mockNavigate).not.toHaveBeenCalled();
});

it('does not initiate the transfer flow when transferable: false is passed', async () => {
mockEnvironmentFetch.mockReturnValue(
Promise.resolve({
Expand Down
55 changes: 50 additions & 5 deletions packages/clerk-js/src/core/clerk.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -98,6 +98,7 @@ import type {
LoadedClerk,
NavigateOptions,
OAuthApplicationNamespace,
OAuthTransport,
OrganizationListProps,
OrganizationProfileProps,
OrganizationResource,
Expand DownExpand Up@@ -269,6 +270,7 @@ export class Clerk implements ClerkInterface {
#listeners: Array<(emission: Resources) => void> = [];
#navigationListeners: Array<() => void> = [];
#options: ClerkOptions = {};
#oauthTransport: OAuthTransport | null = null;
#pageLifecycle: ReturnType<typeof createPageLifecycle> | null = null;
#touchThrottledUntil = 0;
#publicEventBus = createClerkEventBus();
Expand All@@ -295,6 +297,14 @@ export class Clerk implements ClerkInterface {
: undefined;
}

get __internal_hasOAuthTransport(): boolean {
return this.#oauthTransport !== null;
}

get __internal_oauthTransport(): OAuthTransport | null {
return this.#oauthTransport;
}

public __internal_getCachedResources:
| (() => Promise<{ client: ClientJSONSnapshot | null; environment: EnvironmentJSONSnapshot | null }>)
| undefined;
Expand DownExpand Up@@ -529,6 +539,7 @@ export class Clerk implements ClerkInterface {
}

this.#options = this.#initOptions(options);
this.#oauthTransport = this.#options.__internal_oauthTransport ?? null;

// Initialize ClerkUI if it was provided
if (this.#options.ui?.ClerkUI) {
Expand DownExpand Up@@ -2285,7 +2296,7 @@ export class Clerk implements ClerkInterface {
return null;
};

public handleGoogleOneTapCallback = async (
public __internal_handleResourceCallback = async (
signInOrUp: SignInResource | SignUpResource,
params: HandleOAuthCallbackParams,
customNavigate?: (to: string) => Promise<unknown>,
Expand All@@ -2310,6 +2321,14 @@ export class Clerk implements ClerkInterface {
});
};

public handleGoogleOneTapCallback = async (
signInOrUp: SignInResource | SignUpResource,
params: HandleOAuthCallbackParams,
customNavigate?: (to: string) => Promise<unknown>,
): Promise<unknown> => {
return this.__internal_handleResourceCallback(signInOrUp, params, customNavigate);
};

private _handleRedirectCallback = async (
params: HandleOAuthCallbackParams,
{
Expand DownExpand Up@@ -2421,6 +2440,7 @@ export class Clerk implements ClerkInterface {

const signInUrl = params.signInUrl || displayConfig.signInUrl;
const signUpUrl = params.signUpUrl || displayConfig.signUpUrl;
const internalNavigateOnSetActive = params.__internal_navigateOnSetActive;

const setActiveNavigate = async ({
session,
Expand All@@ -2431,6 +2451,15 @@ export class Clerk implements ClerkInterface {
baseUrl: string;
redirectUrl: string;
}) => {
if (internalNavigateOnSetActive) {
await internalNavigateOnSetActive({
session,
redirectUrl,
decorateUrl: url => this.buildUrlWithAuth(url),
});
return;
}

if (!session.currentTask) {
await this.navigate(redirectUrl);
return;
Expand All@@ -2446,7 +2475,11 @@ export class Clerk implements ClerkInterface {
return this.setActive({
session: si.sessionId,
navigate: async ({ session }) => {
await setActiveNavigate({ session, baseUrl: signInUrl, redirectUrl: redirectUrls.getAfterSignInUrl() });
await setActiveNavigate({
session,
baseUrl: signInUrl,
redirectUrl: redirectUrls.getAfterSignInUrl(),
});
},
});
}
Expand All@@ -2461,7 +2494,11 @@ export class Clerk implements ClerkInterface {
return this.setActive({
session: res.createdSessionId,
navigate: async ({ session }) => {
await setActiveNavigate({ session, baseUrl: signUpUrl, redirectUrl: redirectUrls.getAfterSignInUrl() });
await setActiveNavigate({
session,
baseUrl: signUpUrl,
redirectUrl: redirectUrls.getAfterSignInUrl(),
});
},
});
case 'needs_first_factor':
Expand DownExpand Up@@ -2512,7 +2549,11 @@ export class Clerk implements ClerkInterface {
return this.setActive({
session: res.createdSessionId,
navigate: async ({ session }) => {
await setActiveNavigate({ session, baseUrl: signUpUrl, redirectUrl: redirectUrls.getAfterSignUpUrl() });
await setActiveNavigate({
session,
baseUrl: signUpUrl,
redirectUrl: redirectUrls.getAfterSignUpUrl(),
});
},
});
case 'missing_requirements':
Expand All@@ -2526,7 +2567,11 @@ export class Clerk implements ClerkInterface {
return this.setActive({
session: su.sessionId,
navigate: async ({ session }) => {
await setActiveNavigate({ session, baseUrl: signUpUrl, redirectUrl: redirectUrls.getAfterSignUpUrl() });
await setActiveNavigate({
session,
baseUrl: signUpUrl,
redirectUrl: redirectUrls.getAfterSignUpUrl(),
});
},
});
}
Expand Down
13 changes: 13 additions & 0 deletions packages/clerk-js/src/core/resources/SignIn.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -83,6 +83,7 @@ import {
_futureAuthenticateWithPopup,
wrapWithPopupRoutes,
} from '../../utils/authenticateWithPopup';
import { _authenticateWithTransport } from '../../utils/authenticateWithTransport';
import { CaptchaChallenge } from '../../utils/captcha/CaptchaChallenge';
import { runAsyncResourceTask } from '../../utils/runAsyncResourceTask';
import { loadZxcvbn } from '../../utils/zxcvbn';
Expand DownExpand Up@@ -379,6 +380,18 @@ export class SignIn extends BaseResource implements SignInResource {
};

public authenticateWithRedirect = async (params: AuthenticateWithRedirectParams): Promise<void> => {
const transport = SignIn.clerk.__internal_oauthTransport;
if (transport) {
return _authenticateWithTransport({
clerk: SignIn.clerk,
transport,
resource: this,
authenticateMethod: this.authenticateWithRedirectOrPopup,
params,
callbackParams: params.__internal_callbackParams ?? {},
});
}
Comment on lines +383 to +393

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.

If no transport is registered, the existing redirect behavior is preserved. If a transport is registered, we reuse the same private authenticateWithRedirectOrPopup initiation path through _authenticateWithTransport


return this.authenticateWithRedirectOrPopup(params, windowNavigate);
};

Expand Down
13 changes: 13 additions & 0 deletions packages/clerk-js/src/core/resources/SignUp.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -54,6 +54,7 @@ import {
_futureAuthenticateWithPopup,
wrapWithPopupRoutes,
} from '../../utils/authenticateWithPopup';
import { _authenticateWithTransport } from '../../utils/authenticateWithTransport';
import { CaptchaChallenge } from '../../utils/captcha/CaptchaChallenge';
import { normalizeUnsafeMetadata } from '../../utils/resourceParams';
import { runAsyncResourceTask } from '../../utils/runAsyncResourceTask';
Expand DownExpand Up@@ -449,6 +450,18 @@ export class SignUp extends BaseResource implements SignUpResource {
unsafeMetadata?: SignUpUnsafeMetadata;
},
): Promise<void> => {
const transport = SignUp.clerk.__internal_oauthTransport;
if (transport) {
return _authenticateWithTransport({
clerk: SignUp.clerk,
transport,
resource: this,
authenticateMethod: this.authenticateWithRedirectOrPopup,
params,
callbackParams: params.__internal_callbackParams ?? {},
});
}

return this.authenticateWithRedirectOrPopup(params, windowNavigate);
};

Expand Down
41 changes: 41 additions & 0 deletions packages/clerk-js/src/core/resources/__tests__/SignIn.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -34,6 +34,47 @@ describe('SignIn', () => {
expect(snapshot).toBeDefined();
});

describe('authenticateWithRedirect with an OAuth transport', () => {
afterEach(() => {
vi.clearAllMocks();
SignIn.clerk = {} as any;
});

it('routes through the transport instead of windowNavigate when one is registered', async () => {
const open = vi.fn().mockResolvedValue({ callbackUrl: 'myapp://sso-callback' });
const handleResourceCallback = vi.fn().mockResolvedValue(undefined);
SignIn.clerk = {
buildUrlWithAuth: vi.fn(u => u),
__internal_oauthTransport: { getRedirectUrl: () => 'myapp://sso-callback', open },
__internal_handleResourceCallback: handleResourceCallback,
__internal_environment: { displayConfig: { captchaOauthBypass: [] } },
} as any;

const mockFetch = vi.fn().mockResolvedValueOnce({
client: null,
response: {
id: 'signin_123',
first_factor_verification: {
status: 'unverified',
external_verification_redirect_url: 'https://provider.example/auth',
},
},
});
BaseResource._fetch = mockFetch;

const signIn = new SignIn();
await signIn.authenticateWithRedirect({
strategy: 'oauth_google',
redirectUrl: '/sso-callback',
redirectUrlComplete: '/',
__internal_callbackParams: { signInUrl: '/sign-in' },
} as any);

expect(open).toHaveBeenCalledWith(new URL('https://provider.example/auth'));
expect(handleResourceCallback).toHaveBeenCalledWith(signIn, { signInUrl: '/sign-in' });
});
});

describe('signIn.create', () => {
afterEach(() => {
vi.clearAllMocks();
Expand Down
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links"); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
8 changes: 8 additions & 0 deletions .changeset/oauth-transport.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
---
'@clerk/shared': minor
'@clerk/clerk-js': minor
'@clerk/react': minor
'@clerk/ui': minor
---

Add internal OAuth transport support for native desktop SDK wrappers to run Clerk's prebuilt OAuth flows through a system browser.
133 changes: 133 additions & 0 deletions packages/clerk-js/src/core/__tests__/clerk.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -158,6 +158,41 @@ describe('Clerk singleton', () => {
});
});

describe('__internal_oauthTransport', () => {
it('defaults to null with no getter access errors', () => {
const sut = new Clerk(productionPublishableKey);

expect(sut.__internal_hasOAuthTransport).toBe(false);
expect(sut.__internal_oauthTransport).toBeNull();
});

it('exposes the transport registered via options after load', async () => {
const transport = {
getRedirectUrl: () => 'myapp://sso-callback',
open: async (_url: URL) => ({ callbackUrl: 'myapp://sso-callback' }),
};
const sut = new Clerk(productionPublishableKey);

await sut.load({ __internal_oauthTransport: transport });

expect(sut.__internal_hasOAuthTransport).toBe(true);
expect(sut.__internal_oauthTransport).toBe(transport);
});
});

describe('__internal_handleResourceCallback', () => {
it('handleGoogleOneTapCallback delegates to __internal_handleResourceCallback', async () => {
const clerk = new Clerk(productionPublishableKey);
await clerk.load();
const spy = vi.spyOn(clerk, '__internal_handleResourceCallback').mockResolvedValue(undefined);
const signInLike = { identifier: 'x' } as any;

await clerk.handleGoogleOneTapCallback(signInLike, { signInUrl: '/sign-in' });

expect(spy).toHaveBeenCalledWith(signInLike, { signInUrl: '/sign-in' }, undefined);
});
});

describe('.setActive', () => {
describe('with `active` session status', () => {
const mockSession = {
Expand DownExpand Up@@ -1205,6 +1240,104 @@ describe('Clerk singleton', () => {
});
});

it('uses __internal_navigateOnSetActive for completed sign in callbacks', async () => {
const sessionId = 'sess_123';
const mockSession = { id: sessionId, currentTask: null };
mockEnvironmentFetch.mockReturnValue(
Promise.resolve({
authConfig: {},
userSettings: mockUserSettings,
displayConfig: mockDisplayConfig,
isSingleSession: () => false,
isProduction: () => false,
isDevelopmentOrStaging: () => true,
onWindowLocationHost: () => false,
}),
);
mockClientFetch.mockReturnValue(
Promise.resolve({
signedInSessions: [],
signIn: new SignIn({
status: 'complete',
created_session_id: sessionId,
} as any as SignInJSON),
signUp: new SignUp(null),
}),
);

const internalNavigateOnSetActive = vi.fn(async ({ session, redirectUrl, decorateUrl }) => {
expect(session).toBe(mockSession);
expect(redirectUrl).toBe('http://test.host/after-sign-in');
expect(decorateUrl('/decorated')).toBe('/decorated');
});
const mockSetActive = vi.fn(async ({ navigate }) => navigate({ session: mockSession }));

const sut = new Clerk(productionPublishableKey);
await sut.load(mockedLoadOptions);
sut.setActive = mockSetActive as any;

await sut.handleRedirectCallback({
signInForceRedirectUrl: '/after-sign-in',
__internal_navigateOnSetActive: internalNavigateOnSetActive,
});

expect(mockSetActive).toHaveBeenCalledWith({
session: sessionId,
navigate: expect.any(Function),
});
expect(internalNavigateOnSetActive).toHaveBeenCalledTimes(1);
expect(mockNavigate).not.toHaveBeenCalled();
});

it('uses __internal_navigateOnSetActive for completed sign up callbacks', async () => {
const sessionId = 'sess_123';
const mockSession = { id: sessionId, currentTask: null };
mockEnvironmentFetch.mockReturnValue(
Promise.resolve({
authConfig: {},
userSettings: mockUserSettings,
displayConfig: mockDisplayConfig,
isSingleSession: () => false,
isProduction: () => false,
isDevelopmentOrStaging: () => true,
onWindowLocationHost: () => false,
}),
);
mockClientFetch.mockReturnValue(
Promise.resolve({
signedInSessions: [],
signIn: new SignIn(null),
signUp: new SignUp({
status: 'complete',
created_session_id: sessionId,
} as any as SignUpJSON),
}),
);

const internalNavigateOnSetActive = vi.fn(async ({ session, redirectUrl, decorateUrl }) => {
expect(session).toBe(mockSession);
expect(redirectUrl).toBe('http://test.host/after-sign-up');
expect(decorateUrl('/decorated')).toBe('/decorated');
});
const mockSetActive = vi.fn(async ({ navigate }) => navigate({ session: mockSession }));

const sut = new Clerk(productionPublishableKey);
await sut.load(mockedLoadOptions);
sut.setActive = mockSetActive as any;

await sut.handleRedirectCallback({
signUpForceRedirectUrl: '/after-sign-up',
__internal_navigateOnSetActive: internalNavigateOnSetActive,
});

expect(mockSetActive).toHaveBeenCalledWith({
session: sessionId,
navigate: expect.any(Function),
});
expect(internalNavigateOnSetActive).toHaveBeenCalledTimes(1);
expect(mockNavigate).not.toHaveBeenCalled();
});

it('does not initiate the transfer flow when transferable: false is passed', async () => {
mockEnvironmentFetch.mockReturnValue(
Promise.resolve({
Expand Down
55 changes: 50 additions & 5 deletions packages/clerk-js/src/core/clerk.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -98,6 +98,7 @@ import type {
LoadedClerk,
NavigateOptions,
OAuthApplicationNamespace,
OAuthTransport,
OrganizationListProps,
OrganizationProfileProps,
OrganizationResource,
Expand DownExpand Up@@ -269,6 +270,7 @@ export class Clerk implements ClerkInterface {
#listeners: Array<(emission: Resources) => void> = [];
#navigationListeners: Array<() => void> = [];
#options: ClerkOptions = {};
#oauthTransport: OAuthTransport | null = null;
#pageLifecycle: ReturnType<typeof createPageLifecycle> | null = null;
#touchThrottledUntil = 0;
#publicEventBus = createClerkEventBus();
Expand All@@ -295,6 +297,14 @@ export class Clerk implements ClerkInterface {
: undefined;
}

get __internal_hasOAuthTransport(): boolean {
return this.#oauthTransport !== null;
}

get __internal_oauthTransport(): OAuthTransport | null {
return this.#oauthTransport;
}

public __internal_getCachedResources:
| (() => Promise<{ client: ClientJSONSnapshot | null; environment: EnvironmentJSONSnapshot | null }>)
| undefined;
Expand DownExpand Up@@ -529,6 +539,7 @@ export class Clerk implements ClerkInterface {
}

this.#options = this.#initOptions(options);
this.#oauthTransport = this.#options.__internal_oauthTransport ?? null;

// Initialize ClerkUI if it was provided
if (this.#options.ui?.ClerkUI) {
Expand DownExpand Up@@ -2285,7 +2296,7 @@ export class Clerk implements ClerkInterface {
return null;
};

public handleGoogleOneTapCallback = async (
public __internal_handleResourceCallback = async (
signInOrUp: SignInResource | SignUpResource,
params: HandleOAuthCallbackParams,
customNavigate?: (to: string) => Promise<unknown>,
Expand All@@ -2310,6 +2321,14 @@ export class Clerk implements ClerkInterface {
});
};

public handleGoogleOneTapCallback = async (
signInOrUp: SignInResource | SignUpResource,
params: HandleOAuthCallbackParams,
customNavigate?: (to: string) => Promise<unknown>,
): Promise<unknown> => {
return this.__internal_handleResourceCallback(signInOrUp, params, customNavigate);
};

private _handleRedirectCallback = async (
params: HandleOAuthCallbackParams,
{
Expand DownExpand Up@@ -2421,6 +2440,7 @@ export class Clerk implements ClerkInterface {

const signInUrl = params.signInUrl || displayConfig.signInUrl;
const signUpUrl = params.signUpUrl || displayConfig.signUpUrl;
const internalNavigateOnSetActive = params.__internal_navigateOnSetActive;

const setActiveNavigate = async ({
session,
Expand All@@ -2431,6 +2451,15 @@ export class Clerk implements ClerkInterface {
baseUrl: string;
redirectUrl: string;
}) => {
if (internalNavigateOnSetActive) {
await internalNavigateOnSetActive({
session,
redirectUrl,
decorateUrl: url => this.buildUrlWithAuth(url),
});
return;
}

if (!session.currentTask) {
await this.navigate(redirectUrl);
return;
Expand All@@ -2446,7 +2475,11 @@ export class Clerk implements ClerkInterface {
return this.setActive({
session: si.sessionId,
navigate: async ({ session }) => {
await setActiveNavigate({ session, baseUrl: signInUrl, redirectUrl: redirectUrls.getAfterSignInUrl() });
await setActiveNavigate({
session,
baseUrl: signInUrl,
redirectUrl: redirectUrls.getAfterSignInUrl(),
});
},
});
}
Expand All@@ -2461,7 +2494,11 @@ export class Clerk implements ClerkInterface {
return this.setActive({
session: res.createdSessionId,
navigate: async ({ session }) => {
await setActiveNavigate({ session, baseUrl: signUpUrl, redirectUrl: redirectUrls.getAfterSignInUrl() });
await setActiveNavigate({
session,
baseUrl: signUpUrl,
redirectUrl: redirectUrls.getAfterSignInUrl(),
});
},
});
case 'needs_first_factor':
Expand DownExpand Up@@ -2512,7 +2549,11 @@ export class Clerk implements ClerkInterface {
return this.setActive({
session: res.createdSessionId,
navigate: async ({ session }) => {
await setActiveNavigate({ session, baseUrl: signUpUrl, redirectUrl: redirectUrls.getAfterSignUpUrl() });
await setActiveNavigate({
session,
baseUrl: signUpUrl,
redirectUrl: redirectUrls.getAfterSignUpUrl(),
});
},
});
case 'missing_requirements':
Expand All@@ -2526,7 +2567,11 @@ export class Clerk implements ClerkInterface {
return this.setActive({
session: su.sessionId,
navigate: async ({ session }) => {
await setActiveNavigate({ session, baseUrl: signUpUrl, redirectUrl: redirectUrls.getAfterSignUpUrl() });
await setActiveNavigate({
session,
baseUrl: signUpUrl,
redirectUrl: redirectUrls.getAfterSignUpUrl(),
});
},
});
}
Expand Down
13 changes: 13 additions & 0 deletions packages/clerk-js/src/core/resources/SignIn.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -83,6 +83,7 @@ import {
_futureAuthenticateWithPopup,
wrapWithPopupRoutes,
} from '../../utils/authenticateWithPopup';
import { _authenticateWithTransport } from '../../utils/authenticateWithTransport';
import { CaptchaChallenge } from '../../utils/captcha/CaptchaChallenge';
import { runAsyncResourceTask } from '../../utils/runAsyncResourceTask';
import { loadZxcvbn } from '../../utils/zxcvbn';
Expand DownExpand Up@@ -379,6 +380,18 @@ export class SignIn extends BaseResource implements SignInResource {
};

public authenticateWithRedirect = async (params: AuthenticateWithRedirectParams): Promise<void> => {
const transport = SignIn.clerk.__internal_oauthTransport;
if (transport) {
return _authenticateWithTransport({
clerk: SignIn.clerk,
transport,
resource: this,
authenticateMethod: this.authenticateWithRedirectOrPopup,
params,
callbackParams: params.__internal_callbackParams ?? {},
});
}
Comment on lines +383 to +393

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.

If no transport is registered, the existing redirect behavior is preserved. If a transport is registered, we reuse the same private authenticateWithRedirectOrPopup initiation path through _authenticateWithTransport


return this.authenticateWithRedirectOrPopup(params, windowNavigate);
};

Expand Down
13 changes: 13 additions & 0 deletions packages/clerk-js/src/core/resources/SignUp.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -54,6 +54,7 @@ import {
_futureAuthenticateWithPopup,
wrapWithPopupRoutes,
} from '../../utils/authenticateWithPopup';
import { _authenticateWithTransport } from '../../utils/authenticateWithTransport';
import { CaptchaChallenge } from '../../utils/captcha/CaptchaChallenge';
import { normalizeUnsafeMetadata } from '../../utils/resourceParams';
import { runAsyncResourceTask } from '../../utils/runAsyncResourceTask';
Expand DownExpand Up@@ -449,6 +450,18 @@ export class SignUp extends BaseResource implements SignUpResource {
unsafeMetadata?: SignUpUnsafeMetadata;
},
): Promise<void> => {
const transport = SignUp.clerk.__internal_oauthTransport;
if (transport) {
return _authenticateWithTransport({
clerk: SignUp.clerk,
transport,
resource: this,
authenticateMethod: this.authenticateWithRedirectOrPopup,
params,
callbackParams: params.__internal_callbackParams ?? {},
});
}

return this.authenticateWithRedirectOrPopup(params, windowNavigate);
};

Expand Down
41 changes: 41 additions & 0 deletions packages/clerk-js/src/core/resources/__tests__/SignIn.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -34,6 +34,47 @@ describe('SignIn', () => {
expect(snapshot).toBeDefined();
});

describe('authenticateWithRedirect with an OAuth transport', () => {
afterEach(() => {
vi.clearAllMocks();
SignIn.clerk = {} as any;
});

it('routes through the transport instead of windowNavigate when one is registered', async () => {
const open = vi.fn().mockResolvedValue({ callbackUrl: 'myapp://sso-callback' });
const handleResourceCallback = vi.fn().mockResolvedValue(undefined);
SignIn.clerk = {
buildUrlWithAuth: vi.fn(u => u),
__internal_oauthTransport: { getRedirectUrl: () => 'myapp://sso-callback', open },
__internal_handleResourceCallback: handleResourceCallback,
__internal_environment: { displayConfig: { captchaOauthBypass: [] } },
} as any;

const mockFetch = vi.fn().mockResolvedValueOnce({
client: null,
response: {
id: 'signin_123',
first_factor_verification: {
status: 'unverified',
external_verification_redirect_url: 'https://provider.example/auth',
},
},
});
BaseResource._fetch = mockFetch;

const signIn = new SignIn();
await signIn.authenticateWithRedirect({
strategy: 'oauth_google',
redirectUrl: '/sso-callback',
redirectUrlComplete: '/',
__internal_callbackParams: { signInUrl: '/sign-in' },
} as any);

expect(open).toHaveBeenCalledWith(new URL('https://provider.example/auth'));
expect(handleResourceCallback).toHaveBeenCalledWith(signIn, { signInUrl: '/sign-in' });
});
});

describe('signIn.create', () => {
afterEach(() => {
vi.clearAllMocks();
Expand Down
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default"); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
8 changes: 8 additions & 0 deletions .changeset/oauth-transport.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
---
'@clerk/shared': minor
'@clerk/clerk-js': minor
'@clerk/react': minor
'@clerk/ui': minor
---

Add internal OAuth transport support for native desktop SDK wrappers to run Clerk's prebuilt OAuth flows through a system browser.
133 changes: 133 additions & 0 deletions packages/clerk-js/src/core/__tests__/clerk.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -158,6 +158,41 @@ describe('Clerk singleton', () => {
});
});

describe('__internal_oauthTransport', () => {
it('defaults to null with no getter access errors', () => {
const sut = new Clerk(productionPublishableKey);

expect(sut.__internal_hasOAuthTransport).toBe(false);
expect(sut.__internal_oauthTransport).toBeNull();
});

it('exposes the transport registered via options after load', async () => {
const transport = {
getRedirectUrl: () => 'myapp://sso-callback',
open: async (_url: URL) => ({ callbackUrl: 'myapp://sso-callback' }),
};
const sut = new Clerk(productionPublishableKey);

await sut.load({ __internal_oauthTransport: transport });

expect(sut.__internal_hasOAuthTransport).toBe(true);
expect(sut.__internal_oauthTransport).toBe(transport);
});
});

describe('__internal_handleResourceCallback', () => {
it('handleGoogleOneTapCallback delegates to __internal_handleResourceCallback', async () => {
const clerk = new Clerk(productionPublishableKey);
await clerk.load();
const spy = vi.spyOn(clerk, '__internal_handleResourceCallback').mockResolvedValue(undefined);
const signInLike = { identifier: 'x' } as any;

await clerk.handleGoogleOneTapCallback(signInLike, { signInUrl: '/sign-in' });

expect(spy).toHaveBeenCalledWith(signInLike, { signInUrl: '/sign-in' }, undefined);
});
});

describe('.setActive', () => {
describe('with `active` session status', () => {
const mockSession = {
Expand DownExpand Up@@ -1205,6 +1240,104 @@ describe('Clerk singleton', () => {
});
});

it('uses __internal_navigateOnSetActive for completed sign in callbacks', async () => {
const sessionId = 'sess_123';
const mockSession = { id: sessionId, currentTask: null };
mockEnvironmentFetch.mockReturnValue(
Promise.resolve({
authConfig: {},
userSettings: mockUserSettings,
displayConfig: mockDisplayConfig,
isSingleSession: () => false,
isProduction: () => false,
isDevelopmentOrStaging: () => true,
onWindowLocationHost: () => false,
}),
);
mockClientFetch.mockReturnValue(
Promise.resolve({
signedInSessions: [],
signIn: new SignIn({
status: 'complete',
created_session_id: sessionId,
} as any as SignInJSON),
signUp: new SignUp(null),
}),
);

const internalNavigateOnSetActive = vi.fn(async ({ session, redirectUrl, decorateUrl }) => {
expect(session).toBe(mockSession);
expect(redirectUrl).toBe('http://test.host/after-sign-in');
expect(decorateUrl('/decorated')).toBe('/decorated');
});
const mockSetActive = vi.fn(async ({ navigate }) => navigate({ session: mockSession }));

const sut = new Clerk(productionPublishableKey);
await sut.load(mockedLoadOptions);
sut.setActive = mockSetActive as any;

await sut.handleRedirectCallback({
signInForceRedirectUrl: '/after-sign-in',
__internal_navigateOnSetActive: internalNavigateOnSetActive,
});

expect(mockSetActive).toHaveBeenCalledWith({
session: sessionId,
navigate: expect.any(Function),
});
expect(internalNavigateOnSetActive).toHaveBeenCalledTimes(1);
expect(mockNavigate).not.toHaveBeenCalled();
});

it('uses __internal_navigateOnSetActive for completed sign up callbacks', async () => {
const sessionId = 'sess_123';
const mockSession = { id: sessionId, currentTask: null };
mockEnvironmentFetch.mockReturnValue(
Promise.resolve({
authConfig: {},
userSettings: mockUserSettings,
displayConfig: mockDisplayConfig,
isSingleSession: () => false,
isProduction: () => false,
isDevelopmentOrStaging: () => true,
onWindowLocationHost: () => false,
}),
);
mockClientFetch.mockReturnValue(
Promise.resolve({
signedInSessions: [],
signIn: new SignIn(null),
signUp: new SignUp({
status: 'complete',
created_session_id: sessionId,
} as any as SignUpJSON),
}),
);

const internalNavigateOnSetActive = vi.fn(async ({ session, redirectUrl, decorateUrl }) => {
expect(session).toBe(mockSession);
expect(redirectUrl).toBe('http://test.host/after-sign-up');
expect(decorateUrl('/decorated')).toBe('/decorated');
});
const mockSetActive = vi.fn(async ({ navigate }) => navigate({ session: mockSession }));

const sut = new Clerk(productionPublishableKey);
await sut.load(mockedLoadOptions);
sut.setActive = mockSetActive as any;

await sut.handleRedirectCallback({
signUpForceRedirectUrl: '/after-sign-up',
__internal_navigateOnSetActive: internalNavigateOnSetActive,
});

expect(mockSetActive).toHaveBeenCalledWith({
session: sessionId,
navigate: expect.any(Function),
});
expect(internalNavigateOnSetActive).toHaveBeenCalledTimes(1);
expect(mockNavigate).not.toHaveBeenCalled();
});

it('does not initiate the transfer flow when transferable: false is passed', async () => {
mockEnvironmentFetch.mockReturnValue(
Promise.resolve({
Expand Down
55 changes: 50 additions & 5 deletions packages/clerk-js/src/core/clerk.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -98,6 +98,7 @@ import type {
LoadedClerk,
NavigateOptions,
OAuthApplicationNamespace,
OAuthTransport,
OrganizationListProps,
OrganizationProfileProps,
OrganizationResource,
Expand DownExpand Up@@ -269,6 +270,7 @@ export class Clerk implements ClerkInterface {
#listeners: Array<(emission: Resources) => void> = [];
#navigationListeners: Array<() => void> = [];
#options: ClerkOptions = {};
#oauthTransport: OAuthTransport | null = null;
#pageLifecycle: ReturnType<typeof createPageLifecycle> | null = null;
#touchThrottledUntil = 0;
#publicEventBus = createClerkEventBus();
Expand All@@ -295,6 +297,14 @@ export class Clerk implements ClerkInterface {
: undefined;
}

get __internal_hasOAuthTransport(): boolean {
return this.#oauthTransport !== null;
}

get __internal_oauthTransport(): OAuthTransport | null {
return this.#oauthTransport;
}

public __internal_getCachedResources:
| (() => Promise<{ client: ClientJSONSnapshot | null; environment: EnvironmentJSONSnapshot | null }>)
| undefined;
Expand DownExpand Up@@ -529,6 +539,7 @@ export class Clerk implements ClerkInterface {
}

this.#options = this.#initOptions(options);
this.#oauthTransport = this.#options.__internal_oauthTransport ?? null;

// Initialize ClerkUI if it was provided
if (this.#options.ui?.ClerkUI) {
Expand DownExpand Up@@ -2285,7 +2296,7 @@ export class Clerk implements ClerkInterface {
return null;
};

public handleGoogleOneTapCallback = async (
public __internal_handleResourceCallback = async (
signInOrUp: SignInResource | SignUpResource,
params: HandleOAuthCallbackParams,
customNavigate?: (to: string) => Promise<unknown>,
Expand All@@ -2310,6 +2321,14 @@ export class Clerk implements ClerkInterface {
});
};

public handleGoogleOneTapCallback = async (
signInOrUp: SignInResource | SignUpResource,
params: HandleOAuthCallbackParams,
customNavigate?: (to: string) => Promise<unknown>,
): Promise<unknown> => {
return this.__internal_handleResourceCallback(signInOrUp, params, customNavigate);
};

private _handleRedirectCallback = async (
params: HandleOAuthCallbackParams,
{
Expand DownExpand Up@@ -2421,6 +2440,7 @@ export class Clerk implements ClerkInterface {

const signInUrl = params.signInUrl || displayConfig.signInUrl;
const signUpUrl = params.signUpUrl || displayConfig.signUpUrl;
const internalNavigateOnSetActive = params.__internal_navigateOnSetActive;

const setActiveNavigate = async ({
session,
Expand All@@ -2431,6 +2451,15 @@ export class Clerk implements ClerkInterface {
baseUrl: string;
redirectUrl: string;
}) => {
if (internalNavigateOnSetActive) {
await internalNavigateOnSetActive({
session,
redirectUrl,
decorateUrl: url => this.buildUrlWithAuth(url),
});
return;
}

if (!session.currentTask) {
await this.navigate(redirectUrl);
return;
Expand All@@ -2446,7 +2475,11 @@ export class Clerk implements ClerkInterface {
return this.setActive({
session: si.sessionId,
navigate: async ({ session }) => {
await setActiveNavigate({ session, baseUrl: signInUrl, redirectUrl: redirectUrls.getAfterSignInUrl() });
await setActiveNavigate({
session,
baseUrl: signInUrl,
redirectUrl: redirectUrls.getAfterSignInUrl(),
});
},
});
}
Expand All@@ -2461,7 +2494,11 @@ export class Clerk implements ClerkInterface {
return this.setActive({
session: res.createdSessionId,
navigate: async ({ session }) => {
await setActiveNavigate({ session, baseUrl: signUpUrl, redirectUrl: redirectUrls.getAfterSignInUrl() });
await setActiveNavigate({
session,
baseUrl: signUpUrl,
redirectUrl: redirectUrls.getAfterSignInUrl(),
});
},
});
case 'needs_first_factor':
Expand DownExpand Up@@ -2512,7 +2549,11 @@ export class Clerk implements ClerkInterface {
return this.setActive({
session: res.createdSessionId,
navigate: async ({ session }) => {
await setActiveNavigate({ session, baseUrl: signUpUrl, redirectUrl: redirectUrls.getAfterSignUpUrl() });
await setActiveNavigate({
session,
baseUrl: signUpUrl,
redirectUrl: redirectUrls.getAfterSignUpUrl(),
});
},
});
case 'missing_requirements':
Expand All@@ -2526,7 +2567,11 @@ export class Clerk implements ClerkInterface {
return this.setActive({
session: su.sessionId,
navigate: async ({ session }) => {
await setActiveNavigate({ session, baseUrl: signUpUrl, redirectUrl: redirectUrls.getAfterSignUpUrl() });
await setActiveNavigate({
session,
baseUrl: signUpUrl,
redirectUrl: redirectUrls.getAfterSignUpUrl(),
});
},
});
}
Expand Down
13 changes: 13 additions & 0 deletions packages/clerk-js/src/core/resources/SignIn.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -83,6 +83,7 @@ import {
_futureAuthenticateWithPopup,
wrapWithPopupRoutes,
} from '../../utils/authenticateWithPopup';
import { _authenticateWithTransport } from '../../utils/authenticateWithTransport';
import { CaptchaChallenge } from '../../utils/captcha/CaptchaChallenge';
import { runAsyncResourceTask } from '../../utils/runAsyncResourceTask';
import { loadZxcvbn } from '../../utils/zxcvbn';
Expand DownExpand Up@@ -379,6 +380,18 @@ export class SignIn extends BaseResource implements SignInResource {
};

public authenticateWithRedirect = async (params: AuthenticateWithRedirectParams): Promise<void> => {
const transport = SignIn.clerk.__internal_oauthTransport;
if (transport) {
return _authenticateWithTransport({
clerk: SignIn.clerk,
transport,
resource: this,
authenticateMethod: this.authenticateWithRedirectOrPopup,
params,
callbackParams: params.__internal_callbackParams ?? {},
});
}
Comment on lines +383 to +393

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.

If no transport is registered, the existing redirect behavior is preserved. If a transport is registered, we reuse the same private authenticateWithRedirectOrPopup initiation path through _authenticateWithTransport


return this.authenticateWithRedirectOrPopup(params, windowNavigate);
};

Expand Down
13 changes: 13 additions & 0 deletions packages/clerk-js/src/core/resources/SignUp.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -54,6 +54,7 @@ import {
_futureAuthenticateWithPopup,
wrapWithPopupRoutes,
} from '../../utils/authenticateWithPopup';
import { _authenticateWithTransport } from '../../utils/authenticateWithTransport';
import { CaptchaChallenge } from '../../utils/captcha/CaptchaChallenge';
import { normalizeUnsafeMetadata } from '../../utils/resourceParams';
import { runAsyncResourceTask } from '../../utils/runAsyncResourceTask';
Expand DownExpand Up@@ -449,6 +450,18 @@ export class SignUp extends BaseResource implements SignUpResource {
unsafeMetadata?: SignUpUnsafeMetadata;
},
): Promise<void> => {
const transport = SignUp.clerk.__internal_oauthTransport;
if (transport) {
return _authenticateWithTransport({
clerk: SignUp.clerk,
transport,
resource: this,
authenticateMethod: this.authenticateWithRedirectOrPopup,
params,
callbackParams: params.__internal_callbackParams ?? {},
});
}

return this.authenticateWithRedirectOrPopup(params, windowNavigate);
};

Expand Down
41 changes: 41 additions & 0 deletions packages/clerk-js/src/core/resources/__tests__/SignIn.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -34,6 +34,47 @@ describe('SignIn', () => {
expect(snapshot).toBeDefined();
});

describe('authenticateWithRedirect with an OAuth transport', () => {
afterEach(() => {
vi.clearAllMocks();
SignIn.clerk = {} as any;
});

it('routes through the transport instead of windowNavigate when one is registered', async () => {
const open = vi.fn().mockResolvedValue({ callbackUrl: 'myapp://sso-callback' });
const handleResourceCallback = vi.fn().mockResolvedValue(undefined);
SignIn.clerk = {
buildUrlWithAuth: vi.fn(u => u),
__internal_oauthTransport: { getRedirectUrl: () => 'myapp://sso-callback', open },
__internal_handleResourceCallback: handleResourceCallback,
__internal_environment: { displayConfig: { captchaOauthBypass: [] } },
} as any;

const mockFetch = vi.fn().mockResolvedValueOnce({
client: null,
response: {
id: 'signin_123',
first_factor_verification: {
status: 'unverified',
external_verification_redirect_url: 'https://provider.example/auth',
},
},
});
BaseResource._fetch = mockFetch;

const signIn = new SignIn();
await signIn.authenticateWithRedirect({
strategy: 'oauth_google',
redirectUrl: '/sso-callback',
redirectUrlComplete: '/',
__internal_callbackParams: { signInUrl: '/sign-in' },
} as any);

expect(open).toHaveBeenCalledWith(new URL('https://provider.example/auth'));
expect(handleResourceCallback).toHaveBeenCalledWith(signIn, { signInUrl: '/sign-in' });
});
});

describe('signIn.create', () => {
afterEach(() => {
vi.clearAllMocks();
Expand Down
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers"); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
8 changes: 8 additions & 0 deletions .changeset/oauth-transport.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
---
'@clerk/shared': minor
'@clerk/clerk-js': minor
'@clerk/react': minor
'@clerk/ui': minor
---

Add internal OAuth transport support for native desktop SDK wrappers to run Clerk's prebuilt OAuth flows through a system browser.
133 changes: 133 additions & 0 deletions packages/clerk-js/src/core/__tests__/clerk.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -158,6 +158,41 @@ describe('Clerk singleton', () => {
});
});

describe('__internal_oauthTransport', () => {
it('defaults to null with no getter access errors', () => {
const sut = new Clerk(productionPublishableKey);

expect(sut.__internal_hasOAuthTransport).toBe(false);
expect(sut.__internal_oauthTransport).toBeNull();
});

it('exposes the transport registered via options after load', async () => {
const transport = {
getRedirectUrl: () => 'myapp://sso-callback',
open: async (_url: URL) => ({ callbackUrl: 'myapp://sso-callback' }),
};
const sut = new Clerk(productionPublishableKey);

await sut.load({ __internal_oauthTransport: transport });

expect(sut.__internal_hasOAuthTransport).toBe(true);
expect(sut.__internal_oauthTransport).toBe(transport);
});
});

describe('__internal_handleResourceCallback', () => {
it('handleGoogleOneTapCallback delegates to __internal_handleResourceCallback', async () => {
const clerk = new Clerk(productionPublishableKey);
await clerk.load();
const spy = vi.spyOn(clerk, '__internal_handleResourceCallback').mockResolvedValue(undefined);
const signInLike = { identifier: 'x' } as any;

await clerk.handleGoogleOneTapCallback(signInLike, { signInUrl: '/sign-in' });

expect(spy).toHaveBeenCalledWith(signInLike, { signInUrl: '/sign-in' }, undefined);
});
});

describe('.setActive', () => {
describe('with `active` session status', () => {
const mockSession = {
Expand DownExpand Up@@ -1205,6 +1240,104 @@ describe('Clerk singleton', () => {
});
});

it('uses __internal_navigateOnSetActive for completed sign in callbacks', async () => {
const sessionId = 'sess_123';
const mockSession = { id: sessionId, currentTask: null };
mockEnvironmentFetch.mockReturnValue(
Promise.resolve({
authConfig: {},
userSettings: mockUserSettings,
displayConfig: mockDisplayConfig,
isSingleSession: () => false,
isProduction: () => false,
isDevelopmentOrStaging: () => true,
onWindowLocationHost: () => false,
}),
);
mockClientFetch.mockReturnValue(
Promise.resolve({
signedInSessions: [],
signIn: new SignIn({
status: 'complete',
created_session_id: sessionId,
} as any as SignInJSON),
signUp: new SignUp(null),
}),
);

const internalNavigateOnSetActive = vi.fn(async ({ session, redirectUrl, decorateUrl }) => {
expect(session).toBe(mockSession);
expect(redirectUrl).toBe('http://test.host/after-sign-in');
expect(decorateUrl('/decorated')).toBe('/decorated');
});
const mockSetActive = vi.fn(async ({ navigate }) => navigate({ session: mockSession }));

const sut = new Clerk(productionPublishableKey);
await sut.load(mockedLoadOptions);
sut.setActive = mockSetActive as any;

await sut.handleRedirectCallback({
signInForceRedirectUrl: '/after-sign-in',
__internal_navigateOnSetActive: internalNavigateOnSetActive,
});

expect(mockSetActive).toHaveBeenCalledWith({
session: sessionId,
navigate: expect.any(Function),
});
expect(internalNavigateOnSetActive).toHaveBeenCalledTimes(1);
expect(mockNavigate).not.toHaveBeenCalled();
});

it('uses __internal_navigateOnSetActive for completed sign up callbacks', async () => {
const sessionId = 'sess_123';
const mockSession = { id: sessionId, currentTask: null };
mockEnvironmentFetch.mockReturnValue(
Promise.resolve({
authConfig: {},
userSettings: mockUserSettings,
displayConfig: mockDisplayConfig,
isSingleSession: () => false,
isProduction: () => false,
isDevelopmentOrStaging: () => true,
onWindowLocationHost: () => false,
}),
);
mockClientFetch.mockReturnValue(
Promise.resolve({
signedInSessions: [],
signIn: new SignIn(null),
signUp: new SignUp({
status: 'complete',
created_session_id: sessionId,
} as any as SignUpJSON),
}),
);

const internalNavigateOnSetActive = vi.fn(async ({ session, redirectUrl, decorateUrl }) => {
expect(session).toBe(mockSession);
expect(redirectUrl).toBe('http://test.host/after-sign-up');
expect(decorateUrl('/decorated')).toBe('/decorated');
});
const mockSetActive = vi.fn(async ({ navigate }) => navigate({ session: mockSession }));

const sut = new Clerk(productionPublishableKey);
await sut.load(mockedLoadOptions);
sut.setActive = mockSetActive as any;

await sut.handleRedirectCallback({
signUpForceRedirectUrl: '/after-sign-up',
__internal_navigateOnSetActive: internalNavigateOnSetActive,
});

expect(mockSetActive).toHaveBeenCalledWith({
session: sessionId,
navigate: expect.any(Function),
});
expect(internalNavigateOnSetActive).toHaveBeenCalledTimes(1);
expect(mockNavigate).not.toHaveBeenCalled();
});

it('does not initiate the transfer flow when transferable: false is passed', async () => {
mockEnvironmentFetch.mockReturnValue(
Promise.resolve({
Expand Down
55 changes: 50 additions & 5 deletions packages/clerk-js/src/core/clerk.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -98,6 +98,7 @@ import type {
LoadedClerk,
NavigateOptions,
OAuthApplicationNamespace,
OAuthTransport,
OrganizationListProps,
OrganizationProfileProps,
OrganizationResource,
Expand DownExpand Up@@ -269,6 +270,7 @@ export class Clerk implements ClerkInterface {
#listeners: Array<(emission: Resources) => void> = [];
#navigationListeners: Array<() => void> = [];
#options: ClerkOptions = {};
#oauthTransport: OAuthTransport | null = null;
#pageLifecycle: ReturnType<typeof createPageLifecycle> | null = null;
#touchThrottledUntil = 0;
#publicEventBus = createClerkEventBus();
Expand All@@ -295,6 +297,14 @@ export class Clerk implements ClerkInterface {
: undefined;
}

get __internal_hasOAuthTransport(): boolean {
return this.#oauthTransport !== null;
}

get __internal_oauthTransport(): OAuthTransport | null {
return this.#oauthTransport;
}

public __internal_getCachedResources:
| (() => Promise<{ client: ClientJSONSnapshot | null; environment: EnvironmentJSONSnapshot | null }>)
| undefined;
Expand DownExpand Up@@ -529,6 +539,7 @@ export class Clerk implements ClerkInterface {
}

this.#options = this.#initOptions(options);
this.#oauthTransport = this.#options.__internal_oauthTransport ?? null;

// Initialize ClerkUI if it was provided
if (this.#options.ui?.ClerkUI) {
Expand DownExpand Up@@ -2285,7 +2296,7 @@ export class Clerk implements ClerkInterface {
return null;
};

public handleGoogleOneTapCallback = async (
public __internal_handleResourceCallback = async (
signInOrUp: SignInResource | SignUpResource,
params: HandleOAuthCallbackParams,
customNavigate?: (to: string) => Promise<unknown>,
Expand All@@ -2310,6 +2321,14 @@ export class Clerk implements ClerkInterface {
});
};

public handleGoogleOneTapCallback = async (
signInOrUp: SignInResource | SignUpResource,
params: HandleOAuthCallbackParams,
customNavigate?: (to: string) => Promise<unknown>,
): Promise<unknown> => {
return this.__internal_handleResourceCallback(signInOrUp, params, customNavigate);
};

private _handleRedirectCallback = async (
params: HandleOAuthCallbackParams,
{
Expand DownExpand Up@@ -2421,6 +2440,7 @@ export class Clerk implements ClerkInterface {

const signInUrl = params.signInUrl || displayConfig.signInUrl;
const signUpUrl = params.signUpUrl || displayConfig.signUpUrl;
const internalNavigateOnSetActive = params.__internal_navigateOnSetActive;

const setActiveNavigate = async ({
session,
Expand All@@ -2431,6 +2451,15 @@ export class Clerk implements ClerkInterface {
baseUrl: string;
redirectUrl: string;
}) => {
if (internalNavigateOnSetActive) {
await internalNavigateOnSetActive({
session,
redirectUrl,
decorateUrl: url => this.buildUrlWithAuth(url),
});
return;
}

if (!session.currentTask) {
await this.navigate(redirectUrl);
return;
Expand All@@ -2446,7 +2475,11 @@ export class Clerk implements ClerkInterface {
return this.setActive({
session: si.sessionId,
navigate: async ({ session }) => {
await setActiveNavigate({ session, baseUrl: signInUrl, redirectUrl: redirectUrls.getAfterSignInUrl() });
await setActiveNavigate({
session,
baseUrl: signInUrl,
redirectUrl: redirectUrls.getAfterSignInUrl(),
});
},
});
}
Expand All@@ -2461,7 +2494,11 @@ export class Clerk implements ClerkInterface {
return this.setActive({
session: res.createdSessionId,
navigate: async ({ session }) => {
await setActiveNavigate({ session, baseUrl: signUpUrl, redirectUrl: redirectUrls.getAfterSignInUrl() });
await setActiveNavigate({
session,
baseUrl: signUpUrl,
redirectUrl: redirectUrls.getAfterSignInUrl(),
});
},
});
case 'needs_first_factor':
Expand DownExpand Up@@ -2512,7 +2549,11 @@ export class Clerk implements ClerkInterface {
return this.setActive({
session: res.createdSessionId,
navigate: async ({ session }) => {
await setActiveNavigate({ session, baseUrl: signUpUrl, redirectUrl: redirectUrls.getAfterSignUpUrl() });
await setActiveNavigate({
session,
baseUrl: signUpUrl,
redirectUrl: redirectUrls.getAfterSignUpUrl(),
});
},
});
case 'missing_requirements':
Expand All@@ -2526,7 +2567,11 @@ export class Clerk implements ClerkInterface {
return this.setActive({
session: su.sessionId,
navigate: async ({ session }) => {
await setActiveNavigate({ session, baseUrl: signUpUrl, redirectUrl: redirectUrls.getAfterSignUpUrl() });
await setActiveNavigate({
session,
baseUrl: signUpUrl,
redirectUrl: redirectUrls.getAfterSignUpUrl(),
});
},
});
}
Expand Down
13 changes: 13 additions & 0 deletions packages/clerk-js/src/core/resources/SignIn.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -83,6 +83,7 @@ import {
_futureAuthenticateWithPopup,
wrapWithPopupRoutes,
} from '../../utils/authenticateWithPopup';
import { _authenticateWithTransport } from '../../utils/authenticateWithTransport';
import { CaptchaChallenge } from '../../utils/captcha/CaptchaChallenge';
import { runAsyncResourceTask } from '../../utils/runAsyncResourceTask';
import { loadZxcvbn } from '../../utils/zxcvbn';
Expand DownExpand Up@@ -379,6 +380,18 @@ export class SignIn extends BaseResource implements SignInResource {
};

public authenticateWithRedirect = async (params: AuthenticateWithRedirectParams): Promise<void> => {
const transport = SignIn.clerk.__internal_oauthTransport;
if (transport) {
return _authenticateWithTransport({
clerk: SignIn.clerk,
transport,
resource: this,
authenticateMethod: this.authenticateWithRedirectOrPopup,
params,
callbackParams: params.__internal_callbackParams ?? {},
});
}
Comment on lines +383 to +393

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.

If no transport is registered, the existing redirect behavior is preserved. If a transport is registered, we reuse the same private authenticateWithRedirectOrPopup initiation path through _authenticateWithTransport


return this.authenticateWithRedirectOrPopup(params, windowNavigate);
};

Expand Down
13 changes: 13 additions & 0 deletions packages/clerk-js/src/core/resources/SignUp.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -54,6 +54,7 @@ import {
_futureAuthenticateWithPopup,
wrapWithPopupRoutes,
} from '../../utils/authenticateWithPopup';
import { _authenticateWithTransport } from '../../utils/authenticateWithTransport';
import { CaptchaChallenge } from '../../utils/captcha/CaptchaChallenge';
import { normalizeUnsafeMetadata } from '../../utils/resourceParams';
import { runAsyncResourceTask } from '../../utils/runAsyncResourceTask';
Expand DownExpand Up@@ -449,6 +450,18 @@ export class SignUp extends BaseResource implements SignUpResource {
unsafeMetadata?: SignUpUnsafeMetadata;
},
): Promise<void> => {
const transport = SignUp.clerk.__internal_oauthTransport;
if (transport) {
return _authenticateWithTransport({
clerk: SignUp.clerk,
transport,
resource: this,
authenticateMethod: this.authenticateWithRedirectOrPopup,
params,
callbackParams: params.__internal_callbackParams ?? {},
});
}

return this.authenticateWithRedirectOrPopup(params, windowNavigate);
};

Expand Down
41 changes: 41 additions & 0 deletions packages/clerk-js/src/core/resources/__tests__/SignIn.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -34,6 +34,47 @@ describe('SignIn', () => {
expect(snapshot).toBeDefined();
});

describe('authenticateWithRedirect with an OAuth transport', () => {
afterEach(() => {
vi.clearAllMocks();
SignIn.clerk = {} as any;
});

it('routes through the transport instead of windowNavigate when one is registered', async () => {
const open = vi.fn().mockResolvedValue({ callbackUrl: 'myapp://sso-callback' });
const handleResourceCallback = vi.fn().mockResolvedValue(undefined);
SignIn.clerk = {
buildUrlWithAuth: vi.fn(u => u),
__internal_oauthTransport: { getRedirectUrl: () => 'myapp://sso-callback', open },
__internal_handleResourceCallback: handleResourceCallback,
__internal_environment: { displayConfig: { captchaOauthBypass: [] } },
} as any;

const mockFetch = vi.fn().mockResolvedValueOnce({
client: null,
response: {
id: 'signin_123',
first_factor_verification: {
status: 'unverified',
external_verification_redirect_url: 'https://provider.example/auth',
},
},
});
BaseResource._fetch = mockFetch;

const signIn = new SignIn();
await signIn.authenticateWithRedirect({
strategy: 'oauth_google',
redirectUrl: '/sso-callback',
redirectUrlComplete: '/',
__internal_callbackParams: { signInUrl: '/sign-in' },
} as any);

expect(open).toHaveBeenCalledWith(new URL('https://provider.example/auth'));
expect(handleResourceCallback).toHaveBeenCalledWith(signIn, { signInUrl: '/sign-in' });
});
});

describe('signIn.create', () => {
afterEach(() => {
vi.clearAllMocks();
Expand Down
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode"); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })();
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
8 changes: 8 additions & 0 deletions .changeset/oauth-transport.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
---
'@clerk/shared': minor
'@clerk/clerk-js': minor
'@clerk/react': minor
'@clerk/ui': minor
---

Add internal OAuth transport support for native desktop SDK wrappers to run Clerk's prebuilt OAuth flows through a system browser.
133 changes: 133 additions & 0 deletions packages/clerk-js/src/core/__tests__/clerk.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -158,6 +158,41 @@ describe('Clerk singleton', () => {
});
});

describe('__internal_oauthTransport', () => {
it('defaults to null with no getter access errors', () => {
const sut = new Clerk(productionPublishableKey);

expect(sut.__internal_hasOAuthTransport).toBe(false);
expect(sut.__internal_oauthTransport).toBeNull();
});

it('exposes the transport registered via options after load', async () => {
const transport = {
getRedirectUrl: () => 'myapp://sso-callback',
open: async (_url: URL) => ({ callbackUrl: 'myapp://sso-callback' }),
};
const sut = new Clerk(productionPublishableKey);

await sut.load({ __internal_oauthTransport: transport });

expect(sut.__internal_hasOAuthTransport).toBe(true);
expect(sut.__internal_oauthTransport).toBe(transport);
});
});

describe('__internal_handleResourceCallback', () => {
it('handleGoogleOneTapCallback delegates to __internal_handleResourceCallback', async () => {
const clerk = new Clerk(productionPublishableKey);
await clerk.load();
const spy = vi.spyOn(clerk, '__internal_handleResourceCallback').mockResolvedValue(undefined);
const signInLike = { identifier: 'x' } as any;

await clerk.handleGoogleOneTapCallback(signInLike, { signInUrl: '/sign-in' });

expect(spy).toHaveBeenCalledWith(signInLike, { signInUrl: '/sign-in' }, undefined);
});
});

describe('.setActive', () => {
describe('with `active` session status', () => {
const mockSession = {
Expand DownExpand Up@@ -1205,6 +1240,104 @@ describe('Clerk singleton', () => {
});
});

it('uses __internal_navigateOnSetActive for completed sign in callbacks', async () => {
const sessionId = 'sess_123';
const mockSession = { id: sessionId, currentTask: null };
mockEnvironmentFetch.mockReturnValue(
Promise.resolve({
authConfig: {},
userSettings: mockUserSettings,
displayConfig: mockDisplayConfig,
isSingleSession: () => false,
isProduction: () => false,
isDevelopmentOrStaging: () => true,
onWindowLocationHost: () => false,
}),
);
mockClientFetch.mockReturnValue(
Promise.resolve({
signedInSessions: [],
signIn: new SignIn({
status: 'complete',
created_session_id: sessionId,
} as any as SignInJSON),
signUp: new SignUp(null),
}),
);

const internalNavigateOnSetActive = vi.fn(async ({ session, redirectUrl, decorateUrl }) => {
expect(session).toBe(mockSession);
expect(redirectUrl).toBe('http://test.host/after-sign-in');
expect(decorateUrl('/decorated')).toBe('/decorated');
});
const mockSetActive = vi.fn(async ({ navigate }) => navigate({ session: mockSession }));

const sut = new Clerk(productionPublishableKey);
await sut.load(mockedLoadOptions);
sut.setActive = mockSetActive as any;

await sut.handleRedirectCallback({
signInForceRedirectUrl: '/after-sign-in',
__internal_navigateOnSetActive: internalNavigateOnSetActive,
});

expect(mockSetActive).toHaveBeenCalledWith({
session: sessionId,
navigate: expect.any(Function),
});
expect(internalNavigateOnSetActive).toHaveBeenCalledTimes(1);
expect(mockNavigate).not.toHaveBeenCalled();
});

it('uses __internal_navigateOnSetActive for completed sign up callbacks', async () => {
const sessionId = 'sess_123';
const mockSession = { id: sessionId, currentTask: null };
mockEnvironmentFetch.mockReturnValue(
Promise.resolve({
authConfig: {},
userSettings: mockUserSettings,
displayConfig: mockDisplayConfig,
isSingleSession: () => false,
isProduction: () => false,
isDevelopmentOrStaging: () => true,
onWindowLocationHost: () => false,
}),
);
mockClientFetch.mockReturnValue(
Promise.resolve({
signedInSessions: [],
signIn: new SignIn(null),
signUp: new SignUp({
status: 'complete',
created_session_id: sessionId,
} as any as SignUpJSON),
}),
);

const internalNavigateOnSetActive = vi.fn(async ({ session, redirectUrl, decorateUrl }) => {
expect(session).toBe(mockSession);
expect(redirectUrl).toBe('http://test.host/after-sign-up');
expect(decorateUrl('/decorated')).toBe('/decorated');
});
const mockSetActive = vi.fn(async ({ navigate }) => navigate({ session: mockSession }));

const sut = new Clerk(productionPublishableKey);
await sut.load(mockedLoadOptions);
sut.setActive = mockSetActive as any;

await sut.handleRedirectCallback({
signUpForceRedirectUrl: '/after-sign-up',
__internal_navigateOnSetActive: internalNavigateOnSetActive,
});

expect(mockSetActive).toHaveBeenCalledWith({
session: sessionId,
navigate: expect.any(Function),
});
expect(internalNavigateOnSetActive).toHaveBeenCalledTimes(1);
expect(mockNavigate).not.toHaveBeenCalled();
});

it('does not initiate the transfer flow when transferable: false is passed', async () => {
mockEnvironmentFetch.mockReturnValue(
Promise.resolve({
Expand Down
55 changes: 50 additions & 5 deletions packages/clerk-js/src/core/clerk.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -98,6 +98,7 @@ import type {
LoadedClerk,
NavigateOptions,
OAuthApplicationNamespace,
OAuthTransport,
OrganizationListProps,
OrganizationProfileProps,
OrganizationResource,
Expand DownExpand Up@@ -269,6 +270,7 @@ export class Clerk implements ClerkInterface {
#listeners: Array<(emission: Resources) => void> = [];
#navigationListeners: Array<() => void> = [];
#options: ClerkOptions = {};
#oauthTransport: OAuthTransport | null = null;
#pageLifecycle: ReturnType<typeof createPageLifecycle> | null = null;
#touchThrottledUntil = 0;
#publicEventBus = createClerkEventBus();
Expand All@@ -295,6 +297,14 @@ export class Clerk implements ClerkInterface {
: undefined;
}

get __internal_hasOAuthTransport(): boolean {
return this.#oauthTransport !== null;
}

get __internal_oauthTransport(): OAuthTransport | null {
return this.#oauthTransport;
}

public __internal_getCachedResources:
| (() => Promise<{ client: ClientJSONSnapshot | null; environment: EnvironmentJSONSnapshot | null }>)
| undefined;
Expand DownExpand Up@@ -529,6 +539,7 @@ export class Clerk implements ClerkInterface {
}

this.#options = this.#initOptions(options);
this.#oauthTransport = this.#options.__internal_oauthTransport ?? null;

// Initialize ClerkUI if it was provided
if (this.#options.ui?.ClerkUI) {
Expand DownExpand Up@@ -2285,7 +2296,7 @@ export class Clerk implements ClerkInterface {
return null;
};

public handleGoogleOneTapCallback = async (
public __internal_handleResourceCallback = async (
signInOrUp: SignInResource | SignUpResource,
params: HandleOAuthCallbackParams,
customNavigate?: (to: string) => Promise<unknown>,
Expand All@@ -2310,6 +2321,14 @@ export class Clerk implements ClerkInterface {
});
};

public handleGoogleOneTapCallback = async (
signInOrUp: SignInResource | SignUpResource,
params: HandleOAuthCallbackParams,
customNavigate?: (to: string) => Promise<unknown>,
): Promise<unknown> => {
return this.__internal_handleResourceCallback(signInOrUp, params, customNavigate);
};

private _handleRedirectCallback = async (
params: HandleOAuthCallbackParams,
{
Expand DownExpand Up@@ -2421,6 +2440,7 @@ export class Clerk implements ClerkInterface {

const signInUrl = params.signInUrl || displayConfig.signInUrl;
const signUpUrl = params.signUpUrl || displayConfig.signUpUrl;
const internalNavigateOnSetActive = params.__internal_navigateOnSetActive;

const setActiveNavigate = async ({
session,
Expand All@@ -2431,6 +2451,15 @@ export class Clerk implements ClerkInterface {
baseUrl: string;
redirectUrl: string;
}) => {
if (internalNavigateOnSetActive) {
await internalNavigateOnSetActive({
session,
redirectUrl,
decorateUrl: url => this.buildUrlWithAuth(url),
});
return;
}

if (!session.currentTask) {
await this.navigate(redirectUrl);
return;
Expand All@@ -2446,7 +2475,11 @@ export class Clerk implements ClerkInterface {
return this.setActive({
session: si.sessionId,
navigate: async ({ session }) => {
await setActiveNavigate({ session, baseUrl: signInUrl, redirectUrl: redirectUrls.getAfterSignInUrl() });
await setActiveNavigate({
session,
baseUrl: signInUrl,
redirectUrl: redirectUrls.getAfterSignInUrl(),
});
},
});
}
Expand All@@ -2461,7 +2494,11 @@ export class Clerk implements ClerkInterface {
return this.setActive({
session: res.createdSessionId,
navigate: async ({ session }) => {
await setActiveNavigate({ session, baseUrl: signUpUrl, redirectUrl: redirectUrls.getAfterSignInUrl() });
await setActiveNavigate({
session,
baseUrl: signUpUrl,
redirectUrl: redirectUrls.getAfterSignInUrl(),
});
},
});
case 'needs_first_factor':
Expand DownExpand Up@@ -2512,7 +2549,11 @@ export class Clerk implements ClerkInterface {
return this.setActive({
session: res.createdSessionId,
navigate: async ({ session }) => {
await setActiveNavigate({ session, baseUrl: signUpUrl, redirectUrl: redirectUrls.getAfterSignUpUrl() });
await setActiveNavigate({
session,
baseUrl: signUpUrl,
redirectUrl: redirectUrls.getAfterSignUpUrl(),
});
},
});
case 'missing_requirements':
Expand All@@ -2526,7 +2567,11 @@ export class Clerk implements ClerkInterface {
return this.setActive({
session: su.sessionId,
navigate: async ({ session }) => {
await setActiveNavigate({ session, baseUrl: signUpUrl, redirectUrl: redirectUrls.getAfterSignUpUrl() });
await setActiveNavigate({
session,
baseUrl: signUpUrl,
redirectUrl: redirectUrls.getAfterSignUpUrl(),
});
},
});
}
Expand Down
13 changes: 13 additions & 0 deletions packages/clerk-js/src/core/resources/SignIn.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -83,6 +83,7 @@ import {
_futureAuthenticateWithPopup,
wrapWithPopupRoutes,
} from '../../utils/authenticateWithPopup';
import { _authenticateWithTransport } from '../../utils/authenticateWithTransport';
import { CaptchaChallenge } from '../../utils/captcha/CaptchaChallenge';
import { runAsyncResourceTask } from '../../utils/runAsyncResourceTask';
import { loadZxcvbn } from '../../utils/zxcvbn';
Expand DownExpand Up@@ -379,6 +380,18 @@ export class SignIn extends BaseResource implements SignInResource {
};

public authenticateWithRedirect = async (params: AuthenticateWithRedirectParams): Promise<void> => {
const transport = SignIn.clerk.__internal_oauthTransport;
if (transport) {
return _authenticateWithTransport({
clerk: SignIn.clerk,
transport,
resource: this,
authenticateMethod: this.authenticateWithRedirectOrPopup,
params,
callbackParams: params.__internal_callbackParams ?? {},
});
}
Comment on lines +383 to +393

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.

If no transport is registered, the existing redirect behavior is preserved. If a transport is registered, we reuse the same private authenticateWithRedirectOrPopup initiation path through _authenticateWithTransport


return this.authenticateWithRedirectOrPopup(params, windowNavigate);
};

Expand Down
13 changes: 13 additions & 0 deletions packages/clerk-js/src/core/resources/SignUp.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -54,6 +54,7 @@ import {
_futureAuthenticateWithPopup,
wrapWithPopupRoutes,
} from '../../utils/authenticateWithPopup';
import { _authenticateWithTransport } from '../../utils/authenticateWithTransport';
import { CaptchaChallenge } from '../../utils/captcha/CaptchaChallenge';
import { normalizeUnsafeMetadata } from '../../utils/resourceParams';
import { runAsyncResourceTask } from '../../utils/runAsyncResourceTask';
Expand DownExpand Up@@ -449,6 +450,18 @@ export class SignUp extends BaseResource implements SignUpResource {
unsafeMetadata?: SignUpUnsafeMetadata;
},
): Promise<void> => {
const transport = SignUp.clerk.__internal_oauthTransport;
if (transport) {
return _authenticateWithTransport({
clerk: SignUp.clerk,
transport,
resource: this,
authenticateMethod: this.authenticateWithRedirectOrPopup,
params,
callbackParams: params.__internal_callbackParams ?? {},
});
}

return this.authenticateWithRedirectOrPopup(params, windowNavigate);
};

Expand Down
41 changes: 41 additions & 0 deletions packages/clerk-js/src/core/resources/__tests__/SignIn.test.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -34,6 +34,47 @@ describe('SignIn', () => {
expect(snapshot).toBeDefined();
});

describe('authenticateWithRedirect with an OAuth transport', () => {
afterEach(() => {
vi.clearAllMocks();
SignIn.clerk = {} as any;
});

it('routes through the transport instead of windowNavigate when one is registered', async () => {
const open = vi.fn().mockResolvedValue({ callbackUrl: 'myapp://sso-callback' });
const handleResourceCallback = vi.fn().mockResolvedValue(undefined);
SignIn.clerk = {
buildUrlWithAuth: vi.fn(u => u),
__internal_oauthTransport: { getRedirectUrl: () => 'myapp://sso-callback', open },
__internal_handleResourceCallback: handleResourceCallback,
__internal_environment: { displayConfig: { captchaOauthBypass: [] } },
} as any;

const mockFetch = vi.fn().mockResolvedValueOnce({
client: null,
response: {
id: 'signin_123',
first_factor_verification: {
status: 'unverified',
external_verification_redirect_url: 'https://provider.example/auth',
},
},
});
BaseResource._fetch = mockFetch;

const signIn = new SignIn();
await signIn.authenticateWithRedirect({
strategy: 'oauth_google',
redirectUrl: '/sso-callback',
redirectUrlComplete: '/',
__internal_callbackParams: { signInUrl: '/sign-in' },
} as any);

expect(open).toHaveBeenCalledWith(new URL('https://provider.example/auth'));
expect(handleResourceCallback).toHaveBeenCalledWith(signIn, { signInUrl: '/sign-in' });
});
});

describe('signIn.create', () => {
afterEach(() => {
vi.clearAllMocks();
Expand Down
Loading
Loading