liatrio/lab-partner

Lab-Partner

Slack机器人，用于交互式自动化工作坊支持

配置

环境变量

• CLIENT_SIGNING_SECRET: Slack应用签名密钥
  创建Slack应用时生成，可在 api.***/app 的 基本信息 -> 应用凭证 -> 签名密钥 中获取。
• BOT_TOKEN: Slack应用机器人用户OAuth令牌
  创建Slack应用时生成，可在 api.***/app 的 OAuth & 权限 -> 工作区令牌 -> 机器人用户OAuth访问令牌 中获取。
• TEAM: Slack工作区ID
• MONGO_URI: MongoDB服务器URL
• SCRIPT: 指向脚本文件夹的相对路径

Kubernetes Secret配置

若部署到Kubernetes，该应用有一个Helm chart，其中包含名为lab-partner的Secret。需在values.yaml中设置以下三个字符串以填充该Secret：

yaml
secrets:
  slackSigningSecret: ""
  slackBotUserOauthAccessToken: ""
  teamId: ""

脚本

脚本代表特定工作坊或实验室的自定义功能，它告诉机器人如何响应用户输入或其他事件、如何跟踪参与者进度等。脚本是一个包含BotKit功能的文件夹，每个功能是一个JavaScript模块，返回一个接收BotKit控制器作为参数的函数。

javascript
module.exports = function (controller) {
  // 在这里编写扩展机器人功能的代码 :)
}

在 sample-script 文件夹中有一个示例脚本。
要使用脚本，需将SCRIPT环境变量设置为脚本文件夹的相对路径。

插件

帮助（Help）

提供内置帮助消息的访问。

help.addCommand(command, name, description)
向内置帮助消息添加命令，脚本功能应使用此方法记录参与者可用的额外命令。

• command: 触发功能的示例消息
• name: 功能名称
• description: 功能描述

javascript
module.exports = async (controller) => {
  controller.plugins.help.addCommand("@lab-partner awesome feature", "Awesome Feature", "这个功能非常棒！");
  
  controller.hears("awesome feature", "mention", (bot, message) => {
    bot.reply(message, "这个功能很棒！");
  });
}

help.getMessage()
返回Slack消息以显示包含可用命令的帮助信息，消息以包含Slack块工具包块列表的对象形式返回。

javascript
module.exports = async (controller) => {
  controller.hears("foo", "mention", (bot, message) => {
    const helpMessage = controller.plugins.help.getMessage();
    
    bot.reply(message, {
      blocks: [
        {
          type: "section",
          text: {
            type: "mrkdwn",
            text: "我不明白你说的\"foo\"是什么意思。试试这些命令...",
          },
        },
        ...helpMessage.blocks,
      ],
    });
  });
}

Slack助手（Slack helper）

slack.whoAmI()
获取机器人的Slack 用户信息。

javascript
module.exports = async (controller) => {
  let botUser;
  try {
    botUser = await controller.slack.whoAmI();
  } catch (error) {
    console.error(`获取机器人用户信息失败：${error}`);
    return;
  }
  console.log(`机器人用户名是 ${botUser.real_name}。`);
}

slack.getUserInfo(id)
获取指定用户的Slack 用户信息。

• id: Slack用户ID

javascript
module.exports = async (controller) => {
  controller.hears("我的状态是什么", "message", async (bot, message) => {
    const userInfo = await controller.plugins.slack.getUserInfo(message.user);
    
    bot.reply(message, {
      blocks: [
        {
          type: "section",
          text: {
            type: "mrkdwn",
            text: `你的状态是 ${userInfo.profile.status_emoji}: ${userInfo.profile.status_text}`,
          },
        },
      ],
    });
  });
}

Docker部署示例

bash
docker run -d \
  --name lab-partner \
  -e CLIENT_SIGNING_SECRET="your_signing_secret" \
  -e BOT_TOKEN="your_bot_token" \
  -e TEAM="your_team_id" \
  -e MONGO_URI="mongodb://localhost:27017/lab-partner" \
  -e SCRIPT="./sample-script" \
  liatrio/lab-partner