Add uninstall button to application setting (#15988)

As title

<img width="878" height="668" alt="image"
src="https://github.com/user-attachments/assets/b0c9ae1e-036f-4bdd-9bd2-a2a37c2e3b99"
/>
This commit is contained in:
martmull
2025-11-21 15:45:07 +01:00
committed by GitHub
parent 1fa9c45879
commit 445b76fa26
25 changed files with 352 additions and 59 deletions
@@ -0,0 +1,70 @@
import { InjectRepository } from '@nestjs/typeorm';
import { Repository } from 'typeorm';
import { Command } from 'nest-commander';
import { WorkspaceEntity } from 'src/engine/core-modules/workspace/workspace.entity';
import { TwentyORMGlobalManager } from 'src/engine/twenty-orm/twenty-orm-global.manager';
import { ApplicationEntity } from 'src/engine/core-modules/application/application.entity';
import { ApplicationService } from 'src/engine/core-modules/application/application.service';
import {
ActiveOrSuspendedWorkspacesMigrationCommandRunner,
RunOnWorkspaceArgs,
} from 'src/database/commands/command-runners/active-or-suspended-workspaces-migration.command-runner';
import { TWENTY_STANDARD_APPLICATION } from 'src/engine/workspace-manager/workspace-sync-metadata/constants/twenty-standard-applications';
@Command({
name: 'upgrade:1-12:set-standard-application-not-uninstallable',
description: 'Set canBeUninstalled flag to false for standard applications',
})
export class SetStandardApplicationNotUninstallableCommand extends ActiveOrSuspendedWorkspacesMigrationCommandRunner {
constructor(
@InjectRepository(WorkspaceEntity)
protected readonly workspaceRepository: Repository<WorkspaceEntity>,
protected readonly twentyORMGlobalManager: TwentyORMGlobalManager,
@InjectRepository(ApplicationEntity)
private readonly applicationRepository: Repository<ApplicationEntity>,
private readonly applicationService: ApplicationService,
) {
super(workspaceRepository, twentyORMGlobalManager);
}
override async runOnWorkspace({
workspaceId,
options,
}: RunOnWorkspaceArgs): Promise<void> {
try {
this.logger.log(
`Checking standard applications for workspace ${workspaceId}`,
);
const existingApplications = await this.applicationRepository.find({
where: [
{
workspaceId,
universalIdentifier:
TWENTY_STANDARD_APPLICATION.universalIdentifier,
},
{
workspaceId,
description: 'Workspace custom application',
sourcePath: 'workspace-custom',
},
],
});
if (options.dryRun) {
return;
}
for (const existingApplication of existingApplications) {
await this.applicationService.update(existingApplication.id, {
canBeUninstalled: false,
});
}
this.logger.log(`Successfully updated standard applications`);
} catch (e) {
this.logger.error(`Failed to update standard applications`, e);
}
}
}
@@ -0,0 +1,19 @@
import { Module } from '@nestjs/common';
import { TypeOrmModule } from '@nestjs/typeorm';
import { WorkspaceEntity } from 'src/engine/core-modules/workspace/workspace.entity';
import { ApplicationEntity } from 'src/engine/core-modules/application/application.entity';
import { WorkspaceSchemaManagerModule } from 'src/engine/twenty-orm/workspace-schema-manager/workspace-schema-manager.module';
import { ApplicationModule } from 'src/engine/core-modules/application/application.module';
import { SetStandardApplicationNotUninstallableCommand } from 'src/database/commands/upgrade-version-command/1-12/1-12-set-standard-application-not-uninstallable.command';
@Module({
imports: [
TypeOrmModule.forFeature([WorkspaceEntity, ApplicationEntity]),
WorkspaceSchemaManagerModule,
ApplicationModule,
],
providers: [SetStandardApplicationNotUninstallableCommand],
exports: [SetStandardApplicationNotUninstallableCommand],
})
export class V1_12_UpgradeVersionCommandModule {}
@@ -6,6 +6,7 @@ import { V1_11_UpgradeVersionCommandModule } from 'src/database/commands/upgrade
import { V1_6_UpgradeVersionCommandModule } from 'src/database/commands/upgrade-version-command/1-6/1-6-upgrade-version-command.module';
import { V1_7_UpgradeVersionCommandModule } from 'src/database/commands/upgrade-version-command/1-7/1-7-upgrade-version-command.module';
import { V1_8_UpgradeVersionCommandModule } from 'src/database/commands/upgrade-version-command/1-8/1-8-upgrade-version-command.module';
import { V1_12_UpgradeVersionCommandModule } from 'src/database/commands/upgrade-version-command/1-12/1-12-upgrade-version-command.module';
import { UpgradeCommand } from 'src/database/commands/upgrade-version-command/upgrade.command';
import { WorkspaceEntity } from 'src/engine/core-modules/workspace/workspace.entity';
import { WorkspaceSyncMetadataModule } from 'src/engine/workspace-manager/workspace-sync-metadata/workspace-sync-metadata.module';
@@ -18,6 +19,7 @@ import { WorkspaceSyncMetadataModule } from 'src/engine/workspace-manager/worksp
V1_8_UpgradeVersionCommandModule,
V1_10_UpgradeVersionCommandModule,
V1_11_UpgradeVersionCommandModule,
V1_12_UpgradeVersionCommandModule,
WorkspaceSyncMetadataModule,
],
providers: [UpgradeCommand],
@@ -33,6 +33,7 @@ import { TwentyConfigService } from 'src/engine/core-modules/twenty-config/twent
import { WorkspaceEntity } from 'src/engine/core-modules/workspace/workspace.entity';
import { TwentyORMGlobalManager } from 'src/engine/twenty-orm/twenty-orm-global.manager';
import { SyncWorkspaceMetadataCommand } from 'src/engine/workspace-manager/workspace-sync-metadata/commands/sync-workspace-metadata.command';
import { SetStandardApplicationNotUninstallableCommand } from 'src/database/commands/upgrade-version-command/1-12/1-12-set-standard-application-not-uninstallable.command';
@Command({
name: 'upgrade',
@@ -77,6 +78,9 @@ export class UpgradeCommand extends UpgradeCommandRunner {
protected readonly cleanOrphanedUserWorkspacesCommand: CleanOrphanedUserWorkspacesCommand,
protected readonly cleanOrphanedRoleTargetsCommand: CleanOrphanedRoleTargetsCommand,
protected readonly seedStandardApplicationsCommand: CreateTwentyStandardApplicationCommand,
// 1.12 Commands
protected readonlysetStandardApplicationNotUninstallableCommand: SetStandardApplicationNotUninstallableCommand,
) {
super(
workspaceRepository,
@@ -133,12 +137,20 @@ export class UpgradeCommand extends UpgradeCommandRunner {
],
};
const commands_1120: VersionCommands = {
beforeSyncMetadata: [],
afterSyncMetadata: [
this.readonlysetStandardApplicationNotUninstallableCommand,
],
};
this.allCommands = {
'1.6.0': commands_160,
'1.7.0': commands_170,
'1.8.0': commands_180,
'1.10.0': commands_1100,
'1.11.0': commands_1110,
'1.12.0': commands_1120,
};
}
@@ -0,0 +1,19 @@
import { type MigrationInterface, type QueryRunner } from 'typeorm';
export class AddCanBeUninstalledColumnToApplication1763731277403
implements MigrationInterface
{
name = 'AddCanBeUninstalledColumnToApplication1763731277403';
public async up(queryRunner: QueryRunner): Promise<void> {
await queryRunner.query(
`ALTER TABLE "core"."application" ADD "canBeUninstalled" boolean NOT NULL DEFAULT true`,
);
}
public async down(queryRunner: QueryRunner): Promise<void> {
await queryRunner.query(
`ALTER TABLE "core"."application" DROP COLUMN "canBeUninstalled"`,
);
}
}
@@ -6,7 +6,10 @@ import {
ApplicationException,
ApplicationExceptionCode,
} from 'src/engine/core-modules/application/application.exception';
import { NotFoundError } from 'src/engine/core-modules/graphql/utils/graphql-errors.util';
import {
NotFoundError,
UserInputError,
} from 'src/engine/core-modules/graphql/utils/graphql-errors.util';
@Catch(ApplicationException)
export class ApplicationExceptionFilter implements ExceptionFilter {
@@ -18,6 +21,8 @@ export class ApplicationExceptionFilter implements ExceptionFilter {
case ApplicationExceptionCode.APPLICATION_NOT_FOUND:
case ApplicationExceptionCode.SERVERLESS_FUNCTION_NOT_FOUND:
throw new NotFoundError(exception);
case ApplicationExceptionCode.FORBIDDEN:
throw new UserInputError(exception);
default: {
assertUnreachable(exception.code);
}
@@ -926,7 +926,7 @@ export class ApplicationSyncService {
}
}
public async deleteApplication({
public async uninstallApplication({
workspaceId,
applicationUniversalIdentifier,
}: {
@@ -959,6 +959,13 @@ export class ApplicationSyncService {
);
}
if (!application.canBeUninstalled) {
throw new ApplicationException(
'This application cannot be uninstalled.',
ApplicationExceptionCode.FORBIDDEN,
);
}
const flatObjectMetadataMapsByApplicationId =
getFlatEntitiesByApplicationId(
existingFlatObjectMetadataMaps,
@@ -59,6 +59,9 @@ export class ApplicationEntity {
@Column({ nullable: true, type: 'uuid' })
serverlessFunctionLayerId: string | null;
@Column({ nullable: false, type: 'boolean', default: true })
canBeUninstalled: boolean;
@ManyToOne(() => WorkspaceEntity, {
onDelete: 'CASCADE',
})
@@ -8,4 +8,5 @@ export enum ApplicationExceptionCode {
SERVERLESS_FUNCTION_NOT_FOUND = 'SERVERLESS_FUNCTION_NOT_FOUND',
ENTITY_NOT_FOUND = 'ENTITY_NOT_FOUND',
APPLICATION_NOT_FOUND = 'APPLICATION_NOT_FOUND',
FORBIDDEN = 'FORBIDDEN',
}
@@ -7,7 +7,7 @@ import { ApplicationSyncService } from 'src/engine/core-modules/application/appl
import { ApplicationService } from 'src/engine/core-modules/application/application.service';
import { ApplicationDTO } from 'src/engine/core-modules/application/dtos/application.dto';
import { ApplicationInput } from 'src/engine/core-modules/application/dtos/application.input';
import { DeleteApplicationInput } from 'src/engine/core-modules/application/dtos/deleteApplication.input';
import { UninstallApplicationInput } from 'src/engine/core-modules/application/dtos/uninstallApplicationInput';
import { FeatureFlagKey } from 'src/engine/core-modules/feature-flag/enums/feature-flag-key.enum';
import { WorkspaceEntity } from 'src/engine/core-modules/workspace/workspace.entity';
import { AuthWorkspace } from 'src/engine/decorators/auth/auth-workspace.decorator';
@@ -61,11 +61,11 @@ export class ApplicationResolver {
}
@Mutation(() => Boolean)
async deleteApplication(
@Args() { universalIdentifier }: DeleteApplicationInput,
async uninstallApplication(
@Args() { universalIdentifier }: UninstallApplicationInput,
@AuthWorkspace() { id: workspaceId }: WorkspaceEntity,
) {
await this.applicationSyncService.deleteApplication({
await this.applicationSyncService.uninstallApplication({
applicationUniversalIdentifier: universalIdentifier,
workspaceId,
});
@@ -1,6 +1,6 @@
import { Field, ObjectType } from '@nestjs/graphql';
import { IsNotEmpty, IsString, IsUUID } from 'class-validator';
import { IsBoolean, IsNotEmpty, IsString, IsUUID } from 'class-validator';
import { UUIDScalarType } from 'src/engine/api/graphql/workspace-schema-builder/graphql-types/scalars';
import { ApplicationVariableEntityDTO } from 'src/engine/core-modules/applicationVariable/dtos/application-variable.dto';
@@ -27,6 +27,14 @@ export class ApplicationDTO {
@Field()
version: string;
@IsString()
@Field()
universalIdentifier: string;
@Field(() => Boolean)
@IsBoolean()
canBeUninstalled: boolean;
@Field(() => [AgentDTO])
agents: AgentDTO[];
@@ -38,8 +46,4 @@ export class ApplicationDTO {
@Field(() => [ApplicationVariableEntityDTO])
applicationVariables: ApplicationVariableEntityDTO[];
@IsString()
@Field()
universalIdentifier: string;
}
@@ -1,7 +1,7 @@
import { ArgsType, Field } from '@nestjs/graphql';
@ArgsType()
export class DeleteApplicationInput {
export class UninstallApplicationInput {
@Field(() => String)
universalIdentifier: string;
}
@@ -8,6 +8,7 @@ export const TWENTY_STANDARD_APPLICATION = {
version: '1.0.0',
sourcePath: 'cli-sync',
sourceType: 'local',
canBeUninstalled: false,
} as const satisfies CreateApplicationInput;
export type CreateApplicationInput = Omit<
@@ -24,5 +25,3 @@ export type CreateApplicationInput = Omit<
| 'objects'
| 'serverlessFunctions'
>;
export type TwentyStandardApplicationUniversalIdentifiers =
(typeof TWENTY_STANDARD_APPLICATION)['universalIdentifier'];
@@ -20,6 +20,7 @@ export const computeWorkspaceCustomCreateApplicationInput = ({
universalIdentifier: applicationId,
workspaceId: workspace.id,
id: applicationId,
canBeUninstalled: false,
}) as const satisfies CreateApplicationInput & {
workspaceId: string;
id: string;