feat: github 开放平台机器人增加监听消息回调到github issue comment

Author: moonrailgun

apps/github-app/.env.example

@@ -10,6 +10,7 @@ LOG_LEVEL=debug
 WEBHOOK_PROXY_URL=
 
 # Tailchat
-TAILCHAT_API_URL=https://paw-server-nightly.moonrailgun.com
+TAILCHAT_WEB_URL=https://nightly.paw.msgbyte.com
+TAILCHAT_API_URL=https://tailchat-nightly.moonrailgun.com
 TAILCHAT_APP_ID=
 TAILCHAT_APP_SECRET=

apps/github-app/api/github/webhooks/index.js

@@ -2,9 +2,9 @@
 // Reference: https://probot.github.io/docs/deployment/#vercel
 
 const { createNodeMiddleware, createProbot } = require('probot');
-const app = require('../../../src/app').app;
+const appFn = require('../../../src/app').appFn;
 
-module.exports = createNodeMiddleware(app, {
+module.exports = createNodeMiddleware(appFn, {
   probot: createProbot(),
   webhooksPath: '/api/github/webhooks',
 });

apps/github-app/package.json

@@ -19,12 +19,16 @@
   },
   "dependencies": {
     "axios": "^0.21.1",
+    "body-parser": "^1.20.1",
     "dotenv": "^16.0.3",
-    "probot": "^12.2.4",
+    "lodash": "^4.17.21",
+    "probot": "^12.3.0",
     "probot-metadata": "^2.1.0"
   },
   "devDependencies": {
+    "@types/body-parser": "^1.19.2",
     "@types/jest": "^28.1.0",
+    "@types/lodash": "^4.14.191",
     "@types/node": "^18.0.0",
     "jest": "27.5.1",
     "nock": "^13.0.5",

apps/github-app/src/app.ts

@@ -1,7 +1,14 @@
-import { Probot } from 'probot';
+import { ApplicationFunction, Probot } from 'probot';
 import metadata from 'probot-metadata';
 import { TailchatClient } from './client';
-import { configPath, generateErrorBlock } from './utils';
+import {
+  configPath,
+  generateErrorBlock,
+  generateTopicCommentCreateContent,
+  generateTopicCreateContent,
+} from './utils';
+import bodyParser from 'body-parser';
+import _ from 'lodash';
 import * as dotenv from 'dotenv'; // see https://github.com/motdotla/dotenv#how-do-i-use-dotenv-with-import
 dotenv.config();
 
@@ -24,7 +31,7 @@ const tailchatAppSecret = process.env.TAILCHAT_APP_SECRET;
 const tailchatWebUrl =
   process.env.TAILCHAT_WEB_URL || process.env.TAILCHAT_API_URL;
 
-export function app(app: Probot) {
+export const appFn: ApplicationFunction = (app, { getRouter }) => {
   app.on('issues.opened', async (ctx) => {
     if (ctx.isBot) {
       return;
@@ -54,12 +61,15 @@ export function app(app: Probot) {
         {
           groupId,
           panelId,
-          content: `[b]${
-            ctx.payload.issue.user.login
-          }[/b] create Issue:\n\nTitle: ${ctx.payload.issue.title}\n[markdown]${
-            ctx.payload.issue.body ?? ''
-          }[/markdown]\n\nWebsite: ${ctx.payload.issue.html_url}`,
+          content: generateTopicCreateContent(
+            ctx.payload.issue.user.login,
+            ctx.payload.issue.title,
+            ctx.payload.issue.body ?? '',
+            ctx.payload.issue.html_url
+          ),
           meta: {
+            tailchatHost: tailchatClient.url,
+            installationId: ctx.payload.installation?.id,
             githubRepoOwner: ctx.payload.repository.owner.login,
             githubRepoName: ctx.payload.repository.name,
             githubIssueNumber: ctx.payload.issue.number,
@@ -130,11 +140,11 @@ export function app(app: Probot) {
         groupId,
         panelId,
         topicId,
-        content: `[b]${
-          ctx.payload.comment.user.login
-        }[/b] reply Issue:\n\n[markdown]${
-          ctx.payload.comment.body ?? ''
-        }[/markdown]\n\nWebsite: ${ctx.payload.comment.html_url}`,
+        content: generateTopicCommentCreateContent(
+          ctx.payload.comment.user.login,
+          ctx.payload.comment.body ?? '',
+          ctx.payload.comment.html_url
+        ),
       });
     } catch (err) {
       console.error(err);
@@ -158,7 +168,9 @@ export function app(app: Probot) {
   //     installationTargetRepositories,
   //   });
   // });
-}
+
+  buildRouter(app, getRouter);
+};
 
 /**
  * 从配置文件中创建上下文
@@ -168,23 +180,99 @@ export function app(app: Probot) {
 function createTailchatContextWithConfig(githubRaw: string) {
   const content = Buffer.from(githubRaw, 'base64').toString();
   const json = JSON.parse(content);
-  const tailchatHost = json['tailchatHost'];
+  const tailchatHost = json['tailchatHost'] ?? defaultTailchatApiUrl;
   const groupId = json['groupId'];
   const panelId = json['panelId'];
 
   if (!groupId || !panelId) {
     throw new Error('config format error');
   }
 
-  const tailchatClient = new TailchatClient(
-    tailchatHost ?? defaultTailchatApiUrl,
-    tailchatAppId,
-    tailchatAppSecret
-  );
+  const tailchatClient = createTailchatClient(tailchatHost);
 
   return {
     tailchatClient,
     groupId,
     panelId,
   };
 }
+
+function createTailchatClient(tailchatHost = defaultTailchatApiUrl) {
+  const tailchatClient = new TailchatClient(
+    tailchatHost,
+    tailchatAppId,
+    tailchatAppSecret
+  );
+
+  return tailchatClient;
+}
+
+function buildRouter(
+  app: Probot,
+  getRouter: Parameters<ApplicationFunction>[1]['getRouter']
+) {
+  if (getRouter) {
+    getRouter('/')
+      .get('/', (_req, res) => {
+        res.send('Hello World! Github app server is working!');
+      })
+      .post('/message/webhook', bodyParser.json(), (req, res) => {
+        (async () => {
+          try {
+            // 根据收件箱内容向 Github Issue 创建话题
+            const inboxItem = req.body ?? {};
+            if (inboxItem.type !== 'plugin:com.msgbyte.topic.comment') {
+              // 如果不是回复消息，则跳过
+              return;
+            }
+
+            const newComment: any =
+              _.last(_.get(inboxItem, ['payload', 'comments'])) ?? {};
+            const meta = _.get(inboxItem, ['payload', 'meta']) ?? {};
+            if (
+              !meta.installationId ||
+              !meta.githubRepoOwner ||
+              !meta.githubRepoName ||
+              !meta.githubIssueNumber
+            ) {
+              console.warn('Cannot pass meta info check:', { meta });
+              return;
+            }
+            if (!newComment.author || !newComment.content) {
+              console.warn(
+                'Cannot get "newComment.author" or "newComment.content"'
+              );
+              return;
+            }
+
+            // 发送到github comment
+            const octokit = await app.auth(Number(meta.installationId));
+            const tailchatClient = createTailchatClient(meta.tailchatHost);
+            const userInfo = await tailchatClient.call('user.getUserInfo', {
+              userId: newComment.author,
+            });
+
+            const payload = {
+              owner: meta.githubRepoOwner,
+              repo: meta.githubRepoName,
+              issue_number: meta.githubIssueNumber,
+              body: `[${_.get(userInfo, [
+                'data',
+                'nickname',
+              ])}] 在 Tailchat 回复:\n\`\`\`\n${
+                newComment.content ?? ''
+              }\n\`\`\``,
+            };
+
+            console.log('正在向Github Issue创建回复:', payload);
+
+            await octokit.issues.createComment(payload);
+          } catch (err) {
+            console.error(err);
+          }
+        })();
+
+        res.send('Success!');
+      });
+  }
+}

apps/github-app/src/client.ts

@@ -51,7 +51,7 @@ export class TailchatClient {
       console.log('tailchat openapp login success!');
 
       // 尝试调用函数
-      this.whoami().then(console.log);
+      // this.whoami().then(console.log);
     } catch (err) {
       console.error(err);
       throw new Error('登录失败, 请检查应用凭证');

apps/github-app/src/index.ts

@@ -1,8 +1,4 @@
 import { run } from 'probot';
-import { app } from './app';
+import { appFn } from './app';
 
-run(app).then((server) => {
-  server.router('/').get('/', (_req, res) => {
-    res.send('Hello World! Github app server is working!');
-  });
-});
+run(appFn);

apps/github-app/src/utils.ts

@@ -11,3 +11,33 @@ export function generateErrorBlock(err: unknown) {
 
   return `Tailchat occur error, please checkout your config in \`${configPath}\`! \n${errorBlock}`;
 }
+
+/**
+ * 生成创建话题的内容
+ */
+export function generateTopicCreateContent(
+  user: string,
+  title: string,
+  body: string,
+  url: string
+) {
+  return `[b]${user}[/b] create Issue:
+[b]Title: ${title}[/b]
+[markdown]${body}[/markdown]
+
+Website: ${url}`;
+}
+
+/**
+ * 生成创建话题的内容
+ */
+export function generateTopicCommentCreateContent(
+  user: string,
+  body: string,
+  url: string
+) {
+  return `[b]${user}[/b] reply Issue:
+[markdown]${body}[/markdown]
+
+Website: ${url}`;
+}