feat: Post Discord channel message on points earned (#83)

* feat: Post Discord channel message on points earned

* added trigger-example in gitignore

* resolve merge conflicts

---------

Co-authored-by: Johannes <[email protected]>

.env.example

@@ -43,7 +43,7 @@ GITHUB_APP_PRIVATE_KEY=""
 GITHUB_APP_SLUG=
 
 #S3 Bucket credentials
- S3_ACCESS_KEY=
+S3_ACCESS_KEY=
 S3_BUCKET_NAME=
 S3_REGION=
 S3_SECRET_KEY=
@@ -54,4 +54,8 @@ TRIGGER_API_URL=
 
 # Tremendous API credentials
 TREMENDOUS_API_KEY=
-TREMENDOUS_CAMPAIGN_ID=
+TREMENDOUS_CAMPAIGN_ID=
+
+# Discord Credentials
+DISCORD_BOT_TOKEN=
+DISCORD_CHANNEL_ID=

.gitignore

@@ -37,4 +37,6 @@ yarn-error.log*
 next-env.d.ts
 
 .vscode
-.contentlayer
+.contentlayer
+
+jobs/examples.ts

env.mjs

@@ -31,6 +31,8 @@ export const env = createEnv({
     VERCEL_URL: z.string().optional(),
     TREMENDOUS_API_KEY: z.string().min(1),
     TREMENDOUS_CAMPAIGN_ID: z.string().min(1),
+    DISCORD_BOT_TOKEN: z.string(),
+    DISCORD_CHANNEL_ID: z.string(),
   },
   client: {
     NEXT_PUBLIC_APP_URL: z.string().min(1),
@@ -62,5 +64,7 @@ export const env = createEnv({
     TRIGGER_API_URL: process.env.TRIGGER_API_URL,
     TREMENDOUS_API_KEY: process.env.TREMENDOUS_API_KEY,
     TREMENDOUS_CAMPAIGN_ID: process.env.TREMENDOUS_CAMPAIGN_ID,
+    DISCORD_BOT_TOKEN: process.env.DISCORD_BOT_TOKEN,
+    DISCORD_CHANNEL_ID: process.env.DISCORD_CHANNEL_ID,
   },
 });

jobs/discordPointsMessage.ts

@@ -0,0 +1,32 @@
+import { DISCORD_POINTS_MESSAGE_TRIGGER_ID } from "@/lib/constants";
+import { discordApi } from "@/lib/discord";
+import { triggerDotDevClient } from "@/trigger";
+import { eventTrigger } from "@trigger.dev/sdk";
+import z from "zod";
+
+triggerDotDevClient.defineJob({
+  id: "discord-points-message",
+  name: "Discord award points message",
+  version: "0.0.1",
+  trigger: eventTrigger({
+    name: DISCORD_POINTS_MESSAGE_TRIGGER_ID,
+    schema: z.object({
+      channelId: z.string(),
+      message: z.string(),
+    }),
+  }),
+  run: async (payload, io) => {
+    const { channelId, message } = payload;
+
+    await io.runTask(
+      "Post awarded message to Discord channel",
+      async () => {
+        const channelsAPI = discordApi.channels;
+        await channelsAPI.createMessage(channelId, { content: message });
+      },
+
+      // Add metadata to the task to improve how it displays in the logs
+      { name: "Send message", icon: "discord" }
+    );
+  },
+});

jobs/index.ts

@@ -1,3 +1,4 @@
 // export all your job files here
 
-export * from "./issueReminder"
+export * from "./issueReminder";
+export * from "./discordPointsMessage";

lib/constants.ts

@@ -71,3 +71,9 @@ export const WEBAPP_URL =
 // Tremendous
 export const TREMENDOUS_API_KEY = env.TREMENDOUS_API_KEY;
 export const TREMENDOUS_CAMPAIGN_ID = env.TREMENDOUS_CAMPAIGN_ID;
+
+// Discord
+export const DISCORD_BOT_TOKEN = env.DISCORD_BOT_TOKEN;
+export const DISCORD_POINTS_MESSAGE_TRIGGER_ID = "discord.pointsMessage";
+export const DISCORD_AWARD_POINTS_MESSAGE = (username: string, points: number) =>
+  `Way to go, ${username} 🎉 You've just earned ${points} points. Your contribution is invaluable to our community 🙌 Keep up the fantastic work and let's keep pushing forward! 💪`;

lib/discord.ts

@@ -0,0 +1,7 @@
+import { env } from "@/env.mjs";
+// @ts-ignore
+import { API } from "@discordjs/core/http-only";
+import { REST } from "@discordjs/rest";
+
+const rest = new REST({ version: "10" }).setToken(env.DISCORD_BOT_TOKEN!);
+export const discordApi = new API(rest);

lib/github/hooks/issue.ts

@@ -1,7 +1,10 @@
+import { env } from "@/env.mjs";
 import {
   ASSIGN_IDENTIFIER,
   AWARD_POINTS_IDENTIFIER,
   CREATE_IDENTIFIER,
+  DISCORD_AWARD_POINTS_MESSAGE,
+  DISCORD_POINTS_MESSAGE_TRIGGER_ID,
   EVENT_TRIGGERS,
   LEVEL_LABEL,
   ON_NEW_ISSUE,
@@ -390,6 +393,13 @@ export const onAwardPoints = async (webhooks: Webhooks) => {
               ossGgRepo?.id
             );
             comment = `Awarding ${user.login}: ${points} points!` + " " + comment;
+            await triggerDotDevClient.sendEvent({
+              name: DISCORD_POINTS_MESSAGE_TRIGGER_ID,
+              payload: {
+                channelId: env.DISCORD_CHANNEL_ID,
+                message: DISCORD_AWARD_POINTS_MESSAGE(user.name ?? prAuthorUsername, points),
+              },
+            });
           }
         }
 

package.json

@@ -21,6 +21,12 @@
     "@aws-sdk/s3-presigned-post": "^3.577.0",
     "@aws-sdk/s3-request-presigner": "^3.577.0",
     "@hookform/resolvers": "^3.4.0",
+    "@aws-sdk/client-s3": "^3.540.0",
+    "@aws-sdk/s3-presigned-post": "^3.540.0",
+    "@aws-sdk/s3-request-presigner": "^3.540.0",
+    "@discordjs/core": "1.2.0",
+    "@discordjs/rest": "2.3.0",
+    "@hookform/resolvers": "^3.3.4",
     "@next-auth/prisma-adapter": "^1.0.7",
     "@octokit/auth-app": "^6.1.1",
     "@octokit/rest": "^20.1.1",
@@ -99,7 +105,12 @@
     "typescript": "^5.4.5"
   },
   "packageManager": "[email protected]",
+  "pnpm": {
+    "overrides": {
+      "undici": "5.27.0"
+    }
+  },
   "trigger.dev": {
-    "endpointId": "testing-bHhV"
+    "endpointId": "oss-gg-dev-ND8k"
   }
-}
+}

trigger.ts

@@ -1,8 +1,8 @@
-import { TriggerClient } from "@trigger.dev/sdk";
 import { TRIGGER_API_KEY, TRIGGER_API_URL } from "@/lib/constants";
+import { TriggerClient } from "@trigger.dev/sdk";
 
 export const triggerDotDevClient = new TriggerClient({
-  id: "testing-bHhV",
+  id: "oss-gg-dev-ND8k",
   apiKey: TRIGGER_API_KEY,
   apiUrl: TRIGGER_API_URL,
 });