chore: create aisay specific queue

Author: kevinkim-ogp

packages/backend/src/apps/aisay/__tests__/queue.test.ts

@@ -0,0 +1,48 @@
+import '@/apps'
+
+import { afterEach, describe, expect, it, vi } from 'vitest'
+
+import aisayApp from '..'
+
+const mocks = vi.hoisted(() => ({
+  stepQueryResult: vi.fn(),
+}))
+
+vi.mock('@/models/step', () => ({
+  default: {
+    query: vi.fn(() => ({
+      findById: vi.fn(() => ({
+        throwIfNotFound: mocks.stepQueryResult,
+      })),
+    })),
+  },
+}))
+
+describe('AISAY Queue', () => {
+  afterEach(() => {
+    vi.restoreAllMocks()
+  })
+
+  it('sets group ID to the connection ID', async () => {
+    mocks.stepQueryResult.mockResolvedValueOnce({
+      connectionId: 'mock-connection-id',
+      key: 'useGeneralisedModel',
+      appKey: 'aisay',
+    })
+    const groupConfig = await aisayApp.queue.getGroupConfigForJob({
+      flowId: 'test-flow-id',
+      stepId: 'test-step-id',
+      executionId: 'test-step-id',
+    })
+    expect(groupConfig).toEqual({
+      id: 'mock-connection-id',
+    })
+  })
+
+  it('sets group concurrency to 1', () => {
+    expect(aisayApp.queue.groupLimits).toEqual({
+      type: 'concurrency',
+      concurrency: 1,
+    })
+  })
+})

packages/backend/src/apps/aisay/index.ts

@@ -2,6 +2,7 @@ import { IApp } from '@plumber/types'
 
 import actions from './actions'
 import auth from './auth'
+import queue from './queue'
 
 const app: IApp = {
   name: 'AISAY',
@@ -20,6 +21,7 @@ const app: IApp = {
     settingsStepLabel: 'Set up step',
     addConnectionLabel: 'Add new AISAY connection',
   },
+  queue,
 }
 
 export default app

packages/backend/src/apps/aisay/queue/index.ts

@@ -0,0 +1,29 @@
+import type { IAppQueue } from '@plumber/types'
+
+import Step from '@/models/step'
+
+const getGroupConfigForJob: IAppQueue['getGroupConfigForJob'] = async (
+  jobData,
+) => {
+  const step = await Step.query().findById(jobData.stepId).throwIfNotFound()
+
+  /**
+   * This config sets up a per-AISAY connection queue, i.e., all AISAY actions
+   * that use the same AISAY connection are grouped together and rate limited.
+   * This is a conservative approach to start with and can be tweaked later.
+   */
+  return {
+    id: step.connectionId,
+  }
+}
+
+const queueSettings = {
+  getGroupConfigForJob,
+  groupLimits: {
+    type: 'concurrency',
+    concurrency: 1,
+  },
+  isQueueDelayable: false,
+} satisfies IAppQueue
+
+export default queueSettings