quickbase-js 0.1.0-beta.10 → 0.1.0-beta.11

package/examples/quicbase-jsCDN.html

@@ -17,12 +17,12 @@
         if (typeof QuickbaseJS === "undefined") {
             document.getElementById("result").textContent = "Error: Failed to load QuickbaseJS library.";
         } else {
-            var qbClient = QuickbaseJS.quickbase({
+            var qb = QuickbaseJS.quickbase({
                 realm,
                 useTempTokens: true
             });
 
-            qbClient.getApp({ appId })
+            qb.getApp({ appId })
                 .then(function (app) {
                     document.getElementById("result").textContent = "App Name: " + app.name;
                 })

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "quickbase-js",
-  "version": "0.1.0-beta.10",
+  "version": "0.1.0-beta.11",
   "description": "QuickBase JavaScript client for frameworks and vanilla JS",
   "type": "module",
   "main": "dist/esm/quickbase.js",

package/src/authorizationStrategy.ts

@@ -1,5 +1,4 @@
 // src/authorizationStrategy.ts
-
 import { TokenCache } from "./tokenCache";
 
 export interface AuthorizationStrategy {
@@ -15,9 +14,9 @@ export interface AuthorizationStrategy {
   ): Promise<string | null>;
 }
 
-// src/authorizationStrategy.ts (partial update)
-
 export class TempTokenStrategy implements AuthorizationStrategy {
+  private pendingFetches: Map<string, Promise<string>> = new Map();
+
   constructor(
     private tokenCache: TokenCache,
     private initialTempToken: string | undefined,
@@ -61,7 +60,15 @@ export class TempTokenStrategy implements AuthorizationStrategy {
   async getToken(dbid: string): Promise<string | undefined> {
     let token = this.tokenCache.get(dbid) || this.initialTempToken;
     if (!token && dbid) {
-      token = await this.fetchTempToken(dbid);
+      if (this.pendingFetches.has(dbid)) {
+        console.log(`[getToken] Waiting for existing fetch for dbid: ${dbid}`);
+        return this.pendingFetches.get(dbid);
+      }
+      const fetchPromise = this.fetchTempToken(dbid).finally(() =>
+        this.pendingFetches.delete(dbid)
+      );
+      this.pendingFetches.set(dbid, fetchPromise);
+      token = await fetchPromise;
     }
     return token;
   }
@@ -96,14 +103,31 @@ export class TempTokenStrategy implements AuthorizationStrategy {
       return null;
     }
     if (debug) console.log(`Refreshing temp token for dbid: ${dbid}`);
-    const newToken = await this.fetchTempToken(dbid);
-    this.tokenCache.set(dbid, newToken);
-    return newToken;
+    // Invalidate the cache for this dbid to force a fresh fetch
+    this.tokenCache.delete(dbid);
+    try {
+      const newToken = await this.getToken(dbid);
+      if (newToken) {
+        this.tokenCache.set(dbid, newToken);
+        return newToken;
+      }
+      return null;
+    } catch (error) {
+      if (debug)
+        console.log(
+          `[${methodName || "method"}] Failed to refresh token:`,
+          error
+        );
+      throw error;
+    }
   }
 }
 
 export class UserTokenStrategy implements AuthorizationStrategy {
-  constructor(private userToken: string) {}
+  constructor(
+    private userToken: string,
+    private baseUrl: string = "https://api.quickbase.com/v1"
+  ) {}
 
   async getToken(_dbid: string): Promise<string> {
     return this.userToken;
@@ -134,23 +158,32 @@ export class UserTokenStrategy implements AuthorizationStrategy {
 
 export class SsoTokenStrategy implements AuthorizationStrategy {
   private currentToken: string | undefined;
+  private pendingFetches: Map<string, Promise<string>> = new Map();
 
   constructor(
     private samlToken: string,
     private realm: string,
     private fetchApi: typeof fetch,
-    private debug: boolean = false
+    private debug: boolean = false,
+    private baseUrl: string = "https://api.quickbase.com/v1"
   ) {}
 
   async getToken(_dbid: string): Promise<string | undefined> {
     if (!this.currentToken) {
-      this.currentToken = await this.fetchSsoToken({
+      if (this.pendingFetches.has("sso")) {
+        if (this.debug)
+          console.log("[getToken] Waiting for existing SSO fetch");
+        return this.pendingFetches.get("sso");
+      }
+      const fetchPromise = this.fetchSsoToken({
         grant_type: "urn:ietf:params:oauth:grant-type:token-exchange",
         requested_token_type:
           "urn:quickbase:params:oauth:token-type:temp_token",
         subject_token: this.samlToken,
         subject_token_type: "urn:ietf:params:oauth:token-type:saml2",
-      });
+      }).finally(() => this.pendingFetches.delete("sso"));
+      this.pendingFetches.set("sso", fetchPromise);
+      this.currentToken = await fetchPromise;
     }
     return this.currentToken;
   }
@@ -193,18 +226,15 @@ export class SsoTokenStrategy implements AuthorizationStrategy {
       subject_token_type: "urn:ietf:params:oauth:token-type:saml2",
     };
 
-    const response = await this.fetchApi(
-      `https://api.quickbase.com/v1/auth/oauth/token`,
-      {
-        method: "POST",
-        headers: {
-          "QB-Realm-Hostname": `${this.realm}.quickbase.com`,
-          "Content-Type": "application/json",
-        },
-        body: JSON.stringify(payload),
-        credentials: "omit",
-      }
-    );
+    const response = await this.fetchApi(`${this.baseUrl}/auth/oauth/token`, {
+      method: "POST",
+      headers: {
+        "QB-Realm-Hostname": `${this.realm}.quickbase.com`,
+        "Content-Type": "application/json",
+      },
+      body: JSON.stringify(payload),
+      credentials: "omit",
+    });
 
     if (!response.ok) {
       const errorBody = await response.json().catch(() => ({}));
@@ -234,18 +264,15 @@ export class SsoTokenStrategy implements AuthorizationStrategy {
     subject_token: string;
     subject_token_type: string;
   }): Promise<string> {
-    const response = await this.fetchApi(
-      `https://api.quickbase.com/v1/auth/oauth/token`,
-      {
-        method: "POST",
-        headers: {
-          "QB-Realm-Hostname": `${this.realm}.quickbase.com`,
-          "Content-Type": "application/json",
-        },
-        body: JSON.stringify(params),
-        credentials: "omit",
-      }
-    );
+    const response = await this.fetchApi(`${this.baseUrl}/auth/oauth/token`, {
+      method: "POST",
+      headers: {
+        "QB-Realm-Hostname": `${this.realm}.quickbase.com`,
+        "Content-Type": "application/json",
+      },
+      body: JSON.stringify(params),
+      credentials: "omit",
+    });
 
     if (!response.ok) {
       const errorBody = await response.json().catch(() => ({}));

package/src/generated-unified/QuickbaseClient.ts

@@ -1,4 +1,4 @@
-// Generated on 2025-03-22T03:57:10.682Z
+// Generated on 2025-03-23T19:11:12.725Z
 import { AddManagersToGroup200Response, AddManagersToGroupRequest, AddMembersToGroup200Response, AddMembersToGroupRequest, AddSubgroupsToGroup200Response, AddSubgroupsToGroupRequest, Audit200Response, ChangesetSolution200Response, ChangesetSolutionFromRecord200Response, CloneUserToken200Response, CopyApp200Response, CopyAppRequest, CreateApp200Response, CreateAppRequest, CreateField200Response, CreateFieldRequest, CreateRelationship200Response, CreateRelationshipRequest, CreateSolution200Response, CreateSolutionFromRecord200Response, CreateTable200Response, CreateTableRequest, DeactivateUserToken200Response, DeleteApp200Response, DeleteAppRequest, DeleteFields200Response, DeleteFieldsRequest, DeleteFile200Response, DeleteRecords200Response, DeleteRecordsRequest, DeleteRelationship200Response, DeleteTable200Response, DeleteUserToken200Response, DenyUsers200Response, DenyUsersAndGroups200Response, DenyUsersAndGroupsRequest, DenyUsersRequest, DownloadFile200Response, ExchangeSsoToken200Response, ExportSolution200Response, ExportSolutionToRecord200Response, GenerateDocument200Response, GetApp200Response, GetAppEvents200Response, GetAppTables200Response, GetField200Response, GetFieldUsage200Response, GetFields200Response, GetFieldsUsage200Response, GetRelationships200Response, GetReport200Response, GetTable200Response, GetTableReports200Response, GetTempTokenDBID200Response, GetUsers200Response, GetUsersRequest, PlatformAnalyticEventSummaries200Response, PlatformAnalyticReads200Response, RemoveManagersFromGroup200Response, RemoveManagersFromGroupRequest, RemoveMembersFromGroup200Response, RemoveMembersFromGroupRequest, RemoveSubgroupsFromGroup200Response, RemoveSubgroupsFromGroupRequest, RunFormula200Response, RunQuery200Response, RunQueryRequest, RunReport200Response, TransferUserToken200Response, UndenyUsers200Response, UndenyUsersRequest, UpdateApp200Response, UpdateAppRequest, UpdateField200Response, UpdateFieldRequest, UpdateRelationship200Response, UpdateRelationshipRequest, UpdateSolution200Response, UpdateSolutionToRecord200Response, UpdateTable200Response, UpdateTableRequest, Upsert200Response, Upsert207Response, UpsertRequest } from "../generated/models";
 
 export interface QuickbaseClient {

package/src/invokeMethod.ts

@@ -1,5 +1,4 @@
 // src/invokeMethod.ts
-
 import { AuthorizationStrategy, extractDbid } from "./authorizationStrategy";
 import { RateLimiter } from "./rateLimiter";
 import { RateLimitError } from "./RateLimitError";
@@ -31,10 +30,10 @@ export async function invokeMethod<K extends keyof QuickbaseClient>(
   rateLimiter: RateLimiter,
   transformDates: (obj: any, convertStringsToDates: boolean) => any,
   debug: boolean | undefined,
-  convertDates: boolean
+  convertDates: boolean,
+  attempt: number = 0,
+  maxAttempts: number = rateLimiter.maxRetries + 1
 ): Promise<ReturnType<QuickbaseClient[K]>> {
-  console.log("[invokeMethod] Starting for method:", methodName);
-
   const methodInfo = methodMap[methodName];
   if (!methodInfo) throw new Error(`Method ${methodName} not found`);
 
@@ -56,42 +55,27 @@ export async function invokeMethod<K extends keyof QuickbaseClient>(
   };
 
   let dbid: string | undefined = extractDbid(params);
-  console.log("[invokeMethod] Extracted dbid:", dbid);
-
   let token = dbid
     ? await authStrategy.getToken(dbid)
     : await authStrategy.getToken("");
-  console.log("[invokeMethod] Initial token:", token);
 
   if (token) {
     authStrategy.applyHeaders(baseHeaders, token);
     requestOptions.headers = { ...baseHeaders };
-    console.log(
-      "[invokeMethod] Token found, headers set:",
-      requestOptions.headers
-    );
     if (methodName === "getTempTokenDBID") {
-      console.log("[invokeMethod] Using cached token:", token);
       return { temporaryAuthorization: token } as ReturnType<
         QuickbaseClient[K]
       >;
     }
   }
 
-  if (debug) {
-    console.log(`[${methodName}] requestParameters:`, requestParameters);
-    console.log(`[${methodName}] requestOptions:`, requestOptions);
-  }
-
   async function processResponse(
     rawResponse: any
   ): Promise<ReturnType<QuickbaseClient[K]>> {
-    if (debug) console.log(`[${methodName}] rawResponse:`, rawResponse);
     if (rawResponse instanceof Response) {
       const contentType = rawResponse.headers
         .get("Content-Type")
         ?.toLowerCase();
-      if (debug) console.log(`[${methodName}] contentType:`, contentType);
       if (contentType?.includes("application/json")) {
         const jsonResponse = await rawResponse.json();
         return transformDates(jsonResponse, convertDates) as ReturnType<
@@ -102,8 +86,6 @@ export async function invokeMethod<K extends keyof QuickbaseClient>(
     }
     if (rawResponse && typeof rawResponse.value === "function") {
       const response = await rawResponse.value();
-      if (debug)
-        console.log(`[${methodName}] Resolved JSONApiResponse:`, response);
       return transformDates(response, convertDates) as ReturnType<
         QuickbaseClient[K]
       >;
@@ -140,36 +122,20 @@ export async function invokeMethod<K extends keyof QuickbaseClient>(
         message = (await response.text()) || message;
       }
     } catch (e) {
-      if (debug) console.log(`[${methodName}] Error parsing response body:`, e);
       message = "Failed to parse error response";
     }
-    if (debug)
-      console.log(
-        "[invokeMethod] Parsed error - status:",
-        status,
-        "message:",
-        message
-      );
     return { message, status };
   }
 
-  let attempt = 0;
-  const maxAttempts = rateLimiter.maxRetries + 1;
-
   while (attempt < maxAttempts) {
-    console.log("[invokeMethod] Attempt:", attempt + 1, "of", maxAttempts);
     try {
       await rateLimiter.throttle();
-      console.log("[invokeMethod] About to call API for method:", methodName);
       const response = await methodInfo.method(
         requestParameters,
         requestOptions
       );
-      console.log("[invokeMethod] API call completed for method:", methodName);
       return await processResponse(response);
     } catch (error: unknown) {
-      if (debug) console.log("[invokeMethod] Caught error:", error);
-
       let status: number;
       let message: string;
       let response: Response | undefined;
@@ -181,29 +147,14 @@ export async function invokeMethod<K extends keyof QuickbaseClient>(
         response = error;
         ({ message, status } = await parseErrorResponse(response));
       } else {
-        if (debug) console.log(`[${methodName}] Unexpected error:`, error);
-        // Attempt to handle as a fetch error with a response
-        if (error instanceof Error && "response" in error) {
-          response = (error as any).response;
-          if (response instanceof Response) {
-            ({ message, status } = await parseErrorResponse(response));
-          } else {
-            throw error; // Rethrow if no response
-          }
-        } else {
-          throw error; // Rethrow truly unexpected errors
-        }
+        throw error; // Rethrow truly unexpected errors
       }
 
-      if (debug)
-        console.log("[invokeMethod] Handling error with status:", status);
-
       if (status === 429) {
         if (!(error instanceof ResponseError)) {
           throw new Error("Expected ResponseError for 429 handling");
         }
         const delay = await rateLimiter.handle429(error, attempt + 1);
-        if (debug) console.log(`[${methodName}] 429 delay: ${delay}ms`);
         if (attempt + 1 === maxAttempts) {
           throw new RateLimitError(
             `API Error: ${message} (Status: ${status})`,
@@ -218,26 +169,35 @@ export async function invokeMethod<K extends keyof QuickbaseClient>(
         continue;
       }
 
-      const newToken = await authStrategy.handleError(
-        status,
-        params,
-        attempt,
-        maxAttempts,
-        debug,
-        methodName
-      );
-      if (newToken) {
+      // Handle authentication errors
+      let newToken: string | null;
+      try {
+        newToken = await authStrategy.handleError(
+          status,
+          params,
+          attempt,
+          maxAttempts,
+          debug,
+          methodName
+        );
+      } catch (authError) {
+        throw authError; // Propagate the fetchTempToken error and exit immediately
+      }
+
+      // Only proceed with retry if we have a valid new token
+      if (newToken !== null) {
         token = newToken;
         authStrategy.applyHeaders(baseHeaders, token);
         requestOptions.headers = { ...baseHeaders };
-        attempt++;
         if (debug)
           console.log(
             `[${methodName}] Retrying with token: ${token.substring(0, 10)}...`
           );
+        attempt++;
         continue;
       }
 
+      // If no new token was provided, throw the original error
       throw new Error(`API Error: ${message} (Status: ${status})`);
     }
   }

package/src/quickbaseClient.ts

@@ -1,5 +1,4 @@
 // src/quickbaseClient.ts
-
 import { QuickbaseClient as IQuickbaseClient } from "./generated-unified/QuickbaseClient";
 import { Configuration, HTTPHeaders } from "./generated/runtime";
 import * as apis from "./generated/apis";
@@ -9,7 +8,7 @@ import {
   getParamNames,
   transformDates,
   extractHttpMethod,
-} from "./utils"; // Updated import
+} from "./utils";
 import { invokeMethod, MethodInfo } from "./invokeMethod";
 import {
   TempTokenStrategy,
@@ -82,7 +81,13 @@ export function quickbase(config: QuickbaseConfig): QuickbaseClient {
   }
 
   const authStrategy: AuthorizationStrategy = useSso
-    ? new SsoTokenStrategy(samlToken || "", realm, effectiveFetch, debug)
+    ? new SsoTokenStrategy(
+        samlToken || "",
+        realm,
+        effectiveFetch,
+        debug,
+        baseUrl
+      )
     : useTempTokens
     ? new TempTokenStrategy(
         tokenCache,
@@ -91,7 +96,7 @@ export function quickbase(config: QuickbaseConfig): QuickbaseClient {
         realm,
         baseUrl
       )
-    : new UserTokenStrategy(userToken || "");
+    : new UserTokenStrategy(userToken || "", baseUrl);
 
   const baseHeaders: HTTPHeaders = {
     "QB-Realm-Hostname": `${realm}.quickbase.com`,

package/src/tokenCache.ts

@@ -29,6 +29,10 @@ export class TokenCache {
     });
   }
 
+  delete(dbid: string): void {
+    this.cache.delete(dbid);
+  }
+
   clear(): void {
     this.cache.clear();
   }

package/tests/playwright/qb/auth/getAppWithTempTokenConcurrency.test.ts

@@ -0,0 +1,208 @@
+// tests/playwright/qb/auth/getAppWithTempTokenConcurrency.test.ts
+import { test, expect } from "@playwright/test";
+import { quickbase } from "../../../../src/quickbaseClient.ts"; // Keep .ts for now
+import dotenv from "dotenv";
+
+dotenv.config();
+
+const loginToQuickbase = async (
+  page: import("@playwright/test").Page,
+  quickbaseUrl: string,
+  username: string,
+  password: string
+): Promise<boolean> => {
+  let loginSuccess = false;
+  const maxLoginAttempts = 3;
+  let loginAttempt = 0;
+
+  while (!loginSuccess && loginAttempt < maxLoginAttempts) {
+    try {
+      loginAttempt++;
+      if (loginAttempt > 1) console.log(`Login attempt ${loginAttempt}`);
+
+      await page.goto(quickbaseUrl, { timeout: 60000 });
+      await page.waitForSelector("input[name='loginid']", { timeout: 60000 });
+      await page.fill("input[name='loginid']", username);
+      await page.fill("input[name='password']", password);
+      await page.click("#signin");
+      await page.waitForURL(`https://*.quickbase.com/**`, {
+        waitUntil: "networkidle",
+        timeout: 60000,
+      });
+
+      const loginError = await page.$(".login-error");
+      if (loginError) {
+        throw new Error("Login failed. Please check your credentials.");
+      }
+
+      console.log("Signed In to QuickBase.");
+      loginSuccess = true;
+    } catch (error) {
+      console.error(
+        `Login attempt ${loginAttempt} failed: ${(error as Error).message}`
+      );
+      if (loginAttempt >= maxLoginAttempts) {
+        console.error("Max login attempts reached. Exiting.");
+        await page.context().browser()!.close();
+        return false;
+      }
+      await new Promise((resolve) => setTimeout(resolve, 5000));
+    }
+  }
+  return loginSuccess;
+};
+
+test.describe("QuickbaseClient Integration - getApp with Temporary Token Concurrency", () => {
+  test("handles concurrent getApp requests with a single token fetch", async ({
+    page,
+  }) => {
+    const realm = process.env.QB_REALM;
+    const appId = process.env.QB_APP_ID;
+    const username = process.env.QB_USERNAME;
+    const password = process.env.QB_PASSWORD;
+
+    if (!realm) throw new Error("QB_REALM is not defined in .env");
+    if (!appId) throw new Error("QB_APP_ID is not defined in .env");
+    if (!username) throw new Error("QB_USERNAME is not defined in .env");
+    if (!password) throw new Error("QB_PASSWORD is not defined in .env");
+
+    const fetchInits: { url: string; init: RequestInit }[] = [];
+
+    const quickbaseUrl = `https://${realm}.quickbase.com/db/main?a=SignIn`;
+    const loginSuccess = await loginToQuickbase(
+      page,
+      quickbaseUrl,
+      username,
+      password
+    );
+    if (!loginSuccess) {
+      throw new Error("Failed to log in to QuickBase after max attempts.");
+    }
+
+    await page.goto(`https://${realm}.quickbase.com/db/${appId}`, {
+      waitUntil: "networkidle",
+      timeout: 60000,
+    });
+
+    const client = quickbase({
+      realm,
+      useTempTokens: true,
+      debug: true, // Enable debug logs to verify concurrency behavior
+      fetchApi: async (url: RequestInfo | URL, init?: RequestInit) => {
+        const effectiveInit = init || {};
+        fetchInits.push({ url: String(url), init: effectiveInit });
+        const response = await page.evaluate(
+          async (args: [string, RequestInit]) => {
+            const [fetchUrl, fetchInit] = args;
+            const res = await fetch(fetchUrl, fetchInit);
+            const body = await res.text();
+            const headersObj: Record<string, string> = {};
+            res.headers.forEach((value, key) => {
+              headersObj[key] = value;
+            });
+            return {
+              ok: res.ok,
+              status: res.status,
+              statusText: res.statusText,
+              headers: headersObj,
+              body,
+            };
+          },
+          [String(url), effectiveInit] as [string, RequestInit]
+        );
+
+        const fetchResponse = new Response(response.body || null, {
+          status: response.status,
+          statusText: response.statusText,
+          headers: new Headers(response.headers),
+        });
+
+        fetchResponse.json = async () => {
+          if (!response.body) {
+            throw new Error("Empty response body from API");
+          }
+          try {
+            return JSON.parse(response.body);
+          } catch (e) {
+            throw new SyntaxError(`Invalid JSON response: ${response.body}`);
+          }
+        };
+
+        return fetchResponse;
+      },
+    });
+
+    // Make three concurrent getApp requests
+    const concurrentRequests = [
+      client.getApp({ appId }),
+      client.getApp({ appId }),
+      client.getApp({ appId }),
+    ];
+
+    // Wait for all responses to complete
+    await Promise.all([
+      page.waitForResponse(`https://api.quickbase.com/v1/apps/${appId}`, {
+        timeout: 30000,
+      }),
+      page.waitForResponse(`https://api.quickbase.com/v1/apps/${appId}`, {
+        timeout: 30000,
+      }),
+      page.waitForResponse(`https://api.quickbase.com/v1/apps/${appId}`, {
+        timeout: 30000,
+      }),
+    ]);
+
+    const results = await Promise.all(concurrentRequests);
+
+    // Expected app data (based on your previous test)
+    const expectedAppData = {
+      id: appId,
+      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" }],
+    };
+
+    // Assert all results match the expected data
+    expect(results).toHaveLength(3);
+    results.forEach((result) => {
+      expect(result).toEqual(expectedAppData);
+    });
+
+    // Verify token fetch behavior
+    const tokenFetchInits = fetchInits.filter((entry) =>
+      entry.url.includes(`/auth/temporary/${appId}`)
+    );
+    expect(tokenFetchInits).toHaveLength(1); // Only one token fetch should occur
+    expect(tokenFetchInits[0].init.credentials).toBe("include");
+
+    const appFetchInits = fetchInits.filter((entry) =>
+      entry.url.includes(`/apps/${appId}`)
+    );
+    expect(appFetchInits).toHaveLength(3); // Three getApp requests
+    appFetchInits.forEach((init) => {
+      expect(init.init.credentials).toBe("omit");
+      expect(init.init.headers).toHaveProperty("Authorization");
+      expect(
+        (init.init.headers as Record<string, string>)["Authorization"]
+      ).toMatch(/^QB-TEMP-TOKEN .+$/);
+    });
+
+    console.log("Test completed. Check debug logs for concurrency details.");
+  });
+});