fix: Conditionally add ftrack-api-options (#217)

* Conditionally add api-options * Readable form * add test case
ftrackhq · Mar 7, 2024 · b9e690d · b9e690d
1 parent 911682d
commit b9e690d
Show file tree

Hide file tree

Showing 2 changed files with 30 additions and 3 deletions.
diff --git a/source/session.ts b/source/session.ts
@@ -663,9 +663,11 @@ export class Session<
             "ftrack-user": this.apiUser,
             "ftrack-Clienttoken": this.clientToken,
             "ftrack-pushtoken": pushToken,
-            "ftrack-api-options": ensureSerializableResponse
-              ? "strict:1;denormalize:1"
-              : undefined,
+            ...(ensureSerializableResponse
+              ? {
+                  "ftrack-api-options": "strict:1;denormalize:1",
+                }
+              : {}),
             ...this.additionalHeaders,
             ...additionalHeaders,
           } as HeadersInit,

diff --git a/test/session.test.ts b/test/session.test.ts
@@ -229,6 +229,31 @@ describe("Session", () => {
     return expect((await headers).get("X-Test-Header")).toEqual("test");
   });
 
+  it("Should allow api option header based on ensureSerializableResponse", async () => {
+    const headers = new Promise<Headers>((resolve) => {
+      server.use(
+        http.post(
+          "http://ftrack.test/api",
+          (info) => {
+            resolve(info.request.headers as any);
+            return HttpResponse.json(getInitialSessionQuery());
+          },
+          { once: true },
+        ),
+      );
+    });
+
+    new Session(
+      credentials.serverUrl,
+      credentials.apiUser,
+      credentials.apiKey,
+      {
+        ensureSerializableResponse: false,
+      },
+    );
+    return expect((await headers).get("ftrack-api-options")).toBeFalsy();
+  });
+
   it("Should allow creating a User", () => {
     const promise = session.create("User", {
       username: getTestUsername(),