Improve setUser function

library/agent/applyHooks.test.ts

@@ -75,7 +75,7 @@ t.test(
     applyHooks(hooks);
 
     await runWithContext(context, async () => {
-      await fetch("https://aikido.dev");
+      await fetch("https://app.aikido.dev");
       t.same(modifyCalled, true);
 
       t.same(inspectCalled, false);

library/agent/context/user.test.ts

@@ -31,6 +31,26 @@ t.beforeEach(() => {
   createTestAgent();
 });
 
+t.test("usage outside of context", async (t) => {
+  let logs: string[] = [];
+  wrap(console, "warn", function warn() {
+    return function warn(message: string) {
+      logs.push(message);
+    };
+  });
+
+  setUser({ id: "id" });
+
+  t.same(logs, [
+    "setUser(...) did not find a context. Make sure to call setUser(...) within a handler or middleware of a supported framework.",
+  ]);
+
+  // Should not log again
+  logs = [];
+  setUser({ id: "id" });
+  t.same(logs, []);
+});
+
 t.test("it does not set user if empty id", async (t) => {
   const context = createContext();
 
@@ -82,45 +102,36 @@ t.test("it logs when setUser has invalid input", async () => {
   const logger = new LoggerForTesting();
   createTestAgent({ logger });
 
-  // @ts-expect-error User should be an object
-  setUser(1);
-  t.same(logger.getMessages(), [
-    "setUser(...) expects an object with 'id' and 'name' properties, found number instead.",
-  ]);
-  logger.clear();
-
-  // @ts-expect-error User is undefined
-  setUser(undefined);
-  t.same(logger.getMessages(), [
-    "setUser(...) can not be called with null or undefined.",
-  ]);
-  logger.clear();
+  const context = createContext();
 
-  // @ts-expect-error ID should be string or number
-  setUser({ id: {} });
-  t.same(logger.getMessages(), [
-    "setUser(...) expects an object with 'id' property of type string or number, found object instead.",
-  ]);
-  logger.clear();
+  runWithContext(context, () => {
+    // @ts-expect-error User should be an object
+    setUser(1);
+    t.same(logger.getMessages(), [
+      "setUser(...) expects an object with 'id' and 'name' properties, found number instead.",
+    ]);
+    logger.clear();
 
-  setUser({ id: "" });
-  t.same(logger.getMessages(), [
-    "setUser(...) expects an object with 'id' property non-empty string.",
-  ]);
-  logger.clear();
+    // @ts-expect-error ID should be string or number
+    setUser({ id: {} });
+    t.same(logger.getMessages(), [
+      "setUser(...) expects an object with 'id' property of type string or number, found object instead.",
+    ]);
+    logger.clear();
 
-  // @ts-expect-error ID is missing
-  setUser({ name: "name" });
-  t.same(logger.getMessages(), [
-    "setUser(...) expects an object with 'id' property.",
-  ]);
-  logger.clear();
+    setUser({ id: "" });
+    t.same(logger.getMessages(), [
+      "setUser(...) expects an object with 'id' property non-empty string.",
+    ]);
+    logger.clear();
 
-  // @ts-expect-error Testing invalid input
-  setUser(null);
-  t.same(logger.getMessages(), [
-    "setUser(...) can not be called with null or undefined.",
-  ]);
+    // @ts-expect-error ID is missing
+    setUser({ name: "name" });
+    t.same(logger.getMessages(), [
+      "setUser(...) expects an object with 'id' property.",
+    ]);
+    logger.clear();
+  });
 });
 
 t.test(
@@ -164,3 +175,25 @@ t.test(
     ]);
   }
 );
+
+t.test("setUser(undefined) resets the user", async (t) => {
+  const context = createContext();
+
+  runWithContext(context, () => {
+    setUser({ id: "id" });
+    t.same(getContext()?.user, {
+      id: "id",
+    });
+
+    setUser(undefined);
+    t.same(getContext()?.user, undefined);
+
+    setUser({ id: "id" });
+    t.same(getContext()?.user, {
+      id: "id",
+    });
+
+    setUser(null);
+    t.same(getContext()?.user, undefined);
+  });
+});

library/agent/context/user.ts

@@ -4,17 +4,25 @@ import { getInstance } from "../AgentSingleton";
 import type { User } from "../Context";
 import { ContextStorage } from "./ContextStorage";
 
-export function setUser(u: { id: string | number; name?: string }) {
+export function setUser(
+  u: { id: string | number; name?: string } | undefined | null
+) {
   const agent = getInstance();
 
   if (!agent) {
     return;
   }
 
+  const context = ContextStorage.getStore();
+  if (!context) {
+    logWarningSetUserCalledWithoutContext();
+    return;
+  }
+
   const user = u as unknown;
 
   if (user === null || user === undefined) {
-    agent.log(`setUser(...) can not be called with null or undefined.`);
+    context.user = undefined;
     return;
   }
 
@@ -50,12 +58,6 @@ export function setUser(u: { id: string | number; name?: string }) {
     validatedUser.name = user.name;
   }
 
-  const context = ContextStorage.getStore();
-
-  if (!context) {
-    return;
-  }
-
   if (context.executedMiddleware) {
     logWarningSetUserCalledAfterMiddleware();
   }
@@ -85,3 +87,18 @@ function logWarningSetUserCalledAfterMiddleware() {
 
   loggedWarningSetUserCalledAfterMiddleware = true;
 }
+
+let loggedWarningSetUserCalledWithoutContext = false;
+
+function logWarningSetUserCalledWithoutContext() {
+  if (loggedWarningSetUserCalledWithoutContext) {
+    return;
+  }
+
+  // eslint-disable-next-line no-console
+  console.warn(
+    `setUser(...) did not find a context. Make sure to call setUser(...) within a handler or middleware of a supported framework.`
+  );
+
+  loggedWarningSetUserCalledWithoutContext = true;
+}

library/sinks/Fetch.test.ts

@@ -85,17 +85,17 @@ t.test(
 
     t.same(agent.getHostnames().asArray(), []);
 
-    await fetch("http://aikido.dev");
+    await fetch("http://app.aikido.dev");
 
     t.same(agent.getHostnames().asArray(), [
-      { hostname: "aikido.dev", port: 80 },
+      { hostname: "app.aikido.dev", port: 80 },
     ]);
     agent.getHostnames().clear();
 
-    await fetch(new URL("https://aikido.dev"));
+    await fetch(new URL("https://app.aikido.dev"));
 
     t.same(agent.getHostnames().asArray(), [
-      { hostname: "aikido.dev", port: 443 },
+      { hostname: "app.aikido.dev", port: 443 },
     ]);
     agent.getHostnames().clear();
 

library/sinks/Undici.test.ts

@@ -104,77 +104,85 @@ t.test(
       Agent: UndiciAgent,
     } = require("undici");
 
-    await request("https://aikido.dev");
+    await request("https://app.aikido.dev");
     t.same(agent.getHostnames().asArray(), [
-      { hostname: "aikido.dev", port: 443 },
+      { hostname: "app.aikido.dev", port: 443 },
     ]);
     agent.getHostnames().clear();
 
-    await fetch("https://aikido.dev");
+    await fetch("https://app.aikido.dev");
     t.same(agent.getHostnames().asArray(), [
-      { hostname: "aikido.dev", port: 443 },
+      { hostname: "app.aikido.dev", port: 443 },
     ]);
     agent.getHostnames().clear();
 
-    await request({ protocol: "https:", hostname: "aikido.dev", port: 443 });
+    await request({
+      protocol: "https:",
+      hostname: "app.aikido.dev",
+      port: 443,
+    });
     t.same(agent.getHostnames().asArray(), [
-      { hostname: "aikido.dev", port: 443 },
+      { hostname: "app.aikido.dev", port: 443 },
     ]);
     agent.getHostnames().clear();
 
-    await request({ protocol: "https:", hostname: "aikido.dev", port: "443" });
+    await request({
+      protocol: "https:",
+      hostname: "app.aikido.dev",
+      port: "443",
+    });
     t.same(agent.getHostnames().asArray(), [
-      { hostname: "aikido.dev", port: "443" },
+      { hostname: "app.aikido.dev", port: "443" },
     ]);
     agent.getHostnames().clear();
 
     await request({
       protocol: "https:",
-      hostname: "aikido.dev",
+      hostname: "app.aikido.dev",
       port: undefined,
     });
     t.same(agent.getHostnames().asArray(), [
-      { hostname: "aikido.dev", port: 443 },
+      { hostname: "app.aikido.dev", port: 443 },
     ]);
     agent.getHostnames().clear();
 
     await request({
       protocol: "http:",
-      hostname: "aikido.dev",
+      hostname: "app.aikido.dev",
       port: undefined,
     });
     t.same(agent.getHostnames().asArray(), [
-      { hostname: "aikido.dev", port: 80 },
+      { hostname: "app.aikido.dev", port: 80 },
     ]);
     agent.getHostnames().clear();
 
     await request({
       protocol: "https:",
-      hostname: "aikido.dev",
+      hostname: "app.aikido.dev",
       port: "443",
     });
     t.same(agent.getHostnames().asArray(), [
-      { hostname: "aikido.dev", port: "443" },
+      { hostname: "app.aikido.dev", port: "443" },
     ]);
     agent.getHostnames().clear();
 
-    await request(new URL("https://aikido.dev"));
+    await request(new URL("https://app.aikido.dev"));
     t.same(agent.getHostnames().asArray(), [
-      { hostname: "aikido.dev", port: 443 },
+      { hostname: "app.aikido.dev", port: 443 },
     ]);
     agent.getHostnames().clear();
 
-    await request(require("url").parse("https://aikido.dev"));
+    await request(require("url").parse("https://app.aikido.dev"));
     t.same(agent.getHostnames().asArray(), [
-      { hostname: "aikido.dev", port: "443" },
+      { hostname: "app.aikido.dev", port: "443" },
     ]);
     agent.getHostnames().clear();
 
     await request({
-      origin: "https://aikido.dev",
+      origin: "https://app.aikido.dev",
     });
     t.same(agent.getHostnames().asArray(), [
-      { hostname: "aikido.dev", port: "443" },
+      { hostname: "app.aikido.dev", port: "443" },
     ]);
     agent.getHostnames().clear();