Demo

.github/knip.ts

@@ -2,7 +2,7 @@ import type { KnipConfig } from "knip";
 
 const config: KnipConfig = {
   entry: ["src/action.ts", "src/worker.ts"],
-  project: ["src/", "test/"],
+  project: ["src/**/*.ts"],
   ignore: ["src/types/config.ts", "**/__mocks__/**", "**/__fixtures__/**"],
   ignoreExportsUsedInFile: true,
   // eslint can also be safely ignored as per the docs: https://knip.dev/guides/handling-issues#eslint--jest

.github/workflows/jest-testing.yml

@@ -15,14 +15,14 @@ jobs:
         with:
           bun-version: latest
 
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v5
         with:
           fetch-depth: 0
 
       - name: Jest With Coverage
         run: |
           bun install --frozen-lockfile
-          bun run test
+          bun run jest:test
 
       - name: Add Jest Report to Summary
         if: always()

.github/workflows/update-configuration.yml

@@ -39,7 +39,7 @@ jobs:
     name: "Deploy (Action / Deno)"
     runs-on: ubuntu-latest
     permissions: write-all
-    environment: ${{ (github.event.ref == 'refs/heads/main' || github.ref == 'refs/heads/main' || github.event.workflow_run.head_branch == 'main') && 'main' || 'development' }}
+    environment: ${{ (github.event.ref == 'refs/heads/main' || github.ref == 'refs/heads/main' || github.event.workflow_run.head_branch == 'main' || github.event.ref == 'refs/heads/demo' || github.ref == 'refs/heads/demo' || github.event.workflow_run.head_branch == 'demo') && 'main' || 'development' }}
     env:
       BUILD_ACTION_ENABLED: ${{ github.event_name == 'workflow_dispatch' && inputs.build_action_enabled || vars.BUILD_ACTION_ENABLED || 'true' }}
       DEPLOY_DENO_ENABLED: ${{ github.event_name == 'workflow_dispatch' && inputs.deploy_deno_enabled || vars.DEPLOY_DENO_ENABLED || 'true' }}

jest.config.ts

@@ -1,23 +1,20 @@
 import type { Config } from "jest";
 
 const cfg: Config = {
+  testEnvironment: "node",
   transform: {
-    "^.+\\.tsx?$": [
-      "ts-jest",
-      {
-        useESM: true,
-      },
-    ],
+    "^.+\\.[jt]s$": "@swc/jest",
   },
   moduleFileExtensions: ["ts", "tsx", "js", "jsx", "json", "node"],
-  coveragePathIgnorePatterns: ["node_modules", "mocks"],
+  coveragePathIgnorePatterns: ["node_modules", "mocks", "tests"],
   collectCoverage: true,
   coverageReporters: ["json", "lcov", "text", "clover", "json-summary"],
   reporters: ["default", "jest-junit", "jest-md-dashboard"],
   coverageDirectory: "coverage",
   testTimeout: 20000,
   roots: ["<rootDir>", "tests"],
-  extensionsToTreatAsEsm: [".ts"],
+  transformIgnorePatterns: [],
+  extensionsToTreatAsEsm: [".ts", ".tsx"],
   moduleNameMapper: {
     "^(\\.{1,2}/.*)\\.js$": "$1",
   },

package.json

@@ -23,7 +23,8 @@
     "prepare": "bun run prepare:manifest && husky install",
     "prepare:manifest": "bunx @ubiquity-os/plugin-manifest-tool@latest",
     "prebuild": "bun run prepare:manifest",
-    "test": "cross-env NODE_OPTIONS=\"$NODE_OPTIONS --experimental-vm-modules\" jest --setupFiles dotenv/config --coverage",
+    "jest:test": "jest --coverage",
+    "test": "jest --coverage",
     "worker": "wrangler dev --env dev --port 4000"
   },
   "keywords": [
@@ -34,12 +35,10 @@
     "open-source"
   ],
   "dependencies": {
-    "@sinclair/typebox": "0.34.15",
-    "@ubiquity-os/plugin-sdk": "^3.1.4",
+    "@sinclair/typebox": "0.34.41",
+    "@ubiquity-os/plugin-sdk": "^3.8.1",
     "@ubiquity-os/ubiquity-os-logger": "^1.4.0",
-    "dotenv": "16.4.7",
-    "hono": "^4.6.19",
-    "ts-node": "^10.9.2"
+    "hono": "^4.11.3"
   },
   "devDependencies": {
     "@commitlint/cli": "19.6.1",
@@ -50,10 +49,11 @@
     "@eslint/js": "9.19.0",
     "@jest/globals": "29.7.0",
     "@mswjs/data": "0.16.2",
+    "@swc/jest": "^0.2.39",
     "@types/jest": "^29.5.14",
     "@types/node": "22.12.0",
-    "cross-env": "^7.0.3",
     "cspell": "8.17.3",
+    "dotenv": "^17.2.3",
     "eslint": "9.19.0",
     "eslint-plugin-check-file": "3.0.0",
     "eslint-plugin-sonarjs": "3.0.1",
@@ -65,7 +65,7 @@
     "lint-staged": "15.4.3",
     "npm-run-all": "4.1.5",
     "prettier": "3.4.2",
-    "ts-jest": "29.2.5",
+    "ts-node": "^10.9.2",
     "typescript": "5.6.2",
     "typescript-eslint": "8.22.0",
     "wrangler": "3.102.0"
@@ -83,5 +83,8 @@
     "extends": [
       "@commitlint/config-conventional"
     ]
+  },
+  "resolutions": {
+    "@sinclair/typebox": "0.34.41"
   }
 }

src/index.ts

@@ -3,13 +3,16 @@ import { handleCommentCreated, handleCommentEdited } from "./handlers/run-demo";
 import { Context } from "./types/index";
 import { isCommentCreatedEvent, isCommentEditedEvent } from "./types/typeguards";
 
+const BAD_CREDENTIALS_MESSAGE = "The credentials provided for the GitHub user are invalid, the demo cannot proceed.";
+
 export async function runPlugin(context: Context) {
   const { logger, eventName } = context;
 
-  context.userOctokit = new customOctokit({
-    auth: context.env.USER_GITHUB_TOKEN,
-  });
-  const { data: user } = await context.userOctokit.rest.users.getAuthenticated();
+  if (shouldIgnoreEvent(context)) {
+    logger.info(`Ignoring event: ${eventName}`);
+    return;
+  }
+  const user = await getGitHubUser(context);
   context.userName = user.login;
   if (isCommentCreatedEvent(context)) {
     return await handleCommentCreated(context);
@@ -19,3 +22,23 @@ export async function runPlugin(context: Context) {
 
   logger.error(`Unsupported event: ${eventName}`);
 }
+
+async function getGitHubUser(context: Context) {
+  try {
+    context.userOctokit = new customOctokit({
+      auth: context.env.USER_GITHUB_TOKEN,
+    });
+    const { data: user } = await context.userOctokit.rest.users.getAuthenticated();
+    return user;
+  } catch (err) {
+    throw context.logger.error(BAD_CREDENTIALS_MESSAGE, { err });
+  }
+}
+
+function shouldIgnoreEvent(context: Context) {
+  if (isCommentCreatedEvent(context)) {
+    const content = context.payload.comment.body;
+    return content.includes(BAD_CREDENTIALS_MESSAGE);
+  }
+  return false;
+}

src/types/typeguards.ts

@@ -7,7 +7,3 @@ export function isCommentCreatedEvent(context: Context): context is Context<"iss
 export function isCommentEditedEvent(context: Context): context is Context<"issue_comment.edited"> {
   return context.eventName === "issue_comment.edited";
 }
-
-export function isLabelEvent(context: Context): context is Context<"issues.labeled"> {
-  return context.eventName === "issues.labeled";
-}

tests/main.test.ts

@@ -3,7 +3,6 @@ import { drop } from "@mswjs/data";
 import { CommentHandler } from "@ubiquity-os/plugin-sdk";
 import { customOctokit as Octokit } from "@ubiquity-os/plugin-sdk/octokit";
 import { Logs } from "@ubiquity-os/ubiquity-os-logger";
-import dotenv from "dotenv";
 import manifest from "../manifest.json";
 import { runPlugin } from "../src";
 import { Context, Env } from "../src/types/index";
@@ -12,8 +11,6 @@ import { createComment, setupTests } from "./__mocks__/helpers";
 import { server } from "./__mocks__/node";
 import { STRINGS } from "./__mocks__/strings";
 
-dotenv.config();
-
 const octokit = new Octokit();
 
 beforeAll(() => {
@@ -50,7 +47,7 @@ describe("Plugin tests", () => {
 
     expect(errorSpy).not.toHaveBeenCalled();
     expect(infoSpy).toHaveBeenNthCalledWith(1, "Processing /demo command");
-  });
+  }, 50000);
 });
 
 function createContext(