The open alternative to Salesforce, designed for AI.
TypeScript crmcrm-systemcustomergood-first-issuegraphqlhacktoberfestjavascriptmarketingmonoreponestjsopen-sourcepostgresqlreactreactjssalestypescriptweb
Writability 2/3: declare SYSTEM writability on platform-owned standard objects (#25471)
Félix Malfait10c1d6fd9594
diff --git a/packages/twenty-server/src/database/commands/upgrade-version-command/2-39/2-39-upgrade-version-command.module.ts b/packages/twenty-server/src/database/commands/upgrade-version-command/2-39/2-39-upgrade-version-command.module.tsindex df4584449ea..bd8dfce5128 100644--- a/packages/twenty-server/src/database/commands/upgrade-version-command/2-39/2-39-upgrade-version-command.module.ts+++ b/packages/twenty-server/src/database/commands/upgrade-version-command/2-39/2-39-upgrade-version-command.module.ts@@ -3,7 +3,9 @@ import { Module } from '@nestjs/common';import { WorkspaceIteratorModule } from 'src/database/commands/command-runners/workspace-iterator.module';import { ConvertLogicFunctionsToPrebuiltCommand } from 'src/database/commands/upgrade-version-command/2-39/2-39-workspace-command-1788338950836-convert-logic-functions-to-prebuilt.command';import { BackfillRecordFormCommand } from 'src/database/commands/upgrade-version-command/2-39/2-39-workspace-command-1788524477000-backfill-record-form.command';+import { MarkPlatformOwnedStandardObjectsSystemCommand } from 'src/database/commands/upgrade-version-command/2-39/2-39-workspace-command-1788616958245-mark-platform-owned-standard-objects-system.command';import { TypeORMModule } from 'src/database/typeorm/typeorm.module';+import { ApplicationModule } from 'src/engine/core-modules/application/application.module';import { FeatureFlagModule } from 'src/engine/core-modules/feature-flag/feature-flag.module';import { WorkspaceManyOrAllFlatEntityMapsCacheModule } from 'src/engine/metadata-modules/flat-entity/services/workspace-many-or-all-flat-entity-maps-cache.module';import { WorkspaceCacheModule } from 'src/engine/workspace-cache/workspace-cache.module';@@ -12,6 +14,7 @@ import { WorkspaceSchemaMigrationRunnerActionHandlersModule } from 'src/engine/w@Module({imports: [+ ApplicationModule,FeatureFlagModule,TypeORMModule,WorkspaceCacheModule,@@ -20,6 +23,10 @@ import { WorkspaceSchemaMigrationRunnerActionHandlersModule } from 'src/engine/wWorkspaceMigrationModule,WorkspaceSchemaMigrationRunnerActionHandlersModule,],- providers: [ConvertLogicFunctionsToPrebuiltCommand, BackfillRecordFormCommand],+ providers: [+ ConvertLogicFunctionsToPrebuiltCommand,+ BackfillRecordFormCommand,+ MarkPlatformOwnedStandardObjectsSystemCommand,+ ],})export class V2_39_UpgradeVersionCommandModule {}diff --git a/packages/twenty-server/src/database/commands/upgrade-version-command/2-39/2-39-workspace-command-1788616958245-mark-platform-owned-standard-objects-system.command.ts b/packages/twenty-server/src/database/commands/upgrade-version-command/2-39/2-39-workspace-command-1788616958245-mark-platform-owned-standard-objects-system.command.tsnew file mode 100644index 00000000000..72889144798--- /dev/null+++ b/packages/twenty-server/src/database/commands/upgrade-version-command/2-39/2-39-workspace-command-1788616958245-mark-platform-owned-standard-objects-system.command.ts@@ -0,0 +1,121 @@+import { Command } from 'nest-commander';++import { MetadataWritability } from 'twenty-shared/types';+import { isDefined } from 'twenty-shared/utils';++import { ProvisionedWorkspaceCommandRunner } from 'src/database/commands/command-runners/provisioned-workspace.command-runner';+import { WorkspaceIteratorService } from 'src/database/commands/command-runners/workspace-iterator.service';+import { type RunOnWorkspaceArgs } from 'src/database/commands/command-runners/workspace.command-runner';+import { ApplicationService } from 'src/engine/core-modules/application/application.service';+import { RegisteredWorkspaceCommand } from 'src/engine/core-modules/upgrade/decorators/registered-workspace-command.decorator';+import { WorkspaceCacheService } from 'src/engine/workspace-cache/services/workspace-cache.service';+import { computeTwentyStandardApplicationAllFlatEntityMaps } from 'src/engine/workspace-manager/twenty-standard-application/utils/twenty-standard-application-all-flat-entity-maps.constant';+import { WorkspaceMigrationValidateBuildAndRunService } from 'src/engine/workspace-manager/workspace-migration/services/workspace-migration-validate-build-and-run-service';++@RegisteredWorkspaceCommand('2.39.0', 1788616958245)+@Command({+ name: 'upgrade:2-39:mark-platform-owned-standard-objects-system',+ description:+ 'Sync the writability of standard objects with the standard-application definitions: platform-owned objects become SYSTEM on existing workspaces',+})+export class MarkPlatformOwnedStandardObjectsSystemCommand extends ProvisionedWorkspaceCommandRunner {+ constructor(+ protected readonly workspaceIteratorService: WorkspaceIteratorService,+ private readonly applicationService: ApplicationService,+ private readonly workspaceCacheService: WorkspaceCacheService,+ private readonly workspaceMigrationValidateBuildAndRunService: WorkspaceMigrationValidateBuildAndRunService,+ ) {+ super(workspaceIteratorService);+ }++ override async runOnWorkspace({+ workspaceId,+ options,+ }: RunOnWorkspaceArgs): Promise<void> {+ const isDryRun = options.dryRun ?? false;++ const { twentyStandardFlatApplication } =+ await this.applicationService.findWorkspaceTwentyStandardAndCustomApplicationOrThrow(+ { workspaceId },+ );++ const { flatObjectMetadataMaps: existingFlatObjectMetadataMaps } =+ await this.workspaceCacheService.getOrRecompute(workspaceId, [+ 'flatObjectMetadataMaps',+ ]);++ const { allFlatEntityMaps: standardAllFlatEntityMaps } =+ computeTwentyStandardApplicationAllFlatEntityMaps({+ now: new Date().toISOString(),+ workspaceId,+ twentyStandardApplicationId: twentyStandardFlatApplication.id,+ });++ const flatObjectMetadatasToUpdate = Object.values(+ standardAllFlatEntityMaps.flatObjectMetadataMaps.byUniversalIdentifier,+ )+ .filter(isDefined)+ .filter(+ (standardFlatObjectMetadata) =>+ standardFlatObjectMetadata.writability === MetadataWritability.SYSTEM,+ )+ .map((standardFlatObjectMetadata) => {+ const existingFlatObjectMetadata =+ existingFlatObjectMetadataMaps.byUniversalIdentifier[+ standardFlatObjectMetadata.universalIdentifier+ ];++ if (+ !isDefined(existingFlatObjectMetadata) ||+ existingFlatObjectMetadata.writability ===+ standardFlatObjectMetadata.writability+ ) {+ return undefined;+ }++ return {+ ...existingFlatObjectMetadata,+ writability: standardFlatObjectMetadata.writability,+ };+ })+ .filter(isDefined);++ if (flatObjectMetadatasToUpdate.length === 0) {+ return;+ }++ this.logger.log(+ `${isDryRun ? '[DRY RUN] Would mark' : 'Marking'} ${flatObjectMetadatasToUpdate.length} standard object(s) as SYSTEM for workspace ${workspaceId}: ${flatObjectMetadatasToUpdate+ .map((flatObjectMetadata) => flatObjectMetadata.nameSingular)+ .join(', ')}`,+ );++ const validateAndBuildResult =+ await this.workspaceMigrationValidateBuildAndRunService.validateBuildAndRunWorkspaceMigration(+ {+ isSystemBuild: true,+ workspaceId,+ applicationUniversalIdentifier:+ twentyStandardFlatApplication.universalIdentifier,+ dryRun: isDryRun,+ allFlatEntityOperationByMetadataName: {+ objectMetadata: {+ flatEntityToCreate: [],+ flatEntityToDelete: [],+ flatEntityToUpdate: flatObjectMetadatasToUpdate,+ },+ },+ },+ );++ if (validateAndBuildResult.status === 'fail') {+ this.logger.error(+ `Failed to mark standard objects as SYSTEM:\n${JSON.stringify(validateAndBuildResult, null, 2)}`,+ );++ throw new Error(+ `Failed to mark standard objects as SYSTEM for workspace ${workspaceId}`,+ );+ }+ }+}diff --git a/packages/twenty-server/src/engine/twenty-orm/repository/__tests__/validate-writability-or-throw.util.spec.ts b/packages/twenty-server/src/engine/twenty-orm/repository/__tests__/validate-writability-or-throw.util.spec.tsindex d85045ac940..96c3e9c9911 100644--- a/packages/twenty-server/src/engine/twenty-orm/repository/__tests__/validate-writability-or-throw.util.spec.ts+++ b/packages/twenty-server/src/engine/twenty-orm/repository/__tests__/validate-writability-or-throw.util.spec.ts@@ -41,6 +41,11 @@ const otherApplicationContext = {application: { id: 'app-2' },} as WorkspaceAuthContext;+const systemContext = {+ type: 'system',+ workspace: { id: 'workspace-1' },+} as WorkspaceAuthContext;+const apiKeyContext = {type: 'apiKey',workspace: { id: 'workspace-1' },@@ -176,13 +181,48 @@ describe('validateWritabilityOrThrow', () => {).toThrow(/not writable/);});- it('should refuse every caller on a SYSTEM object', () => {+ it('should refuse every token-bound caller on a SYSTEM object', () => {+ for (const authContext of [+ applicationContext,+ userContextCarryingApplication,+ plainUserContext,+ apiKeyContext,+ undefined,+ ]) {+ expect(() =>+ validate({+ objectWritability: MetadataWritability.SYSTEM,+ authContext,+ }),+ ).toThrow(/not writable/);+ }+ });++ it('should let a system context write a SYSTEM object', () => {expect(() =>validate({objectWritability: MetadataWritability.SYSTEM,- authContext: applicationContext,+ authContext: systemContext,}),- ).toThrow(/not writable/);+ ).not.toThrow();+ });++ it('should let a system context write an APPLICATION object', () => {+ expect(() =>+ validate({+ objectWritability: MetadataWritability.APPLICATION,+ authContext: systemContext,+ }),+ ).not.toThrow();+ });++ it('should let a system context write a SYSTEM field', () => {+ expect(() =>+ validate({+ fieldWritability: MetadataWritability.SYSTEM,+ authContext: systemContext,+ }),+ ).not.toThrow();});it('should enforce field writability even when the object is OPEN', () => {diff --git a/packages/twenty-server/src/engine/twenty-orm/repository/validate-writability-or-throw.util.ts b/packages/twenty-server/src/engine/twenty-orm/repository/validate-writability-or-throw.util.tsindex 571b9000dab..62a9accaec7 100644--- a/packages/twenty-server/src/engine/twenty-orm/repository/validate-writability-or-throw.util.ts+++ b/packages/twenty-server/src/engine/twenty-orm/repository/validate-writability-or-throw.util.ts@@ -26,6 +26,13 @@ const isWritePermittedByWritability = ({return true;}+ // A system context is only ever built server-side (sync jobs, listeners,+ // internal services); no token strategy mints one, so it is the platform+ // itself writing and neither ownership level applies to it.+ if (isDefined(authContext) && authContext.type === 'system') {+ return true;+ }+if (writability === MetadataWritability.APPLICATION) {// Only APPLICATION_ACCESS tokens ever carry an application, so reading it// off a user-bound context cannot let an ordinary session through.diff --git a/packages/twenty-server/src/engine/workspace-manager/twenty-standard-application/utils/__tests__/standard-object-writability.spec.ts b/packages/twenty-server/src/engine/workspace-manager/twenty-standard-application/utils/__tests__/standard-object-writability.spec.tsnew file mode 100644index 00000000000..33e115cebba--- /dev/null+++ b/packages/twenty-server/src/engine/workspace-manager/twenty-standard-application/utils/__tests__/standard-object-writability.spec.ts@@ -0,0 +1,61 @@+import { MetadataWritability } from 'twenty-shared/types';+import { isDefined } from 'twenty-shared/utils';++import { computeTwentyStandardApplicationAllFlatEntityMaps } from 'src/engine/workspace-manager/twenty-standard-application/utils/twenty-standard-application-all-flat-entity-maps.constant';++const WORKSPACE_ID = '20202020-1111-4111-8111-111111111111';+const TWENTY_STANDARD_APPLICATION_ID = '20202020-2222-4222-8222-222222222222';+const NOW = '2024-01-01T00:00:00.000Z';++// Records of these objects are only ever written by the platform itself:+// sync bookkeeping rows and workflow trigger registrations. timelineActivity+// stays OPEN because merging records reparents its rows under the caller.+const SYSTEM_WRITABILITY_STANDARD_OBJECT_NAMES = [+ 'calendarChannelEventAssociation',+ 'messageChannelMessageAssociation',+ 'messageChannelMessageAssociationMessageFolder',+ 'workflowAutomatedTrigger',+];++describe('Standard object writability', () => {+ const { allFlatEntityMaps } =+ computeTwentyStandardApplicationAllFlatEntityMaps({+ now: NOW,+ workspaceId: WORKSPACE_ID,+ twentyStandardApplicationId: TWENTY_STANDARD_APPLICATION_ID,+ });++ const standardFlatObjectMetadatas = Object.values(+ allFlatEntityMaps.flatObjectMetadataMaps.byUniversalIdentifier,+ ).filter(isDefined);++ it('marks platform-owned objects SYSTEM', () => {+ const systemObjectNames = standardFlatObjectMetadatas+ .filter(+ (flatObjectMetadata) =>+ flatObjectMetadata.writability === MetadataWritability.SYSTEM,+ )+ .map((flatObjectMetadata) => flatObjectMetadata.nameSingular)+ .sort();++ expect(systemObjectNames).toEqual(SYSTEM_WRITABILITY_STANDARD_OBJECT_NAMES);+ });++ it('leaves every other standard object OPEN', () => {+ const otherWritabilities = new Set(+ standardFlatObjectMetadatas+ .filter(+ (flatObjectMetadata) =>+ !SYSTEM_WRITABILITY_STANDARD_OBJECT_NAMES.includes(+ flatObjectMetadata.nameSingular,+ ),+ )+ .map((flatObjectMetadata) => flatObjectMetadata.writability),+ );++ expect(standardFlatObjectMetadatas.length).toBeGreaterThan(+ SYSTEM_WRITABILITY_STANDARD_OBJECT_NAMES.length,+ );+ expect([...otherWritabilities]).toEqual([MetadataWritability.OPEN]);+ });+});diff --git a/packages/twenty-server/src/engine/workspace-manager/twenty-standard-application/utils/object-metadata/create-standard-flat-object-metadata.util.ts b/packages/twenty-server/src/engine/workspace-manager/twenty-standard-application/utils/object-metadata/create-standard-flat-object-metadata.util.tsindex b77f6910ad8..e03ca211553 100644--- a/packages/twenty-server/src/engine/workspace-manager/twenty-standard-application/utils/object-metadata/create-standard-flat-object-metadata.util.ts+++ b/packages/twenty-server/src/engine/workspace-manager/twenty-standard-application/utils/object-metadata/create-standard-flat-object-metadata.util.ts@@ -1,6 +1,6 @@import { msg } from '@lingui/core/macro';import { STANDARD_OBJECTS } from 'twenty-shared/metadata';-import { ObjectOpenRecordIn } from 'twenty-shared/types';+import { MetadataWritability, ObjectOpenRecordIn } from 'twenty-shared/types';import { type FlatObjectMetadata } from 'src/engine/metadata-modules/flat-object-metadata/types/flat-object-metadata.type';import { type AllStandardObjectName } from 'src/engine/workspace-manager/twenty-standard-application/types/all-standard-object-name.type';@@ -129,6 +129,7 @@ export const STANDARD_FLAT_OBJECT_METADATA_BUILDERS_BY_OBJECT_NAME = {isSystem: true,isAuditLogged: false,isUICreatable: false,+ writability: MetadataWritability.SYSTEM,labelIdentifierFieldMetadataName: 'id',},workspaceId,@@ -561,6 +562,7 @@ export const STANDARD_FLAT_OBJECT_METADATA_BUILDERS_BY_OBJECT_NAME = {isSystem: true,isAuditLogged: false,isUICreatable: false,+ writability: MetadataWritability.SYSTEM,labelIdentifierFieldMetadataName: 'id',},workspaceId,@@ -609,6 +611,7 @@ export const STANDARD_FLAT_OBJECT_METADATA_BUILDERS_BY_OBJECT_NAME = {isSystem: true,isAuditLogged: false,isUICreatable: false,+ writability: MetadataWritability.SYSTEM,labelIdentifierFieldMetadataName: 'id',},workspaceId,@@ -1141,6 +1144,7 @@ export const STANDARD_FLAT_OBJECT_METADATA_BUILDERS_BY_OBJECT_NAME = {icon: 'IconSettingsAutomation',isSystem: true,isUICreatable: false,+ writability: MetadataWritability.SYSTEM,labelIdentifierFieldMetadataName: 'id',},workspaceId,diff --git a/packages/twenty-server/src/engine/workspace-manager/twenty-standard-application/utils/object-metadata/create-standard-object-flat-metadata.util.ts b/packages/twenty-server/src/engine/workspace-manager/twenty-standard-application/utils/object-metadata/create-standard-object-flat-metadata.util.tsindex eb216cd52ab..b45cfe414ec 100644--- a/packages/twenty-server/src/engine/workspace-manager/twenty-standard-application/utils/object-metadata/create-standard-object-flat-metadata.util.ts+++ b/packages/twenty-server/src/engine/workspace-manager/twenty-standard-application/utils/object-metadata/create-standard-object-flat-metadata.util.ts@@ -24,6 +24,7 @@ export type CreateStandardObjectContext<O extends AllStandardObjectName> = {isAuditLogged?: boolean;isUIEditable?: boolean;isUICreatable?: boolean;+ writability?: MetadataWritability;openRecordIn?: ObjectOpenRecordIn;shortcut?: string | null;duplicateCriteria?: string[][] | null;@@ -54,6 +55,7 @@ export const createStandardObjectFlatMetadata = <isAuditLogged = true,isUIEditable = true,isUICreatable = true,+ writability = MetadataWritability.OPEN,openRecordIn = ObjectOpenRecordIn.USER_CHOICE,shortcut = null,duplicateCriteria = null,@@ -97,7 +99,7 @@ export const createStandardObjectFlatMetadata = <isAuditLogged,isUIEditable,isUICreatable,- writability: MetadataWritability.OPEN,+ writability,readability: MetadataReadability.OPEN,openRecordIn,isLabelSyncedWithName: false,