Skip to content

The open alternative to Salesforce, designed for AI.

Bind CSV export downloads to their requesting session (#26052)

Weiko80658bb66bcf
diff --git a/packages/twenty-client-sdk/src/metadata/generated/schema.graphql b/packages/twenty-client-sdk/src/metadata/generated/schema.graphql
index 4a64a5cc396..a2f5857e68b 100644
--- a/packages/twenty-client-sdk/src/metadata/generated/schema.graphql
+++ b/packages/twenty-client-sdk/src/metadata/generated/schema.graphql
@@ -2879,23 +2879,6 @@ type WorkspaceMigration {
actions: JSON!
}
-type RecordExport {
- id: UUID!
- filename: String!
- status: RecordExportStatus!
- processedRecordCount: Int!
- totalRecordCount: Int
- errorMessage: String
- downloadUrl: String
-}
-
-enum RecordExportStatus {
- QUEUED
- PROCESSING
- COMPLETED
- FAILED
-}
-
type PublicDomain {
id: UUID!
domain: String!
@@ -3319,6 +3302,14 @@ type EventLogQueryResult {
pageInfo: EventLogPageInfo!
}
+type RecordExport {
+ id: UUID!
+ filename: String!
+ progress: Int!
+ errorMessage: String
+ downloadUrl: String
+}
+
type AiChatUsage {
limitValue: BigInt!
consumedValue: BigInt
diff --git a/packages/twenty-client-sdk/src/metadata/generated/schema.ts b/packages/twenty-client-sdk/src/metadata/generated/schema.ts
index d9276c77fe7..2031ebd6d06 100644
--- a/packages/twenty-client-sdk/src/metadata/generated/schema.ts
+++ b/packages/twenty-client-sdk/src/metadata/generated/schema.ts
@@ -2496,19 +2496,6 @@ export interface WorkspaceMigration {
__typename: 'WorkspaceMigration'
}
-export interface RecordExport {
- id: Scalars['UUID']
- filename: Scalars['String']
- status: RecordExportStatus
- processedRecordCount: Scalars['Int']
- totalRecordCount?: Scalars['Int']
- errorMessage?: Scalars['String']
- downloadUrl?: Scalars['String']
- __typename: 'RecordExport'
-}
-
-export type RecordExportStatus = 'QUEUED' | 'PROCESSING' | 'COMPLETED' | 'FAILED'
-
export interface PublicDomain {
id: Scalars['UUID']
domain: Scalars['String']
@@ -2915,6 +2902,15 @@ export interface EventLogQueryResult {
__typename: 'EventLogQueryResult'
}
+export interface RecordExport {
+ id: Scalars['UUID']
+ filename: Scalars['String']
+ progress: Scalars['Int']
+ errorMessage?: Scalars['String']
+ downloadUrl?: Scalars['String']
+ __typename: 'RecordExport'
+}
+
export interface AiChatUsage {
limitValue: Scalars['BigInt']
consumedValue?: Scalars['BigInt']
@@ -6218,18 +6214,6 @@ export interface WorkspaceMigrationGenqlSelection{
__scalar?: boolean | number
}
-export interface RecordExportGenqlSelection{
- id?: boolean | number
- filename?: boolean | number
- status?: boolean | number
- processedRecordCount?: boolean | number
- totalRecordCount?: boolean | number
- errorMessage?: boolean | number
- downloadUrl?: boolean | number
- __typename?: boolean | number
- __scalar?: boolean | number
-}
-
export interface PublicDomainGenqlSelection{
id?: boolean | number
domain?: boolean | number
@@ -6651,6 +6635,16 @@ export interface EventLogQueryResultGenqlSelection{
__scalar?: boolean | number
}
+export interface RecordExportGenqlSelection{
+ id?: boolean | number
+ filename?: boolean | number
+ progress?: boolean | number
+ errorMessage?: boolean | number
+ downloadUrl?: boolean | number
+ __typename?: boolean | number
+ __scalar?: boolean | number
+}
+
export interface AiChatUsageGenqlSelection{
limitValue?: boolean | number
consumedValue?: boolean | number
@@ -9669,14 +9663,6 @@ export interface CreateRecordExportInput {objectMetadataId: Scalars['UUID'],fiel
- const RecordExport_possibleTypes: string[] = ['RecordExport']
- export const isRecordExport = (obj?: { __typename?: any } | null): obj is RecordExport => {
- if (!obj?.__typename) throw new Error('__typename is missing in "isRecordExport"')
- return RecordExport_possibleTypes.includes(obj.__typename)
- }
-
-
-
const PublicDomain_possibleTypes: string[] = ['PublicDomain']
export const isPublicDomain = (obj?: { __typename?: any } | null): obj is PublicDomain => {
if (!obj?.__typename) throw new Error('__typename is missing in "isPublicDomain"')
@@ -10005,6 +9991,14 @@ export interface CreateRecordExportInput {objectMetadataId: Scalars['UUID'],fiel
+ const RecordExport_possibleTypes: string[] = ['RecordExport']
+ export const isRecordExport = (obj?: { __typename?: any } | null): obj is RecordExport => {
+ if (!obj?.__typename) throw new Error('__typename is missing in "isRecordExport"')
+ return RecordExport_possibleTypes.includes(obj.__typename)
+ }
+
+
+
const AiChatUsage_possibleTypes: string[] = ['AiChatUsage']
export const isAiChatUsage = (obj?: { __typename?: any } | null): obj is AiChatUsage => {
if (!obj?.__typename) throw new Error('__typename is missing in "isAiChatUsage"')
@@ -10912,13 +10906,6 @@ export const enumFileFolder = {
Dpa: 'Dpa' as const
}
-export const enumRecordExportStatus = {
- QUEUED: 'QUEUED' as const,
- PROCESSING: 'PROCESSING' as const,
- COMPLETED: 'COMPLETED' as const,
- FAILED: 'FAILED' as const
-}
-
export const enumEmailingDomainStatus = {
PENDING: 'PENDING' as const,
VERIFIED: 'VERIFIED' as const,
diff --git a/packages/twenty-client-sdk/src/metadata/generated/types.ts b/packages/twenty-client-sdk/src/metadata/generated/types.ts
index 7bf4e1e851a..9c3ff167a9f 100644
--- a/packages/twenty-client-sdk/src/metadata/generated/types.ts
+++ b/packages/twenty-client-sdk/src/metadata/generated/types.ts
@@ -77,34 +77,33 @@ export default {
268,
299,
306,
- 312,
+ 314,
+ 315,
316,
- 317,
318,
+ 319,
320,
321,
322,
323,
324,
- 325,
- 326,
- 336,
- 337,
- 340,
- 378,
- 385,
+ 334,
+ 335,
+ 338,
+ 377,
+ 384,
+ 386,
387,
388,
389,
- 390,
- 392,
- 394,
- 399,
- 416,
- 428,
- 548,
- 552,
- 579
+ 391,
+ 393,
+ 398,
+ 415,
+ 427,
+ 547,
+ 551,
+ 578
],
"types": {
"BillingProductDTO": {
@@ -5637,33 +5636,6 @@ export default {
1
]
},
- "RecordExport": {
- "id": [
- 3
- ],
- "filename": [
- 1
- ],
- "status": [
- 312
- ],
- "processedRecordCount": [
- 28
- ],
- "totalRecordCount": [
- 28
- ],
- "errorMessage": [
- 1
- ],
- "downloadUrl": [
- 1
- ],
- "__typename": [
- 1
- ]
- },
- "RecordExportStatus": {},
"PublicDomain": {
"id": [
3
@@ -5718,16 +5690,16 @@ export default {
1
],
"status": [
- 316
+ 314
],
"tenantStatus": [
- 317
+ 315
],
"unsubscribeHostnameStatus": [
- 318
+ 316
],
"verificationRecords": [
- 314
+ 312
],
"verifiedAt": [
4
@@ -5744,7 +5716,7 @@ export default {
3
],
"visibility": [
- 320
+ 318
],
"handle": [
1
@@ -5753,16 +5725,16 @@ export default {
1
],
"type": [
- 321
+ 319
],
"isContactAutoCreationEnabled": [
8
],
"contactAutoCreationPolicy": [
- 322
+ 320
],
"messageFolderImportPolicy": [
- 323
+ 321
],
"excludeNonProfessionalEmails": [
8
@@ -5771,7 +5743,7 @@ export default {
8
],
"pendingGroupEmailsAction": [
- 324
+ 322
],
"isSyncEnabled": [
8
@@ -5780,10 +5752,10 @@ export default {
4
],
"syncStatus": [
- 325
+ 323
],
"syncStage": [
- 326
+ 324
],
"syncStageStartedAt": [
4
@@ -5833,7 +5805,7 @@ export default {
},
"IngestAppMessagesOutput": {
"messages": [
- 327
+ 325
],
"__typename": [
1
@@ -5841,7 +5813,7 @@ export default {
},
"CreateEmailGroupChannelOutput": {
"messageChannel": [
- 319
+ 317
],
"forwardingAddress": [
1
@@ -5906,7 +5878,7 @@ export default {
28
],
"audience": [
- 330
+ 328
],
"__typename": [
1
@@ -5949,10 +5921,10 @@ export default {
1
],
"reason": [
- 336
+ 334
],
"source": [
- 337
+ 335
],
"unsubscribeTopicId": [
3
@@ -5965,7 +5937,7 @@ export default {
"MessageSuppressionSource": {},
"MessageSuppressionList": {
"records": [
- 335
+ 333
],
"totalCount": [
28
@@ -5991,7 +5963,7 @@ export default {
1
],
"visibility": [
- 340
+ 338
],
"__typename": [
1
@@ -6037,7 +6009,7 @@ export default {
1
],
"location": [
- 342
+ 340
],
"__typename": [
1
@@ -6065,13 +6037,13 @@ export default {
1
],
"IMAP": [
- 344
+ 342
],
"SMTP": [
- 344
+ 342
],
"CALDAV": [
- 344
+ 342
],
"__typename": [
1
@@ -6091,7 +6063,7 @@ export default {
3
],
"connectionParameters": [
- 345
+ 343
],
"__typename": [
1
@@ -6316,7 +6288,7 @@ export default {
1
],
"series": [
- 354
+ 352
],
"xAxisLabel": [
1
@@ -6365,7 +6337,7 @@ export default {
1
],
"data": [
- 356
+ 354
],
"__typename": [
1
@@ -6373,7 +6345,7 @@ export default {
},
"LineChartData": {
"series": [
- 357
+ 355
],
"xAxisLabel": [
1
@@ -6410,7 +6382,7 @@ export default {
},
"PieChartData": {
"data": [
- 359
+ 357
],
"showLegend": [
8
@@ -6515,13 +6487,33 @@ export default {
},
"EventLogQueryResult": {
"records": [
- 364
+ 362
],
"totalCount": [
28
],
"pageInfo": [
- 365
+ 363
+ ],
+ "__typename": [
+ 1
+ ]
+ },
+ "RecordExport": {
+ "id": [
+ 3
+ ],
+ "filename": [
+ 1
+ ],
+ "progress": [
+ 28
+ ],
+ "errorMessage": [
+ 1
+ ],
+ "downloadUrl": [
+ 1
],
"__typename": [
1
@@ -6602,7 +6594,7 @@ export default {
1
],
"parts": [
- 350
+ 348
],
"processedAt": [
4
@@ -6674,7 +6666,7 @@ export default {
},
"AiSystemPromptPreview": {
"sections": [
- 371
+ 370
],
"estimatedTokenCount": [
28
@@ -6702,7 +6694,7 @@ export default {
28
],
"error": [
- 373
+ 372
],
"__typename": [
1
@@ -6735,10 +6727,10 @@ export default {
},
"StartWorkspaceSetupChatResult": {
"outcome": [
- 378
+ 377
],
"thread": [
- 370
+ 369
],
"__typename": [
1
@@ -6776,10 +6768,10 @@ export default {
3
],
"evaluations": [
- 379
+ 378
],
"messages": [
- 369
+ 368
],
"createdAt": [
4
@@ -6841,7 +6833,7 @@ export default {
9
],
"scope": [
- 385
+ 384
],
"__typename": [
1
@@ -6856,19 +6848,19 @@ export default {
1
],
"syncStatus": [
- 387
+ 386
],
"syncStage": [
- 388
+ 387
],
"visibility": [
- 389
+ 388
],
"isContactAutoCreationEnabled": [
8
],
"contactAutoCreationPolicy": [
- 390
+ 389
],
"isSyncEnabled": [
8
@@ -6919,7 +6911,7 @@ export default {
1
],
"pendingSyncAction": [
- 392
+ 391
],
"messageChannelId": [
3
@@ -6961,7 +6953,7 @@ export default {
1
],
"provenance": [
- 394
+ 393
],
"__typename": [
1
@@ -6990,7 +6982,7 @@ export default {
3
],
"through": [
- 395
+ 394
],
"__typename": [
1
@@ -7010,7 +7002,7 @@ export default {
1
],
"emit": [
- 396
+ 395
],
"action": [
1
@@ -7045,7 +7037,7 @@ export default {
},
"CollectionHash": {
"collectionName": [
- 399
+ 398
],
"hash": [
1
@@ -7109,13 +7101,13 @@ export default {
},
"MinimalMetadata": {
"objectMetadataItems": [
- 400
+ 399
],
"views": [
- 401
+ 400
],
"collectionHashes": [
- 398
+ 397
],
"__typename": [
1
@@ -7175,7 +7167,7 @@ export default {
175,
{
"input": [
- 404
+ 403
]
}
],
@@ -7192,7 +7184,7 @@ export default {
182,
{
"input": [
- 405,
+ 404,
"UsageQuotaScopeInput!"
]
}
@@ -7315,7 +7307,7 @@ export default {
2,
{
"input": [
- 406,
+ 405,
"GetApiKeyInput!"
]
}
@@ -7433,7 +7425,7 @@ export default {
10,
{
"input": [
- 407,
+ 406,
"AgentIdInput!"
]
}
@@ -7446,7 +7438,7 @@ export default {
"CursorPaging!"
],
"filter": [
- 408,
+ 407,
"ObjectFilter!"
]
}
@@ -7476,7 +7468,7 @@ export default {
21,
{
"input": [
- 409,
+ 408,
"LogicFunctionIdInput!"
]
}
@@ -7488,7 +7480,7 @@ export default {
9,
{
"input": [
- 409,
+ 408,
"LogicFunctionIdInput!"
]
}
@@ -7497,7 +7489,7 @@ export default {
1,
{
"input": [
- 409,
+ 408,
"LogicFunctionIdInput!"
]
}
@@ -7734,28 +7726,28 @@ export default {
48
],
"previewMessageCampaignAudience": [
- 330,
+ 328,
{
"input": [
- 410,
+ 409,
"PreviewMessageCampaignAudienceInput!"
]
}
],
"messageSuppressions": [
- 338,
+ 336,
{
"input": [
- 411,
+ 410,
"FindMessageSuppressionsInput!"
]
}
],
"unsubscribeTopics": [
- 339
+ 337
],
"myMessageChannels": [
- 319,
+ 317,
{
"connectedAccountId": [
3
@@ -7763,18 +7755,18 @@ export default {
}
],
"appMessageChannels": [
- 319,
+ 317,
{
"filter": [
- 412
+ 411
]
}
],
"getEmailingDomains": [
- 315
+ 313
],
"getToolIndex": [
- 349
+ 347
],
"getToolInputSchema": [
9,
@@ -7786,10 +7778,10 @@ export default {
}
],
"webhooks": [
- 348
+ 346
],
"webhook": [
- 348,
+ 346,
{
"id": [
3,
@@ -7798,7 +7790,7 @@ export default {
}
],
"myMessageFolders": [
- 391,
+ 390,
{
"messageChannelId": [
3
@@ -7806,7 +7798,7 @@ export default {
}
],
"myCalendarChannels": [
- 386,
+ 385,
{
"connectedAccountId": [
3
@@ -7814,17 +7806,17 @@ export default {
}
],
"minimalMetadata": [
- 402
+ 401
],
"appKeyValue": [
- 384,
+ 383,
{
"key": [
1,
"String!"
],
"scope": [
- 385
+ 384
]
}
],
@@ -7841,7 +7833,7 @@ export default {
228,
{
"filter": [
- 413
+ 412
]
}
],
@@ -7855,16 +7847,16 @@ export default {
}
],
"findWorkspaceAiStats": [
- 381
+ 380
],
"aiChatUsage": [
- 367
+ 366
],
"chatThreads": [
- 370
+ 369
],
"chatThread": [
- 370,
+ 369,
{
"id": [
3,
@@ -7873,7 +7865,7 @@ export default {
}
],
"chatMessages": [
- 369,
+ 368,
{
"threadId": [
3,
@@ -7882,7 +7874,7 @@ export default {
}
],
"chatStreamCatchupChunks": [
- 374,
+ 373,
{
"threadId": [
3,
@@ -7891,13 +7883,13 @@ export default {
}
],
"getAiSystemPromptPreview": [
- 372
+ 371
],
"skills": [
- 368
+ 367
],
"skill": [
- 368,
+ 367,
{
"id": [
3,
@@ -7906,7 +7898,7 @@ export default {
}
],
"agentTurns": [
- 380,
+ 379,
{
"agentId": [
3,
@@ -7915,13 +7907,13 @@ export default {
}
],
"timelineActivityTypes": [
- 397
+ 396
],
"metadataTranslations": [
- 393,
+ 392,
{
"input": [
- 414,
+ 413,
"MetadataTranslationsInput!"
]
}
@@ -7984,37 +7976,37 @@ export default {
234
],
"eventLogs": [
- 366,
+ 364,
{
"input": [
- 415,
+ 414,
"EventLogQueryInput!"
]
}
],
"pieChartData": [
- 360,
+ 358,
{
"input": [
- 419,
+ 418,
"PieChartDataInput!"
]
}
],
"lineChartData": [
- 358,
+ 356,
{
"input": [
- 420,
+ 419,
"LineChartDataInput!"
]
}
],
"barChartData": [
- 355,
+ 353,
{
"input": [
- 421,
+ 420,
"BarChartDataInput!"
]
}
@@ -8029,7 +8021,7 @@ export default {
}
],
"getConnectedImapSmtpCaldavAccount": [
- 346,
+ 344,
{
"id": [
3,
@@ -8038,7 +8030,7 @@ export default {
}
],
"getAutoCompleteAddress": [
- 341,
+ 339,
{
"address": [
1,
@@ -8057,7 +8049,7 @@ export default {
}
],
"getAddressDetails": [
- 343,
+ 341,
{
"placeId": [
1,
@@ -8070,7 +8062,7 @@ export default {
}
],
"findManyPublicDomains": [
- 313
+ 311
],
"exportApplication": [
301,
@@ -8146,10 +8138,10 @@ export default {
},
"ObjectFilter": {
"and": [
- 408
+ 407
],
"or": [
- 408
+ 407
],
"id": [
31
@@ -8203,7 +8195,7 @@ export default {
},
"FindMessageSuppressionsInput": {
"reason": [
- 336
+ 334
],
"searchTerm": [
1
@@ -8259,10 +8251,10 @@ export default {
},
"EventLogQueryInput": {
"table": [
- 416
+ 415
],
"filters": [
- 417
+ 416
],
"first": [
28
@@ -8283,7 +8275,7 @@ export default {
1
],
"dateRange": [
- 418
+ 417
],
"recordId": [
1
@@ -8344,7 +8336,7 @@ export default {
8,
{
"input": [
- 423,
+ 422,
"AddQuerySubscriptionInput!"
]
}
@@ -8353,7 +8345,7 @@ export default {
8,
{
"input": [
- 424,
+ 423,
"RemoveQueryFromEventStreamInput!"
]
}
@@ -8362,7 +8354,7 @@ export default {
154,
{
"inputs": [
- 425,
+ 424,
"[CreateNavigationMenuItemInput!]!"
]
}
@@ -8371,7 +8363,7 @@ export default {
154,
{
"input": [
- 425,
+ 424,
"CreateNavigationMenuItemInput!"
]
}
@@ -8380,7 +8372,7 @@ export default {
154,
{
"inputs": [
- 426,
+ 425,
"[UpdateOneNavigationMenuItemInput!]!"
]
}
@@ -8389,7 +8381,7 @@ export default {
154,
{
"input": [
- 426,
+ 425,
"UpdateOneNavigationMenuItemInput!"
]
}
@@ -8463,7 +8455,7 @@ export default {
151,
{
"file": [
- 428,
+ 427,
"Upload!"
]
}
@@ -8472,7 +8464,7 @@ export default {
151,
{
"file": [
- 428,
+ 427,
"Upload!"
]
}
@@ -8481,7 +8473,7 @@ export default {
151,
{
"file": [
- 428,
+ 427,
"Upload!"
],
"fieldMetadataUniversalIdentifier": [
@@ -8494,7 +8486,7 @@ export default {
183,
{
"input": [
- 429,
+ 428,
"CreateUsageLimitInput!"
]
}
@@ -8503,7 +8495,7 @@ export default {
183,
{
"input": [
- 430,
+ 429,
"UpdateUsageLimitInput!"
]
}
@@ -8521,7 +8513,7 @@ export default {
55,
{
"input": [
- 431,
+ 430,
"CreateViewFilterGroupInput!"
]
}
@@ -8534,7 +8526,7 @@ export default {
"String!"
],
"input": [
- 432,
+ 431,
"UpdateViewFilterGroupInput!"
]
}
@@ -8561,7 +8553,7 @@ export default {
57,
{
"input": [
- 433,
+ 432,
"CreateViewFilterInput!"
]
}
@@ -8570,7 +8562,7 @@ export default {
57,
{
"input": [
- 434,
+ 433,
"UpdateViewFilterInput!"
]
}
@@ -8579,7 +8571,7 @@ export default {
57,
{
"input": [
- 436,
+ 435,
"DeleteViewFilterInput!"
]
}
@@ -8588,7 +8580,7 @@ export default {
57,
{
"input": [
- 437,
+ 436,
"DestroyViewFilterInput!"
]
}
@@ -8597,7 +8589,7 @@ export default {
63,
{
"input": [
- 438,
+ 437,
"CreateViewInput!"
]
}
@@ -8610,7 +8602,7 @@ export default {
"String!"
],
"input": [
- 439,
+ 438,
"UpdateViewInput!"
]
}
@@ -8637,7 +8629,7 @@ export default {
63,
{
"input": [
- 440,
+ 439,
"UpsertViewWidgetInput!"
]
}
@@ -8646,7 +8638,7 @@ export default {
60,
{
"input": [
- 446,
+ 445,
"CreateViewSortInput!"
]
}
@@ -8655,7 +8647,7 @@ export default {
60,
{
"input": [
- 447,
+ 446,
"UpdateViewSortInput!"
]
}
@@ -8664,7 +8656,7 @@ export default {
8,
{
"input": [
- 449,
+ 448,
"DeleteViewSortInput!"
]
}
@@ -8673,7 +8665,7 @@ export default {
8,
{
"input": [
- 450,
+ 449,
"DestroyViewSortInput!"
]
}
@@ -8682,7 +8674,7 @@ export default {
53,
{
"input": [
- 451,
+ 450,
"UpdateViewFieldInput!"
]
}
@@ -8691,7 +8683,7 @@ export default {
53,
{
"input": [
- 453,
+ 452,
"CreateViewFieldInput!"
]
}
@@ -8700,7 +8692,7 @@ export default {
53,
{
"inputs": [
- 453,
+ 452,
"[CreateViewFieldInput!]!"
]
}
@@ -8709,7 +8701,7 @@ export default {
53,
{
"input": [
- 454,
+ 453,
"DeleteViewFieldInput!"
]
}
@@ -8718,7 +8710,7 @@ export default {
53,
{
"input": [
- 455,
+ 454,
"DestroyViewFieldInput!"
]
}
@@ -8727,7 +8719,7 @@ export default {
62,
{
"input": [
- 456,
+ 455,
"UpdateViewFieldGroupInput!"
]
}
@@ -8736,7 +8728,7 @@ export default {
62,
{
"input": [
- 458,
+ 457,
"CreateViewFieldGroupInput!"
]
}
@@ -8745,7 +8737,7 @@ export default {
62,
{
"inputs": [
- 458,
+ 457,
"[CreateViewFieldGroupInput!]!"
]
}
@@ -8754,7 +8746,7 @@ export default {
62,
{
"input": [
- 459,
+ 458,
"DeleteViewFieldGroupInput!"
]
}
@@ -8763,7 +8755,7 @@ export default {
62,
{
"input": [
- 460,
+ 459,
"DestroyViewFieldGroupInput!"
]
}
@@ -8772,7 +8764,7 @@ export default {
63,
{
"input": [
- 461,
+ 460,
"UpsertFieldsWidgetInput!"
]
}
@@ -8781,7 +8773,7 @@ export default {
2,
{
"input": [
- 464,
+ 463,
"CreateApiKeyInput!"
]
}
@@ -8790,7 +8782,7 @@ export default {
2,
{
"input": [
- 465,
+ 464,
"UpdateApiKeyInput!"
]
}
@@ -8799,7 +8791,7 @@ export default {
2,
{
"input": [
- 466,
+ 465,
"RevokeApiKeyInput!"
]
}
@@ -9001,7 +8993,7 @@ export default {
184,
{
"input": [
- 467,
+ 466,
"CreateApprovedAccessDomainInput!"
]
}
@@ -9010,7 +9002,7 @@ export default {
8,
{
"input": [
- 468,
+ 467,
"DeleteApprovedAccessDomainInput!"
]
}
@@ -9019,7 +9011,7 @@ export default {
184,
{
"input": [
- 469,
+ 468,
"ValidateApprovedAccessDomainInput!"
]
}
@@ -9028,7 +9020,7 @@ export default {
142,
{
"input": [
- 470,
+ 469,
"CreatePageLayoutTabInput!"
]
}
@@ -9041,7 +9033,7 @@ export default {
"String!"
],
"input": [
- 471,
+ 470,
"UpdatePageLayoutTabInput!"
]
}
@@ -9059,7 +9051,7 @@ export default {
143,
{
"input": [
- 472,
+ 471,
"CreatePageLayoutInput!"
]
}
@@ -9072,7 +9064,7 @@ export default {
"String!"
],
"input": [
- 473,
+ 472,
"UpdatePageLayoutInput!"
]
}
@@ -9094,7 +9086,7 @@ export default {
"String!"
],
"input": [
- 474,
+ 473,
"UpdatePageLayoutWithTabsInput!"
]
}
@@ -9130,7 +9122,7 @@ export default {
98,
{
"input": [
- 477,
+ 476,
"CreatePageLayoutWidgetInput!"
]
}
@@ -9143,7 +9135,7 @@ export default {
"String!"
],
"input": [
- 478,
+ 477,
"UpdatePageLayoutWidgetInput!"
]
}
@@ -9161,7 +9153,7 @@ export default {
10,
{
"input": [
- 479,
+ 478,
"CreateAgentInput!"
]
}
@@ -9170,7 +9162,7 @@ export default {
10,
{
"input": [
- 480,
+ 479,
"UpdateAgentInput!"
]
}
@@ -9179,7 +9171,7 @@ export default {
10,
{
"input": [
- 407,
+ 406,
"AgentIdInput!"
]
}
@@ -9188,7 +9180,7 @@ export default {
23,
{
"input": [
- 481,
+ 480,
"CreateOneObjectInput!"
]
}
@@ -9197,7 +9189,7 @@ export default {
23,
{
"input": [
- 483,
+ 482,
"DeleteOneObjectInput!"
]
}
@@ -9206,7 +9198,7 @@ export default {
23,
{
"input": [
- 484,
+ 483,
"UpdateOneObjectInput!"
]
}
@@ -9215,7 +9207,7 @@ export default {
258,
{
"input": [
- 487,
+ 486,
"CreateOneIndexInput!"
]
}
@@ -9224,7 +9216,7 @@ export default {
258,
{
"input": [
- 490,
+ 489,
"DeleteOneIndexInput!"
]
}
@@ -9233,7 +9225,7 @@ export default {
21,
{
"input": [
- 409,
+ 408,
"LogicFunctionIdInput!"
]
}
@@ -9242,7 +9234,7 @@ export default {
21,
{
"input": [
- 491,
+ 490,
"CreateLogicFunctionFromSourceInput!"
]
}
@@ -9251,7 +9243,7 @@ export default {
147,
{
"input": [
- 492,
+ 491,
"ExecuteOneLogicFunctionInput!"
]
}
@@ -9260,7 +9252,7 @@ export default {
8,
{
"input": [
- 493,
+ 492,
"UpdateLogicFunctionFromSourceInput!"
]
}
@@ -9269,7 +9261,7 @@ export default {
14,
{
"input": [
- 495,
+ 494,
"CreateCommandMenuItemInput!"
]
}
@@ -9278,7 +9270,7 @@ export default {
14,
{
"input": [
- 496,
+ 495,
"UpdateCommandMenuItemInput!"
]
}
@@ -9305,7 +9297,7 @@ export default {
13,
{
"input": [
- 497,
+ 496,
"CreateFrontComponentInput!"
]
}
@@ -9314,7 +9306,7 @@ export default {
13,
{
"input": [
- 498,
+ 497,
"UpdateFrontComponentInput!"
]
}
@@ -9332,7 +9324,7 @@ export default {
69,
{
"data": [
- 500,
+ 499,
"ActivateWorkspaceInput!"
]
}
@@ -9341,7 +9333,7 @@ export default {
69,
{
"data": [
- 501,
+ 500,
"UpdateWorkspaceInput!"
]
}
@@ -9372,7 +9364,7 @@ export default {
225,
{
"input": [
- 502,
+ 501,
"CreateApplicationRegistrationInput!"
]
}
@@ -9381,7 +9373,7 @@ export default {
76,
{
"input": [
- 503,
+ 502,
"UpdateApplicationRegistrationInput!"
]
}
@@ -9408,7 +9400,7 @@ export default {
198,
{
"input": [
- 505,
+ 504,
"CreateApplicationRegistrationVariableInput!"
]
}
@@ -9417,7 +9409,7 @@ export default {
198,
{
"input": [
- 506,
+ 505,
"UpdateApplicationRegistrationVariableInput!"
]
}
@@ -9435,7 +9427,7 @@ export default {
76,
{
"file": [
- 428,
+ 427,
"Upload!"
],
"universalIdentifier": [
@@ -9493,7 +9485,7 @@ export default {
245,
{
"input": [
- 508,
+ 507,
"TriggerInstallApplicationJobInput!"
]
}
@@ -9502,7 +9494,7 @@ export default {
246,
{
"input": [
- 509,
+ 508,
"TriggerUninstallApplicationJobInput!"
]
}
@@ -9515,7 +9507,7 @@ export default {
"UUID!"
],
"input": [
- 510,
+ 509,
"UpdateApplicationInput!"
]
}
@@ -9536,7 +9528,7 @@ export default {
250,
{
"input": [
- 511,
+ 510,
"CreateOneFieldMetadataInput!"
]
}
@@ -9545,7 +9537,7 @@ export default {
250,
{
"input": [
- 513,
+ 512,
"UpdateOneFieldMetadataInput!"
]
}
@@ -9554,7 +9546,7 @@ export default {
250,
{
"input": [
- 515,
+ 514,
"DeleteOneFieldInput!"
]
}
@@ -9563,7 +9555,7 @@ export default {
59,
{
"input": [
- 516,
+ 515,
"CreateViewGroupInput!"
]
}
@@ -9572,7 +9564,7 @@ export default {
59,
{
"inputs": [
- 516,
+ 515,
"[CreateViewGroupInput!]!"
]
}
@@ -9581,7 +9573,7 @@ export default {
59,
{
"input": [
- 517,
+ 516,
"UpdateViewGroupInput!"
]
}
@@ -9590,7 +9582,7 @@ export default {
59,
{
"inputs": [
- 517,
+ 516,
"[UpdateViewGroupInput!]!"
]
}
@@ -9599,7 +9591,7 @@ export default {
59,
{
"input": [
- 519,
+ 518,
"DeleteViewGroupInput!"
]
}
@@ -9608,7 +9600,7 @@ export default {
59,
{
"input": [
- 520,
+ 519,
"DestroyViewGroupInput!"
]
}
@@ -9630,7 +9622,7 @@ export default {
48,
{
"createRoleInput": [
- 521,
+ 520,
"CreateRoleInput!"
]
}
@@ -9639,7 +9631,7 @@ export default {
48,
{
"updateRoleInput": [
- 522,
+ 521,
"UpdateRoleInput!"
]
}
@@ -9657,7 +9649,7 @@ export default {
45,
{
"upsertObjectPermissionsInput": [
- 524,
+ 523,
"UpsertObjectPermissionsInput!"
]
}
@@ -9666,7 +9658,7 @@ export default {
46,
{
"upsertPermissionFlagsInput": [
- 526,
+ 525,
"UpsertPermissionFlagsInput!"
]
}
@@ -9675,7 +9667,7 @@ export default {
40,
{
"upsertFieldPermissionsInput": [
- 527,
+ 526,
"UpsertFieldPermissionsInput!"
]
}
@@ -9684,7 +9676,7 @@ export default {
271,
{
"input": [
- 529,
+ 528,
"UpsertRowLevelPermissionPredicatesInput!"
]
}
@@ -9712,43 +9704,43 @@ export default {
}
],
"sendEmailViaEmailingDomain": [
- 332,
+ 330,
{
"input": [
- 532,
+ 531,
"SendEmailViaDomainInput!"
]
}
],
"sendMessageCampaign": [
- 333,
+ 331,
{
"input": [
- 533,
+ 532,
"SendMessageCampaignInput!"
]
}
],
"cancelMessageCampaign": [
- 331,
+ 329,
{
"input": [
- 534,
+ 533,
"CancelMessageCampaignInput!"
]
}
],
"sendMessageCampaignTest": [
- 332,
+ 330,
{
"input": [
- 535,
+ 534,
"SendMessageCampaignTestInput!"
]
}
],
"duplicateMessageList": [
- 334,
+ 332,
{
"id": [
3,
@@ -9757,10 +9749,10 @@ export default {
}
],
"createMessageSuppression": [
- 335,
+ 333,
{
"input": [
- 536,
+ 535,
"CreateMessageSuppressionInput!"
]
}
@@ -9775,19 +9767,19 @@ export default {
}
],
"createUnsubscribeTopic": [
- 339,
+ 337,
{
"input": [
- 537,
+ 536,
"CreateUnsubscribeTopicInput!"
]
}
],
"updateUnsubscribeTopic": [
- 339,
+ 337,
{
"input": [
- 538,
+ 537,
"UpdateUnsubscribeTopicInput!"
]
}
@@ -9802,34 +9794,34 @@ export default {
}
],
"updateMessageChannel": [
- 319,
+ 317,
{
"input": [
- 539,
+ 538,
"UpdateMessageChannelInput!"
]
}
],
"createEmailGroupChannel": [
- 329,
+ 327,
{
"input": [
- 541,
+ 540,
"CreateEmailGroupChannelInput!"
]
}
],
"updateEmailGroupChannel": [
- 319,
+ 317,
{
"input": [
- 542,
+ 541,
"UpdateEmailGroupChannelInput!"
]
}
],
"deleteEmailGroupChannel": [
- 319,
+ 317,
{
"id": [
3,
@@ -9838,25 +9830,25 @@ export default {
}
],
"createAppMessageChannel": [
- 319,
+ 317,
{
"input": [
- 543,
+ 542,
"CreateAppMessageChannelInput!"
]
}
],
"updateAppMessageChannel": [
- 319,
+ 317,
{
"input": [
- 544,
+ 543,
"UpdateAppMessageChannelInput!"
]
}
],
"deleteAppMessageChannel": [
- 319,
+ 317,
{
"id": [
3,
@@ -9865,19 +9857,19 @@ export default {
}
],
"ingestAppMessages": [
- 328,
+ 326,
{
"input": [
- 545,
+ 544,
"IngestAppMessagesInput!"
]
}
],
"createEmailingDomain": [
- 315,
+ 313,
{
"input": [
- 549,
+ 548,
"CreateEmailingDomainInput!"
]
}
@@ -9892,7 +9884,7 @@ export default {
}
],
"verifyEmailingDomain": [
- 315,
+ 313,
{
"id": [
1,
@@ -9901,34 +9893,34 @@ export default {
}
],
"runAgent": [
- 351,
+ 349,
{
"input": [
- 550,
+ 549,
"RunAgentInput!"
]
}
],
"createWebhook": [
- 348,
+ 346,
{
"input": [
- 554,
+ 553,
"CreateWebhookInput!"
]
}
],
"updateWebhook": [
- 348,
+ 346,
{
"input": [
- 555,
+ 554,
"UpdateWebhookInput!"
]
}
],
"deleteWebhook": [
- 348,
+ 346,
{
"id": [
3,
@@ -9937,37 +9929,37 @@ export default {
}
],
"updateMessageFolder": [
- 391,
+ 390,
{
"input": [
- 557,
+ 556,
"UpdateMessageFolderInput!"
]
}
],
"updateMessageFolders": [
- 391,
+ 390,
{
"input": [
- 559,
+ 558,
"UpdateMessageFoldersInput!"
]
}
],
"updateCalendarChannel": [
- 386,
+ 385,
{
"input": [
- 560,
+ 559,
"UpdateCalendarChannelInput!"
]
}
],
"setAppKeyValue": [
- 384,
+ 383,
{
"input": [
- 562,
+ 561,
"SetAppKeyValueInput!"
]
}
@@ -9980,24 +9972,24 @@ export default {
"String!"
],
"scope": [
- 385
+ 384
]
}
],
"enqueueJob": [
- 382,
+ 381,
{
"input": [
- 563,
+ 562,
"EnqueueJobInput!"
]
}
],
"enqueueJobs": [
- 383,
+ 382,
{
"input": [
- 564,
+ 563,
"EnqueueJobsInput!"
]
}
@@ -10006,16 +9998,16 @@ export default {
8,
{
"input": [
- 566,
+ 565,
"ReportAppConnectionAuthFailureInput!"
]
}
],
"createChatThread": [
- 370
+ 369
],
"sendChatMessage": [
- 375,
+ 374,
{
"threadId": [
3,
@@ -10036,13 +10028,13 @@ export default {
1
],
"fileAttachments": [
- 567,
+ 566,
"[FileAttachmentInput!]"
]
}
],
"retryChatMessage": [
- 375,
+ 374,
{
"threadId": [
3,
@@ -10054,7 +10046,7 @@ export default {
}
],
"answerAgentChatQuestion": [
- 375,
+ 374,
{
"threadId": [
3,
@@ -10065,14 +10057,14 @@ export default {
"UUID!"
],
"answers": [
- 568,
+ 567,
"[AgentChatQuestionAnswerInput!]!"
],
"modelId": [
1
],
"fileAttachments": [
- 567,
+ 566,
"[FileAttachmentInput!]"
]
}
@@ -10087,7 +10079,7 @@ export default {
}
],
"renameChatThread": [
- 370,
+ 369,
{
"id": [
3,
@@ -10100,7 +10092,7 @@ export default {
}
],
"archiveChatThread": [
- 370,
+ 369,
{
"id": [
3,
@@ -10109,7 +10101,7 @@ export default {
}
],
"unarchiveChatThread": [
- 370,
+ 369,
{
"id": [
3,
@@ -10136,7 +10128,7 @@ export default {
}
],
"startWorkspaceSetupChat": [
- 377,
+ 376,
{
"companyContext": [
9
@@ -10147,25 +10139,25 @@ export default {
}
],
"createSkill": [
- 368,
+ 367,
{
"input": [
- 569,
+ 568,
"CreateSkillInput!"
]
}
],
"updateSkill": [
- 368,
+ 367,
{
"input": [
- 570,
+ 569,
"UpdateSkillInput!"
]
}
],
"deleteSkill": [
- 368,
+ 367,
{
"id": [
3,
@@ -10174,7 +10166,7 @@ export default {
}
],
"activateSkill": [
- 368,
+ 367,
{
"id": [
3,
@@ -10183,7 +10175,7 @@ export default {
}
],
"deactivateSkill": [
- 368,
+ 367,
{
"id": [
3,
@@ -10192,7 +10184,7 @@ export default {
}
],
"evaluateAgentTurn": [
- 379,
+ 378,
{
"turnId": [
3,
@@ -10201,7 +10193,7 @@ export default {
}
],
"runEvaluationInput": [
- 380,
+ 379,
{
"agentId": [
3,
@@ -10214,16 +10206,16 @@ export default {
}
],
"updateTimelineActivityType": [
- 397,
+ 396,
{
"input": [
- 571,
+ 570,
"UpdateTimelineActivityTypeInput!"
]
}
],
"resetTimelineActivityType": [
- 397,
+ 396,
{
"id": [
3,
@@ -10235,7 +10227,7 @@ export default {
280,
{
"input": [
- 572,
+ 571,
"GetAuthorizationUrlForSSOInput!"
]
}
@@ -10401,7 +10393,7 @@ export default {
283,
{
"input": [
- 573
+ 572
]
}
],
@@ -10413,7 +10405,7 @@ export default {
"String!"
],
"file": [
- 428,
+ 427,
"Upload!"
]
}
@@ -10579,7 +10571,7 @@ export default {
8,
{
"input": [
- 574,
+ 573,
"UpdateWorkspaceMemberSettingsInput!"
]
}
@@ -10613,7 +10605,7 @@ export default {
235,
{
"input": [
- 575,
+ 574,
"SetupOIDCSsoInput!"
]
}
@@ -10622,7 +10614,7 @@ export default {
235,
{
"input": [
- 576,
+ 575,
"SetupSAMLSsoInput!"
]
}
@@ -10631,7 +10623,7 @@ export default {
231,
{
"input": [
- 577,
+ 576,
"DeleteSsoInput!"
]
}
@@ -10640,13 +10632,13 @@ export default {
232,
{
"input": [
- 578,
+ 577,
"EditSsoInput!"
]
}
],
"createObjectEvent": [
- 363,
+ 361,
{
"event": [
1,
@@ -10666,10 +10658,10 @@ export default {
}
],
"trackAnalytics": [
- 363,
+ 361,
{
"type": [
- 579,
+ 578,
"AnalyticsType!"
],
"name": [
@@ -10684,7 +10676,7 @@ export default {
}
],
"duplicateDashboard": [
- 361,
+ 359,
{
"id": [
3,
@@ -10709,25 +10701,25 @@ export default {
295
],
"createCalendarEvent": [
- 353,
+ 351,
{
"input": [
- 580,
+ 579,
"CreateCalendarEventInput!"
]
}
],
"sendEmail": [
- 362,
+ 360,
{
"input": [
- 581,
+ 580,
"SendEmailInput!"
]
}
],
"startChannelSync": [
- 352,
+ 350,
{
"connectedAccountId": [
3,
@@ -10736,14 +10728,14 @@ export default {
}
],
"saveImapSmtpCaldavAccount": [
- 347,
+ 345,
{
"handle": [
1,
"String!"
],
"connectionParameters": [
- 583,
+ 582,
"EmailAccountConnectionParameters!"
],
"id": [
@@ -10755,13 +10747,13 @@ export default {
195,
{
"input": [
- 585,
+ 584,
"UpdateLabPublicFeatureFlagInput!"
]
}
],
"createPublicDomain": [
- 313,
+ 311,
{
"domain": [
1,
@@ -10823,7 +10815,7 @@ export default {
302,
{
"file": [
- 428,
+ 427,
"Upload!"
],
"applicationUniversalIdentifier": [
@@ -10848,7 +10840,7 @@ export default {
"String!"
],
"files": [
- 586,
+ 585,
"[ApplicationFileUploadRequestInput!]!"
]
}
@@ -10971,7 +10963,7 @@ export default {
3
],
"update": [
- 427
+ 426
],
"__typename": [
1
@@ -11044,7 +11036,7 @@ export default {
3
],
"payload": [
- 429
+ 428
],
"__typename": [
1
@@ -11127,7 +11119,7 @@ export default {
3
],
"update": [
- 435
+ 434
],
"__typename": [
1
@@ -11298,19 +11290,19 @@ export default {
3
],
"view": [
- 441
+ 440
],
"viewFields": [
- 442
+ 441
],
"viewFilters": [
- 443
+ 442
],
"viewFilterGroups": [
- 444
+ 443
],
"viewSorts": [
- 445
+ 444
],
"__typename": [
1
@@ -11459,7 +11451,7 @@ export default {
3
],
"update": [
- 448
+ 447
],
"__typename": [
1
@@ -11497,7 +11489,7 @@ export default {
3
],
"update": [
- 452
+ 451
],
"__typename": [
1
@@ -11573,7 +11565,7 @@ export default {
3
],
"update": [
- 457
+ 456
],
"__typename": [
1
@@ -11637,10 +11629,10 @@ export default {
3
],
"groups": [
- 462
+ 461
],
"fields": [
- 463
+ 462
],
"__typename": [
1
@@ -11660,7 +11652,7 @@ export default {
8
],
"fields": [
- 463
+ 462
],
"__typename": [
1
@@ -11831,7 +11823,7 @@ export default {
8
],
"tabs": [
- 475
+ 474
],
"__typename": [
1
@@ -11854,7 +11846,7 @@ export default {
102
],
"widgets": [
- 476
+ 475
],
"__typename": [
1
@@ -12019,7 +12011,7 @@ export default {
},
"CreateOneObjectInput": {
"object": [
- 482
+ 481
],
"__typename": [
1
@@ -12079,7 +12071,7 @@ export default {
},
"UpdateOneObjectInput": {
"update": [
- 485
+ 484
],
"id": [
3
@@ -12132,7 +12124,7 @@ export default {
24
],
"translations": [
- 486
+ 485
],
"__typename": [
1
@@ -12154,7 +12146,7 @@ export default {
},
"CreateOneIndexInput": {
"index": [
- 488
+ 487
],
"__typename": [
1
@@ -12165,7 +12157,7 @@ export default {
3
],
"fields": [
- 489
+ 488
],
"indexType": [
259
@@ -12250,7 +12242,7 @@ export default {
3
],
"update": [
- 494
+ 493
],
"__typename": [
1
@@ -12419,7 +12411,7 @@ export default {
3
],
"update": [
- 499
+ 498
],
"__typename": [
1
@@ -12546,7 +12538,7 @@ export default {
1
],
"update": [
- 504
+ 503
],
"__typename": [
1
@@ -12591,7 +12583,7 @@ export default {
1
],
"update": [
- 507
+ 506
],
"__typename": [
1
@@ -12637,7 +12629,7 @@ export default {
},
"CreateOneFieldMetadataInput": {
"field": [
- 512
+ 511
],
"__typename": [
1
@@ -12716,7 +12708,7 @@ export default {
3
],
"update": [
- 514
+ 513
],
"__typename": [
1
@@ -12781,7 +12773,7 @@ export default {
9
],
"translations": [
- 486
+ 485
],
"__typename": [
1
@@ -12820,7 +12812,7 @@ export default {
3
],
"update": [
- 518
+ 517
],
"__typename": [
1
@@ -12905,7 +12897,7 @@ export default {
},
"UpdateRoleInput": {
"update": [
- 523
+ 522
],
"id": [
3
@@ -12960,7 +12952,7 @@ export default {
3
],
"objectPermissions": [
- 525
+ 524
],
"__typename": [
1
@@ -13002,7 +12994,7 @@ export default {
3
],
"fieldPermissions": [
- 528
+ 527
],
"__typename": [
1
@@ -13033,10 +13025,10 @@ export default {
3
],
"predicates": [
- 530
+ 529
],
"predicateGroups": [
- 531
+ 530
],
"__typename": [
1
@@ -13184,7 +13176,7 @@ export default {
1
],
"visibility": [
- 340
+ 338
],
"__typename": [
1
@@ -13201,7 +13193,7 @@ export default {
1
],
"visibility": [
- 340
+ 338
],
"__typename": [
1
@@ -13212,7 +13204,7 @@ export default {
3
],
"update": [
- 540
+ 539
],
"__typename": [
1
@@ -13220,16 +13212,16 @@ export default {
},
"UpdateMessageChannelInputUpdates": {
"visibility": [
- 320
+ 318
],
"isContactAutoCreationEnabled": [
8
],
"contactAutoCreationPolicy": [
- 322
+ 320
],
"messageFolderImportPolicy": [
- 323
+ 321
],
"isSyncEnabled": [
8
@@ -13277,7 +13269,7 @@ export default {
1
],
"visibility": [
- 320
+ 318
],
"__typename": [
1
@@ -13291,7 +13283,7 @@ export default {
1
],
"visibility": [
- 320
+ 318
],
"isSyncEnabled": [
8
@@ -13305,7 +13297,7 @@ export default {
3
],
"messages": [
- 546
+ 545
],
"__typename": [
1
@@ -13328,7 +13320,7 @@ export default {
4
],
"participants": [
- 547
+ 546
],
"__typename": [
1
@@ -13336,7 +13328,7 @@ export default {
},
"AppMessageParticipantInput": {
"role": [
- 548
+ 547
],
"handle": [
1
@@ -13374,7 +13366,7 @@ export default {
3
],
"messages": [
- 551
+ 550
],
"__typename": [
1
@@ -13382,13 +13374,13 @@ export default {
},
"RunAgentMessageInput": {
"role": [
- 552
+ 551
],
"content": [
1
],
"attachments": [
- 553
+ 552
],
"__typename": [
1
@@ -13431,7 +13423,7 @@ export default {
3
],
"update": [
- 556
+ 555
],
"__typename": [
1
@@ -13459,7 +13451,7 @@ export default {
3
],
"update": [
- 558
+ 557
],
"__typename": [
1
@@ -13478,7 +13470,7 @@ export default {
3
],
"update": [
- 558
+ 557
],
"__typename": [
1
@@ -13489,7 +13481,7 @@ export default {
3
],
"update": [
- 561
+ 560
],
"__typename": [
1
@@ -13497,13 +13489,13 @@ export default {
},
"UpdateCalendarChannelInputUpdates": {
"visibility": [
- 389
+ 388
],
"isContactAutoCreationEnabled": [
8
],
"contactAutoCreationPolicy": [
- 390
+ 389
],
"isSyncEnabled": [
8
@@ -13520,7 +13512,7 @@ export default {
9
],
"scope": [
- 385
+ 384
],
"__typename": [
1
@@ -13554,7 +13546,7 @@ export default {
9
],
"jobs": [
- 565
+ 564
],
"retryLimit": [
28
@@ -13676,7 +13668,7 @@ export default {
8
],
"translations": [
- 486
+ 485
],
"__typename": [
1
@@ -13842,7 +13834,7 @@ export default {
1
],
"files": [
- 582
+ 581
],
"__typename": [
1
@@ -13864,13 +13856,13 @@ export default {
1
],
"IMAP": [
- 584
+ 583
],
"SMTP": [
- 584
+ 583
],
"CALDAV": [
- 584
+ 583
],
"__typename": [
1
@@ -13935,13 +13927,13 @@ export default {
272,
{
"input": [
- 588,
+ 587,
"LogicFunctionLogsInput!"
]
}
],
"onAgentChatEvent": [
- 376,
+ 375,
{
"threadId": [
3,
@@ -13950,19 +13942,19 @@ export default {
}
],
"eventLogsLive": [
- 364,
+ 362,
{
"table": [
- 416,
+ 415,
"EventLogTable!"
]
}
],
"exportRecords": [
- 311,
+ 365,
{
"input": [
- 589,
+ 588,
"CreateRecordExportInput!"
]
}
diff --git a/packages/twenty-front/src/generated-metadata/graphql.ts b/packages/twenty-front/src/generated-metadata/graphql.ts
index 3d6b081593e..9b605e21d82 100644
--- a/packages/twenty-front/src/generated-metadata/graphql.ts
+++ b/packages/twenty-front/src/generated-metadata/graphql.ts
@@ -5627,18 +5627,9 @@ export type RecordExport = {
errorMessage?: Maybe<Scalars['String']['output']>;
filename: Scalars['String']['output'];
id: Scalars['UUID']['output'];
- processedRecordCount: Scalars['Int']['output'];
- status: RecordExportStatus;
- totalRecordCount?: Maybe<Scalars['Int']['output']>;
+ progress: Scalars['Int']['output'];
};
-export enum RecordExportStatus {
- COMPLETED = 'COMPLETED',
- FAILED = 'FAILED',
- PROCESSING = 'PROCESSING',
- QUEUED = 'QUEUED'
-}
-
export type RecordIdentifier = {
__typename?: 'RecordIdentifier';
id: Scalars['UUID']['output'];
@@ -8964,7 +8955,7 @@ export type ExportRecordsSubscriptionVariables = Exact<{
}>;
-export type ExportRecordsSubscription = { __typename?: 'Subscription', exportRecords: { __typename?: 'RecordExport', id: string, filename: string, status: RecordExportStatus, processedRecordCount: number, totalRecordCount?: number | null, errorMessage?: string | null, downloadUrl?: string | null } };
+export type ExportRecordsSubscription = { __typename?: 'Subscription', exportRecords: { __typename?: 'RecordExport', id: string, filename: string, progress: number, errorMessage?: string | null, downloadUrl?: string | null } };
export type CreateEmailGroupChannelMutationVariables = Exact<{
input: CreateEmailGroupChannelInput;
@@ -10269,7 +10260,7 @@ export const CallRecordingIdForCalendarEventDocument = {"kind":"Document","defin
export const BarChartDataDocument = {"kind":"Document","definitions":[{"kind":"OperationDefinition","operation":"query","name":{"kind":"Name","value":"BarChartData"},"variableDefinitions":[{"kind":"VariableDefinition","variable":{"kind":"Variable","name":{"kind":"Name","value":"input"}},"type":{"kind":"NonNullType","type":{"kind":"NamedType","name":{"kind":"Name","value":"BarChartDataInput"}}}}],"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"barChartData"},"arguments":[{"kind":"Argument","name":{"kind":"Name","value":"input"},"value":{"kind":"Variable","name":{"kind":"Name","value":"input"}}}],"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"data"}},{"kind":"Field","name":{"kind":"Name","value":"indexBy"}},{"kind":"Field","name":{"kind":"Name","value":"keys"}},{"kind":"Field","name":{"kind":"Name","value":"series"},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"key"}},{"kind":"Field","name":{"kind":"Name","value":"label"}}]}},{"kind":"Field","name":{"kind":"Name","value":"xAxisLabel"}},{"kind":"Field","name":{"kind":"Name","value":"yAxisLabel"}},{"kind":"Field","name":{"kind":"Name","value":"showLegend"}},{"kind":"Field","name":{"kind":"Name","value":"showDataLabels"}},{"kind":"Field","name":{"kind":"Name","value":"layout"}},{"kind":"Field","name":{"kind":"Name","value":"groupMode"}},{"kind":"Field","name":{"kind":"Name","value":"hasTooManyGroups"}},{"kind":"Field","name":{"kind":"Name","value":"formattedToRawLookup"}}]}}]}}]} as unknown as DocumentNode<BarChartDataQuery, BarChartDataQueryVariables>;
export const LineChartDataDocument = {"kind":"Document","definitions":[{"kind":"OperationDefinition","operation":"query","name":{"kind":"Name","value":"LineChartData"},"variableDefinitions":[{"kind":"VariableDefinition","variable":{"kind":"Variable","name":{"kind":"Name","value":"input"}},"type":{"kind":"NonNullType","type":{"kind":"NamedType","name":{"kind":"Name","value":"LineChartDataInput"}}}}],"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"lineChartData"},"arguments":[{"kind":"Argument","name":{"kind":"Name","value":"input"},"value":{"kind":"Variable","name":{"kind":"Name","value":"input"}}}],"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"series"},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"key"}},{"kind":"Field","name":{"kind":"Name","value":"label"}},{"kind":"Field","name":{"kind":"Name","value":"data"},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"x"}},{"kind":"Field","name":{"kind":"Name","value":"y"}}]}}]}},{"kind":"Field","name":{"kind":"Name","value":"xAxisLabel"}},{"kind":"Field","name":{"kind":"Name","value":"yAxisLabel"}},{"kind":"Field","name":{"kind":"Name","value":"showLegend"}},{"kind":"Field","name":{"kind":"Name","value":"showDataLabels"}},{"kind":"Field","name":{"kind":"Name","value":"hasTooManyGroups"}},{"kind":"Field","name":{"kind":"Name","value":"formattedToRawLookup"}}]}}]}}]} as unknown as DocumentNode<LineChartDataQuery, LineChartDataQueryVariables>;
export const PieChartDataDocument = {"kind":"Document","definitions":[{"kind":"OperationDefinition","operation":"query","name":{"kind":"Name","value":"PieChartData"},"variableDefinitions":[{"kind":"VariableDefinition","variable":{"kind":"Variable","name":{"kind":"Name","value":"input"}},"type":{"kind":"NonNullType","type":{"kind":"NamedType","name":{"kind":"Name","value":"PieChartDataInput"}}}}],"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"pieChartData"},"arguments":[{"kind":"Argument","name":{"kind":"Name","value":"input"},"value":{"kind":"Variable","name":{"kind":"Name","value":"input"}}}],"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"data"},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"key"}},{"kind":"Field","name":{"kind":"Name","value":"value"}}]}},{"kind":"Field","name":{"kind":"Name","value":"showLegend"}},{"kind":"Field","name":{"kind":"Name","value":"showDataLabels"}},{"kind":"Field","name":{"kind":"Name","value":"showCenterMetric"}},{"kind":"Field","name":{"kind":"Name","value":"hasTooManyGroups"}},{"kind":"Field","name":{"kind":"Name","value":"formattedToRawLookup"}}]}}]}}]} as unknown as DocumentNode<PieChartDataQuery, PieChartDataQueryVariables>;
-export const ExportRecordsDocument = {"kind":"Document","definitions":[{"kind":"OperationDefinition","operation":"subscription","name":{"kind":"Name","value":"ExportRecords"},"variableDefinitions":[{"kind":"VariableDefinition","variable":{"kind":"Variable","name":{"kind":"Name","value":"input"}},"type":{"kind":"NonNullType","type":{"kind":"NamedType","name":{"kind":"Name","value":"CreateRecordExportInput"}}}}],"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"exportRecords"},"arguments":[{"kind":"Argument","name":{"kind":"Name","value":"input"},"value":{"kind":"Variable","name":{"kind":"Name","value":"input"}}}],"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"id"}},{"kind":"Field","name":{"kind":"Name","value":"filename"}},{"kind":"Field","name":{"kind":"Name","value":"status"}},{"kind":"Field","name":{"kind":"Name","value":"processedRecordCount"}},{"kind":"Field","name":{"kind":"Name","value":"totalRecordCount"}},{"kind":"Field","name":{"kind":"Name","value":"errorMessage"}},{"kind":"Field","name":{"kind":"Name","value":"downloadUrl"}}]}}]}}]} as unknown as DocumentNode<ExportRecordsSubscription, ExportRecordsSubscriptionVariables>;
+export const ExportRecordsDocument = {"kind":"Document","definitions":[{"kind":"OperationDefinition","operation":"subscription","name":{"kind":"Name","value":"ExportRecords"},"variableDefinitions":[{"kind":"VariableDefinition","variable":{"kind":"Variable","name":{"kind":"Name","value":"input"}},"type":{"kind":"NonNullType","type":{"kind":"NamedType","name":{"kind":"Name","value":"CreateRecordExportInput"}}}}],"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"exportRecords"},"arguments":[{"kind":"Argument","name":{"kind":"Name","value":"input"},"value":{"kind":"Variable","name":{"kind":"Name","value":"input"}}}],"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"id"}},{"kind":"Field","name":{"kind":"Name","value":"filename"}},{"kind":"Field","name":{"kind":"Name","value":"progress"}},{"kind":"Field","name":{"kind":"Name","value":"errorMessage"}},{"kind":"Field","name":{"kind":"Name","value":"downloadUrl"}}]}}]}}]} as unknown as DocumentNode<ExportRecordsSubscription, ExportRecordsSubscriptionVariables>;
export const CreateEmailGroupChannelDocument = {"kind":"Document","definitions":[{"kind":"OperationDefinition","operation":"mutation","name":{"kind":"Name","value":"CreateEmailGroupChannel"},"variableDefinitions":[{"kind":"VariableDefinition","variable":{"kind":"Variable","name":{"kind":"Name","value":"input"}},"type":{"kind":"NonNullType","type":{"kind":"NamedType","name":{"kind":"Name","value":"CreateEmailGroupChannelInput"}}}}],"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"createEmailGroupChannel"},"arguments":[{"kind":"Argument","name":{"kind":"Name","value":"input"},"value":{"kind":"Variable","name":{"kind":"Name","value":"input"}}}],"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"messageChannel"},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"id"}},{"kind":"Field","name":{"kind":"Name","value":"handle"}},{"kind":"Field","name":{"kind":"Name","value":"visibility"}},{"kind":"Field","name":{"kind":"Name","value":"type"}},{"kind":"Field","name":{"kind":"Name","value":"isSyncEnabled"}},{"kind":"Field","name":{"kind":"Name","value":"excludeGroupEmails"}},{"kind":"Field","name":{"kind":"Name","value":"contactAutoCreationPolicy"}}]}},{"kind":"Field","name":{"kind":"Name","value":"forwardingAddress"}}]}}]}}]} as unknown as DocumentNode<CreateEmailGroupChannelMutation, CreateEmailGroupChannelMutationVariables>;
export const DeleteConnectedAccountDocument = {"kind":"Document","definitions":[{"kind":"OperationDefinition","operation":"mutation","name":{"kind":"Name","value":"DeleteConnectedAccount"},"variableDefinitions":[{"kind":"VariableDefinition","variable":{"kind":"Variable","name":{"kind":"Name","value":"id"}},"type":{"kind":"NonNullType","type":{"kind":"NamedType","name":{"kind":"Name","value":"UUID"}}}}],"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"deleteConnectedAccount"},"arguments":[{"kind":"Argument","name":{"kind":"Name","value":"id"},"value":{"kind":"Variable","name":{"kind":"Name","value":"id"}}}],"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"id"}}]}}]}}]} as unknown as DocumentNode<DeleteConnectedAccountMutation, DeleteConnectedAccountMutationVariables>;
export const DeleteEmailGroupChannelDocument = {"kind":"Document","definitions":[{"kind":"OperationDefinition","operation":"mutation","name":{"kind":"Name","value":"DeleteEmailGroupChannel"},"variableDefinitions":[{"kind":"VariableDefinition","variable":{"kind":"Variable","name":{"kind":"Name","value":"id"}},"type":{"kind":"NonNullType","type":{"kind":"NamedType","name":{"kind":"Name","value":"UUID"}}}}],"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"deleteEmailGroupChannel"},"arguments":[{"kind":"Argument","name":{"kind":"Name","value":"id"},"value":{"kind":"Variable","name":{"kind":"Name","value":"id"}}}],"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"id"}}]}}]}}]} as unknown as DocumentNode<DeleteEmailGroupChannelMutation, DeleteEmailGroupChannelMutationVariables>;
diff --git a/packages/twenty-front/src/modules/page-layout/widgets/standalone-rich-text/components/__stories__/RecordPageNoteWidget.stories.tsx b/packages/twenty-front/src/modules/page-layout/widgets/standalone-rich-text/components/__stories__/RecordPageNoteWidget.stories.tsx
index a81c5c4701e..c6a4fedba79 100644
--- a/packages/twenty-front/src/modules/page-layout/widgets/standalone-rich-text/components/__stories__/RecordPageNoteWidget.stories.tsx
+++ b/packages/twenty-front/src/modules/page-layout/widgets/standalone-rich-text/components/__stories__/RecordPageNoteWidget.stories.tsx
@@ -264,7 +264,7 @@ export const SelectAndFormatText: Story = {
await expect(jotaiStore.get(EDITING_WIDGET_ATOM)).toBe('other-widget');
await userEvent.click(bold);
await waitFor(() =>
- expect(canvas.getByText('instructions').closest('strong')).not.toBeNull(),
+ expect(canvas.getByText(/instructions/).closest('strong')).not.toBeNull(),
);
await expect(jotaiStore.get(isSidePanelOpenedState.atom)).toBe(false);
await expect(await canvas.findByRole('textbox')).toBe(editor);
diff --git a/packages/twenty-front/src/modules/record-export/components/__stories__/RecordExportConnectionEffect.stories.tsx b/packages/twenty-front/src/modules/record-export/components/__stories__/RecordExportConnectionEffect.stories.tsx
index 6b8632cde64..fec37c4fe27 100644
--- a/packages/twenty-front/src/modules/record-export/components/__stories__/RecordExportConnectionEffect.stories.tsx
+++ b/packages/twenty-front/src/modules/record-export/components/__stories__/RecordExportConnectionEffect.stories.tsx
@@ -7,7 +7,6 @@ import { useState } from 'react';
import { expect, spyOn, userEvent, waitFor, within } from 'storybook/test';
import { IconFileExport } from 'twenty-ui/icon';
import { REACT_APP_SERVER_BASE_URL } from '~/config';
-import { RecordExportStatus } from '~/generated-metadata/graphql';
const ExportExample = () => {
const [connection] = useState(createRecordExportConnection);
@@ -55,19 +54,17 @@ const ExportExample = () => {
const exportHandler = (finish: 'completed' | 'interrupted' | 'wait') =>
http.post(`${REACT_APP_SERVER_BASE_URL}/metadata`, () => {
const encoder = new TextEncoder();
- const event = (status: RecordExportStatus) =>
+ const event = (progress: number) =>
encoder.encode(
`event: next\ndata: ${JSON.stringify({
data: {
exportRecords: {
id: 'export',
filename: 'person.csv',
- status,
- processedRecordCount: 42,
- totalRecordCount: 100,
+ progress,
downloadUrl:
- status === RecordExportStatus.COMPLETED
- ? '/record-exports/export/download?token=token'
+ progress === 100
+ ? '/file/record-export/export?token=token'
: null,
},
},
@@ -75,13 +72,13 @@ const exportHandler = (finish: 'completed' | 'interrupted' | 'wait') =>
);
const body = new ReadableStream({
async start(controller) {
- controller.enqueue(event(RecordExportStatus.PROCESSING));
+ controller.enqueue(event(42));
if (finish === 'wait') {
return;
}
await new Promise((resolve) => setTimeout(resolve, 1000));
if (finish === 'completed') {
- controller.enqueue(event(RecordExportStatus.COMPLETED));
+ controller.enqueue(event(100));
}
controller.enqueue(encoder.encode('event: complete\ndata: null\n\n'));
controller.close();
@@ -117,7 +114,7 @@ export const AutomaticDownload: Story = {
});
expect(download.mock.instances[0]).toHaveAttribute(
'href',
- '/record-exports/export/download?token=token',
+ '/file/record-export/export?token=token',
);
await waitFor(() =>
expect(canvas.getByRole('button', { name: 'Export' })).toBeEnabled(),
diff --git a/packages/twenty-front/src/modules/record-export/graphql/exportRecords.ts b/packages/twenty-front/src/modules/record-export/graphql/exportRecords.ts
index 2119abae02e..88a16cadc9a 100644
--- a/packages/twenty-front/src/modules/record-export/graphql/exportRecords.ts
+++ b/packages/twenty-front/src/modules/record-export/graphql/exportRecords.ts
@@ -5,9 +5,7 @@ export const EXPORT_RECORDS = gql`
exportRecords(input: $input) {
id
filename
- status
- processedRecordCount
- totalRecordCount
+ progress
errorMessage
downloadUrl
}
diff --git a/packages/twenty-front/src/modules/record-export/utils/__tests__/createRecordExportConnection.test.ts b/packages/twenty-front/src/modules/record-export/utils/__tests__/createRecordExportConnection.test.ts
new file mode 100644
index 00000000000..43d84ae35f8
--- /dev/null
+++ b/packages/twenty-front/src/modules/record-export/utils/__tests__/createRecordExportConnection.test.ts
@@ -0,0 +1,102 @@
+import { createRecordExportConnection } from '@/record-export/utils/createRecordExportConnection';
+import { type ExecutionResult, type Sink } from 'graphql-sse';
+import { type ExportRecordsSubscription } from '~/generated-metadata/graphql';
+
+let mockSink: Sink<ExecutionResult<ExportRecordsSubscription>>;
+const mockDispose = jest.fn();
+
+jest.mock('graphql-sse', () => ({
+ createClient: () => ({
+ dispose: mockDispose,
+ subscribe: (_request: unknown, sink: typeof mockSink) => {
+ mockSink = sink;
+ },
+ }),
+}));
+
+const input = { objectMetadataId: 'person', fieldMetadataIds: ['name'] };
+const update = (values: Partial<ExportRecordsSubscription['exportRecords']>) =>
+ mockSink.next({
+ data: {
+ exportRecords: {
+ id: 'export',
+ filename: 'person.csv',
+ progress: 42,
+ ...values,
+ },
+ },
+ });
+
+describe('createRecordExportConnection', () => {
+ beforeEach(() => jest.clearAllMocks());
+ afterEach(() => jest.restoreAllMocks());
+
+ it('reports server progress and automatically downloads the completed file once', async () => {
+ const click = jest
+ .spyOn(HTMLAnchorElement.prototype, 'click')
+ .mockImplementation(() => {});
+ const onProgress = jest.fn();
+ const connection = createRecordExportConnection();
+ const finished = connection.exportRecords({ input, onProgress });
+ update({});
+ expect(onProgress.mock.calls).toEqual([[0], [42]]);
+ expect(click).not.toHaveBeenCalled();
+ update({
+ progress: 100,
+ downloadUrl: '/file/record-export/export?token=token',
+ });
+ await expect(finished).resolves.toBeUndefined();
+ expect(click).toHaveBeenCalledTimes(1);
+ expect(click.mock.instances[0]).toHaveAttribute('download', 'person.csv');
+ expect(click.mock.instances[0]).toHaveAttribute(
+ 'href',
+ '/file/record-export/export?token=token',
+ );
+ update({
+ progress: 100,
+ downloadUrl: '/file/record-export/export?token=token',
+ });
+ mockSink.complete();
+ expect(click).toHaveBeenCalledTimes(1);
+ expect(mockDispose).toHaveBeenCalledTimes(1);
+ });
+
+ it('surfaces the server failure and closes the connection', async () => {
+ const finished = createRecordExportConnection().exportRecords({ input });
+ update({ errorMessage: 'Export failed' });
+ await expect(finished).rejects.toThrow('Export failed');
+ expect(mockDispose).toHaveBeenCalledTimes(1);
+ });
+
+ it.each(['error', 'complete'] as const)(
+ 'fails when the stream ends with %s before a download',
+ async (event) => {
+ const finished = createRecordExportConnection().exportRecords({ input });
+ if (event === 'error') {
+ mockSink.error(new Error('Network failure'));
+ } else {
+ mockSink.complete();
+ }
+ await expect(finished).rejects.toThrow(
+ event === 'error' ? 'connection was lost' : 'export was interrupted',
+ );
+ expect(mockDispose).toHaveBeenCalledTimes(1);
+ },
+ );
+
+ it('ignores late completion after cancellation', async () => {
+ const click = jest
+ .spyOn(HTMLAnchorElement.prototype, 'click')
+ .mockImplementation(() => {});
+ const connection = createRecordExportConnection();
+ const finished = connection.exportRecords({ input });
+ connection.cancel();
+ await expect(finished).resolves.toBeUndefined();
+ update({
+ progress: 100,
+ downloadUrl: '/file/record-export/export?token=token',
+ });
+ expect(click).not.toHaveBeenCalled();
+ expect(mockDispose).toHaveBeenCalledTimes(1);
+ });
+});
diff --git a/packages/twenty-front/src/modules/record-export/utils/__tests__/getRecordExportUpdateOrThrow.test.ts b/packages/twenty-front/src/modules/record-export/utils/__tests__/getRecordExportUpdateOrThrow.test.ts
deleted file mode 100644
index 33df08f3042..00000000000
--- a/packages/twenty-front/src/modules/record-export/utils/__tests__/getRecordExportUpdateOrThrow.test.ts
+++ /dev/null
@@ -1,52 +0,0 @@
-import { getRecordExportUpdateOrThrow } from '@/record-export/utils/getRecordExportUpdateOrThrow';
-import { RecordExportStatus } from '~/generated-metadata/graphql';
-
-const recordExport = {
- id: 'export',
- filename: 'person.csv',
- status: RecordExportStatus.PROCESSING,
- processedRecordCount: 42,
- totalRecordCount: 100,
-};
-
-describe('getRecordExportUpdateOrThrow', () => {
- it.each([
- { totalRecordCount: null, processedRecordCount: 0, progress: 0 },
- { totalRecordCount: 0, processedRecordCount: 0, progress: 0 },
- { totalRecordCount: 100, processedRecordCount: 42, progress: 42 },
- { totalRecordCount: 100, processedRecordCount: 100, progress: 99 },
- { totalRecordCount: 100, processedRecordCount: 110, progress: 99 },
- ])(
- 'reports $progress percent before the file is ready',
- ({ progress, ...counts }) => {
- expect(
- getRecordExportUpdateOrThrow({ ...recordExport, ...counts }),
- ).toEqual({
- progress,
- });
- },
- );
-
- it('downloads only a completed export with a URL', () => {
- const completed = { ...recordExport, status: RecordExportStatus.COMPLETED };
- expect(() => getRecordExportUpdateOrThrow(completed)).toThrow(
- 'could not be downloaded',
- );
- expect(
- getRecordExportUpdateOrThrow({ ...completed, downloadUrl: '/download' }),
- ).toEqual({
- progress: 100,
- download: { url: '/download', filename: 'person.csv' },
- });
- });
-
- it('surfaces the server failure', () => {
- expect(() =>
- getRecordExportUpdateOrThrow({
- ...recordExport,
- status: RecordExportStatus.FAILED,
- errorMessage: 'Permission revoked',
- }),
- ).toThrow('Permission revoked');
- });
-});
diff --git a/packages/twenty-front/src/modules/record-export/utils/createRecordExportConnection.ts b/packages/twenty-front/src/modules/record-export/utils/createRecordExportConnection.ts
index 17c24ce20f5..3399389d53a 100644
--- a/packages/twenty-front/src/modules/record-export/utils/createRecordExportConnection.ts
+++ b/packages/twenty-front/src/modules/record-export/utils/createRecordExportConnection.ts
@@ -1,4 +1,3 @@
-import { getRecordExportUpdateOrThrow } from '@/record-export/utils/getRecordExportUpdateOrThrow';
import { t } from '@lingui/core/macro';
import { print } from 'graphql';
import { createClient } from 'graphql-sse';
@@ -60,12 +59,14 @@ export const createRecordExportConnection = () => {
return;
}
try {
- const update = getRecordExportUpdateOrThrow(recordExport);
- onProgress?.(update.progress);
- if (isDefined(update.download)) {
+ if (isDefined(recordExport.errorMessage)) {
+ throw new Error(recordExport.errorMessage);
+ }
+ onProgress?.(recordExport.progress);
+ if (isDefined(recordExport.downloadUrl)) {
const link = document.createElement('a');
- link.href = update.download.url;
- link.download = update.download.filename;
+ link.href = recordExport.downloadUrl;
+ link.download = recordExport.filename;
document.body.appendChild(link);
link.click();
link.remove();
diff --git a/packages/twenty-front/src/modules/record-export/utils/getRecordExportUpdateOrThrow.ts b/packages/twenty-front/src/modules/record-export/utils/getRecordExportUpdateOrThrow.ts
deleted file mode 100644
index 1797b11bb4b..00000000000
--- a/packages/twenty-front/src/modules/record-export/utils/getRecordExportUpdateOrThrow.ts
+++ /dev/null
@@ -1,38 +0,0 @@
-import { t } from '@lingui/core/macro';
-import { isDefined } from 'twenty-shared/utils';
-import {
- RecordExportStatus,
- type ExportRecordsSubscription,
-} from '~/generated-metadata/graphql';
-
-export const getRecordExportUpdateOrThrow = (
- recordExport: ExportRecordsSubscription['exportRecords'],
-): { progress: number; download?: { url: string; filename: string } } => {
- if (recordExport.status === RecordExportStatus.FAILED) {
- throw new Error(
- recordExport.errorMessage ?? t`The export failed. Please try again.`,
- );
- }
- if (recordExport.status === RecordExportStatus.COMPLETED) {
- if (!isDefined(recordExport.downloadUrl)) {
- throw new Error(t`The export could not be downloaded. Please try again.`);
- }
- return {
- progress: 100,
- download: {
- url: recordExport.downloadUrl,
- filename: recordExport.filename,
- },
- };
- }
- const total = recordExport.totalRecordCount;
- return {
- progress:
- isDefined(total) && total > 0
- ? Math.min(
- 99,
- Math.round((recordExport.processedRecordCount / total) * 100),
- )
- : 0,
- };
-};
diff --git a/packages/twenty-server/src/engine/core-modules/core-engine.module.ts b/packages/twenty-server/src/engine/core-modules/core-engine.module.ts
index 04c5de2ffc8..c02a44000eb 100644
--- a/packages/twenty-server/src/engine/core-modules/core-engine.module.ts
+++ b/packages/twenty-server/src/engine/core-modules/core-engine.module.ts
@@ -23,7 +23,6 @@ import { BillingWebhookModule } from 'src/engine/core-modules/billing-webhook/bi
import { AppBillingModule } from 'src/engine/core-modules/billing/app-billing/app-billing.module';
import { BillingModule } from 'src/engine/core-modules/billing/billing.module';
import { BillingGraphqlApiExceptionFilter } from 'src/engine/core-modules/billing/filters/billing-graphql-api-exception.filter';
-import { RecordExportModule } from 'src/engine/core-modules/record-export/record-export.module';
import { PermissionsGraphqlApiExceptionFilter } from 'src/engine/metadata-modules/permissions/utils/permissions-graphql-api-exception.filter';
import { CacheStorageModule } from 'src/engine/core-modules/cache-storage/cache-storage.module';
import { TimelineCalendarEventModule } from 'src/engine/core-modules/calendar/timeline-calendar-event.module';
@@ -87,12 +86,11 @@ import { DashboardModule } from 'src/modules/dashboard/dashboard.module';
import { SendEmailModule } from 'src/modules/messaging/message-outbound-manager/send-email.module';
import { ClientConfigModule } from './client-config/client-config.module';
import { EventLogsViewerModule } from './event-logs/event-logs-viewer.module';
-import { FileModule } from './file/file.module';
+import { FileApiModule } from './file/file-api.module';
@Module({
imports: [
EnvironmentModule,
- RecordExportModule,
TwentyConfigModule.forRoot(),
HealthModule,
AuthModule,
@@ -103,7 +101,7 @@ import { FileModule } from './file/file.module';
UsageModule,
ClientConfigModule,
FeatureFlagModule,
- FileModule,
+ FileApiModule,
RecordShareModule,
RowLevelPermissionModule,
OpenApiModule,
diff --git a/packages/twenty-server/src/engine/core-modules/file-storage/services/file-storage.service.ts b/packages/twenty-server/src/engine/core-modules/file-storage/services/file-storage.service.ts
index 3c4506213d4..f1cbbb57198 100644
--- a/packages/twenty-server/src/engine/core-modules/file-storage/services/file-storage.service.ts
+++ b/packages/twenty-server/src/engine/core-modules/file-storage/services/file-storage.service.ts
@@ -23,10 +23,7 @@ import { validateFolderPath } from 'src/engine/core-modules/file-storage/utils/v
import { validateStoragePathIsWithinWorkspaceOrThrow } from 'src/engine/core-modules/file-storage/utils/validate-storage-path-is-within-workspace-or-throw.util';
import { FileEntity } from 'src/engine/core-modules/file/entities/file.entity';
import { FileSettings } from 'src/engine/core-modules/file/types/file-settings.types';
-import {
- FILE_STATUS,
- type FileStatus,
-} from 'src/engine/core-modules/file/types/file-status.types';
+import { FILE_STATUS } from 'src/engine/core-modules/file/types/file-status.types';
import { removeFileFolderFromFileEntityPath } from 'src/engine/core-modules/file/utils/remove-file-folder-from-file-entity-path.utils';
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';
@@ -528,7 +525,6 @@ export class FileStorageService {
async deleteFolder(
params: Omit<ResourceIdentifier, 'resourcePath'> & {
folderPath: string;
- fileStatus?: FileStatus;
},
): Promise<void> {
const {
@@ -558,7 +554,6 @@ export class FileStorageService {
await this.fileRepository.delete(workspaceId, {
path: Like(`${validatedFolderPath}%`),
applicationId,
- ...(isDefined(params.fileStatus) ? { status: params.fileStatus } : {}),
});
}
diff --git a/packages/twenty-server/src/engine/core-modules/file/controllers/file.controller.spec.ts b/packages/twenty-server/src/engine/core-modules/file/controllers/file.controller.spec.ts
index c39dc0b873e..efd939e36cf 100644
--- a/packages/twenty-server/src/engine/core-modules/file/controllers/file.controller.spec.ts
+++ b/packages/twenty-server/src/engine/core-modules/file/controllers/file.controller.spec.ts
@@ -1,3 +1,9 @@
+import { RecordExportWorkspaceService } from 'src/engine/core-modules/record-export/services/record-export.workspace-service';
+import { JwtAuthGuard } from 'src/engine/guards/jwt-auth.guard';
+import { WorkspaceAuthGuard } from 'src/engine/guards/workspace-auth.guard';
+import { UserAuthGuard } from 'src/engine/guards/user-auth.guard';
+import { CustomPermissionGuard } from 'src/engine/guards/custom-permission.guard';
+import { PermissionsRestApiExceptionFilter } from 'src/engine/metadata-modules/permissions/utils/permissions-rest-api-exception.filter';
import { type CanActivate, Logger } from '@nestjs/common';
import { Test, type TestingModule } from '@nestjs/testing';
@@ -68,6 +74,10 @@ describe('FileController', () => {
const module: TestingModule = await Test.createTestingModule({
controllers: [FileController],
providers: [
+ {
+ provide: RecordExportWorkspaceService,
+ useValue: { openDownload: jest.fn() },
+ },
{
provide: FileService,
useValue: {
@@ -84,6 +94,16 @@ describe('FileController', () => {
},
],
})
+ .overrideGuard(JwtAuthGuard)
+ .useValue(mock_NoPermissionGuard)
+ .overrideGuard(WorkspaceAuthGuard)
+ .useValue(mock_NoPermissionGuard)
+ .overrideGuard(UserAuthGuard)
+ .useValue(mock_NoPermissionGuard)
+ .overrideGuard(CustomPermissionGuard)
+ .useValue(mock_NoPermissionGuard)
+ .overrideFilter(PermissionsRestApiExceptionFilter)
+ .useValue({})
.overrideGuard(FileByIdGuard)
.useValue(mock_FileByIdGuard)
.overrideGuard(PublicEndpointGuard)
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.ts
index ac07b4a0e7e..8dd17b0d1ef 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
@@ -3,17 +3,17 @@ import {
Get,
Logger,
Param,
+ Query,
Req,
Res,
UseFilters,
UseGuards,
} from '@nestjs/common';
+import { Request, Response } from 'express';
import { pipeline } from 'node:stream/promises';
import { join } from 'path';
import { type Readable } from 'stream';
-
-import { Request, Response } from 'express';
import { ApiPath, FileFolder, ServerFileFolder } from 'twenty-shared/types';
import { isDefined } from 'twenty-shared/utils';
@@ -27,16 +27,22 @@ import {
FileException,
FileExceptionCode,
} from 'src/engine/core-modules/file/file.exception';
-import { PUBLIC_ASSET_CACHE_CONTROL } from 'src/engine/core-modules/file/interfaces/file-folder.interface';
import { FileApiExceptionFilter } from 'src/engine/core-modules/file/filters/file-api-exception.filter';
import {
FileByIdGuard,
SupportedFileFolder,
} from 'src/engine/core-modules/file/guards/file-by-id.guard';
+import { PUBLIC_ASSET_CACHE_CONTROL } from 'src/engine/core-modules/file/interfaces/file-folder.interface';
import { FileService } from 'src/engine/core-modules/file/services/file.service';
import { setFileResponseHeaders } from 'src/engine/core-modules/file/utils/set-file-response-headers.utils';
+import { RecordExportWorkspaceService } from 'src/engine/core-modules/record-export/services/record-export.workspace-service';
+import { CustomPermissionGuard } from 'src/engine/guards/custom-permission.guard';
+import { JwtAuthGuard } from 'src/engine/guards/jwt-auth.guard';
import { NoPermissionGuard } from 'src/engine/guards/no-permission.guard';
import { PublicEndpointGuard } from 'src/engine/guards/public-endpoint.guard';
+import { UserAuthGuard } from 'src/engine/guards/user-auth.guard';
+import { WorkspaceAuthGuard } from 'src/engine/guards/workspace-auth.guard';
+import { PermissionsRestApiExceptionFilter } from 'src/engine/metadata-modules/permissions/utils/permissions-rest-api-exception.filter';
// workspaceId is bound onto the request by FileByIdGuard.
type FileByIdRequest = Request & { workspaceId: string };
@@ -47,6 +53,7 @@ export class FileController {
private readonly logger = new Logger(FileController.name);
constructor(
+ private readonly recordExportWorkspaceService: RecordExportWorkspaceService,
private readonly fileService: FileService,
private readonly serverFileStorageService: ServerFileStorageService,
) {}
@@ -191,6 +198,40 @@ export class FileController {
}
}
+ @Get(`${ApiPath.File}/${FileFolder.RecordExport}/:id`)
+ @UseGuards(
+ JwtAuthGuard,
+ WorkspaceAuthGuard,
+ UserAuthGuard,
+ CustomPermissionGuard,
+ )
+ @UseFilters(PermissionsRestApiExceptionFilter)
+ async downloadRecordExport(
+ @Param('id') id: string,
+ @Query('token') token: string,
+ @Req() request: Request,
+ @Res() response: Response,
+ ): Promise<void> {
+ const { stream, filename, cleanup } =
+ await this.recordExportWorkspaceService.openDownload({
+ id,
+ token,
+ request,
+ });
+ try {
+ setFileResponseHeaders(
+ response,
+ 'text/csv; charset=utf-8',
+ FileFolder.RecordExport,
+ );
+ response.attachment(filename);
+ await pipeline(stream, response);
+ } finally {
+ stream.destroy();
+ await cleanup();
+ }
+ }
+
@Get(`${ApiPath.File}/:fileFolder/:id`)
@UseGuards(FileByIdGuard, NoPermissionGuard)
async getFileById(
diff --git a/packages/twenty-server/src/engine/core-modules/file/file-api.module.ts b/packages/twenty-server/src/engine/core-modules/file/file-api.module.ts
new file mode 100644
index 00000000000..668e79a75a7
--- /dev/null
+++ b/packages/twenty-server/src/engine/core-modules/file/file-api.module.ts
@@ -0,0 +1,24 @@
+import { Module } from '@nestjs/common';
+
+import { CoreEntityCacheModule } from 'src/engine/core-entity-cache/core-entity-cache.module';
+import { TokenModule } from 'src/engine/core-modules/auth/token/token.module';
+import { FileController } from 'src/engine/core-modules/file/controllers/file.controller';
+import { FileModule } from 'src/engine/core-modules/file/file.module';
+import { FileByIdGuard } from 'src/engine/core-modules/file/guards/file-by-id.guard';
+import { JwtModule } from 'src/engine/core-modules/jwt/jwt.module';
+import { RecordExportModule } from 'src/engine/core-modules/record-export/record-export.module';
+import { WorkspaceCacheStorageModule } from 'src/engine/workspace-cache-storage/workspace-cache-storage.module';
+
+@Module({
+ imports: [
+ CoreEntityCacheModule,
+ FileModule,
+ RecordExportModule,
+ JwtModule,
+ TokenModule,
+ WorkspaceCacheStorageModule,
+ ],
+ controllers: [FileController],
+ providers: [FileByIdGuard],
+})
+export class FileApiModule {}
diff --git a/packages/twenty-server/src/engine/core-modules/file/file.module.ts b/packages/twenty-server/src/engine/core-modules/file/file.module.ts
index d35cb151021..6ecfb222725 100644
--- a/packages/twenty-server/src/engine/core-modules/file/file.module.ts
+++ b/packages/twenty-server/src/engine/core-modules/file/file.module.ts
@@ -5,26 +5,22 @@ import { ApplicationEntity } from 'src/engine/core-modules/application/applicati
import { FileStorageModule } from 'src/engine/core-modules/file-storage/file-storage.module';
import { FileDeletionJob } from 'src/engine/core-modules/file/jobs/file-deletion.job';
import { FileWorkspaceFolderDeletionJob } from 'src/engine/core-modules/file/jobs/file-workspace-folder-deletion.job';
-import { CoreEntityCacheModule } from 'src/engine/core-entity-cache/core-entity-cache.module';
import { JwtModule } from 'src/engine/core-modules/jwt/jwt.module';
import { SecureHttpClientModule } from 'src/engine/core-modules/secure-http-client/secure-http-client.module';
import { WorkspaceEntity } from 'src/engine/core-modules/workspace/workspace.entity';
import { PermissionsModule } from 'src/engine/metadata-modules/permissions/permissions.module';
import { provideWorkspaceScopedRepository } from 'src/engine/twenty-orm/workspace-scoped-repository/provide-workspace-scoped-repository';
-import { FileController } from './controllers/file.controller';
import { FileEntity } from './entities/file.entity';
import { FileCorePictureModule } from './file-core-picture/file-core-picture.module';
import { FileEmailAttachmentModule } from './file-email-attachment/file-email-attachment.module';
import { FileUploadModule } from './file-upload/file-upload.module';
import { FileUrlModule } from './file-url/file-url.module';
import { FilesFieldModule } from './files-field/files-field.module';
-import { FileByIdGuard } from './guards/file-by-id.guard';
import { FileService } from './services/file.service';
@Module({
imports: [
JwtModule,
- CoreEntityCacheModule,
TypeOrmModule.forFeature([FileEntity, WorkspaceEntity, ApplicationEntity]),
PermissionsModule,
FileStorageModule,
@@ -37,7 +33,6 @@ import { FileService } from './services/file.service';
],
providers: [
FileService,
- FileByIdGuard,
FileWorkspaceFolderDeletionJob,
FileDeletionJob,
provideWorkspaceScopedRepository(FileEntity),
@@ -50,6 +45,5 @@ import { FileService } from './services/file.service';
FileEmailAttachmentModule,
FileUploadModule,
],
- controllers: [FileController],
})
export class FileModule {}
diff --git a/packages/twenty-server/src/engine/core-modules/message-queue/drivers/__tests__/bullmq.driver.spec.ts b/packages/twenty-server/src/engine/core-modules/message-queue/drivers/__tests__/bullmq.driver.spec.ts
index 18b686db0df..8e30ebe4117 100644
--- a/packages/twenty-server/src/engine/core-modules/message-queue/drivers/__tests__/bullmq.driver.spec.ts
+++ b/packages/twenty-server/src/engine/core-modules/message-queue/drivers/__tests__/bullmq.driver.spec.ts
@@ -5,7 +5,6 @@ import { MessageQueue } from 'src/engine/core-modules/message-queue/message-queu
const mockGetJobs = jest.fn();
const mockGetJob = jest.fn();
-const mockGetJobState = jest.fn();
const mockAdd = jest.fn();
const mockAddBulk = jest.fn();
@@ -13,7 +12,6 @@ jest.mock('bullmq', () => ({
Queue: jest.fn().mockImplementation(() => ({
getJobs: mockGetJobs,
getJob: mockGetJob,
- getJobState: mockGetJobState,
add: mockAdd,
addBulk: mockAddBulk,
})),
@@ -48,26 +46,6 @@ describe('BullMQDriver deduplication', () => {
);
});
- it('includes the result when a job finishes during a snapshot read', async () => {
- const job = {
- id: 'export',
- data: {},
- returnvalue: null as { fileId: string } | null,
- opts: {},
- getState: mockGetJobState,
- };
- mockGetJob.mockImplementation(async () => ({ ...job }));
- mockGetJobState.mockImplementation(async () => {
- job.returnvalue = { fileId: 'completed-file' };
- return 'completed';
- });
- const jobs = await driver.getJobs(MessageQueue.workspaceQueue, ['export']);
- expect(jobs.export).toMatchObject({
- state: 'completed',
- result: { fileId: 'completed-file' },
- });
- });
-
describe('add', () => {
it('skips a job whose id prefix is already waiting', async () => {
const jobId = await driver.add(
@@ -192,7 +170,6 @@ describe('BullMQDriver progress', () => {
};
const updateProgress = jest.spyOn(job, 'updateProgress');
mockGetJob.mockResolvedValue(job);
- mockGetJobState.mockResolvedValue('active');
driver.work(MessageQueue.workspaceQueue, async (queueJob) => {
await queueJob.updateProgress(progress);
});
diff --git a/packages/twenty-server/src/engine/core-modules/message-queue/drivers/__tests__/sync.driver.spec.ts b/packages/twenty-server/src/engine/core-modules/message-queue/drivers/__tests__/sync.driver.spec.ts
index 0381c2d6a1d..6eb227c4cbd 100644
--- a/packages/twenty-server/src/engine/core-modules/message-queue/drivers/__tests__/sync.driver.spec.ts
+++ b/packages/twenty-server/src/engine/core-modules/message-queue/drivers/__tests__/sync.driver.spec.ts
@@ -119,52 +119,3 @@ describe('SyncDriver job snapshots', () => {
expect(jobs[newId]?.state).toBe('completed');
});
});
-
-describe('SyncDriver job results', () => {
- it('retains progress and the handler result when work completes', async () => {
- const driver = new SyncDriver();
- driver.work(MessageQueue.recordExportQueue, async (job) => {
- await job.updateData({ cursor: 'next-page' });
- await job.updateProgress({ processedRecordCount: 100 });
- const active = await driver.getJobs(MessageQueue.recordExportQueue, [
- job.id,
- ]);
- expect(active[job.id]).toMatchObject({
- state: 'active',
- data: { cursor: 'next-page' },
- progress: { processedRecordCount: 100 },
- });
- return { fileId: 'file-id' };
- });
- const id = (await driver.add(
- MessageQueue.recordExportQueue,
- 'Export',
- {},
- ))!;
- const jobs = await driver.getJobs(MessageQueue.recordExportQueue, [id]);
- expect(jobs[id]).toMatchObject({
- state: 'completed',
- result: { fileId: 'file-id' },
- progress: { processedRecordCount: 100 },
- });
- expect(await driver.getJobs(MessageQueue.workspaceQueue, [id])).toEqual({});
- });
-
- it('keeps failures observable while preserving synchronous error propagation', async () => {
- const driver = new SyncDriver();
- let id = '';
- driver.work(MessageQueue.recordExportQueue, async (job) => {
- id = job.id;
- throw new Error('Storage failed');
- });
- await expect(
- driver.add(MessageQueue.recordExportQueue, 'Export', {}),
- ).rejects.toThrow('Storage failed');
- const jobs = await driver.getJobs(MessageQueue.recordExportQueue, [id]);
- expect(jobs[id]).toMatchObject({
- state: 'failed',
- failedReason: 'Storage failed',
- });
- expect(jobs[id]?.result).toBeUndefined();
- });
-});
diff --git a/packages/twenty-server/src/engine/core-modules/message-queue/drivers/bullmq.driver.ts b/packages/twenty-server/src/engine/core-modules/message-queue/drivers/bullmq.driver.ts
index 815bf633eea..d470466edcf 100644
--- a/packages/twenty-server/src/engine/core-modules/message-queue/drivers/bullmq.driver.ts
+++ b/packages/twenty-server/src/engine/core-modules/message-queue/drivers/bullmq.driver.ts
@@ -183,7 +183,7 @@ export class BullMQDriver
work<T>(
queueName: MessageQueue,
- handler: (job: MessageQueueJob<T>) => Promise<unknown> | unknown,
+ handler: (job: MessageQueueJob<T>) => Promise<void>,
options?: MessageQueueWorkerOptions,
) {
const workerOptions = {
@@ -230,7 +230,7 @@ export class BullMQDriver
this.logger.log(
`Processing job ${job.id} with name ${job.name} on queue ${queueName}${workspaceSuffix}`,
);
- const result = await handler({
+ await handler({
data: job.data,
id: job.id ?? '',
name: job.name,
@@ -245,7 +245,6 @@ export class BullMQDriver
this.logger.log(
`Job ${job.id} with name ${job.name} processed on queue ${queueName} in ${executionTime.toFixed(2)}ms${workspaceSuffix}`,
);
- return result;
}),
workerOptions,
);
@@ -536,15 +535,16 @@ export class BullMQDriver
queueName: MessageQueue,
jobId: string,
): Promise<QueueJobDetails<T> | undefined> {
- const queue = this.queueMap[queueName];
- const state = await queue.getJobState(jobId);
+ const job = await this.queueMap[queueName].getJob(jobId);
- // Read completion data after the state so a finished job includes its result.
- if (state === 'unknown') {
+ if (!isDefined(job)) {
return undefined;
}
- const job = await queue.getJob(jobId);
- if (!isDefined(job)) {
+
+ const state = await job.getState();
+
+ // BullMQ reports 'unknown' for a job whose record was evicted by retention
+ if (state === 'unknown') {
return undefined;
}
@@ -569,7 +569,6 @@ export class BullMQDriver
attemptsMade: job.attemptsMade,
failedReason: job.failedReason,
progress: job.progress,
- result: job.returnvalue,
timestamp: job.timestamp,
processedOn: job.processedOn,
finishedOn: job.finishedOn,
diff --git a/packages/twenty-server/src/engine/core-modules/message-queue/drivers/interfaces/message-queue-driver.interface.ts b/packages/twenty-server/src/engine/core-modules/message-queue/drivers/interfaces/message-queue-driver.interface.ts
index c56ee9c2d69..0a3d0474bb3 100644
--- a/packages/twenty-server/src/engine/core-modules/message-queue/drivers/interfaces/message-queue-driver.interface.ts
+++ b/packages/twenty-server/src/engine/core-modules/message-queue/drivers/interfaces/message-queue-driver.interface.ts
@@ -28,7 +28,7 @@ export interface MessageQueueDriver {
): Promise<string[]>;
work<T extends MessageQueueJobData>(
queueName: MessageQueue,
- handler: (job: MessageQueueJob<T>) => Promise<unknown> | unknown,
+ handler: (job: MessageQueueJob<T>) => Promise<void> | void,
options?: MessageQueueWorkerOptions,
): void;
addCron<T extends MessageQueueJobData | undefined>({
@@ -75,7 +75,6 @@ export type QueueJobDetails<T extends MessageQueueJobData> = {
attemptsMade: number;
failedReason?: string;
progress?: unknown;
- result?: unknown;
timestamp: number;
processedOn?: number;
finishedOn?: number;
diff --git a/packages/twenty-server/src/engine/core-modules/message-queue/drivers/sync.driver.ts b/packages/twenty-server/src/engine/core-modules/message-queue/drivers/sync.driver.ts
index 6a51b04b39c..b997293e601 100644
--- a/packages/twenty-server/src/engine/core-modules/message-queue/drivers/sync.driver.ts
+++ b/packages/twenty-server/src/engine/core-modules/message-queue/drivers/sync.driver.ts
@@ -20,7 +20,7 @@ import { type MessageQueue } from 'src/engine/core-modules/message-queue/message
export class SyncDriver implements MessageQueueDriver {
private readonly logger = new Logger(SyncDriver.name);
private workersMap: {
- [queueName: string]: (job: MessageQueueJob) => Promise<unknown> | unknown;
+ [queueName: string]: (job: MessageQueueJob) => Promise<void> | void;
} = {};
private readonly jobs = new Map<
@@ -100,7 +100,7 @@ export class SyncDriver implements MessageQueueDriver {
work<T extends MessageQueueJobData>(
queueName: MessageQueue,
- handler: (job: MessageQueueJob<T>) => Promise<unknown> | unknown,
+ handler: (job: MessageQueueJob<T>) => Promise<void> | void,
): void {
this.logger.log(`Registering handler for queue: ${queueName}`);
this.workersMap[queueName] = handler;
@@ -131,7 +131,7 @@ export class SyncDriver implements MessageQueueDriver {
details.progress = progress;
};
try {
- details.result = await worker(job);
+ await worker(job);
details.state = 'completed';
} catch (error) {
details.state = 'failed';
diff --git a/packages/twenty-server/src/engine/core-modules/message-queue/message-queue-worker-config.constant.ts b/packages/twenty-server/src/engine/core-modules/message-queue/message-queue-worker-config.constant.ts
index 330535091e4..df92072f4d4 100644
--- a/packages/twenty-server/src/engine/core-modules/message-queue/message-queue-worker-config.constant.ts
+++ b/packages/twenty-server/src/engine/core-modules/message-queue/message-queue-worker-config.constant.ts
@@ -27,7 +27,7 @@ export const MESSAGE_QUEUE_WORKER_CONFIG: Record<
workerOptions: {
concurrency: 1,
lockDuration: 60_000,
- maxStalledCount: 1,
+ maxStalledCount: 0,
boundedShutdownDrain: false,
},
},
diff --git a/packages/twenty-server/src/engine/core-modules/message-queue/message-queue.explorer.ts b/packages/twenty-server/src/engine/core-modules/message-queue/message-queue.explorer.ts
index a8f60070a05..67703de1f50 100644
--- a/packages/twenty-server/src/engine/core-modules/message-queue/message-queue.explorer.ts
+++ b/packages/twenty-server/src/engine/core-modules/message-queue/message-queue.explorer.ts
@@ -196,17 +196,9 @@ export class MessageQueueExplorer implements OnModuleInit {
});
try {
- let result: unknown;
for (const processorGroup of processorGroupCollection) {
- const processorResult = await this.handleProcessor(
- processorGroup,
- job,
- );
- if (processorResult !== undefined) {
- result = processorResult;
- }
+ await this.handleProcessor(processorGroup, job);
}
- return result;
} finally {
this.eventLoopStallMonitorService.registerJobEnd(stallMonitorToken);
}
@@ -253,13 +245,13 @@ export class MessageQueueExplorer implements OnModuleInit {
contextId,
);
- return this.invokeProcessMethods(
+ await this.invokeProcessMethods(
contextInstance,
filteredProcessMethodNames,
job,
);
} else {
- return this.invokeProcessMethods(
+ await this.invokeProcessMethods(
instance,
filteredProcessMethodNames,
job,
@@ -272,23 +264,15 @@ export class MessageQueueExplorer implements OnModuleInit {
processMethodNames: string[],
job: MessageQueueJob<MessageQueueJobData>,
) {
- let result: unknown;
for (const processMethodName of processMethodNames) {
try {
// @ts-expect-error legacy noImplicitAny
- const methodResult = await instance[processMethodName].call(
- instance,
- job.data,
- {
- abortSignal: job.abortSignal,
- retryLimit: job.retryLimit,
- updateData: job.updateData,
- updateProgress: job.updateProgress,
- },
- );
- if (methodResult !== undefined) {
- result = methodResult;
- }
+ await instance[processMethodName].call(instance, job.data, {
+ abortSignal: job.abortSignal,
+ retryLimit: job.retryLimit,
+ updateData: job.updateData,
+ updateProgress: job.updateProgress,
+ });
} catch (err) {
if (shouldCaptureException(err)) {
this.exceptionHandlerService.captureExceptions([err]);
@@ -296,6 +280,5 @@ export class MessageQueueExplorer implements OnModuleInit {
throw err;
}
}
- return result;
}
}
diff --git a/packages/twenty-server/src/engine/core-modules/message-queue/services/message-queue.service.ts b/packages/twenty-server/src/engine/core-modules/message-queue/services/message-queue.service.ts
index 3ebbea0ed3e..b77d092dceb 100644
--- a/packages/twenty-server/src/engine/core-modules/message-queue/services/message-queue.service.ts
+++ b/packages/twenty-server/src/engine/core-modules/message-queue/services/message-queue.service.ts
@@ -103,7 +103,7 @@ export class MessageQueueService {
}
work<T extends MessageQueueJobData>(
- handler: (job: MessageQueueJob<T>) => Promise<unknown> | unknown,
+ handler: (job: MessageQueueJob<T>) => Promise<void> | void,
options?: MessageQueueWorkerOptions,
): void {
this.driver.work(this.queueName, handler, options);
diff --git a/packages/twenty-server/src/engine/core-modules/record-export/constants/create-record-export-download-script.constant.ts b/packages/twenty-server/src/engine/core-modules/record-export/constants/create-record-export-download-script.constant.ts
deleted file mode 100644
index 5fdc131ad01..00000000000
--- a/packages/twenty-server/src/engine/core-modules/record-export/constants/create-record-export-download-script.constant.ts
+++ /dev/null
@@ -1,10 +0,0 @@
-import { type CacheScript } from 'src/engine/core-modules/cache-storage/types/cache-script.type';
-
-export const CREATE_RECORD_EXPORT_DOWNLOAD_SCRIPT: CacheScript = {
- name: 'record-export:create-download',
- source: `
-if redis.call('GET', KEYS[1]) ~= ARGV[1] then return 0 end
-redis.call('SET', KEYS[2], ARGV[2], 'PX', ARGV[3])
-return 1
-`,
-};
diff --git a/packages/twenty-server/src/engine/core-modules/record-export/constants/record-export.constants.ts b/packages/twenty-server/src/engine/core-modules/record-export/constants/record-export.constants.ts
index 741fccc497f..e772e93f844 100644
--- a/packages/twenty-server/src/engine/core-modules/record-export/constants/record-export.constants.ts
+++ b/packages/twenty-server/src/engine/core-modules/record-export/constants/record-export.constants.ts
@@ -2,6 +2,6 @@ export const RECORD_EXPORT_PAGE_SIZE = 1000;
export const RECORD_EXPORT_MAX_DURATION_MS = 60 * 60 * 1000;
export const RECORD_EXPORT_MAX_FILE_BYTES = 1024 * 1024 * 1024;
export const RECORD_EXPORT_CONNECTION_TTL_MS = 30_000;
-export const RECORD_EXPORT_DOWNLOAD_TTL_MS = 5 * 60 * 1000;
+export const RECORD_EXPORT_DOWNLOAD_TOKEN_TTL_SECONDS = 60;
export const RECORD_EXPORT_PROGRESS_INTERVAL_MS = 1000;
export const RECORD_EXPORT_REQUESTER_REFRESH_INTERVAL_MS = 5_000;
diff --git a/packages/twenty-server/src/engine/core-modules/record-export/dtos/record-export.dto.ts b/packages/twenty-server/src/engine/core-modules/record-export/dtos/record-export.dto.ts
index c5fa068c6c9..33004242214 100644
--- a/packages/twenty-server/src/engine/core-modules/record-export/dtos/record-export.dto.ts
+++ b/packages/twenty-server/src/engine/core-modules/record-export/dtos/record-export.dto.ts
@@ -1,7 +1,6 @@
import { Field, Int, ObjectType } from '@nestjs/graphql';
import { UUIDScalarType } from 'src/engine/api/graphql/workspace-schema-builder/graphql-types/scalars';
-import { RecordExportStatus } from 'src/engine/core-modules/record-export/enums/record-export-status.enum';
@ObjectType('RecordExport')
export class RecordExportDTO {
@@ -11,14 +10,8 @@ export class RecordExportDTO {
@Field(() => String)
filename: string;
- @Field(() => RecordExportStatus)
- status: RecordExportStatus;
-
@Field(() => Int)
- processedRecordCount: number;
-
- @Field(() => Int, { nullable: true })
- totalRecordCount: number | null;
+ progress: number;
@Field(() => String, { nullable: true })
errorMessage: string | null;
diff --git a/packages/twenty-server/src/engine/core-modules/record-export/enums/record-export-status.enum.ts b/packages/twenty-server/src/engine/core-modules/record-export/enums/record-export-status.enum.ts
deleted file mode 100644
index efea878fac6..00000000000
--- a/packages/twenty-server/src/engine/core-modules/record-export/enums/record-export-status.enum.ts
+++ /dev/null
@@ -1,10 +0,0 @@
-import { registerEnumType } from '@nestjs/graphql';
-
-export enum RecordExportStatus {
- QUEUED = 'QUEUED',
- PROCESSING = 'PROCESSING',
- COMPLETED = 'COMPLETED',
- FAILED = 'FAILED',
-}
-
-registerEnumType(RecordExportStatus, { name: 'RecordExportStatus' });
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.ts
index 0a46877864f..5b01b714afe 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
@@ -1,49 +1,48 @@
-import { RecordExportException } from 'src/engine/core-modules/record-export/record-export.exception';
import { Logger } from '@nestjs/common';
import { msg } from '@lingui/core/macro';
-import { type APP_LOCALES, SOURCE_LOCALE } from 'twenty-shared/translations';
-import { I18nService } from 'src/engine/core-modules/i18n/i18n.service';
import { Readable } from 'stream';
+import { type APP_LOCALES, SOURCE_LOCALE } from 'twenty-shared/translations';
import {
formatValueForCSV,
isDefined,
sanitizeValueForCSVExport,
} from 'twenty-shared/utils';
-import { v4 } from 'uuid';
import { FileStorageService } from 'src/engine/core-modules/file-storage/services/file-storage.service';
import { FileEntity } from 'src/engine/core-modules/file/entities/file.entity';
import { FILE_STATUS } from 'src/engine/core-modules/file/types/file-status.types';
-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';
+import { I18nService } from 'src/engine/core-modules/i18n/i18n.service';
import { Process } from 'src/engine/core-modules/message-queue/decorators/process.decorator';
import { Processor } from 'src/engine/core-modules/message-queue/decorators/processor.decorator';
+import { type MessageQueueJobProgressContext } from 'src/engine/core-modules/message-queue/interfaces/message-queue-job.interface';
import { MessageQueue } from 'src/engine/core-modules/message-queue/message-queue.constants';
import {
RECORD_EXPORT_MAX_DURATION_MS,
RECORD_EXPORT_MAX_FILE_BYTES,
- RECORD_EXPORT_PROGRESS_INTERVAL_MS,
RECORD_EXPORT_REQUESTER_REFRESH_INTERVAL_MS,
} from 'src/engine/core-modules/record-export/constants/record-export.constants';
-import { type MessageQueueJobProgressContext } from 'src/engine/core-modules/message-queue/interfaces/message-queue-job.interface';
+import { RecordExportException } from 'src/engine/core-modules/record-export/record-export.exception';
+import {
+ RecordExportWorkspaceService,
+ type RecordExportQueryContext,
+} from 'src/engine/core-modules/record-export/services/record-export.workspace-service';
import {
type RecordExport,
- type RecordExportResult,
+ type RecordExportProgress,
} from 'src/engine/core-modules/record-export/types/record-export.type';
-import { RecordExportQueryWorkspaceService } from 'src/engine/core-modules/record-export/services/record-export-query.workspace-service';
-import { RecordExportCacheService } from 'src/engine/core-modules/record-export/services/record-export-cache.service';
-import { RecordExportWorkspaceService } from 'src/engine/core-modules/record-export/services/record-export.workspace-service';
import { formatRecordExportRow } from 'src/engine/core-modules/record-export/utils/format-record-export-row.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';
+
+type RecordExportFileProgress = RecordExportProgress & { size: number };
@Processor(MessageQueue.recordExportQueue)
export class GenerateRecordExportJob {
private readonly logger = new Logger(GenerateRecordExportJob.name);
constructor(
- private readonly recordExportCacheService: RecordExportCacheService,
private readonly recordExportWorkspaceService: RecordExportWorkspaceService,
- private readonly recordExportQueryWorkspaceService: RecordExportQueryWorkspaceService,
private readonly fileStorageService: FileStorageService,
@InjectWorkspaceScopedRepository(FileEntity)
private readonly fileRepository: WorkspaceScopedRepository<FileEntity>,
@@ -54,179 +53,62 @@ export class GenerateRecordExportJob {
async handle(
recordExport: RecordExport,
{ updateProgress, abortSignal }: MessageQueueJobProgressContext,
- ): Promise<RecordExportResult> {
- const { workspaceId } = recordExport;
- const fileId = v4();
- const filePath = `${recordExport.id}/${fileId}.csv`;
- let processedRecordCount = 0;
- let totalRecordCount: number | null = null;
- let stream: Readable | undefined;
+ ): Promise<void> {
+ const progress: RecordExportFileProgress = {
+ processedRecordCount: 0,
+ totalRecordCount: null,
+ size: 0,
+ };
let locale: keyof typeof APP_LOCALES = SOURCE_LOCALE;
try {
- const remainingTime =
- RECORD_EXPORT_MAX_DURATION_MS - (Date.now() - recordExport.createdAt);
- if (remainingTime <= 0) {
- throw new RecordExportException(
- 'Export duration limit exceeded',
- 'DURATION_LIMIT_EXCEEDED',
- {
- userFriendlyMessage: msg`The export took too long. Please try exporting fewer records.`,
- },
- );
- }
-
- const signal = AbortSignal.any([
- AbortSignal.timeout(remainingTime),
- ...(isDefined(abortSignal) ? [abortSignal] : []),
- ]);
- const assertConnected = async () => {
- signal.throwIfAborted();
- if (!(await this.recordExportCacheService.isConnected(recordExport))) {
- throw new RecordExportException(
- 'Export connection closed',
- 'CONNECTION_CLOSED',
- );
- }
- };
- await assertConnected();
+ await this.recordExportWorkspaceService.assertPermissionsUnchanged(
+ recordExport,
+ );
+ const signal = this.createAbortSignal(recordExport, abortSignal);
+ await this.recordExportWorkspaceService.assertConnected(
+ recordExport,
+ signal,
+ );
const requester =
- await this.recordExportQueryWorkspaceService.resolveRequester(
- recordExport,
- );
+ await this.recordExportWorkspaceService.resolveRequester(recordExport);
locale = requester.workspaceMember.locale;
- const context = await this.recordExportQueryWorkspaceService.buildContext(
- { parameters: recordExport.parameters, authContext: requester },
- );
- const recordExportQueryWorkspaceService =
- this.recordExportQueryWorkspaceService;
- let lastProgressAt = 0;
- let lastRequesterRefreshAt = Date.now();
- let bytes = 0;
-
- const reportProgress = async () => {
- await assertConnected();
- await updateProgress({ processedRecordCount, totalRecordCount });
- lastProgressAt = Date.now();
- };
-
- totalRecordCount = await recordExportQueryWorkspaceService.countRecords({
+ const context = await this.recordExportWorkspaceService.buildContext({
parameters: recordExport.parameters,
- context,
- });
- await reportProgress();
-
- async function* generateCsv() {
- const header =
- '\uFEFF' +
- context.columns
- .map((column) =>
- formatValueForCSV(sanitizeValueForCSVExport(column.label)),
- )
- .join(',') +
- '\n';
- bytes += Buffer.byteLength(header);
- yield header;
- let after: string | undefined;
-
- do {
- await reportProgress();
- if (
- Date.now() - lastRequesterRefreshAt >=
- RECORD_EXPORT_REQUESTER_REFRESH_INTERVAL_MS
- ) {
- context.queryRunnerContext.authContext =
- await recordExportQueryWorkspaceService.resolveRequester(
- recordExport,
- );
- lastRequesterRefreshAt = Date.now();
- } else {
- await recordExportQueryWorkspaceService.assertCanExport(
- context.queryRunnerContext.authContext,
- );
- }
- const { results } = await recordExportQueryWorkspaceService.readPage({
- parameters: recordExport.parameters,
- context,
- after,
- });
-
- await assertConnected();
- for (const record of results.records) {
- const row = formatRecordExportRow({
- columns: context.columns,
- record,
- });
- bytes += Buffer.byteLength(row);
- if (bytes > RECORD_EXPORT_MAX_FILE_BYTES) {
- throw new RecordExportException(
- 'Export file size limit exceeded',
- 'FILE_SIZE_LIMIT_EXCEEDED',
- {
- userFriendlyMessage: msg`The export file is too large. Please export fewer records.`,
- },
- );
- }
- yield row;
- processedRecordCount++;
- }
-
- if (
- Date.now() - lastProgressAt >=
- RECORD_EXPORT_PROGRESS_INTERVAL_MS
- ) {
- await reportProgress();
- }
- if (!results.pageInfo.hasNextPage) {
- break;
- }
-
- const endCursor = results.pageInfo.endCursor;
- if (!isDefined(endCursor) || endCursor === after) {
- throw new RecordExportException(
- 'Export pagination did not advance',
- 'PAGINATION_FAILED',
- );
- }
- after = endCursor;
- } while (true);
- }
-
- const resource = this.recordExportWorkspaceService.getFileResource({
- workspaceId,
- resourcePath: filePath,
- });
- const file = await this.fileStorageService.createPendingFile({
- ...resource,
- fileId,
- size: 0,
- mimeType: 'application/octet-stream',
- settings: { isTemporaryFile: true, toDelete: false },
- });
-
- stream = Readable.from(generateCsv(), { signal });
- await this.fileStorageService.writeFileStream({
- ...resource,
- stream,
- mimeType: 'text/csv',
+ authContext: requester,
});
-
- await this.fileRepository.update(
- workspaceId,
- { id: file.id },
- { status: FILE_STATUS.UPLOADED, size: bytes, mimeType: 'text/csv' },
+ progress.totalRecordCount =
+ await this.recordExportWorkspaceService.countRecords({
+ parameters: recordExport.parameters,
+ context,
+ });
+ await this.writeFile(
+ recordExport,
+ this.generateCsv({
+ recordExport,
+ context,
+ progress,
+ signal,
+ updateProgress,
+ }),
+ progress,
+ signal,
);
-
- await assertConnected();
- return { fileId, processedRecordCount, totalRecordCount };
+ await this.recordExportWorkspaceService.assertPermissionsUnchanged(
+ recordExport,
+ );
+ await this.recordExportWorkspaceService.assertConnected(
+ recordExport,
+ signal,
+ );
+ await updateProgress({
+ processedRecordCount: progress.processedRecordCount,
+ totalRecordCount: progress.totalRecordCount,
+ });
} catch (error) {
- stream?.destroy();
await this.fileStorageService
.deleteFile(
- this.recordExportWorkspaceService.getFileResource({
- workspaceId,
- resourcePath: filePath,
- }),
+ this.recordExportWorkspaceService.getFileResource(recordExport),
)
.catch(() =>
this.logger.warn(
@@ -234,8 +116,8 @@ export class GenerateRecordExportJob {
),
);
await updateProgress({
- processedRecordCount,
- totalRecordCount,
+ processedRecordCount: progress.processedRecordCount,
+ totalRecordCount: progress.totalRecordCount,
errorMessage: this.i18nService
.getI18nInstance(locale)
._(
@@ -247,4 +129,154 @@ export class GenerateRecordExportJob {
throw error;
}
}
+
+ private createAbortSignal(
+ recordExport: RecordExport,
+ abortSignal?: AbortSignal,
+ ): AbortSignal {
+ const remainingTime =
+ RECORD_EXPORT_MAX_DURATION_MS - (Date.now() - recordExport.createdAt);
+ if (remainingTime <= 0) {
+ throw new RecordExportException(
+ 'Export duration limit exceeded',
+ 'DURATION_LIMIT_EXCEEDED',
+ {
+ userFriendlyMessage: msg`The export took too long. Please try exporting fewer records.`,
+ },
+ );
+ }
+ return AbortSignal.any([
+ AbortSignal.timeout(remainingTime),
+ ...(isDefined(abortSignal) ? [abortSignal] : []),
+ ]);
+ }
+
+ private async writeFile(
+ recordExport: RecordExport,
+ csv: AsyncIterable<string>,
+ progress: RecordExportFileProgress,
+ signal: AbortSignal,
+ ): Promise<void> {
+ const resource =
+ this.recordExportWorkspaceService.getFileResource(recordExport);
+ const file = await this.fileStorageService.createPendingFile({
+ ...resource,
+ fileId: recordExport.id,
+ size: 0,
+ mimeType: 'application/octet-stream',
+ settings: { isTemporaryFile: true, toDelete: false },
+ });
+ const stream = Readable.from(csv, { signal });
+ try {
+ await this.fileStorageService.writeFileStream({
+ ...resource,
+ stream,
+ mimeType: 'text/csv',
+ });
+ await this.fileRepository.update(
+ recordExport.workspaceId,
+ { id: file.id },
+ {
+ status: FILE_STATUS.UPLOADED,
+ size: progress.size,
+ mimeType: 'text/csv',
+ },
+ );
+ } finally {
+ stream.destroy();
+ }
+ }
+
+ private async *generateCsv({
+ recordExport,
+ context,
+ progress,
+ signal,
+ updateProgress,
+ }: {
+ recordExport: RecordExport;
+ context: RecordExportQueryContext;
+ progress: RecordExportFileProgress;
+ signal: AbortSignal;
+ updateProgress: MessageQueueJobProgressContext['updateProgress'];
+ }): AsyncGenerator<string> {
+ const header =
+ '\uFEFF' +
+ context.columns
+ .map((column) =>
+ formatValueForCSV(sanitizeValueForCSVExport(column.label)),
+ )
+ .join(',') +
+ '\n';
+ progress.size += Buffer.byteLength(header);
+ yield header;
+ let after: string | undefined;
+ let lastRequesterRefreshAt = Date.now();
+
+ do {
+ await this.recordExportWorkspaceService.assertConnected(
+ recordExport,
+ signal,
+ );
+ await updateProgress({
+ processedRecordCount: progress.processedRecordCount,
+ totalRecordCount: progress.totalRecordCount,
+ });
+ await this.recordExportWorkspaceService.assertPermissionsUnchanged(
+ recordExport,
+ );
+ if (
+ Date.now() - lastRequesterRefreshAt >=
+ RECORD_EXPORT_REQUESTER_REFRESH_INTERVAL_MS
+ ) {
+ context.queryRunnerContext.authContext =
+ await this.recordExportWorkspaceService.resolveRequester(
+ recordExport,
+ );
+ lastRequesterRefreshAt = Date.now();
+ } else {
+ await this.recordExportWorkspaceService.assertCanExport(
+ context.queryRunnerContext.authContext,
+ );
+ }
+ const { results } = await this.recordExportWorkspaceService.readPage({
+ parameters: recordExport.parameters,
+ context,
+ after,
+ });
+ await this.recordExportWorkspaceService.assertPermissionsUnchanged(
+ recordExport,
+ );
+ await this.recordExportWorkspaceService.assertConnected(
+ recordExport,
+ signal,
+ );
+ for (const record of results.records) {
+ const row = formatRecordExportRow({ columns: context.columns, record });
+ progress.size += Buffer.byteLength(row);
+ if (progress.size > RECORD_EXPORT_MAX_FILE_BYTES) {
+ throw new RecordExportException(
+ 'Export file size limit exceeded',
+ 'FILE_SIZE_LIMIT_EXCEEDED',
+ {
+ userFriendlyMessage: msg`The export file is too large. Please export fewer records.`,
+ },
+ );
+ }
+ yield row;
+ progress.processedRecordCount++;
+ }
+ if (!results.pageInfo.hasNextPage) {
+ break;
+ }
+ const endCursor = results.pageInfo.endCursor;
+ if (!isDefined(endCursor) || endCursor === after) {
+ throw new RecordExportException(
+ 'Export pagination did not advance',
+ 'PAGINATION_FAILED',
+ );
+ }
+ after = endCursor;
+ } while (true);
+ }
}
diff --git a/packages/twenty-server/src/engine/core-modules/record-export/record-export.controller.ts b/packages/twenty-server/src/engine/core-modules/record-export/record-export.controller.ts
deleted file mode 100644
index 6330d29fa27..00000000000
--- a/packages/twenty-server/src/engine/core-modules/record-export/record-export.controller.ts
+++ /dev/null
@@ -1,108 +0,0 @@
-import { RecordExportCacheService } from 'src/engine/core-modules/record-export/services/record-export-cache.service';
-import {
- Controller,
- ConflictException,
- ForbiddenException,
- Get,
- Param,
- Query,
- Res,
- UseGuards,
- UseFilters,
-} from '@nestjs/common';
-
-import { t } from '@lingui/core/macro';
-import { pipeline } from 'node:stream/promises';
-import { Response } from 'express';
-import { isDefined } from 'twenty-shared/utils';
-
-import { type FileTokenJwtPayload } from 'src/engine/core-modules/auth/types/file-token-jwt-payload.type';
-import { JwtTokenTypeEnum } from 'src/engine/core-modules/auth/types/jwt-token-type.enum';
-import { FileStorageService } from 'src/engine/core-modules/file-storage/services/file-storage.service';
-import { JwtWrapperService } from 'src/engine/core-modules/jwt/services/jwt-wrapper.service';
-import { RecordExportQueryWorkspaceService } from 'src/engine/core-modules/record-export/services/record-export-query.workspace-service';
-import { RecordExportWorkspaceService } from 'src/engine/core-modules/record-export/services/record-export.workspace-service';
-import { NoPermissionGuard } from 'src/engine/guards/no-permission.guard';
-import { PublicEndpointGuard } from 'src/engine/guards/public-endpoint.guard';
-import { PermissionsRestApiExceptionFilter } from 'src/engine/metadata-modules/permissions/utils/permissions-rest-api-exception.filter';
-
-@Controller('record-exports')
-@UseGuards(PublicEndpointGuard, NoPermissionGuard)
-@UseFilters(PermissionsRestApiExceptionFilter)
-export class RecordExportController {
- constructor(
- private readonly recordExportCacheService: RecordExportCacheService,
- private readonly recordExportWorkspaceService: RecordExportWorkspaceService,
- private readonly recordExportQueryWorkspaceService: RecordExportQueryWorkspaceService,
- private readonly fileStorageService: FileStorageService,
- private readonly jwtWrapperService: JwtWrapperService,
- ) {}
-
- @Get(':id/download')
- async download(
- @Param('id') id: string,
- @Query('token') token: string,
- @Res() response: Response,
- ): Promise<void> {
- let payload: FileTokenJwtPayload;
- try {
- payload = await this.jwtWrapperService.verifyJwtToken(token);
- if (
- payload.type !== JwtTokenTypeEnum.FILE ||
- payload.fileId !== id ||
- !isDefined(payload.workspaceId)
- ) {
- throw new ForbiddenException(
- t`Invalid or expired export download link.`,
- );
- }
- } catch {
- throw new ForbiddenException(t`Invalid or expired export download link.`);
- }
-
- const recordExport = await this.recordExportWorkspaceService.findOrThrow({
- workspaceId: payload.workspaceId,
- id,
- });
- this.recordExportWorkspaceService.assertDownloadable(recordExport);
- const requester =
- await this.recordExportQueryWorkspaceService.resolveRequester(
- recordExport,
- );
- const context = await this.recordExportQueryWorkspaceService.buildContext({
- parameters: recordExport.parameters,
- authContext: requester,
- });
- await this.recordExportQueryWorkspaceService.readPage({
- parameters: recordExport.parameters,
- context,
- first: 0,
- });
-
- const claimed =
- await this.recordExportCacheService.claimDownload(recordExport);
- if (!claimed) {
- throw new ConflictException(
- t`This export download has already started or expired.`,
- );
- }
-
- const resource = this.recordExportWorkspaceService.getFileResource({
- workspaceId: recordExport.workspaceId,
- resourcePath: `${recordExport.id}/${recordExport.fileId}.csv`,
- });
- response.setHeader('Cache-Control', 'private, no-store');
- const contentDisposition = `attachment; filename="${recordExport.filename.replace(/["\r\n\\]/g, '_')}"`;
- try {
- const stream = await this.fileStorageService.readFile(resource);
- response.setHeader('Content-Type', 'text/csv; charset=utf-8');
- response.setHeader('Content-Disposition', contentDisposition);
- await pipeline(stream, response);
- } finally {
- await this.recordExportWorkspaceService.cancel({
- workspaceId: recordExport.workspaceId,
- id: recordExport.id,
- });
- }
- }
-}
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.ts
index c056f64c322..d720d2d097f 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,26 +1,24 @@
-import { RecordExportStreamWorkspaceService } from 'src/engine/core-modules/record-export/services/record-export-stream.workspace-service';
-import { FeatureFlagModule } from 'src/engine/core-modules/feature-flag/feature-flag.module';
-import { RecordExportCacheService } from 'src/engine/core-modules/record-export/services/record-export-cache.service';
import { Module } from '@nestjs/common';
import { TypeOrmModule } from '@nestjs/typeorm';
-import { FileEntity } from 'src/engine/core-modules/file/entities/file.entity';
-import { provideWorkspaceScopedRepository } from 'src/engine/twenty-orm/workspace-scoped-repository/provide-workspace-scoped-repository';
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';
import { JwtModule } from 'src/engine/core-modules/jwt/jwt.module';
import { GenerateRecordExportJob } from 'src/engine/core-modules/record-export/jobs/generate-record-export.job';
-import { RecordExportController } from 'src/engine/core-modules/record-export/record-export.controller';
import { RecordExportResolver } from 'src/engine/core-modules/record-export/record-export.resolver';
-import { RecordExportQueryWorkspaceService } from 'src/engine/core-modules/record-export/services/record-export-query.workspace-service';
import { RecordExportWorkspaceService } from 'src/engine/core-modules/record-export/services/record-export.workspace-service';
+import { UserSessionModule } from 'src/engine/core-modules/user-session/user-session.module';
import { UserWorkspaceModule } from 'src/engine/core-modules/user-workspace/user-workspace.module';
import { ApplicationTranslationCatalogModule } from 'src/engine/metadata-modules/application-translation-catalog/application-translation-catalog.module';
import { PermissionsModule } from 'src/engine/metadata-modules/permissions/permissions.module';
+import { provideWorkspaceScopedRepository } from 'src/engine/twenty-orm/workspace-scoped-repository/provide-workspace-scoped-repository';
import { WorkspaceCacheModule } from 'src/engine/workspace-cache/workspace-cache.module';
@Module({
imports: [
TypeOrmModule.forFeature([FileEntity]),
+ UserSessionModule,
CoreCommonApiModule,
FeatureFlagModule,
JwtModule,
@@ -29,14 +27,11 @@ import { WorkspaceCacheModule } from 'src/engine/workspace-cache/workspace-cache
ApplicationTranslationCatalogModule,
WorkspaceCacheModule,
],
- controllers: [RecordExportController],
+ exports: [RecordExportWorkspaceService],
providers: [
RecordExportResolver,
- RecordExportStreamWorkspaceService,
- RecordExportCacheService,
provideWorkspaceScopedRepository(FileEntity),
RecordExportWorkspaceService,
- RecordExportQueryWorkspaceService,
GenerateRecordExportJob,
],
})
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.ts
index ea5a3f4956d..6701d423374 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
@@ -1,18 +1,19 @@
-import { RecordExportStreamWorkspaceService } from 'src/engine/core-modules/record-export/services/record-export-stream.workspace-service';
-import { FeatureFlagService } from 'src/engine/core-modules/feature-flag/services/feature-flag.service';
-import { PreventNestToAutoLogGraphqlErrorsFilter } from 'src/engine/core-modules/graphql/filters/prevent-nest-to-auto-log-graphql-errors.filter';
-import { ForbiddenError } from 'src/engine/core-modules/graphql/utils/graphql-errors.util';
-import { FeatureFlagKey } from 'twenty-shared/types';
import { UseFilters, UseGuards, UsePipes } from '@nestjs/common';
-import { Args, Subscription } from '@nestjs/graphql';
+import { Args, Context, Subscription } from '@nestjs/graphql';
+import { type Request } from 'express';
import { PermissionFlagType } from 'twenty-shared/constants';
+import { FeatureFlagKey } from 'twenty-shared/types';
import { MetadataResolver } from 'src/engine/api/graphql/graphql-config/decorators/metadata-resolver.decorator';
import { getWorkspaceAuthContext } from 'src/engine/core-modules/auth/storage/workspace-auth-context.storage';
+import { FeatureFlagService } from 'src/engine/core-modules/feature-flag/services/feature-flag.service';
+import { PreventNestToAutoLogGraphqlErrorsFilter } from 'src/engine/core-modules/graphql/filters/prevent-nest-to-auto-log-graphql-errors.filter';
import { ResolverValidationPipe } from 'src/engine/core-modules/graphql/pipes/resolver-validation.pipe';
+import { ForbiddenError } from 'src/engine/core-modules/graphql/utils/graphql-errors.util';
import { CreateRecordExportInput } from 'src/engine/core-modules/record-export/dtos/create-record-export.input';
import { RecordExportDTO } from 'src/engine/core-modules/record-export/dtos/record-export.dto';
+import { RecordExportWorkspaceService } from 'src/engine/core-modules/record-export/services/record-export.workspace-service';
import { SettingsPermissionGuard } from 'src/engine/guards/settings-permission.guard';
import { UserAuthGuard } from 'src/engine/guards/user-auth.guard';
import { WorkspaceAuthGuard } from 'src/engine/guards/workspace-auth.guard';
@@ -27,7 +28,7 @@ import { WorkspaceAuthGuard } from 'src/engine/guards/workspace-auth.guard';
@UseFilters(PreventNestToAutoLogGraphqlErrorsFilter)
export class RecordExportResolver {
constructor(
- private readonly recordExportStreamService: RecordExportStreamWorkspaceService,
+ private readonly recordExportWorkspaceService: RecordExportWorkspaceService,
private readonly featureFlagService: FeatureFlagService,
) {}
@@ -36,6 +37,7 @@ export class RecordExportResolver {
})
async exportRecords(
@Args('input') input: CreateRecordExportInput,
+ @Context() context: { req: Request },
): Promise<AsyncIterableIterator<RecordExportDTO>> {
const authContext = getWorkspaceAuthContext();
if (
@@ -48,9 +50,13 @@ export class RecordExportResolver {
'Asynchronous CSV export is not enabled for this workspace',
);
}
- return this.recordExportStreamService.stream({
+ return this.recordExportWorkspaceService.stream({
parameters: input,
authContext,
+ requestTokenHash:
+ this.recordExportWorkspaceService.getRequestTokenHashOrThrow(
+ context.req,
+ ),
});
}
}
diff --git a/packages/twenty-server/src/engine/core-modules/record-export/services/record-export-cache.service.ts b/packages/twenty-server/src/engine/core-modules/record-export/services/record-export-cache.service.ts
deleted file mode 100644
index 49be44b5b6b..00000000000
--- a/packages/twenty-server/src/engine/core-modules/record-export/services/record-export-cache.service.ts
+++ /dev/null
@@ -1,116 +0,0 @@
-import { ConflictException, Inject, Injectable } from '@nestjs/common';
-
-import { t } from '@lingui/core/macro';
-import { isDefined } from 'twenty-shared/utils';
-
-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';
-import { UPDATE_RECORD_EXPORT_LEASE_SCRIPT } from 'src/engine/core-modules/record-export/constants/update-record-export-lease-script.constant';
-import { CREATE_RECORD_EXPORT_DOWNLOAD_SCRIPT } from 'src/engine/core-modules/record-export/constants/create-record-export-download-script.constant';
-import {
- RECORD_EXPORT_DOWNLOAD_TTL_MS,
- RECORD_EXPORT_CONNECTION_TTL_MS,
-} from 'src/engine/core-modules/record-export/constants/record-export.constants';
-import {
- type RecordExport,
- type RecordExportDownload,
-} from 'src/engine/core-modules/record-export/types/record-export.type';
-
-type ExportIdentity = Pick<RecordExport, 'workspaceId' | 'id'>;
-
-@Injectable()
-export class RecordExportCacheService {
- constructor(
- @Inject(CacheStorageNamespace.EngineRecordExport)
- private readonly cacheStorageService: CacheStorageService,
- ) {}
-
- async acquireLease(recordExport: ExportIdentity): Promise<void> {
- const created = await this.cacheStorageService.setIfAbsent(
- this.getActiveKey(recordExport.workspaceId),
- recordExport.id,
- RECORD_EXPORT_CONNECTION_TTL_MS,
- );
- if (!created) {
- throw new ConflictException(
- t`An export is already running in this workspace. Please wait for it to finish.`,
- );
- }
- }
-
- async isConnected({ workspaceId, id }: ExportIdentity): Promise<boolean> {
- return (
- (await this.cacheStorageService.get<string>(
- this.getActiveKey(workspaceId),
- )) === id
- );
- }
-
- renewLease(recordExport: ExportIdentity): Promise<boolean> {
- return this.updateLease(recordExport, RECORD_EXPORT_CONNECTION_TTL_MS);
- }
-
- releaseLease(recordExport: ExportIdentity): Promise<boolean> {
- return this.updateLease(recordExport, 0);
- }
-
- async createDownload(recordExport: RecordExportDownload): Promise<boolean> {
- return (
- (await this.cacheStorageService.runScript<number>({
- script: CREATE_RECORD_EXPORT_DOWNLOAD_SCRIPT,
- keys: [
- this.getActiveKey(recordExport.workspaceId),
- this.getDownloadKey(recordExport),
- ],
- args: [
- JSON.stringify(recordExport.id),
- JSON.stringify(recordExport),
- String(RECORD_EXPORT_DOWNLOAD_TTL_MS),
- ],
- })) === 1
- );
- }
-
- findDownload(
- recordExport: ExportIdentity,
- ): Promise<RecordExportDownload | undefined> {
- return this.cacheStorageService.get<RecordExportDownload>(
- this.getDownloadKey(recordExport),
- );
- }
-
- async claimDownload(recordExport: ExportIdentity): Promise<boolean> {
- const claimed = await this.cacheStorageService.setIfAbsent(
- `${this.getDownloadKey(recordExport)}:claimed`,
- true,
- RECORD_EXPORT_DOWNLOAD_TTL_MS,
- );
- return claimed && isDefined(await this.findDownload(recordExport));
- }
-
- async delete(recordExport: ExportIdentity): Promise<void> {
- await this.releaseLease(recordExport);
- await this.cacheStorageService.del(this.getDownloadKey(recordExport));
- }
-
- private async updateLease(
- { workspaceId, id }: ExportIdentity,
- ttl: number,
- ): Promise<boolean> {
- return (
- (await this.cacheStorageService.runScript<number>({
- script: UPDATE_RECORD_EXPORT_LEASE_SCRIPT,
- keys: [this.getActiveKey(workspaceId)],
- args: [JSON.stringify(id), String(ttl)],
- })) === 1
- );
- }
-
- private getDownloadKey({ workspaceId, id }: ExportIdentity): string {
- return `{${workspaceId}}:download:${id}`;
- }
-
- private getActiveKey(workspaceId: string): string {
- return `{${workspaceId}}:active`;
- }
-}
diff --git a/packages/twenty-server/src/engine/core-modules/record-export/services/record-export-query.workspace-service.ts b/packages/twenty-server/src/engine/core-modules/record-export/services/record-export-query.workspace-service.ts
deleted file mode 100644
index c6b21879979..00000000000
--- a/packages/twenty-server/src/engine/core-modules/record-export/services/record-export-query.workspace-service.ts
+++ /dev/null
@@ -1,251 +0,0 @@
-import { RecordExportException } from 'src/engine/core-modules/record-export/record-export.exception';
-import {
- ForbiddenException,
- Injectable,
- BadRequestException,
-} from '@nestjs/common';
-
-import { t } from '@lingui/core/macro';
-import { PermissionFlagType } from 'twenty-shared/constants';
-import { isDefined } from 'twenty-shared/utils';
-
-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 { 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 {
- type UserWorkspaceAuthContext,
- 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 { RECORD_EXPORT_PAGE_SIZE } from 'src/engine/core-modules/record-export/constants/record-export.constants';
-import { type RecordExport } from 'src/engine/core-modules/record-export/types/record-export.type';
-import { type RecordExportColumn } from 'src/engine/core-modules/record-export/types/record-export-column.type';
-import { type RecordExportParameters } from 'src/engine/core-modules/record-export/types/record-export-parameters.type';
-import { buildRecordExportColumns } from 'src/engine/core-modules/record-export/utils/build-record-export-columns.util';
-import { UserWorkspaceService } from 'src/engine/core-modules/user-workspace/user-workspace.service';
-import { fromUserEntityToFlat } from 'src/engine/core-modules/user/utils/from-user-entity-to-flat.util';
-import { fromWorkspaceEntityToFlat } from 'src/engine/core-modules/workspace/utils/from-workspace-entity-to-flat.util';
-import { findFlatEntityByIdInFlatEntityMapsOrThrow } from 'src/engine/metadata-modules/flat-entity/utils/find-flat-entity-by-id-in-flat-entity-maps-or-throw.util';
-import { buildObjectIdByNameMaps } from 'src/engine/metadata-modules/flat-object-metadata/utils/build-object-id-by-name-maps.util';
-import { ApplicationTranslationCatalogService } from 'src/engine/metadata-modules/application-translation-catalog/services/application-translation-catalog.service';
-import { resolveEffectiveTranslatedFlatEntity } from 'src/engine/metadata-modules/overrides/utils/resolve-effective-translated-flat-entity.util';
-import { PermissionsService } from 'src/engine/metadata-modules/permissions/permissions.service';
-import { WorkspaceCacheService } from 'src/engine/workspace-cache/services/workspace-cache.service';
-
-export type RecordExportQueryContext = {
- queryRunnerContext: CommonBaseQueryRunnerContext;
- columns: RecordExportColumn[];
- selectedFields: CommonSelectedFields;
-};
-
-@Injectable()
-export class RecordExportQueryWorkspaceService {
- constructor(
- private readonly userWorkspaceService: UserWorkspaceService,
- private readonly permissionsService: PermissionsService,
- private readonly workspaceCacheService: WorkspaceCacheService,
- private readonly commonFindManyQueryRunnerService: CommonFindManyQueryRunnerService,
- private readonly applicationTranslationCatalogService: ApplicationTranslationCatalogService,
- ) {}
-
- async assertCanExport(
- authContext: WorkspaceAuthContext,
- ): Promise<UserWorkspaceAuthContext> {
- if (
- !isUserAuthContext(authContext) ||
- isDefined(authContext.application) ||
- isDefined(authContext.viaApplication)
- ) {
- throw new ForbiddenException(t`Sign in to export records.`);
- }
-
- if (
- !(await this.permissionsService.userHasWorkspaceSettingPermission({
- workspaceId: authContext.workspace.id,
- userWorkspaceId: authContext.userWorkspaceId,
- setting: PermissionFlagType.EXPORT_CSV,
- }))
- ) {
- throw new ForbiddenException(
- t`You do not have permission to export records.`,
- );
- }
-
- return authContext;
- }
-
- async resolveRequester(
- recordExport: RecordExport,
- ): Promise<UserWorkspaceAuthContext> {
- const workspaceMember = await this.userWorkspaceService.getWorkspaceMember({
- workspaceId: recordExport.workspaceId,
- workspaceMemberId: recordExport.workspaceMemberId,
- });
-
- if (!isDefined(workspaceMember)) {
- throw new ForbiddenException(
- t`The export requester is no longer a workspace member.`,
- );
- }
-
- const userWorkspace =
- await this.userWorkspaceService.getUserWorkspaceForUser({
- userId: workspaceMember.userId,
- workspaceId: recordExport.workspaceId,
- relations: ['user', 'workspace'],
- });
-
- if (
- !isDefined(userWorkspace) ||
- userWorkspace.id !== recordExport.userWorkspaceId
- ) {
- throw new ForbiddenException(
- t`The export requester is no longer a workspace member.`,
- );
- }
-
- return this.assertCanExport(
- buildUserAuthContext({
- workspace: fromWorkspaceEntityToFlat(userWorkspace.workspace),
- user: fromUserEntityToFlat(userWorkspace.user),
- userWorkspaceId: userWorkspace.id,
- workspaceMember,
- workspaceMemberId: workspaceMember.id,
- }),
- );
- }
-
- async buildContext({
- parameters,
- authContext,
- }: {
- parameters: RecordExportParameters;
- authContext: UserWorkspaceAuthContext;
- }): Promise<RecordExportQueryContext> {
- const { flatObjectMetadataMaps, flatFieldMetadataMaps } =
- await this.workspaceCacheService.getOrRecompute(
- authContext.workspace.id,
- ['flatObjectMetadataMaps', 'flatFieldMetadataMaps'],
- );
- const flatObjectMetadata = findFlatEntityByIdInFlatEntityMapsOrThrow({
- flatEntityMaps: flatObjectMetadataMaps,
- flatEntityId: parameters.objectMetadataId,
- });
- const rawFields = parameters.fieldMetadataIds.map((fieldMetadataId) => {
- const field = findFlatEntityByIdInFlatEntityMapsOrThrow({
- flatEntityMaps: flatFieldMetadataMaps,
- flatEntityId: fieldMetadataId,
- });
-
- if (field.objectMetadataId !== flatObjectMetadata.id) {
- throw new BadRequestException(
- t`An export field is no longer available.`,
- );
- }
-
- return field;
- });
- const getI18nContext =
- await this.applicationTranslationCatalogService.getI18nContextByApplicationId(
- {
- applicationIds: rawFields.map((field) => field.applicationId),
- locale: authContext.workspaceMember.locale,
- workspaceId: authContext.workspace.id,
- },
- );
- const fields = rawFields.map((field) =>
- resolveEffectiveTranslatedFlatEntity({
- metadataName: 'fieldMetadata',
- flatEntity: field,
- i18nContext: getI18nContext(field.applicationId),
- }),
- );
- if (fields.some((field) => !field.isActive)) {
- throw new BadRequestException(t`An export field is no longer available.`);
- }
- const columns = buildRecordExportColumns(fields);
- const node: CommonSelectedFields = {};
-
- for (const column of columns) {
- if (isDefined(column.subFieldName)) {
- const nested = node[column.fieldName];
- node[column.fieldName] = {
- ...(typeof nested === 'object' ? nested : {}),
- [column.subFieldName]: true,
- };
- } else {
- node[column.fieldName] = true;
- }
- }
-
- return {
- columns,
- selectedFields: { edges: { node } },
- queryRunnerContext: {
- authContext,
- flatObjectMetadata,
- flatObjectMetadataMaps,
- flatFieldMetadataMaps,
- objectIdByNameSingular: buildObjectIdByNameMaps(flatObjectMetadataMaps)
- .idByNameSingular,
- },
- };
- }
-
- async countRecords({
- parameters,
- context,
- }: {
- parameters: Pick<RecordExportParameters, 'filter'>;
- context: RecordExportQueryContext;
- }): Promise<number> {
- const { results } = await withWorkspaceAuthContext(
- context.queryRunnerContext.authContext,
- () =>
- this.commonFindManyQueryRunnerService.execute(
- {
- filter: parameters.filter,
- selectedFields: { ...context.selectedFields, totalCount: true },
- first: 0,
- },
- context.queryRunnerContext,
- ),
- );
- if (!isDefined(results.totalCount)) {
- throw new RecordExportException(
- 'Export record count is unavailable',
- 'RECORD_COUNT_UNAVAILABLE',
- );
- }
- return Number(results.totalCount);
- }
-
- async readPage({
- parameters,
- context,
- after,
- first = RECORD_EXPORT_PAGE_SIZE,
- }: {
- parameters: Pick<RecordExportParameters, 'filter' | 'orderBy'>;
- context: RecordExportQueryContext;
- after?: string;
- first?: number;
- }) {
- return withWorkspaceAuthContext(
- context.queryRunnerContext.authContext,
- () =>
- this.commonFindManyQueryRunnerService.execute(
- {
- filter: parameters.filter,
- orderBy: parameters.orderBy,
- selectedFields: context.selectedFields,
- first,
- after,
- },
- context.queryRunnerContext,
- ),
- );
- }
-}
diff --git a/packages/twenty-server/src/engine/core-modules/record-export/services/record-export-stream.workspace-service.ts b/packages/twenty-server/src/engine/core-modules/record-export/services/record-export-stream.workspace-service.ts
deleted file mode 100644
index d76134c8814..00000000000
--- a/packages/twenty-server/src/engine/core-modules/record-export/services/record-export-stream.workspace-service.ts
+++ /dev/null
@@ -1,116 +0,0 @@
-import { BadRequestException, Injectable } from '@nestjs/common';
-
-import { t } from '@lingui/core/macro';
-import { setTimeout } from 'node:timers/promises';
-import { isDefined } from 'twenty-shared/utils';
-
-import { type WorkspaceAuthContext } from 'src/engine/core-modules/auth/types/workspace-auth-context.type';
-import {
- RECORD_EXPORT_PROGRESS_INTERVAL_MS,
- RECORD_EXPORT_MAX_DURATION_MS,
-} from 'src/engine/core-modules/record-export/constants/record-export.constants';
-import { type RecordExportDTO } from 'src/engine/core-modules/record-export/dtos/record-export.dto';
-import { RecordExportStatus } from 'src/engine/core-modules/record-export/enums/record-export-status.enum';
-import { RecordExportCacheService } from 'src/engine/core-modules/record-export/services/record-export-cache.service';
-import { RecordExportWorkspaceService } from 'src/engine/core-modules/record-export/services/record-export.workspace-service';
-import { type RecordExportParameters } from 'src/engine/core-modules/record-export/types/record-export-parameters.type';
-import { wrapAsyncIteratorWithLifecycle } from 'src/engine/subscriptions/utils/wrap-async-iterator-with-lifecycle';
-
-@Injectable()
-export class RecordExportStreamWorkspaceService {
- constructor(
- private readonly recordExportCacheService: RecordExportCacheService,
- private readonly recordExportWorkspaceService: RecordExportWorkspaceService,
- ) {}
-
- async stream({
- parameters,
- authContext,
- }: {
- parameters: RecordExportParameters;
- authContext: WorkspaceAuthContext;
- }): Promise<AsyncIterableIterator<RecordExportDTO>> {
- const service = this;
- const recordExport = await this.recordExportWorkspaceService.create({
- parameters,
- authContext,
- });
- let downloadReady = false;
- let jobId: string;
-
- async function* events(
- signal: AbortSignal,
- ): AsyncGenerator<RecordExportDTO> {
- while (!signal.aborted) {
- const updated = await service.recordExportWorkspaceService.getProgress(
- recordExport,
- jobId,
- );
- if (signal.aborted) {
- return;
- }
- if (
- updated.status === RecordExportStatus.COMPLETED &&
- isDefined(updated.result)
- ) {
- await service.recordExportWorkspaceService.prepareDownload(
- recordExport,
- updated.result,
- );
- const downloadUrl =
- await service.recordExportWorkspaceService.getDownloadUrl({
- id: updated.id,
- authContext,
- });
- if (signal.aborted) {
- return;
- }
- downloadReady = true;
- yield { ...updated, downloadUrl };
- return;
- }
- yield updated;
- if (updated.status === RecordExportStatus.FAILED) {
- return;
- }
- await setTimeout(RECORD_EXPORT_PROGRESS_INTERVAL_MS, undefined, {
- signal,
- });
- }
- }
-
- const stream = wrapAsyncIteratorWithLifecycle(events, {
- heartbeatStart: 'immediate',
- heartbeatErrorBehavior: 'close',
- heartbeatIntervalMs: RECORD_EXPORT_PROGRESS_INTERVAL_MS,
- onHeartbeat: async () => {
- if (downloadReady) {
- return false;
- }
- if (
- Date.now() - recordExport.createdAt > RECORD_EXPORT_MAX_DURATION_MS ||
- !(await this.recordExportCacheService.renewLease(recordExport))
- ) {
- throw new BadRequestException(
- t`The export was interrupted. Please try again.`,
- );
- }
- return true;
- },
- onCleanup: async () => {
- if (downloadReady) {
- await this.recordExportCacheService.releaseLease(recordExport);
- } else {
- await this.recordExportWorkspaceService.cancel(recordExport);
- }
- },
- });
- try {
- jobId = await this.recordExportWorkspaceService.enqueue(recordExport);
- } catch (error) {
- await stream.return?.();
- throw error;
- }
- return stream;
- }
-}
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.ts
index 4b2a5af3e9c..9caf2472dd7 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
@@ -1,41 +1,93 @@
-import { v4 } from 'uuid';
-import { z } from 'zod';
-import { type JobState } from 'bullmq/dist/esm/types';
-import { RecordExportException } from 'src/engine/core-modules/record-export/record-export.exception';
import {
+ ConflictException,
+ Inject,
+ NotFoundException,
BadRequestException,
+ ForbiddenException,
Injectable,
- NotFoundException,
+ Logger,
} from '@nestjs/common';
-import { FileStorageService } from 'src/engine/core-modules/file-storage/services/file-storage.service';
-import { FILE_STATUS } from 'src/engine/core-modules/file/types/file-status.types';
import { t } from '@lingui/core/macro';
+import { type Request } from 'express';
+import { setTimeout } from 'node:timers/promises';
+import { type Readable } from 'stream';
import { TWENTY_STANDARD_APPLICATION_UNIVERSAL_IDENTIFIER } from 'twenty-shared/application';
+import { PermissionFlagType } from 'twenty-shared/constants';
import { FileFolder } from 'twenty-shared/types';
import { isDefined } from 'twenty-shared/utils';
+import { v4 } from 'uuid';
+import { z } from 'zod';
-import { type WorkspaceAuthContext } from 'src/engine/core-modules/auth/types/workspace-auth-context.type';
+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 { 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 { 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';
+import { FileStorageService } from 'src/engine/core-modules/file-storage/services/file-storage.service';
+import { FileEntity } from 'src/engine/core-modules/file/entities/file.entity';
+import { FILE_STATUS } from 'src/engine/core-modules/file/types/file-status.types';
import { JwtWrapperService } from 'src/engine/core-modules/jwt/services/jwt-wrapper.service';
import { InjectMessageQueue } from 'src/engine/core-modules/message-queue/decorators/message-queue.decorator';
import { MessageQueue } from 'src/engine/core-modules/message-queue/message-queue.constants';
import { MessageQueueService } from 'src/engine/core-modules/message-queue/services/message-queue.service';
import {
+ RECORD_EXPORT_CONNECTION_TTL_MS,
+ RECORD_EXPORT_DOWNLOAD_TOKEN_TTL_SECONDS,
RECORD_EXPORT_MAX_DURATION_MS,
- RECORD_EXPORT_DOWNLOAD_TTL_MS,
+ RECORD_EXPORT_PROGRESS_INTERVAL_MS,
+ RECORD_EXPORT_PAGE_SIZE,
} from 'src/engine/core-modules/record-export/constants/record-export.constants';
+import { UPDATE_RECORD_EXPORT_LEASE_SCRIPT } from 'src/engine/core-modules/record-export/constants/update-record-export-lease-script.constant';
import { type RecordExportDTO } from 'src/engine/core-modules/record-export/dtos/record-export.dto';
-import { RecordExportStatus } from 'src/engine/core-modules/record-export/enums/record-export-status.enum';
-import {
- type RecordExport,
- type RecordExportDownload,
- type RecordExportResult,
-} from 'src/engine/core-modules/record-export/types/record-export.type';
-import { RecordExportCacheService } from 'src/engine/core-modules/record-export/services/record-export-cache.service';
-import { RecordExportQueryWorkspaceService } from 'src/engine/core-modules/record-export/services/record-export-query.workspace-service';
+import { RecordExportException } from 'src/engine/core-modules/record-export/record-export.exception';
+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 { TwentyConfigService } from 'src/engine/core-modules/twenty-config/twenty-config.service';
+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';
+import { fromUserEntityToFlat } from 'src/engine/core-modules/user/utils/from-user-entity-to-flat.util';
+import { fromWorkspaceEntityToFlat } from 'src/engine/core-modules/workspace/utils/from-workspace-entity-to-flat.util';
+import { ApplicationTranslationCatalogService } from 'src/engine/metadata-modules/application-translation-catalog/services/application-translation-catalog.service';
+import { findFlatEntityByIdInFlatEntityMapsOrThrow } from 'src/engine/metadata-modules/flat-entity/utils/find-flat-entity-by-id-in-flat-entity-maps-or-throw.util';
+import { buildObjectIdByNameMaps } from 'src/engine/metadata-modules/flat-object-metadata/utils/build-object-id-by-name-maps.util';
+import { resolveEffectiveTranslatedFlatEntity } from 'src/engine/metadata-modules/overrides/utils/resolve-effective-translated-flat-entity.util';
+import { PermissionsService } from 'src/engine/metadata-modules/permissions/permissions.service';
+import { wrapAsyncIteratorWithLifecycle } from 'src/engine/subscriptions/utils/wrap-async-iterator-with-lifecycle';
+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';
+import { WorkspaceCacheService } from 'src/engine/workspace-cache/services/workspace-cache.service';
+import { type WorkspaceCacheKeyName } from 'src/engine/workspace-cache/types/workspace-cache-key.type';
+import { combineCacheHashes } from 'src/engine/workspace-cache/utils/combine-cache-hashes.util';
+
+export type RecordExportQueryContext = {
+ queryRunnerContext: CommonBaseQueryRunnerContext;
+ columns: RecordExportColumn[];
+ selectedFields: CommonSelectedFields;
+};
+
+const RECORD_EXPORT_PERMISSION_CACHE_KEYS: WorkspaceCacheKeyName[] = [
+ 'rolesPermissions',
+ 'userWorkspaceRoleMap',
+ 'flatRoleMaps',
+ 'flatRowLevelPermissionPredicateMaps',
+ 'flatRowLevelPermissionPredicateGroupMaps',
+ 'flatWorkspaceMemberMaps',
+ 'flatObjectMetadataMaps',
+ 'flatFieldMetadataMaps',
+];
const recordExportProgressSchema = z.object({
processedRecordCount: z.number().int().nonnegative(),
@@ -43,233 +95,634 @@ const recordExportProgressSchema = z.object({
errorMessage: z.string().optional(),
});
-const recordExportResultSchema = recordExportProgressSchema.extend({
- fileId: z.uuid(),
-});
-
@Injectable()
export class RecordExportWorkspaceService {
+ private readonly logger = new Logger(RecordExportWorkspaceService.name);
+
constructor(
- private readonly recordExportCacheService: RecordExportCacheService,
+ private readonly userWorkspaceService: UserWorkspaceService,
+ private readonly permissionsService: PermissionsService,
+ private readonly workspaceCacheService: WorkspaceCacheService,
+ private readonly commonFindManyQueryRunnerService: CommonFindManyQueryRunnerService,
+ private readonly applicationTranslationCatalogService: ApplicationTranslationCatalogService,
+ private readonly userSessionCookieService: UserSessionCookieService,
+ @Inject(CacheStorageNamespace.EngineRecordExport)
+ private readonly cacheStorageService: CacheStorageService,
+ @InjectWorkspaceScopedRepository(FileEntity)
+ private readonly fileRepository: WorkspaceScopedRepository<FileEntity>,
@InjectMessageQueue(MessageQueue.recordExportQueue)
private readonly messageQueueService: MessageQueueService,
- private readonly recordExportQueryWorkspaceService: RecordExportQueryWorkspaceService,
private readonly fileStorageService: FileStorageService,
private readonly jwtWrapperService: JwtWrapperService,
private readonly twentyConfigService: TwentyConfigService,
) {}
+ async stream(input: {
+ parameters: RecordExportParameters;
+ authContext: WorkspaceAuthContext;
+ requestTokenHash: string;
+ }): Promise<AsyncIterableIterator<RecordExportDTO>> {
+ const service = this;
+ const recordExport = await this.create(input);
+ let downloadReady = false;
+ let jobId: string;
+
+ async function* events(
+ signal: AbortSignal,
+ ): AsyncGenerator<RecordExportDTO> {
+ while (!signal.aborted) {
+ const updated = await service.getProgress(recordExport, jobId);
+ if (signal.aborted) {
+ return;
+ }
+ downloadReady = isDefined(updated.downloadUrl);
+ yield updated;
+ if (downloadReady || isDefined(updated.errorMessage)) {
+ return;
+ }
+ await setTimeout(RECORD_EXPORT_PROGRESS_INTERVAL_MS, undefined, {
+ signal,
+ });
+ }
+ }
+
+ const stream = wrapAsyncIteratorWithLifecycle(events, {
+ heartbeatStart: 'immediate',
+ heartbeatErrorBehavior: 'close',
+ heartbeatIntervalMs: RECORD_EXPORT_PROGRESS_INTERVAL_MS,
+ onHeartbeat: async () => {
+ if (downloadReady) {
+ return false;
+ }
+ if (
+ Date.now() - recordExport.createdAt > RECORD_EXPORT_MAX_DURATION_MS ||
+ !(await this.updateLease(
+ recordExport,
+ RECORD_EXPORT_CONNECTION_TTL_MS,
+ ))
+ ) {
+ throw new BadRequestException(
+ t`The export was interrupted. Please try again.`,
+ );
+ }
+ return true;
+ },
+ onCleanup: async () => {
+ if (downloadReady) {
+ await this.updateLease(recordExport, 0);
+ } else {
+ await this.cancel(recordExport);
+ }
+ },
+ });
+ try {
+ jobId = await this.enqueue(recordExport);
+ } catch (error) {
+ await stream.return?.();
+ throw error;
+ }
+ return stream;
+ }
+
async create({
parameters,
authContext,
+ requestTokenHash,
}: {
parameters: RecordExportParameters;
authContext: WorkspaceAuthContext;
+ requestTokenHash: string;
}): Promise<RecordExport> {
- const requester =
- await this.recordExportQueryWorkspaceService.assertCanExport(authContext);
- const context = await this.recordExportQueryWorkspaceService.buildContext({
+ const requester = await this.assertCanExport(authContext);
+ const permissionsHash = await this.capturePermissionsHash(
+ requester.workspace.id,
+ );
+ const context = await this.buildContext({
parameters,
authContext: requester,
});
- const workspaceId = requester.workspace.id;
-
const recordExport: RecordExport = {
id: v4(),
createdAt: Date.now(),
- workspaceId,
+ workspaceId: requester.workspace.id,
userWorkspaceId: requester.userWorkspaceId,
workspaceMemberId: requester.workspaceMemberId,
+ requestTokenHash,
+ permissionsHash,
parameters,
filename: `${context.queryRunnerContext.flatObjectMetadata.nameSingular}.csv`,
};
- await this.recordExportCacheService.acquireLease(recordExport);
+ const acquired = await this.cacheStorageService.setIfAbsent(
+ `{${recordExport.workspaceId}}:active`,
+ recordExport.id,
+ RECORD_EXPORT_CONNECTION_TTL_MS,
+ );
+ if (!acquired) {
+ throw new ConflictException(
+ t`An export is already running in this workspace. Please wait for it to finish.`,
+ );
+ }
return recordExport;
}
async enqueue(recordExport: RecordExport): Promise<string> {
- try {
- const jobId = await this.messageQueueService.add(
- 'GenerateRecordExportJob',
- recordExport,
- { id: recordExport.id },
+ const jobId = await this.messageQueueService.add(
+ 'GenerateRecordExportJob',
+ recordExport,
+ { id: recordExport.id },
+ );
+ if (!isDefined(jobId)) {
+ throw new RecordExportException(
+ 'The export could not be queued',
+ 'QUEUE_UNAVAILABLE',
);
- if (!isDefined(jobId)) {
- throw new RecordExportException(
- 'The export could not be queued',
- 'QUEUE_UNAVAILABLE',
- );
- }
- return jobId;
- } catch (error) {
- await this.cancel(recordExport);
- throw error;
}
+ return jobId;
}
async getProgress(
recordExport: RecordExport,
jobId: string,
- ): Promise<RecordExportDTO & { result?: RecordExportResult }> {
+ ): Promise<RecordExportDTO> {
const jobs = await this.messageQueueService.getJobs<RecordExport>([jobId]);
const job = jobs[jobId];
const progress = recordExportProgressSchema.safeParse(job?.progress).data;
- const result = recordExportResultSchema.safeParse(job?.result).data;
- const interrupted =
- !isDefined(job) ||
- (job.state === 'completed' && !isDefined(result?.fileId)) ||
- Date.now() - recordExport.createdAt > RECORD_EXPORT_MAX_DURATION_MS;
- const status = this.getStatus({ state: job?.state, interrupted });
- return {
+ const update: RecordExportDTO = {
id: recordExport.id,
filename: recordExport.filename,
- status,
- processedRecordCount:
- result?.processedRecordCount ?? progress?.processedRecordCount ?? 0,
- totalRecordCount:
- result?.totalRecordCount ?? progress?.totalRecordCount ?? null,
- errorMessage:
- status === RecordExportStatus.FAILED
- ? (progress?.errorMessage ??
- t`The export was interrupted. Please try again.`)
- : null,
- result,
+ progress: progress?.totalRecordCount
+ ? Math.min(
+ 99,
+ Math.floor(
+ (100 * progress.processedRecordCount) / progress.totalRecordCount,
+ ),
+ )
+ : 0,
+ errorMessage: null,
};
- }
-
- private getStatus({
- state,
- interrupted,
- }: {
- state: JobState | undefined;
- interrupted: boolean;
- }): RecordExportStatus {
- if (interrupted || state === 'failed') {
- return RecordExportStatus.FAILED;
+ if (
+ !isDefined(job) ||
+ job.state === 'failed' ||
+ Date.now() - recordExport.createdAt > RECORD_EXPORT_MAX_DURATION_MS
+ ) {
+ return {
+ ...update,
+ errorMessage:
+ progress?.errorMessage ??
+ t`The export was interrupted. Please try again.`,
+ };
}
-
- if (state === 'completed') {
- return RecordExportStatus.COMPLETED;
+ if (job.state === 'completed') {
+ return {
+ ...update,
+ progress: 100,
+ downloadUrl: await this.getDownloadUrl(recordExport),
+ };
}
+ return update;
+ }
- if (state === 'active') {
- return RecordExportStatus.PROCESSING;
+ async cancel({
+ workspaceId,
+ id,
+ }: Pick<RecordExport, 'workspaceId' | 'id'>): Promise<void> {
+ await this.updateLease({ workspaceId, id }, 0);
+ // Keep pending rows until their writer stops, so failed cleanup remains retryable.
+ const file = await this.fileRepository.findOne(workspaceId, {
+ where: {
+ id,
+ path: `${FileFolder.RecordExport}/${id}.csv`,
+ status: FILE_STATUS.UPLOADED,
+ },
+ });
+ if (isDefined(file)) {
+ await this.fileStorageService.deleteFile({
+ ...this.getFileResource({ workspaceId, id }),
+ applicationId: file.applicationId,
+ });
}
-
- return RecordExportStatus.QUEUED;
}
- async prepareDownload(
- recordExport: RecordExport,
- result: RecordExportResult,
- ): Promise<void> {
- const created = await this.recordExportCacheService.createDownload({
- ...recordExport,
- ...result,
- expiresAt: Date.now() + RECORD_EXPORT_DOWNLOAD_TTL_MS,
+ async findOrThrow({
+ workspaceId,
+ id,
+ }: Pick<RecordExport, 'workspaceId' | 'id'>): Promise<FileEntity> {
+ const file = await this.fileRepository.findOne(workspaceId, {
+ where: {
+ id,
+ path: `${FileFolder.RecordExport}/${id}.csv`,
+ status: FILE_STATUS.UPLOADED,
+ },
});
- if (!created) {
+ if (!isDefined(file)) {
throw new NotFoundException(t`Export not found.`);
}
+ return file;
}
- async cancel({
- workspaceId,
+ async getDownloadUrl(
+ recordExport: Omit<RecordExport, 'parameters' | 'createdAt'>,
+ ): Promise<string> {
+ await this.resolveRequester(recordExport);
+ await this.assertPermissionsUnchanged(recordExport);
+ await this.findOrThrow(recordExport);
+ const payload: RecordExportDownloadTokenJwtPayload = {
+ type: JwtTokenTypeEnum.FILE,
+ purpose: 'record-export',
+ sub: recordExport.workspaceId,
+ workspaceId: recordExport.workspaceId,
+ fileId: recordExport.id,
+ userWorkspaceId: recordExport.userWorkspaceId,
+ workspaceMemberId: recordExport.workspaceMemberId,
+ requestTokenHash: recordExport.requestTokenHash,
+ permissionsHash: recordExport.permissionsHash,
+ filename: recordExport.filename,
+ };
+ const token = await this.jwtWrapperService.signAsyncOrThrow(payload, {
+ expiresIn: RECORD_EXPORT_DOWNLOAD_TOKEN_TTL_SECONDS,
+ });
+ await this.assertPermissionsUnchanged(recordExport);
+ return `${this.twentyConfigService.get('SERVER_URL')}/file/record-export/${recordExport.id}?token=${token}`;
+ }
+
+ async openDownload({
id,
+ token,
+ request,
}: {
- workspaceId: string;
id: string;
- }): Promise<void> {
- await this.recordExportCacheService.delete({ workspaceId, id });
- await this.fileStorageService.deleteFolder({
- ...this.getFileResource({ workspaceId, resourcePath: id }),
- folderPath: id,
- // Pending rows must survive cancellation until their writer has stopped.
- fileStatus: FILE_STATUS.UPLOADED,
- });
+ token: string;
+ request: Request;
+ }): Promise<{
+ stream: Readable;
+ filename: string;
+ cleanup: () => Promise<void>;
+ }> {
+ const payload = await this.verifyDownloadToken(id, token);
+ const recordExport = { ...payload, id };
+ this.assertDownloader({ request, recordExport });
+ await this.findOrThrow(recordExport);
+ const cleanup = () =>
+ this.cancel(recordExport).catch(() => {
+ this.logger.warn(`Failed to remove export ${id}`);
+ });
+ try {
+ await this.assertPermissionsUnchanged(recordExport);
+ await this.resolveRequester(recordExport);
+ } catch (error) {
+ await cleanup();
+ throw error;
+ }
+ const claimed = await this.cacheStorageService.setIfAbsent(
+ `{${payload.workspaceId}}:download:${id}:claimed`,
+ true,
+ RECORD_EXPORT_DOWNLOAD_TOKEN_TTL_SECONDS * 1000,
+ );
+ if (!claimed) {
+ throw new ConflictException(
+ t`This export download has already started or expired.`,
+ );
+ }
+ let stream: Readable | undefined;
+ try {
+ stream = await this.fileStorageService.readFile(
+ this.getFileResource(recordExport),
+ );
+ await this.assertPermissionsUnchanged(recordExport);
+ return { stream, filename: payload.filename, cleanup };
+ } catch (error) {
+ stream?.destroy();
+ await cleanup();
+ throw error;
+ }
}
- async findOrThrow({
+ private async verifyDownloadToken(
+ id: string,
+ token: string,
+ ): Promise<RecordExportDownloadTokenJwtPayload> {
+ try {
+ const payload: RecordExportDownloadTokenJwtPayload =
+ await this.jwtWrapperService.verifyJwtToken(token);
+ if (
+ payload.type !== JwtTokenTypeEnum.FILE ||
+ payload.purpose !== 'record-export' ||
+ payload.fileId !== id ||
+ !isDefined(payload.workspaceId)
+ ) {
+ throw new ForbiddenException(
+ t`Invalid or expired export download link.`,
+ );
+ }
+ return payload;
+ } catch {
+ throw new ForbiddenException(t`Invalid or expired export download link.`);
+ }
+ }
+
+ getFileResource({
workspaceId,
id,
- }: {
- workspaceId: string;
- id: string;
- }): Promise<RecordExportDownload> {
- const recordExport = await this.recordExportCacheService.findDownload({
+ }: Pick<RecordExport, 'workspaceId' | 'id'>) {
+ return {
workspaceId,
- id,
+ applicationUniversalIdentifier:
+ TWENTY_STANDARD_APPLICATION_UNIVERSAL_IDENTIFIER,
+ fileFolder: FileFolder.RecordExport,
+ resourcePath: `${id}.csv`,
+ };
+ }
+
+ async assertConnected(
+ recordExport: Pick<RecordExport, 'workspaceId' | 'id'>,
+ signal: AbortSignal,
+ ): Promise<void> {
+ signal.throwIfAborted();
+ if (
+ (await this.cacheStorageService.get<string>(
+ `{${recordExport.workspaceId}}:active`,
+ )) !== recordExport.id
+ ) {
+ throw new RecordExportException(
+ 'Export connection closed',
+ 'CONNECTION_CLOSED',
+ );
+ }
+ }
+
+ private async updateLease(
+ { workspaceId, id }: Pick<RecordExport, 'workspaceId' | 'id'>,
+ ttl: number,
+ ): Promise<boolean> {
+ return (
+ (await this.cacheStorageService.runScript<number>({
+ script: UPDATE_RECORD_EXPORT_LEASE_SCRIPT,
+ keys: [`{${workspaceId}}:active`],
+ args: [JSON.stringify(id), String(ttl)],
+ })) === 1
+ );
+ }
+ async assertCanExport(
+ authContext: WorkspaceAuthContext,
+ ): Promise<UserWorkspaceAuthContext> {
+ if (
+ !isUserAuthContext(authContext) ||
+ isDefined(authContext.application) ||
+ isDefined(authContext.viaApplication)
+ ) {
+ throw new ForbiddenException(t`Sign in to export records.`);
+ }
+
+ if (
+ !(await this.permissionsService.userHasWorkspaceSettingPermission({
+ workspaceId: authContext.workspace.id,
+ userWorkspaceId: authContext.userWorkspaceId,
+ setting: PermissionFlagType.EXPORT_CSV,
+ }))
+ ) {
+ throw new ForbiddenException(
+ t`You do not have permission to export records.`,
+ );
+ }
+
+ return authContext;
+ }
+
+ async resolveRequester(
+ recordExport: Pick<
+ RecordExport,
+ 'workspaceId' | 'userWorkspaceId' | 'workspaceMemberId'
+ >,
+ ): Promise<UserWorkspaceAuthContext> {
+ const workspaceMember = await this.userWorkspaceService.getWorkspaceMember({
+ workspaceId: recordExport.workspaceId,
+ workspaceMemberId: recordExport.workspaceMemberId,
});
- if (!isDefined(recordExport)) {
- throw new NotFoundException(t`Export not found.`);
+ if (!isDefined(workspaceMember)) {
+ throw new ForbiddenException(
+ t`The export requester is no longer a workspace member.`,
+ );
}
- return recordExport;
+ const userWorkspace =
+ await this.userWorkspaceService.getUserWorkspaceForUser({
+ userId: workspaceMember.userId,
+ workspaceId: recordExport.workspaceId,
+ relations: ['user', 'workspace'],
+ });
+
+ if (
+ !isDefined(userWorkspace) ||
+ userWorkspace.id !== recordExport.userWorkspaceId
+ ) {
+ throw new ForbiddenException(
+ t`The export requester is no longer a workspace member.`,
+ );
+ }
+
+ return this.assertCanExport(
+ buildUserAuthContext({
+ workspace: fromWorkspaceEntityToFlat(userWorkspace.workspace),
+ user: fromUserEntityToFlat(userWorkspace.user),
+ userWorkspaceId: userWorkspace.id,
+ workspaceMember,
+ workspaceMemberId: workspaceMember.id,
+ }),
+ );
}
- async getDownloadUrl({
- id,
+ async buildContext({
+ parameters,
authContext,
}: {
- id: string;
- authContext: WorkspaceAuthContext;
- }): Promise<string> {
- const requester =
- await this.recordExportQueryWorkspaceService.assertCanExport(authContext);
- const recordExport = await this.findOrThrow({
- workspaceId: requester.workspace.id,
- id,
+ parameters: RecordExportParameters;
+ authContext: UserWorkspaceAuthContext;
+ }): Promise<RecordExportQueryContext> {
+ const { flatObjectMetadataMaps, flatFieldMetadataMaps } =
+ await this.workspaceCacheService.getOrRecompute(
+ authContext.workspace.id,
+ ['flatObjectMetadataMaps', 'flatFieldMetadataMaps'],
+ );
+ const flatObjectMetadata = findFlatEntityByIdInFlatEntityMapsOrThrow({
+ flatEntityMaps: flatObjectMetadataMaps,
+ flatEntityId: parameters.objectMetadataId,
});
+ const rawFields = parameters.fieldMetadataIds.map((fieldMetadataId) => {
+ const field = findFlatEntityByIdInFlatEntityMapsOrThrow({
+ flatEntityMaps: flatFieldMetadataMaps,
+ flatEntityId: fieldMetadataId,
+ });
- if (recordExport.userWorkspaceId !== requester.userWorkspaceId) {
- throw new NotFoundException(t`Export not found.`);
- }
+ if (field.objectMetadataId !== flatObjectMetadata.id) {
+ throw new BadRequestException(
+ t`An export field is no longer available.`,
+ );
+ }
- this.assertDownloadable(recordExport);
- const context = await this.recordExportQueryWorkspaceService.buildContext({
- parameters: recordExport.parameters,
- authContext: requester,
+ return field;
});
- await this.recordExportQueryWorkspaceService.readPage({
- parameters: recordExport.parameters,
- context,
- first: 0,
- });
- const token = await this.jwtWrapperService.signAsyncOrThrow(
- {
- type: JwtTokenTypeEnum.FILE,
- sub: requester.workspace.id,
- workspaceId: requester.workspace.id,
- fileId: recordExport.id,
- },
- { expiresIn: 60 },
+ const getI18nContext =
+ await this.applicationTranslationCatalogService.getI18nContextByApplicationId(
+ {
+ applicationIds: rawFields.map((field) => field.applicationId),
+ locale: authContext.workspaceMember.locale,
+ workspaceId: authContext.workspace.id,
+ },
+ );
+ const fields = rawFields.map((field) =>
+ resolveEffectiveTranslatedFlatEntity({
+ metadataName: 'fieldMetadata',
+ flatEntity: field,
+ i18nContext: getI18nContext(field.applicationId),
+ }),
);
+ if (fields.some((field) => !field.isActive)) {
+ throw new BadRequestException(t`An export field is no longer available.`);
+ }
+ const columns = buildRecordExportColumns(fields);
+ const node: CommonSelectedFields = {};
- return `${this.twentyConfigService.get('SERVER_URL')}/record-exports/${recordExport.id}/download?token=${token}`;
+ for (const column of columns) {
+ if (isDefined(column.subFieldName)) {
+ const nested = node[column.fieldName];
+ node[column.fieldName] = {
+ ...(typeof nested === 'object' ? nested : {}),
+ [column.subFieldName]: true,
+ };
+ } else {
+ node[column.fieldName] = true;
+ }
+ }
+
+ return {
+ columns,
+ selectedFields: { edges: { node } },
+ queryRunnerContext: {
+ authContext,
+ flatObjectMetadata,
+ flatObjectMetadataMaps,
+ flatFieldMetadataMaps,
+ objectIdByNameSingular: buildObjectIdByNameMaps(flatObjectMetadataMaps)
+ .idByNameSingular,
+ },
+ };
}
- assertDownloadable(recordExport: RecordExportDownload): void {
- if (recordExport.expiresAt <= Date.now()) {
- throw new BadRequestException(
- t`This export has expired. Please create a new export.`,
+ async countRecords({
+ parameters,
+ context,
+ }: {
+ parameters: Pick<RecordExportParameters, 'filter'>;
+ context: RecordExportQueryContext;
+ }): Promise<number> {
+ const { results } = await withWorkspaceAuthContext(
+ context.queryRunnerContext.authContext,
+ () =>
+ this.commonFindManyQueryRunnerService.execute(
+ {
+ filter: parameters.filter,
+ selectedFields: { ...context.selectedFields, totalCount: true },
+ first: 0,
+ },
+ context.queryRunnerContext,
+ ),
+ );
+ if (!isDefined(results.totalCount)) {
+ throw new RecordExportException(
+ 'Export record count is unavailable',
+ 'RECORD_COUNT_UNAVAILABLE',
);
}
+ return Number(results.totalCount);
}
- getFileResource({
- workspaceId,
- resourcePath,
+ async readPage({
+ parameters,
+ context,
+ after,
+ first = RECORD_EXPORT_PAGE_SIZE,
}: {
- workspaceId: string;
- resourcePath: string;
+ parameters: Pick<RecordExportParameters, 'filter' | 'orderBy'>;
+ context: RecordExportQueryContext;
+ after?: string;
+ first?: number;
}) {
- return {
- workspaceId,
- applicationUniversalIdentifier:
- TWENTY_STANDARD_APPLICATION_UNIVERSAL_IDENTIFIER,
- fileFolder: FileFolder.RecordExport,
- resourcePath,
- };
+ return withWorkspaceAuthContext(
+ context.queryRunnerContext.authContext,
+ () =>
+ this.commonFindManyQueryRunnerService.execute(
+ {
+ filter: parameters.filter,
+ orderBy: parameters.orderBy,
+ selectedFields: context.selectedFields,
+ first,
+ after,
+ },
+ context.queryRunnerContext,
+ ),
+ );
+ }
+ getRequestTokenHashOrThrow(request: Request): string {
+ const token =
+ this.jwtWrapperService.extractJwtFromRequest()(request) ??
+ this.userSessionCookieService.extractSessionTokenFromRequest(request);
+
+ if (!isDefined(token)) {
+ throw new ForbiddenException(t`Sign in to export records.`);
+ }
+
+ return hashUserSessionToken(token);
+ }
+
+ assertDownloader({
+ request,
+ recordExport,
+ }: {
+ request: Request;
+ recordExport: Pick<
+ RecordExport,
+ | 'workspaceId'
+ | 'userWorkspaceId'
+ | 'workspaceMemberId'
+ | 'requestTokenHash'
+ >;
+ }): void {
+ if (
+ request.workspace?.id !== recordExport.workspaceId ||
+ request.userWorkspaceId !== recordExport.userWorkspaceId ||
+ request.workspaceMemberId !== recordExport.workspaceMemberId ||
+ this.getRequestTokenHashOrThrow(request) !== recordExport.requestTokenHash
+ ) {
+ throw new ForbiddenException(
+ t`This export belongs to another session. Please create a new export.`,
+ );
+ }
+ }
+
+ async capturePermissionsHash(workspaceId: string): Promise<string> {
+ const { hashes } =
+ await this.workspaceCacheService.getOrRecomputeWithHashes(
+ workspaceId,
+ RECORD_EXPORT_PERMISSION_CACHE_KEYS,
+ );
+
+ return combineCacheHashes(hashes, RECORD_EXPORT_PERMISSION_CACHE_KEYS);
+ }
+
+ async assertPermissionsUnchanged(
+ recordExport: Pick<RecordExport, 'workspaceId' | 'permissionsHash'>,
+ ): Promise<void> {
+ if (
+ recordExport.permissionsHash !==
+ (await this.workspaceCacheService.getOrRecomputeCombinedHash(
+ recordExport.workspaceId,
+ RECORD_EXPORT_PERMISSION_CACHE_KEYS,
+ ))
+ ) {
+ throw new ForbiddenException(
+ t`Access permissions have changed. Please create a new export.`,
+ );
+ }
}
}
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.ts
new file mode 100644
index 00000000000..4d46ee453e1
--- /dev/null
+++ b/packages/twenty-server/src/engine/core-modules/record-export/types/record-export-download-token-jwt-payload.type.ts
@@ -0,0 +1,15 @@
+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'
+ > & {
+ purpose: 'record-export';
+ };
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.ts
index fef6ca5c7f4..fa51a83a414 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
@@ -5,6 +5,8 @@ export type RecordExport = {
workspaceId: string;
userWorkspaceId: string;
workspaceMemberId: string;
+ requestTokenHash: string;
+ permissionsHash: string;
parameters: RecordExportParameters;
filename: string;
createdAt: number;
@@ -15,12 +17,3 @@ export type RecordExportProgress = {
totalRecordCount: number | null;
errorMessage?: string;
};
-
-export type RecordExportResult = RecordExportProgress & {
- fileId: string;
-};
-
-export type RecordExportDownload = RecordExport &
- RecordExportResult & {
- expiresAt: number;
- };
diff --git a/packages/twenty-server/test/integration/record-export/record-export-cache.integration-spec.ts b/packages/twenty-server/test/integration/record-export/record-export-cache.integration-spec.ts
deleted file mode 100644
index b304129ab3e..00000000000
--- a/packages/twenty-server/test/integration/record-export/record-export-cache.integration-spec.ts
+++ /dev/null
@@ -1,190 +0,0 @@
-import { i18n } from '@lingui/core';
-import { ConflictException } from '@nestjs/common';
-import { caching } from 'cache-manager';
-import { redisInsStore } from 'cache-manager-redis-yet';
-import { createClient } from 'redis';
-import { setTimeout } from 'node:timers/promises';
-import { v4 } from 'uuid';
-
-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';
-import {
- RECORD_EXPORT_CONNECTION_TTL_MS,
- RECORD_EXPORT_DOWNLOAD_TTL_MS,
-} from 'src/engine/core-modules/record-export/constants/record-export.constants';
-import { type RecordExportDownload } from 'src/engine/core-modules/record-export/types/record-export.type';
-import { RecordExportCacheService } from 'src/engine/core-modules/record-export/services/record-export-cache.service';
-
-describe('record export Redis lifetime', () => {
- const redis = createClient({ url: process.env.REDIS_URL });
- let cache: CacheStorageService;
- let exports: RecordExportCacheService;
- let workspaceId: string;
- const input = (): RecordExportDownload => ({
- id: v4(),
- createdAt: Date.now(),
- expiresAt: Date.now() + RECORD_EXPORT_DOWNLOAD_TTL_MS,
- fileId: v4(),
- processedRecordCount: 12,
- totalRecordCount: 12,
- workspaceId,
- userWorkspaceId: 'owner',
- workspaceMemberId: 'member',
- filename: 'person.csv',
- parameters: {
- objectMetadataId: 'person',
- fieldMetadataIds: [],
- filter: { id: { in: [] } },
- },
- });
- const recordKey = (id: string) => `{${workspaceId}}:download:${id}`;
- const leaseKey = () => `{${workspaceId}}:active`;
- const script = (source: string, keys: string[], args: string[] = []) =>
- cache.runScript<number>({
- script: { name: 'export-test', source },
- keys,
- args,
- });
-
- beforeAll(async () => {
- jest.useRealTimers();
- i18n.load('en', {});
- i18n.activate('en');
- await redis.connect();
- const store = redisInsStore(
- redis as Parameters<typeof redisInsStore>[0],
- {},
- );
- cache = new CacheStorageService(
- await caching(store),
- CacheStorageNamespace.EngineRecordExport,
- );
- exports = new RecordExportCacheService(cache);
- });
- beforeEach(() => {
- workspaceId = v4();
- });
- afterEach(async () => {
- jest.restoreAllMocks();
- await cache.flushByPattern(`{${workspaceId}}:*`);
- });
- afterAll(async () => {
- await redis.quit();
- });
-
- it('expires an abandoned connection and refuses to revive it', async () => {
- const recordExport = input();
- await exports.acquireLease(recordExport);
- const ttl = await script("return redis.call('PTTL', KEYS[1])", [
- leaseKey(),
- ]);
- expect(ttl).toBeGreaterThan(RECORD_EXPORT_CONNECTION_TTL_MS - 1000);
- await script("return redis.call('PEXPIRE', KEYS[1], 1)", [leaseKey()]);
- await setTimeout(20);
- expect(await exports.renewLease(recordExport)).toBe(false);
- expect(await exports.createDownload(recordExport)).toBe(false);
- });
-
- it('allows only one concurrent export in a workspace', async () => {
- const results = await Promise.allSettled([
- exports.acquireLease(input()),
- exports.acquireLease(input()),
- ]);
- expect(results.filter(({ status }) => status === 'fulfilled')).toHaveLength(
- 1,
- );
- const rejected = results.find((result) => result.status === 'rejected');
- expect(rejected?.reason).toBeInstanceOf(ConflictException);
- });
-
- it('renews the lease only from the connection heartbeat', async () => {
- const recordExport = input();
- await exports.acquireLease(recordExport);
- await script("return redis.call('PEXPIRE', KEYS[1], 2000)", [leaseKey()]);
- expect(await exports.isConnected(recordExport)).toBe(true);
- expect(
- await script("return redis.call('PTTL', KEYS[1])", [leaseKey()]),
- ).toBeLessThanOrEqual(2000);
- expect(await exports.renewLease(recordExport)).toBe(true);
- expect(
- await script("return redis.call('PTTL', KEYS[1])", [leaseKey()]),
- ).toBeGreaterThan(RECORD_EXPORT_CONNECTION_TTL_MS - 1000);
- });
-
- it('does not let an old connection renew or release a replacement lease', async () => {
- const oldExport = input();
- const replacement = input();
- await exports.acquireLease(oldExport);
- await exports.releaseLease(oldExport);
- await exports.acquireLease(replacement);
- expect(await exports.renewLease(oldExport)).toBe(false);
- await exports.delete(oldExport);
- expect(await exports.createDownload(oldExport)).toBe(false);
- expect(await exports.isConnected(replacement)).toBe(true);
- });
-
- it.each(['before', 'after'])(
- 'cannot publish a download %s cancellation',
- async (order) => {
- const recordExport = input();
- await exports.acquireLease(recordExport);
- if (order === 'before') {
- expect(await exports.createDownload(recordExport)).toBe(true);
- await exports.delete(recordExport);
- } else {
- await exports.delete(recordExport);
- expect(await exports.createDownload(recordExport)).toBe(false);
- }
- expect(await exports.findDownload(recordExport)).toBeUndefined();
- },
- );
-
- it('cannot publish a download during cancellation', async () => {
- const recordExport = input();
- await exports.acquireLease(recordExport);
- const del = cache.del.bind(cache);
- jest.spyOn(cache, 'del').mockImplementationOnce(async (key) => {
- expect(await exports.createDownload(recordExport)).toBe(false);
- return del(key);
- });
- await exports.delete(recordExport);
- expect(await exports.findDownload(recordExport)).toBeUndefined();
- });
-
- it('keeps a completed ticket for five minutes independently of the next export', async () => {
- const recordExport = input();
- await exports.acquireLease(recordExport);
- expect(await exports.createDownload(recordExport)).toBe(true);
- await exports.releaseLease(recordExport);
- const next = input();
- await exports.acquireLease(next);
- expect(await exports.findDownload(recordExport)).toEqual(recordExport);
- const ttl = await script("return redis.call('PTTL', KEYS[1])", [
- recordKey(recordExport.id),
- ]);
- expect(ttl).toBeGreaterThan(RECORD_EXPORT_DOWNLOAD_TTL_MS - 1000);
- expect(ttl).toBeLessThanOrEqual(RECORD_EXPORT_DOWNLOAD_TTL_MS);
- await script("return redis.call('PEXPIRE', KEYS[1], 1)", [
- recordKey(recordExport.id),
- ]);
- await setTimeout(20);
- expect(await exports.claimDownload(recordExport)).toBe(false);
- expect(await exports.isConnected(next)).toBe(true);
- });
-
- it('grants only one download claim and never grants a canceled ticket', async () => {
- const recordExport = input();
- await exports.acquireLease(recordExport);
- await exports.createDownload(recordExport);
- expect(
- (
- await Promise.all([
- exports.claimDownload(recordExport),
- exports.claimDownload(recordExport),
- ])
- ).sort(),
- ).toEqual([false, true]);
- await exports.delete(recordExport);
- expect(await exports.claimDownload(recordExport)).toBe(false);
- });
-});
diff --git a/packages/twenty-server/test/integration/record-export/record-export-file-cleanup.integration-spec.ts b/packages/twenty-server/test/integration/record-export/record-export-file-cleanup.integration-spec.ts
index 16ee18129a9..a8ca2ef7b90 100644
--- a/packages/twenty-server/test/integration/record-export/record-export-file-cleanup.integration-spec.ts
+++ b/packages/twenty-server/test/integration/record-export/record-export-file-cleanup.integration-spec.ts
@@ -40,7 +40,7 @@ describe('export file cleanup (integration)', () => {
applicationUniversalIdentifier:
TWENTY_STANDARD_APPLICATION_UNIVERSAL_IDENTIFIER,
fileFolder,
- resourcePath: `${v4()}/${id}.csv`,
+ resourcePath: `${id}.csv`,
};
await storage.createPendingFile({
...resource,
@@ -175,9 +175,9 @@ describe('export file cleanup (integration)', () => {
);
await exports.cancel({
workspaceId: SEED_APPLE_WORKSPACE_ID,
- id: file.resource.resourcePath.split('/')[0],
+ id: file.id,
});
- expect(await storage.checkFileExists(file.resource)).toBe(false);
+ expect(await storage.checkFileExists(file.resource)).toBe(true);
expect(
await globalThis.testDataSource.query(
'SELECT id FROM core.file WHERE id = $1',
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.ts
index eb9befde957..80f5470ac29 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,6 +1,18 @@
+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';
import { CacheStorageNamespace } from 'src/engine/core-modules/cache-storage/types/cache-storage-namespace.enum';
import { type CacheStorageService } from 'src/engine/core-modules/cache-storage/services/cache-storage.service';
-import { type RecordExportStreamWorkspaceService } from 'src/engine/core-modules/record-export/services/record-export-stream.workspace-service';
+import { type AccessTokenService } from 'src/engine/core-modules/auth/token/services/access-token.service';
+import { JwtTokenTypeEnum } from 'src/engine/core-modules/auth/types/jwt-token-type.enum';
+import { type JwtWrapperService } from 'src/engine/core-modules/jwt/services/jwt-wrapper.service';
+import { type UserSessionService } from 'src/engine/core-modules/user-session/services/user-session.service';
+import { USER_SESSION_COOKIE_NAME } from 'src/engine/core-modules/user-session/constants/user-session-cookie-name.constant';
+import { UserSessionRevokedReason } from 'src/engine/core-modules/user-session/types/user-session-revoked-reason.type';
+import { hashUserSessionToken } from 'src/engine/core-modules/user-session/utils/hash-user-session-token.util';
+import { isUserSessionToken } from 'src/engine/core-modules/user-session/utils/is-user-session-token.util';
+import { AuthProviderEnum } from 'src/engine/core-modules/workspace/types/workspace.type';
+import { upsertRowLevelPermissionPredicates } from 'test/integration/metadata/suites/row-level-permission-predicate/utils/upsert-row-level-permission-predicates.util';
import { updateFeatureFlag } from 'test/integration/metadata/suites/utils/update-feature-flag.util';
import { type FeatureFlagService } from 'src/engine/core-modules/feature-flag/services/feature-flag.service';
import { createClient } from 'graphql-sse';
@@ -33,14 +45,8 @@ import { getQueueToken } from 'src/engine/core-modules/message-queue/utils/get-q
import { type FileStorageService } from 'src/engine/core-modules/file-storage/services/file-storage.service';
import { type CreateRecordExportInput } from 'src/engine/core-modules/record-export/dtos/create-record-export.input';
import { type RecordExportDTO } from 'src/engine/core-modules/record-export/dtos/record-export.dto';
-import { RecordExportStatus } from 'src/engine/core-modules/record-export/enums/record-export-status.enum';
-import { type RecordExportCacheService } from 'src/engine/core-modules/record-export/services/record-export-cache.service';
-import { type RecordExportQueryWorkspaceService } from 'src/engine/core-modules/record-export/services/record-export-query.workspace-service';
import { type RecordExportWorkspaceService } from 'src/engine/core-modules/record-export/services/record-export.workspace-service';
-import {
- type RecordExport,
- type RecordExportDownload,
-} from 'src/engine/core-modules/record-export/types/record-export.type';
+import { type RecordExport } from 'src/engine/core-modules/record-export/types/record-export.type';
import { SEED_APPLE_WORKSPACE_ID } from 'src/engine/workspace-manager/dev-seeder/core/constants/seeder-workspaces.constant';
import { WORKSPACE_MEMBER_DATA_SEED_IDS } from 'src/engine/workspace-manager/dev-seeder/data/constants/workspace-member-data-seeds.constant';
@@ -63,14 +69,23 @@ const waitUntil = async (condition: () => Promise<boolean>) => {
describe('record export lifecycle (integration)', () => {
let input: CreateRecordExportInput;
let exports: RecordExportWorkspaceService;
- let cache: RecordExportCacheService;
+ let cache: CacheStorageService;
let storage: FileStorageService;
- let query: RecordExportQueryWorkspaceService;
+ let query: RecordExportWorkspaceService;
let originalRoleId: string;
let roleId: string;
let wasAsyncCsvExportEnabled: boolean;
const connections: ReturnType<typeof createClient>[] = [];
const exportIds = new Set<string>();
+ const downloadTokens = new Map<string, string>();
+ const sessionTokens = new Set<string>();
+ const authenticationHeaders = (token: string): Record<string, string> =>
+ isUserSessionToken(token)
+ ? {
+ Cookie: `${USER_SESSION_COOKIE_NAME}=${token}`,
+ Origin: `http://localhost:${APP_PORT}`,
+ }
+ : { Authorization: `Bearer ${token}` };
const subscribe = (
parameters = input,
@@ -78,14 +93,14 @@ describe('record export lifecycle (integration)', () => {
) => {
const connection = createClient({
url: `http://localhost:${APP_PORT}/metadata`,
- headers: { Authorization: `Bearer ${token}` },
+ headers: authenticationHeaders(token),
retryAttempts: 0,
});
connections.push(connection);
const events = connection.iterate<{ exportRecords: RecordExportDTO }>({
query: `subscription ExportRecords($input: CreateRecordExportInput!) {
exportRecords(input: $input) {
- id filename status processedRecordCount totalRecordCount downloadUrl errorMessage
+ id filename progress downloadUrl errorMessage
}
}`,
variables: { input: parameters },
@@ -111,11 +126,12 @@ describe('record export lifecycle (integration)', () => {
try {
while (true) {
const recordExport = await nextExport(events);
- if (recordExport.status === RecordExportStatus.FAILED) {
+ if (isDefined(recordExport.errorMessage)) {
throw new Error(recordExport.errorMessage ?? 'Export failed');
}
- if (recordExport.status === RecordExportStatus.COMPLETED) {
+ if (isDefined(recordExport.downloadUrl)) {
expect(recordExport.downloadUrl).toBeDefined();
+ downloadTokens.set(recordExport.id, token);
return recordExport;
}
}
@@ -124,19 +140,43 @@ describe('record export lifecycle (integration)', () => {
}
};
- const download = (recordExport: RecordExportDTO) => {
+ const download = (
+ recordExport: RecordExportDTO,
+ token = downloadTokens.get(recordExport.id) ??
+ APPLE_JANE_ADMIN_ACCESS_TOKEN,
+ ) => {
const url = new URL(recordExport.downloadUrl!);
- return client.get(url.pathname + url.search);
+ return client
+ .get(url.pathname + url.search)
+ .set(authenticationHeaders(token));
};
const getExport = (id: string) =>
exports.findOrThrow({ workspaceId: SEED_APPLE_WORKSPACE_ID, id });
- const fileExists = (recordExport: RecordExportDownload) =>
- storage.checkFileExists(
- exports.getFileResource({
- workspaceId: SEED_APPLE_WORKSPACE_ID,
- resourcePath: `${recordExport.id}/${recordExport.fileId}.csv`,
- }),
+ const fileResource = (resourcePath: string) => ({
+ workspaceId: SEED_APPLE_WORKSPACE_ID,
+ applicationUniversalIdentifier:
+ TWENTY_STANDARD_APPLICATION_UNIVERSAL_IDENTIFIER,
+ fileFolder: FileFolder.RecordExport,
+ resourcePath,
+ });
+ const fileExists = (file: { id: string }) =>
+ storage.checkFileExists(fileResource(`${file.id}.csv`));
+ const authorization = (
+ recordExport: RecordExportDTO,
+ ): Promise<RecordExportDownloadTokenJwtPayload> =>
+ getAppProviderByClassName<JwtWrapperService>(
+ 'JwtWrapperService',
+ ).verifyJwtToken(
+ new URL(recordExport.downloadUrl!).searchParams.get('token')!,
);
+ const isConnected = async ({
+ workspaceId,
+ id,
+ }: {
+ workspaceId: string;
+ id: string;
+ }) => (await cache.get<string>(`{${workspaceId}}:active`)) === id;
+
const changeRole = async (updatePayload: {
canAccessAllTools?: boolean;
canReadAllObjectRecords?: boolean;
@@ -161,9 +201,11 @@ describe('record export lifecycle (integration)', () => {
expectToFail: false,
});
exports = getAppProviderByClassName('RecordExportWorkspaceService');
- cache = getAppProviderByClassName('RecordExportCacheService');
+ cache = global.app.get<CacheStorageService>(
+ CacheStorageNamespace.EngineRecordExport,
+ );
storage = getAppProviderByClassName('FileStorageService');
- query = getAppProviderByClassName('RecordExportQueryWorkspaceService');
+ query = getAppProviderByClassName('RecordExportWorkspaceService');
const { objects } = await findManyObjectMetadata({
input: { filter: {}, paging: { first: 1000 } },
gqlFields: 'id nameSingular fieldsList { id name }',
@@ -212,7 +254,25 @@ describe('record export lifecycle (integration)', () => {
for (const id of exportIds)
await exports.cancel({ workspaceId: SEED_APPLE_WORKSPACE_ID, id });
exportIds.clear();
+ downloadTokens.clear();
+ const sessions =
+ getAppProviderByClassName<UserSessionService>('UserSessionService');
+ for (const token of sessionTokens) {
+ await sessions.revokeSessionByToken(
+ token,
+ UserSessionRevokedReason.UserSignOut,
+ );
+ }
+ sessionTokens.clear();
if (isDefined(roleId)) {
+ await upsertRowLevelPermissionPredicates({
+ input: {
+ roleId,
+ objectMetadataId: input.objectMetadataId,
+ predicates: [],
+ predicateGroups: [],
+ },
+ });
await changeRole({
canAccessAllTools: true,
canReadAllObjectRecords: true,
@@ -282,16 +342,12 @@ describe('record export lifecycle (integration)', () => {
and: [input.filter!, { not: { id: { eq: companies[0].id } } }],
},
});
- expect(recordExport.processedRecordCount).toBe(1004);
- expect(recordExport.totalRecordCount).toBe(1004);
+ expect(recordExport.progress).toBe(100);
const stored = await getExport(recordExport.id);
expect(await fileExists(stored)).toBe(true);
const [file] = await globalThis.testDataSource.query(
'SELECT id, status, size, "mimeType" FROM core.file WHERE "workspaceId" = $1 AND path = $2',
- [
- SEED_APPLE_WORKSPACE_ID,
- `${FileFolder.RecordExport}/${stored.id}/${stored.fileId}.csv`,
- ],
+ [SEED_APPLE_WORKSPACE_ID, `${FileFolder.RecordExport}/${stored.id}.csv`],
);
expect(file).toMatchObject({ status: 'UPLOADED', mimeType: 'text/csv' });
const response = await download(recordExport).expect(200);
@@ -315,12 +371,9 @@ describe('record export lifecycle (integration)', () => {
.join(''),
);
await waitUntil(async () => !(await fileExists(stored)));
- expect(
- await cache.findDownload({
- workspaceId: SEED_APPLE_WORKSPACE_ID,
- id: recordExport.id,
- }),
- ).toBeUndefined();
+ await expect(getExport(recordExport.id)).rejects.toThrow(
+ 'Export not found',
+ );
await download(recordExport).expect(404);
});
@@ -329,8 +382,7 @@ describe('record export lifecycle (integration)', () => {
...input,
filter: { id: { eq: v4() } },
});
- expect(recordExport.totalRecordCount).toBe(0);
- expect(recordExport.processedRecordCount).toBe(0);
+ expect(recordExport.progress).toBe(100);
const response = await download(recordExport).expect(200);
expect(response.text.replace(/^\uFEFF/, '')).toBe('Id,Name\n');
});
@@ -338,11 +390,11 @@ describe('record export lifecycle (integration)', () => {
it('cancels on a lost SSE connection and allows the next export', async () => {
const { connection, events } = subscribe();
const recordExport = await nextExport(events);
- expect(recordExport.status).not.toBe(RecordExportStatus.COMPLETED);
+ expect(recordExport.downloadUrl).toBeNull();
connection.dispose();
await waitUntil(
async () =>
- !(await cache.isConnected({
+ !(await isConnected({
workspaceId: SEED_APPLE_WORKSPACE_ID,
id: recordExport.id,
})),
@@ -366,11 +418,11 @@ describe('record export lifecycle (integration)', () => {
const first = subscribe();
try {
let progress = await nextExport(first.events);
- while (progress.processedRecordCount < 1000) {
+ while (progress.progress < 99) {
progress = await nextExport(first.events);
}
- expect(progress.status).toBe(RecordExportStatus.PROCESSING);
- expect(progress.totalRecordCount).toBe(companies.length);
+ expect(progress.progress).toBe(99);
+ expect(progress.downloadUrl).toBeNull();
const second = subscribe();
await expect(nextExport(second.events)).rejects.toThrow();
} finally {
@@ -381,8 +433,9 @@ describe('record export lifecycle (integration)', () => {
it('releases the workspace slot when the export queue cannot accept a job', async () => {
const completed = await exportToCompletion();
- const stored = await getExport(completed.id);
- const requester = await query.resolveRequester(stored);
+ const requester = await query.resolveRequester(
+ await authorization(completed),
+ );
const queue = global.app.get<MessageQueueService>(
getQueueToken(MessageQueue.recordExportQueue),
);
@@ -398,23 +451,21 @@ describe('record export lifecycle (integration)', () => {
.spyOn(queue, 'add')
.mockRejectedValueOnce(new Error('Queue unavailable'));
await expect(
- exports.enqueue(
- await exports.create({ parameters: input, authContext: requester }),
- ),
+ exports.stream({
+ parameters: input,
+ authContext: requester,
+ requestTokenHash: hashUserSessionToken(APPLE_JANE_ADMIN_ACCESS_TOKEN),
+ }),
).rejects.toThrow('Queue unavailable');
- expect(await cache.isConnected(failed!)).toBe(false);
- expect(await cache.findDownload(failed!)).toBeUndefined();
+ expect(await isConnected(failed!)).toBe(false);
+ await expect(getExport(failed!.id)).rejects.toThrow('Export not found');
const next = await exportToCompletion();
await download(next).expect(200);
});
it('renews the lease during queue handoff and paused event consumption', async () => {
const ready = await exportToCompletion();
- const requester = await query.resolveRequester(await getExport(ready.id));
- const streams =
- getAppProviderByClassName<RecordExportStreamWorkspaceService>(
- 'RecordExportStreamWorkspaceService',
- );
+ const requester = await query.resolveRequester(await authorization(ready));
const storageCache = global.app.get<CacheStorageService>(
CacheStorageNamespace.EngineRecordExport,
);
@@ -444,9 +495,10 @@ describe('record export lifecycle (integration)', () => {
await pageGate;
return readPage(args);
});
- const subscription = streams.stream({
+ const subscription = exports.stream({
parameters: input,
authContext: requester,
+ requestTokenHash: hashUserSessionToken(APPLE_JANE_ADMIN_ACCESS_TOKEN),
});
try {
const recordExport = await enqueueStarted;
@@ -460,7 +512,7 @@ describe('record export lifecycle (integration)', () => {
args: [],
});
await setTimeout(2500);
- expect(await cache.isConnected(recordExport)).toBe(true);
+ expect(await isConnected(recordExport)).toBe(true);
};
await assertLeaseSurvives();
releaseEnqueue();
@@ -468,7 +520,7 @@ describe('record export lifecycle (integration)', () => {
expect((await events.next()).done).toBe(false);
await assertLeaseSurvives();
await events.return?.();
- expect(await cache.isConnected(recordExport)).toBe(false);
+ expect(await isConnected(recordExport)).toBe(false);
} finally {
releaseEnqueue();
releasePage();
@@ -479,11 +531,7 @@ describe('record export lifecycle (integration)', () => {
it('retrieves completed worker output when the SSE consumer missed all progress', async () => {
const ready = await exportToCompletion();
- const requester = await query.resolveRequester(await getExport(ready.id));
- const streams =
- getAppProviderByClassName<RecordExportStreamWorkspaceService>(
- 'RecordExportStreamWorkspaceService',
- );
+ const requester = await query.resolveRequester(await authorization(ready));
const enqueue = exports.enqueue.bind(exports);
let recordExport: RecordExport;
let jobId: string;
@@ -493,21 +541,23 @@ describe('record export lifecycle (integration)', () => {
jobId = await enqueue(created);
return jobId;
});
- const events = await streams.stream({
+ const events = await exports.stream({
parameters: input,
authContext: requester,
+ requestTokenHash: hashUserSessionToken(APPLE_JANE_ADMIN_ACCESS_TOKEN),
});
try {
+ const queue = global.app.get<MessageQueueService>(
+ getQueueToken(MessageQueue.recordExportQueue),
+ );
await waitUntil(
async () =>
- (await exports.getProgress(recordExport, jobId)).status ===
- RecordExportStatus.COMPLETED,
+ (await queue.getJobs([jobId]))[jobId]?.state === 'completed',
);
- expect(await cache.findDownload(recordExport!)).toBeUndefined();
+ expect(await fileExists(await getExport(recordExport!.id))).toBe(true);
const completed = await events.next();
expect(completed.value).toMatchObject({
- status: RecordExportStatus.COMPLETED,
- processedRecordCount: companies.length,
+ progress: 100,
});
await download(completed.value).expect(200);
} finally {
@@ -515,6 +565,115 @@ describe('record export lifecycle (integration)', () => {
}
});
+ it.each([
+ {
+ progress: {
+ processedRecordCount: companies.length,
+ totalRecordCount: companies.length,
+ },
+ expectedProgress: 99,
+ },
+ {
+ progress: {
+ processedRecordCount: 'invalid',
+ totalRecordCount: companies.length,
+ errorMessage: 42,
+ },
+ expectedProgress: 0,
+ },
+ { progress: undefined, expectedProgress: 0 },
+ ])(
+ 'does not offer an uploaded file when its worker failed with progress $progress',
+ async ({ progress, expectedProgress }) => {
+ const ready = await exportToCompletion();
+ const queue = global.app.get<MessageQueueService>(
+ getQueueToken(MessageQueue.recordExportQueue),
+ );
+ const claims = await authorization(ready);
+ const recordExport: RecordExport = {
+ ...claims,
+ id: ready.id,
+ parameters: input,
+ createdAt: Date.now(),
+ };
+ jest.spyOn(queue, 'getJobs').mockResolvedValue({
+ job: {
+ id: 'job',
+ data: recordExport,
+ state: 'failed',
+ attemptsMade: 1,
+ timestamp: Date.now(),
+ progress,
+ },
+ });
+ const update = await exports.getProgress(recordExport, 'job');
+ expect(await fileExists(await getExport(ready.id))).toBe(true);
+ expect(update.downloadUrl).toBeUndefined();
+ expect(update.errorMessage).toContain('interrupted');
+ expect(update.progress).toBe(expectedProgress);
+ },
+ );
+
+ it('allows concurrent cleanup of the same completed export', async () => {
+ const ready = await exportToCompletion();
+ const identity = { workspaceId: SEED_APPLE_WORKSPACE_ID, id: ready.id };
+ await Promise.all([exports.cancel(identity), exports.cancel(identity)]);
+ expect(await fileExists(ready)).toBe(false);
+ await expect(getExport(ready.id)).rejects.toThrow('Export not found');
+ await expect(exports.cancel(identity)).resolves.toBeUndefined();
+ });
+
+ it('does not let cancellation of an older export release a newer connection', async () => {
+ const ready = await exportToCompletion();
+ const requester = await query.resolveRequester(await authorization(ready));
+ const current = await exports.create({
+ parameters: input,
+ authContext: requester,
+ requestTokenHash: hashUserSessionToken(APPLE_JANE_ADMIN_ACCESS_TOKEN),
+ });
+ exportIds.add(current.id);
+ await exports.cancel({
+ workspaceId: SEED_APPLE_WORKSPACE_ID,
+ id: ready.id,
+ });
+ expect(await isConnected(current)).toBe(true);
+ await exports.cancel(current);
+ expect(await isConnected(current)).toBe(false);
+ });
+
+ it('closes the subscription when its connection lease expires', async () => {
+ const ready = await exportToCompletion();
+ const requester = await query.resolveRequester(await authorization(ready));
+ const create = exports.create.bind(exports);
+ let created: RecordExport;
+ jest.spyOn(exports, 'create').mockImplementation(async (args) => {
+ created = await create(args);
+ exportIds.add(created.id);
+ return created;
+ });
+ jest.spyOn(exports, 'enqueue').mockResolvedValue('not-started');
+ const events = await exports.stream({
+ parameters: input,
+ authContext: requester,
+ requestTokenHash: hashUserSessionToken(APPLE_JANE_ADMIN_ACCESS_TOKEN),
+ });
+ try {
+ await cache.runScript({
+ script: {
+ name: 'expire-export-test-lease',
+ source: "return redis.call('PEXPIRE', KEYS[1], 1)",
+ },
+ keys: [`{${SEED_APPLE_WORKSPACE_ID}}:active`],
+ args: [],
+ });
+ await setTimeout(1500);
+ expect(await isConnected(created!)).toBe(false);
+ await expect(events.next()).rejects.toThrow('export was interrupted');
+ } finally {
+ await events.return?.();
+ }
+ });
+
it('allows only one download while the file is being opened', async () => {
const recordExport = await exportToCompletion();
const stored = await getExport(recordExport.id);
@@ -553,7 +712,7 @@ describe('record export lifecycle (integration)', () => {
.spyOn(storage, 'readFile')
.mockRejectedValueOnce(new Error('Storage unavailable'));
await download(recordExport).expect(500);
- expect(await cache.findDownload(stored)).toBeUndefined();
+ await expect(getExport(stored.id)).rejects.toThrow('Export not found');
expect(await fileExists(stored)).toBe(false);
});
@@ -561,9 +720,13 @@ describe('record export lifecycle (integration)', () => {
const recordExport = await exportToCompletion();
const url = new URL(recordExport.downloadUrl!);
await client
- .get(`/record-exports/${v4()}/download${url.search}`)
+ .get(`/file/record-export/${v4()}${url.search}`)
+ .set(authenticationHeaders(APPLE_JANE_ADMIN_ACCESS_TOKEN))
+ .expect(403);
+ await client
+ .get(`${url.pathname}?token=invalid`)
+ .set(authenticationHeaders(APPLE_JANE_ADMIN_ACCESS_TOKEN))
.expect(403);
- await client.get(`${url.pathname}?token=invalid`).expect(403);
await download(recordExport).expect(200);
});
@@ -617,38 +780,50 @@ describe('record export lifecycle (integration)', () => {
}
});
- it('stops generation when export permission is revoked between pages', async () => {
- const readPage = query.readPage.bind(query);
- let releasePage = () => {};
- let notifyPage = () => {};
- const pageGate = new Promise<void>((resolve) => {
- releasePage = resolve;
- });
- const pageStarted = new Promise<void>((resolve) => {
- notifyPage = resolve;
- });
- jest.spyOn(query, 'readPage').mockImplementation(async (...args) => {
- if (!isDefined(args[0].after) && !isDefined(args[0].first)) {
- notifyPage();
- await pageGate;
- }
- return readPage(...args);
- });
- const { events } = subscribe(input, APPLE_JONY_MEMBER_ACCESS_TOKEN);
- try {
- let recordExport = await nextExport(events);
- await pageStarted;
- await changeRole({ canAccessAllTools: false });
- releasePage();
- while (recordExport.status !== RecordExportStatus.FAILED) {
- recordExport = await nextExport(events);
+ it.each(['export', 'row'])(
+ 'stops generation when %s permission changes between pages',
+ async (permission) => {
+ const readPage = query.readPage.bind(query);
+ let releasePage = () => {};
+ let notifyPage = () => {};
+ const pageGate = new Promise<void>((resolve) => {
+ releasePage = resolve;
+ });
+ const pageStarted = new Promise<void>((resolve) => {
+ notifyPage = resolve;
+ });
+ jest.spyOn(query, 'readPage').mockImplementation(async (...args) => {
+ if (isDefined(args[0].after)) {
+ notifyPage();
+ await pageGate;
+ }
+ return readPage(...args);
+ });
+ const { events } = subscribe(input, APPLE_JONY_MEMBER_ACCESS_TOKEN);
+ try {
+ let recordExport = await nextExport(events);
+ await pageStarted;
+ if (permission === 'export') {
+ await changeRole({ canAccessAllTools: false });
+ } else {
+ await upsertContainsRlsPredicate({
+ roleId,
+ objectNameSingular: 'company',
+ fieldName: 'name',
+ value: companies[0].name,
+ });
+ }
+ releasePage();
+ while (!isDefined(recordExport.errorMessage)) {
+ recordExport = await nextExport(events);
+ }
+ expect(recordExport.downloadUrl).toBeNull();
+ expect(recordExport.progress).toBeLessThan(100);
+ } finally {
+ releasePage();
}
- expect(recordExport.downloadUrl).toBeNull();
- expect(recordExport.processedRecordCount).toBeLessThan(companies.length);
- } finally {
- releasePage();
- }
- });
+ },
+ );
it('applies row permissions to both the count and the exported records', async () => {
await upsertContainsRlsPredicate({
@@ -661,8 +836,7 @@ describe('record export lifecycle (integration)', () => {
input,
APPLE_JONY_MEMBER_ACCESS_TOKEN,
);
- expect(recordExport.totalRecordCount).toBe(1);
- expect(recordExport.processedRecordCount).toBe(1);
+ expect(recordExport.progress).toBe(100);
const response = await download(recordExport).expect(200);
expect(response.text.replace(/^\uFEFF/, '')).toBe(
`Id,Name\n${companies[0].id},${companies[0].name}\n`,
@@ -695,7 +869,7 @@ describe('record export lifecycle (integration)', () => {
});
const { events } = subscribe();
let recordExport = await nextExport(events);
- while (recordExport.status !== RecordExportStatus.FAILED) {
+ while (!isDefined(recordExport.errorMessage)) {
recordExport = await nextExport(events);
}
expect(recordExport.downloadUrl).toBeNull();
@@ -707,14 +881,9 @@ describe('record export lifecycle (integration)', () => {
[pendingFile!.id],
),
).toEqual([]);
- expect(
- await storage.checkFileExists(
- exports.getFileResource({
- workspaceId: SEED_APPLE_WORKSPACE_ID,
- resourcePath: partialFilePath!,
- }),
- ),
- ).toBe(false);
+ expect(await storage.checkFileExists(fileResource(partialFilePath!))).toBe(
+ false,
+ );
});
it('cleans up a download when the storage stream fails', async () => {
@@ -730,11 +899,204 @@ describe('record export lifecycle (integration)', () => {
);
await expect(download(recordExport)).rejects.toThrow();
await waitUntil(async () => !(await fileExists(stored)));
- expect(
- await cache.findDownload({
- workspaceId: SEED_APPLE_WORKSPACE_ID,
- id: stored.id,
- }),
- ).toBeUndefined();
+ await expect(getExport(stored.id)).rejects.toThrow('Export not found');
+ });
+
+ it('requires the exact requesting token without consuming the file on denied requests', async () => {
+ const recordExport = await exportToCompletion();
+ const stored = await getExport(recordExport.id);
+ const url = new URL(recordExport.downloadUrl!);
+ const requester = await query.resolveRequester(
+ await authorization(recordExport),
+ );
+ const tokens =
+ getAppProviderByClassName<AccessTokenService>('AccessTokenService');
+ const otherToken = await tokens.generateAccessToken({
+ userId: requester.user.id,
+ workspaceId: requester.workspace.id,
+ authProvider: AuthProviderEnum.Password,
+ });
+
+ await client.get(url.pathname + url.search).expect(403);
+ await download(recordExport, APPLE_JONY_MEMBER_ACCESS_TOKEN).expect(403);
+ await download(recordExport, otherToken.token).expect(403);
+ expect(await getExport(recordExport.id)).toEqual(stored);
+ expect(await fileExists(stored)).toBe(true);
+ await download(recordExport).expect(200);
});
+
+ it.each([false, true])(
+ 'requires the originating cookie session, revoked: %s',
+ async (isRevoked) => {
+ const ready = await exportToCompletion();
+ const requester = await query.resolveRequester(
+ await authorization(ready),
+ );
+ const sessions =
+ getAppProviderByClassName<UserSessionService>('UserSessionService');
+ const createSession = async () => {
+ const { sessionToken } = await sessions.createSession({
+ userId: requester.user.id,
+ workspaceId: requester.workspace.id,
+ userWorkspaceId: requester.userWorkspaceId,
+ authProvider: AuthProviderEnum.Password,
+ origin: 'renewal_bridge',
+ });
+ sessionTokens.add(sessionToken);
+ return sessionToken;
+ };
+ const sessionToken = await createSession();
+ const otherSessionToken = await createSession();
+ const recordExport = await exportToCompletion(input, sessionToken);
+
+ await download(recordExport, otherSessionToken).expect(403);
+ await download(recordExport, APPLE_JANE_ADMIN_ACCESS_TOKEN).expect(403);
+ if (isRevoked) {
+ await sessions.revokeSessionByToken(
+ sessionToken,
+ UserSessionRevokedReason.UserSignOut,
+ );
+ }
+ await download(recordExport).expect(isRevoked ? 403 : 200);
+ },
+ );
+
+ it.each(['file-token', 'expired-export-token'])(
+ 'rejects a signed %s',
+ async (tokenKind) => {
+ const recordExport = await exportToCompletion();
+ const stored = await getExport(recordExport.id);
+ const jwt =
+ getAppProviderByClassName<JwtWrapperService>('JwtWrapperService');
+ const payload = {
+ type: JwtTokenTypeEnum.FILE as const,
+ sub: SEED_APPLE_WORKSPACE_ID,
+ workspaceId: SEED_APPLE_WORKSPACE_ID,
+ fileId: stored.id,
+ ...(tokenKind === 'expired-export-token'
+ ? {
+ purpose: 'record-export',
+ userWorkspaceId: (await authorization(recordExport))
+ .userWorkspaceId,
+ }
+ : {}),
+ };
+ const token = await jwt.signAsyncOrThrow(payload, {
+ expiresIn: tokenKind === 'expired-export-token' ? -1 : 60,
+ });
+ const url = new URL(recordExport.downloadUrl!);
+ await client
+ .get(`${url.pathname}?token=${token}`)
+ .set(authenticationHeaders(APPLE_JANE_ADMIN_ACCESS_TOKEN))
+ .expect(403);
+ await download(recordExport).expect(200);
+ },
+ );
+
+ it.each([
+ ['before-download', false],
+ ['during-storage-open', false],
+ ['before-download', true],
+ ['during-storage-open', true],
+ ] as const)(
+ 'invalidates the file when row permissions change %s, cleanup fails: %s',
+ async (when, cleanupFails) => {
+ const recordExport = await exportToCompletion(
+ {
+ ...input,
+ filter: { id: { in: companies.slice(0, 2).map(({ id }) => id) } },
+ },
+ APPLE_JONY_MEMBER_ACCESS_TOKEN,
+ );
+ const stored = await getExport(recordExport.id);
+ expect(recordExport.progress).toBe(100);
+ const restrictRows = () =>
+ upsertContainsRlsPredicate({
+ roleId,
+ objectNameSingular: 'company',
+ fieldName: 'name',
+ value: companies[0].name,
+ });
+ if (when === 'during-storage-open') {
+ const readFile = storage.readFile.bind(storage);
+ jest
+ .spyOn(storage, 'readFile')
+ .mockImplementationOnce(async (resource) => {
+ await restrictRows();
+ return readFile(resource);
+ });
+ } else {
+ await restrictRows();
+ }
+ if (cleanupFails) {
+ jest
+ .spyOn(storage, 'deleteFile')
+ .mockRejectedValueOnce(new Error('Storage deletion unavailable'));
+ }
+ const response = await download(recordExport).expect(403);
+ expect(response.text).not.toContain(companies[1].id);
+ if (cleanupFails) {
+ expect(await fileExists(stored)).toBe(true);
+ await globalThis.testDataSource.query(
+ 'UPDATE core.file SET "createdAt" = $3 WHERE "workspaceId" = $1 AND path = $2',
+ [
+ stored.workspaceId,
+ `${FileFolder.RecordExport}/${stored.id}.csv`,
+ new Date(Date.now() - 61 * 60_000),
+ ],
+ );
+ const cleanup = getAppProviderByClassName<PendingFileCleanupCronJob>(
+ 'PendingFileCleanupCronJob',
+ );
+ await cleanup.handle();
+ }
+ expect(await fileExists(stored)).toBe(false);
+ },
+ );
+
+ it.each(['access-check', 'token-signing'])(
+ 'rejects URL issuance when row permissions change during %s',
+ async (when) => {
+ const ready = await exportToCompletion(
+ input,
+ APPLE_JONY_MEMBER_ACCESS_TOKEN,
+ );
+ const stored = await getExport(ready.id);
+ const claims = await authorization(ready);
+ const restrictRows = () =>
+ upsertContainsRlsPredicate({
+ roleId,
+ objectNameSingular: 'company',
+ fieldName: 'name',
+ value: companies[0].name,
+ });
+ if (when === 'access-check') {
+ const resolveRequester = query.resolveRequester.bind(query);
+ jest
+ .spyOn(query, 'resolveRequester')
+ .mockImplementationOnce(async (args) => {
+ const result = await resolveRequester(args);
+ await restrictRows();
+ return result;
+ });
+ } else {
+ const jwt =
+ getAppProviderByClassName<JwtWrapperService>('JwtWrapperService');
+ const sign = jwt.signAsyncOrThrow.bind(jwt);
+ jest
+ .spyOn(jwt, 'signAsyncOrThrow')
+ .mockImplementationOnce(async (...args) => {
+ const result = await sign(...args);
+ await restrictRows();
+ return result;
+ });
+ }
+ await expect(
+ exports.getDownloadUrl({ ...claims, id: stored.id }),
+ ).rejects.toThrow('Access permissions have changed');
+ await download(ready).expect(403);
+ await expect(getExport(stored.id)).rejects.toThrow('Export not found');
+ expect(await fileExists(stored)).toBe(false);
+ },
+ );
});