Merge pull request ubiquity-os#55 from gentlementlegen/fix/target-bra…

…nch-dispatch

chore: added test types and test for configuration

.github/workflows/typecheck.yml

@@ -13,8 +13,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
-      - name: Install bun
-        run: npm i -g bun
+      - uses: oven-sh/setup-bun@v1
       - name: Install dependencies
         run: bun install
       - name: Run typecheck

package.json

@@ -57,6 +57,7 @@
     "@cspell/dict-software-terms": "^3.3.18",
     "@cspell/dict-typescript": "^3.1.2",
     "@mswjs/data": "0.16.1",
+    "@types/bun": "1.1.3",
     "@types/node": "^20.11.19",
     "@typescript-eslint/eslint-plugin": "^7.0.1",
     "@typescript-eslint/parser": "^7.0.1",

src/github/github-event-handler.ts

@@ -52,7 +52,7 @@ export class GitHubEventHandler {
 
     return await crypto.subtle.importKey(
       "pkcs8",
-      binaryDer.buffer,
+      binaryDer.buffer as ArrayBuffer,
       {
         name: "RSASSA-PKCS1-v1_5",
         hash: "SHA-256",

tests/__mocks__/webhooks.ts

@@ -0,0 +1,15 @@
+/* eslint-disable @typescript-eslint/naming-convention */
+
+export class WebhooksMocked {
+  constructor(_: unknown) {}
+  verifyAndReceive(_: unknown) {
+    return Promise.resolve();
+  }
+  onAny(_: unknown) {}
+  on(_: unknown) {}
+  onError(_: unknown) {}
+  removeListener(_: unknown, __: unknown) {}
+  sign(_: unknown) {}
+  verify(_: unknown, __: unknown) {}
+  receive(_: unknown) {}
+}

tests/configuration.test.ts

@@ -0,0 +1,79 @@
+import { afterAll, afterEach, beforeAll, describe, expect, it, mock } from "bun:test";
+import { config } from "dotenv";
+import { server } from "./__mocks__/node";
+import { WebhooksMocked } from "./__mocks__/webhooks";
+import { getConfig } from "../src/github/utils/config";
+import { GitHubContext } from "../src/github/github-context";
+import { GitHubEventHandler } from "../src/github/github-event-handler";
+
+config({ path: ".dev.vars" });
+
+mock.module("@octokit/webhooks", () => ({
+  Webhooks: WebhooksMocked,
+}));
+
+const issueOpened = "issues.opened";
+
+beforeAll(() => {
+  server.listen();
+});
+afterEach(() => {
+  server.resetHandlers();
+});
+afterAll(() => {
+  server.close();
+});
+
+describe("Configuration tests", () => {
+  it("Should properly parse the Action path if a branch and workflow are specified", async () => {
+    const cfg = await getConfig({
+      key: issueOpened,
+      name: issueOpened,
+      id: "",
+      payload: {
+        repository: {
+          owner: { login: "ubiquity" },
+          name: "conversation-rewards",
+        },
+      } as unknown as GitHubContext<"issues.closed">["payload"],
+      octokit: {
+        rest: {
+          repos: {
+            getContent() {
+              return {
+                data: `
+plugins:
+  'issues.labeled':
+    - uses:
+      - plugin: ubiquity/user-activity-watcher:compute.yml@pull/1
+        type: github
+        with:
+          settings1: 'enabled'`,
+              };
+            },
+          },
+        },
+      },
+      eventHandler: {} as GitHubEventHandler,
+    } as unknown as GitHubContext);
+    expect(cfg.plugins["issues.labeled"]).toEqual([
+      {
+        uses: [
+          {
+            plugin: {
+              owner: "ubiquity",
+              repo: "user-activity-watcher",
+              workflowId: "compute.yml",
+              ref: "pull/1",
+            },
+            type: "github",
+            with: {
+              settings1: "enabled",
+            },
+          },
+        ],
+        skipBotEvents: true,
+      },
+    ]);
+  });
+});

tests/main.test.ts

@@ -1,34 +1,19 @@
 import { RestEndpointMethodTypes } from "@octokit/plugin-rest-endpoint-methods";
-/* eslint-disable @typescript-eslint/naming-convention */
-// @ts-expect-error package name is correct, TypeScript doesn't recognize it
 import { afterAll, afterEach, beforeAll, describe, expect, it, jest, mock, spyOn } from "bun:test";
 import { config } from "dotenv";
 import { GitHubContext } from "../src/github/github-context";
 import { GitHubEventHandler } from "../src/github/github-event-handler";
 import { getConfig } from "../src/github/utils/config";
 import worker from "../src/worker";
 import { server } from "./__mocks__/node";
+import { WebhooksMocked } from "./__mocks__/webhooks";
 
-mock.module("@octokit/webhooks", () => ({
+void mock.module("@octokit/webhooks", () => ({
   Webhooks: WebhooksMocked,
 }));
 
 const issueOpened = "issues.opened";
 
-class WebhooksMocked {
-  constructor(_: unknown) {}
-  verifyAndReceive(_: unknown) {
-    return Promise.resolve();
-  }
-  onAny(_: unknown) {}
-  on(_: unknown) {}
-  onError(_: unknown) {}
-  removeListener(_: unknown, __: unknown) {}
-  sign(_: unknown) {}
-  verify(_: unknown, __: unknown) {}
-  receive(_: unknown) {}
-}
-
 config({ path: ".dev.vars" });
 
 beforeAll(() => {

tsconfig.json

@@ -31,7 +31,7 @@
     // "paths": {},                                      /* Specify a set of entries that re-map imports to additional lookup locations. */
     // "rootDirs": [],                                   /* Allow multiple folders to be treated as one when resolving modules. */
     // "typeRoots": [],                                  /* Specify multiple folders that act like `./node_modules/@types`. */
-    "types": ["@cloudflare/workers-types/2023-07-01"] /* Specify type package names to be included without being referenced in a source file. */,
+    "types": ["@cloudflare/workers-types/2023-07-01", "bun"] /* Specify type package names to be included without being referenced in a source file. */,
     // "allowUmdGlobalAccess": true,                     /* Allow accessing UMD globals from modules. */
     "resolveJsonModule": true /* Enable importing .json files */,
     // "noResolve": true,                                /* Disallow `import`s, `require`s or `<reference>`s from expanding the number of files TypeScript should add to a project. */