Added some more API tests

Author: forman

chartlets.js/packages/lib/src/api/fetchCallback.test.ts

@@ -0,0 +1,88 @@
+import {
+  describe,
+  it,
+  vi,
+  expect,
+  beforeEach,
+  afterEach,
+  type Mock,
+} from "vitest";
+import { fetchCallback } from "./fetchCallback";
+
+describe("fetchCallback", () => {
+  beforeEach(() => {
+    // Mock the global fetch function
+    globalThis.fetch = vi.fn();
+  });
+
+  afterEach(() => {
+    // Restore the original fetch implementation
+    vi.restoreAllMocks();
+  });
+
+  it("should return expected data on success", async () => {
+    // Define a mock response
+    const expectedResult = {
+      contribPoint: "panels",
+      contribIndex: 0,
+      stateChanges: [
+        {
+          id: "checkbox0",
+          property: "value",
+          value: true,
+        },
+      ],
+    };
+    const mockResponse = {
+      ok: true,
+      status: 200,
+      statusText: "ok",
+      json: vi.fn().mockResolvedValue({
+        result: expectedResult,
+      }),
+    };
+
+    // Mock fetch to resolve with the mock response
+    (globalThis.fetch as Mock).mockResolvedValue(mockResponse);
+
+    // Call fetch
+    const response = await fetchCallback([], {
+      serverUrl: "https://chartlets-test",
+      endpointName: "api",
+    });
+
+    // Assertions
+    expect(fetch).toHaveBeenCalledOnce();
+    expect(response).toEqual({
+      status: "ok",
+      data: expectedResult,
+    });
+  });
+
+  it("should return error for bad API responses", async () => {
+    // Define a mock response
+    const mockResponse = {
+      ok: true,
+      status: 200,
+      statusText: "ok",
+      json: vi.fn().mockResolvedValue({ message: "Hello, world!" }),
+    };
+
+    // Mock fetch to resolve with the mock response
+    (globalThis.fetch as Mock).mockResolvedValue(mockResponse);
+
+    // Call fetch
+    const response = await fetchCallback([], {
+      serverUrl: "https://chartlets-test",
+      endpointName: "api",
+    });
+    // Assertions
+    expect(fetch).toHaveBeenCalledOnce();
+    expect(response).toEqual({
+      status: "failed",
+      error: {
+        message: "unexpected response from https://chartlets-test/api/callback",
+      },
+    });
+  });
+});

chartlets.js/packages/lib/src/api/fetchContributions.test.ts

@@ -1,4 +1,12 @@
-import { describe, it, vi, expect, beforeEach, afterEach, Mock } from "vitest";
+import {
+  describe,
+  it,
+  vi,
+  expect,
+  beforeEach,
+  afterEach,
+  type Mock,
+} from "vitest";
 import { fetchContributions } from "./fetchContributions";
 
 describe("fetchContributions", () => {
@@ -14,8 +22,19 @@ describe("fetchContributions", () => {
 
   it("should return expected data on success", async () => {
     // Define a mock response
+    const expectedResult = {
+      extensions: [{ name: "e0", version: "1", contributes: ["panels"] }],
+      contributions: {
+        panels: [{ name: "p0", extension: "e0", layout: {} }],
+      },
+    };
     const mockResponse = {
-      json: vi.fn().mockResolvedValue({ message: "Hello, world!" }),
+      ok: true,
+      status: 200,
+      statusText: "ok",
+      json: vi.fn().mockResolvedValue({
+        result: expectedResult,
+      }),
     };
 
     // Mock fetch to resolve with the mock response
@@ -26,10 +45,52 @@ describe("fetchContributions", () => {
       serverUrl: "https://chartlets-test",
       endpointName: "api",
     });
-    const data = response.data;
 
     // Assertions
     expect(fetch).toHaveBeenCalledOnce();
-    expect(data).toEqual({ message: "Hello, world!" });
+    expect(response).toEqual({
+      status: "ok",
+      data: {
+        extensions: [{ name: "e0", version: "1", contributes: ["panels"] }],
+        contributions: {
+          panels: [
+            {
+              name: "p0",
+              extension: "e0",
+              layout: { inputs: [], outputs: [] },
+              callbacks: [],
+            },
+          ],
+        },
+      },
+    });
+  });
+
+  it("should return error for bad responses", async () => {
+    // Define a mock response
+    const mockResponse = {
+      ok: true,
+      status: 200,
+      statusText: "ok",
+      json: vi.fn().mockResolvedValue({ message: "Hello, world!" }),
+    };
+
+    // Mock fetch to resolve with the mock response
+    (globalThis.fetch as Mock).mockResolvedValue(mockResponse);
+
+    // Call fetch
+    const response = await fetchContributions({
+      serverUrl: "https://chartlets-test",
+      endpointName: "api",
+    });
+    // Assertions
+    expect(fetch).toHaveBeenCalledOnce();
+    expect(response).toEqual({
+      status: "failed",
+      error: {
+        message:
+          "unexpected response from https://chartlets-test/api/contributions",
+      },
+    });
   });
 });

chartlets.js/packages/lib/src/api/fetchLayout.test.ts

@@ -0,0 +1,82 @@
+import {
+  describe,
+  it,
+  vi,
+  expect,
+  beforeEach,
+  afterEach,
+  type Mock,
+} from "vitest";
+import { fetchLayout } from "./fetchLayout";
+
+describe("fetchLayout", () => {
+  beforeEach(() => {
+    // Mock the global fetch function
+    globalThis.fetch = vi.fn();
+  });
+
+  afterEach(() => {
+    // Restore the original fetch implementation
+    vi.restoreAllMocks();
+  });
+
+  it("should return expected data on success", async () => {
+    // Define a mock response
+    const expectedResult = {
+      type: "Button",
+      text: "Click me!",
+    };
+    const mockResponse = {
+      ok: true,
+      status: 200,
+      statusText: "ok",
+      json: vi.fn().mockResolvedValue({
+        result: expectedResult,
+      }),
+    };
+
+    // Mock fetch to resolve with the mock response
+    (globalThis.fetch as Mock).mockResolvedValue(mockResponse);
+
+    // Call fetch
+    const response = await fetchLayout("panels", 0, [], {
+      serverUrl: "https://chartlets-test",
+      endpointName: "api",
+    });
+
+    // Assertions
+    expect(fetch).toHaveBeenCalledOnce();
+    expect(response).toEqual({
+      status: "ok",
+      data: expectedResult,
+    });
+  });
+
+  it("should return error for bad responses", async () => {
+    // Define a mock response
+    const mockResponse = {
+      ok: true,
+      status: 200,
+      statusText: "ok",
+      json: vi.fn().mockResolvedValue({ message: "Hello, world!" }),
+    };
+
+    // Mock fetch to resolve with the mock response
+    (globalThis.fetch as Mock).mockResolvedValue(mockResponse);
+
+    // Call fetch
+    const response = await fetchLayout("panels", 0, [], {
+      serverUrl: "https://chartlets-test",
+      endpointName: "api",
+    });
+    // Assertions
+    expect(fetch).toHaveBeenCalledOnce();
+    expect(response).toEqual({
+      status: "failed",
+      error: {
+        message:
+          "unexpected response from https://chartlets-test/api/layout/panels/0",
+      },
+    });
+  });
+});