Remove metadata from context, move it to it’s own tab

Author: ericallam

apps/webapp/app/presenters/v3/SpanPresenter.server.ts

@@ -192,10 +192,9 @@ export class SpanPresenter extends BasePresenter {
 
     const span = await eventRepository.getSpan(spanId, run.traceId);
 
-    const metadata = await parsePacket({
-      data: run.metadata ?? undefined,
-      dataType: run.metadataType,
-    });
+    const metadata = run.metadata
+      ? await prettyPrintPacket(run.metadata, run.metadataType)
+      : undefined;
 
     const context = {
       task: {
@@ -215,7 +214,6 @@ export class SpanPresenter extends BasePresenter {
         baseCostInCents: run.baseCostInCents,
         maxAttempts: run.maxAttempts ?? undefined,
         version: run.lockedToVersion?.version,
-        metadata,
       },
       queue: {
         name: run.queue,
@@ -285,6 +283,7 @@ export class SpanPresenter extends BasePresenter {
       error,
       links: span?.links,
       context: JSON.stringify(context, null, 2),
+      metadata,
     };
   }
 

apps/webapp/app/routes/resources.orgs.$organizationSlug.projects.v3.$projectParam.runs.$runParam.spans.$spanParam/route.tsx

@@ -421,6 +421,17 @@ function RunBody({
           >
             Context
           </TabButton>
+
+          <TabButton
+            isActive={tab === "metadata"}
+            layoutId="span-run"
+            onClick={() => {
+              replace({ tab: "metadata" });
+            }}
+            shortcut={{ key: "m" }}
+          >
+            Metadata
+          </TabButton>
         </TabContainer>
       </div>
       <div className="overflow-y-auto px-3 scrollbar-thin scrollbar-track-transparent scrollbar-thumb-charcoal-600">
@@ -607,6 +618,16 @@ function RunBody({
             <div className="flex flex-col gap-4 py-3">
               <CodeBlock code={run.context} showLineNumbers={false} />
             </div>
+          ) : tab === "metadata" ? (
+            <div className="flex flex-col gap-4 py-3">
+              {run.metadata ? (
+                <CodeBlock code={run.metadata} showLineNumbers={false} />
+              ) : (
+                <Callout to="https://trigger.dev/docs/runs/metadata" variant="docs">
+                  No metadata set for this run. View our metadata documentation to learn more.
+                </Callout>
+              )}
+            </div>
           ) : (
             <div className="flex flex-col gap-4 pt-3">
               <div className="border-b border-grid-bright pb-3">

apps/webapp/app/routes/resources.runs.$runParam.ts

@@ -1,10 +1,5 @@
 import { LoaderFunctionArgs } from "@remix-run/server-runtime";
-import {
-  MachinePresetName,
-  parsePacket,
-  prettyPrintPacket,
-  TaskRunError,
-} from "@trigger.dev/core/v3";
+import { MachinePresetName, prettyPrintPacket, TaskRunError } from "@trigger.dev/core/v3";
 import { typedjson, UseDataFunctionReturn } from "remix-typedjson";
 import { RUNNING_STATUSES } from "~/components/runs/v3/TaskRunStatus";
 import { $replica } from "~/db.server";
@@ -158,11 +153,6 @@ export const loader = async ({ request, params }: LoaderFunctionArgs) => {
     }
   }
 
-  const metadata = await parsePacket({
-    data: run.metadata ?? undefined,
-    dataType: run.metadataType,
-  });
-
   const context = {
     task: {
       id: run.taskIdentifier,
@@ -181,7 +171,6 @@ export const loader = async ({ request, params }: LoaderFunctionArgs) => {
       baseCostInCents: run.baseCostInCents,
       maxAttempts: run.maxAttempts ?? undefined,
       version: run.lockedToVersion?.version,
-      metadata,
     },
     queue: {
       name: run.queue,

docs/runs/metadata.mdx

@@ -0,0 +1,48 @@
+---
+title: "Run metadata"
+description: "Attach a small amount of data to a run and update it as the run progresses."
+---
+
+You can attach up to 8KB of metadata to a run, which you can then access from inside the run function, via the API, and in the dashboard. You can use metadata to store additional, structured information on an run. For example, you could store your user’s full name and corresponding unique identifier from your system on every task that is associated with that user:
+
+```ts
+const handle = await myTask.trigger(
+  { message: "hello world" },
+  { metadata: { user: { name: "Eric", id: "user_1234" } } }
+);
+```
+
+Then inside your run function, you can access the metadata like this:
+
+```ts
+import { task, metadata } from "@trigger.dev/sdk/v3";
+
+export const myTask = task({
+  id: "my-task",
+  run: async (payload: { message: string }, { ctx }) => {
+    const user = metadata.get("user");
+    console.log(user.name); // "Eric"
+    console.log(user.id); // "user_1234"
+  },
+});
+```
+
+You can also update the metadata during the run:
+
+```ts
+import { task, metadata } from "@trigger.dev/sdk/v3";
+
+export const myTask = task({
+  id: "my-task",
+  run: async (payload: { message: string }, { ctx }) => {
+    // Do some work
+    await metadata.set("progress", 0.1);
+
+    // Do some more work
+    await metadata.set("progress", 0.5);
+
+    // Do even more work
+    await metadata.set("progress", 1.0);
+  },
+});
+```

docs/v3-openapi.yaml

@@ -1897,6 +1897,10 @@ components:
           items:
             type: string
             description: A tag must be between 1 and 64 characters, a run can have up to 5 tags attached to it.
+        metadata:
+          type: object
+          description: The metadata of the run. See [Metadata](/runs/metadata) for more information.
+          example: { "foo": "bar" }
         costInCents:
           type: number
           example: 0.00292

packages/core/src/v3/runMetadata/index.ts

@@ -25,6 +25,10 @@ export class RunMetadataAPI {
     return this.store;
   }
 
+  public getKey(key: string): DeserializedJson | undefined {
+    return this.store?.[key];
+  }
+
   public async setKey(
     key: string,
     value: DeserializedJson,

packages/core/src/v3/schemas/common.ts

@@ -223,7 +223,7 @@ export const TaskRunContext = z.object({
     backgroundWorkerId: true,
     backgroundWorkerTaskId: true,
   }),
-  run: TaskRun.omit({ payload: true, payloadType: true }),
+  run: TaskRun.omit({ payload: true, payloadType: true, metadata: true }),
   queue: TaskRunExecutionQueue,
   environment: TaskRunExecutionEnvironment,
   organization: TaskRunExecutionOrganization,

packages/core/src/v3/workers/taskExecutor.ts

@@ -72,8 +72,8 @@ export class TaskExecutor {
       worker,
     });
 
-    if (ctx.run.metadata) {
-      runMetadata.enterWithMetadata(ctx.run.metadata);
+    if (execution.run.metadata) {
+      runMetadata.enterWithMetadata(execution.run.metadata);
     }
 
     this._tracingSDK.asyncResourceDetector.resolveWithAttributes({

packages/trigger-sdk/src/v3/metadata.ts

@@ -2,13 +2,15 @@ import { DeserializedJson } from "@trigger.dev/core";
 import {
   accessoryAttributes,
   ApiRequestOptions,
+  flattenAttributes,
   mergeRequestOptions,
   runMetadata,
 } from "@trigger.dev/core/v3";
 import { tracer } from "./tracer.js";
 
 export const metadata = {
   current: currentMetadata,
+  get: getMetadataKey,
   set: setMetadataKey,
   del: deleteMetadataKey,
   update: updateMetadata,
@@ -23,6 +25,13 @@ function currentMetadata(): RunMetadata | undefined {
   return runMetadata.current();
 }
 
+/**
+ * Get a key from the metadata of the current run if inside a task run.
+ */
+function getMetadataKey(key: string): DeserializedJson | undefined {
+  return runMetadata.getKey(key);
+}
+
 /**
  * Set a key in the metadata of the current run if inside a task run.
  *
@@ -48,7 +57,7 @@ async function setMetadataKey(
           ],
           style: "codepath",
         }),
-        key,
+        ...flattenAttributes(value, key),
       },
     },
     requestOptions
@@ -94,6 +103,9 @@ async function updateMetadata(
       tracer,
       name: "metadata.update()",
       icon: "code-plus",
+      attributes: {
+        ...flattenAttributes(metadata),
+      },
     },
     requestOptions
   );

references/v3-catalog/src/trigger/runMetadata.ts

@@ -19,8 +19,6 @@ export const runMetadataTask = task({
 export const runMetadataChildTask = task({
   id: "run-metadata-child-task",
   run: async (payload: any, { ctx }) => {
-    logger.info("metadata", { metadata: ctx.run.metadata });
-
     await metadata.set("child", "task");
 
     logger.info("metadata", { metadata: metadata.current() });
@@ -41,9 +39,13 @@ export const runMetadataChildTask = task({
       },
     });
 
-    // Now try and update the metadata with something larger than 8KB
-    await metadata.update({
-      large: new Array(10000).fill("a").join(""),
+    await runMetadataChildTask2.triggerAndWait(payload, {
+      metadata: metadata.current(),
     });
   },
 });
+
+export const runMetadataChildTask2 = task({
+  id: "run-metadata-child-task-2",
+  run: async (payload: any, { ctx }) => {},
+});