🧪 add testcode (#10)

Author: woohm402

.github/workflows/ci.yml

@@ -0,0 +1,34 @@
+name: CI
+
+on:
+  push:
+    branches: ["main"]
+  pull_request:
+    types: [opened, synchronize]
+
+jobs:
+  build:
+    name: Build and Test
+    timeout-minutes: 1
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Check out code
+        uses: actions/checkout@v3
+        with:
+          fetch-depth: 2
+
+      - name: Setup Node.js environment
+        uses: actions/setup-node@v3
+        with:
+          node-version: 16
+          cache: "yarn"
+
+      - name: Install dependencies
+        run: yarn
+
+      - name: Build
+        run: yarn build
+
+      - name: Test
+        run: yarn test

package.json

@@ -8,6 +8,7 @@
   "scripts": {
     "build": "turbo run build",
     "dev": "turbo run dev",
+    "test": "turbo run test",
     "lint": "turbo run lint",
     "format": "prettier --write \"**/*.{ts,tsx,md}\"",
     "publish-packages": "turbo run build lint test && changeset version && changeset publish"

packages/truffle-browser/package.json

@@ -1,12 +1,13 @@
 {
   "name": "@wafflestudio/truffle-browser",
-  "version": "0.2.0",
+  "version": "0.2.1",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
   "license": "MIT",
   "scripts": {
     "dev": "yarn build -- --watch",
-    "build": "tsup src/index.ts --format cjs --dts"
+    "build": "tsup src/index.ts --format cjs --dts",
+    "test": "vitest run"
   },
   "files": [
     "dist/index.js",
@@ -17,8 +18,11 @@
     "error-stack-parser": "^2.1.4"
   },
   "devDependencies": {
+    "happy-dom": "8.2.6",
     "tsup": "6.5.0",
-    "typescript": "4.9.5"
+    "typescript": "4.9.5",
+    "vite": "4.1.1",
+    "vitest": "0.28.4"
   },
   "publishConfig": {
     "access": "public"

packages/truffle-browser/src/index.test.ts

@@ -0,0 +1,73 @@
+import { describe, it, expect, vi, afterEach, beforeEach } from "vitest";
+import { getTruffleClient, TruffleClient } from ".";
+import * as postEvent from "./postEvent";
+
+describe("getTruffleClient (disabled)", () => {
+  let client: TruffleClient;
+
+  beforeEach(() => {
+    client = getTruffleClient({
+      enabled: false,
+      app: { name: "1", phase: "2" },
+      apiKey: "3",
+    });
+  });
+
+  afterEach(() => {
+    vi.clearAllMocks();
+  });
+
+  it("capture", () => {
+    const spy = vi.spyOn(postEvent, "postEvent");
+    client.capture(new Error("test"));
+    expect(spy).not.toBeCalled();
+  });
+});
+
+describe("getTruffleClient (enabled)", () => {
+  let client: TruffleClient;
+
+  beforeEach(() => {
+    client = getTruffleClient({
+      enabled: true,
+      app: { name: "1", phase: "2" },
+      apiKey: "3",
+    });
+  });
+
+  afterEach(() => {
+    vi.clearAllMocks();
+  });
+
+  it("capture", () => {
+    const spy = vi.spyOn(postEvent, "postEvent");
+    client.capture(new Error("test"));
+    expect(spy).toBeCalledWith("3", {
+      app: { name: "1", phase: "2" },
+      description: "about:blank",
+      exception: {
+        className: "Error",
+        message: "test",
+        elements: expect.any(Array),
+      },
+      runtime: { name: "browser", version: "" },
+      version: "v1",
+    });
+  });
+
+  it("capture (sdk error)", () => {
+    const spy = vi.spyOn(postEvent, "postEvent");
+    client.capture("test" as unknown as Error);
+    expect(spy).toBeCalledWith("3", {
+      app: { name: "1", phase: "2" },
+      description: "Cannot parse given Error object",
+      exception: {
+        className: "sdk error",
+        message: "sdk error",
+        elements: expect.any(Array),
+      },
+      runtime: { name: "browser", version: "" },
+      version: "v1",
+    });
+  });
+});

packages/truffle-browser/src/index.ts

@@ -1,4 +1,5 @@
 import ErrorStackParser from "error-stack-parser";
+import { postEvent } from "./postEvent";
 
 export interface TruffleClient {
   capture(message: Error): void;
@@ -10,61 +11,54 @@ export interface TruffleConfig {
   apiKey: string;
 }
 
-const baseUrl = "https://truffle-api.wafflestudio.com";
 const runtime = { name: "browser", version: "" };
 
 export const getTruffleClient = ({
   enabled = true,
   app,
   apiKey,
 }: TruffleConfig): TruffleClient => {
-  const send = (body: unknown) =>
-    fetch(`${baseUrl}/events`, {
-      method: "POST",
-      headers: { "x-api-key": apiKey, "content-type": "application/json" },
-      body: JSON.stringify(body),
-    });
-
   return {
     capture: (error: Error) => {
       try {
         if (!enabled) return;
 
         const message = error.message;
         const description = window.location.href;
-        const fallbackString = "__fail__";
         const fallbackNumber = 99999;
         const elements = ErrorStackParser.parse(error).map((e) => ({
           className: "",
-          methodName: e.functionName ?? fallbackString,
+          methodName: e.functionName ?? "",
           lineNumber: e.lineNumber ?? fallbackNumber,
-          fileName: e.fileName ?? fallbackString,
+          fileName: e.fileName ?? "",
           isInAppInClude: e.isNative ?? true,
         }));
 
         const body = {
-          version: "v1",
           app,
-          runtime,
           description,
           exception: { className: error.name, message, elements },
+          runtime,
+          version: "v1",
         };
 
-        send(body);
+        postEvent(apiKey, body);
       } catch (err) {
-        send(
-          JSON.stringify({
-            version: "v1",
-            app,
-            runtime,
-            description: "",
-            exception: {
-              className: "sdk error",
-              message: "sdk error",
-              elements: [],
-            },
-          })
-        );
+        const body = {
+          app,
+          description:
+            err && typeof err === "object"
+              ? (err as { message?: string }).message
+              : "",
+          exception: {
+            className: "sdk error",
+            message: "sdk error",
+            elements: [],
+          },
+          runtime,
+          version: "v1",
+        };
+        postEvent(apiKey, body);
       }
     },
   };

packages/truffle-browser/src/postEvent.ts

@@ -0,0 +1,8 @@
+const baseUrl = "https://truffle-api.wafflestudio.com";
+
+export const postEvent = (apiKey: string, body: unknown) =>
+  fetch(`${baseUrl}/events`, {
+    method: "POST",
+    headers: { "x-api-key": apiKey, "content-type": "application/json" },
+    body: JSON.stringify(body),
+  });

packages/truffle-browser/vite.config.ts

@@ -0,0 +1,7 @@
+import { defineConfig } from "vite";
+
+export default defineConfig({
+  test: {
+    environment: "happy-dom",
+  },
+});

turbo.json

@@ -4,7 +4,7 @@
   "pipeline": {
     "build": { "dependsOn": ["^build"], "outputs": ["dist/**"] },
     "lint": { "outputs": [] },
-    "test": { "outputs": [] },
+    "test": { "dependsOn": ["^build"], "outputs": [] },
     "dev": { "cache": false }
   }
 }