Skip to content

The open alternative to Salesforce, designed for AI.

feat(application): deploy app tarballs straight to file storage (#26314)

martmullcd0d84def040
diff --git a/packages/twenty-client-sdk/src/metadata/generated/schema.graphql b/packages/twenty-client-sdk/src/metadata/generated/schema.graphql
index 1a03d866b4f..1ddeaf2a9f6 100644
--- a/packages/twenty-client-sdk/src/metadata/generated/schema.graphql
+++ b/packages/twenty-client-sdk/src/metadata/generated/schema.graphql
@@ -4087,7 +4087,8 @@ type Mutation {
createApplicationRegistrationVariable(input: CreateApplicationRegistrationVariableInput!): ApplicationRegistrationVariable!
updateApplicationRegistrationVariable(input: UpdateApplicationRegistrationVariableInput!): ApplicationRegistrationVariable!
deleteApplicationRegistrationVariable(id: String!): Boolean!
- uploadAppTarball(file: Upload!, universalIdentifier: String @deprecated(reason: "Ignored: the application universalIdentifier is read from the tarball manifest.")): ApplicationRegistration!
+ completeAppTarballUpload(fileId: UUID!): ApplicationRegistration!
+ uploadAppTarball(file: Upload!, universalIdentifier: String @deprecated(reason: "Ignored: the application universalIdentifier is read from the tarball manifest.")): ApplicationRegistration! @deprecated(reason: "Use createFileUpload with the AppTarball folder and completeAppTarballUpload, which send the tarball straight to file storage.")
claimApplicationRegistrationOwnership(applicationRegistrationId: String!): ApplicationRegistration!
transferApplicationRegistrationOwnership(applicationRegistrationId: String!, targetWorkspaceSubdomain: String!): ApplicationRegistration!
grantApplicationCapabilities(input: GrantApplicationCapabilitiesInput!): ApplicationCapabilityGrant!
diff --git a/packages/twenty-client-sdk/src/metadata/generated/schema.ts b/packages/twenty-client-sdk/src/metadata/generated/schema.ts
index f82e02003a2..e8a01b850f3 100644
--- a/packages/twenty-client-sdk/src/metadata/generated/schema.ts
+++ b/packages/twenty-client-sdk/src/metadata/generated/schema.ts
@@ -3503,6 +3503,8 @@ export interface Mutation {
createApplicationRegistrationVariable: ApplicationRegistrationVariable
updateApplicationRegistrationVariable: ApplicationRegistrationVariable
deleteApplicationRegistrationVariable: Scalars['Boolean']
+ completeAppTarballUpload: ApplicationRegistration
+ /** @deprecated Use createFileUpload with the AppTarball folder and completeAppTarballUpload, which send the tarball straight to file storage. */
uploadAppTarball: ApplicationRegistration
claimApplicationRegistrationOwnership: ApplicationRegistration
transferApplicationRegistrationOwnership: ApplicationRegistration
@@ -7347,6 +7349,8 @@ export interface MutationGenqlSelection{
createApplicationRegistrationVariable?: (ApplicationRegistrationVariableGenqlSelection & { __args: {input: CreateApplicationRegistrationVariableInput} })
updateApplicationRegistrationVariable?: (ApplicationRegistrationVariableGenqlSelection & { __args: {input: UpdateApplicationRegistrationVariableInput} })
deleteApplicationRegistrationVariable?: { __args: {id: Scalars['String']} }
+ completeAppTarballUpload?: (ApplicationRegistrationGenqlSelection & { __args: {fileId: Scalars['UUID']} })
+ /** @deprecated Use createFileUpload with the AppTarball folder and completeAppTarballUpload, which send the tarball straight to file storage. */
uploadAppTarball?: (ApplicationRegistrationGenqlSelection & { __args: {file: Scalars['Upload'], universalIdentifier?: (Scalars['String'] | null)} })
claimApplicationRegistrationOwnership?: (ApplicationRegistrationGenqlSelection & { __args: {applicationRegistrationId: Scalars['String']} })
transferApplicationRegistrationOwnership?: (ApplicationRegistrationGenqlSelection & { __args: {applicationRegistrationId: Scalars['String'], targetWorkspaceSubdomain: Scalars['String']} })
diff --git a/packages/twenty-client-sdk/src/metadata/generated/types.ts b/packages/twenty-client-sdk/src/metadata/generated/types.ts
index 1c17e03c161..2f550d2c2a4 100644
--- a/packages/twenty-client-sdk/src/metadata/generated/types.ts
+++ b/packages/twenty-client-sdk/src/metadata/generated/types.ts
@@ -9567,6 +9567,15 @@ export default {
]
}
],
+ "completeAppTarballUpload": [
+ 76,
+ {
+ "fileId": [
+ 3,
+ "UUID!"
+ ]
+ }
+ ],
"uploadAppTarball": [
76,
{
diff --git a/packages/twenty-docs/developers/extend/apps/operations/publishing.mdx b/packages/twenty-docs/developers/extend/apps/operations/publishing.mdx
index e2f6778b236..3bbd46c69cd 100644
--- a/packages/twenty-docs/developers/extend/apps/operations/publishing.mdx
+++ b/packages/twenty-docs/developers/extend/apps/operations/publishing.mdx
@@ -77,7 +77,7 @@ The share link uses the server's base URL (without any workspace subdomain) so i
### Version management
-When updating an already deployed tarball app, the server requires the `version` in `package.json` to be **strictly higher** (per [semver](https://semver.org) ordering) than the currently deployed version. Re-deploying the same version, or pushing a lower one, is rejected before the tarball is stored — you'll see a `VERSION_ALREADY_EXISTS` error from the CLI.
+When updating an already deployed tarball app, the server requires the `version` in `package.json` to be **strictly higher** (per [semver](https://semver.org) ordering) than the currently deployed version. Re-deploying the same version, or pushing a lower one, is rejected when the server registers the uploaded tarball, which is then dropped again. You'll see a `VERSION_ALREADY_EXISTS` error from the CLI.
To release an update:
diff --git a/packages/twenty-front/src/generated-metadata/graphql.ts b/packages/twenty-front/src/generated-metadata/graphql.ts
index cf298183724..25fbf1bcdba 100644
--- a/packages/twenty-front/src/generated-metadata/graphql.ts
+++ b/packages/twenty-front/src/generated-metadata/graphql.ts
@@ -3034,6 +3034,7 @@ export type Mutation = {
checkPublicDomainValidRecords?: Maybe<DomainValidRecords>;
checkoutSession: BillingSession;
claimApplicationRegistrationOwnership: ApplicationRegistration;
+ completeAppTarballUpload: ApplicationRegistration;
completeApplicationFileUploads: CompleteApplicationFileUploadsResult;
completeBookCallOnboardingStep: OnboardingStepSuccess;
completeFileUpload: FileWithSignedUrl;
@@ -3262,6 +3263,7 @@ export type Mutation = {
updateWorkspaceMemberRole: WorkspaceMember;
updateWorkspaceMemberSettings: Scalars['Boolean']['output'];
upgradeApplication: Scalars['Boolean']['output'];
+ /** @deprecated Use createFileUpload with the AppTarball folder and completeAppTarballUpload, which send the tarball straight to file storage. */
uploadAppTarball: ApplicationRegistration;
uploadApplicationFile: File;
uploadFilesFieldFileByUniversalIdentifier: FileWithSignedUrl;
@@ -3356,6 +3358,11 @@ export type MutationClaimApplicationRegistrationOwnershipArgs = {
};
+export type MutationCompleteAppTarballUploadArgs = {
+ fileId: Scalars['UUID']['input'];
+};
+
+
export type MutationCompleteApplicationFileUploadsArgs = {
applicationUniversalIdentifier: Scalars['String']['input'];
fileIds: Array<Scalars['UUID']['input']>;
diff --git a/packages/twenty-sdk/CHANGELOG.md b/packages/twenty-sdk/CHANGELOG.md
index 3bca8d3a1d2..af8fc1ab4f5 100644
--- a/packages/twenty-sdk/CHANGELOG.md
+++ b/packages/twenty-sdk/CHANGELOG.md
@@ -45,6 +45,7 @@ The format follows [Keep a Changelog](https://keepachangelog.com/en/1.1.0/), and
### Changed
+- **`twenty app deploy` sends the tarball straight to file storage.** The CLI reserves an upload with `createFileUpload`, PUTs the archive to storage and registers it with `completeAppTarballUpload`, so the tarball no longer transits through the API process. Deploying to a server that predates these mutations fails instead of falling back to the multipart `uploadAppTarball` mutation.
- **`twenty-client-sdk` should now be a dev dependency too.** Although app code imports it (`CoreApiClient`, `MetadataApiClient`, `RestApiClient`), Twenty provides it at runtime — logic functions get it from a generated SDK layer and front components resolve it from server-served modules — so the installed copy is only needed for typechecking and the deploy-time build. Newly scaffolded apps now place it under `devDependencies`. Moving it is recommended (not required: the server already strips it from the deployed runtime), and keeps the installed app leaner:
```diff
diff --git a/packages/twenty-sdk/src/cli/operations/__tests__/deploy.spec.ts b/packages/twenty-sdk/src/cli/operations/__tests__/deploy.spec.ts
new file mode 100644
index 00000000000..b43e7c54695
--- /dev/null
+++ b/packages/twenty-sdk/src/cli/operations/__tests__/deploy.spec.ts
@@ -0,0 +1,142 @@
+import { mkdtemp, writeFile } from 'node:fs/promises';
+import { tmpdir } from 'node:os';
+import { join } from 'node:path';
+
+import { beforeEach, describe, expect, it, vi } from 'vitest';
+
+const mockCreateFileUpload = vi.fn();
+const mockCompleteAppTarballUpload = vi.fn();
+const mockPutFileToUploadUrl = vi.fn();
+
+vi.mock('@/cli/utilities/api/api-service', () => ({
+ ApiService: class {
+ createFileUpload = mockCreateFileUpload;
+ completeAppTarballUpload = mockCompleteAppTarballUpload;
+ },
+}));
+
+vi.mock('@/cli/utilities/file/put-file-to-upload-url', () => ({
+ putFileToUploadUrl: (...args: unknown[]) => mockPutFileToUploadUrl(...args),
+}));
+
+const { appDeploy } = await import('@/cli/operations/deploy');
+
+const TARBALL_CONTENT = 'tarball bytes';
+
+const uploadTarget = {
+ fileId: 'file-id',
+ uploadUrl: 'https://storage.tld/pending/file-id',
+ contentType: 'application/octet-stream',
+ expiresAt: '2026-01-01T00:00:00.000Z',
+};
+
+const registration = {
+ id: 'registration-id',
+ universalIdentifier: 'application-uid',
+ name: 'Test App',
+};
+
+describe('appDeploy', () => {
+ let tarballPath: string;
+
+ beforeEach(async () => {
+ vi.clearAllMocks();
+
+ const directory = await mkdtemp(join(tmpdir(), 'twenty-deploy-'));
+
+ tarballPath = join(directory, 'app.tar.gz');
+ await writeFile(tarballPath, TARBALL_CONTENT);
+
+ mockCreateFileUpload.mockResolvedValue({
+ success: true,
+ data: uploadTarget,
+ });
+ mockCompleteAppTarballUpload.mockResolvedValue({
+ success: true,
+ data: registration,
+ });
+ mockPutFileToUploadUrl.mockResolvedValue(undefined);
+ });
+
+ it('sends the tarball straight to storage, then registers it', async () => {
+ const progressMessages: string[] = [];
+
+ const result = await appDeploy({
+ tarballPath,
+ onProgress: (message) => progressMessages.push(message),
+ });
+
+ expect(result).toEqual({ success: true, data: registration });
+
+ expect(mockCreateFileUpload).toHaveBeenCalledWith({
+ filename: 'app.tar.gz',
+ size: TARBALL_CONTENT.length,
+ fileFolder: 'app-tarball',
+ });
+ expect(mockPutFileToUploadUrl).toHaveBeenCalledWith({
+ absolutePath: tarballPath,
+ uploadUrl: uploadTarget.uploadUrl,
+ contentType: uploadTarget.contentType,
+ });
+ expect(mockCompleteAppTarballUpload).toHaveBeenCalledWith({
+ fileId: uploadTarget.fileId,
+ });
+ expect(progressMessages).toEqual([
+ `Uploading ${tarballPath}...`,
+ 'Registering application...',
+ ]);
+ });
+
+ it('reports a refused upload target without sending anything', async () => {
+ mockCreateFileUpload.mockResolvedValue({
+ success: false,
+ error: 'Invalid file size 0 (max 1073741824 bytes)',
+ });
+
+ const result = await appDeploy({ tarballPath });
+
+ expect(result).toEqual({
+ success: false,
+ error: {
+ code: 'DEPLOY_FAILED',
+ message: 'Upload failed: Invalid file size 0 (max 1073741824 bytes)',
+ },
+ });
+ expect(mockPutFileToUploadUrl).not.toHaveBeenCalled();
+ expect(mockCompleteAppTarballUpload).not.toHaveBeenCalled();
+ });
+
+ it('does not register the tarball when storage refuses the bytes', async () => {
+ mockPutFileToUploadUrl.mockRejectedValue(
+ new Error('Request failed with status code 403'),
+ );
+
+ const result = await appDeploy({ tarballPath });
+
+ expect(result).toEqual({
+ success: false,
+ error: {
+ code: 'DEPLOY_FAILED',
+ message: 'Upload failed: Request failed with status code 403',
+ },
+ });
+ expect(mockCompleteAppTarballUpload).not.toHaveBeenCalled();
+ });
+
+ it('reports a rejected tarball from the completion step', async () => {
+ mockCompleteAppTarballUpload.mockResolvedValue({
+ success: false,
+ error: 'manifest.json not found or invalid in tarball',
+ });
+
+ const result = await appDeploy({ tarballPath });
+
+ expect(result).toEqual({
+ success: false,
+ error: {
+ code: 'DEPLOY_FAILED',
+ message: 'Upload failed: manifest.json not found or invalid in tarball',
+ },
+ });
+ });
+});
diff --git a/packages/twenty-sdk/src/cli/operations/deploy.ts b/packages/twenty-sdk/src/cli/operations/deploy.ts
index 2defd90fce6..ca7032293e0 100644
--- a/packages/twenty-sdk/src/cli/operations/deploy.ts
+++ b/packages/twenty-sdk/src/cli/operations/deploy.ts
@@ -1,9 +1,13 @@
import fs from 'fs';
+import path from 'path';
import { ApiService } from '@/cli/utilities/api/api-service';
import { ConfigService } from '@/cli/utilities/config/config-service';
+import { serializeError } from '@/cli/utilities/error/serialize-error';
+import { putFileToUploadUrl } from '@/cli/utilities/file/put-file-to-upload-url';
import { runSafe } from '@/cli/utilities/run-safe';
import { APP_ERROR_CODES, type CommandResult } from '@/cli/types';
+import { FileFolder } from 'twenty-shared/types';
export type AppDeployOptions = {
tarballPath: string;
@@ -19,6 +23,16 @@ export type AppDeployResult = {
universalIdentifier: string;
};
+const buildDeployFailure = (
+ message: string,
+): CommandResult<AppDeployResult> => ({
+ success: false,
+ error: {
+ code: APP_ERROR_CODES.DEPLOY_FAILED,
+ message,
+ },
+});
+
const innerAppDeploy = async (
options: AppDeployOptions,
): Promise<CommandResult<AppDeployResult>> => {
@@ -30,28 +44,50 @@ const innerAppDeploy = async (
onProgress?.(`Uploading ${tarballPath}...`);
- const tarballBuffer = fs.readFileSync(tarballPath);
-
const apiService = new ApiService({
serverUrl: options.serverUrl,
token: options.token,
});
- const uploadResult = await apiService.uploadAppTarball({ tarballBuffer });
+ const { size } = await fs.promises.stat(tarballPath);
+
+ const createResult = await apiService.createFileUpload({
+ filename: path.basename(tarballPath),
+ size,
+ fileFolder: FileFolder.AppTarball,
+ });
+
+ if (!createResult.success) {
+ return buildDeployFailure(
+ `Upload failed: ${serializeError(createResult.error ?? createResult.message)}`,
+ );
+ }
+
+ const { fileId, uploadUrl, contentType } = createResult.data;
+
+ try {
+ await putFileToUploadUrl({
+ absolutePath: tarballPath,
+ uploadUrl,
+ contentType,
+ });
+ } catch (error) {
+ return buildDeployFailure(`Upload failed: ${serializeError(error)}`);
+ }
+
+ onProgress?.('Registering application...');
+
+ const completeResult = await apiService.completeAppTarballUpload({ fileId });
- if (!uploadResult.success) {
- return {
- success: false,
- error: {
- code: APP_ERROR_CODES.DEPLOY_FAILED,
- message: `Upload failed: ${uploadResult.error}`,
- },
- };
+ if (!completeResult.success) {
+ return buildDeployFailure(
+ `Upload failed: ${serializeError(completeResult.error ?? completeResult.message)}`,
+ );
}
return {
success: true,
- data: uploadResult.data,
+ data: completeResult.data,
};
};
diff --git a/packages/twenty-sdk/src/cli/utilities/api/api-service.ts b/packages/twenty-sdk/src/cli/utilities/api/api-service.ts
index c3d2014fd67..eff5207fa33 100644
--- a/packages/twenty-sdk/src/cli/utilities/api/api-service.ts
+++ b/packages/twenty-sdk/src/cli/utilities/api/api-service.ts
@@ -115,8 +115,14 @@ export class ApiService {
return this.logicFunctionApi.subscribeToLogs(...args);
}
- uploadAppTarball(...args: Parameters<FileApi['uploadAppTarball']>) {
- return this.fileApi.uploadAppTarball(...args);
+ createFileUpload(...args: Parameters<FileApi['createFileUpload']>) {
+ return this.fileApi.createFileUpload(...args);
+ }
+
+ completeAppTarballUpload(
+ ...args: Parameters<FileApi['completeAppTarballUpload']>
+ ) {
+ return this.fileApi.completeAppTarballUpload(...args);
}
installTarballApp(...args: Parameters<FileApi['installTarballApp']>) {
diff --git a/packages/twenty-sdk/src/cli/utilities/api/file-api.ts b/packages/twenty-sdk/src/cli/utilities/api/file-api.ts
index b937afa8346..7589ac9d491 100644
--- a/packages/twenty-sdk/src/cli/utilities/api/file-api.ts
+++ b/packages/twenty-sdk/src/cli/utilities/api/file-api.ts
@@ -85,96 +85,79 @@ export type CompleteApplicationFileUploadsResult = {
errors: ApplicationFileCompletionError[];
};
+export type FileUploadTarget = {
+ fileId: string;
+ uploadUrl: string;
+ contentType: string;
+ expiresAt: string;
+};
+
+export type AppTarballRegistration = {
+ id: string;
+ universalIdentifier: string;
+ name: string;
+};
+
export class FileApi {
constructor(private readonly client: AxiosInstance) {}
- // TODO: Migrate to MetadataClient once available
- // (see https://github.com/twentyhq/core-team-issues/issues/2289)
- async uploadAppTarball({
- tarballBuffer,
- universalIdentifier,
+ async createFileUpload({
+ filename,
+ size,
+ fileFolder,
}: {
- tarballBuffer: Buffer;
- universalIdentifier?: string;
- }): Promise<
- ApiResponse<{
- id: string;
- universalIdentifier: string;
- name: string;
- }>
- > {
- try {
- const mutation = `
- mutation UploadAppTarball($file: Upload!, $universalIdentifier: String) {
- uploadAppTarball(file: $file, universalIdentifier: $universalIdentifier) {
- id
- universalIdentifier
- name
- }
+ filename: string;
+ size: number;
+ fileFolder: FileFolder;
+ }): Promise<ApiResponse<FileUploadTarget>> {
+ const mutation = `
+ mutation CreateFileUpload(
+ $filename: String!
+ $size: Float!
+ $fileFolder: FileFolder!
+ ) {
+ createFileUpload(
+ filename: $filename
+ size: $size
+ fileFolder: $fileFolder
+ ) {
+ fileId
+ uploadUrl
+ contentType
+ expiresAt
}
- `;
-
- const operations = JSON.stringify({
- query: mutation,
- variables: {
- file: null,
- universalIdentifier: universalIdentifier ?? null,
- },
- });
-
- const map = JSON.stringify({
- '0': ['variables.file'],
- });
-
- const formData = new FormData();
-
- formData.append('operations', operations);
- formData.append('map', map);
- formData.append(
- '0',
- new Blob([new Uint8Array(tarballBuffer)], {
- type: 'application/gzip',
- }),
- 'app.tar.gz',
- );
-
- const response: AxiosResponse = await this.client.post(
- '/metadata',
- formData,
- );
-
- if (response.data.errors) {
- return {
- success: false,
- error: response.data.errors[0]?.message || 'Failed to upload tarball',
- };
}
+ `;
- return {
- success: true,
- data: response.data.data.uploadAppTarball,
- };
- } catch (error) {
- if (axios.isAxiosError(error) && error.response) {
- if (error.response.status === 401) {
- return {
- success: false,
- error: error.response.data?.errors?.[0]?.message || error.message,
- isAuthError: true,
- };
- }
+ return this.runMetadataMutation<FileUploadTarget>({
+ mutation,
+ variables: { filename, size, fileFolder: pascalCase(fileFolder) },
+ resultKey: 'createFileUpload',
+ defaultErrorMessage: 'Failed to create file upload',
+ });
+ }
- return {
- success: false,
- error: error.response.data?.errors?.[0]?.message || error.message,
- };
+ async completeAppTarballUpload({
+ fileId,
+ }: {
+ fileId: string;
+ }): Promise<ApiResponse<AppTarballRegistration>> {
+ const mutation = `
+ mutation CompleteAppTarballUpload($fileId: UUID!) {
+ completeAppTarballUpload(fileId: $fileId) {
+ id
+ universalIdentifier
+ name
+ }
}
+ `;
- return {
- success: false,
- error,
- };
- }
+ return this.runMetadataMutation<AppTarballRegistration>({
+ mutation,
+ variables: { fileId },
+ resultKey: 'completeAppTarballUpload',
+ defaultErrorMessage: 'Failed to complete tarball upload',
+ });
}
async installTarballApp({
diff --git a/packages/twenty-sdk/src/cli/utilities/api/is-missing-graphql-field-error.ts b/packages/twenty-sdk/src/cli/utilities/api/is-missing-graphql-field-error.ts
new file mode 100644
index 00000000000..fe958476a89
--- /dev/null
+++ b/packages/twenty-sdk/src/cli/utilities/api/is-missing-graphql-field-error.ts
@@ -0,0 +1,18 @@
+import { serializeError } from '@/cli/utilities/error/serialize-error';
+
+export const isMissingGraphqlFieldError = ({
+ error,
+ fieldNames,
+}: {
+ error: unknown;
+ fieldNames: string[];
+}): boolean => {
+ const message = serializeError(error);
+
+ return (
+ fieldNames.some((fieldName) => message.includes(fieldName)) &&
+ (message.includes('Cannot query field') ||
+ message.includes('Unknown type') ||
+ message.includes('Unknown field'))
+ );
+};
diff --git a/packages/twenty-sdk/src/cli/utilities/file/file-uploader.ts b/packages/twenty-sdk/src/cli/utilities/file/file-uploader.ts
index 0d9ec2b8036..d94f6107917 100644
--- a/packages/twenty-sdk/src/cli/utilities/file/file-uploader.ts
+++ b/packages/twenty-sdk/src/cli/utilities/file/file-uploader.ts
@@ -1,5 +1,6 @@
import { ApiService } from '@/cli/utilities/api/api-service';
import { type ApplicationFileUploadRequest } from '@/cli/utilities/api/file-api';
+import { isMissingGraphqlFieldError } from '@/cli/utilities/api/is-missing-graphql-field-error';
import { serializeError } from '@/cli/utilities/error/serialize-error';
import { putFileToUploadUrl } from '@/cli/utilities/file/put-file-to-upload-url';
import * as fs from 'fs';
@@ -22,19 +23,6 @@ export type FileUploadFailure = {
const DIRECT_UPLOAD_CONCURRENCY = 10;
-const isMissingDirectUploadMutationError = (error: unknown): boolean => {
- const message = serializeError(error);
-
- return (
- (message.includes('createApplicationFileUploads') ||
- message.includes('ApplicationFileUploadRequestInput') ||
- message.includes('CreateApplicationFileUploads')) &&
- (message.includes('Cannot query field') ||
- message.includes('Unknown type') ||
- message.includes('Unknown field'))
- );
-};
-
export class FileUploader {
private apiService = new ApiService();
private applicationUniversalIdentifier: string;
@@ -93,9 +81,14 @@ export class FileUploader {
if (!createResult.success) {
if (
- isMissingDirectUploadMutationError(
- createResult.error ?? createResult.message,
- )
+ isMissingGraphqlFieldError({
+ error: createResult.error ?? createResult.message,
+ fieldNames: [
+ 'createApplicationFileUploads',
+ 'ApplicationFileUploadRequestInput',
+ 'CreateApplicationFileUploads',
+ ],
+ })
) {
return this.uploadBatchWithMultipartMutation(batch);
}
diff --git a/packages/twenty-server/src/engine/core-modules/application/application-registration/application-registration-exception-filter.ts b/packages/twenty-server/src/engine/core-modules/application/application-registration/application-registration-exception-filter.ts
index fb89d3bcb5b..e55cdda77eb 100644
--- a/packages/twenty-server/src/engine/core-modules/application/application-registration/application-registration-exception-filter.ts
+++ b/packages/twenty-server/src/engine/core-modules/application/application-registration/application-registration-exception-filter.ts
@@ -5,6 +5,7 @@ import {
ApplicationRegistrationExceptionCode,
} from 'src/engine/core-modules/application/application-registration/application-registration.exception';
import {
+ ConflictError,
InternalServerError,
NotFoundError,
UserInputError,
@@ -16,6 +17,7 @@ export class ApplicationRegistrationExceptionFilter implements ExceptionFilter {
switch (exception.code) {
case ApplicationRegistrationExceptionCode.APPLICATION_REGISTRATION_NOT_FOUND:
case ApplicationRegistrationExceptionCode.VARIABLE_NOT_FOUND:
+ case ApplicationRegistrationExceptionCode.TARBALL_UPLOAD_NOT_FOUND:
throw new NotFoundError(exception);
case ApplicationRegistrationExceptionCode.INVALID_INPUT:
case ApplicationRegistrationExceptionCode.INVALID_SCOPE:
@@ -26,6 +28,8 @@ export class ApplicationRegistrationExceptionFilter implements ExceptionFilter {
case ApplicationRegistrationExceptionCode.VERSION_ALREADY_EXISTS:
case ApplicationRegistrationExceptionCode.INVALID_APP_ENGINE_REQUIREMENT:
throw new UserInputError(exception);
+ case ApplicationRegistrationExceptionCode.TARBALL_UPLOAD_COMPLETION_IN_PROGRESS:
+ throw new ConflictError(exception);
default:
throw new InternalServerError(exception);
}
diff --git a/packages/twenty-server/src/engine/core-modules/application/application-registration/application-registration.exception.ts b/packages/twenty-server/src/engine/core-modules/application/application-registration/application-registration.exception.ts
index 85333416827..98a68b7f656 100644
--- a/packages/twenty-server/src/engine/core-modules/application/application-registration/application-registration.exception.ts
+++ b/packages/twenty-server/src/engine/core-modules/application/application-registration/application-registration.exception.ts
@@ -24,6 +24,8 @@ export enum ApplicationRegistrationExceptionCode {
GITHUB_AUTH_FAILED = 'GITHUB_AUTH_FAILED',
GITHUB_ORG_OWNERSHIP_REQUIRED = 'GITHUB_ORG_OWNERSHIP_REQUIRED',
CLAIM_STATE_MISMATCH = 'CLAIM_STATE_MISMATCH',
+ TARBALL_UPLOAD_NOT_FOUND = 'TARBALL_UPLOAD_NOT_FOUND',
+ TARBALL_UPLOAD_COMPLETION_IN_PROGRESS = 'TARBALL_UPLOAD_COMPLETION_IN_PROGRESS',
}
const getExceptionUserFriendlyMessage = (
@@ -68,6 +70,10 @@ const getExceptionUserFriendlyMessage = (
return msg`Your GitHub account does not own the organization that publishes this package. If you are an owner, make sure you granted this app access to the organization on GitHub's authorization screen (Organization access section).`;
case ApplicationRegistrationExceptionCode.CLAIM_STATE_MISMATCH:
return msg`This claim was started in another browser or has already been used. Start the claim again from this browser.`;
+ case ApplicationRegistrationExceptionCode.TARBALL_UPLOAD_NOT_FOUND:
+ return msg`Tarball upload not found.`;
+ case ApplicationRegistrationExceptionCode.TARBALL_UPLOAD_COMPLETION_IN_PROGRESS:
+ return msg`This upload is already being completed. Please wait for it to finish.`;
default:
assertUnreachable(code);
}
diff --git a/packages/twenty-server/src/engine/core-modules/application/application-registration/application-registration.module.ts b/packages/twenty-server/src/engine/core-modules/application/application-registration/application-registration.module.ts
index c4db50e8c76..8b7ef1ebc19 100644
--- a/packages/twenty-server/src/engine/core-modules/application/application-registration/application-registration.module.ts
+++ b/packages/twenty-server/src/engine/core-modules/application/application-registration/application-registration.module.ts
@@ -1,6 +1,7 @@
import { Module } from '@nestjs/common';
import { TypeOrmModule } from '@nestjs/typeorm';
+import { TypeORMModule } from 'src/database/typeorm/typeorm.module';
import { CoreEntityCacheModule } from 'src/engine/core-entity-cache/core-entity-cache.module';
import { ApplicationRegistrationAssetUrlService } from 'src/engine/core-modules/application/application-registration/application-registration-asset-url.service';
import { ApplicationRegistrationAssetService } from 'src/engine/core-modules/application/application-registration/application-registration-asset.service';
@@ -21,12 +22,15 @@ import { DomainServerConfigModule } from 'src/engine/core-modules/domain/domain-
import { WorkspaceDomainsModule } from 'src/engine/core-modules/domain/workspace-domains/workspace-domains.module';
import { FeatureFlagModule } from 'src/engine/core-modules/feature-flag/feature-flag.module';
import { FileStorageModule } from 'src/engine/core-modules/file-storage/file-storage.module';
+import { FileEntity } from 'src/engine/core-modules/file/entities/file.entity';
+import { FileUploadModule } from 'src/engine/core-modules/file/file-upload/file-upload.module';
import { FileUrlModule } from 'src/engine/core-modules/file/file-url/file-url.module';
import { GuardRedirectModule } from 'src/engine/core-modules/guard-redirect/guard-redirect.module';
import { JwtModule } from 'src/engine/core-modules/jwt/jwt.module';
import { MetricsModule } from 'src/engine/core-modules/metrics/metrics.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 { WorkspaceCacheStorageModule } from 'src/engine/workspace-cache-storage/workspace-cache-storage.module';
@Module({
@@ -35,12 +39,14 @@ import { WorkspaceCacheStorageModule } from 'src/engine/workspace-cache-storage/
ApplicationRegistrationEntity,
ApplicationEntity,
WorkspaceEntity,
+ FileEntity,
]),
ApplicationRegistrationVariableModule,
ApplicationModule,
ApplicationPackageModule,
CacheLockModule,
CoreEntityCacheModule,
+ TypeORMModule,
DomainServerConfigModule,
WorkspaceDomainsModule,
FeatureFlagModule,
@@ -48,6 +54,7 @@ import { WorkspaceCacheStorageModule } from 'src/engine/workspace-cache-storage/
JwtModule,
PermissionsModule,
FileStorageModule,
+ FileUploadModule,
FileUrlModule,
MetricsModule,
WorkspaceCacheStorageModule,
@@ -62,6 +69,7 @@ import { WorkspaceCacheStorageModule } from 'src/engine/workspace-cache-storage/
ApplicationTarballService,
ApplicationRegistrationAssetService,
ApplicationRegistrationAssetUrlService,
+ provideWorkspaceScopedRepository(FileEntity),
],
exports: [
ApplicationRegistrationService,
diff --git a/packages/twenty-server/src/engine/core-modules/application/application-registration/application-registration.resolver.ts b/packages/twenty-server/src/engine/core-modules/application/application-registration/application-registration.resolver.ts
index 0c1615480b8..f1cd713e4e7 100644
--- a/packages/twenty-server/src/engine/core-modules/application/application-registration/application-registration.resolver.ts
+++ b/packages/twenty-server/src/engine/core-modules/application/application-registration/application-registration.resolver.ts
@@ -19,6 +19,7 @@ import { type IDataloaders } from 'src/engine/dataloaders/dataloader.interface';
import type { FileUpload } from 'graphql-upload/processRequest.mjs';
import { MetadataResolver } from 'src/engine/api/graphql/graphql-config/decorators/metadata-resolver.decorator';
+import { UUIDScalarType } from 'src/engine/api/graphql/workspace-schema-builder/graphql-types/scalars';
import { ApplicationRegistrationVariableService } from 'src/engine/core-modules/application/application-registration-variable/application-registration-variable.service';
import { CreateApplicationRegistrationVariableInput } from 'src/engine/core-modules/application/application-registration-variable/dtos/create-application-registration-variable.input';
import { UpdateApplicationRegistrationVariableInput } from 'src/engine/core-modules/application/application-registration-variable/dtos/update-application-registration-variable.input';
@@ -41,6 +42,7 @@ import { TransferApplicationRegistrationOwnershipInput } from 'src/engine/core-m
import { UpdateApplicationRegistrationInput } from 'src/engine/core-modules/application/application-registration/dtos/update-application-registration.input';
import { ApplicationRegistrationSourceType } from 'src/engine/core-modules/application/application-registration/enums/application-registration-source-type.enum';
import { AuthGraphqlApiExceptionFilter } from 'src/engine/core-modules/auth/filters/auth-graphql-api-exception.filter';
+import { FileUploadGraphqlApiExceptionFilter } from 'src/engine/core-modules/file/file-upload/filters/file-upload-graphql-api-exception.filter';
import { FileUrlService } from 'src/engine/core-modules/file/file-url/file-url.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';
@@ -66,6 +68,7 @@ import {
@MetadataResolver(() => ApplicationRegistrationEntity)
@UseFilters(
ApplicationRegistrationExceptionFilter,
+ FileUploadGraphqlApiExceptionFilter,
AuthGraphqlApiExceptionFilter,
PreventNestToAutoLogGraphqlErrorsFilter,
)
@@ -258,6 +261,24 @@ export class ApplicationRegistrationResolver {
SettingsPermissionGuard(PermissionFlagType.MARKETPLACE_APPS),
)
@Mutation(() => ApplicationRegistrationEntity)
+ async completeAppTarballUpload(
+ @Args({ name: 'fileId', type: () => UUIDScalarType }) fileId: string,
+ @AuthWorkspace() { id: workspaceId }: WorkspaceEntity,
+ ): Promise<ApplicationRegistrationEntity> {
+ return this.applicationTarballService.completeTarballUpload({
+ ownerWorkspaceId: workspaceId,
+ fileId,
+ });
+ }
+
+ @UseGuards(
+ WorkspaceAuthGuard,
+ SettingsPermissionGuard(PermissionFlagType.MARKETPLACE_APPS),
+ )
+ @Mutation(() => ApplicationRegistrationEntity, {
+ deprecationReason:
+ 'Use createFileUpload with the AppTarball folder and completeAppTarballUpload, which send the tarball straight to file storage.',
+ })
async uploadAppTarball(
@Args({ name: 'file', type: () => GraphQLUpload })
{ createReadStream }: FileUpload,
diff --git a/packages/twenty-server/src/engine/core-modules/application/application-registration/application-tarball.service.ts b/packages/twenty-server/src/engine/core-modules/application/application-registration/application-tarball.service.ts
index 9e6b14bbf52..0a1aa176dd8 100644
--- a/packages/twenty-server/src/engine/core-modules/application/application-registration/application-tarball.service.ts
+++ b/packages/twenty-server/src/engine/core-modules/application/application-registration/application-tarball.service.ts
@@ -1,15 +1,17 @@
import { Injectable, Logger } from '@nestjs/common';
import { InjectRepository } from '@nestjs/typeorm';
-import { promises as fs } from 'fs';
+import { createWriteStream, promises as fs } from 'fs';
import { tmpdir } from 'os';
import { isAbsolute, join, relative, resolve } from 'path';
+import { pipeline } from 'stream/promises';
import { FileFolder } from 'twenty-shared/types';
import { isDefined, isValidUuid } from 'twenty-shared/utils';
-import { Repository } from 'typeorm';
+import { Like, Repository } from 'typeorm';
import { v4 } from 'uuid';
+import { PostgresAdvisoryLockService } from 'src/database/typeorm/postgres-advisory-lock.service';
import { ApplicationVersionValidationService } from 'src/engine/core-modules/application/application-package/application-version-validation.service';
import {
VERSION_PROGRESSION_REASON_TO_DEPLOY_EXCEPTION_CODE,
@@ -27,10 +29,28 @@ import {
import { ApplicationRegistrationService } from 'src/engine/core-modules/application/application-registration/application-registration.service';
import { ApplicationRegistrationSourceType } from 'src/engine/core-modules/application/application-registration/enums/application-registration-source-type.enum';
import { fromManifestApplicationToDisplayFields } from 'src/engine/core-modules/application/application-registration/utils/from-manifest-application-to-display-fields.util';
+import { getTarballUploadCompletionLockName } from 'src/engine/core-modules/application/application-registration/utils/get-tarball-upload-completion-lock-name.util';
import { ApplicationService } from 'src/engine/core-modules/application/application.service';
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 {
+ FileUploadCompletionService,
+ type FileUploadStorageLocation,
+} from 'src/engine/core-modules/file/file-upload/services/file-upload-completion.service';
+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';
import type { ApplicationManifest, Manifest } from 'twenty-shared/application';
+const TARBALL_FILE_NAME = 'app.tar.gz';
+
+type ExtractedTarball = {
+ contentDir: string;
+ manifest: { application: ApplicationManifest };
+ packageJson: { version: string; engines?: { twenty?: string } } | null;
+};
+
@Injectable()
export class ApplicationTarballService {
private readonly logger = new Logger(ApplicationTarballService.name);
@@ -38,105 +58,302 @@ export class ApplicationTarballService {
constructor(
@InjectRepository(ApplicationRegistrationEntity)
private readonly appRegistrationRepository: Repository<ApplicationRegistrationEntity>,
+ @InjectWorkspaceScopedRepository(FileEntity)
+ private readonly fileRepository: WorkspaceScopedRepository<FileEntity>,
private readonly fileStorageService: FileStorageService,
+ private readonly fileUploadCompletionService: FileUploadCompletionService,
private readonly applicationRegistrationAssetService: ApplicationRegistrationAssetService,
private readonly applicationService: ApplicationService,
private readonly applicationVersionValidationService: ApplicationVersionValidationService,
private readonly applicationRegistrationService: ApplicationRegistrationService,
+ private readonly postgresAdvisoryLockService: PostgresAdvisoryLockService,
) {}
async uploadTarball(params: {
tarballBuffer: Buffer;
ownerWorkspaceId: string;
}): Promise<ApplicationRegistrationEntity> {
- const tempDir = join(tmpdir(), 'twenty-tarball-upload', v4());
-
- await fs.mkdir(tempDir, { recursive: true });
+ return this.withTempDir(async (tempDir) => {
+ const tarballPath = join(tempDir, TARBALL_FILE_NAME);
- try {
- const { contentDir, manifest, packageJson } =
- await this.extractAndValidateTarball(tempDir, params.tarballBuffer);
+ await fs.writeFile(tarballPath, params.tarballBuffer);
- const universalIdentifier = manifest.application.universalIdentifier;
+ const extractedTarball = await this.extractAndValidateTarball(
+ tempDir,
+ tarballPath,
+ );
- const existingRegistration = await this.appRegistrationRepository.findOne(
- {
- where: {
- universalIdentifier,
+ return this.registerExtractedTarball({
+ extractedTarball,
+ ownerWorkspaceId: params.ownerWorkspaceId,
+ storeTarballFile: (appRegistration) =>
+ this.storeTarballFile({
+ appRegistration,
+ tarballBuffer: params.tarballBuffer,
ownerWorkspaceId: params.ownerWorkspaceId,
- },
- },
+ }),
+ });
+ });
+ }
+
+ async completeTarballUpload({
+ ownerWorkspaceId,
+ fileId,
+ }: {
+ ownerWorkspaceId: string;
+ fileId: string;
+ }): Promise<ApplicationRegistrationEntity> {
+ // Completions of one upload run one at a time: an overlapping request
+ // would race the registration insert, so it is refused and a later retry
+ // finds the registration the first one attached.
+ const lockResult = await this.postgresAdvisoryLockService.tryWithLock(
+ getTarballUploadCompletionLockName(fileId),
+ () => this.completeTarballUploadExclusively({ ownerWorkspaceId, fileId }),
+ );
+
+ if (!lockResult.acquired) {
+ throw new ApplicationRegistrationException(
+ `Tarball upload ${fileId} is already being completed`,
+ ApplicationRegistrationExceptionCode.TARBALL_UPLOAD_COMPLETION_IN_PROGRESS,
);
+ }
- const isNewRegistration = !isDefined(existingRegistration);
- const previousLatestAvailableVersion =
- existingRegistration?.latestAvailableVersion ?? null;
-
- const appRegistration = isDefined(existingRegistration)
- ? this.assertTarballCanReplaceRegistration({
- registration: existingRegistration,
- incomingVersion: packageJson?.version,
- universalIdentifier,
- })
- : await this.createTarballRegistration({
- universalIdentifier,
- manifest,
- packageJsonVersion: packageJson?.version ?? null,
- ownerWorkspaceId: params.ownerWorkspaceId,
- });
+ return lockResult.value;
+ }
- const savedFile = await this.storeTarballFile({
- appRegistration,
- tarballBuffer: params.tarballBuffer,
- ownerWorkspaceId: params.ownerWorkspaceId,
- });
+ private async completeTarballUploadExclusively({
+ ownerWorkspaceId,
+ fileId,
+ }: {
+ ownerWorkspaceId: string;
+ fileId: string;
+ }): Promise<ApplicationRegistrationEntity> {
+ const file = await this.fileRepository.findOne(ownerWorkspaceId, {
+ where: { id: fileId, path: Like(`${FileFolder.AppTarball}/%`) },
+ });
- await this.applicationRegistrationService.updateFromManifest({
- applicationRegistrationId: appRegistration.id,
- manifest: manifest as Manifest,
- sourceType: ApplicationRegistrationSourceType.TARBALL,
- latestAvailableVersion: packageJson?.version ?? null,
- additionalFields: {
- tarballFileId: savedFile.id,
- isListed: false,
- isVetted: false,
- ownerWorkspaceId: params.ownerWorkspaceId,
- },
+ if (!isDefined(file)) {
+ throw new ApplicationRegistrationException(
+ `Tarball upload ${fileId} not found`,
+ ApplicationRegistrationExceptionCode.TARBALL_UPLOAD_NOT_FOUND,
+ );
+ }
+
+ const attachedRegistration = await this.findRegistrationAttachedToFile({
+ fileId: file.id,
+ ownerWorkspaceId,
+ });
+
+ const applicationUniversalIdentifier =
+ await this.findOwnerCustomApplicationUniversalIdentifier(
+ ownerWorkspaceId,
+ );
+
+ const storageLocation: FileUploadStorageLocation = {
+ fileFolder: FileFolder.AppTarball,
+ applicationUniversalIdentifier,
+ workspaceId: ownerWorkspaceId,
+ resourcePath: removeFileFolderFromFileEntityPath(file.path),
+ };
+
+ if (file.status !== FILE_STATUS.UPLOADED) {
+ await this.fileUploadCompletionService.completeUploadedFile({
+ workspaceId: ownerWorkspaceId,
+ file,
+ storageLocation,
});
+ }
+
+ try {
+ const registration = await this.withTempDir(async (tempDir) => {
+ const tarballPath = join(tempDir, TARBALL_FILE_NAME);
+
+ await pipeline(
+ await this.fileStorageService.readFile(storageLocation),
+ createWriteStream(tarballPath),
+ );
- await this.applicationRegistrationAssetService.storeRegistrationAssets({
- applicationRegistrationId: appRegistration.id,
- manifestApplication: manifest.application,
- readAsset: (path) => this.readAssetFromContentDir(contentDir, path),
+ const extractedTarball = await this.extractAndValidateTarball(
+ tempDir,
+ tarballPath,
+ );
+
+ if (isDefined(attachedRegistration)) {
+ return this.resumeAttachedRegistration({
+ appRegistration: attachedRegistration,
+ extractedTarball,
+ });
+ }
+
+ return this.registerExtractedTarball({
+ extractedTarball,
+ ownerWorkspaceId,
+ storeTarballFile: async () => file,
+ });
});
- this.logger.log(
- `Tarball uploaded for app ${universalIdentifier} (registration ${appRegistration.id})`,
+ await this.fileRepository.update(
+ ownerWorkspaceId,
+ { id: file.id },
+ { settings: { isTemporaryFile: false, toDelete: false } },
);
- const incomingVersion = packageJson?.version ?? null;
- if (
- isNewRegistration ||
- previousLatestAvailableVersion !== incomingVersion
- ) {
- this.applicationRegistrationService.emitRegistrationPublishMetric({
- isNewRegistration,
+ return registration;
+ } catch (error) {
+ await this.deleteTarballFileUnlessAttached({
+ fileId: file.id,
+ ownerWorkspaceId,
+ });
+
+ throw error;
+ }
+ }
+
+ // The registration is attached to its tarball before the assets are stored
+ // and the auto-upgrade is enqueued, so a retried completion cannot tell
+ // where the previous attempt stopped and reruns those idempotent steps.
+ private async resumeAttachedRegistration({
+ appRegistration,
+ extractedTarball: { contentDir, manifest },
+ }: {
+ appRegistration: ApplicationRegistrationEntity;
+ extractedTarball: ExtractedTarball;
+ }): Promise<ApplicationRegistrationEntity> {
+ await this.applicationRegistrationAssetService.storeRegistrationAssets({
+ applicationRegistrationId: appRegistration.id,
+ manifestApplication: manifest.application,
+ readAsset: (path) => this.readAssetFromContentDir(contentDir, path),
+ });
+
+ await this.applicationRegistrationService.enqueueAutoUpgradeApplications(
+ appRegistration.id,
+ );
+
+ return this.appRegistrationRepository.findOneOrFail({
+ where: { id: appRegistration.id },
+ });
+ }
+
+ private async findRegistrationAttachedToFile({
+ fileId,
+ ownerWorkspaceId,
+ }: {
+ fileId: string;
+ ownerWorkspaceId: string;
+ }): Promise<ApplicationRegistrationEntity | null> {
+ return this.appRegistrationRepository.findOne({
+ where: { tarballFileId: fileId, ownerWorkspaceId },
+ });
+ }
+
+ private async registerExtractedTarball({
+ extractedTarball: { contentDir, manifest, packageJson },
+ ownerWorkspaceId,
+ storeTarballFile,
+ }: {
+ extractedTarball: ExtractedTarball;
+ ownerWorkspaceId: string;
+ storeTarballFile: (
+ appRegistration: ApplicationRegistrationEntity,
+ ) => Promise<Pick<FileEntity, 'id'>>;
+ }): Promise<ApplicationRegistrationEntity> {
+ const universalIdentifier = manifest.application.universalIdentifier;
+
+ const existingRegistration = await this.appRegistrationRepository.findOne({
+ where: {
+ universalIdentifier,
+ ownerWorkspaceId,
+ },
+ });
+
+ const isNewRegistration = !isDefined(existingRegistration);
+ const previousLatestAvailableVersion =
+ existingRegistration?.latestAvailableVersion ?? null;
+ const previousTarballFileId = existingRegistration?.tarballFileId ?? null;
+
+ const appRegistration = isDefined(existingRegistration)
+ ? this.assertTarballCanReplaceRegistration({
+ registration: existingRegistration,
+ incomingVersion: packageJson?.version,
+ universalIdentifier,
+ })
+ : await this.createTarballRegistration({
universalIdentifier,
- name: manifest.application?.displayName ?? 'Unknown App',
- sourceType: ApplicationRegistrationSourceType.TARBALL,
- version: incomingVersion,
+ manifest,
+ packageJsonVersion: packageJson?.version ?? null,
+ ownerWorkspaceId,
});
- if (!isNewRegistration) {
- await this.applicationRegistrationService.enqueueAutoUpgradeApplications(
- appRegistration.id,
- );
- }
+ const savedFile = await storeTarballFile(appRegistration);
+
+ await this.applicationRegistrationService.updateFromManifest({
+ applicationRegistrationId: appRegistration.id,
+ manifest: manifest as Manifest,
+ sourceType: ApplicationRegistrationSourceType.TARBALL,
+ latestAvailableVersion: packageJson?.version ?? null,
+ additionalFields: {
+ tarballFileId: savedFile.id,
+ isListed: false,
+ isVetted: false,
+ ownerWorkspaceId,
+ },
+ });
+
+ await this.applicationRegistrationAssetService.storeRegistrationAssets({
+ applicationRegistrationId: appRegistration.id,
+ manifestApplication: manifest.application,
+ readAsset: (path) => this.readAssetFromContentDir(contentDir, path),
+ });
+
+ this.logger.log(
+ `Tarball uploaded for app ${universalIdentifier} (registration ${appRegistration.id})`,
+ );
+
+ const incomingVersion = packageJson?.version ?? null;
+
+ if (
+ isNewRegistration ||
+ previousLatestAvailableVersion !== incomingVersion
+ ) {
+ this.applicationRegistrationService.emitRegistrationPublishMetric({
+ isNewRegistration,
+ universalIdentifier,
+ name: manifest.application?.displayName ?? 'Unknown App',
+ sourceType: ApplicationRegistrationSourceType.TARBALL,
+ version: incomingVersion,
+ });
+
+ if (!isNewRegistration) {
+ await this.applicationRegistrationService.enqueueAutoUpgradeApplications(
+ appRegistration.id,
+ );
}
+ }
- return this.appRegistrationRepository.findOneOrFail({
- where: { id: appRegistration.id },
+ if (
+ isDefined(previousTarballFileId) &&
+ previousTarballFileId !== savedFile.id
+ ) {
+ await this.deleteTarballFileSilently({
+ fileId: previousTarballFileId,
+ ownerWorkspaceId,
});
+ }
+
+ return this.appRegistrationRepository.findOneOrFail({
+ where: { id: appRegistration.id },
+ });
+ }
+
+ private async withTempDir<TResult>(
+ run: (tempDir: string) => Promise<TResult>,
+ ): Promise<TResult> {
+ const tempDir = join(tmpdir(), 'twenty-tarball-upload', v4());
+
+ await fs.mkdir(tempDir, { recursive: true });
+
+ try {
+ return await run(tempDir);
} finally {
await fs.rm(tempDir, { recursive: true, force: true });
}
@@ -144,16 +361,8 @@ export class ApplicationTarballService {
private async extractAndValidateTarball(
tempDir: string,
- tarballBuffer: Buffer,
- ): Promise<{
- contentDir: string;
- manifest: { application: ApplicationManifest };
- packageJson: { version: string; engines?: { twenty?: string } } | null;
- }> {
- const tarballPath = join(tempDir, 'app.tar.gz');
-
- await fs.writeFile(tarballPath, tarballBuffer);
-
+ tarballPath: string,
+ ): Promise<ExtractedTarball> {
const extractDir = join(tempDir, 'extracted');
await fs.mkdir(extractDir, { recursive: true });
@@ -282,6 +491,17 @@ export class ApplicationTarballService {
);
}
+ private async findOwnerCustomApplicationUniversalIdentifier(
+ ownerWorkspaceId: string,
+ ): Promise<string> {
+ const { workspaceCustomFlatApplication } =
+ await this.applicationService.findWorkspaceTwentyStandardAndCustomApplicationOrThrow(
+ { workspaceId: ownerWorkspaceId },
+ );
+
+ return workspaceCustomFlatApplication.universalIdentifier;
+ }
+
private async storeTarballFile({
appRegistration,
tarballBuffer,
@@ -290,18 +510,17 @@ export class ApplicationTarballService {
appRegistration: ApplicationRegistrationEntity;
tarballBuffer: Buffer;
ownerWorkspaceId: string;
- }) {
- const { workspaceCustomFlatApplication } =
- await this.applicationService.findWorkspaceTwentyStandardAndCustomApplicationOrThrow(
- { workspaceId: ownerWorkspaceId },
+ }): Promise<FileEntity> {
+ const applicationUniversalIdentifier =
+ await this.findOwnerCustomApplicationUniversalIdentifier(
+ ownerWorkspaceId,
);
return this.fileStorageService.writeFile({
sourceFile: tarballBuffer,
- resourcePath: `${appRegistration.id}/app.tar.gz`,
+ resourcePath: `${appRegistration.id}/${TARBALL_FILE_NAME}`,
fileFolder: FileFolder.AppTarball,
- applicationUniversalIdentifier:
- workspaceCustomFlatApplication.universalIdentifier,
+ applicationUniversalIdentifier,
workspaceId: ownerWorkspaceId,
fileId: appRegistration.tarballFileId ?? v4(),
settings: {
@@ -311,6 +530,45 @@ export class ApplicationTarballService {
});
}
+ private async deleteTarballFileUnlessAttached({
+ fileId,
+ ownerWorkspaceId,
+ }: {
+ fileId: string;
+ ownerWorkspaceId: string;
+ }): Promise<void> {
+ const attachedRegistration = await this.findRegistrationAttachedToFile({
+ fileId,
+ ownerWorkspaceId,
+ });
+
+ if (isDefined(attachedRegistration)) {
+ return;
+ }
+
+ await this.deleteTarballFileSilently({ fileId, ownerWorkspaceId });
+ }
+
+ private async deleteTarballFileSilently({
+ fileId,
+ ownerWorkspaceId,
+ }: {
+ fileId: string;
+ ownerWorkspaceId: string;
+ }): Promise<void> {
+ try {
+ await this.fileStorageService.deleteByFileId({
+ fileId,
+ workspaceId: ownerWorkspaceId,
+ fileFolder: FileFolder.AppTarball,
+ });
+ } catch (error) {
+ this.logger.warn(
+ `Failed to delete tarball file ${fileId} of workspace ${ownerWorkspaceId}: ${error instanceof Error ? error.message : String(error)}`,
+ );
+ }
+ }
+
private async readAssetFromContentDir(
contentDir: string,
path: string,
diff --git a/packages/twenty-server/src/engine/core-modules/application/application-registration/utils/get-tarball-upload-completion-lock-name.util.ts b/packages/twenty-server/src/engine/core-modules/application/application-registration/utils/get-tarball-upload-completion-lock-name.util.ts
new file mode 100644
index 00000000000..7d66fdda037
--- /dev/null
+++ b/packages/twenty-server/src/engine/core-modules/application/application-registration/utils/get-tarball-upload-completion-lock-name.util.ts
@@ -0,0 +1,2 @@
+export const getTarballUploadCompletionLockName = (fileId: string) =>
+ `app-tarball-upload-completion-${fileId}`;
diff --git a/packages/twenty-server/src/engine/core-modules/file/file-upload/filters/file-upload-graphql-api-exception.filter.ts b/packages/twenty-server/src/engine/core-modules/file/file-upload/filters/file-upload-graphql-api-exception.filter.ts
new file mode 100644
index 00000000000..c08e0f25e4b
--- /dev/null
+++ b/packages/twenty-server/src/engine/core-modules/file/file-upload/filters/file-upload-graphql-api-exception.filter.ts
@@ -0,0 +1,35 @@
+import { Catch, type ExceptionFilter } from '@nestjs/common';
+
+import { assertUnreachable } from 'twenty-shared/utils';
+
+import {
+ FileUploadException,
+ FileUploadExceptionCode,
+} from 'src/engine/core-modules/file/file-upload/file-upload.exception';
+import {
+ InternalServerError,
+ NotFoundError,
+ TimeoutError,
+ UserInputError,
+} from 'src/engine/core-modules/graphql/utils/graphql-errors.util';
+
+@Catch(FileUploadException)
+export class FileUploadGraphqlApiExceptionFilter implements ExceptionFilter {
+ catch(exception: FileUploadException) {
+ switch (exception.code) {
+ case FileUploadExceptionCode.FILE_NOT_FOUND:
+ throw new NotFoundError(exception);
+ case FileUploadExceptionCode.BAD_REQUEST:
+ case FileUploadExceptionCode.FILE_NOT_UPLOADED:
+ case FileUploadExceptionCode.FILE_SIZE_MISMATCH:
+ case FileUploadExceptionCode.FILE_TOO_LARGE:
+ throw new UserInputError(exception);
+ case FileUploadExceptionCode.STORAGE_TIMEOUT:
+ throw new TimeoutError(exception);
+ case FileUploadExceptionCode.STORAGE_INCONSISTENT:
+ throw new InternalServerError(exception);
+ default:
+ return assertUnreachable(exception.code);
+ }
+ }
+}
diff --git a/packages/twenty-server/src/engine/core-modules/file/file-upload/resolvers/file-upload.resolver.ts b/packages/twenty-server/src/engine/core-modules/file/file-upload/resolvers/file-upload.resolver.ts
index 0a9143eb1d0..a52584024b5 100644
--- a/packages/twenty-server/src/engine/core-modules/file/file-upload/resolvers/file-upload.resolver.ts
+++ b/packages/twenty-server/src/engine/core-modules/file/file-upload/resolvers/file-upload.resolver.ts
@@ -7,6 +7,7 @@ import { FileFolder } from 'twenty-shared/types';
import { MetadataResolver } from 'src/engine/api/graphql/graphql-config/decorators/metadata-resolver.decorator';
import { FileWithSignedUrlDTO } from 'src/engine/core-modules/file/dtos/file-with-sign-url.dto';
import { FileUploadTargetDTO } from 'src/engine/core-modules/file/file-upload/dtos/file-upload-target.dto';
+import { FileUploadGraphqlApiExceptionFilter } from 'src/engine/core-modules/file/file-upload/filters/file-upload-graphql-api-exception.filter';
import { FileUploadService } from 'src/engine/core-modules/file/file-upload/services/file-upload.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';
@@ -21,6 +22,7 @@ import { UsageLimitGraphqlApiExceptionFilter } from 'src/engine/core-modules/usa
@UsePipes(ResolverValidationPipe)
@UseFilters(
UsageLimitGraphqlApiExceptionFilter,
+ FileUploadGraphqlApiExceptionFilter,
PreventNestToAutoLogGraphqlErrorsFilter,
AuthGraphqlApiExceptionFilter,
)
diff --git a/packages/twenty-server/src/engine/core-modules/file/file-upload/services/file-upload.service.ts b/packages/twenty-server/src/engine/core-modules/file/file-upload/services/file-upload.service.ts
index 4882f375918..fef86b51ec5 100644
--- a/packages/twenty-server/src/engine/core-modules/file/file-upload/services/file-upload.service.ts
+++ b/packages/twenty-server/src/engine/core-modules/file/file-upload/services/file-upload.service.ts
@@ -6,13 +6,11 @@ import { pipeline } from 'stream/promises';
import { msg } from '@lingui/core/macro';
import { isNonEmptyString } from '@sniptt/guards';
-import bytes from 'bytes';
import { FileFolder } from 'twenty-shared/types';
import { isDefined } from 'twenty-shared/utils';
import { Repository } from 'typeorm';
import { v4 } from 'uuid';
-import { settings } from 'src/engine/constants/settings';
import { ApplicationEntity } from 'src/engine/core-modules/application/application.entity';
import { ApplicationService } from 'src/engine/core-modules/application/application.service';
import { FileStorageService } from 'src/engine/core-modules/file-storage/services/file-storage.service';
@@ -27,6 +25,7 @@ import {
} from 'src/engine/core-modules/file/file-upload/file-upload.exception';
import { FileUploadCompletionService } from 'src/engine/core-modules/file/file-upload/services/file-upload-completion.service';
import { FileUploadTargetService } from 'src/engine/core-modules/file/file-upload/services/file-upload-target.service';
+import { assertValidDirectUploadSize } from 'src/engine/core-modules/file/file-upload/utils/assert-valid-direct-upload-size.util';
import { buildSvgTooLargeException } from 'src/engine/core-modules/file/file-upload/utils/build-svg-too-large-exception.util';
import { FileUrlService } from 'src/engine/core-modules/file/file-url/file-url.service';
import { FILE_STATUS } from 'src/engine/core-modules/file/types/file-status.types';
@@ -44,6 +43,14 @@ export const DIRECT_UPLOAD_FILE_FOLDERS = [
FileFolder.EmailAttachment,
FileFolder.AgentChat,
FileFolder.EmailImage,
+ FileFolder.AppTarball,
+] as const;
+
+// A tarball leaves quarantine through completeAppTarballUpload only, behind
+// the marketplace-apps permission: the generic completion, open to any member
+// allowed to upload files, must not persist bytes in that folder.
+export const DEDICATED_COMPLETION_FILE_FOLDERS = [
+ FileFolder.AppTarball,
] as const;
@Injectable()
@@ -93,17 +100,7 @@ export class FileUploadService {
);
}
- const maxFileSize = bytes(settings.storage.maxDirectUploadFileSize) ?? 0;
-
- if (!Number.isInteger(size) || size <= 0 || size > maxFileSize) {
- throw new FileUploadException(
- `Invalid file size ${size} (max ${maxFileSize} bytes)`,
- FileUploadExceptionCode.FILE_TOO_LARGE,
- {
- userFriendlyMessage: msg`The file is empty or exceeds the maximum allowed size.`,
- },
- );
- }
+ assertValidDirectUploadSize(size);
const { ext } = buildFileInfo(filename);
@@ -268,6 +265,20 @@ export class FileUploadService {
);
}
+ if (
+ DEDICATED_COMPLETION_FILE_FOLDERS.includes(
+ fileFolder as (typeof DEDICATED_COMPLETION_FILE_FOLDERS)[number],
+ )
+ ) {
+ throw new FileUploadException(
+ `File ${fileId} in folder ${fileFolder} is completed by its dedicated mutation`,
+ FileUploadExceptionCode.BAD_REQUEST,
+ {
+ userFriendlyMessage: msg`This file must be completed with its dedicated mutation.`,
+ },
+ );
+ }
+
if (file.status === FILE_STATUS.UPLOADED) {
if (!file.settings?.isTemporaryFile) {
throw new FileUploadException(
diff --git a/packages/twenty-server/src/engine/core-modules/file/file-upload/utils/assert-valid-direct-upload-size.util.ts b/packages/twenty-server/src/engine/core-modules/file/file-upload/utils/assert-valid-direct-upload-size.util.ts
new file mode 100644
index 00000000000..f10d6edd907
--- /dev/null
+++ b/packages/twenty-server/src/engine/core-modules/file/file-upload/utils/assert-valid-direct-upload-size.util.ts
@@ -0,0 +1,22 @@
+import { msg } from '@lingui/core/macro';
+import bytes from 'bytes';
+
+import { settings } from 'src/engine/constants/settings';
+import {
+ FileUploadException,
+ FileUploadExceptionCode,
+} from 'src/engine/core-modules/file/file-upload/file-upload.exception';
+
+export const assertValidDirectUploadSize = (size: number): void => {
+ const maxFileSize = bytes(settings.storage.maxDirectUploadFileSize) ?? 0;
+
+ if (!Number.isInteger(size) || size <= 0 || size > maxFileSize) {
+ throw new FileUploadException(
+ `Invalid file size ${size} (max ${maxFileSize} bytes)`,
+ FileUploadExceptionCode.FILE_TOO_LARGE,
+ {
+ userFriendlyMessage: msg`The file is empty or exceeds the maximum allowed size.`,
+ },
+ );
+ }
+};
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 016cea52568..9dea1214c24 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
@@ -88,7 +88,7 @@ export const fileFolderConfigs: Record<FileFolder, FileFolderConfig> = {
[FileFolder.AppTarball]: {
ignoreExpirationToken: false,
cacheControl: null,
- allowedMimeTypes: ANY_MIME_TYPE,
+ allowedMimeTypes: ['application/gzip'],
},
[FileFolder.GeneratedSdkClient]: {
ignoreExpirationToken: false,
diff --git a/packages/twenty-server/test/integration/metadata/suites/application/direct-app-tarball-upload.integration-spec.ts b/packages/twenty-server/test/integration/metadata/suites/application/direct-app-tarball-upload.integration-spec.ts
new file mode 100644
index 00000000000..646a0893ab0
--- /dev/null
+++ b/packages/twenty-server/test/integration/metadata/suites/application/direct-app-tarball-upload.integration-spec.ts
@@ -0,0 +1,587 @@
+import crypto from 'crypto';
+
+import gql from 'graphql-tag';
+import { type ApplicationRegistrationAssetService } from 'src/engine/core-modules/application/application-registration/application-registration-asset.service';
+import { type ApplicationRegistrationService } from 'src/engine/core-modules/application/application-registration/application-registration.service';
+import { completeAppTarballUpload } from 'test/integration/metadata/suites/application/utils/complete-app-tarball-upload.util';
+import { createAppTarball } from 'test/integration/metadata/suites/application/utils/create-app-tarball.util';
+import {
+ type AppTarballUploadTarget,
+ createAppTarballUpload,
+} from 'test/integration/metadata/suites/application/utils/create-app-tarball-upload.util';
+import { putApplicationFileUploadTarget } from 'test/integration/metadata/suites/application/utils/put-application-file-upload-target.util';
+import { makeMetadataAPIRequest } from 'test/integration/metadata/suites/utils/make-metadata-api-request.util';
+import { getAppProviderByClassName } from 'test/integration/utils/get-app-provider-by-class-name.util';
+import { type DataSource } from 'typeorm';
+
+const buildManifest = (universalIdentifier: string) =>
+ JSON.stringify({
+ application: {
+ universalIdentifier,
+ displayName: 'Direct Tarball App',
+ description: 'An app deployed straight to storage',
+ icon: 'IconTestPipe',
+ defaultRoleUniversalIdentifier: crypto.randomUUID(),
+ applicationVariables: {},
+ packageJsonChecksum: null,
+ yarnLockChecksum: null,
+ },
+ roles: [],
+ skills: [],
+ objects: [],
+ fields: [],
+ logicFunctions: [],
+ frontComponents: [],
+ publicAssets: [],
+ views: [],
+ navigationMenuItems: [],
+ pageLayouts: [],
+ pageLayoutTabs: [],
+ pageLayoutWidgets: [],
+ });
+
+const buildPackageJson = (version: string) =>
+ JSON.stringify({ name: 'direct-tarball-app', version });
+
+const buildValidTarball = ({
+ universalIdentifier,
+ version,
+}: {
+ universalIdentifier: string;
+ version: string;
+}) =>
+ createAppTarball({
+ 'manifest.json': buildManifest(universalIdentifier),
+ 'package.json': buildPackageJson(version),
+ });
+
+describe('Direct app tarball upload', () => {
+ let ds: DataSource;
+ const createdRegistrationIds: string[] = [];
+ const createdFileIds: string[] = [];
+
+ const sendToStorage = async (tarball: Buffer) => {
+ const { data, errors } = await createAppTarballUpload({
+ size: tarball.length,
+ });
+
+ expect(errors).toBeUndefined();
+
+ const uploadTarget = data!.createFileUpload;
+
+ createdFileIds.push(uploadTarget.fileId);
+
+ const putResponse = await putApplicationFileUploadTarget({
+ uploadTarget,
+ body: tarball,
+ });
+
+ expect(putResponse.status).toBe(204);
+
+ return uploadTarget;
+ };
+
+ const deployTarball = async (
+ tarball: Buffer,
+ { expectToFail = false }: { expectToFail?: boolean } = {},
+ ) => {
+ const uploadTarget = await sendToStorage(tarball);
+
+ const completion = await completeAppTarballUpload({
+ fileId: uploadTarget.fileId,
+ expectToFail,
+ });
+
+ if (completion.data?.completeAppTarballUpload) {
+ createdRegistrationIds.push(completion.data.completeAppTarballUpload.id);
+ }
+
+ return { uploadTarget, completion };
+ };
+
+ const completeFileUploadGenerically = async (fileId: string) => {
+ const response = await makeMetadataAPIRequest({
+ query: gql`
+ mutation CompleteFileUpload($fileId: String!) {
+ completeFileUpload(fileId: $fileId) {
+ id
+ }
+ }
+ `,
+ variables: { fileId },
+ });
+
+ return response.body;
+ };
+
+ const findFileRow = async (fileId: string) => {
+ const [row] = await ds.query(
+ `SELECT status, "mimeType", path, size FROM core."file" WHERE id = $1`,
+ [fileId],
+ );
+
+ return row ?? null;
+ };
+
+ const findRegistrationRow = async (registrationId: string) => {
+ const [row] = await ds.query(
+ `SELECT "sourceType", "tarballFileId", "latestAvailableVersion"
+ FROM core."applicationRegistration" WHERE id = $1`,
+ [registrationId],
+ );
+
+ return row ?? null;
+ };
+
+ beforeAll(() => {
+ jest.useRealTimers();
+ ds = global.testDataSource;
+ });
+
+ afterAll(async () => {
+ for (const id of new Set(createdRegistrationIds)) {
+ await ds.query(
+ `DELETE FROM core."applicationRegistration" WHERE id = $1`,
+ [id],
+ );
+ }
+
+ for (const id of createdFileIds) {
+ await ds.query(`DELETE FROM core."file" WHERE id = $1`, [id]);
+ }
+
+ jest.useFakeTimers();
+ });
+
+ it('registers the app from a tarball sent straight to storage', async () => {
+ const universalIdentifier = crypto.randomUUID();
+ const tarball = await buildValidTarball({
+ universalIdentifier,
+ version: '1.0.0',
+ });
+
+ const {
+ uploadTarget,
+ completion: { data, errors },
+ } = await deployTarball(tarball);
+
+ expect(errors).toBeUndefined();
+ expect(data?.completeAppTarballUpload.universalIdentifier).toBe(
+ universalIdentifier,
+ );
+ expect(data?.completeAppTarballUpload.name).toBe('Direct Tarball App');
+
+ const registration = await findRegistrationRow(
+ data!.completeAppTarballUpload.id,
+ );
+
+ expect(registration).toEqual({
+ sourceType: 'tarball',
+ tarballFileId: uploadTarget.fileId,
+ latestAvailableVersion: '1.0.0',
+ });
+
+ const file = await findFileRow(uploadTarget.fileId);
+
+ expect(file.status).toBe('UPLOADED');
+ expect(file.mimeType).toBe('application/gzip');
+ expect(file.path).toBe(`app-tarball/${uploadTarget.fileId}.gz`);
+ expect(Number(file.size)).toBe(tarball.length);
+ });
+
+ it('answers a repeated completion with the same registration', async () => {
+ const universalIdentifier = crypto.randomUUID();
+ const tarball = await buildValidTarball({
+ universalIdentifier,
+ version: '1.0.0',
+ });
+
+ const { uploadTarget, completion } = await deployTarball(tarball);
+
+ const { data, errors } = await completeAppTarballUpload({
+ fileId: uploadTarget.fileId,
+ });
+
+ expect(errors).toBeUndefined();
+ expect(data?.completeAppTarballUpload.id).toBe(
+ completion.data?.completeAppTarballUpload.id,
+ );
+ });
+
+ it('replaces the previous tarball on a new version and drops it', async () => {
+ const universalIdentifier = crypto.randomUUID();
+
+ const first = await deployTarball(
+ await buildValidTarball({ universalIdentifier, version: '1.0.0' }),
+ );
+
+ expect(first.completion.errors).toBeUndefined();
+
+ const second = await deployTarball(
+ await buildValidTarball({ universalIdentifier, version: '1.1.0' }),
+ );
+
+ expect(second.completion.errors).toBeUndefined();
+ expect(second.completion.data?.completeAppTarballUpload.id).toBe(
+ first.completion.data?.completeAppTarballUpload.id,
+ );
+
+ const registration = await findRegistrationRow(
+ first.completion.data!.completeAppTarballUpload.id,
+ );
+
+ expect(registration.tarballFileId).toBe(second.uploadTarget.fileId);
+ expect(registration.latestAvailableVersion).toBe('1.1.0');
+
+ expect(await findFileRow(first.uploadTarget.fileId)).toBeNull();
+ expect((await findFileRow(second.uploadTarget.fileId)).status).toBe(
+ 'UPLOADED',
+ );
+ });
+
+ it('refuses a version that does not progress and drops the promoted file', async () => {
+ const universalIdentifier = crypto.randomUUID();
+
+ const first = await deployTarball(
+ await buildValidTarball({ universalIdentifier, version: '1.0.0' }),
+ );
+
+ expect(first.completion.errors).toBeUndefined();
+
+ const second = await deployTarball(
+ await buildValidTarball({ universalIdentifier, version: '1.0.0' }),
+ { expectToFail: true },
+ );
+
+ expect(
+ second.completion.errors?.some((error: { message: string }) =>
+ error.message.includes(
+ 'version must be higher than the currently deployed version',
+ ),
+ ),
+ ).toBe(true);
+
+ expect(await findFileRow(second.uploadTarget.fileId)).toBeNull();
+
+ const registration = await findRegistrationRow(
+ first.completion.data!.completeAppTarballUpload.id,
+ );
+
+ expect(registration.tarballFileId).toBe(first.uploadTarget.fileId);
+ });
+
+ it('registers a promoted upload whose registration was lost', async () => {
+ const universalIdentifier = crypto.randomUUID();
+
+ const { uploadTarget, completion } = await deployTarball(
+ await buildValidTarball({ universalIdentifier, version: '1.0.0' }),
+ );
+
+ expect(completion.errors).toBeUndefined();
+
+ await ds.query(`DELETE FROM core."applicationRegistration" WHERE id = $1`, [
+ completion.data!.completeAppTarballUpload.id,
+ ]);
+
+ const { data, errors } = await completeAppTarballUpload({
+ fileId: uploadTarget.fileId,
+ });
+
+ expect(errors).toBeUndefined();
+ expect(data?.completeAppTarballUpload.universalIdentifier).toBe(
+ universalIdentifier,
+ );
+
+ createdRegistrationIds.push(data!.completeAppTarballUpload.id);
+
+ const registration = await findRegistrationRow(
+ data!.completeAppTarballUpload.id,
+ );
+
+ expect(registration.tarballFileId).toBe(uploadTarget.fileId);
+ expect((await findFileRow(uploadTarget.fileId)).status).toBe('UPLOADED');
+ });
+
+ it('keeps the registration on the new tarball when a step after attaching it fails', async () => {
+ const universalIdentifier = crypto.randomUUID();
+
+ const first = await deployTarball(
+ await buildValidTarball({ universalIdentifier, version: '1.0.0' }),
+ );
+
+ expect(first.completion.errors).toBeUndefined();
+
+ const storeRegistrationAssetsSpy = jest
+ .spyOn(
+ getAppProviderByClassName<ApplicationRegistrationAssetService>(
+ 'ApplicationRegistrationAssetService',
+ ),
+ 'storeRegistrationAssets',
+ )
+ .mockRejectedValueOnce(new Error('Asset storage unavailable'));
+
+ try {
+ const second = await deployTarball(
+ await buildValidTarball({ universalIdentifier, version: '1.1.0' }),
+ { expectToFail: true },
+ );
+
+ expect(second.completion.errors).toBeDefined();
+
+ const registration = await findRegistrationRow(
+ first.completion.data!.completeAppTarballUpload.id,
+ );
+
+ expect(registration.tarballFileId).toBe(second.uploadTarget.fileId);
+ expect((await findFileRow(second.uploadTarget.fileId)).status).toBe(
+ 'UPLOADED',
+ );
+ expect((await findFileRow(first.uploadTarget.fileId)).status).toBe(
+ 'UPLOADED',
+ );
+ } finally {
+ storeRegistrationAssetsSpy.mockRestore();
+ }
+ });
+
+ it('reruns the asset and upgrade steps when a completion is retried after a late failure', async () => {
+ const universalIdentifier = crypto.randomUUID();
+
+ const first = await deployTarball(
+ await buildValidTarball({ universalIdentifier, version: '1.0.0' }),
+ );
+
+ expect(first.completion.errors).toBeUndefined();
+
+ const storeRegistrationAssetsSpy = jest
+ .spyOn(
+ getAppProviderByClassName<ApplicationRegistrationAssetService>(
+ 'ApplicationRegistrationAssetService',
+ ),
+ 'storeRegistrationAssets',
+ )
+ .mockRejectedValueOnce(new Error('Asset storage unavailable'));
+ const enqueueAutoUpgradeSpy = jest.spyOn(
+ getAppProviderByClassName<ApplicationRegistrationService>(
+ 'ApplicationRegistrationService',
+ ),
+ 'enqueueAutoUpgradeApplications',
+ );
+
+ try {
+ const second = await deployTarball(
+ await buildValidTarball({ universalIdentifier, version: '1.1.0' }),
+ { expectToFail: true },
+ );
+
+ expect(second.completion.errors).toBeDefined();
+ expect(enqueueAutoUpgradeSpy).not.toHaveBeenCalled();
+
+ const { data, errors } = await completeAppTarballUpload({
+ fileId: second.uploadTarget.fileId,
+ });
+
+ expect(errors).toBeUndefined();
+ expect(data?.completeAppTarballUpload.id).toBe(
+ first.completion.data?.completeAppTarballUpload.id,
+ );
+ expect(storeRegistrationAssetsSpy).toHaveBeenCalledTimes(2);
+ expect(enqueueAutoUpgradeSpy).toHaveBeenCalledTimes(1);
+ expect(enqueueAutoUpgradeSpy).toHaveBeenCalledWith(
+ first.completion.data?.completeAppTarballUpload.id,
+ );
+ } finally {
+ storeRegistrationAssetsSpy.mockRestore();
+ enqueueAutoUpgradeSpy.mockRestore();
+ }
+ });
+
+ it('refuses a completion that overlaps another completion of the same upload', async () => {
+ const uploadTarget = await sendToStorage(
+ await buildValidTarball({
+ universalIdentifier: crypto.randomUUID(),
+ version: '1.0.0',
+ }),
+ );
+
+ const assetService =
+ getAppProviderByClassName<ApplicationRegistrationAssetService>(
+ 'ApplicationRegistrationAssetService',
+ );
+ const storeRegistrationAssets =
+ assetService.storeRegistrationAssets.bind(assetService);
+
+ let releaseFirstCompletion = () => {};
+ const firstCompletionGate = new Promise<void>((resolve) => {
+ releaseFirstCompletion = resolve;
+ });
+
+ const storeRegistrationAssetsSpy = jest
+ .spyOn(assetService, 'storeRegistrationAssets')
+ .mockImplementationOnce(async (args) => {
+ await firstCompletionGate;
+
+ return storeRegistrationAssets(args);
+ });
+
+ try {
+ const firstCompletion = completeAppTarballUpload({
+ fileId: uploadTarget.fileId,
+ });
+
+ while (storeRegistrationAssetsSpy.mock.calls.length === 0) {
+ await new Promise((resolve) => setTimeout(resolve, 20));
+ }
+
+ const overlapping = await completeAppTarballUpload({
+ fileId: uploadTarget.fileId,
+ expectToFail: true,
+ });
+
+ expect(overlapping.errors?.[0].extensions.code).toBe('CONFLICT');
+ expect(overlapping.errors?.[0].message).toContain(
+ 'already being completed',
+ );
+
+ releaseFirstCompletion();
+
+ const first = await firstCompletion;
+
+ expect(first.errors).toBeUndefined();
+
+ createdRegistrationIds.push(first.data!.completeAppTarballUpload.id);
+
+ const retried = await completeAppTarballUpload({
+ fileId: uploadTarget.fileId,
+ });
+
+ expect(retried.errors).toBeUndefined();
+ expect(retried.data?.completeAppTarballUpload.id).toBe(
+ first.data?.completeAppTarballUpload.id,
+ );
+ } finally {
+ releaseFirstCompletion();
+ storeRegistrationAssetsSpy.mockRestore();
+ }
+ });
+
+ it('refuses the generic completion for a tarball reservation', async () => {
+ const uploadTarget = await sendToStorage(
+ await buildValidTarball({
+ universalIdentifier: crypto.randomUUID(),
+ version: '1.0.0',
+ }),
+ );
+
+ const { data, errors } = await completeFileUploadGenerically(
+ uploadTarget.fileId,
+ );
+
+ expect(data?.completeFileUpload ?? null).toBeNull();
+ expect(errors?.[0].extensions.code).toBe('BAD_USER_INPUT');
+ expect(errors?.[0].message).toContain('dedicated mutation');
+ expect((await findFileRow(uploadTarget.fileId)).status).toBe('PENDING');
+
+ const completion = await completeAppTarballUpload({
+ fileId: uploadTarget.fileId,
+ });
+
+ expect(completion.errors).toBeUndefined();
+
+ createdRegistrationIds.push(completion.data!.completeAppTarballUpload.id);
+ });
+
+ it('rejects a tarball without a manifest and drops the promoted file', async () => {
+ const tarball = await createAppTarball({
+ 'readme.txt': 'no manifest here',
+ });
+
+ const {
+ uploadTarget,
+ completion: { errors },
+ } = await deployTarball(tarball, { expectToFail: true });
+
+ expect(
+ errors?.some((error: { message: string }) =>
+ error.message.includes('manifest.json'),
+ ),
+ ).toBe(true);
+
+ expect(await findFileRow(uploadTarget.fileId)).toBeNull();
+ });
+
+ it('rejects a payload that is not a gzip archive before promoting it', async () => {
+ const body = Buffer.from('definitely not a tarball');
+
+ const { data } = await createAppTarballUpload({ size: body.length });
+ const uploadTarget = data!.createFileUpload;
+
+ createdFileIds.push(uploadTarget.fileId);
+
+ const putResponse = await putApplicationFileUploadTarget({
+ uploadTarget,
+ body,
+ });
+
+ expect(putResponse.status).toBe(204);
+
+ const { errors } = await completeAppTarballUpload({
+ fileId: uploadTarget.fileId,
+ expectToFail: true,
+ });
+
+ expect(errors).toBeDefined();
+ expect((await findFileRow(uploadTarget.fileId)).status).toBe('PENDING');
+ });
+
+ it('refuses to finalize an upload whose bytes never reached storage', async () => {
+ const tarball = await buildValidTarball({
+ universalIdentifier: crypto.randomUUID(),
+ version: '1.0.0',
+ });
+
+ const { data } = await createAppTarballUpload({ size: tarball.length });
+ const uploadTarget: AppTarballUploadTarget = data!.createFileUpload;
+
+ createdFileIds.push(uploadTarget.fileId);
+
+ const { errors } = await completeAppTarballUpload({
+ fileId: uploadTarget.fileId,
+ expectToFail: true,
+ });
+
+ expect(
+ errors?.some((error: { message: string }) =>
+ error.message.includes('has not been uploaded'),
+ ),
+ ).toBe(true);
+ expect(errors?.[0].extensions.code).toBe('BAD_USER_INPUT');
+ });
+
+ it('rejects an unknown upload', async () => {
+ const { errors } = await completeAppTarballUpload({
+ fileId: crypto.randomUUID(),
+ expectToFail: true,
+ });
+
+ expect(
+ errors?.some((error: { message: string }) =>
+ error.message.includes('not found'),
+ ),
+ ).toBe(true);
+ });
+
+ it('rejects a declared size above the direct upload limit', async () => {
+ const { errors } = await createAppTarballUpload({
+ size: 1024 * 1024 * 1024 + 1,
+ expectToFail: true,
+ });
+
+ expect(
+ errors?.some((error: { message: string }) =>
+ error.message.includes('Invalid file size'),
+ ),
+ ).toBe(true);
+ expect(errors?.[0].extensions.code).toBe('BAD_USER_INPUT');
+ });
+});
diff --git a/packages/twenty-server/test/integration/metadata/suites/application/utils/complete-app-tarball-upload-query-factory.util.ts b/packages/twenty-server/test/integration/metadata/suites/application/utils/complete-app-tarball-upload-query-factory.util.ts
new file mode 100644
index 00000000000..db9c7a8d8cd
--- /dev/null
+++ b/packages/twenty-server/test/integration/metadata/suites/application/utils/complete-app-tarball-upload-query-factory.util.ts
@@ -0,0 +1,18 @@
+import gql from 'graphql-tag';
+
+export const completeAppTarballUploadQueryFactory = ({
+ fileId,
+}: {
+ fileId: string;
+}) => ({
+ query: gql`
+ mutation CompleteAppTarballUpload($fileId: UUID!) {
+ completeAppTarballUpload(fileId: $fileId) {
+ id
+ universalIdentifier
+ name
+ }
+ }
+ `,
+ variables: { fileId },
+});
diff --git a/packages/twenty-server/test/integration/metadata/suites/application/utils/complete-app-tarball-upload.util.ts b/packages/twenty-server/test/integration/metadata/suites/application/utils/complete-app-tarball-upload.util.ts
new file mode 100644
index 00000000000..aba4e369bc6
--- /dev/null
+++ b/packages/twenty-server/test/integration/metadata/suites/application/utils/complete-app-tarball-upload.util.ts
@@ -0,0 +1,44 @@
+import { completeAppTarballUploadQueryFactory } from 'test/integration/metadata/suites/application/utils/complete-app-tarball-upload-query-factory.util';
+import { makeMetadataAPIRequest } from 'test/integration/metadata/suites/utils/make-metadata-api-request.util';
+import { type CommonResponseBody } from 'test/integration/metadata/types/common-response-body.type';
+import { warnIfErrorButNotExpectedToFail } from 'test/integration/metadata/utils/warn-if-error-but-not-expected-to-fail.util';
+import { warnIfNoErrorButExpectedToFail } from 'test/integration/metadata/utils/warn-if-no-error-but-expected-to-fail.util';
+
+export type CompleteAppTarballUploadResult = {
+ id: string;
+ universalIdentifier: string;
+ name: string;
+};
+
+export const completeAppTarballUpload = async ({
+ fileId,
+ expectToFail = false,
+ token,
+}: {
+ fileId: string;
+ expectToFail?: boolean;
+ token?: string;
+}): CommonResponseBody<{
+ completeAppTarballUpload: CompleteAppTarballUploadResult;
+}> => {
+ const graphqlOperation = completeAppTarballUploadQueryFactory({ fileId });
+
+ const response = await makeMetadataAPIRequest(graphqlOperation, token);
+
+ if (expectToFail === true) {
+ warnIfNoErrorButExpectedToFail({
+ response,
+ errorMessage:
+ 'Complete app tarball upload should have failed but did not',
+ });
+ }
+
+ if (expectToFail === false) {
+ warnIfErrorButNotExpectedToFail({
+ response,
+ errorMessage: 'Complete app tarball upload has failed but should not',
+ });
+ }
+
+ return { data: response.body.data, errors: response.body.errors };
+};
diff --git a/packages/twenty-server/test/integration/metadata/suites/application/utils/create-app-tarball-upload-query-factory.util.ts b/packages/twenty-server/test/integration/metadata/suites/application/utils/create-app-tarball-upload-query-factory.util.ts
new file mode 100644
index 00000000000..b79091920c0
--- /dev/null
+++ b/packages/twenty-server/test/integration/metadata/suites/application/utils/create-app-tarball-upload-query-factory.util.ts
@@ -0,0 +1,25 @@
+import gql from 'graphql-tag';
+
+export const createAppTarballUploadQueryFactory = ({
+ filename,
+ size,
+}: {
+ filename: string;
+ size: number;
+}) => ({
+ query: gql`
+ mutation CreateAppTarballUpload($filename: String!, $size: Float!) {
+ createFileUpload(
+ filename: $filename
+ size: $size
+ fileFolder: AppTarball
+ ) {
+ fileId
+ uploadUrl
+ contentType
+ expiresAt
+ }
+ }
+ `,
+ variables: { filename, size },
+});
diff --git a/packages/twenty-server/test/integration/metadata/suites/application/utils/create-app-tarball-upload.util.ts b/packages/twenty-server/test/integration/metadata/suites/application/utils/create-app-tarball-upload.util.ts
new file mode 100644
index 00000000000..cb27eff4da9
--- /dev/null
+++ b/packages/twenty-server/test/integration/metadata/suites/application/utils/create-app-tarball-upload.util.ts
@@ -0,0 +1,49 @@
+import { createAppTarballUploadQueryFactory } from 'test/integration/metadata/suites/application/utils/create-app-tarball-upload-query-factory.util';
+import { makeMetadataAPIRequest } from 'test/integration/metadata/suites/utils/make-metadata-api-request.util';
+import { type CommonResponseBody } from 'test/integration/metadata/types/common-response-body.type';
+import { warnIfErrorButNotExpectedToFail } from 'test/integration/metadata/utils/warn-if-error-but-not-expected-to-fail.util';
+import { warnIfNoErrorButExpectedToFail } from 'test/integration/metadata/utils/warn-if-no-error-but-expected-to-fail.util';
+
+export type AppTarballUploadTarget = {
+ fileId: string;
+ uploadUrl: string;
+ contentType: string;
+ expiresAt: string;
+};
+
+export const createAppTarballUpload = async ({
+ filename = 'app.tar.gz',
+ size,
+ expectToFail = false,
+ token,
+}: {
+ filename?: string;
+ size: number;
+ expectToFail?: boolean;
+ token?: string;
+}): CommonResponseBody<{
+ createFileUpload: AppTarballUploadTarget;
+}> => {
+ const graphqlOperation = createAppTarballUploadQueryFactory({
+ filename,
+ size,
+ });
+
+ const response = await makeMetadataAPIRequest(graphqlOperation, token);
+
+ if (expectToFail === true) {
+ warnIfNoErrorButExpectedToFail({
+ response,
+ errorMessage: 'Create app tarball upload should have failed but did not',
+ });
+ }
+
+ if (expectToFail === false) {
+ warnIfErrorButNotExpectedToFail({
+ response,
+ errorMessage: 'Create app tarball upload has failed but should not',
+ });
+ }
+
+ return { data: response.body.data, errors: response.body.errors };
+};
diff --git a/packages/twenty-server/test/integration/metadata/suites/application/utils/put-application-file-upload-target.util.ts b/packages/twenty-server/test/integration/metadata/suites/application/utils/put-application-file-upload-target.util.ts
index 116658f3a2e..3cc68e9fec7 100644
--- a/packages/twenty-server/test/integration/metadata/suites/application/utils/put-application-file-upload-target.util.ts
+++ b/packages/twenty-server/test/integration/metadata/suites/application/utils/put-application-file-upload-target.util.ts
@@ -6,7 +6,7 @@ export const putApplicationFileUploadTarget = ({
uploadTarget,
body,
}: {
- uploadTarget: ApplicationFileUploadTarget;
+ uploadTarget: Pick<ApplicationFileUploadTarget, 'uploadUrl' | 'contentType'>;
body: Buffer;
}) => {
const { pathname, search } = new URL(uploadTarget.uploadUrl);