feat(bugbuster): no longer auto create a linear issue from a github issue (botpress#13250)

Author: franklevasseur

.github/workflows/bugbuster.yml

@@ -28,7 +28,7 @@ jobs:
       - name: Login to Botpress
         run: pnpm bp login -y --token ${{ secrets.PRODUCTION_TOKEN_CLOUD_OPS_ACCOUNT }} --workspace-id ${{ secrets.PRODUCTION_CLOUD_OPS_WORKSPACE_ID }}
       - name: Install Botpress Dependencies
-        run: pnpm bp add linear -y && pnpm bp add github -y && pnpm bp add slack
+        run: pnpm bp add github -y && pnpm bp add slack
       - name: Type Check
         run: tsc --noEmit
       - name: Build

bots/bugbuster/integrations.ts

@@ -3,7 +3,7 @@ import * as pathlib from 'path'
 
 const rootDir = pathlib.resolve(__dirname, '..', '..')
 const integrationsDir = pathlib.join(rootDir, 'integrations')
-const integrations = ['linear', 'github', 'slack']
+const integrations = ['github', 'slack']
 
 const main = async () => {
   for (const integration of integrations) {

bots/bugbuster/src/bot.ts

@@ -2,15 +2,27 @@ import { z } from '@botpress/sdk'
 import * as bp from '.botpress'
 
 const github = new bp.github.Github()
-const linear = new bp.linear.Linear()
 const slack = new bp.slack.Slack()
 
+type AsyncFunction = (...args: any[]) => Promise<any>
+
 export type Bot = typeof bot
 export type EventHandler = Parameters<Bot['event']>[0]
 export type EventHandlerProps = Parameters<EventHandler>[0]
 export type MessageHandler = Parameters<Bot['message']>[0]
 export type MessageHandlerProps = Parameters<MessageHandler>[0]
 
+export type Client = EventHandlerProps['client']
+export type ClientOperation = keyof {
+  [K in keyof Client as Client[K] extends AsyncFunction ? K : never]: null
+}
+export type ClientInputs = {
+  [K in ClientOperation]: Parameters<Client[K]>[0]
+}
+export type ClientOutputs = {
+  [K in ClientOperation]: Awaited<ReturnType<Client[K]>>
+}
+
 export type BotEvents = {
   [K in EventHandlerProps['event']['type']]: Extract<EventHandlerProps['event'], { type: K }>
 }
@@ -24,7 +36,6 @@ const listenersSchema = z.object({
 export const bot = new bp.Bot({
   integrations: {
     github,
-    linear,
     slack,
   },
   states: {

bots/bugbuster/src/handlers/issue-opened.ts

@@ -1,39 +1,17 @@
+import * as listener from '../listeners'
 import { Handler } from './typings'
 
-export const handleNewIssue: Handler<'github:issueOpened'> = async ({ client, ctx }, event): Promise<void> => {
+export const handleNewIssue: Handler<'github:issueOpened'> = async (props, event): Promise<void> => {
   const githubIssue = event.payload
 
   console.info('Received GitHub issue', githubIssue)
 
-  const { output } = await client.callAction({
-    type: 'linear:createIssue',
-    input: {
-      title: githubIssue.title,
-      description: githubIssue.content ?? 'No content...',
-      teamName: 'Cloud Services',
-      labels: ['origin/github'],
-    },
-  })
-
-  const { issue } = output
-
-  const { conversation } = await client.getOrCreateConversation({
-    integrationName: 'linear',
-    channel: 'issue',
-    tags: {
-      ['linear:id']: issue.id,
-    },
-  })
-
-  const issueUrl = `https://github.com/${githubIssue.repositoryOwner}/${githubIssue.repositoryName}/issues/${githubIssue.number}`
+  const message = ['The following issue was just created in GitHub:', githubIssue.title, githubIssue.content].join('\n')
 
-  await client.createMessage({
+  await listener.notifyListeners(props, {
     type: 'text',
-    conversationId: conversation.id,
-    userId: ctx.botId,
-    tags: {},
     payload: {
-      text: `Automatically created from GitHub issue: ${issueUrl}`,
+      text: message,
     },
   })
 }

bots/bugbuster/src/handlers/sync-issues.ts

@@ -7,7 +7,7 @@ import { Handler } from './typings'
  */
 export const handleSyncIssuesRequest: Handler<'syncIssuesRequest'> = async (props) => {
   try {
-    const { client, ctx } = props
+    const { client } = props
     const {
       output: { targets: githubIssues },
     } = await client.callAction({
@@ -42,20 +42,12 @@ export const handleSyncIssuesRequest: Handler<'syncIssuesRequest'> = async (prop
     ].join('\n')
     console.info(message)
 
-    const state = await listeners.readListeners(props)
-    console.info(`Sending message to ${state.conversationIds.length} conversation(s)`)
-
-    for (const conversationId of state.conversationIds) {
-      await client.createMessage({
-        conversationId,
-        userId: ctx.botId,
-        tags: {},
-        type: 'text',
-        payload: {
-          text: message,
-        },
-      })
-    }
+    await listeners.notifyListeners(props, {
+      type: 'text',
+      payload: {
+        text: message,
+      },
+    })
   } catch (thrown) {
     // If recurring event fails to many times, bridge stops sending it... We don't want that
     const err = thrown instanceof Error ? thrown : new Error(`${thrown}`)

bots/bugbuster/src/listeners.ts

@@ -1,6 +1,8 @@
-import { BotListeners, EventHandlerProps } from './bot'
+import { BotListeners, EventHandlerProps, ClientInputs } from './bot'
 
 type Props = Omit<EventHandlerProps, 'event'>
+type Message = Pick<ClientInputs['createMessage'], 'type' | 'payload'>
+
 const emptyListeners: BotListeners = {
   conversationIds: [],
 }
@@ -28,3 +30,16 @@ export const writeListeners = async (props: Props, state: BotListeners) => {
     payload: state,
   })
 }
+
+export const notifyListeners = async (props: Props, message: Message) => {
+  const state = await readListeners(props)
+  console.info(`Sending message to ${state.conversationIds.length} conversation(s)`)
+  for (const conversationId of state.conversationIds) {
+    await props.client.createMessage({
+      conversationId,
+      userId: props.ctx.botId,
+      tags: {},
+      ...message,
+    })
+  }
+}