The open alternative to Salesforce, designed for AI.
TypeScript crmcrm-systemcustomergood-first-issuegraphqlhacktoberfestjavascriptmarketingmonoreponestjsopen-sourcepostgresqlreactreactjssalestypescriptweb
feat: allow API keys to export records (#27941)
Weikofdaf76b3acfe
diff --git a/packages/twenty-server/src/engine/core-modules/api-key/services/api-key.service.ts b/packages/twenty-server/src/engine/core-modules/api-key/services/api-key.service.tsindex 13a3fab1348..7dc1d920ec4 100644--- a/packages/twenty-server/src/engine/core-modules/api-key/services/api-key.service.ts+++ b/packages/twenty-server/src/engine/core-modules/api-key/services/api-key.service.ts@@ -2,6 +2,7 @@ import { Injectable } from '@nestjs/common';import { msg } from '@lingui/core/macro';import { isNull } from '@sniptt/guards';+import { isDefined } from 'twenty-shared/utils';import { IsNull } from 'typeorm';import { type QueryDeepPartialEntity } from 'typeorm/query-builder/QueryPartialEntity';@@ -10,6 +11,8 @@ import {ApiKeyException,ApiKeyExceptionCode,} from 'src/engine/core-modules/api-key/exceptions/api-key.exception';+import { isApiKeyActive } from 'src/engine/core-modules/api-key/utils/is-api-key-active.util';+import { isApiKeyExpired } from 'src/engine/core-modules/api-key/utils/is-api-key-expired.util';import { type ApiKeyToken } from 'src/engine/core-modules/auth/dto/api-key-token.dto';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';@@ -129,7 +132,7 @@ export class ApiKeyService {);}- if (apiKey.revokedAt) {+ if (this.isRevoked(apiKey)) {throw new ApiKeyException('This API Key is revoked',ApiKeyExceptionCode.API_KEY_REVOKED,@@ -139,7 +142,7 @@ export class ApiKeyService {);}- if (new Date() > apiKey.expiresAt) {+ if (this.isExpired(apiKey)) {throw new ApiKeyException('This API Key has expired',ApiKeyExceptionCode.API_KEY_EXPIRED,@@ -189,15 +192,15 @@ export class ApiKeyService {}isExpired(apiKey: ApiKeyEntity): boolean {- return new Date() > apiKey.expiresAt;+ return isApiKeyExpired(apiKey);}isRevoked(apiKey: ApiKeyEntity): boolean {- return !!apiKey.revokedAt;+ return isDefined(apiKey.revokedAt);}isActive(apiKey: ApiKeyEntity): boolean {- return !this.isRevoked(apiKey) && !this.isExpired(apiKey);+ return isApiKeyActive(apiKey);}private async invalidateApiKeyCache(workspaceId: string): Promise<void> {diff --git a/packages/twenty-server/src/engine/core-modules/api-key/utils/__tests__/is-api-key-active.util.spec.ts b/packages/twenty-server/src/engine/core-modules/api-key/utils/__tests__/is-api-key-active.util.spec.tsnew file mode 100644index 00000000000..4384891129e--- /dev/null+++ b/packages/twenty-server/src/engine/core-modules/api-key/utils/__tests__/is-api-key-active.util.spec.ts@@ -0,0 +1,33 @@+import { isApiKeyActive } from 'src/engine/core-modules/api-key/utils/is-api-key-active.util';++const NOW = new Date('2026-10-13T12:00:00.000Z');++describe('isApiKeyActive', () => {+ beforeEach(() => jest.useFakeTimers().setSystemTime(NOW));+ afterEach(() => jest.useRealTimers());++ it.each([false, true])(+ 'handles entity and cached dates, serialized: %s',+ (serialized) => {+ const date = (milliseconds: number) =>+ serialized+ ? new Date(milliseconds).toISOString()+ : new Date(milliseconds);+ expect(+ isApiKeyActive({ expiresAt: date(NOW.getTime() + 1), revokedAt: null }),+ ).toBe(true);+ expect(+ isApiKeyActive({ expiresAt: date(NOW.getTime()), revokedAt: null }),+ ).toBe(true);+ expect(+ isApiKeyActive({ expiresAt: date(NOW.getTime() - 1), revokedAt: null }),+ ).toBe(false);+ expect(+ isApiKeyActive({+ expiresAt: date(NOW.getTime() + 1),+ revokedAt: date(NOW.getTime() - 1),+ }),+ ).toBe(false);+ },+ );+});diff --git a/packages/twenty-server/src/engine/core-modules/api-key/utils/is-api-key-active.util.ts b/packages/twenty-server/src/engine/core-modules/api-key/utils/is-api-key-active.util.tsnew file mode 100644index 00000000000..44e0bf6f0e3--- /dev/null+++ b/packages/twenty-server/src/engine/core-modules/api-key/utils/is-api-key-active.util.ts@@ -0,0 +1,9 @@+import { isDefined } from 'twenty-shared/utils';++import { type ApiKeyEntity } from 'src/engine/core-modules/api-key/api-key.entity';+import { type FlatApiKey } from 'src/engine/core-modules/api-key/types/flat-api-key.type';+import { isApiKeyExpired } from 'src/engine/core-modules/api-key/utils/is-api-key-expired.util';++export const isApiKeyActive = (+ apiKey: Pick<ApiKeyEntity | FlatApiKey, 'revokedAt' | 'expiresAt'>,+): boolean => !isDefined(apiKey.revokedAt) && !isApiKeyExpired(apiKey);diff --git a/packages/twenty-server/src/engine/core-modules/api-key/utils/is-api-key-expired.util.ts b/packages/twenty-server/src/engine/core-modules/api-key/utils/is-api-key-expired.util.tsnew file mode 100644index 00000000000..a9a8364b46d--- /dev/null+++ b/packages/twenty-server/src/engine/core-modules/api-key/utils/is-api-key-expired.util.ts@@ -0,0 +1,6 @@+import { type ApiKeyEntity } from 'src/engine/core-modules/api-key/api-key.entity';+import { type FlatApiKey } from 'src/engine/core-modules/api-key/types/flat-api-key.type';++export const isApiKeyExpired = (+ apiKey: Pick<ApiKeyEntity | FlatApiKey, 'expiresAt'>,+): boolean => Date.now() > new Date(apiKey.expiresAt).getTime();diff --git a/packages/twenty-server/src/engine/core-modules/auth/strategies/jwt.auth.strategy.spec.ts b/packages/twenty-server/src/engine/core-modules/auth/strategies/jwt.auth.strategy.spec.tsindex b388b8f369f..07c3e7601bb 100644--- a/packages/twenty-server/src/engine/core-modules/auth/strategies/jwt.auth.strategy.spec.ts+++ b/packages/twenty-server/src/engine/core-modules/auth/strategies/jwt.auth.strategy.spec.ts@@ -208,6 +208,44 @@ describe('JwtAuthStrategy', () => {);});+ it.each([+ { offsetMilliseconds: -1, isAllowed: false },+ { offsetMilliseconds: 0, isAllowed: true },+ { offsetMilliseconds: 1, isAllowed: true },+ ])(+ 'validates cached API-key expiry at offset $offsetMilliseconds ms',+ async ({ offsetMilliseconds, isAllowed }) => {+ const payload: JwtPayload = {+ ...jwt,+ type: JwtTokenTypeEnum.API_KEY,+ workspaceId: 'workspace-id',+ };+ const workspace = new WorkspaceEntity();++ workspace.id = 'workspace-id';+ workspaceStore[payload.sub] = workspace;+ apiKeyStore[workspace.id] = {+ [jwt.jti]: {+ id: 'api-key-id',+ revokedAt: null,+ expiresAt: new Date(Date.now() + offsetMilliseconds).toISOString(),+ },+ };++ strategy = createStrategy();++ if (isAllowed) {+ await expect(strategy.validate(payload)).resolves.toMatchObject({+ apiKey: { id: 'api-key-id' },+ });+ } else {+ await expect(strategy.validate(payload)).rejects.toThrow(+ 'This API Key is expired',+ );+ }+ },+ );+it('should be truthy if type is API_KEY and API_KEY is not revoked', async () => {const payload = {...jwt,diff --git a/packages/twenty-server/src/engine/core-modules/auth/strategies/jwt.auth.strategy.ts b/packages/twenty-server/src/engine/core-modules/auth/strategies/jwt.auth.strategy.tsindex 891d327fd71..d1d4d483b16 100644--- a/packages/twenty-server/src/engine/core-modules/auth/strategies/jwt.auth.strategy.ts+++ b/packages/twenty-server/src/engine/core-modules/auth/strategies/jwt.auth.strategy.ts@@ -5,6 +5,7 @@ import { InjectRepository } from '@nestjs/typeorm';import { msg } from '@lingui/core/macro';import { type SecretOrKeyProvider, Strategy } from 'passport-jwt';import { CoreEntityCacheService } from 'src/engine/core-entity-cache/services/core-entity-cache.service';+import { isApiKeyExpired } from 'src/engine/core-modules/api-key/utils/is-api-key-expired.util';import {AuthException,AuthExceptionCode,@@ -94,7 +95,7 @@ export class JwtAuthStrategy extends PassportStrategy(Strategy, 'jwt') {);}- if (new Date(apiKey.expiresAt) < new Date()) {+ if (isApiKeyExpired(apiKey)) {throw new AuthException('This API Key is expired',AuthExceptionCode.FORBIDDEN_EXCEPTION,diff --git a/packages/twenty-server/src/engine/core-modules/file/controllers/file.controller.ts b/packages/twenty-server/src/engine/core-modules/file/controllers/file.controller.tsindex fd545d3957e..754306d9651 100644--- a/packages/twenty-server/src/engine/core-modules/file/controllers/file.controller.ts+++ b/packages/twenty-server/src/engine/core-modules/file/controllers/file.controller.ts@@ -204,7 +204,7 @@ export class FileController {playground: true,workspaceAgnostic: false,},- apiKey: false,+ apiKey: true,oauthClient: { withUser: true, withoutUser: false },application: { withUser: true, withoutUser: false },}),diff --git a/packages/twenty-server/src/engine/core-modules/record-export/guards/is-api-key-record-export-requester.guard.ts b/packages/twenty-server/src/engine/core-modules/record-export/guards/is-api-key-record-export-requester.guard.tsnew file mode 100644index 00000000000..b1ab17bad11--- /dev/null+++ b/packages/twenty-server/src/engine/core-modules/record-export/guards/is-api-key-record-export-requester.guard.ts@@ -0,0 +1,8 @@+import { isDefined } from 'twenty-shared/utils';++import { type RecordExportRequester } from 'src/engine/core-modules/record-export/types/record-export-requester.type';++export const isApiKeyRecordExportRequester = (+ requester: RecordExportRequester,+): requester is Extract<RecordExportRequester, { apiKeyId: string }> =>+ isDefined(requester.apiKeyId);diff --git a/packages/twenty-server/src/engine/core-modules/record-export/jobs/generate-record-export.job.ts b/packages/twenty-server/src/engine/core-modules/record-export/jobs/generate-record-export.job.tsindex f11c8ecf001..0d1be2a4e24 100644--- a/packages/twenty-server/src/engine/core-modules/record-export/jobs/generate-record-export.job.ts+++ b/packages/twenty-server/src/engine/core-modules/record-export/jobs/generate-record-export.job.ts@@ -32,6 +32,7 @@ import {type RecordExportProgress,} from 'src/engine/core-modules/record-export/types/record-export.type';import { formatRecordExportRow } from 'src/engine/core-modules/record-export/utils/format-record-export-row.util';+import { getRecordExportLocale } from 'src/engine/core-modules/record-export/utils/get-record-export-locale.util';import { InjectWorkspaceScopedRepository } from 'src/engine/twenty-orm/workspace-scoped-repository/inject-workspace-scoped-repository.decorator';import { WorkspaceScopedRepository } from 'src/engine/twenty-orm/workspace-scoped-repository/workspace-scoped-repository';@@ -72,7 +73,7 @@ export class GenerateRecordExportJob {);const requester =await this.recordExportWorkspaceService.resolveRequester(recordExport);- locale = requester.workspaceMember.locale;+ locale = getRecordExportLocale(requester);const context = await this.recordExportWorkspaceService.buildContext({parameters: recordExport.parameters,authContext: requester,diff --git a/packages/twenty-server/src/engine/core-modules/record-export/record-export.module.ts b/packages/twenty-server/src/engine/core-modules/record-export/record-export.module.tsindex d720d2d097f..070c86b6fd5 100644--- a/packages/twenty-server/src/engine/core-modules/record-export/record-export.module.ts+++ b/packages/twenty-server/src/engine/core-modules/record-export/record-export.module.ts@@ -1,6 +1,7 @@import { Module } from '@nestjs/common';import { TypeOrmModule } from '@nestjs/typeorm';+import { CoreEntityCacheModule } from 'src/engine/core-entity-cache/core-entity-cache.module';import { CoreCommonApiModule } from 'src/engine/api/common/core-common-api.module';import { FeatureFlagModule } from 'src/engine/core-modules/feature-flag/feature-flag.module';import { FileEntity } from 'src/engine/core-modules/file/entities/file.entity';@@ -20,6 +21,7 @@ import { WorkspaceCacheModule } from 'src/engine/workspace-cache/workspace-cacheTypeOrmModule.forFeature([FileEntity]),UserSessionModule,CoreCommonApiModule,+ CoreEntityCacheModule,FeatureFlagModule,JwtModule,UserWorkspaceModule,diff --git a/packages/twenty-server/src/engine/core-modules/record-export/record-export.resolver.ts b/packages/twenty-server/src/engine/core-modules/record-export/record-export.resolver.tsindex b1a2ffc45aa..7a7173db1e8 100644--- a/packages/twenty-server/src/engine/core-modules/record-export/record-export.resolver.ts+++ b/packages/twenty-server/src/engine/core-modules/record-export/record-export.resolver.ts@@ -26,7 +26,7 @@ import { AuthPrincipalGuard } from 'src/engine/guards/auth-principal.guard';playground: true,workspaceAgnostic: false,},- apiKey: false,+ apiKey: true,oauthClient: { withUser: true, withoutUser: false },application: { withUser: true, withoutUser: false },}),diff --git a/packages/twenty-server/src/engine/core-modules/record-export/services/record-export.workspace-service.ts b/packages/twenty-server/src/engine/core-modules/record-export/services/record-export.workspace-service.tsindex a845b6b9674..2c08ec1494a 100644--- a/packages/twenty-server/src/engine/core-modules/record-export/services/record-export.workspace-service.ts+++ b/packages/twenty-server/src/engine/core-modules/record-export/services/record-export.workspace-service.ts@@ -22,13 +22,15 @@ import { z } from 'zod';import { CommonFindManyQueryRunnerService } from 'src/engine/api/common/common-query-runners/common-find-many-query-runner.service';import { type CommonBaseQueryRunnerContext } from 'src/engine/api/common/types/common-base-query-runner-context.type';import { type CommonSelectedFields } from 'src/engine/api/common/types/common-selected-fields-result.type';+import { CoreEntityCacheService } from 'src/engine/core-entity-cache/services/core-entity-cache.service';+import { isApiKeyActive } from 'src/engine/core-modules/api-key/utils/is-api-key-active.util';+import { isApiKeyAuthContext } from 'src/engine/core-modules/auth/guards/is-api-key-auth-context.guard';+import { buildApiKeyAuthContext } from 'src/engine/core-modules/auth/utils/build-api-key-auth-context.util';+import { type RecordExportRequester } from 'src/engine/core-modules/record-export/types/record-export-requester.type';import { isUserAuthContext } from 'src/engine/core-modules/auth/guards/is-user-auth-context.guard';import { withWorkspaceAuthContext } from 'src/engine/core-modules/auth/storage/workspace-auth-context.storage';import { JwtTokenTypeEnum } from 'src/engine/core-modules/auth/types/jwt-token-type.enum';-import {- type WorkspaceAuthContext,- type UserWorkspaceAuthContext,-} from 'src/engine/core-modules/auth/types/workspace-auth-context.type';+import { type WorkspaceAuthContext } from 'src/engine/core-modules/auth/types/workspace-auth-context.type';import { buildUserAuthContext } from 'src/engine/core-modules/auth/utils/build-user-auth-context.util';import { CacheStorageService } from 'src/engine/core-modules/cache-storage/services/cache-storage.service';import { CacheStorageNamespace } from 'src/engine/core-modules/cache-storage/types/cache-storage-namespace.enum';@@ -48,12 +50,15 @@ import {} from 'src/engine/core-modules/record-export/constants/record-export.constants';import { UPDATE_OWNED_KEY_LEASE_SCRIPT } from 'src/engine/core-modules/cache-storage/constants/update-owned-key-lease-script.constant';import { type RecordExportDTO } from 'src/engine/core-modules/record-export/dtos/record-export.dto';+import { isApiKeyRecordExportRequester } from 'src/engine/core-modules/record-export/guards/is-api-key-record-export-requester.guard';import { RecordExportException } from 'src/engine/core-modules/record-export/record-export.exception';+import { type RecordExportAuthContext } from 'src/engine/core-modules/record-export/types/record-export-auth-context.type';import { type RecordExportColumn } from 'src/engine/core-modules/record-export/types/record-export-column.type';import { type RecordExportDownloadTokenJwtPayload } from 'src/engine/core-modules/record-export/types/record-export-download-token-jwt-payload.type';import { type RecordExportParameters } from 'src/engine/core-modules/record-export/types/record-export-parameters.type';import { type RecordExport } from 'src/engine/core-modules/record-export/types/record-export.type';import { buildRecordExportColumns } from 'src/engine/core-modules/record-export/utils/build-record-export-columns.util';+import { getRecordExportLocale } from 'src/engine/core-modules/record-export/utils/get-record-export-locale.util';import { UserSessionCookieService } from 'src/engine/core-modules/user-session/services/user-session-cookie.service';import { hashUserSessionToken } from 'src/engine/core-modules/user-session/utils/hash-user-session-token.util';import { UserWorkspaceService } from 'src/engine/core-modules/user-workspace/user-workspace.service';@@ -81,6 +86,7 @@ const RECORD_EXPORT_PERMISSION_CACHE_KEYS: WorkspaceCacheOrDerivedCacheKeyName[]['rolesPermissions','userWorkspaceRoleMap',+ 'apiKeyRoleMap','flatRoleMaps','flatRowLevelPermissionPredicateMaps','flatRowLevelPermissionPredicateGroupMaps',@@ -100,6 +106,7 @@ export class RecordExportWorkspaceService {private readonly logger = new Logger(RecordExportWorkspaceService.name);constructor(+ private readonly coreEntityCacheService: CoreEntityCacheService,private readonly userWorkspaceService: UserWorkspaceService,private readonly permissionsService: PermissionsService,private readonly workspaceCacheService: WorkspaceCacheService,@@ -204,8 +211,12 @@ export class RecordExportWorkspaceService {id: v4(),createdAt: Date.now(),workspaceId: requester.workspace.id,- userWorkspaceId: requester.userWorkspaceId,- workspaceMemberId: requester.workspaceMemberId,+ ...(isApiKeyAuthContext(requester)+ ? { apiKeyId: requester.apiKey.id }+ : {+ userWorkspaceId: requester.userWorkspaceId,+ workspaceMemberId: requester.workspaceMemberId,+ }),requestTokenHash,permissionsHash,parameters,@@ -320,7 +331,11 @@ export class RecordExportWorkspaceService {}async getDownloadPath(- recordExport: Omit<RecordExport, 'parameters' | 'createdAt'>,+ recordExport: RecordExportRequester &+ Pick<+ RecordExport,+ 'id' | 'requestTokenHash' | 'permissionsHash' | 'filename'+ >,): Promise<string> {await this.resolveRequester(recordExport);await this.assertPermissionsUnchanged(recordExport);@@ -331,8 +346,12 @@ export class RecordExportWorkspaceService {sub: recordExport.workspaceId,workspaceId: recordExport.workspaceId,fileId: recordExport.id,- userWorkspaceId: recordExport.userWorkspaceId,- workspaceMemberId: recordExport.workspaceMemberId,+ ...(isApiKeyRecordExportRequester(recordExport)+ ? { apiKeyId: recordExport.apiKeyId }+ : {+ userWorkspaceId: recordExport.userWorkspaceId,+ workspaceMemberId: recordExport.workspaceMemberId,+ }),requestTokenHash: recordExport.requestTokenHash,permissionsHash: recordExport.permissionsHash,filename: recordExport.filename,@@ -463,19 +482,31 @@ export class RecordExportWorkspaceService {}async assertCanExport(authContext: WorkspaceAuthContext,- ): Promise<UserWorkspaceAuthContext> {+ ): Promise<RecordExportAuthContext> {if (- !isUserAuthContext(authContext) ||- isDefined(authContext.application) ||- isDefined(authContext.viaApplication)+ !isApiKeyAuthContext(authContext) &&+ (!isUserAuthContext(authContext) ||+ isDefined(authContext.application) ||+ isDefined(authContext.viaApplication))) {throw new ForbiddenException(t`Sign in to export records.`);}+ if (+ isApiKeyAuthContext(authContext) &&+ !isApiKeyActive(authContext.apiKey)+ ) {+ throw new ForbiddenException(+ t`You do not have permission to export records.`,+ );+ }+if (!(await this.permissionsService.userHasWorkspaceSettingPermission({workspaceId: authContext.workspace.id,- userWorkspaceId: authContext.userWorkspaceId,+ ...(isApiKeyAuthContext(authContext)+ ? { apiKeyId: authContext.apiKey.id }+ : { userWorkspaceId: authContext.userWorkspaceId }),applicationId: undefined,setting: PermissionFlagType.EXPORT_CSV,}))@@ -489,11 +520,30 @@ export class RecordExportWorkspaceService {}async resolveRequester(- recordExport: Pick<- RecordExport,- 'workspaceId' | 'userWorkspaceId' | 'workspaceMemberId'- >,- ): Promise<UserWorkspaceAuthContext> {+ recordExport: RecordExportRequester,+ ): Promise<RecordExportAuthContext> {+ if (isApiKeyRecordExportRequester(recordExport)) {+ const workspace = await this.coreEntityCacheService.get(+ 'workspaceEntity',+ recordExport.workspaceId,+ );+ const { apiKeyMap } = await this.workspaceCacheService.getOrRecompute(+ recordExport.workspaceId,+ ['apiKeyMap'],+ );+ const apiKey = apiKeyMap[recordExport.apiKeyId];++ if (!isDefined(workspace) || !isDefined(apiKey)) {+ throw new ForbiddenException(+ t`You do not have permission to export records.`,+ );+ }++ return this.assertCanExport(+ buildApiKeyAuthContext({ workspace, apiKey }),+ );+ }+const workspaceMember = await this.userWorkspaceService.getWorkspaceMember({workspaceId: recordExport.workspaceId,workspaceMemberId: recordExport.workspaceMemberId,@@ -537,7 +587,7 @@ export class RecordExportWorkspaceService {authContext,}: {parameters: RecordExportParameters;- authContext: UserWorkspaceAuthContext;+ authContext: RecordExportAuthContext;}): Promise<RecordExportQueryContext> {const { flatObjectMetadataMaps, flatFieldMetadataMaps } =await this.workspaceCacheService.getOrRecompute(@@ -566,7 +616,7 @@ export class RecordExportWorkspaceService {await this.applicationTranslationCatalogService.getI18nContextByApplicationId({applicationIds: rawFields.map((field) => field.applicationId),- locale: authContext.workspaceMember.locale,+ locale: getRecordExportLocale(authContext),workspaceId: authContext.workspace.id,},);@@ -680,18 +730,16 @@ export class RecordExportWorkspaceService {recordExport,}: {request: Request;- recordExport: Pick<- RecordExport,- | 'workspaceId'- | 'userWorkspaceId'- | 'workspaceMemberId'- | 'requestTokenHash'- >;+ recordExport: RecordExportRequester &+ Pick<RecordExport, 'requestTokenHash'>;}): void {if (request.workspace?.id !== recordExport.workspaceId ||- request.userWorkspaceId !== recordExport.userWorkspaceId ||- request.workspaceMemberId !== recordExport.workspaceMemberId ||+ (isApiKeyRecordExportRequester(recordExport)+ ? request.apiKey?.id !== recordExport.apiKeyId+ : isDefined(request.apiKey) ||+ request.userWorkspaceId !== recordExport.userWorkspaceId ||+ request.workspaceMemberId !== recordExport.workspaceMemberId) ||this.getRequestTokenHashOrThrow(request) !== recordExport.requestTokenHash) {throw new ForbiddenException(diff --git a/packages/twenty-server/src/engine/core-modules/record-export/types/record-export-auth-context.type.ts b/packages/twenty-server/src/engine/core-modules/record-export/types/record-export-auth-context.type.tsnew file mode 100644index 00000000000..cad1474f4f1--- /dev/null+++ b/packages/twenty-server/src/engine/core-modules/record-export/types/record-export-auth-context.type.ts@@ -0,0 +1,8 @@+import {+ type ApiKeyWorkspaceAuthContext,+ type UserWorkspaceAuthContext,+} from 'src/engine/core-modules/auth/types/workspace-auth-context.type';++export type RecordExportAuthContext =+ | UserWorkspaceAuthContext+ | ApiKeyWorkspaceAuthContext;diff --git a/packages/twenty-server/src/engine/core-modules/record-export/types/record-export-download-token-jwt-payload.type.ts b/packages/twenty-server/src/engine/core-modules/record-export/types/record-export-download-token-jwt-payload.type.tsindex 4d46ee453e1..c9d4e100401 100644--- a/packages/twenty-server/src/engine/core-modules/record-export/types/record-export-download-token-jwt-payload.type.ts+++ b/packages/twenty-server/src/engine/core-modules/record-export/types/record-export-download-token-jwt-payload.type.ts@@ -1,15 +1,9 @@+import { type RecordExportRequester } from 'src/engine/core-modules/record-export/types/record-export-requester.type';import { type FileTokenJwtPayload } from 'src/engine/core-modules/auth/types/file-token-jwt-payload.type';import { type RecordExport } from 'src/engine/core-modules/record-export/types/record-export.type';export type RecordExportDownloadTokenJwtPayload = FileTokenJwtPayload &- Pick<- RecordExport,- | 'workspaceId'- | 'userWorkspaceId'- | 'workspaceMemberId'- | 'requestTokenHash'- | 'permissionsHash'- | 'filename'- > & {+ RecordExportRequester &+ Pick<RecordExport, 'requestTokenHash' | 'permissionsHash' | 'filename'> & {purpose: 'record-export';};diff --git a/packages/twenty-server/src/engine/core-modules/record-export/types/record-export-requester.type.ts b/packages/twenty-server/src/engine/core-modules/record-export/types/record-export-requester.type.tsnew file mode 100644index 00000000000..1da219b96d1--- /dev/null+++ b/packages/twenty-server/src/engine/core-modules/record-export/types/record-export-requester.type.ts@@ -0,0 +1,22 @@+import {+ type ApiKeyWorkspaceAuthContext,+ type UserWorkspaceAuthContext,+ type WorkspaceAuthContext,+} from 'src/engine/core-modules/auth/types/workspace-auth-context.type';++type RecordExportApiKeyRequester = {+ apiKeyId: ApiKeyWorkspaceAuthContext['apiKey']['id'];+ userWorkspaceId?: never;+ workspaceMemberId?: never;+};++type RecordExportUserRequester = Pick<+ UserWorkspaceAuthContext,+ 'userWorkspaceId' | 'workspaceMemberId'+> & {+ apiKeyId?: never;+};++export type RecordExportRequester = {+ workspaceId: WorkspaceAuthContext['workspace']['id'];+} & (RecordExportApiKeyRequester | RecordExportUserRequester);diff --git a/packages/twenty-server/src/engine/core-modules/record-export/types/record-export.type.ts b/packages/twenty-server/src/engine/core-modules/record-export/types/record-export.type.tsindex fa51a83a414..21115e56893 100644--- a/packages/twenty-server/src/engine/core-modules/record-export/types/record-export.type.ts+++ b/packages/twenty-server/src/engine/core-modules/record-export/types/record-export.type.ts@@ -1,10 +1,8 @@+import { type RecordExportRequester } from 'src/engine/core-modules/record-export/types/record-export-requester.type';import { type RecordExportParameters } from 'src/engine/core-modules/record-export/types/record-export-parameters.type';-export type RecordExport = {+export type RecordExport = RecordExportRequester & {id: string;- workspaceId: string;- userWorkspaceId: string;- workspaceMemberId: string;requestTokenHash: string;permissionsHash: string;parameters: RecordExportParameters;diff --git a/packages/twenty-server/src/engine/core-modules/record-export/utils/get-record-export-locale.util.ts b/packages/twenty-server/src/engine/core-modules/record-export/utils/get-record-export-locale.util.tsnew file mode 100644index 00000000000..3fc5c3888c2--- /dev/null+++ b/packages/twenty-server/src/engine/core-modules/record-export/utils/get-record-export-locale.util.ts@@ -0,0 +1,9 @@+import { SOURCE_LOCALE } from 'twenty-shared/translations';++import { isUserAuthContext } from 'src/engine/core-modules/auth/guards/is-user-auth-context.guard';+import { type RecordExportAuthContext } from 'src/engine/core-modules/record-export/types/record-export-auth-context.type';++export const getRecordExportLocale = (authContext: RecordExportAuthContext) =>+ isUserAuthContext(authContext)+ ? authContext.workspaceMember.locale+ : SOURCE_LOCALE;diff --git a/packages/twenty-server/test/integration/endpoint-permissions/__snapshots__/endpoint-permission-declarations.integration-spec.ts.snap b/packages/twenty-server/test/integration/endpoint-permissions/__snapshots__/endpoint-permission-declarations.integration-spec.ts.snapindex e469314856f..f44e3041c09 100644--- a/packages/twenty-server/test/integration/endpoint-permissions/__snapshots__/endpoint-permission-declarations.integration-spec.ts.snap+++ b/packages/twenty-server/test/integration/endpoint-permissions/__snapshots__/endpoint-permission-declarations.integration-spec.ts.snap@@ -305,7 +305,7 @@ exports[`endpoint permission declarations should match the AuthPrincipalGuard an"FieldMetadataResolver.field {"applicationTarget":null,"authPrincipalGuards":[{"apiKey":true,"application":true,"oauthClient":true,"userSession":{"impersonated":true,"playground":true,"standard":true,"workspaceAgnostic":false}}]}","FieldMetadataResolver.fields {"applicationTarget":null,"authPrincipalGuards":[{"apiKey":true,"application":true,"oauthClient":true,"userSession":{"impersonated":true,"playground":true,"standard":true,"workspaceAgnostic":false}}]}","FieldMetadataResolver.updateOneField {"applicationTarget":null,"authPrincipalGuards":[{"apiKey":true,"application":true,"oauthClient":true,"userSession":{"impersonated":true,"playground":true,"standard":true,"workspaceAgnostic":false}}]}",- "FileController.downloadRecordExport {"applicationTarget":null,"authPrincipalGuards":[{"apiKey":false,"application":{"withUser":true,"withoutUser":false},"oauthClient":{"withUser":true,"withoutUser":false},"userSession":{"impersonated":true,"playground":true,"standard":true,"workspaceAgnostic":false}}]}",+ "FileController.downloadRecordExport {"applicationTarget":null,"authPrincipalGuards":[{"apiKey":true,"application":{"withUser":true,"withoutUser":false},"oauthClient":{"withUser":true,"withoutUser":false},"userSession":{"impersonated":true,"playground":true,"standard":true,"workspaceAgnostic":false}}]}","FileController.getApplicationRegistrationAsset {"applicationTarget":null,"authPrincipalGuards":[]}","FileController.getFileById {"applicationTarget":null,"authPrincipalGuards":[]}","FileController.getPublicAssets {"applicationTarget":null,"authPrincipalGuards":[]}",@@ -454,7 +454,7 @@ exports[`endpoint permission declarations should match the AuthPrincipalGuard an"PublicDomainResolver.createPublicDomain {"applicationTarget":{"idKey":"applicationId","kind":"applicationId","requireApplicationRegistrationOwnership":false,"source":"graphqlArgs"},"authPrincipalGuards":[{"apiKey":true,"application":true,"oauthClient":true,"userSession":{"impersonated":true,"playground":true,"standard":true,"workspaceAgnostic":false}},{"apiKey":true,"application":false,"oauthClient":true,"userSession":{"impersonated":true,"playground":true,"standard":true,"workspaceAgnostic":false}}]}","PublicDomainResolver.deletePublicDomain {"applicationTarget":null,"authPrincipalGuards":[{"apiKey":true,"application":true,"oauthClient":true,"userSession":{"impersonated":true,"playground":true,"standard":true,"workspaceAgnostic":false}},{"apiKey":true,"application":false,"oauthClient":true,"userSession":{"impersonated":true,"playground":true,"standard":true,"workspaceAgnostic":false}}]}","PublicDomainResolver.findManyPublicDomains {"applicationTarget":null,"authPrincipalGuards":[{"apiKey":true,"application":true,"oauthClient":true,"userSession":{"impersonated":true,"playground":true,"standard":true,"workspaceAgnostic":false}}]}",- "RecordExportResolver.exportRecords {"applicationTarget":null,"authPrincipalGuards":[{"apiKey":false,"application":{"withUser":true,"withoutUser":false},"oauthClient":{"withUser":true,"withoutUser":false},"userSession":{"impersonated":true,"playground":true,"standard":true,"workspaceAgnostic":false}}]}",+ "RecordExportResolver.exportRecords {"applicationTarget":null,"authPrincipalGuards":[{"apiKey":true,"application":{"withUser":true,"withoutUser":false},"oauthClient":{"withUser":true,"withoutUser":false},"userSession":{"impersonated":true,"playground":true,"standard":true,"workspaceAgnostic":false}}]}","RecordPermissionsResolver.recordPermissions {"applicationTarget":null,"authPrincipalGuards":[{"apiKey":false,"application":{"withUser":true,"withoutUser":false},"oauthClient":{"withUser":true,"withoutUser":false},"userSession":{"impersonated":true,"playground":true,"standard":true,"workspaceAgnostic":false}}]}","RecordSharingResolver.recordSharing {"applicationTarget":null,"authPrincipalGuards":[{"apiKey":false,"application":{"withUser":true,"withoutUser":false},"oauthClient":{"withUser":true,"withoutUser":false},"userSession":{"impersonated":true,"playground":true,"standard":true,"workspaceAgnostic":false}}]}","RecordSharingResolver.removeRecordShare {"applicationTarget":null,"authPrincipalGuards":[{"apiKey":false,"application":{"withUser":true,"withoutUser":false},"oauthClient":{"withUser":true,"withoutUser":false},"userSession":{"impersonated":true,"playground":true,"standard":true,"workspaceAgnostic":false}}]}",diff --git a/packages/twenty-server/test/integration/record-export/record-export.integration-spec.ts b/packages/twenty-server/test/integration/record-export/record-export.integration-spec.tsindex dfaef57f28e..e2006a0dabe 100644--- a/packages/twenty-server/test/integration/record-export/record-export.integration-spec.ts+++ b/packages/twenty-server/test/integration/record-export/record-export.integration-spec.ts@@ -1,3 +1,6 @@+import { type ApiKeyRoleService } from 'src/engine/core-modules/api-key/services/api-key-role.service';+import { isUserAuthContext } from 'src/engine/core-modules/auth/guards/is-user-auth-context.guard';+import { type ApiKeyService } from 'src/engine/core-modules/api-key/services/api-key.service';import { TWENTY_STANDARD_APPLICATION_UNIVERSAL_IDENTIFIER } from 'twenty-shared/application';import { type RecordExportDownloadTokenJwtPayload } from 'src/engine/core-modules/record-export/types/record-export-download-token-jwt-payload.type';import { type PendingFileCleanupCronJob } from 'src/engine/core-modules/file/file-upload/crons/jobs/pending-file-cleanup.cron.job';@@ -79,6 +82,27 @@ describe('record export lifecycle (integration)', () => {const exportIds = new Set<string>();const downloadTokens = new Map<string, string>();const sessionTokens = new Set<string>();+ const apiKeyIds = new Set<string>();+ const apiKeys = () =>+ getAppProviderByClassName<ApiKeyService>('ApiKeyService');+ const createApiKey = async () => {+ const apiKey = await apiKeys().create({+ workspaceId: SEED_APPLE_WORKSPACE_ID,+ name: `Record export ${v4()}`,+ expiresAt: new Date(Date.now() + 60_000),+ revokedAt: null,+ roleId,+ });+ apiKeyIds.add(apiKey.id);+ const credentials = await apiKeys().generateApiKeyToken(+ SEED_APPLE_WORKSPACE_ID,+ apiKey.id,+ );+ if (!isDefined(credentials)) {+ throw new Error('API key token missing');+ }+ return { id: apiKey.id, token: credentials.token };+ };const authenticationHeaders = (token: string): Record<string, string> =>isUserSessionToken(token)? {@@ -250,6 +274,7 @@ describe('record export lifecycle (integration)', () => {canAccessAllTools: true,canReadAllObjectRecords: true,canBeAssignedToUsers: true,+ canBeAssignedToApiKeys: true,},expectToFail: false,});@@ -276,6 +301,10 @@ describe('record export lifecycle (integration)', () => {);}sessionTokens.clear();+ for (const id of apiKeyIds) {+ await apiKeys().revoke(id, SEED_APPLE_WORKSPACE_ID);+ }+ apiKeyIds.clear();if (isDefined(roleId)) {await upsertRowLevelPermissionPredicates({input: {@@ -389,6 +418,87 @@ describe('record export lifecycle (integration)', () => {await download(recordExport).expect(404);});+ it('exports with API key row permissions and only allows the requesting key to download', async () => {+ const requester = await createApiKey();+ const otherKey = await createApiKey();+ await upsertContainsRlsPredicate({+ roleId,+ objectNameSingular: 'company',+ fieldName: 'name',+ value: companies[0].name,+ });+ const ready = await exportToCompletion(input, requester.token);+ expect(await authorization(ready)).toMatchObject({+ apiKeyId: requester.id,+ });+ await download(ready, otherKey.token).expect(403);+ await download(ready, APPLE_JANE_ADMIN_ACCESS_TOKEN).expect(403);+ const response = await download(ready).expect(200);+ expect(response.text.replace(/^\uFEFF/, '')).toBe(+ `Id,Name\n${companies[0].id},${companies[0].name}\n`,+ );+ });++ it('rejects an API key without export permission', async () => {+ const requester = await createApiKey();+ await changeRole({ canAccessAllTools: false });+ const { events } = subscribe(input, requester.token);+ await expect(nextExport(events)).rejects.toThrow(/permission/i);+ });++ it.each(['revoked', 'expired'])(+ 'rejects a completed export when its API key is %s',+ async (state) => {+ const requester = await createApiKey();+ const ready = await exportToCompletion(input, requester.token);+ const payload = await authorization(ready);+ await apiKeys().update(+ requester.id,+ SEED_APPLE_WORKSPACE_ID,+ state === 'revoked'+ ? { revokedAt: new Date() }+ : { expiresAt: new Date(Date.now() - 1000) },+ );+ await expect(exports.resolveRequester(payload)).rejects.toThrow(+ /permission/i,+ );+ await download(ready).expect(403);+ },+ );++ it('invalidates an API key export when its role permissions change', async () => {+ const requester = await createApiKey();+ const ready = await exportToCompletion(input, requester.token);+ await changeRole({ canAccessAllTools: false });+ await download(ready).expect(403);+ });++ it('invalidates an API key export when reassigned to a role that can still export', async () => {+ const requester = await createApiKey();+ const adminRole = await findOneRoleByLabel({ label: 'Admin' });+ const ready = await exportToCompletion(input, requester.token);+ const payload = await authorization(ready);+ await expect(+ exports.assertPermissionsUnchanged(payload),+ ).resolves.toBeUndefined();++ await getAppProviderByClassName<ApiKeyRoleService>(+ 'ApiKeyRoleService',+ ).assignRoleToApiKey({+ apiKeyId: requester.id,+ roleId: adminRole.id,+ workspaceId: SEED_APPLE_WORKSPACE_ID,+ });++ await expect(exports.resolveRequester(payload)).resolves.toMatchObject({+ apiKey: { id: requester.id },+ });+ await expect(exports.assertPermissionsUnchanged(payload)).rejects.toThrow(+ 'Access permissions have changed.',+ );+ await download(ready).expect(403);+ });+it('exports headers when the selection is empty', async () => {const recordExport = await exportToCompletion({...input,@@ -923,6 +1033,9 @@ describe('record export lifecycle (integration)', () => {const requester = await query.resolveRequester(await authorization(recordExport),);+ if (!isUserAuthContext(requester)) {+ throw new Error('Expected user requester');+ }const tokens =getAppProviderByClassName<AccessTokenService>('AccessTokenService');const otherToken = await tokens.generateAccessToken({@@ -946,6 +1059,9 @@ describe('record export lifecycle (integration)', () => {const requester = await query.resolveRequester(await authorization(ready),);+ if (!isUserAuthContext(requester)) {+ throw new Error('Expected user requester');+ }const sessions =getAppProviderByClassName<UserSessionService>('UserSessionService');const createSession = async () => {