feat(tracing): enable tracing channels for unstorage (#4226)

Author: logaretm

src/build/virtual/storage.ts

@@ -24,8 +24,13 @@ export default function storage(nitro: Nitro) {
 
       const driverImports = [...new Set(mounts.map((m) => m.driver))];
 
+      const tracingEnabled = !!(
+        typeof nitro.options.tracingChannel === "object" && nitro.options.tracingChannel?.unstorage
+      );
+
       return /* js */ `
 import { createStorage } from 'unstorage'
+${tracingEnabled ? `import { withTracing } from 'unstorage/tracing'` : ""}
 import { assets } from '#nitro/virtual/server-assets'
 
 ${driverImports.map((i) => genImport(i, genSafeVariableName(i))).join("\n")}
@@ -39,7 +44,7 @@ export function initStorage() {
         `storage.mount('${m.path}', ${genSafeVariableName(m.driver)}(${JSON.stringify(m.opts)}))`
     )
     .join("\n")}
-  return storage
+  return ${tracingEnabled ? "withTracing(storage)" : "storage"}
 }
 `;
     },

src/config/resolvers/tracing.ts

@@ -5,6 +5,7 @@ export async function resolveTracingOptions(options: NitroOptions) {
   options.tracingChannel = {
     srvx: true,
     h3: true,
+    unstorage: true,
     ...(typeof options.tracingChannel === "object" ? options.tracingChannel : {}),
   };
   options.plugins = options.plugins || [];

src/types/config.ts

@@ -1038,6 +1038,7 @@ export interface ServerAssetDir {
 export interface TracingOptions {
   srvx?: boolean;
   h3?: boolean;
+  unstorage?: boolean;
 }
 
 /**

test/unit/virtual-storage.test.ts

@@ -0,0 +1,38 @@
+import { describe, expect, it } from "vitest";
+import type { Nitro } from "nitro/types";
+
+import storage from "../../src/build/virtual/storage.ts";
+
+function createNitroStub(tracingChannel: Nitro["options"]["tracingChannel"]): Nitro {
+  return {
+    options: {
+      dev: true,
+      preset: "nitro-dev",
+      storage: {},
+      devStorage: {},
+      tracingChannel,
+    },
+  } as unknown as Nitro;
+}
+
+describe("virtual/storage template", () => {
+  it("does not wrap storage when tracingChannel is disabled", () => {
+    const template = storage(createNitroStub(undefined)).template();
+    expect(template).not.toContain("withTracing");
+    expect(template).not.toContain("unstorage/tracing");
+    expect(template).toContain("return storage");
+  });
+
+  it("does not wrap storage when tracingChannel.unstorage is false", () => {
+    const template = storage(
+      createNitroStub({ srvx: true, h3: true, unstorage: false })
+    ).template();
+    expect(template).not.toContain("withTracing");
+  });
+
+  it("wraps storage with withTracing when tracingChannel.unstorage is true", () => {
+    const template = storage(createNitroStub({ srvx: true, h3: true, unstorage: true })).template();
+    expect(template).toContain(`import { withTracing } from 'unstorage/tracing'`);
+    expect(template).toContain("return withTracing(storage)");
+  });
+});