quickbase-js 0.1.0-beta.12 → 0.1.0-beta.14

package/tests/vitest/qb/ThrottleBucket.test.ts

@@ -1,77 +0,0 @@
-// tests/vitest/qb/ThrottleBucket.test.ts
-import { describe, it, expect } from "vitest";
-import { quickbase } from "../../../src/quickbaseClient";
-
-describe("QuickbaseClient with ConcurrentThrottleBucket Integration Tests", () => {
-  it("handles concurrent API calls with burst and rate limiting in strict order", async () => {
-    const mockFetch = async (
-      url: string,
-      options: RequestInit
-    ): Promise<Response> => {
-      await new Promise((resolve) => setTimeout(resolve, 500));
-      return new Response(JSON.stringify({ id: "mock-app" }), {
-        status: 200,
-        headers: { "Content-Type": "application/json" },
-      });
-    };
-
-    const qbClient = quickbase({
-      realm: "test",
-      userToken: "mock-token",
-      throttle: { rate: 5, burst: 3 },
-      fetchApi: mockFetch,
-      debug: true,
-    });
-
-    const throttleTimes: number[] = [];
-    const startTimes: number[] = new Array(6).fill(0);
-    const completionTimes: number[] = [];
-    const recordTime = async (index: number) => {
-      const preThrottle = Date.now();
-      throttleTimes[index] = preThrottle;
-      await qbClient.getApp({
-        appId: "mock-app-id",
-        startTime: startTimes[index],
-      });
-      completionTimes[index] = Date.now();
-      startTimes[index] = startTimes[index] || Date.now() - 500;
-    };
-
-    const startTime = Date.now();
-    const promises = [];
-    for (let i = 0; i < 6; i++) {
-      promises.push(recordTime(i));
-      await new Promise((resolve) => setTimeout(resolve, 1));
-    }
-    await Promise.all(promises);
-
-    const relativeThrottleTimes = throttleTimes.map((t) => t - startTime);
-    const relativeStartTimes = startTimes.map((t) => t - startTime);
-    const durations = completionTimes.map((t) => t - startTime);
-    const timings = completionTimes.map((t, i) => t - startTimes[i]);
-
-    console.log("Relative Throttle Times:", relativeThrottleTimes);
-    console.log("Relative Start Times (post-throttle):", relativeStartTimes);
-    console.log("Durations (completion times):", durations);
-    console.log("Timings (fetch durations):", timings);
-    console.log("Total Duration:", Date.now() - startTime);
-
-    const totalDuration = Date.now() - startTime;
-    expect(totalDuration).toBeGreaterThanOrEqual(1000);
-    expect(totalDuration).toBeLessThan(1200); // Adjusted back to ~1100ms
-
-    expect(durations.length).toBe(6);
-    expect(durations.slice(0, 3).every((d) => d >= 500 && d < 550)).toBe(true);
-
-    // Sort durations to handle out-of-order completion
-    const sortedDurations = [...durations].sort((a, b) => a - b);
-    expect(sortedDurations[3]).toBeGreaterThanOrEqual(650);
-    expect(sortedDurations[3]).toBeLessThan(750);
-    expect(sortedDurations[4]).toBeGreaterThanOrEqual(850);
-    expect(sortedDurations[4]).toBeLessThan(950);
-    expect(sortedDurations[5]).toBeGreaterThanOrEqual(1050);
-    expect(sortedDurations[5]).toBeLessThan(1150);
-
-    expect(timings.every((t) => t >= 500 && t < 550)).toBe(true);
-  });
-});

package/tests/vitest/qb/apps/copyApp.test.ts

@@ -1,76 +0,0 @@
-// tests/vitest/qb/apps/copyApp.test.ts
-import { test, expect } from "vitest";
-import { quickbase } from "../../../../src/quickbaseClient";
-
-test(
-  "QuickbaseClient Integration - copyApp > creates a new copied app in QuickBase",
-  { timeout: 30000 }, // Increased to 30 seconds
-  async () => {
-    const config = {
-      realm: process.env.QB_REALM || "",
-      userToken: process.env.QB_USER_TOKEN || "",
-      debug: true,
-    };
-    const client = quickbase(config);
-    const appId = process.env.QB_APP_ID || ""; // The source app ID to copy from
-
-    const copyAppName = `CopiedApp_${Date.now()}`; // Unique name to avoid conflicts
-    const copyBody = {
-      name: copyAppName,
-      description: "Test copied app",
-      properties: {
-        keepData: false,
-        excludeFiles: true,
-        usersAndRoles: false,
-        assignUserToken: true,
-      },
-    };
-
-    console.log("Config used:", {
-      ...config,
-      userToken: config.userToken ? "[REDACTED]" : "", // Avoid logging sensitive token
-    });
-    console.log("Copying app with:", copyBody);
-    const startTime = Date.now();
-    let response;
-    try {
-      response = await client.copyApp({ appId, body: copyBody });
-      const duration = Date.now() - startTime;
-      console.log(`copyApp completed in ${duration}ms`);
-      console.log("Real API response:", response);
-
-      expect(response).toBeDefined();
-      expect(response.id).toBeDefined();
-      expect(response.name).toBe(copyAppName);
-      expect(response.description).toBe(copyBody.description);
-      expect(response.created).toBeInstanceOf(Date);
-      expect(response.updated).toBeInstanceOf(Date);
-      expect(response.dateFormat).toMatch(/^\w{2}-\w{2}-\w{4}$/); // e.g., "MM-DD-YYYY"
-      expect(typeof response.timeZone).toBe("string"); // Simplified check
-      expect(typeof response.hasEveryoneOnTheInternet).toBe("boolean");
-      expect(response.ancestorId).toBe(appId); // Should match the source app ID
-      expect(
-        response.dataClassification === undefined ||
-          typeof response.dataClassification === "string"
-      ).toBe(true); // Allow undefined or string
-      expect(
-        response.variables === undefined || Array.isArray(response.variables)
-      ).toBe(true); // Allow undefined or array
-    } catch (error) {
-      const duration = Date.now() - startTime;
-      console.error(`copyApp failed after ${duration}ms:`, error);
-      throw error; // Re-throw to fail the test
-    }
-
-    // Cleanup: Delete the copied app using deleteApp
-    const deleteStartTime = Date.now();
-    const deleteResponse = await client.deleteApp({
-      appId: response.id,
-      body: { name: copyAppName },
-    });
-    const deleteDuration = Date.now() - deleteStartTime;
-    console.log(`deleteApp completed in ${deleteDuration}ms`);
-    console.log("Cleanup - Deleted app:", deleteResponse);
-    expect(deleteResponse.deletedAppId).toBe(response.id);
-  }
-);

package/tests/vitest/qb/apps/createApp.test.ts

@@ -1,64 +0,0 @@
-// tests/vitest/qb/apps/createApp.test.ts
-import { test, expect } from "vitest";
-import { quickbase } from "../../../../src/quickbaseClient";
-
-test(
-  "QuickbaseClient Integration - createApp > creates a new app in QuickBase",
-  { timeout: 30000 },
-  async () => {
-    const config = {
-      realm: process.env.QB_REALM || "",
-      userToken: process.env.QB_USER_TOKEN || "",
-      debug: true,
-      useTempTokens: false,
-    };
-    const client = quickbase(config);
-
-    const appName = `TestApp_${Date.now()}`;
-    const createBody = {
-      name: appName,
-      description: "Test app creation",
-      assignToken: true,
-    };
-
-    console.log("Config used:", {
-      ...config,
-      userToken: config.userToken ? "[REDACTED]" : "",
-    });
-    console.log("Creating app with:", createBody);
-    const createStartTime = Date.now();
-    let response;
-    try {
-      response = await client.createApp({ body: createBody });
-      const createDuration = Date.now() - createStartTime;
-      console.log(`createApp completed in ${createDuration}ms`);
-      console.log("Real API response:", response);
-
-      expect(response).toBeDefined();
-      expect(response.id).toBeDefined();
-      expect(response.name).toBe(appName);
-      expect(response.description).toBe(createBody.description);
-      expect(response.created).toBeInstanceOf(Date);
-      expect(response.updated).toBeInstanceOf(Date);
-      expect(response.dateFormat).toMatch(/^\w{2}-\w{2}-\w{4}$/);
-      expect(typeof response.timeZone).toBe("string");
-      expect(typeof response.hasEveryoneOnTheInternet).toBe("boolean");
-      expect(
-        response.dataClassification === undefined ||
-          typeof response.dataClassification === "string"
-      ).toBe(true);
-      expect(
-        response.variables === undefined || Array.isArray(response.variables)
-      ).toBe(true);
-
-      // Cleanup: Delete the app after assertions
-      const deleteBody = { name: appName };
-      await client.deleteApp({ appId: response.id, body: deleteBody });
-      console.log("Cleanup: App deleted:", response.id);
-    } catch (error) {
-      const createDuration = Date.now() - createStartTime;
-      console.error(`createApp failed after ${createDuration}ms:`, error);
-      throw error;
-    }
-  }
-);

package/tests/vitest/qb/apps/deleteApp.test.ts

@@ -1,76 +0,0 @@
-// tests/vitest/qb/apps/deleteApp.test.ts
-import { test, expect } from "vitest";
-import { quickbase } from "../../../../src/quickbaseClient";
-
-test(
-  "QuickbaseClient Integration - deleteApp > deletes an app in QuickBase",
-  { timeout: 30000 },
-  async () => {
-    const config = {
-      realm: process.env.QB_REALM || "",
-      userToken: process.env.QB_USER_TOKEN || "",
-      debug: true,
-      useTempTokens: false,
-    };
-    const client = quickbase(config);
-
-    const appName = `TempApp_${Date.now()}`;
-    const createBody = {
-      name: appName,
-      description: "Temporary app for deleteApp test",
-      assignToken: true, // Match createApp.test.ts
-    };
-
-    console.log("Config used:", {
-      ...config,
-      userToken: config.userToken ? "[REDACTED]" : "",
-    });
-    console.log("Creating temporary app with:", createBody);
-    const createStartTime = Date.now();
-    let createResponse;
-    try {
-      createResponse = await client.createApp({ body: createBody });
-      const createDuration = Date.now() - createStartTime;
-      console.log(`createApp completed in ${createDuration}ms`);
-      console.log("Created app response:", createResponse);
-
-      expect(createResponse).toBeDefined();
-      expect(createResponse.id).toBeDefined();
-      expect(createResponse.name).toBe(appName);
-    } catch (error) {
-      const createDuration = Date.now() - createStartTime;
-      console.error(`createApp failed after ${createDuration}ms:`, error);
-      throw error;
-    }
-
-    const deleteBody = {
-      name: appName,
-    };
-    console.log("Deleting app with:", deleteBody);
-    const deleteStartTime = Date.now();
-    try {
-      const deleteResponse = await client.deleteApp({
-        appId: createResponse.id,
-        body: deleteBody,
-      });
-      const deleteDuration = Date.now() - deleteStartTime;
-      console.log(`deleteApp completed in ${deleteDuration}ms`);
-      console.log("Delete app response:", deleteResponse);
-
-      expect(deleteResponse).toBeDefined();
-      expect(deleteResponse.deletedAppId).toBe(createResponse.id);
-    } catch (error) {
-      const deleteDuration = Date.now() - deleteStartTime;
-      console.error(`deleteApp failed after ${deleteDuration}ms:`, error);
-      if (error instanceof Error && "response" in error) {
-        try {
-          const errorBody = await (error as any).response.json();
-          console.error("Full deleteApp error response:", errorBody);
-        } catch (e) {
-          console.error("Could not parse error response:", e);
-        }
-      }
-      throw error;
-    }
-  }
-);

package/tests/vitest/qb/apps/getApp.test.ts

@@ -1,44 +0,0 @@
-// tests/vitest/qb/apps/getApp.test.ts
-import { test, expect } from "vitest";
-import { quickbase } from "../../../../src/quickbaseClient";
-
-test(
-  "QuickbaseClient Integration - getApp > fetches real app data from QuickBase",
-  { timeout: 10000 },
-  async () => {
-    const config = {
-      realm: process.env.QB_REALM || "",
-      userToken: process.env.QB_USER_TOKEN || "",
-      debug: true,
-    };
-    const client = quickbase(config);
-    const getAppId = "buwai2zpe";
-
-    console.log("Config used:", config);
-    const result = await client.getApp({ appId: getAppId });
-    console.log("Real API response:", result);
-
-    expect(result).toEqual({
-      id: getAppId,
-      name: "qb-copy",
-      created: expect.any(Date),
-      updated: expect.any(Date),
-      description: "",
-      timeZone: "(UTC-08:00) Pacific Time (US & Canada)",
-      dateFormat: "MM-DD-YYYY",
-      hasEveryoneOnTheInternet: false,
-      memoryInfo: { estMemory: 0, estMemoryInclDependentApps: 0 },
-      securityProperties: {
-        allowClone: false,
-        allowExport: true,
-        enableAppTokens: true,
-        hideFromPublic: false,
-        mustBeRealmApproved: false,
-        useIPFilter: false,
-      },
-      ancestorId: undefined,
-      dataClassification: undefined,
-      variables: [{ name: "TestVar", value: "TestValue" }],
-    });
-  }
-);

package/tests/vitest/qb/apps/getAppEvents.test.ts

@@ -1,67 +0,0 @@
-import { test, expect } from "vitest";
-import { quickbase } from "../../../../src/quickbaseClient";
-
-test(
-  "QuickbaseClient Integration - getAppEvents > fetches real app events from QuickBase",
-  { timeout: 10000 },
-  async () => {
-    const config = {
-      realm: process.env.QB_REALM || "",
-      userToken: process.env.QB_USER_TOKEN || "",
-      debug: true,
-    };
-    const client = quickbase(config);
-    const appId = "buwai2zpe"; // Same app ID as getApp test
-
-    console.log("Config used:", config);
-    const result = await client.getAppEvents({ appId });
-    console.log("Real API response:", result);
-
-    // Validate the response is an array of events
-    expect(result).toBeInstanceOf(Array);
-
-    // Check that each event has the required properties
-    result.forEach((event) => {
-      expect(event).toHaveProperty("type");
-      expect([
-        "qb-action",
-        "webhook",
-        "email-notification",
-        "subscription",
-        "reminder",
-        "automation",
-      ]).toContain(event.type);
-
-      expect(event).toHaveProperty("owner");
-      expect(event.owner).toHaveProperty("email");
-      expect(typeof event.owner.email).toBe("string");
-      expect(event.owner).toHaveProperty("id");
-      expect(typeof event.owner.id).toBe("string");
-      expect(event.owner).toHaveProperty("name");
-      expect(typeof event.owner.name).toBe("string");
-      // userName is optional, so we don't enforce it
-
-      expect(event).toHaveProperty("isActive");
-      expect(typeof event.isActive).toBe("boolean");
-
-      expect(event).toHaveProperty("tableId");
-      expect(typeof event.tableId).toBe("string");
-
-      // Name is present for all types except automation
-      if (event.type !== "automation") {
-        expect(event).toHaveProperty("name");
-        expect(typeof event.name).toBe("string");
-      } else {
-        expect(event.name).toBeUndefined();
-      }
-
-      // URL is only present for automation
-      if (event.type === "automation") {
-        expect(event).toHaveProperty("url");
-        expect(typeof event.url).toBe("string");
-      } else {
-        expect(event.url).toBeUndefined();
-      }
-    });
-  }
-);

package/tests/vitest/qb/apps/updateApp.test.ts

@@ -1,58 +0,0 @@
-import { test, expect } from "vitest";
-import { quickbase } from "../../../../src/quickbaseClient";
-
-test(
-  "QuickbaseClient Integration - updateApp > updates real app data in QuickBase",
-  { timeout: 10000 },
-  async () => {
-    const config = {
-      realm: process.env.QB_REALM || "",
-      userToken: process.env.QB_USER_TOKEN || "",
-      debug: true,
-    };
-    const client = quickbase(config);
-    const appId = "buwai2zpe"; // Same app ID as before
-
-    // Original app data (to restore later if needed)
-    const originalApp = await client.getApp({ appId });
-    console.log("Original app data:", originalApp);
-
-    // Update request
-    const updateRequest = {
-      name: "qb-copy-updated",
-      description: "Updated via integration test",
-      variables: [{ name: "TestVar", value: "TestValue" }],
-    };
-
-    console.log("Config used:", config);
-    console.log("Update request:", updateRequest);
-    const result = await client.updateApp({ appId, body: updateRequest });
-    console.log("Real API response:", result);
-
-    // Validate the response
-    expect(result).toHaveProperty("id", appId);
-    expect(result).toHaveProperty("name", "qb-copy-updated");
-    expect(result).toHaveProperty(
-      "description",
-      "Updated via integration test"
-    );
-    expect(result).toHaveProperty("variables");
-    expect(result.variables).toContainEqual({
-      name: "TestVar",
-      value: "TestValue",
-    });
-    expect(result).toHaveProperty("created");
-    expect(result.created).toBeInstanceOf(Date);
-    expect(result).toHaveProperty("updated");
-    expect(result.updated).toBeInstanceOf(Date);
-
-    // Optional: Restore original name to avoid permanent changes
-    const restoreRequest = {
-      name: originalApp.name,
-      description: originalApp.description,
-      variables: originalApp.variables,
-    };
-    await client.updateApp({ appId, body: restoreRequest });
-    console.log("Restored app to:", originalApp.name);
-  }
-);

package/tests/vitest/qb/auth/mockQuickbaseServer.ts

@@ -1,60 +0,0 @@
-// tests/vitest/qb/auth/mockQuickbaseServer.ts
-import express from "express";
-
-export function startMockQuickbaseServer(port: number = 3000) {
-  const app = express();
-  app.use(express.json());
-  let failNextCall = false;
-
-  app.post("/v1/auth/oauth/token", (req, res) => {
-    const { subject_token } = req.body;
-    console.log("[Mock Server] Received SSO token request:", req.body);
-    if (!subject_token) {
-      return res.status(400).json({ message: "Missing SAML token" });
-    }
-    res.json({
-      access_token: "mock-temp-token",
-      token_type: "Bearer",
-    });
-  });
-
-  app.get("/v1/apps/:appId", (req, res) => {
-    const authHeader = req.headers.authorization;
-    console.log(
-      "[Mock Server] Received getApp request:",
-      req.params,
-      "Auth:",
-      authHeader
-    );
-    if (!authHeader || !authHeader.startsWith("QB-TEMP-TOKEN")) {
-      return res.status(401).json({ message: "Unauthorized" });
-    }
-    if (failNextCall) {
-      failNextCall = false;
-      return res.status(401).json({ message: "Token expired" });
-    }
-    res.json({
-      id: req.params.appId,
-      name: "Mock App",
-      created: "2025-03-19T12:00:00Z",
-      updated: "2025-03-19T12:00:00Z",
-    });
-  });
-
-  app.post("/mock/toggle-fail", (req, res) => {
-    failNextCall = true;
-    console.log("[Mock Server] Toggling next getApp call to fail with 401");
-    res.sendStatus(200);
-  });
-
-  const server = app.listen(port, () => {
-    console.log(`Mock QuickBase server running on port ${port}`);
-  });
-
-  return {
-    server,
-    close: () => server.close(),
-    toggleFail: () =>
-      fetch(`http://localhost:${port}/mock/toggle-fail`, { method: "POST" }),
-  };
-}

package/tests/vitest/qb/auth/retryUserToken401.test.ts

@@ -1,73 +0,0 @@
-import { describe, it, vi, expect, beforeEach } from "vitest";
-import { quickbase, QuickbaseClient } from "../../../../src/quickbaseClient";
-
-describe("QuickbaseClient Integration - User Token Retry on 401", () => {
-  let client: QuickbaseClient;
-
-  beforeEach(() => {
-    const userToken = process.env.QB_USER_TOKEN;
-    const realm = process.env.QB_REALM;
-    const tableId = process.env.QB_TABLE_ID_1; // Consistent env var name
-
-    if (!userToken) {
-      throw new Error(
-        "QB_USER_TOKEN environment variable is required for integration test"
-      );
-    }
-    if (!tableId) {
-      throw new Error(
-        "QB_TABLE_ID_1 environment variable is required for integration test"
-      );
-    }
-
-    const config = {
-      realm,
-      userToken,
-      debug: true,
-    };
-    console.log("[quickbaseTest] Config:", {
-      realm,
-      userToken: userToken.substring(0, 10) + "...",
-      tableId, // Log to confirm
-      debug: true,
-    });
-    client = quickbase(config);
-  });
-
-  it(
-    "successfully retrieves fields with user token, retrying on transient 401 if needed",
-    async () => {
-      const consoleSpy = vi.spyOn(console, "log");
-
-      const tableId = process.env.QB_TABLE_ID_1!; // Match beforeEach
-      let fields;
-      try {
-        fields = await client.getFields({ tableId });
-      } catch (error) {
-        console.error("[integrationTest] Failed to retrieve fields:", error);
-        throw error;
-      }
-
-      expect(fields).toBeInstanceOf(Array);
-      expect(fields.length).toBeGreaterThan(0);
-      expect(fields[0]).toHaveProperty("id");
-      expect(fields[0]).toHaveProperty("label");
-
-      console.log("[integrationTest] Fields retrieved:", fields.length);
-
-      const retryLog = consoleSpy.mock.calls.some((call) =>
-        call[0].includes("Retrying getFields with existing user token")
-      );
-      if (retryLog) {
-        console.log("[integrationTest] Retry on 401 detected");
-      } else {
-        console.log(
-          "[integrationTest] No 401 retries observed (expected if no transient failure)"
-        );
-      }
-
-      consoleSpy.mockRestore();
-    },
-    { timeout: 10000 }
-  );
-});

package/tests/vitest/qb/auth/ssoTokenConcurrency.test.ts

@@ -1,68 +0,0 @@
-// tests/vitest/qb/auth/ssoTokenConcurrency.test.ts
-import { test, expect, vi } from "vitest";
-import { quickbase } from "../../../../src/quickbaseClient";
-import { startMockQuickbaseServer } from "./mockQuickbaseServer";
-import { QB_APP_ID, QB_REALM } from "@tests/setup.ts";
-
-test(
-  "QuickbaseClient Integration - getApp with SsoTokenStrategy Concurrency",
-  async () => {
-    const mockServer = startMockQuickbaseServer(3000);
-
-    // Spy on console.log before any actions
-    const consoleSpy = vi.spyOn(console, "log");
-
-    try {
-      const client = quickbase({
-        realm: QB_REALM,
-        useSso: true,
-        samlToken: "mock-saml-token",
-        debug: true,
-        baseUrl: "http://localhost:3000/v1",
-      });
-
-      const concurrentRequests = [
-        client.getApp({ appId: QB_APP_ID }),
-        client.getApp({ appId: QB_APP_ID }),
-        client.getApp({ appId: QB_APP_ID }),
-      ];
-
-      const results = await Promise.all(concurrentRequests);
-
-      expect(results).toHaveLength(3);
-      results.forEach((result) =>
-        expect(result).toEqual({
-          id: QB_APP_ID,
-          name: "Mock App",
-          created: expect.any(Date),
-          updated: expect.any(Date),
-        })
-      );
-
-      // Verify token fetch and waits using console logs
-      const logs = consoleSpy.mock.calls;
-      const tokenFetchLogs = logs.filter((call) =>
-        call[0].includes("[fetchSsoToken] Fetched token")
-      );
-      expect(tokenFetchLogs).toHaveLength(1); // Single fetch with synchronization
-
-      const waitLogs = logs.filter((call) =>
-        call[0].includes("Waiting for existing SSO fetch")
-      );
-      expect(waitLogs.length).toBeGreaterThanOrEqual(2); // At least two waits
-
-      const appRequestLogs = logs.filter((call) =>
-        call[0].includes("Received getApp request")
-      );
-      expect(appRequestLogs).toHaveLength(3);
-
-      console.log(
-        "SsoTokenStrategy: Single token fetch with concurrent waits confirmed."
-      );
-    } finally {
-      mockServer.close();
-      consoleSpy.mockRestore();
-    }
-  },
-  { timeout: 20000 }
-);