feat: Add AI Agent workflow action node (#12650)

https://github.com/user-attachments/assets/8593e488-cb00-4fd2-b903-5ba5766e0254 --------- Co-authored-by: Antoine Moreaux <moreaux.antoine@gmail.com> Co-authored-by: martmull <martmull@hotmail.fr> Co-authored-by: Félix Malfait <felix.malfait@gmail.com> Co-authored-by: Baptiste Devessier <baptiste@devessier.fr> Co-authored-by: Joseph Chiang <josephj6802@gmail.com> Co-authored-by: Claude <noreply@anthropic.com> Co-authored-by: Guillim <guillim@users.noreply.github.com> Co-authored-by: Raphaël Bosi <71827178+bosiraphael@users.noreply.github.com> Co-authored-by: Lucas Bordeau <bordeau.lucas@gmail.com> Co-authored-by: Marie <51697796+ijreilly@users.noreply.github.com> Co-authored-by: Naifer <161821705+omarNaifer12@users.noreply.github.com> Co-authored-by: prastoin <paul@twenty.com> Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> Co-authored-by: github-actions <github-actions@twenty.com> Co-authored-by: Thomas Trompette <thomas.trompette@sfr.fr> Co-authored-by: Etienne <45695613+etiennejouan@users.noreply.github.com> Co-authored-by: Ajay A Adsule <103304466+AjayAdsule@users.noreply.github.com> Co-authored-by: bosiraphael <raphael.bosi@gmail.com> Co-authored-by: Charles Bochet <charles@twenty.com> Co-authored-by: Marty <91310557+real-marty@users.noreply.github.com> Co-authored-by: Félix Malfait <felix@twenty.com> Co-authored-by: Charles Bochet <charlesBochet@users.noreply.github.com> Co-authored-by: Cursor Agent <cursoragent@cursor.com> Co-authored-by: Paul Rastoin <45004772+prastoin@users.noreply.github.com> Co-authored-by: Weiko <corentin@twenty.com> Co-authored-by: greptile-apps[bot] <165735046+greptile-apps[bot]@users.noreply.github.com> Co-authored-by: nitin <142569587+ehconitin@users.noreply.github.com>
2025-06-23 01:12:04 +05:30
parent 22e126869c
commit 65df511179
75 changed files with 2268 additions and 30 deletions
@@ -9,6 +9,7 @@ import { AI_DRIVER } from 'src/engine/core-modules/ai/ai.constants';
 import { AiService } from 'src/engine/core-modules/ai/ai.service';
 import { AiController } from 'src/engine/core-modules/ai/controllers/ai.controller';
 import { OpenAIDriver } from 'src/engine/core-modules/ai/drivers/openai.driver';
+import { AIBillingService } from 'src/engine/core-modules/ai/services/ai-billing.service';
 import { FeatureFlagModule } from 'src/engine/core-modules/feature-flag/feature-flag.module';

@Global()
@@ -33,8 +34,8 @@ export class AiModule {
      module: AiModule,
      imports: [FeatureFlagModule],
      controllers: [AiController],
-      providers: [AiService, provider],
-      exports: [AiService],
+      providers: [AiService, AIBillingService, provider],
+      exports: [AiService, AIBillingService],
    };
  }
 }
@@ -0,0 +1,65 @@
+export enum ModelProvider {
+  OPENAI = 'openai',
+  ANTHROPIC = 'anthropic',
+}
+
+export type ModelId =
+  | 'gpt-4o'
+  | 'gpt-4o-mini'
+  | 'gpt-4-turbo'
+  | 'claude-opus-4-20250514'
+  | 'claude-sonnet-4-20250514'
+  | 'claude-3-5-haiku-20241022';
+
+export interface AIModelConfig {
+  modelId: ModelId;
+  label: string;
+  provider: ModelProvider;
+  inputCostPer1kTokensInCents: number;
+  outputCostPer1kTokensInCents: number;
+}
+
+export const AI_MODELS: AIModelConfig[] = [
+  {
+    modelId: 'gpt-4o',
+    label: 'GPT-4o',
+    provider: ModelProvider.OPENAI,
+    inputCostPer1kTokensInCents: 0.25,
+    outputCostPer1kTokensInCents: 1.0,
+  },
+  {
+    modelId: 'gpt-4o-mini',
+    label: 'GPT-4o Mini',
+    provider: ModelProvider.OPENAI,
+    inputCostPer1kTokensInCents: 0.015,
+    outputCostPer1kTokensInCents: 0.06,
+  },
+  {
+    modelId: 'gpt-4-turbo',
+    label: 'GPT-4 Turbo',
+    provider: ModelProvider.OPENAI,
+    inputCostPer1kTokensInCents: 1.0,
+    outputCostPer1kTokensInCents: 3.0,
+  },
+  {
+    modelId: 'claude-opus-4-20250514',
+    label: 'Claude Opus 4',
+    provider: ModelProvider.ANTHROPIC,
+    inputCostPer1kTokensInCents: 1.5,
+    outputCostPer1kTokensInCents: 7.5,
+  },
+  {
+    modelId: 'claude-sonnet-4-20250514',
+    label: 'Claude Sonnet 4',
+    provider: ModelProvider.ANTHROPIC,
+    inputCostPer1kTokensInCents: 0.3,
+    outputCostPer1kTokensInCents: 1.5,
+  },
+  {
+    modelId: 'claude-3-5-haiku-20241022',
+    label: 'Claude Haiku 3.5',
+    provider: ModelProvider.ANTHROPIC,
+    inputCostPer1kTokensInCents: 0.08,
+    outputCostPer1kTokensInCents: 0.4,
+  },
+];
@@ -0,0 +1,2 @@
+// Configuration: $0.001 = 1 credit
+export const DOLLAR_TO_CREDIT_MULTIPLIER = 1000; // 1 / 0.001 = 1000 credits per dollar
@@ -0,0 +1,90 @@
+import { Test, TestingModule } from '@nestjs/testing';
+
+import { BILLING_FEATURE_USED } from 'src/engine/core-modules/billing/constants/billing-feature-used.constant';
+import { BillingMeterEventName } from 'src/engine/core-modules/billing/enums/billing-meter-event-names';
+import { WorkspaceEventEmitter } from 'src/engine/workspace-event-emitter/workspace-event-emitter';
+
+import { AIBillingService } from './ai-billing.service';
+
+describe('AIBillingService', () => {
+  let service: AIBillingService;
+  let mockWorkspaceEventEmitter: jest.Mocked<WorkspaceEventEmitter>;
+
+  const mockTokenUsage = {
+    promptTokens: 1000,
+    completionTokens: 500,
+    totalTokens: 1500,
+  };
+
+  beforeEach(async () => {
+    const mockEventEmitterMethods = {
+      emitCustomBatchEvent: jest.fn(),
+    };
+
+    const module: TestingModule = await Test.createTestingModule({
+      providers: [
+        AIBillingService,
+        {
+          provide: WorkspaceEventEmitter,
+          useValue: mockEventEmitterMethods,
+        },
+      ],
+    }).compile();
+
+    service = module.get<AIBillingService>(AIBillingService);
+    mockWorkspaceEventEmitter = module.get(WorkspaceEventEmitter);
+  });
+
+  it('should be defined', () => {
+    expect(service).toBeDefined();
+  });
+
+  describe('calculateCost', () => {
+    it('should calculate cost correctly for valid model and token usage', async () => {
+      const costInCents = await service.calculateCost('gpt-4o', mockTokenUsage);
+
+      // Expected: (1000/1000 * 0.25) + (500/1000 * 1.0) = 0.25 + 0.5 = 0.75 cents
+      expect(costInCents).toBe(0.75);
+    });
+
+    it('should calculate cost correctly with different token usage', async () => {
+      const differentTokenUsage = {
+        promptTokens: 2000,
+        completionTokens: 1000,
+        totalTokens: 3000,
+      };
+
+      const costInCents = await service.calculateCost(
+        'gpt-4o',
+        differentTokenUsage,
+      );
+
+      // Expected: (2000/1000 * 0.25) + (1000/1000 * 1.0) = 0.5 + 1.0 = 1.5 cents
+      expect(costInCents).toBe(1.5);
+    });
+  });
+
+  describe('calculateAndBillUsage', () => {
+    it('should calculate cost and emit billing event when model exists', async () => {
+      await service.calculateAndBillUsage(
+        'gpt-4o',
+        mockTokenUsage,
+        'workspace-1',
+      );
+
+      // Expected credits: (0.75 cents / 100) * 1000 = 0.0075 * 1000 = 7.5 credits, rounded to 8
+      expect(
+        mockWorkspaceEventEmitter.emitCustomBatchEvent,
+      ).toHaveBeenCalledWith(
+        BILLING_FEATURE_USED,
+        [
+          {
+            eventName: BillingMeterEventName.WORKFLOW_NODE_RUN,
+            value: 8,
+          },
+        ],
+        'workspace-1',
+      );
+    });
+  });
+});
@@ -0,0 +1,72 @@
+import { Injectable, Logger } from '@nestjs/common';
+
+import { ModelId } from 'src/engine/core-modules/ai/constants/ai-models.const';
+import { DOLLAR_TO_CREDIT_MULTIPLIER } from 'src/engine/core-modules/ai/constants/dollar-to-credit-multiplier';
+import { getAIModelById } from 'src/engine/core-modules/ai/utils/get-ai-model-by-id';
+import { BILLING_FEATURE_USED } from 'src/engine/core-modules/billing/constants/billing-feature-used.constant';
+import { BillingMeterEventName } from 'src/engine/core-modules/billing/enums/billing-meter-event-names';
+import { BillingUsageEvent } from 'src/engine/core-modules/billing/types/billing-usage-event.type';
+import { WorkspaceEventEmitter } from 'src/engine/workspace-event-emitter/workspace-event-emitter';
+
+export interface TokenUsage {
+  promptTokens: number;
+  completionTokens: number;
+  totalTokens: number;
+}
+
+@Injectable()
+export class AIBillingService {
+  private readonly logger = new Logger(AIBillingService.name);
+
+  constructor(private readonly workspaceEventEmitter: WorkspaceEventEmitter) {}
+
+  async calculateCost(modelId: ModelId, usage: TokenUsage): Promise<number> {
+    const model = getAIModelById(modelId);
+
+    if (!model) {
+      throw new Error(`AI model with id ${modelId} not found`);
+    }
+
+    const inputCost =
+      (usage.promptTokens / 1000) * model.inputCostPer1kTokensInCents;
+    const outputCost =
+      (usage.completionTokens / 1000) * model.outputCostPer1kTokensInCents;
+
+    const totalCost = inputCost + outputCost;
+
+    this.logger.log(
+      `Calculated cost for model ${modelId}: ${totalCost} cents (input: ${inputCost}, output: ${outputCost})`,
+    );
+
+    return totalCost;
+  }
+
+  async calculateAndBillUsage(
+    modelId: ModelId,
+    usage: TokenUsage,
+    workspaceId: string,
+  ): Promise<void> {
+    const costInCents = await this.calculateCost(modelId, usage);
+
+    const costInDollars = costInCents / 100;
+    const creditsUsed = Math.round(costInDollars * DOLLAR_TO_CREDIT_MULTIPLIER);
+
+    this.sendAiTokenUsageEvent(workspaceId, creditsUsed);
+  }
+
+  private sendAiTokenUsageEvent(
+    workspaceId: string,
+    creditsUsed: number,
+  ): void {
+    this.workspaceEventEmitter.emitCustomBatchEvent<BillingUsageEvent>(
+      BILLING_FEATURE_USED,
+      [
+        {
+          eventName: BillingMeterEventName.WORKFLOW_NODE_RUN,
+          value: creditsUsed,
+        },
+      ],
+      workspaceId,
+    );
+  }
+}
@@ -0,0 +1,7 @@
+/**
+ * Converts cost in cents to cost in credits
+ * Formula: credits = cents / 100 * 1000 = cents * 10
+ * @param cents - Cost in cents (real cost)
+ * @returns Cost in credits (end-user cost)
+ */
+export const convertCentsToCredits = (cents: number): number => cents * 10;
@@ -0,0 +1,9 @@
+import {
+  AI_MODELS,
+  AIModelConfig,
+  ModelId,
+} from 'src/engine/core-modules/ai/constants/ai-models.const';
+
+export const getAIModelById = (modelId: ModelId): AIModelConfig | undefined => {
+  return AI_MODELS.find((model) => model.modelId === modelId);
+};