Skip to content

The open alternative to Salesforce, designed for AI.

fix(apps): do not fan out auto upgrades to workspaces behind the app's required server version (#26608)

Charles Bochet74d11ef841f2
diff --git a/packages/twenty-server/src/engine/core-modules/application/application-upgrade/__tests__/application-upgrade.service.spec.ts b/packages/twenty-server/src/engine/core-modules/application/application-upgrade/__tests__/application-upgrade.service.spec.ts
index 7579069709d..ff847a5fea5 100644
--- a/packages/twenty-server/src/engine/core-modules/application/application-upgrade/__tests__/application-upgrade.service.spec.ts
+++ b/packages/twenty-server/src/engine/core-modules/application/application-upgrade/__tests__/application-upgrade.service.spec.ts
@@ -2,6 +2,7 @@ import { Test, type TestingModule } from '@nestjs/testing';
import { getRepositoryToken } from '@nestjs/typeorm';
import { ApplicationInstallService } from 'src/engine/core-modules/application/application-install/application-install.service';
+import { ApplicationVersionValidationService } from 'src/engine/core-modules/application/application-package/application-version-validation.service';
import { ApplicationRegistrationEntity } from 'src/engine/core-modules/application/application-registration/application-registration.entity';
import { ApplicationRegistrationSourceType } from 'src/engine/core-modules/application/application-registration/enums/application-registration-source-type.enum';
import { ApplicationUpgradeService } from 'src/engine/core-modules/application/application-upgrade/application-upgrade.service';
@@ -20,6 +21,8 @@ const APPLICATION_REGISTRATION_ID = '20202020-0000-0000-0000-000000000001';
const OUTDATED_WORKSPACE_ID = '20202020-0000-0000-0000-000000000002';
const UP_TO_DATE_WORKSPACE_ID = '20202020-0000-0000-0000-000000000003';
const NON_PROVISIONED_WORKSPACE_ID = '20202020-0000-0000-0000-000000000004';
+const BEHIND_SERVER_VERSION_WORKSPACE_ID =
+ '20202020-0000-0000-0000-100000000000';
const TARGET_VERSION = '2.0.0';
const appRegistration = {
@@ -55,6 +58,9 @@ describe('ApplicationUpgradeService', () => {
const applicationRepository = { find: jest.fn(), findOne: jest.fn() };
const applicationInstallService = { installApplication: jest.fn() };
const workspaceVersionService = { getProvisionedWorkspaceIds: jest.fn() };
+ const applicationVersionValidationService = {
+ validateWorkspaceCompatibility: jest.fn(),
+ };
const applicationUpgradeQueueService = { bulkAdd: jest.fn() };
beforeEach(async () => {
@@ -71,6 +77,16 @@ describe('ApplicationUpgradeService', () => {
jobs.map((_job, index) => `job-${index}`),
);
applicationInstallService.installApplication.mockResolvedValue(true);
+ applicationVersionValidationService.validateWorkspaceCompatibility.mockImplementation(
+ async ({ workspaceId }: { workspaceId: string }) =>
+ workspaceId === BEHIND_SERVER_VERSION_WORKSPACE_ID
+ ? {
+ compatible: false,
+ reason: 'WORKSPACE_INCOMPATIBLE',
+ message: 'behind',
+ }
+ : { compatible: true },
+ );
const module: TestingModule = await Test.createTestingModule({
providers: [
@@ -91,6 +107,10 @@ describe('ApplicationUpgradeService', () => {
provide: ApplicationInstallService,
useValue: applicationInstallService,
},
+ {
+ provide: ApplicationVersionValidationService,
+ useValue: applicationVersionValidationService,
+ },
{
provide: WorkspaceVersionService,
useValue: workspaceVersionService,
@@ -144,6 +164,43 @@ describe('ApplicationUpgradeService', () => {
);
});
+ it('does not enqueue a workspace that has not finished the server upgrade the target version requires', async () => {
+ workspaceVersionService.getProvisionedWorkspaceIds.mockResolvedValue([
+ OUTDATED_WORKSPACE_ID,
+ BEHIND_SERVER_VERSION_WORKSPACE_ID,
+ ]);
+ applicationRepository.find.mockResolvedValue([
+ buildApplication({
+ workspaceId: OUTDATED_WORKSPACE_ID,
+ version: '1.0.0',
+ }),
+ buildApplication({
+ workspaceId: BEHIND_SERVER_VERSION_WORKSPACE_ID,
+ version: '1.0.0',
+ }),
+ ]);
+
+ const jobIds = await service.enqueueApplicationUpgrades({
+ applicationRegistrationId: APPLICATION_REGISTRATION_ID,
+ onlyAutoUpgrade: true,
+ });
+
+ expect(jobIds).toEqual(['job-0']);
+ expect(applicationUpgradeQueueService.bulkAdd).toHaveBeenCalledWith(
+ UPGRADE_WORKSPACE_APPLICATION_JOB_NAME,
+ [
+ {
+ data: {
+ applicationRegistrationId: APPLICATION_REGISTRATION_ID,
+ workspaceId: OUTDATED_WORKSPACE_ID,
+ onlyAutoUpgrade: true,
+ },
+ },
+ ],
+ UPGRADE_WORKSPACE_APPLICATION_JOB_OPTIONS,
+ );
+ });
+
it('splits a large fan-out into several bulk adds', async () => {
const workspaceIds = Array.from(
{ length: UPGRADE_WORKSPACE_APPLICATION_JOB_ENQUEUE_BATCH_SIZE + 1 },
diff --git a/packages/twenty-server/src/engine/core-modules/application/application-upgrade/application-upgrade.module.ts b/packages/twenty-server/src/engine/core-modules/application/application-upgrade/application-upgrade.module.ts
index 510095f366a..55d2c7d6314 100644
--- a/packages/twenty-server/src/engine/core-modules/application/application-upgrade/application-upgrade.module.ts
+++ b/packages/twenty-server/src/engine/core-modules/application/application-upgrade/application-upgrade.module.ts
@@ -2,6 +2,7 @@ import { Module } from '@nestjs/common';
import { TypeOrmModule } from '@nestjs/typeorm';
import { ApplicationInstallModule } from 'src/engine/core-modules/application/application-install/application-install.module';
+import { ApplicationPackageModule } from 'src/engine/core-modules/application/application-package/application-package.module';
import { ApplicationEntity } from 'src/engine/core-modules/application/application.entity';
import { ApplicationRegistrationEntity } from 'src/engine/core-modules/application/application-registration/application-registration.entity';
import { ApplicationRegistrationModule } from 'src/engine/core-modules/application/application-registration/application-registration.module';
@@ -21,6 +22,7 @@ import { provideWorkspaceScopedRepository } from 'src/engine/twenty-orm/workspac
ApplicationRegistrationEntity,
]),
ApplicationInstallModule,
+ ApplicationPackageModule,
// Nothing here injects from these two modules any more, but the generated
// metadata GraphQL schema follows Nest's module registration order, so
// dropping them reorders the checked-in client schema.
diff --git a/packages/twenty-server/src/engine/core-modules/application/application-upgrade/application-upgrade.service.ts b/packages/twenty-server/src/engine/core-modules/application/application-upgrade/application-upgrade.service.ts
index 3f22f9851b7..91aed8474d2 100644
--- a/packages/twenty-server/src/engine/core-modules/application/application-upgrade/application-upgrade.service.ts
+++ b/packages/twenty-server/src/engine/core-modules/application/application-upgrade/application-upgrade.service.ts
@@ -6,6 +6,7 @@ import { isDefined, isNonEmptyArray } from 'twenty-shared/utils';
import { In, Repository } from 'typeorm';
import { ApplicationInstallService } from 'src/engine/core-modules/application/application-install/application-install.service';
+import { ApplicationVersionValidationService } from 'src/engine/core-modules/application/application-package/application-version-validation.service';
import { ApplicationRegistrationEntity } from 'src/engine/core-modules/application/application-registration/application-registration.entity';
import { ApplicationRegistrationSourceType } from 'src/engine/core-modules/application/application-registration/enums/application-registration-source-type.enum';
import { ApplicationEntity } from 'src/engine/core-modules/application/application.entity';
@@ -41,6 +42,7 @@ export class ApplicationUpgradeService {
@InjectRepository(ApplicationEntity)
private readonly unscopedApplicationRepository: Repository<ApplicationEntity>,
private readonly applicationInstallService: ApplicationInstallService,
+ private readonly applicationVersionValidationService: ApplicationVersionValidationService,
private readonly workspaceVersionService: WorkspaceVersionService,
@InjectMessageQueue(MessageQueue.applicationUpgradeQueue)
private readonly applicationUpgradeQueueService: MessageQueueService,
@@ -61,6 +63,7 @@ export class ApplicationUpgradeService {
targetVersion: string | null;
applicationsToUpgrade: ApplicationEntity[];
skippedNonProvisionedWorkspaceIds: string[];
+ skippedIncompatibleWorkspaceIds: string[];
}> {
const appRegistration = await this.appRegistrationRepository.findOneOrFail({
where: { id: applicationRegistrationId },
@@ -74,6 +77,7 @@ export class ApplicationUpgradeService {
targetVersion: null,
applicationsToUpgrade: [],
skippedNonProvisionedWorkspaceIds: [],
+ skippedIncompatibleWorkspaceIds: [],
};
}
@@ -105,15 +109,40 @@ export class ApplicationUpgradeService {
)
.map((application) => application.workspaceId);
+ const requiredServerVersion =
+ appRegistration.manifest?.application.requiredServerVersionRange ??
+ undefined;
+
+ const compatibleApplications: ApplicationEntity[] = [];
+ const skippedIncompatibleWorkspaceIds: string[] = [];
+
+ for (const application of provisionedApplications) {
+ const validation =
+ await this.applicationVersionValidationService.validateWorkspaceCompatibility(
+ { requiredServerVersion, workspaceId: application.workspaceId },
+ );
+
+ if (
+ !validation.compatible &&
+ validation.reason === 'WORKSPACE_INCOMPATIBLE'
+ ) {
+ skippedIncompatibleWorkspaceIds.push(application.workspaceId);
+ continue;
+ }
+
+ compatibleApplications.push(application);
+ }
+
const applicationsToUpgrade = isDefined(workspaceCountLimit)
- ? provisionedApplications.slice(0, workspaceCountLimit)
- : provisionedApplications;
+ ? compatibleApplications.slice(0, workspaceCountLimit)
+ : compatibleApplications;
return {
appRegistration,
targetVersion,
applicationsToUpgrade,
skippedNonProvisionedWorkspaceIds,
+ skippedIncompatibleWorkspaceIds,
};
}
@@ -162,16 +191,26 @@ export class ApplicationUpgradeService {
applicationRegistrationId: string;
onlyAutoUpgrade?: boolean;
}): Promise<string[]> {
- const { appRegistration, targetVersion, applicationsToUpgrade } =
- await this.findApplicationsToUpgrade({
- applicationRegistrationId,
- onlyAutoUpgrade,
- });
+ const {
+ appRegistration,
+ targetVersion,
+ applicationsToUpgrade,
+ skippedIncompatibleWorkspaceIds,
+ } = await this.findApplicationsToUpgrade({
+ applicationRegistrationId,
+ onlyAutoUpgrade,
+ });
if (!isDefined(targetVersion)) {
return [];
}
+ if (skippedIncompatibleWorkspaceIds.length > 0) {
+ this.logger.log(
+ `Skipping ${skippedIncompatibleWorkspaceIds.length} workspace(s) that have not finished the server upgrade ${appRegistration.universalIdentifier}@${targetVersion} requires`,
+ );
+ }
+
const jobIds = await this.enqueueWorkspaceApplicationUpgrades({
applicationRegistrationId,
applications: applicationsToUpgrade,
diff --git a/packages/twenty-server/src/engine/core-modules/application/application-upgrade/commands/upgrade-application.command.ts b/packages/twenty-server/src/engine/core-modules/application/application-upgrade/commands/upgrade-application.command.ts
index 0565a18e66d..deb40f39021 100644
--- a/packages/twenty-server/src/engine/core-modules/application/application-upgrade/commands/upgrade-application.command.ts
+++ b/packages/twenty-server/src/engine/core-modules/application/application-upgrade/commands/upgrade-application.command.ts
@@ -121,6 +121,7 @@ export class UpgradeApplicationCommand extends CommandRunner {
targetVersion,
applicationsToUpgrade,
skippedNonProvisionedWorkspaceIds,
+ skippedIncompatibleWorkspaceIds,
} = await this.applicationUpgradeService.findApplicationsToUpgrade({
applicationRegistrationId: registration.id,
onlyAutoUpgrade: false,
@@ -142,6 +143,12 @@ export class UpgradeApplicationCommand extends CommandRunner {
);
}
+ if (skippedIncompatibleWorkspaceIds.length > 0) {
+ this.logger.warn(
+ `Skipping ${skippedIncompatibleWorkspaceIds.length} workspace(s) that have not finished the server upgrade ${targetVersion} requires: ${skippedIncompatibleWorkspaceIds.join(', ')}`,
+ );
+ }
+
const impactedWorkspaceIds = applicationsToUpgrade.map(
(application) => application.workspaceId,
);