fix validator and event payload schemas

Author: sethetter

.tool-versions

@@ -0,0 +1 @@
+deno 1.44.4

README.md

@@ -2,17 +2,24 @@
 
 A slack bot powered by Slack webhook events.
 
+## Slack App
+
+This bot is installed in the devICT work space as a Slack app called **bot**.
+
+- The [OAuth & Permissions](https://api.slack.com/apps/A07B9TL6EMT/oauth) page contains the `SLACK_TOKEN` needed to power the bot.
+  - The following scopes must be added: `app_mentions:read`, `chat:write`
+- The event receiving endpoint must be added on the [Event Subscriptions](https://api.slack.com/apps/A07B9TL6EMT/event-subscriptions) page.
+  - Events to subscribe to: `app_mention`
+
 ## Slack Events
 
 [A list of all the events can be seen here](https://api.slack.com/events).
 
 The events the bot responds to are defined in the `events.ts` module. Typebox schemas are defined for the events we respond to.
 
-## Running locally
+## Development
 
-```
-deno task start
-```
+There is a separate Slack app for development that can be used.
 
 ## Deployment
 

commands/types.ts commands/mod.ts

@@ -1,3 +1,7 @@
+import { pingCommand } from "./ping.ts";
+
+export const commands = [pingCommand];
+
 export interface Command<TSlackEvent> {
   matcher: RegExp;
   handler: (event: TSlackEvent) => Promise<void>;

commands/ping.ts

@@ -1,6 +1,6 @@
+import { Command } from "./mod.ts";
 import { AppMention } from "../events.ts";
 import { slack } from "../slack.ts";
-import { Command } from "./types.ts";
 
 export const pingCommand: Command<AppMention> = {
   matcher: /ping/,

config.ts

@@ -6,5 +6,4 @@ const assertEnv = (key: string) => {
 
 export const config = {
   SLACK_TOKEN: assertEnv("SLACK_TOKEN"),
-  SLACK_WEBHOOK_URL: assertEnv("SSLACK_WEBHOOK_URL"),
 } as const;

deno.json

@@ -1,6 +1,6 @@
 {
   "tasks": {
-    "start": "deno run --allow-net main.ts",
+    "start": "deno run --allow-net --allow-env main.ts",
     "deploy": "deployctl deploy --org=devICT --project=devict-bot",
     "deploy:prod": "deployctl deploy --org=devICT --project=devict-bot --prod"
   },
@@ -11,9 +11,9 @@
     "entrypoint": "main.ts"
   },
   "imports": {
-    "@hono/typebox-validator": "npm:@hono/typebox-validator@^0.2.3",
+    "@hono/hono": "jsr:@hono/hono@^4.4.12",
+    "@hono/typebox-validator": "npm:@hono/typebox-validator@^0.2.4",
     "@sinclair/typebox": "npm:@sinclair/typebox@^0.32.26",
-    "@slack/web-api": "npm:@slack/web-api@^7.0.4",
-    "hono": "https://deno.land/x/hono/mod.ts@^4.2.8"
+    "@slack/web-api": "npm:@slack/web-api@^7.0.4"
   }
 }

deno.lock

@@ -23,5 +23,7 @@ export const AppMentionSchema = Type.Object({
 });
 export type AppMention = Static<typeof AppMentionSchema>;
 
-export const SlackEventSchema = Type.Union([ChallengeSchema, AppMentionSchema]);
+export const SlackEventSchema = Type.Object({
+  event: Type.Union([ChallengeSchema, AppMentionSchema]),
+});
 export type SlackEvent = Static<typeof SlackEventSchema>;

events.ts

@@ -1,30 +1,45 @@
-import { Hono } from "npm:hono";
-import { tbValidator } from "npm:@hono/typebox-validator";
+import { Hono } from "@hono/hono";
+import { validator } from "@hono/hono/validator";
+import { logger } from "@hono/hono/logger";
 import { SlackEventSchema } from "./events.ts";
-import { pingCommand } from "./commands/ping.ts";
+import { Value as V } from "@sinclair/typebox/value";
+import { commands } from "./commands/mod.ts";
 
 const app = new Hono();
 
-const commands = [pingCommand];
-
-app.post("/slack/event", tbValidator("json", SlackEventSchema), async (c) => {
-  const body = c.req.valid("json");
+app.use(logger());
+app.post(
+  "/slack/event",
+  validator("json", (value, c) => {
+    if (!V.Check(SlackEventSchema, value)) {
+      const errors = [...V.Errors(SlackEventSchema, value)].map(
+        ({ path, message }) => ({ path, message })
+      );
+      console.log("bad request", errors);
+      return c.json({ errors }, 400);
+    }
+    return V.Cast(SlackEventSchema, value);
+  }),
+  async (c) => {
+    const body = c.req.valid("json");
 
-  switch (body.type) {
-    case "url_verification":
-      return c.json({ challenge: body.challenge });
+    switch (body.event.type) {
+      case "url_verification":
+        return c.json({ challenge: body.event.challenge });
 
-    case "app_mention": {
-      const command = commands.find((cmd) => cmd.matcher.test(body.text));
-      if (!command) {
-        return c.json({ text: "wat?" }, 400);
-      }
+      case "app_mention": {
+        const msg = body.event.text;
+        const command = commands.find((cmd) => cmd.matcher.test(msg));
+        if (!command) {
+          return c.json({ text: "wat?" }, 400);
+        }
 
-      await command.handler(body);
+        await command.handler(body.event);
 
-      return c.text("OK");
+        return c.text("OK");
+      }
     }
   }
-});
+);
 
 Deno.serve(app.fetch);