Merge pull request #31 from asingh9-godaddy/DEVX-73-http-trace-headers

Devx 73 http trace headers

Author: asingh9-godaddy

.changeset/cli-http-trace-headers.md

@@ -0,0 +1,5 @@
+---
+"@godaddy/cli": minor
+---
+
+Outgoing HTTP requests now carry a consistent `User-Agent` (`godaddy-cli/<version>` from the package manifest) and a per-request `X-Request-ID` (UUID v7) on REST catalog calls, GraphQL requests, OAuth token exchange, and webhook event-type discovery. Presigned S3 artifact uploads are unchanged: only the headers returned with the presigned URL are sent, so uploads remain signature-compatible.

src/core/api.ts

@@ -10,6 +10,7 @@ import {
 } from "../effect/errors";
 import { fileExists } from "../effect/fs-utils";
 import type { Keychain } from "../effect/services/keychain";
+import { CLI_USER_AGENT } from "../shared/cli-trace";
 import { getTokenInfoEffect } from "./auth";
 import { type Environment, envGetEffect, getApiUrl } from "./environment";
 
@@ -76,7 +77,6 @@ const MAX_ERROR_SUMMARY_CHARS = 240;
 const MAX_ERROR_DEPTH = 6;
 const MAX_ERROR_ARRAY_ITEMS = 40;
 const MAX_ERROR_OBJECT_KEYS = 80;
-const DEFAULT_USER_AGENT = "godaddy-cli";
 
 function findHeaderKey(
   headers: Record<string, string>,
@@ -108,7 +108,7 @@ function ensureRequiredRequestHeaders(headers: Record<string, string>): void {
   }
 
   if (!hasNonEmptyHeader(headers, "user-agent")) {
-    headers["user-agent"] = DEFAULT_USER_AGENT;
+    headers["user-agent"] = CLI_USER_AGENT;
   }
 }
 

src/core/auth.ts

@@ -12,6 +12,7 @@ import type { Keychain } from "../effect/services/keychain";
 // handler (Promise context), outside the Effect runtime. The Fetch tag is for
 // code within Effect.gen contexts.
 import { loggedFetch } from "../services/logger";
+import { cliTraceHeaders } from "../shared/cli-trace";
 import {
   type Environment,
   envGetEffect,
@@ -183,6 +184,7 @@ export function authLoginEffect(options?: {
                     method: "POST",
                     headers: {
                       "Content-Type": "application/x-www-form-urlencoded",
+                      ...cliTraceHeaders(),
                     },
                     body: new URLSearchParams({
                       client_id: clientId,

src/services/extension/upload.ts

@@ -99,8 +99,11 @@ export function uploadArtifactEffect(
     let lastError: Error | undefined;
 
     for (let attempt = 1; attempt <= maxRetries; attempt++) {
-      // Use only the requiredHeaders from the presigned URL (already signed)
-      // Filter out x-amz-meta-upload-id as it's not signed
+      // Presigned S3 PUT: send only the headers returned with the URL (they are
+      // part of the AWS Signature v4 signing string). Do not add `user-agent` or
+      // `x-request-id` here — unsigned headers can still affect behavior, and
+      // anything not in the signature can break the upload. Traceability for
+      // this hop is the presigned URL request (GraphQL), not the PUT itself.
       const { "x-amz-meta-upload-id": _, ...headers } = target.requiredHeaders;
 
       logger.debug(

src/services/http-helpers.ts

@@ -6,9 +6,9 @@ import { Fetch } from "@effect/platform/FetchHttpClient";
 import type { FileSystem } from "@effect/platform/FileSystem";
 import * as Effect from "effect/Effect";
 import { GraphQLClient } from "graphql-request";
-import { v7 as uuid } from "uuid";
 import { type Environment, envGetEffect, getApiUrl } from "../core/environment";
 import { ConfigurationError } from "../effect/errors";
+import { cliTraceHeaders } from "../shared/cli-trace";
 
 /**
  * Resolve the API base URL from environment variables or the active environment.
@@ -63,6 +63,6 @@ export function makeGraphQLClientEffect(): Effect.Effect<
 export function getRequestHeaders(accessToken: string): Record<string, string> {
   return {
     Authorization: `Bearer ${accessToken}`,
-    "X-Request-ID": uuid(),
+    ...cliTraceHeaders(),
   };
 }

src/services/webhook-events.ts

@@ -8,6 +8,7 @@ import {
   NetworkError,
   type ValidationError,
 } from "../effect/errors";
+import { cliTraceHeaders } from "../shared/cli-trace";
 import { logHttpRequest, logHttpResponse } from "./logger";
 
 export type WebhookEventType = {
@@ -47,7 +48,7 @@ export function getWebhookEventsTypesEffect({
     const url = `${baseUrl}/v1/apis/webhook-event-types`;
     const headers = {
       Authorization: `Bearer ${accessToken}`,
-      UserAgent: "@godaddy/cli",
+      ...cliTraceHeaders(),
     };
 
     const startTime = Date.now();

src/shared/cli-trace.ts

@@ -0,0 +1,21 @@
+import { v7 as uuid } from "uuid";
+import packageJson from "../../package.json";
+
+/** Shared User-Agent for outbound CLI HTTP requests (server-side tracing). */
+export const CLI_USER_AGENT = `godaddy-cli/${packageJson.version}`;
+
+/**
+ * Headers attached to outbound requests so upstream logs can correlate calls.
+ * Each invocation generates a fresh request ID.
+ *
+ * Keys are lowercase (`user-agent`, `x-request-id`) so the same spelling is
+ * used as in `ensureRequiredRequestHeaders` (`src/core/api.ts`) and across
+ * REST, GraphQL, OAuth, and webhook calls. HTTP treats header names as
+ * case-insensitive; lowercase keeps log pipelines and tests consistent.
+ */
+export function cliTraceHeaders(): Record<string, string> {
+  return {
+    "user-agent": CLI_USER_AGENT,
+    "x-request-id": uuid(),
+  };
+}

tests/unit/core/api.test.ts

@@ -82,7 +82,7 @@ describe("API Core Functions", () => {
           headers: expect.objectContaining({
             Authorization: "Bearer test-token-123",
             "x-request-id": expect.any(String),
-            "user-agent": "godaddy-cli",
+            "user-agent": expect.stringMatching(/^godaddy-cli\/\d+\.\d+\.\d+$/),
           }),
         }),
       );

tests/unit/services/extension/presigned-url.test.ts

@@ -27,7 +27,8 @@ vi.mock("@/services/http-helpers", () => {
   return {
     getRequestHeaders: (token: string) => ({
       Authorization: `Bearer ${token}`,
-      "X-Request-ID": "test-uuid",
+      "user-agent": "godaddy-cli/0.0.0-test",
+      "x-request-id": "test-uuid",
     }),
     makeGraphQLClientEffect: () =>
       Effect.succeed({

tests/unit/shared/cli-trace.test.ts

@@ -0,0 +1,30 @@
+import { describe, expect, test } from "vitest";
+import packageJson from "../../../package.json";
+import { getRequestHeaders } from "../../../src/services/http-helpers";
+import { CLI_USER_AGENT, cliTraceHeaders } from "../../../src/shared/cli-trace";
+
+describe("cli-trace", () => {
+  test("CLI_USER_AGENT includes package version", () => {
+    expect(CLI_USER_AGENT).toBe(`godaddy-cli/${packageJson.version}`);
+  });
+
+  test("cliTraceHeaders sets lowercase user-agent and x-request-id", () => {
+    const h = cliTraceHeaders();
+    expect(h["user-agent"]).toBe(CLI_USER_AGENT);
+    const rid = h["x-request-id"];
+    expect(rid).toBeDefined();
+    // Standard UUID string forms are 32 hex digits (with optional hyphens);
+    // avoid a strict 8-4-4-4-12 regex so a future uuid package output shape
+    // does not flake the test as long as it remains 32 hex.
+    const hex = rid.replace(/-/g, "");
+    expect(hex).toHaveLength(32);
+    expect(hex).toMatch(/^[0-9a-f]+$/i);
+  });
+
+  test("getRequestHeaders merges auth with trace headers", () => {
+    const h = getRequestHeaders("tok");
+    expect(h.Authorization).toBe("Bearer tok");
+    expect(h["user-agent"]).toBe(CLI_USER_AGENT);
+    expect(h["x-request-id"]).toBeTruthy();
+  });
+});