The open alternative to Salesforce, designed for AI.
TypeScript crmcrm-systemcustomergood-first-issuegraphqlhacktoberfestjavascriptmarketingmonoreponestjsopen-sourcepostgresqlreactreactjssalestypescriptweb
Fix handle in ConnectionProvider (#23674)
BOHEUS4fbe355a0faa
diff --git a/packages/twenty-docs/developers/extend/apps/logic/connections.mdx b/packages/twenty-docs/developers/extend/apps/logic/connections.mdxindex 5b573e07b36..cba67ececa4 100644--- a/packages/twenty-docs/developers/extend/apps/logic/connections.mdx+++ b/packages/twenty-docs/developers/extend/apps/logic/connections.mdx@@ -219,7 +219,8 @@ Each connection has:| `scopes` | OAuth permissions granted by the upstream provider (distinct from `visibility` — those are unrelated) || `userWorkspaceId` | The owner's userWorkspace id — useful for picking "the request user's connection" in HTTP-route triggers || `accessToken` | Fresh OAuth access token (refreshed automatically if expired) |-| `name` / `handle` | The connection's display name (auto-derived at OAuth callback, user-renameable) |+| `name` | The connection's display name (auto-derived at OAuth callback, user-renameable) |+| `handle` | The connected upstream account's email, refreshed on each reconnect; resolved from the OIDC `id_token` returned at token exchange, falling back to the connecting Twenty user's email when the provider doesn't return one || `authFailedAt` | Set when the most recent refresh failed; the user must reconnect |Key points:diff --git a/packages/twenty-server/src/engine/core-modules/application/connection-provider/connection-provider-oauth-flow.service.ts b/packages/twenty-server/src/engine/core-modules/application/connection-provider/connection-provider-oauth-flow.service.tsindex a9cb9d27685..f002790a65f 100644--- a/packages/twenty-server/src/engine/core-modules/application/connection-provider/connection-provider-oauth-flow.service.ts+++ b/packages/twenty-server/src/engine/core-modules/application/connection-provider/connection-provider-oauth-flow.service.ts@@ -19,12 +19,14 @@ import {import { buildAppOAuthCallbackUrl } from 'src/engine/core-modules/application/connection-provider/utils/build-callback-url.util';import { computePkceChallenge } from 'src/engine/core-modules/application/connection-provider/utils/compute-pkce-challenge.util';import { exchangeCodeForToken } from 'src/engine/core-modules/application/connection-provider/utils/exchange-code-for-token.util';+import { extractEmailFromIdTokenClaims } from 'src/engine/core-modules/application/connection-provider/utils/extract-email-from-id-token-claims.util';import { generatePkceVerifier } from 'src/engine/core-modules/application/connection-provider/utils/generate-pkce-verifier.util';import { type AppOAuthStateJwtPayload } from 'src/engine/core-modules/auth/types/app-oauth-state-jwt-payload.type';import { JwtTokenTypeEnum } from 'src/engine/core-modules/auth/types/jwt-token-type.enum';import { JwtWrapperService } from 'src/engine/core-modules/jwt/services/jwt-wrapper.service';import { SecureHttpClientService } from 'src/engine/core-modules/secure-http-client/secure-http-client.service';import { TwentyConfigService } from 'src/engine/core-modules/twenty-config/twenty-config.service';+import { UserEntity } from 'src/engine/core-modules/user/user.entity';import { ConnectedAccountEntity } from 'src/engine/metadata-modules/connected-account/entities/connected-account.entity';import { ConnectedAccountTokenEncryptionService } from 'src/engine/metadata-modules/connected-account/services/connected-account-token-encryption.service';@@ -65,6 +67,8 @@ export class ConnectionProviderOAuthFlowService {private readonly connectionProviderLifecycleHookService: ConnectionProviderLifecycleHookService,@InjectRepository(ConnectedAccountEntity)private readonly connectedAccountRepository: Repository<ConnectedAccountEntity>,+ @InjectRepository(UserEntity)+ private readonly userRepository: Repository<UserEntity>,) {}async startAuthorizationFlow(@@ -182,6 +186,7 @@ export class ConnectionProviderOAuthFlowService {provider,tokenResponse,workspaceId: statePayload.workspaceId,+ userId: statePayload.userId,userWorkspaceId: statePayload.userWorkspaceId,visibility: statePayload.visibility,reconnectingConnectedAccountId:@@ -235,10 +240,38 @@ export class ConnectionProviderOAuthFlowService {return this.twentyConfigService.get('SERVER_URL');}+ private async resolveConnectedAccountHandle({+ tokenResponse,+ userId,+ }: {+ tokenResponse: TokenExchangeResponse;+ userId: string;+ }): Promise<string> {+ const idTokenEmail = isDefined(tokenResponse.idToken)+ ? extractEmailFromIdTokenClaims(tokenResponse.idToken)+ : null;++ if (isDefined(idTokenEmail)) {+ return idTokenEmail;+ }++ const user = await this.userRepository.findOneBy({ id: userId });++ if (!isDefined(user)) {+ throw new ConnectionProviderException(+ 'User not found',+ ConnectionProviderExceptionCode.INVALID_STATE,+ );+ }++ return user.email;+ }+private async persistConnectedAccount({provider,tokenResponse,workspaceId,+ userId,userWorkspaceId,visibility,reconnectingConnectedAccountId,@@ -246,6 +279,7 @@ export class ConnectionProviderOAuthFlowService {provider: OAuthConnectionProvider;tokenResponse: TokenExchangeResponse;workspaceId: string;+ userId: string;userWorkspaceId: string;visibility: 'user' | 'workspace';reconnectingConnectedAccountId: string | null;@@ -259,6 +293,11 @@ export class ConnectionProviderOAuthFlowService {workspaceId,});+ const handle = await this.resolveConnectedAccountHandle({+ tokenResponse,+ userId,+ });+const sharedFields = {accessToken: encryptedAccessToken,refreshToken: encryptedRefreshToken,@@ -266,6 +305,7 @@ export class ConnectionProviderOAuthFlowService {lastCredentialsRefreshedAt: new Date(),authFailedAt: null,visibility,+ handle,};if (isDefined(reconnectingConnectedAccountId)) {@@ -290,7 +330,6 @@ export class ConnectionProviderOAuthFlowService {const created = this.connectedAccountRepository.create({...sharedFields,- handle: name,name,visibility,provider: ConnectedAccountProvider.APP,diff --git a/packages/twenty-server/src/engine/core-modules/application/connection-provider/connection-provider.module.ts b/packages/twenty-server/src/engine/core-modules/application/connection-provider/connection-provider.module.tsindex c9715b96696..2a0e8da6086 100644--- a/packages/twenty-server/src/engine/core-modules/application/connection-provider/connection-provider.module.ts+++ b/packages/twenty-server/src/engine/core-modules/application/connection-provider/connection-provider.module.ts@@ -12,6 +12,7 @@ import { JwtModule } from 'src/engine/core-modules/jwt/jwt.module';import { SecretEncryptionModule } from 'src/engine/core-modules/secret-encryption/secret-encryption.module';import { SecureHttpClientModule } from 'src/engine/core-modules/secure-http-client/secure-http-client.module';import { TwentyConfigModule } from 'src/engine/core-modules/twenty-config/twenty-config.module';+import { UserEntity } from 'src/engine/core-modules/user/user.entity';import { ConnectedAccountEntity } from 'src/engine/metadata-modules/connected-account/entities/connected-account.entity';import { ConnectedAccountTokenEncryptionModule } from 'src/engine/metadata-modules/connected-account/services/connected-account-token-encryption.module';import { FlatConnectionProviderModule } from 'src/engine/metadata-modules/flat-connection-provider/flat-connection-provider.module';@@ -24,6 +25,7 @@ import { WorkspaceCacheModule } from 'src/engine/workspace-cache/workspace-cacheApplicationEntity,ApplicationRegistrationVariableEntity,ConnectedAccountEntity,+ UserEntity,]),JwtModule,SecretEncryptionModule,diff --git a/packages/twenty-server/src/engine/core-modules/application/connection-provider/types/token-exchange-response.type.ts b/packages/twenty-server/src/engine/core-modules/application/connection-provider/types/token-exchange-response.type.tsindex 125af9f710d..b0e83900c3a 100644--- a/packages/twenty-server/src/engine/core-modules/application/connection-provider/types/token-exchange-response.type.ts+++ b/packages/twenty-server/src/engine/core-modules/application/connection-provider/types/token-exchange-response.type.ts@@ -3,5 +3,6 @@ import { PlaintextString } from 'src/engine/core-modules/secret-encryption/brandexport type TokenExchangeResponse = {accessToken: PlaintextString;refreshToken: PlaintextString | null;+ idToken: PlaintextString | null;scopes: string[] | null;};diff --git a/packages/twenty-server/src/engine/core-modules/application/connection-provider/utils/__tests__/exchange-code-for-token.util.spec.ts b/packages/twenty-server/src/engine/core-modules/application/connection-provider/utils/__tests__/exchange-code-for-token.util.spec.tsindex 79d493bc0d1..008cafbb999 100644--- a/packages/twenty-server/src/engine/core-modules/application/connection-provider/utils/__tests__/exchange-code-for-token.util.spec.ts+++ b/packages/twenty-server/src/engine/core-modules/application/connection-provider/utils/__tests__/exchange-code-for-token.util.spec.ts@@ -42,6 +42,7 @@ describe('exchangeCodeForToken', () => {expect(result).toEqual({accessToken: 'lin_access',refreshToken: 'lin_refresh',+ idToken: null,scopes: ['read', 'write'],});@@ -140,6 +141,7 @@ describe('exchangeRefreshTokenForToken', () => {expect(result).toEqual({accessToken: 'new_access',refreshToken: 'new_refresh',+ idToken: null,scopes: null,});diff --git a/packages/twenty-server/src/engine/core-modules/application/connection-provider/utils/__tests__/extract-email-from-id-token-claims.util.spec.ts b/packages/twenty-server/src/engine/core-modules/application/connection-provider/utils/__tests__/extract-email-from-id-token-claims.util.spec.tsnew file mode 100644index 00000000000..96f0ca6cebf--- /dev/null+++ b/packages/twenty-server/src/engine/core-modules/application/connection-provider/utils/__tests__/extract-email-from-id-token-claims.util.spec.ts@@ -0,0 +1,75 @@+import * as jwt from 'jsonwebtoken';++import { extractEmailFromIdTokenClaims } from 'src/engine/core-modules/application/connection-provider/utils/extract-email-from-id-token-claims.util';++const GOOGLE_ID_TOKEN_CLAIMS = {+ iss: 'https://accounts.google.com',+ azp: '1234987819200.apps.googleusercontent.com',+ aud: '1234987819200.apps.googleusercontent.com',+ sub: '10769150350006150715113082367',+ at_hash: 'HK6E_P6Dh8Y93mRNtsDB1Q',+ hd: 'example.com',+ email: '[email protected]',+ email_verified: 'true',+ iat: 1353601026,+ exp: 1353604926,+ nonce: '0394852-3190485-2490358',+};++const MICROSOFT_ENTRA_ID_TOKEN_CLAIMS_WITH_UPN = {+ ver: '1.0',+ iss: 'https://sts.windows.net/72f988bf-86f1-41af-91ab-2d7cd011db47/',+ sub: 'HKZpfaHyWadeOouYlitjrI-KffTm222X1yNTz_c',+ aud: '6e74172b-be56-4843-9ff4-e66a39bb12e3',+ tid: '72f988bf-86f1-41af-91ab-2d7cd011db47',+ oid: '690222be-ff1a-4d56-abd1-7e4f7d38e474',+ upn: '[email protected]',+ unique_name: '[email protected]',+ iat: 1537231048,+ nbf: 1537231048,+ exp: 1537234948,+};++describe('extractEmailFromIdTokenClaims', () => {+ it('reads the email claim from a Google-shaped id_token', () => {+ const idToken = jwt.sign(GOOGLE_ID_TOKEN_CLAIMS, 'test-secret');++ expect(extractEmailFromIdTokenClaims(idToken)).toBe('[email protected]');+ });++ it('falls back to the upn claim on a Microsoft Entra ID-shaped id_token with no email claim', () => {+ const idToken = jwt.sign(+ MICROSOFT_ENTRA_ID_TOKEN_CLAIMS_WITH_UPN,+ 'test-secret',+ );++ expect(extractEmailFromIdTokenClaims(idToken)).toBe('[email protected]');+ });++ it('prefers the email claim over upn when both are present', () => {+ const idToken = jwt.sign(+ {+ ...MICROSOFT_ENTRA_ID_TOKEN_CLAIMS_WITH_UPN,+ email: '[email protected]',+ },+ 'test-secret',+ );++ expect(extractEmailFromIdTokenClaims(idToken)).toBe(+ '[email protected]',+ );+ });++ it('returns null when neither email nor upn claims are present', () => {+ const idToken = jwt.sign(+ { sub: '24400320', iss: 'https://server.example.com' },+ 'test-secret',+ );++ expect(extractEmailFromIdTokenClaims(idToken)).toBeNull();+ });++ it('returns null for a malformed token', () => {+ expect(extractEmailFromIdTokenClaims('not-a-jwt')).toBeNull();+ });+});diff --git a/packages/twenty-server/src/engine/core-modules/application/connection-provider/utils/extract-email-from-id-token-claims.util.ts b/packages/twenty-server/src/engine/core-modules/application/connection-provider/utils/extract-email-from-id-token-claims.util.tsnew file mode 100644index 00000000000..6432c1f71fd--- /dev/null+++ b/packages/twenty-server/src/engine/core-modules/application/connection-provider/utils/extract-email-from-id-token-claims.util.ts@@ -0,0 +1,10 @@+import { decodeJwtPayload } from 'src/engine/core-modules/jwt/utils/decode-jwt-payload.util';++export const extractEmailFromIdTokenClaims = (+ idToken: string,+): string | null => {+ const claims = decodeJwtPayload<{ email?: string; upn?: string }>(idToken);+ const email = claims?.email ?? claims?.upn;++ return typeof email === 'string' ? email : null;+};diff --git a/packages/twenty-server/src/engine/core-modules/application/connection-provider/utils/parse-token-response.util.ts b/packages/twenty-server/src/engine/core-modules/application/connection-provider/utils/parse-token-response.util.tsindex 0868b97cc7a..8a240213a6e 100644--- a/packages/twenty-server/src/engine/core-modules/application/connection-provider/utils/parse-token-response.util.ts+++ b/packages/twenty-server/src/engine/core-modules/application/connection-provider/utils/parse-token-response.util.ts@@ -21,6 +21,10 @@ export const parseTokenResponse = (typeof json.refresh_token === 'string'? (json.refresh_token as PlaintextString): null,+ idToken:+ typeof json.id_token === 'string'+ ? (json.id_token as PlaintextString)+ : null,scopes:typeof json.scope === 'string'? json.scope.split(/[\s,]+/).filter(Boolean)