fix(js): include project/session name in distributed tracing (#1667)

Author: dqbd

js/package.json

@@ -1,6 +1,6 @@
 {
   "name": "langsmith",
-  "version": "0.3.16",
+  "version": "0.3.17",
   "description": "Client library to connect to the LangSmith LLM Tracing and Evaluation Platform.",
   "packageManager": "[email protected]",
   "files": [

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.16";
+export const __version__ = "0.3.17";

js/src/run_trees.ts

@@ -115,27 +115,35 @@ interface HeadersLike {
 class Baggage {
   metadata: KVMap | undefined;
   tags: string[] | undefined;
-
-  constructor(metadata: KVMap | undefined, tags: string[] | undefined) {
+  project_name: string | undefined;
+  constructor(
+    metadata: KVMap | undefined,
+    tags: string[] | undefined,
+    project_name: string | undefined
+  ) {
     this.metadata = metadata;
     this.tags = tags;
+    this.project_name = project_name;
   }
 
   static fromHeader(value: string) {
     const items = value.split(",");
     let metadata: KVMap = {};
     let tags: string[] = [];
+    let project_name: string | undefined;
     for (const item of items) {
       const [key, uriValue] = item.split("=");
       const value = decodeURIComponent(uriValue);
       if (key === "langsmith-metadata") {
         metadata = JSON.parse(value);
       } else if (key === "langsmith-tags") {
         tags = value.split(",");
+      } else if (key === "langsmith-project") {
+        project_name = value;
       }
     }
 
-    return new Baggage(metadata, tags);
+    return new Baggage(metadata, tags, project_name);
   }
 
   toHeader(): string {
@@ -150,6 +158,10 @@ class Baggage {
     if (this.tags && this.tags.length > 0) {
       items.push(`langsmith-tags=${encodeURIComponent(this.tags.join(","))}`);
     }
+    if (this.project_name) {
+      items.push(`langsmith-project=${encodeURIComponent(this.project_name)}`);
+    }
+
     return items.join(",");
   }
 }
@@ -556,6 +568,7 @@ export class RunTree implements BaseRun {
       const baggage = Baggage.fromHeader(rawHeaders["baggage"]);
       config.metadata = baggage.metadata;
       config.tags = baggage.tags;
+      config.project_name = baggage.project_name;
     }
 
     return new RunTree(config);
@@ -564,7 +577,11 @@ export class RunTree implements BaseRun {
   toHeaders(headers?: HeadersLike) {
     const result = {
       "langsmith-trace": this.dotted_order,
-      baggage: new Baggage(this.extra?.metadata, this.tags).toHeader(),
+      baggage: new Baggage(
+        this.extra?.metadata,
+        this.tags,
+        this.project_name
+      ).toHeader(),
     };
 
     if (headers) {

js/src/tests/run_trees.test.ts

@@ -95,9 +95,11 @@ test("distributed", () => {
     name: "parent_1",
     id: "00000000-0000-0000-0000-00000000000",
     start_time: Date.parse("2021-05-03T00:00:00.000Z"),
+    project_name: "test_project",
   });
 
   const serialized = parent.toHeaders();
+  expect(serialized.baggage).toContain("test_project");
 
   const child2 = RunTree.fromHeaders(serialized)?.createChild({
     name: "child_2",
@@ -108,6 +110,7 @@ test("distributed", () => {
   expect(JSON.parse(JSON.stringify(child2))).toMatchObject({
     name: "child_2",
     run_type: "chain",
+    session_name: "test_project",
     dotted_order:
       "20210503T000000000001Z00000000-0000-0000-0000-00000000000.20210503T000001000002Z00000000-0000-0000-0000-00000000001",
   });