The open alternative to Salesforce, designed for AI.
TypeScript crmcrm-systemcustomergood-first-issuegraphqlhacktoberfestjavascriptmarketingmonoreponestjsopen-sourcepostgresqlreactreactjssalestypescriptweb
fix(auth): preserve returnToPath across Google/Microsoft SSO redirects (#20537)
Félix Malfait49b966042080
diff --git a/packages/twenty-front/src/modules/auth/hooks/__tests__/useAuth.test.tsx b/packages/twenty-front/src/modules/auth/hooks/__tests__/useAuth.test.tsxindex 6477c083752..d7862eb45c8 100644--- a/packages/twenty-front/src/modules/auth/hooks/__tests__/useAuth.test.tsx+++ b/packages/twenty-front/src/modules/auth/hooks/__tests__/useAuth.test.tsx@@ -11,8 +11,10 @@ import {results,token,} from '@/auth/hooks/__mocks__/useAuth';+import { returnToPathState } from '@/auth/states/returnToPathState';import { SnackBarComponentInstanceContext } from '@/ui/feedback/snack-bar-manager/contexts/SnackBarComponentInstanceContext';import { renderHook } from '@testing-library/react';+import { getDefaultStore } from 'jotai';const redirectSpy = jest.fn();@@ -85,6 +87,7 @@ const renderHooks = () => {describe('useAuth', () => {beforeEach(() => {jest.clearAllMocks();+ getDefaultStore().set(returnToPathState.atom, '');});it('should return login token object', async () => {@@ -138,6 +141,47 @@ describe('useAuth', () => {);});+ it('should forward returnToPath to /auth/google when set in state', async () => {+ getDefaultStore().set(+ returnToPathState.atom,+ '/authorize?response_type=code&client_id=abc&state=xyz',+ );++ const { result } = renderHooks();++ await act(async () => {+ await result.current.signInWithGoogle({+ action: 'list-available-workspaces',+ });+ });++ const calledWithUrl = redirectSpy.mock.calls[0]?.[0] as string;+ const parsed = new URL(calledWithUrl);++ expect(parsed.pathname).toBe('/auth/google');+ expect(parsed.searchParams.get('action')).toBe('list-available-workspaces');+ expect(parsed.searchParams.get('returnToPath')).toBe(+ '/authorize?response_type=code&client_id=abc&state=xyz',+ );+ });++ it('should not forward an invalid (protocol-relative) returnToPath', async () => {+ getDefaultStore().set(returnToPathState.atom, '//evil.example.com');++ const { result } = renderHooks();++ await act(async () => {+ await result.current.signInWithGoogle({+ action: 'list-available-workspaces',+ });+ });++ const calledWithUrl = redirectSpy.mock.calls[0]?.[0] as string;+ const parsed = new URL(calledWithUrl);++ expect(parsed.searchParams.has('returnToPath')).toBe(false);+ });+it('should handle sign-out', async () => {sessionStorage.setItem('lingering-key', 'should-be-cleared');diff --git a/packages/twenty-front/src/modules/auth/hooks/useAuth.ts b/packages/twenty-front/src/modules/auth/hooks/useAuth.tsindex a152a60be47..b23c2360faa 100644--- a/packages/twenty-front/src/modules/auth/hooks/useAuth.ts+++ b/packages/twenty-front/src/modules/auth/hooks/useAuth.ts@@ -17,9 +17,12 @@ import {VerifyEmailAndGetWorkspaceAgnosticTokenDocument,} from '~/generated-metadata/graphql';+import { returnToPathState } from '@/auth/states/returnToPathState';import { tokenPairState } from '@/auth/states/tokenPairState';import { clearSessionLocalStorageKeys } from '@/auth/utils/clearSessionLocalStorageKeys';import { broadcastSignOutToOtherTabs } from '@/auth/utils/crossTabSignOut';+import { isValidReturnToPath } from '@/auth/utils/isValidReturnToPath';+import { isNonEmptyString } from '@sniptt/guards';import { useAtomStateValue } from '@/ui/utilities/state/jotai/hooks/useAtomStateValue';import { useSetAtomState } from '@/ui/utilities/state/jotai/hooks/useSetAtomState';@@ -524,9 +527,15 @@ export const useAuth = () => {url.searchParams.set('workspaceId', workspacePublicData.id);}+ const returnToPath = store.get(returnToPathState.atom);++ if (isNonEmptyString(returnToPath) && isValidReturnToPath(returnToPath)) {+ url.searchParams.set('returnToPath', returnToPath);+ }+return url.toString();},- [workspacePublicData],+ [workspacePublicData, store],);const handleGoogleLogin = useCallback(diff --git a/packages/twenty-server/src/engine/core-modules/auth/services/auth.service.ts b/packages/twenty-server/src/engine/core-modules/auth/services/auth.service.tsindex 14f4a10d0ae..220a1cd8e62 100644--- a/packages/twenty-server/src/engine/core-modules/auth/services/auth.service.ts+++ b/packages/twenty-server/src/engine/core-modules/auth/services/auth.service.ts@@ -10,6 +10,7 @@ import ms from 'ms';import { PasswordUpdateNotifyEmail } from 'twenty-emails';import { PermissionFlagType } from 'twenty-shared/constants';import { AppPath, ConnectedAccountProvider } from 'twenty-shared/types';+import { isNonEmptyString } from '@sniptt/guards';import { assertIsDefinedOrThrow, isDefined } from 'twenty-shared/utils';import { IsNull, Repository } from 'typeorm';@@ -761,10 +762,12 @@ export class AuthService {loginToken,workspace,billingCheckoutSessionState,+ returnToPath,}: {loginToken: string;workspace: WorkspaceDomainConfig;billingCheckoutSessionState?: string;+ returnToPath?: string;}) {const url = this.workspaceDomainsService.buildWorkspaceURL({workspace,@@ -772,6 +775,9 @@ export class AuthService {searchParams: {loginToken,...(billingCheckoutSessionState ? { billingCheckoutSessionState } : {}),+ ...(isNonEmptyString(returnToPath) && returnToPath.startsWith('/')+ ? { returnToPath }+ : {}),},});@@ -944,6 +950,7 @@ export class AuthService {billingCheckoutSessionState,action,locale,+ returnToPath,}: MicrosoftRequest['user'] | GoogleRequest['user'],authProvider: AuthProviderEnum.Google | AuthProviderEnum.Microsoft,): Promise<string> {@@ -995,6 +1002,9 @@ export class AuthService {targetedTokenType: JwtTokenTypeEnum.WORKSPACE_AGNOSTIC,}),}),+ ...(isNonEmptyString(returnToPath) && returnToPath.startsWith('/')+ ? { returnToPath }+ : {}),},});@@ -1066,6 +1076,7 @@ export class AuthService {loginToken: loginToken.token,workspace,billingCheckoutSessionState,+ returnToPath,});} catch (error) {return this.guardRedirectService.getRedirectErrorUrlAndCaptureExceptions({diff --git a/packages/twenty-server/src/engine/core-modules/auth/strategies/google.auth.strategy.ts b/packages/twenty-server/src/engine/core-modules/auth/strategies/google.auth.strategy.tsindex bcca948c323..890df81377a 100644--- a/packages/twenty-server/src/engine/core-modules/auth/strategies/google.auth.strategy.ts+++ b/packages/twenty-server/src/engine/core-modules/auth/strategies/google.auth.strategy.ts@@ -33,6 +33,7 @@ export type GoogleRequest = Omit<action: SocialSSOSignInUpActionType;workspaceId?: string;billingCheckoutSessionState?: string;+ returnToPath?: string;};};@@ -59,6 +60,7 @@ export class GoogleStrategy extends PassportStrategy(Strategy, 'google') {workspacePersonalInviteToken: req.query.workspacePersonalInviteToken,action: req.query.action,locale: req.query.locale,+ returnToPath: req.query.returnToPath,}),};@@ -97,6 +99,7 @@ export class GoogleStrategy extends PassportStrategy(Strategy, 'google') {billingCheckoutSessionState: state?.billingCheckoutSessionState,action: state?.action ?? 'list-available-workspaces',locale: state?.locale,+ returnToPath: state?.returnToPath,};done(null, user);diff --git a/packages/twenty-server/src/engine/core-modules/auth/strategies/microsoft.auth.strategy.ts b/packages/twenty-server/src/engine/core-modules/auth/strategies/microsoft.auth.strategy.tsindex 884a09429ba..a32f5fb5cc9 100644--- a/packages/twenty-server/src/engine/core-modules/auth/strategies/microsoft.auth.strategy.ts+++ b/packages/twenty-server/src/engine/core-modules/auth/strategies/microsoft.auth.strategy.ts@@ -31,6 +31,7 @@ export type MicrosoftRequest = Omit<workspaceId?: string;billingCheckoutSessionState?: string;action: SocialSSOSignInUpActionType;+ returnToPath?: string;};};@@ -58,6 +59,7 @@ export class MicrosoftStrategy extends PassportStrategy(Strategy, 'microsoft') {billingCheckoutSessionState: req.query.billingCheckoutSessionState,workspacePersonalInviteToken: req.query.workspacePersonalInviteToken,action: req.query.action,+ returnToPath: req.query.returnToPath,oauthRetryCount: req.query.oauthRetryCount? Number(req.query.oauthRetryCount): undefined,@@ -95,6 +97,7 @@ export class MicrosoftStrategy extends PassportStrategy(Strategy, 'microsoft') {billingCheckoutSessionState: state?.billingCheckoutSessionState,locale: state?.locale,action: state?.action ?? 'list-available-workspaces',+ returnToPath: state?.returnToPath,};done(null, user);diff --git a/packages/twenty-server/src/engine/core-modules/auth/types/social-sso-state.type.ts b/packages/twenty-server/src/engine/core-modules/auth/types/social-sso-state.type.tsindex efc375055e4..0ba9bef42f1 100644--- a/packages/twenty-server/src/engine/core-modules/auth/types/social-sso-state.type.ts+++ b/packages/twenty-server/src/engine/core-modules/auth/types/social-sso-state.type.ts@@ -9,4 +9,5 @@ export type SocialSSOState = {workspacePersonalInviteToken?: string;action?: SocialSSOSignInUpActionType;locale?: keyof typeof APP_LOCALES;+ returnToPath?: string;};