add tests

Author: hzrd149

.github/workflows/test.yml

@@ -0,0 +1,30 @@
+name: CI/CD Pipeline
+
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+    branches:
+      - master
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout Repo
+        uses: actions/checkout@v4
+
+      - uses: pnpm/action-setup@v4
+
+      - name: Setup Node.js 20
+        uses: actions/setup-node@v4
+        with:
+          node-version: 20
+          cache: "pnpm"
+
+      - name: Install Dependencies
+        run: pnpm install
+
+      - name: Run tests
+        run: pnpm test

package.json

@@ -3,6 +3,7 @@
   "private": true,
   "scripts": {
     "build": "turbo build",
+    "test": "turbo test",
     "format": "prettier --write .",
     "docs": "typedoc",
     "version-packages": "changeset version && pnpm install --no-frozen-lockfile && pnpm format",

packages/core/package.json

@@ -6,7 +6,10 @@
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "scripts": {
-    "build": "tsc"
+    "build": "tsc",
+    "watch:build": "tsc --watch > /dev/null",
+    "test": "node --experimental-vm-modules node_modules/jest/bin/jest.js",
+    "watch:test": "(trap 'kill 0' SIGINT; pnpm run build -w > /dev/null & pnpm run test --watch)"
   },
   "keywords": [
     "nostr"
@@ -47,8 +50,20 @@
     "zen-push": "^0.3.1"
   },
   "devDependencies": {
+    "@jest/globals": "^29.7.0",
     "@types/debug": "^4.1.12",
+    "@types/jest": "^29.5.13",
     "@types/zen-observable": "^0.8.7",
+    "jest": "^29.7.0",
+    "jest-extended": "^4.0.2",
     "zen-observable": "^0.10.0"
+  },
+  "jest": {
+    "roots": [
+      "dist"
+    ],
+    "setupFilesAfterEnv": [
+      "jest-extended/all"
+    ]
   }
 }

packages/core/src/helpers/mailboxes.test.ts

@@ -0,0 +1,143 @@
+/// <reference types="jest-extended" />
+import { NostrEvent } from "nostr-tools";
+import { getInboxes, getOutboxes } from "./mailboxes.js";
+
+const emptyEvent: NostrEvent = {
+  kind: 10002,
+  content: "",
+  tags: [],
+  created_at: 0,
+  sig: "",
+  id: "",
+  pubkey: "",
+};
+
+describe("Mailboxes", () => {
+  describe("getInboxes", () => {
+    test("should transform urls", () => {
+      expect(
+        Array.from(
+          getInboxes({
+            ...emptyEvent,
+            tags: [["r", "wss://inbox.com"]],
+          }),
+        ),
+      ).toIncludeAllMembers(["wss://inbox.com/"]);
+    });
+
+    test("should remove bad urls", () => {
+      expect(
+        Array.from(
+          getInboxes({
+            ...emptyEvent,
+            tags: [["r", "bad://inbox.com"]],
+          }),
+        ),
+      ).toBeArrayOfSize(0);
+
+      expect(
+        Array.from(
+          getInboxes({
+            ...emptyEvent,
+            tags: [["r", "something that is not a url"]],
+          }),
+        ),
+      ).toBeArrayOfSize(0);
+
+      expect(
+        Array.from(
+          getInboxes({
+            ...emptyEvent,
+            tags: [["r", "wss://inbox.com,wss://inbox.org"]],
+          }),
+        ),
+      ).toBeArrayOfSize(0);
+    });
+
+    test("without marker", () => {
+      expect(
+        Array.from(
+          getInboxes({
+            ...emptyEvent,
+            tags: [["r", "wss://inbox.com/"]],
+          }),
+        ),
+      ).toIncludeAllMembers(["wss://inbox.com/"]);
+    });
+
+    test("with marker", () => {
+      expect(
+        Array.from(
+          getInboxes({
+            ...emptyEvent,
+            tags: [["r", "wss://inbox.com/", "read"]],
+          }),
+        ),
+      ).toIncludeAllMembers(["wss://inbox.com/"]);
+    });
+  });
+
+  describe("getOutboxes", () => {
+    test("should transform urls", () => {
+      expect(
+        Array.from(
+          getOutboxes({
+            ...emptyEvent,
+            tags: [["r", "wss://outbox.com"]],
+          }),
+        ),
+      ).toIncludeAllMembers(["wss://outbox.com/"]);
+    });
+
+    test("should remove bad urls", () => {
+      expect(
+        Array.from(
+          getOutboxes({
+            ...emptyEvent,
+            tags: [["r", "bad://inbox.com"]],
+          }),
+        ),
+      ).toBeArrayOfSize(0);
+
+      expect(
+        Array.from(
+          getOutboxes({
+            ...emptyEvent,
+            tags: [["r", "something that is not a url"]],
+          }),
+        ),
+      ).toBeArrayOfSize(0);
+
+      expect(
+        Array.from(
+          getOutboxes({
+            ...emptyEvent,
+            tags: [["r", "wss://outbox.com,wss://inbox.org"]],
+          }),
+        ),
+      ).toBeArrayOfSize(0);
+    });
+
+    test("without marker", () => {
+      expect(
+        Array.from(
+          getOutboxes({
+            ...emptyEvent,
+            tags: [["r", "wss://outbox.com/"]],
+          }),
+        ),
+      ).toIncludeAllMembers(["wss://outbox.com/"]);
+    });
+
+    test("with marker", () => {
+      expect(
+        Array.from(
+          getOutboxes({
+            ...emptyEvent,
+            tags: [["r", "wss://outbox.com/", "write"]],
+          }),
+        ),
+      ).toIncludeAllMembers(["wss://outbox.com/"]);
+    });
+  });
+});