Skip to content

The open alternative to Salesforce, designed for AI.

perf(twenty-server): drive immutable file caching from fileFolderConfigs on both serving paths (#22510)

Félix Malfait8156bf2b89e9
diff --git a/packages/twenty-server/src/engine/core-modules/file-storage/drivers/__tests__/s3.driver.spec.ts b/packages/twenty-server/src/engine/core-modules/file-storage/drivers/__tests__/s3.driver.spec.ts
index e899b4d35c2..26106d14936 100644
--- a/packages/twenty-server/src/engine/core-modules/file-storage/drivers/__tests__/s3.driver.spec.ts
+++ b/packages/twenty-server/src/engine/core-modules/file-storage/drivers/__tests__/s3.driver.spec.ts
@@ -51,6 +51,7 @@ describe('S3Driver.getPresignedUrl', () => {
filePath: 'file.png',
responseContentType: 'image/png',
responseContentDisposition: 'inline',
+ responseCacheControl: 'private, max-age=86400, immutable',
});
expect(result).toBe(
@@ -61,6 +62,12 @@ describe('S3Driver.getPresignedUrl', () => {
expect.any(GetObjectCommand),
{ expiresIn: 900 },
);
+
+ const command = (getSignedUrl as jest.Mock).mock.calls[0][1];
+
+ expect(command.input.ResponseCacheControl).toBe(
+ 'private, max-age=86400, immutable',
+ );
});
it('should presign with a separate client when endpoint override is provided', async () => {
diff --git a/packages/twenty-server/src/engine/core-modules/file-storage/drivers/interfaces/storage-driver.interface.ts b/packages/twenty-server/src/engine/core-modules/file-storage/drivers/interfaces/storage-driver.interface.ts
index f4aee0b57a8..7f81bbb2524 100644
--- a/packages/twenty-server/src/engine/core-modules/file-storage/drivers/interfaces/storage-driver.interface.ts
+++ b/packages/twenty-server/src/engine/core-modules/file-storage/drivers/interfaces/storage-driver.interface.ts
@@ -40,5 +40,6 @@ export interface StorageDriver {
expiresInSeconds?: number;
responseContentType?: string;
responseContentDisposition?: string;
+ responseCacheControl?: string;
}): Promise<string | null>;
}
diff --git a/packages/twenty-server/src/engine/core-modules/file-storage/drivers/s3.driver.ts b/packages/twenty-server/src/engine/core-modules/file-storage/drivers/s3.driver.ts
index 51ad265635e..d7b715234c1 100644
--- a/packages/twenty-server/src/engine/core-modules/file-storage/drivers/s3.driver.ts
+++ b/packages/twenty-server/src/engine/core-modules/file-storage/drivers/s3.driver.ts
@@ -385,6 +385,7 @@ export class S3Driver implements StorageDriver {
expiresInSeconds?: number;
responseContentType?: string;
responseContentDisposition?: string;
+ responseCacheControl?: string;
}): Promise<string | null> {
if (!this.presignClient) {
return null;
@@ -395,6 +396,7 @@ export class S3Driver implements StorageDriver {
Key: params.filePath,
ResponseContentType: params.responseContentType,
ResponseContentDisposition: params.responseContentDisposition,
+ ResponseCacheControl: params.responseCacheControl,
});
return getSignedUrl(this.presignClient, command, {
diff --git a/packages/twenty-server/src/engine/core-modules/file-storage/drivers/validated-storage.driver.ts b/packages/twenty-server/src/engine/core-modules/file-storage/drivers/validated-storage.driver.ts
index f36e9440982..25e66aa06ee 100644
--- a/packages/twenty-server/src/engine/core-modules/file-storage/drivers/validated-storage.driver.ts
+++ b/packages/twenty-server/src/engine/core-modules/file-storage/drivers/validated-storage.driver.ts
@@ -104,6 +104,7 @@ export class ValidatedStorageDriver implements StorageDriver {
expiresInSeconds?: number;
responseContentType?: string;
responseContentDisposition?: string;
+ responseCacheControl?: string;
}): Promise<string | null> {
assertStoragePathIsSafe(params.filePath);
diff --git a/packages/twenty-server/src/engine/core-modules/file-storage/file-storage.service.ts b/packages/twenty-server/src/engine/core-modules/file-storage/file-storage.service.ts
index 2a504344d8b..bc2d901765a 100644
--- a/packages/twenty-server/src/engine/core-modules/file-storage/file-storage.service.ts
+++ b/packages/twenty-server/src/engine/core-modules/file-storage/file-storage.service.ts
@@ -192,6 +192,7 @@ export class FileStorageService {
expiresInSeconds?: number;
responseContentType?: string;
responseContentDisposition?: string;
+ responseCacheControl?: string;
},
): Promise<string | null> {
const driver = this.fileStorageDriverFactory.getCurrentDriver();
@@ -203,6 +204,7 @@ export class FileStorageService {
expiresInSeconds: params.expiresInSeconds,
responseContentType: params.responseContentType,
responseContentDisposition: params.responseContentDisposition,
+ responseCacheControl: params.responseCacheControl,
});
}
diff --git a/packages/twenty-server/src/engine/core-modules/file/interfaces/file-folder.interface.ts b/packages/twenty-server/src/engine/core-modules/file/interfaces/file-folder.interface.ts
index 438e2498ba1..848eb94a7fd 100644
--- a/packages/twenty-server/src/engine/core-modules/file/interfaces/file-folder.interface.ts
+++ b/packages/twenty-server/src/engine/core-modules/file/interfaces/file-folder.interface.ts
@@ -9,62 +9,83 @@ registerEnumType(FileFolder, {
export type FileFolderConfig = {
ignoreExpirationToken: boolean;
+ immutable: boolean;
};
+export const IMMUTABLE_FILE_CACHE_CONTROL = 'private, max-age=86400, immutable';
+
export const fileFolderConfigs: Record<FileFolder, FileFolderConfig> = {
[FileFolder.ProfilePicture]: {
ignoreExpirationToken: true,
+ immutable: false,
},
[FileFolder.WorkspaceLogo]: {
ignoreExpirationToken: true,
+ immutable: false,
},
[FileFolder.Attachment]: {
ignoreExpirationToken: false,
+ immutable: false,
},
[FileFolder.PersonPicture]: {
ignoreExpirationToken: false,
+ immutable: false,
},
[FileFolder.CorePicture]: {
ignoreExpirationToken: true,
+ immutable: true,
},
[FileFolder.File]: {
ignoreExpirationToken: false,
+ immutable: false,
},
[FileFolder.AgentChat]: {
ignoreExpirationToken: false,
+ immutable: true,
},
[FileFolder.BuiltLogicFunction]: {
ignoreExpirationToken: false,
+ immutable: false,
},
[FileFolder.BuiltFrontComponent]: {
ignoreExpirationToken: false,
+ immutable: false,
},
[FileFolder.PublicAsset]: {
ignoreExpirationToken: true,
+ immutable: false,
},
[FileFolder.Source]: {
ignoreExpirationToken: false,
+ immutable: false,
},
[FileFolder.FilesField]: {
ignoreExpirationToken: false,
+ immutable: true,
},
[FileFolder.Dependencies]: {
ignoreExpirationToken: false,
+ immutable: false,
},
[FileFolder.Workflow]: {
ignoreExpirationToken: false,
+ immutable: true,
},
[FileFolder.EmailAttachment]: {
ignoreExpirationToken: false,
+ immutable: true,
},
[FileFolder.AppTarball]: {
ignoreExpirationToken: false,
+ immutable: false,
},
[FileFolder.GeneratedSdkClient]: {
ignoreExpirationToken: false,
+ immutable: false,
},
[FileFolder.Dpa]: {
ignoreExpirationToken: false,
+ immutable: true,
},
};
diff --git a/packages/twenty-server/src/engine/core-modules/file/services/file.service.ts b/packages/twenty-server/src/engine/core-modules/file/services/file.service.ts
index 3bdc7f7f962..8ac628545b1 100644
--- a/packages/twenty-server/src/engine/core-modules/file/services/file.service.ts
+++ b/packages/twenty-server/src/engine/core-modules/file/services/file.service.ts
@@ -13,6 +13,10 @@ import {
FileStorageExceptionCode,
} from 'src/engine/core-modules/file-storage/interfaces/file-storage-exception';
import { FileEntity } from 'src/engine/core-modules/file/entities/file.entity';
+import {
+ fileFolderConfigs,
+ IMMUTABLE_FILE_CACHE_CONTROL,
+} from 'src/engine/core-modules/file/interfaces/file-folder.interface';
import { type FileResponse } from 'src/engine/core-modules/file/types/file-response.type';
import { getContentDisposition } from 'src/engine/core-modules/file/utils/get-content-disposition.utils';
import { removeFileFolderFromFileEntityPath } from 'src/engine/core-modules/file/utils/remove-file-folder-from-file-entity-path.utils';
@@ -209,6 +213,9 @@ export class FileService {
),
responseContentType: mimeType,
responseContentDisposition: getContentDisposition(mimeType),
+ responseCacheControl: fileFolderConfigs[fileFolder].immutable
+ ? IMMUTABLE_FILE_CACHE_CONTROL
+ : undefined,
});
if (presignedUrl) {
diff --git a/packages/twenty-server/src/engine/core-modules/file/utils/__tests__/set-file-response-headers.utils.spec.ts b/packages/twenty-server/src/engine/core-modules/file/utils/__tests__/set-file-response-headers.utils.spec.ts
index 7d9ceef3967..86e449af1c1 100644
--- a/packages/twenty-server/src/engine/core-modules/file/utils/__tests__/set-file-response-headers.utils.spec.ts
+++ b/packages/twenty-server/src/engine/core-modules/file/utils/__tests__/set-file-response-headers.utils.spec.ts
@@ -86,38 +86,44 @@ describe('setFileResponseHeaders', () => {
);
});
- it('should set an immutable Cache-Control for the CorePicture folder', () => {
- const res = createMockResponse();
-
- setFileResponseHeaders(res as any, 'image/png', FileFolder.CorePicture);
-
- expect(res.setHeader).toHaveBeenCalledWith(
- 'Cache-Control',
- 'private, max-age=86400, immutable',
- );
- });
-
it.each([
- FileFolder.ProfilePicture,
- FileFolder.WorkspaceLogo,
- FileFolder.PersonPicture,
+ FileFolder.CorePicture,
FileFolder.FilesField,
- FileFolder.Attachment,
FileFolder.Workflow,
- FileFolder.PublicAsset,
+ FileFolder.AgentChat,
+ FileFolder.EmailAttachment,
+ FileFolder.Dpa,
])(
- 'should not set Cache-Control for non-cacheable folder %s',
+ 'should set an immutable Cache-Control for immutable folder %s',
(fileFolder) => {
const res = createMockResponse();
setFileResponseHeaders(res as any, 'image/png', fileFolder);
- expect(res.setHeader).not.toHaveBeenCalledWith(
+ expect(res.setHeader).toHaveBeenCalledWith(
'Cache-Control',
- expect.anything(),
+ 'private, max-age=86400, immutable',
);
},
);
+
+ it.each([
+ FileFolder.ProfilePicture,
+ FileFolder.WorkspaceLogo,
+ FileFolder.PersonPicture,
+ FileFolder.Attachment,
+ FileFolder.PublicAsset,
+ FileFolder.AppTarball,
+ ])('should not set Cache-Control for mutable folder %s', (fileFolder) => {
+ const res = createMockResponse();
+
+ setFileResponseHeaders(res as any, 'image/png', fileFolder);
+
+ expect(res.setHeader).not.toHaveBeenCalledWith(
+ 'Cache-Control',
+ expect.anything(),
+ );
+ });
});
describe('getContentDisposition', () => {
diff --git a/packages/twenty-server/src/engine/core-modules/file/utils/set-file-response-headers.utils.ts b/packages/twenty-server/src/engine/core-modules/file/utils/set-file-response-headers.utils.ts
index 124af593168..c87be51b171 100644
--- a/packages/twenty-server/src/engine/core-modules/file/utils/set-file-response-headers.utils.ts
+++ b/packages/twenty-server/src/engine/core-modules/file/utils/set-file-response-headers.utils.ts
@@ -3,12 +3,12 @@ import { type Response } from 'express';
import { FileFolder } from 'twenty-shared/types';
import { isDefined } from 'twenty-shared/utils';
+import {
+ fileFolderConfigs,
+ IMMUTABLE_FILE_CACHE_CONTROL,
+} from 'src/engine/core-modules/file/interfaces/file-folder.interface';
import { getContentDisposition } from 'src/engine/core-modules/file/utils/get-content-disposition.utils';
-const CACHEABLE_PICTURE_FILE_FOLDERS: FileFolder[] = [FileFolder.CorePicture];
-
-const PICTURE_CACHE_CONTROL = 'private, max-age=86400, immutable';
-
export const setFileResponseHeaders = (
res: Response,
mimeType: string,
@@ -20,10 +20,7 @@ export const setFileResponseHeaders = (
res.setHeader('X-Content-Type-Options', 'nosniff');
res.setHeader('Content-Disposition', getContentDisposition(contentType));
- if (
- isDefined(fileFolder) &&
- CACHEABLE_PICTURE_FILE_FOLDERS.includes(fileFolder)
- ) {
- res.setHeader('Cache-Control', PICTURE_CACHE_CONTROL);
+ if (isDefined(fileFolder) && fileFolderConfigs[fileFolder].immutable) {
+ res.setHeader('Cache-Control', IMMUTABLE_FILE_CACHE_CONTROL);
}
};