patch(js): utf-8 encode multipart parts

js/package.json

@@ -1,6 +1,6 @@
 {
   "name": "langsmith",
-  "version": "0.3.4",
+  "version": "0.3.5",
   "description": "Client library to connect to the LangSmith LLM Tracing and Evaluation Platform.",
   "packageManager": "yarn@1.22.19",
   "files": [

js/src/client.ts

@@ -67,7 +67,7 @@
 import { raiseForStatus } from "./utils/error.js";
 import { _getFetchImplementation } from "./singletons/fetch.js";
 
-import { stringify as stringifyForTracing } from "./utils/fast-safe-stringify/index.js";
+import { serialize as serializePayloadForTracing } from "./utils/fast-safe-stringify/index.js";
 
 export interface ClientConfig {
   apiUrl?: string;
@@ -405,7 +405,7 @@
       // https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise/Promise
       itemPromiseResolve = resolve;
     });
-    const size = stringifyForTracing(item.item).length;
+    const size = serializePayloadForTracing(item.item).length;
     this.items.push({
       action: item.action,
       payload: item.item,
@@ -439,7 +439,7 @@
     // If there is an item on the queue we were unable to pop,
     // just return it as a single batch.
     if (popped.length === 0 && this.items.length > 0) {
       const item = this.items.shift()!;
       popped.push(item);
       poppedSizeBytes += item.size;
       this.sizeBytes -= item.size;
@@ -878,7 +878,7 @@
         if (this._serverInfo === undefined) {
           try {
             this._serverInfo = await this._getServerInfo();
           } catch (e) {
             console.warn(
               `[WARNING]: LangSmith failed to fetch info on supported operations. Falling back to batch operations and default limits.`
             );
@@ -943,7 +943,7 @@
       {
         method: "POST",
         headers,
-        body: stringifyForTracing(mergedRunCreateParam),
+        body: serializePayloadForTracing(mergedRunCreateParam),
         signal: AbortSignal.timeout(this.timeout_ms),
         ...this.fetchOptions,
       }
@@ -1020,11 +1020,11 @@
       }
     }
     if (batchChunks.post.length > 0 || batchChunks.patch.length > 0) {
-      await this._postBatchIngestRuns(stringifyForTracing(batchChunks));
+      await this._postBatchIngestRuns(serializePayloadForTracing(batchChunks));
     }
   }
 
-  private async _postBatchIngestRuns(body: string) {
+  private async _postBatchIngestRuns(body: Uint8Array) {
     const headers = {
       ...this.headers,
       "Content-Type": "application/json",
@@ -1143,7 +1143,7 @@
           originalPayload;
         const fields = { inputs, outputs, events };
         // encode the main run payload
-        const stringifiedPayload = stringifyForTracing(payload);
+        const stringifiedPayload = serializePayloadForTracing(payload);
         accumulatedParts.push({
           name: `${method}.${payload.id}`,
           payload: new Blob([stringifiedPayload], {
@@ -1155,7 +1155,7 @@
           if (value === undefined) {
             continue;
           }
-          const stringifiedValue = stringifyForTracing(value);
+          const stringifiedValue = serializePayloadForTracing(value);
           accumulatedParts.push({
             name: `${method}.${payload.id}.${key}`,
             payload: new Blob([stringifiedValue], {
@@ -1301,7 +1301,7 @@
       {
         method: "PATCH",
         headers,
-        body: stringifyForTracing(run),
+        body: serializePayloadForTracing(run),
         signal: AbortSignal.timeout(this.timeout_ms),
         ...this.fetchOptions,
       }
@@ -1613,7 +1613,7 @@
     treeFilter?: string;
     isRoot?: boolean;
     dataSourceType?: string;
   }): Promise<any> {
     let projectIds_ = projectIds || [];
     if (projectNames) {
       projectIds_ = [
@@ -1901,7 +1901,7 @@
         `Failed to list shared examples: ${response.status} ${response.statusText}`
       );
     }
     return result.map((example: any) => ({
       ...example,
       _hostUrl: this.getHostUrl(),
     }));
@@ -2031,7 +2031,7 @@
       }
       // projectId querying
       return true;
     } catch (e) {
       return false;
     }
   }
@@ -3521,7 +3521,7 @@
   async _logEvaluationFeedback(
     evaluatorResponse: EvaluationResult | EvaluationResults,
     run?: Run,
     sourceInfo?: { [key: string]: any }
   ): Promise<[results: EvaluationResult[], feedbacks: Feedback[]]> {
     const evalResults: Array<EvaluationResult> =
       this._selectEvalResults(evaluatorResponse);
@@ -3560,7 +3560,7 @@
   public async logEvaluationFeedback(
     evaluatorResponse: EvaluationResult | EvaluationResults,
     run?: Run,
     sourceInfo?: { [key: string]: any }
   ): Promise<EvaluationResult[]> {
     const [results] = await this._logEvaluationFeedback(
       evaluatorResponse,
@@ -4056,7 +4056,7 @@
 
   public async createCommit(
     promptIdentifier: string,
     object: any,
     options?: {
       parentCommitHash?: string;
     }
@@ -4124,15 +4124,15 @@
       };
 
       // Add main example data
-      const stringifiedExample = stringifyForTracing(exampleBody);
+      const stringifiedExample = serializePayloadForTracing(exampleBody);
       const exampleBlob = new Blob([stringifiedExample], {
         type: "application/json",
       });
       formData.append(exampleId, exampleBlob);
 
       // Add inputs
       if (example.inputs) {
-        const stringifiedInputs = stringifyForTracing(example.inputs);
+        const stringifiedInputs = serializePayloadForTracing(example.inputs);
         const inputsBlob = new Blob([stringifiedInputs], {
           type: "application/json",
         });
@@ -4141,7 +4141,7 @@
 
       // Add outputs if present
       if (example.outputs) {
-        const stringifiedOutputs = stringifyForTracing(example.outputs);
+        const stringifiedOutputs = serializePayloadForTracing(example.outputs);
         const outputsBlob = new Blob([stringifiedOutputs], {
           type: "application/json",
         });
@@ -4168,7 +4168,7 @@
       }
 
       if (example.attachments_operations) {
-        const stringifiedAttachmentsOperations = stringifyForTracing(
+        const stringifiedAttachmentsOperations = serializePayloadForTracing(
           example.attachments_operations
         );
         const attachmentsOperationsBlob = new Blob(
@@ -4224,22 +4224,22 @@
       };
 
       // Add main example data
-      const stringifiedExample = stringifyForTracing(exampleBody);
+      const stringifiedExample = serializePayloadForTracing(exampleBody);
       const exampleBlob = new Blob([stringifiedExample], {
         type: "application/json",
       });
       formData.append(exampleId, exampleBlob);
 
       // Add inputs
-      const stringifiedInputs = stringifyForTracing(example.inputs);
+      const stringifiedInputs = serializePayloadForTracing(example.inputs);
       const inputsBlob = new Blob([stringifiedInputs], {
         type: "application/json",
       });
       formData.append(`${exampleId}.inputs`, inputsBlob);
 
       // Add outputs if present
       if (example.outputs) {
-        const stringifiedOutputs = stringifyForTracing(example.outputs);
+        const stringifiedOutputs = serializePayloadForTracing(example.outputs);
         const outputsBlob = new Blob([stringifiedOutputs], {
           type: "application/json",
         });
@@ -4288,7 +4288,7 @@
       isPublic?: boolean;
       isArchived?: boolean;
     }
   ): Promise<Record<string, any>> {
     if (!(await this.promptExists(promptIdentifier))) {
       throw new Error("Prompt does not exist, you must create it first.");
     }
@@ -4299,7 +4299,7 @@
       throw await this._ownerConflictError("update a prompt", owner);
     }
 
     const payload: Record<string, any> = {};
 
     if (options?.description !== undefined)
       payload.description = options.description;

js/src/index.ts

@@ -18,4 +18,4 @@ export { RunTree, type RunTreeConfig } from "./run_trees.js";
 export { overrideFetchImplementation } from "./singletons/fetch.js";
 
 // Update using yarn bump-version
-export const __version__ = "0.3.4";
+export const __version__ = "0.3.5";

js/src/tests/batch_client.test.ts

@@ -7,12 +7,17 @@ import { convertToDottedOrderFormat } from "../run_trees.js";
 import { _getFetchImplementation } from "../singletons/fetch.js";
 import { RunCreate } from "../schemas.js";
 
-const parseMockRequestBody = async (body: string | ArrayBuffer) => {
+const parseMockRequestBody = async (body: string | ArrayBuffer | Uint8Array) => {
   if (typeof body === "string") {
     return JSON.parse(body);
   }
+
   // Typing is missing
   const rawMultipart = new TextDecoder().decode(body);
+
+  if (rawMultipart.trim().startsWith('{')) {
+    return JSON.parse(rawMultipart);
+  }
   // Parse the multipart form data boundary from the raw text
   const boundary = rawMultipart.split("\r\n")[0].trim();
   // Split the multipart body into individual parts
@@ -143,7 +148,7 @@ describe.each(ENDPOINT_TYPES)(
         _getFetchImplementation(),
         expectedTraceURL,
         expect.objectContaining({
-          body: expect.any(endpointType === "batch" ? String : ArrayBuffer),
+          body: expect.any(endpointType === "batch" ? Uint8Array : ArrayBuffer),
         })
       );
     });
@@ -257,7 +262,7 @@ describe.each(ENDPOINT_TYPES)(
         _getFetchImplementation(),
         expectedTraceURL,
         expect.objectContaining({
-          body: expect.any(endpointType === "batch" ? String : ArrayBuffer),
+          body: expect.any(endpointType === "batch" ? Uint8Array : ArrayBuffer),
         })
       );
     });
@@ -338,7 +343,7 @@ describe.each(ENDPOINT_TYPES)(
         _getFetchImplementation(),
         expectedTraceURL,
         expect.objectContaining({
-          body: expect.any(endpointType === "batch" ? String : ArrayBuffer),
+          body: expect.any(endpointType === "batch" ? Uint8Array : ArrayBuffer),
         })
       );
     });
@@ -935,7 +940,7 @@ describe.each(ENDPOINT_TYPES)(
         _getFetchImplementation(),
         "https://api.smith.langchain.com/runs/batch",
         expect.objectContaining({
-          body: expect.any(String),
+          body: expect.any(Uint8Array),
         })
       );
     });
@@ -1027,7 +1032,7 @@ describe.each(ENDPOINT_TYPES)(
         _getFetchImplementation(),
         expectedTraceURL,
         expect.objectContaining({
-          body: expect.any(endpointType === "batch" ? String : ArrayBuffer),
+          body: expect.any(endpointType === "batch" ? Uint8Array : ArrayBuffer),
         })
       );
     });

js/src/tests/utils/tree.ts

@@ -30,20 +30,29 @@ export function getAssumedTreeFromCalls(calls: unknown[][]) {
       { method: string; body: string }
     ];
     const req = `${fetchArgs.method} ${new URL(url as string).pathname}`;
-    const body: Run = JSON.parse(fetchArgs.body);
-
+    let body: Run;
+    if (typeof fetchArgs.body === "string") {
+      body = JSON.parse(fetchArgs.body);
+    } else {
+      const decoded = new TextDecoder().decode(fetchArgs.body);
+
+      if (decoded.trim().startsWith("{")) {
+        body = JSON.parse(decoded);
+      }
+    }
+
     if (req === "POST /runs") {
-      const id = body.id;
+      const id = body!.id;
       upsertId(id);
-      nodeMap[id] = { ...nodeMap[id], ...body };
+      nodeMap[id] = { ...nodeMap[id], ...body! };
       if (nodeMap[id].parent_run_id) {
         // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
         edges.push([nodeMap[id].parent_run_id!, nodeMap[id].id]);
       }
     } else if (req.startsWith("PATCH /runs/")) {
       const id = req.substring("PATCH /runs/".length);
       upsertId(id);
-      nodeMap[id] = { ...nodeMap[id], ...body };
+      nodeMap[id] = { ...nodeMap[id], ...body! };
     }
   }
 

js/src/utils/fast-safe-stringify/index.ts

@@ -6,22 +6,29 @@ var CIRCULAR_REPLACE_NODE = { result: "[Circular]" };
 var arr = [];
 var replacerStack = [];
 
+const encoder = new TextEncoder();
+
 function defaultOptions() {
   return {
     depthLimit: Number.MAX_SAFE_INTEGER,
     edgesLimit: Number.MAX_SAFE_INTEGER,
   };
 }
 
+function encodeString(str: string): Uint8Array {
+  return encoder.encode(str);
+}
+
 // Regular stringify
-export function stringify(obj, replacer?, spacer?, options?) {
+export function serialize(obj, replacer?, spacer?, options?) {
   try {
-    return JSON.stringify(obj, replacer, spacer);
+    const str = JSON.stringify(obj, replacer, spacer);
+    return encodeString(str);
   } catch (e: any) {
     // Fall back to more complex stringify if circular reference
     if (!e.message?.includes("Converting circular structure to JSON")) {
       console.warn("[WARNING]: LangSmith received unserializable value.");
-      return "[Unserializable]";
+      return encodeString("[Unserializable]");
     }
     console.warn(
       "[WARNING]: LangSmith received circular JSON. This will decrease tracer performance."
@@ -31,28 +38,28 @@ export function stringify(obj, replacer?, spacer?, options?) {
     }
 
     decirc(obj, "", 0, [], undefined, 0, options);
-    var res;
+    let res: string;
     try {
       if (replacerStack.length === 0) {
         res = JSON.stringify(obj, replacer, spacer);
       } else {
         res = JSON.stringify(obj, replaceGetterValues(replacer), spacer);
       }
     } catch (_) {
-      return JSON.stringify(
+      return encodeString(
         "[unable to serialize, circular reference is too complex to analyze]"
       );
     } finally {
       while (arr.length !== 0) {
-        var part = arr.pop();
+        const part = arr.pop();
         if (part.length === 4) {
           Object.defineProperty(part[0], part[1], part[3]);
         } else {
           part[0][part[1]] = part[2];
         }
       }
     }
-    return res;
+    return encodeString(res);
   }
 }