admin/twenty
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

101 featch available variables from previous steps (#8062)

Browse Source 
- add outputSchema in workflow step settings
- use outputSchemas to compute step available variables


https://github.com/user-attachments/assets/6b851d8e-625c-49ff-b29c-074cd86cbfee
This commit is contained in:
martmull
2024-10-28 12:25:29 +01:00
committed by GitHub
parent 3ae987be92
commit 1aa961dedf
49 changed files with 706 additions and 83 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
packages/twenty-server/src/engine/core-modules/core-engine.module.ts
View File

@ -39,7 +39,7 @@ import { ServerlessModule } from 'src/engine/core-modules/serverless/serverless.
import { WorkspaceSSOModule } from 'src/engine/core-modules/sso/sso.module';
import { TelemetryModule } from 'src/engine/core-modules/telemetry/telemetry.module';
import { UserModule } from 'src/engine/core-modules/user/user.module';
import { WorkflowTriggerApiModule } from 'src/engine/core-modules/workflow/workflow-trigger-api.module';
import { WorkflowApiModule } from 'src/engine/core-modules/workflow/workflow-api.module';
import { WorkspaceInvitationModule } from 'src/engine/core-modules/workspace-invitation/workspace-invitation.module';
import { WorkspaceModule } from 'src/engine/core-modules/workspace/workspace.module';
import { WorkspaceEventEmitterModule } from 'src/engine/workspace-event-emitter/workspace-event-emitter.module';
@ -66,7 +66,7 @@ import { FileModule } from './file/file.module';
WorkspaceInvitationModule,
WorkspaceSSOModule,
PostgresCredentialsModule,
WorkflowTriggerApiModule,
WorkflowApiModule,
WorkspaceEventEmitterModule,
ActorModule,
TelemetryModule,

2
packages/twenty-server/src/engine/core-modules/event-emitter/types/object-record-update.event.ts
View File

@ -2,7 +2,7 @@ import { ObjectRecordBaseEvent } from 'src/engine/core-modules/event-emitter/typ
export class ObjectRecordUpdateEvent<T> extends ObjectRecordBaseEvent {
properties: {
updatedFields: string[];
updatedFields?: string[];
before: T;
after: T;
diff?: Partial<T>;

85
packages/twenty-server/src/engine/core-modules/event-emitter/utils/generate-fake-object-record-event.ts Normal file
View File

@ -0,0 +1,85 @@
import { v4 } from 'uuid';
import { ObjectMetadataEntity } from 'src/engine/metadata-modules/object-metadata/object-metadata.entity';
import { ObjectRecordCreateEvent } from 'src/engine/core-modules/event-emitter/types/object-record-create.event';
import { generateFakeValue } from 'src/engine/utils/generate-fake-value';
import { ObjectRecordUpdateEvent } from 'src/engine/core-modules/event-emitter/types/object-record-update.event';
import { ObjectRecordDeleteEvent } from 'src/engine/core-modules/event-emitter/types/object-record-delete.event';
import { ObjectRecordDestroyEvent } from 'src/engine/core-modules/event-emitter/types/object-record-destroy.event';
export const generateFakeObjectRecordEvent = <Entity>(
objectMetadataEntity: ObjectMetadataEntity,
action: 'created' | 'updated' | 'deleted' | 'destroyed',
):
| ObjectRecordCreateEvent<Entity>
| ObjectRecordUpdateEvent<Entity>
| ObjectRecordDeleteEvent<Entity>
| ObjectRecordDestroyEvent<Entity> => {
const recordId = v4();
const userId = v4();
const workspaceMemberId = v4();
const after = objectMetadataEntity.fields.reduce((acc, field) => {
acc[field.name] = generateFakeValue(field.type);
return acc;
}, {} as Entity);
if (action === 'created') {
return {
recordId,
userId,
workspaceMemberId,
objectMetadata: objectMetadataEntity,
properties: {
after,
},
} satisfies ObjectRecordCreateEvent<Entity>;
}
const before = objectMetadataEntity.fields.reduce((acc, field) => {
acc[field.name] = generateFakeValue(field.type);
return acc;
}, {} as Entity);
if (action === 'updated') {
return {
recordId,
userId,
workspaceMemberId,
objectMetadata: objectMetadataEntity,
properties: {
before,
after,
diff: after,
},
} satisfies ObjectRecordUpdateEvent<Entity>;
}
if (action === 'deleted') {
return {
recordId,
userId,
workspaceMemberId,
objectMetadata: objectMetadataEntity,
properties: {
before,
},
} satisfies ObjectRecordDeleteEvent<Entity>;
}
if (action === 'destroyed') {
return {
recordId,
userId,
workspaceMemberId,
objectMetadata: objectMetadataEntity,
properties: {
before,
},
} satisfies ObjectRecordDestroyEvent<Entity>;
}
throw new Error(`Unknown action '${action}'`);
};

4
packages/twenty-server/src/engine/core-modules/event-emitter/utils/object-record-changed-values.ts
View File

@ -8,7 +8,7 @@ import { FieldMetadataType } from 'src/engine/metadata-modules/field-metadata/fi
export const objectRecordChangedValues = (
oldRecord: Partial<IRecord>,
newRecord: Partial<IRecord>,
updatedKeys: string[],
updatedKeys: string[] | undefined,
objectMetadata: ObjectMetadataInterface,
) => {
const fieldsByKey = new Map(
@ -23,7 +23,7 @@ export const objectRecordChangedValues = (
if (
key === 'updatedAt' ||
!updatedKeys.includes(key) ||
!updatedKeys?.includes(key) ||
field?.type === FieldMetadataType.RELATION ||
deepEqual(oldRecordValue, newRecordValue)
) {

15
packages/twenty-server/src/engine/core-modules/workflow/dtos/compute-step-output-schema-input.dto.ts Normal file
View File

@ -0,0 +1,15 @@
import { Field, InputType } from '@nestjs/graphql';
import graphqlTypeJson from 'graphql-type-json';
import { WorkflowTrigger } from 'src/modules/workflow/workflow-trigger/types/workflow-trigger.type';
import { WorkflowStep } from 'src/modules/workflow/workflow-executor/types/workflow-action.type';
@InputType()
export class ComputeStepOutputSchemaInput {
@Field(() => graphqlTypeJson, {
description: 'Step JSON format',
nullable: false,
})
step: WorkflowTrigger | WorkflowStep;
}

33
packages/twenty-server/src/engine/core-modules/workflow/resolvers/workflow-builder.resolver.ts Normal file
View File

@ -0,0 +1,33 @@
import { Args, Mutation, Resolver } from '@nestjs/graphql';
import { UseFilters, UseGuards } from '@nestjs/common';
import graphqlTypeJson from 'graphql-type-json';
import { WorkspaceAuthGuard } from 'src/engine/guards/workspace-auth.guard';
import { UserAuthGuard } from 'src/engine/guards/user-auth.guard';
import { WorkflowTriggerGraphqlApiExceptionFilter } from 'src/engine/core-modules/workflow/filters/workflow-trigger-graphql-api-exception.filter';
import { OutputSchema } from 'src/modules/workflow/workflow-executor/types/workflow-step-settings.type';
import { AuthWorkspace } from 'src/engine/decorators/auth/auth-workspace.decorator';
import { Workspace } from 'src/engine/core-modules/workspace/workspace.entity';
import { ComputeStepOutputSchemaInput } from 'src/engine/core-modules/workflow/dtos/compute-step-output-schema-input.dto';
import { WorkflowBuilderService } from 'src/modules/workflow/workflow-builder/workflow-builder.service';
@Resolver()
@UseGuards(WorkspaceAuthGuard, UserAuthGuard)
@UseFilters(WorkflowTriggerGraphqlApiExceptionFilter)
export class WorkflowBuilderResolver {
constructor(
private readonly workflowBuilderService: WorkflowBuilderService,
) {}
@Mutation(() => graphqlTypeJson)
async computeStepOutputSchema(
@AuthWorkspace() { id: workspaceId }: Workspace,
@Args('input') { step }: ComputeStepOutputSchemaInput,
): Promise<OutputSchema> {
return this.workflowBuilderService.computeStepOutputSchema({
step,
workspaceId,
});
}
}

0
packages/twenty-server/src/engine/core-modules/workflow/workflow-trigger.resolver.ts → packages/twenty-server/src/engine/core-modules/workflow/resolvers/workflow-trigger.resolver.ts
View File

12
packages/twenty-server/src/engine/core-modules/workflow/workflow-api.module.ts Normal file
View File

@ -0,0 +1,12 @@
import { Module } from '@nestjs/common';
import { WorkflowTriggerResolver } from 'src/engine/core-modules/workflow/resolvers/workflow-trigger.resolver';
import { WorkflowBuilderResolver } from 'src/engine/core-modules/workflow/resolvers/workflow-builder.resolver';
import { WorkflowBuilderModule } from 'src/modules/workflow/workflow-builder/workflow-builder.module';
import { WorkflowTriggerModule } from 'src/modules/workflow/workflow-trigger/workflow-trigger.module';
@Module({
imports: [WorkflowTriggerModule, WorkflowBuilderModule],
providers: [WorkflowTriggerResolver, WorkflowBuilderResolver],
})
export class WorkflowApiModule {}

10
packages/twenty-server/src/engine/core-modules/workflow/workflow-trigger-api.module.ts
View File

@ -1,10 +0,0 @@
import { Module } from '@nestjs/common';
import { WorkflowTriggerResolver } from 'src/engine/core-modules/workflow/workflow-trigger.resolver';
import { WorkflowTriggerModule } from 'src/modules/workflow/workflow-trigger/workflow-trigger.module';
@Module({
imports: [WorkflowTriggerModule],
providers: [WorkflowTriggerResolver],
})
export class WorkflowTriggerApiModule {}

33
packages/twenty-server/src/engine/utils/generate-fake-value.ts Normal file
View File

@ -0,0 +1,33 @@
export const generateFakeValue = (valueType: string): any => {
if (valueType === 'string') {
return 'generated-string-value';
} else if (valueType === 'number') {
return 1;
} else if (valueType === 'boolean') {
return true;
} else if (valueType === 'Date') {
return new Date();
} else if (valueType.endsWith('[]')) {
const elementType = valueType.replace('[]', '');
return Array.from({ length: 3 }, () => generateFakeValue(elementType));
} else if (valueType.startsWith('{') && valueType.endsWith('}')) {
const objData: Record<string, any> = {};
const properties = valueType
.slice(1, -1)
.split(';')
.map((p) => p.trim())
.filter((p) => p);
properties.forEach((property) => {
const [key, valueType] = property.split(':').map((s) => s.trim());
objData[key] = generateFakeValue(valueType);
});
return objData;
} else {
return 'generated-string-value';
}
};

30
packages/twenty-server/src/modules/code-introspection/__tests__/code-introspection.service.spec.ts
View File

@ -103,4 +103,34 @@ describe('CodeIntrospectionService', () => {
]);
});
});
describe('generateFakeDataForFunction', () => {
it('should generate fake data for function', () => {
const fileContent = `
const testArrowFunction = (param1: string, param2: number): void => {
console.log(param1, param2);
};
`;
const result = service.generateInputData(fileContent);
expect(typeof result['param1']).toEqual('string');
expect(typeof result['param2']).toEqual('number');
});
it('should generate fake data for complex function', () => {
const fileContent = `
const testArrowFunction = (param1: string[], param2: { key: number }): void => {
console.log(param1, param2);
};
`;
const result = service.generateInputData(fileContent);
expect(Array.isArray(result['param1'])).toBeTruthy();
expect(typeof result['param1'][0]).toEqual('string');
expect(typeof result['param2']).toEqual('object');
expect(typeof result['param2']['key']).toEqual('number');
});
});
});

21
packages/twenty-server/src/modules/code-introspection/code-introspection.service.ts
View File

@ -12,6 +12,7 @@ import {
CodeIntrospectionException,
CodeIntrospectionExceptionCode,
} from 'src/modules/code-introspection/code-introspection.exception';
import { generateFakeValue } from 'src/engine/utils/generate-fake-value';
type FunctionParameter = {
name: string;
@ -89,4 +90,24 @@ export class CodeIntrospectionService {
type: parameter.getType().getText(),
};
}
public generateInputData(fileContent: string, fileName = 'temp.ts') {
const parameters = this.analyze(fileContent, fileName);
return this.generateFakeDataFromParams(parameters);
}
private generateFakeDataFromParams(
params: FunctionParameter[],
): Record<string, any> {
const data: Record<string, any> = {};
params.forEach((param) => {
const type = param.type;
data[param.name] = generateFakeValue(type);
});
return data;
}
}

18
packages/twenty-server/src/modules/workflow/workflow-builder/workflow-builder.module.ts Normal file
View File

@ -0,0 +1,18 @@
import { Module } from '@nestjs/common';
import { TypeOrmModule } from '@nestjs/typeorm';
import { WorkflowBuilderService } from 'src/modules/workflow/workflow-builder/workflow-builder.service';
import { ServerlessFunctionModule } from 'src/engine/metadata-modules/serverless-function/serverless-function.module';
import { CodeIntrospectionModule } from 'src/modules/code-introspection/code-introspection.module';
import { ObjectMetadataEntity } from 'src/engine/metadata-modules/object-metadata/object-metadata.entity';
@Module({
imports: [
TypeOrmModule.forFeature([ObjectMetadataEntity], 'metadata'),
ServerlessFunctionModule,
CodeIntrospectionModule,
],
providers: [WorkflowBuilderService],
exports: [WorkflowBuilderService],
})
export class WorkflowBuilderModule {}

111
packages/twenty-server/src/modules/workflow/workflow-builder/workflow-builder.service.ts Normal file
View File

@ -0,0 +1,111 @@
import { InjectRepository } from '@nestjs/typeorm';
import { Injectable } from '@nestjs/common';
import { join } from 'path';
import { Repository } from 'typeorm';
import { ServerlessFunctionService } from 'src/engine/metadata-modules/serverless-function/serverless-function.service';
import { CodeIntrospectionService } from 'src/modules/code-introspection/code-introspection.service';
import { ObjectMetadataEntity } from 'src/engine/metadata-modules/object-metadata/object-metadata.entity';
import {
WorkflowTrigger,
WorkflowTriggerType,
} from 'src/modules/workflow/workflow-trigger/types/workflow-trigger.type';
import {
WorkflowActionType,
WorkflowStep,
} from 'src/modules/workflow/workflow-executor/types/workflow-action.type';
import { isDefined } from 'src/utils/is-defined';
import { generateFakeObjectRecordEvent } from 'src/engine/core-modules/event-emitter/utils/generate-fake-object-record-event';
import { INDEX_FILE_NAME } from 'src/engine/core-modules/serverless/drivers/constants/index-file-name';
@Injectable()
export class WorkflowBuilderService {
constructor(
private readonly serverlessFunctionService: ServerlessFunctionService,
private readonly codeIntrospectionService: CodeIntrospectionService,
@InjectRepository(ObjectMetadataEntity, 'metadata')
private readonly objectMetadataRepository: Repository<ObjectMetadataEntity>,
) {}
async computeStepOutputSchema({
step,
workspaceId,
}: {
step: WorkflowTrigger | WorkflowStep;
workspaceId: string;
}) {
const stepType = step.type;
switch (stepType) {
case WorkflowTriggerType.DATABASE_EVENT: {
const [nameSingular, action] = step.settings.eventName.split('.');
if (!['created', 'updated', 'deleted', 'destroyed'].includes(action)) {
return {};
}
const objectMetadata =
await this.objectMetadataRepository.findOneOrFail({
where: {
nameSingular,
workspaceId,
},
relations: ['fields'],
});
if (!isDefined(objectMetadata)) {
return {};
}
return generateFakeObjectRecordEvent(
objectMetadata,
action as 'created' | 'updated' | 'deleted' | 'destroyed',
);
}
case WorkflowActionType.SEND_EMAIL: {
return { success: true };
}
case WorkflowActionType.CODE: {
const { serverlessFunctionId, serverlessFunctionVersion } =
step.settings.input;
if (serverlessFunctionId === '') {
return {};
}
const sourceCode = (
await this.serverlessFunctionService.getServerlessFunctionSourceCode(
workspaceId,
serverlessFunctionId,
serverlessFunctionVersion,
)
)?.[join('src', INDEX_FILE_NAME)];
if (!isDefined(sourceCode)) {
return {};
}
const fakeFunctionInput =
this.codeIntrospectionService.generateInputData(sourceCode);
// handle the case when event parameter is destructured:
// (event: {param1: string; param2: number}) VS ({param1, param2}: {param1: string; param2: number})
const formattedInput = Object.values(fakeFunctionInput)[0];
const resultFromFakeInput =
await this.serverlessFunctionService.executeOneServerlessFunction(
serverlessFunctionId,
workspaceId,
formattedInput,
serverlessFunctionVersion,
);
return resultFromFakeInput.data ?? {};
}
default:
throw new Error(`Unknown type ${stepType}`);
}
}
}

3
packages/twenty-server/src/modules/workflow/workflow-executor/types/workflow-action.type.ts
View File

@ -1,6 +1,7 @@
import {
WorkflowCodeStepSettings,
WorkflowSendEmailStepSettings,
WorkflowStepSettings,
} from 'src/modules/workflow/workflow-executor/types/workflow-step-settings.type';
export enum WorkflowActionType {
@ -11,6 +12,8 @@ export enum WorkflowActionType {
type BaseWorkflowStep = {
id: string;
name: string;
type: WorkflowActionType;
settings: WorkflowStepSettings;
valid: boolean;
};

10
packages/twenty-server/src/modules/workflow/workflow-executor/types/workflow-step-settings.type.ts
View File

@ -1,4 +1,8 @@
export type OutputSchema = object;
type BaseWorkflowStepSettings = {
input: object;
outputSchema: OutputSchema;
errorHandlingOptions: {
retryOnFailure: {
value: boolean;
@ -11,6 +15,8 @@ type BaseWorkflowStepSettings = {
export type WorkflowCodeStepInput = {
serverlessFunctionId: string;
serverlessFunctionVersion: string;
payloadInput: object;
};
export type WorkflowCodeStepSettings = BaseWorkflowStepSettings & {
@ -27,3 +33,7 @@ export type WorkflowSendEmailStepInput = {
export type WorkflowSendEmailStepSettings = BaseWorkflowStepSettings & {
input: WorkflowSendEmailStepInput;
};
export type WorkflowStepSettings =
| WorkflowSendEmailStepSettings
| WorkflowCodeStepSettings;

9
packages/twenty-server/src/modules/workflow/workflow-trigger/types/workflow-trigger.type.ts
View File

@ -1,12 +1,19 @@
import { OutputSchema } from 'src/modules/workflow/workflow-executor/types/workflow-step-settings.type';
export enum WorkflowTriggerType {
DATABASE_EVENT = 'DATABASE_EVENT',
MANUAL = 'MANUAL',
}
type BaseWorkflowTriggerSettings = {
input?: object;
outputSchema: OutputSchema;
};
type BaseTrigger = {
name: string;
type: WorkflowTriggerType;
input?: object;
settings: BaseWorkflowTriggerSettings;
};
export type WorkflowDatabaseEventTrigger = BaseTrigger & {