The open alternative to Salesforce, designed for AI.
TypeScript crmcrm-systemcustomergood-first-issuegraphqlhacktoberfestjavascriptmarketingmonoreponestjsopen-sourcepostgresqlreactreactjssalestypescriptweb
Let workflows update custom fields on email and calendar records (#26789)
Thomas des Francs7e8ce345abf9
diff --git a/packages/twenty-server/src/engine/core-modules/record-crud/services/update-record.service.ts b/packages/twenty-server/src/engine/core-modules/record-crud/services/update-record.service.tsindex cdaec0be9c1..4435045fa22 100644--- a/packages/twenty-server/src/engine/core-modules/record-crud/services/update-record.service.ts+++ b/packages/twenty-server/src/engine/core-modules/record-crud/services/update-record.service.ts@@ -1,7 +1,7 @@import { Injectable, Logger } from '@nestjs/common';import { isDefined, isValidUuid } from 'twenty-shared/utils';-import { canObjectBeManagedByAutomation } from 'twenty-shared/workflow';+import { isObjectSyncedFromConnectedAccounts } from 'twenty-shared/workflow';import { CommonUpdateOneQueryRunnerService } from 'src/engine/api/common/common-query-runners/common-update-one-query-runner.service';import {@@ -10,6 +10,7 @@ import {} from 'src/engine/core-modules/record-crud/exceptions/record-crud.exception';import { CommonApiContextBuilderService } from 'src/engine/core-modules/record-crud/services/common-api-context-builder.service';import { type UpdateRecordParams } from 'src/engine/core-modules/record-crud/types/update-record-params.type';+import { canFieldsBeUpdatedByAutomation } from 'src/engine/core-modules/record-crud/utils/can-fields-be-updated-by-automation.util';import { getRecordDisplayName } from 'src/engine/core-modules/record-crud/utils/get-record-display-name.util';import { removeUndefinedFromRecord } from 'src/engine/core-modules/record-crud/utils/remove-undefined-from-record.util';import { type ToolOutput } from 'src/engine/core-modules/tool/types/tool-output.type';@@ -53,9 +54,26 @@ export class UpdateRecordService {rolePermissionConfig,});+ const fieldsToUpdateArray = fieldsToUpdate ?? Object.keys(objectRecord);++ const filteredObjectRecord = Object.keys(objectRecord).reduce(+ (acc, key) => {+ if (fieldsToUpdateArray.includes(key)) {+ return { ...acc, [key]: objectRecord[key] };+ }++ return acc;+ },+ {},+ );+if (- !canObjectBeManagedByAutomation({- nameSingular: flatObjectMetadata.nameSingular,+ !canFieldsBeUpdatedByAutomation({+ flatObjectMetadata,+ flatFieldMetadataMaps,+ fieldNames: Object.keys(filteredObjectRecord),+ workspaceCustomApplicationId:+ authContext.workspace.workspaceCustomApplicationId,})) {throw new RecordCrudException(@@ -64,8 +82,6 @@ export class UpdateRecordService {);}- const fieldsToUpdateArray = fieldsToUpdate ?? Object.keys(objectRecord);-if (fieldsToUpdateArray.length === 0) {return {success: true,@@ -74,17 +90,6 @@ export class UpdateRecordService {};}- const filteredObjectRecord = Object.keys(objectRecord).reduce(- (acc, key) => {- if (fieldsToUpdateArray.includes(key)) {- return { ...acc, [key]: objectRecord[key] };- }-- return acc;- },- {},- );-// Clean undefined values from the record data (including nested composite fields)// This prevents validation errors for partial composite field inputsconst cleanedRecord = removeUndefinedFromRecord(filteredObjectRecord);@@ -101,6 +106,18 @@ export class UpdateRecordService {this.logger.log(`Record updated successfully in ${objectName}`);+ if (+ isObjectSyncedFromConnectedAccounts({+ nameSingular: flatObjectMetadata.nameSingular,+ })+ ) {+ return {+ success: true,+ message: `Record updated successfully in ${objectName}`,+ result: { id: objectRecordId },+ };+ }+return {success: true,message: `Record updated successfully in ${objectName}`,diff --git a/packages/twenty-server/src/engine/core-modules/record-crud/utils/__tests__/can-fields-be-updated-by-automation.util.spec.ts b/packages/twenty-server/src/engine/core-modules/record-crud/utils/__tests__/can-fields-be-updated-by-automation.util.spec.tsnew file mode 100644index 00000000000..b472e234dc8--- /dev/null+++ b/packages/twenty-server/src/engine/core-modules/record-crud/utils/__tests__/can-fields-be-updated-by-automation.util.spec.ts@@ -0,0 +1,134 @@+import { FieldMetadataType, RelationType } from 'twenty-shared/types';++import { canFieldsBeUpdatedByAutomation } from 'src/engine/core-modules/record-crud/utils/can-fields-be-updated-by-automation.util';+import { type FlatEntityMaps } from 'src/engine/metadata-modules/flat-entity/types/flat-entity-maps.type';+import { getFlatFieldMetadataMock } from 'src/engine/metadata-modules/flat-field-metadata/__mocks__/get-flat-field-metadata.mock';+import { type FlatFieldMetadata } from 'src/engine/metadata-modules/flat-field-metadata/types/flat-field-metadata.type';+import { getFlatObjectMetadataMock } from 'src/engine/metadata-modules/flat-object-metadata/__mocks__/get-flat-object-metadata.mock';++const WORKSPACE_CUSTOM_APPLICATION_ID = 'workspace-custom-application-id';+const STANDARD_APPLICATION_ID = 'twenty-standard-application-id';+const INSTALLED_APPLICATION_ID = 'installed-application-id';++const companyName = getFlatFieldMetadataMock({+ universalIdentifier: 'company-name',+ objectMetadataId: 'company',+ type: FieldMetadataType.TEXT,+ name: 'name',+ applicationId: STANDARD_APPLICATION_ID,+});++const messageThreadSubject = getFlatFieldMetadataMock({+ universalIdentifier: 'message-thread-subject',+ objectMetadataId: 'messageThread',+ type: FieldMetadataType.TEXT,+ name: 'subject',+ applicationId: STANDARD_APPLICATION_ID,+});++const messageThreadCategory = getFlatFieldMetadataMock({+ universalIdentifier: 'message-thread-category',+ objectMetadataId: 'messageThread',+ type: FieldMetadataType.SELECT,+ name: 'category',+ applicationId: WORKSPACE_CUSTOM_APPLICATION_ID,+});++const messageThreadDeal = getFlatFieldMetadataMock({+ universalIdentifier: 'message-thread-deal',+ objectMetadataId: 'messageThread',+ type: FieldMetadataType.RELATION,+ name: 'deal',+ applicationId: WORKSPACE_CUSTOM_APPLICATION_ID,+ settings: { relationType: RelationType.MANY_TO_ONE },+});++const messageThreadSyncCursor = getFlatFieldMetadataMock({+ universalIdentifier: 'message-thread-sync-cursor',+ objectMetadataId: 'messageThread',+ type: FieldMetadataType.TEXT,+ name: 'syncCursor',+ applicationId: INSTALLED_APPLICATION_ID,+});++const workspaceMemberCategory = getFlatFieldMetadataMock({+ universalIdentifier: 'workspace-member-category',+ objectMetadataId: 'workspaceMember',+ type: FieldMetadataType.SELECT,+ name: 'category',+ applicationId: WORKSPACE_CUSTOM_APPLICATION_ID,+});++const flatFieldMetadatas = [+ companyName,+ messageThreadSubject,+ messageThreadCategory,+ messageThreadDeal,+ messageThreadSyncCursor,+ workspaceMemberCategory,+];++const flatFieldMetadataMaps: FlatEntityMaps<FlatFieldMetadata> = {+ byUniversalIdentifier: Object.fromEntries(+ flatFieldMetadatas.map((flatFieldMetadata) => [+ flatFieldMetadata.universalIdentifier,+ flatFieldMetadata,+ ]),+ ),+ universalIdentifierById: Object.fromEntries(+ flatFieldMetadatas.map((flatFieldMetadata) => [+ flatFieldMetadata.id,+ flatFieldMetadata.universalIdentifier,+ ]),+ ),+ universalIdentifiersByApplicationId: {},+};++const FLAT_OBJECT_METADATA_BY_NAME = {+ company: getFlatObjectMetadataMock({+ universalIdentifier: 'company',+ nameSingular: 'company',+ fieldIds: [companyName.id],+ }),+ messageThread: getFlatObjectMetadataMock({+ universalIdentifier: 'messageThread',+ nameSingular: 'messageThread',+ fieldIds: [+ messageThreadSubject.id,+ messageThreadCategory.id,+ messageThreadDeal.id,+ messageThreadSyncCursor.id,+ ],+ }),+ workspaceMember: getFlatObjectMetadataMock({+ universalIdentifier: 'workspaceMember',+ nameSingular: 'workspaceMember',+ fieldIds: [workspaceMemberCategory.id],+ }),+};++describe('canFieldsBeUpdatedByAutomation', () => {+ it.each<[keyof typeof FLAT_OBJECT_METADATA_BY_NAME, string[], boolean]>([+ ['company', ['name'], true],+ ['messageThread', ['category'], true],+ ['messageThread', ['dealId'], true],+ ['messageThread', ['subject'], false],+ ['messageThread', ['syncCursor'], false],+ ['messageThread', ['category', 'subject'], false],+ ['messageThread', ['unknownField'], false],+ ['messageThread', [], false],+ ['workspaceMember', ['category'], false],+ ])(+ 'should allow automation to update %s fields %j: %s',+ (objectName, fieldNames, expected) => {+ expect(+ canFieldsBeUpdatedByAutomation({+ flatObjectMetadata: FLAT_OBJECT_METADATA_BY_NAME[objectName],+ flatFieldMetadataMaps,+ fieldNames,+ workspaceCustomApplicationId: WORKSPACE_CUSTOM_APPLICATION_ID,+ }),+ ).toBe(expected);+ },+ );+});diff --git a/packages/twenty-server/src/engine/core-modules/record-crud/utils/can-fields-be-updated-by-automation.util.ts b/packages/twenty-server/src/engine/core-modules/record-crud/utils/can-fields-be-updated-by-automation.util.tsnew file mode 100644index 00000000000..59a6d9c51df--- /dev/null+++ b/packages/twenty-server/src/engine/core-modules/record-crud/utils/can-fields-be-updated-by-automation.util.ts@@ -0,0 +1,60 @@+import { isDefined } from 'twenty-shared/utils';+import {+ canObjectBeManagedByAutomation,+ isObjectSyncedFromConnectedAccounts,+} from 'twenty-shared/workflow';++import { resolveFilterKeyFieldMetadata } from 'src/engine/api/graphql/graphql-query-runner/graphql-query-parsers/utils/resolve-filter-key-field-metadata.util';+import { type FlatEntityMaps } from 'src/engine/metadata-modules/flat-entity/types/flat-entity-maps.type';+import { type FlatFieldMetadata } from 'src/engine/metadata-modules/flat-field-metadata/types/flat-field-metadata.type';+import { buildFieldMapsFromFlatObjectMetadata } from 'src/engine/metadata-modules/flat-field-metadata/utils/build-field-maps-from-flat-object-metadata.util';+import { type FlatObjectMetadata } from 'src/engine/metadata-modules/flat-object-metadata/types/flat-object-metadata.type';++export const canFieldsBeUpdatedByAutomation = ({+ flatObjectMetadata,+ flatFieldMetadataMaps,+ fieldNames,+ workspaceCustomApplicationId,+}: {+ flatObjectMetadata: FlatObjectMetadata;+ flatFieldMetadataMaps: FlatEntityMaps<FlatFieldMetadata>;+ fieldNames: string[];+ workspaceCustomApplicationId: string;+}): boolean => {+ if (+ canObjectBeManagedByAutomation({+ nameSingular: flatObjectMetadata.nameSingular,+ })+ ) {+ return true;+ }++ if (+ !isObjectSyncedFromConnectedAccounts({+ nameSingular: flatObjectMetadata.nameSingular,+ }) ||+ fieldNames.length === 0+ ) {+ return false;+ }++ const { fieldIdByName, fieldIdByJoinColumnName } =+ buildFieldMapsFromFlatObjectMetadata(+ flatFieldMetadataMaps,+ flatObjectMetadata,+ );++ return fieldNames.every((fieldName) => {+ const { fieldMetadata } = resolveFilterKeyFieldMetadata({+ filterKey: fieldName,+ fieldIdByName,+ fieldIdByJoinColumnName,+ flatFieldMetadataMaps,+ });++ return (+ isDefined(fieldMetadata) &&+ fieldMetadata.applicationId === workspaceCustomApplicationId+ );+ });+};diff --git a/packages/twenty-server/test/integration/graphql/suites/workflow/utils/run-workflow-action-step.util.ts b/packages/twenty-server/test/integration/graphql/suites/workflow/utils/run-workflow-action-step.util.tsindex cb03f1ceedf..e4f4ed183ec 100644--- a/packages/twenty-server/test/integration/graphql/suites/workflow/utils/run-workflow-action-step.util.ts+++ b/packages/twenty-server/test/integration/graphql/suites/workflow/utils/run-workflow-action-step.util.ts@@ -12,7 +12,8 @@ import { makeGraphqlApiRequest } from 'test/integration/graphql/utils/make-graphtype WorkflowActionStepType =| 'SEND_EMAIL'| 'DRAFT_EMAIL'- | 'CREATE_CALENDAR_EVENT';+ | 'CREATE_CALENDAR_EVENT'+ | 'UPDATE_RECORD';type WorkflowVersionStep = {id: string;diff --git a/packages/twenty-server/test/integration/workflow-actions/update-record/update-record-on-message-thread.integration-spec.ts b/packages/twenty-server/test/integration/workflow-actions/update-record/update-record-on-message-thread.integration-spec.tsnew file mode 100644index 00000000000..12c210b3ff7--- /dev/null+++ b/packages/twenty-server/test/integration/workflow-actions/update-record/update-record-on-message-thread.integration-spec.ts@@ -0,0 +1,119 @@+import { runWorkflowActionStep } from 'test/integration/graphql/suites/workflow/utils/run-workflow-action-step.util';+import { createOneSelectFieldMetadataForIntegrationTests } from 'test/integration/metadata/suites/field-metadata/utils/create-one-select-field-metadata-for-integration-tests.util';+import { deleteOneFieldMetadata } from 'test/integration/metadata/suites/field-metadata/utils/delete-one-field-metadata.util';+import { updateOneFieldMetadata } from 'test/integration/metadata/suites/field-metadata/utils/update-one-field-metadata.util';+import { findManyObjectMetadata } from 'test/integration/metadata/suites/object-metadata/utils/find-many-object-metadata.util';+import { findRecordNodesByFilter } from 'test/integration/utils/find-records-by-filter.util';+import { isDefined } from 'twenty-shared/utils';++import { MESSAGE_THREAD_DATA_SEED_IDS } from 'src/engine/workspace-manager/dev-seeder/data/constants/message-thread-data-seeds.constant';++const MESSAGE_THREAD_ID = MESSAGE_THREAD_DATA_SEED_IDS.ID_1;++const findMessageThread = async () => {+ const [messageThread] = await findRecordNodesByFilter<{+ subject: string;+ category: string | null;+ }>('messageThread', 'messageThreads', 'subject category', {+ id: { eq: MESSAGE_THREAD_ID },+ });++ return messageThread;+};++describe('UPDATE_RECORD workflow action on message threads (integration)', () => {+ let categoryFieldMetadataId: string | undefined;++ beforeAll(async () => {+ const { objects } = await findManyObjectMetadata({+ input: { filter: {}, paging: { first: 1000 } },+ gqlFields: 'id nameSingular',+ expectToFail: false,+ });++ const messageThreadObjectMetadata = objects.find(+ (object) => object.nameSingular === 'messageThread',+ );++ if (!isDefined(messageThreadObjectMetadata)) {+ throw new Error('messageThread object metadata not found');+ }++ const { selectFieldMetadataId } =+ await createOneSelectFieldMetadataForIntegrationTests({+ input: {+ objectMetadataId: messageThreadObjectMetadata.id,+ name: 'category',+ },+ });++ categoryFieldMetadataId = selectFieldMetadataId;+ });++ afterAll(async () => {+ if (!isDefined(categoryFieldMetadataId)) {+ return;+ }++ await updateOneFieldMetadata({+ input: {+ idToUpdate: categoryFieldMetadataId,+ updatePayload: { isActive: false },+ },+ expectToFail: false,+ });++ await deleteOneFieldMetadata({+ input: { idToDelete: categoryFieldMetadataId },+ expectToFail: false,+ });+ });++ it('updates a custom field and returns only the record id', async () => {+ const workflowRun = await runWorkflowActionStep({+ name: 'Update a message thread custom field',+ stepType: 'UPDATE_RECORD',+ input: {+ objectName: 'messageThread',+ objectRecordId: MESSAGE_THREAD_ID,+ objectRecord: { category: 'OPTION_1' },+ fieldsToUpdate: ['category'],+ },+ });++ expect(workflowRun).toMatchObject({+ status: 'COMPLETED',+ stepStatus: 'SUCCESS',+ stepResult: { id: MESSAGE_THREAD_ID },+ });+ expect(Object.keys(workflowRun.stepResult ?? {})).toEqual(['id']);++ const messageThread = await findMessageThread();++ expect(messageThread.category).toBe('OPTION_1');+ });++ it('rejects an update of a standard field', async () => {+ const { subject: subjectBeforeRun } = await findMessageThread();++ const workflowRun = await runWorkflowActionStep({+ name: 'Rename a message thread',+ stepType: 'UPDATE_RECORD',+ input: {+ objectName: 'messageThread',+ objectRecordId: MESSAGE_THREAD_ID,+ objectRecord: { subject: 'Renamed by a workflow' },+ fieldsToUpdate: ['subject'],+ },+ });++ expect(workflowRun).toMatchObject({+ stepStatus: 'FAILED',+ stepError: 'Failed to update: Object cannot be updated by automation',+ });++ const messageThread = await findMessageThread();++ expect(messageThread.subject).toBe(subjectBeforeRun);+ });+});diff --git a/packages/twenty-shared/src/workflow/constants/ObjectsBlockedFromAutomation.ts b/packages/twenty-shared/src/workflow/constants/ObjectsBlockedFromAutomation.tsindex e515f07edce..26cd9b57ca3 100644--- a/packages/twenty-shared/src/workflow/constants/ObjectsBlockedFromAutomation.ts+++ b/packages/twenty-shared/src/workflow/constants/ObjectsBlockedFromAutomation.ts@@ -1,3 +1,5 @@+import { OBJECTS_SYNCED_FROM_CONNECTED_ACCOUNTS } from './ObjectsSyncedFromConnectedAccounts';+// Objects whose records must not be created, updated, or deleted by// automation callers (workflows and AI tools). Either they back the// automation runtime itself (recursion risk), gate access/permissions,@@ -9,11 +11,5 @@ export const OBJECTS_BLOCKED_FROM_AUTOMATION = ['workflowAutomatedTrigger','workspaceMember','dashboard',- 'message',- 'messageThread',- 'messageChannelMessageAssociation',- 'messageParticipant',- 'calendarEvent',- 'calendarEventParticipant',- 'calendarChannelEventAssociation',+ ...OBJECTS_SYNCED_FROM_CONNECTED_ACCOUNTS,] as const;diff --git a/packages/twenty-shared/src/workflow/constants/ObjectsSyncedFromConnectedAccounts.ts b/packages/twenty-shared/src/workflow/constants/ObjectsSyncedFromConnectedAccounts.tsnew file mode 100644index 00000000000..c8576fdd056--- /dev/null+++ b/packages/twenty-shared/src/workflow/constants/ObjectsSyncedFromConnectedAccounts.ts@@ -0,0 +1,9 @@+export const OBJECTS_SYNCED_FROM_CONNECTED_ACCOUNTS = [+ 'message',+ 'messageThread',+ 'messageChannelMessageAssociation',+ 'messageParticipant',+ 'calendarEvent',+ 'calendarEventParticipant',+ 'calendarChannelEventAssociation',+] as const;diff --git a/packages/twenty-shared/src/workflow/index.ts b/packages/twenty-shared/src/workflow/index.tsindex 159d1b646a6..c7296b369b7 100644--- a/packages/twenty-shared/src/workflow/index.ts+++ b/packages/twenty-shared/src/workflow/index.ts@@ -11,6 +11,7 @@ export { CAPTURE_ALL_VARIABLE_TAG_INNER_REGEX } from './constants/CaptureAllVariexport { CONTENT_TYPE_VALUES_HTTP_REQUEST } from './constants/ContentTypeValuesHttpRequest';export { IF_ELSE_BRANCH_POSITION_OFFSETS } from './constants/IfElseBranchPositionOffsets';export { OBJECTS_BLOCKED_FROM_AUTOMATION } from './constants/ObjectsBlockedFromAutomation';+export { OBJECTS_SYNCED_FROM_CONNECTED_ACCOUNTS } from './constants/ObjectsSyncedFromConnectedAccounts';export { STEP_RETRY_DELAYS_MS } from './constants/StepRetryDelaysMs';export { TRIGGER_STEP_ID } from './constants/TriggerStepId';export { WORKFLOW_TRIGGER_METADATA_KEY } from './constants/WorkflowTriggerMetadataKey';@@ -140,6 +141,7 @@ export { canObjectBeManagedByAutomation } from './utils/canObjectBeManagedByAutoexport { extractRawVariableNamePart } from './utils/extractRawVariableNameParts';export { getFunctionInputFromInputSchema } from './utils/getFunctionInputFromInputSchema';export { getWorkflowRunContext } from './utils/getWorkflowRunContext';+export { isObjectSyncedFromConnectedAccounts } from './utils/isObjectSyncedFromConnectedAccounts';export { isStandaloneVariableString } from './utils/isStandaloneVariableString';export { parseBooleanFromStringValue } from './utils/parseBooleanFromStringValue';export { parseDataFromContentType } from './utils/parseDataFromContentType';diff --git a/packages/twenty-shared/src/workflow/utils/isObjectSyncedFromConnectedAccounts.ts b/packages/twenty-shared/src/workflow/utils/isObjectSyncedFromConnectedAccounts.tsnew file mode 100644index 00000000000..02581f201c1--- /dev/null+++ b/packages/twenty-shared/src/workflow/utils/isObjectSyncedFromConnectedAccounts.ts@@ -0,0 +1,11 @@+import { OBJECTS_SYNCED_FROM_CONNECTED_ACCOUNTS } from '../constants/ObjectsSyncedFromConnectedAccounts';++export const isObjectSyncedFromConnectedAccounts = ({+ nameSingular,+}: {+ nameSingular: string;+}): boolean => {+ return OBJECTS_SYNCED_FROM_CONNECTED_ACCOUNTS.includes(+ nameSingular as (typeof OBJECTS_SYNCED_FROM_CONNECTED_ACCOUNTS)[number],+ );+};