Build code introspection service (#7760)

Starting to use ts-morph to retrieve function parameters

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

@@ -0,0 +1,106 @@
+import { Test, TestingModule } from '@nestjs/testing';
+
+import { CodeIntrospectionException } from 'src/modules/code-introspection/code-introspection.exception';
+import { CodeIntrospectionService } from 'src/modules/code-introspection/code-introspection.service';
+
+describe('CodeIntrospectionService', () => {
+  let service: CodeIntrospectionService;
+
+  beforeEach(async () => {
+    const module: TestingModule = await Test.createTestingModule({
+      providers: [CodeIntrospectionService],
+    }).compile();
+
+    service = module.get<CodeIntrospectionService>(CodeIntrospectionService);
+  });
+
+  it('should be defined', () => {
+    expect(service).toBeDefined();
+  });
+
+  describe('analyze', () => {
+    it('should analyze a function declaration correctly', () => {
+      const fileContent = `
+        function testFunction(param1: string, param2: number): void {
+          console.log(param1, param2);
+        }
+      `;
+
+      const result = service.analyze(fileContent);
+
+      expect(result).toEqual([
+        { name: 'param1', type: 'string' },
+        { name: 'param2', type: 'number' },
+      ]);
+    });
+
+    it('should analyze an arrow function correctly', () => {
+      const fileContent = `
+        const testArrowFunction = (param1: string, param2: number): void => {
+          console.log(param1, param2);
+        };
+      `;
+
+      const result = service.analyze(fileContent);
+
+      expect(result).toEqual([
+        { name: 'param1', type: 'string' },
+        { name: 'param2', type: 'number' },
+      ]);
+    });
+
+    it('should return an empty array for files without functions', () => {
+      const fileContent = `
+        const x = 5;
+        console.log(x);
+      `;
+
+      const result = service.analyze(fileContent);
+
+      expect(result).toEqual([]);
+    });
+
+    it('should throw an exception for multiple function declarations', () => {
+      const fileContent = `
+        function func1(param1: string) {}
+        function func2(param2: number) {}
+      `;
+
+      expect(() => service.analyze(fileContent)).toThrow(
+        CodeIntrospectionException,
+      );
+      expect(() => service.analyze(fileContent)).toThrow(
+        'Only one function is allowed',
+      );
+    });
+
+    it('should throw an exception for multiple arrow functions', () => {
+      const fileContent = `
+        const func1 = (param1: string) => {};
+        const func2 = (param2: number) => {};
+      `;
+
+      expect(() => service.analyze(fileContent)).toThrow(
+        CodeIntrospectionException,
+      );
+      expect(() => service.analyze(fileContent)).toThrow(
+        'Only one arrow function is allowed',
+      );
+    });
+
+    it('should correctly analyze complex types', () => {
+      const fileContent = `
+        function complexFunction(param1: string[], param2: { key: number }): Promise<boolean> {
+          return Promise.resolve(true);
+        }
+      `;
+
+      const result = service.analyze(fileContent);
+
+      expect(result).toEqual([
+        { name: 'param1', type: 'string[]' },
+        { name: 'param2', type: '{ key: number; }' },
+      ]);
+    });
+  });
+});

packages/twenty-server/src/modules/code-introspection/code-introspection.exception.ts

@@ -0,0 +1,12 @@
+import { CustomException } from 'src/utils/custom-exception';
+
+export class CodeIntrospectionException extends CustomException {
+  code: CodeIntrospectionExceptionCode;
+  constructor(message: string, code: CodeIntrospectionExceptionCode) {
+    super(message, code);
+  }
+}
+
+export enum CodeIntrospectionExceptionCode {
+  ONLY_ONE_FUNCTION_ALLOWED = 'ONLY_ONE_FUNCTION_ALLOWED',
+}

packages/twenty-server/src/modules/code-introspection/code-introspection.module.ts

@@ -0,0 +1,9 @@
+import { Module } from '@nestjs/common';
+
+import { CodeIntrospectionService } from 'src/modules/code-introspection/code-introspection.service';
+
+@Module({
+  providers: [CodeIntrospectionService],
+  exports: [CodeIntrospectionService],
+})
+export class CodeIntrospectionModule {}

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

@@ -0,0 +1,92 @@
+import { Injectable } from '@nestjs/common';
+
+import {
+  ArrowFunction,
+  FunctionDeclaration,
+  ParameterDeclaration,
+  Project,
+  SyntaxKind,
+} from 'ts-morph';
+
+import {
+  CodeIntrospectionException,
+  CodeIntrospectionExceptionCode,
+} from 'src/modules/code-introspection/code-introspection.exception';
+
+type FunctionParameter = {
+  name: string;
+  type: string;
+};
+
+@Injectable()
+export class CodeIntrospectionService {
+  private project: Project;
+
+  constructor() {
+    this.project = new Project();
+  }
+
+  public analyze(
+    fileContent: string,
+    fileName = 'temp.ts',
+  ): FunctionParameter[] {
+    const sourceFile = this.project.createSourceFile(fileName, fileContent, {
+      overwrite: true,
+    });
+
+    const functionDeclarations = sourceFile.getFunctions();
+
+    if (functionDeclarations.length > 0) {
+      return this.analyzeFunctions(functionDeclarations);
+    }
+
+    const arrowFunctions = sourceFile.getDescendantsOfKind(
+      SyntaxKind.ArrowFunction,
+    );
+
+    if (arrowFunctions.length > 0) {
+      return this.analyzeArrowFunctions(arrowFunctions);
+    }
+
+    return [];
+  }
+
+  private analyzeFunctions(
+    functionDeclarations: FunctionDeclaration[],
+  ): FunctionParameter[] {
+    if (functionDeclarations.length > 1) {
+      throw new CodeIntrospectionException(
+        'Only one function is allowed',
+        CodeIntrospectionExceptionCode.ONLY_ONE_FUNCTION_ALLOWED,
+      );
+    }
+
+    const functionDeclaration = functionDeclarations[0];
+
+    return functionDeclaration.getParameters().map(this.buildFunctionParameter);
+  }
+
+  private analyzeArrowFunctions(
+    arrowFunctions: ArrowFunction[],
+  ): FunctionParameter[] {
+    if (arrowFunctions.length > 1) {
+      throw new CodeIntrospectionException(
+        'Only one arrow function is allowed',
+        CodeIntrospectionExceptionCode.ONLY_ONE_FUNCTION_ALLOWED,
+      );
+    }
+
+    const arrowFunction = arrowFunctions[0];
+
+    return arrowFunction.getParameters().map(this.buildFunctionParameter);
+  }
+
+  private buildFunctionParameter(
+    parameter: ParameterDeclaration,
+  ): FunctionParameter {
+    return {
+      name: parameter.getName(),
+      type: parameter.getType().getText(),
+    };
+  }
+}