@outputai/http 0.1.4 → 0.1.5

package/dist/config.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Configuration for HTTP client behavior
+ */
+export declare const config: {
+    /**
+     * Whether to log verbose HTTP information (headers and bodies)
+     * Controlled by OUTPUT_TRACE_HTTP_VERBOSE environment variable
+     */
+    logVerbose: boolean;
+};

package/dist/config.js

@@ -0,0 +1,10 @@
+/**
+ * Configuration for HTTP client behavior
+ */
+export const config = {
+    /**
+     * Whether to log verbose HTTP information (headers and bodies)
+     * Controlled by OUTPUT_TRACE_HTTP_VERBOSE environment variable
+     */
+    logVerbose: ['1', 'true'].includes(process.env.OUTPUT_TRACE_HTTP_VERBOSE)
+};

package/dist/hooks/assign_request_id.d.ts

@@ -0,0 +1,9 @@
+import type { BeforeRequestHook } from 'ky';
+/**
+ * Assigns a unique request ID to each request via X-Request-ID header
+ * This ensures each request invocation has a unique identifier for tracing,
+ * even if the request shape (method/url/headers) is identical
+ *
+ * If X-Request-ID already exists (from upstream), it's preserved for propagation
+ */
+export declare const assignRequestId: BeforeRequestHook;

package/dist/hooks/assign_request_id.js

@@ -0,0 +1,15 @@
+import { randomUUID } from 'node:crypto';
+/**
+ * Assigns a unique request ID to each request via X-Request-ID header
+ * This ensures each request invocation has a unique identifier for tracing,
+ * even if the request shape (method/url/headers) is identical
+ *
+ * If X-Request-ID already exists (from upstream), it's preserved for propagation
+ */
+export const assignRequestId = (request) => {
+    const existingId = request.headers.get('X-Request-ID');
+    if (!existingId) {
+        const requestId = randomUUID();
+        request.headers.set('X-Request-ID', requestId);
+    }
+};

package/dist/hooks/index.d.ts

@@ -0,0 +1,4 @@
+export { assignRequestId } from './assign_request_id.js';
+export { traceRequest } from './trace_request.js';
+export { traceResponse } from './trace_response.js';
+export { traceError } from './trace_error.js';

package/dist/hooks/index.js

@@ -0,0 +1,4 @@
+export { assignRequestId } from './assign_request_id.js';
+export { traceRequest } from './trace_request.js';
+export { traceResponse } from './trace_response.js';
+export { traceError } from './trace_error.js';

package/dist/hooks/trace_error.d.ts

@@ -0,0 +1,14 @@
+import type { BeforeErrorHook, Input } from 'ky';
+/**
+ * Wraps a fetch-like function to log and rethrow errors.
+ *
+ * This is nessesary as ky's beforeError hook does not trace non-HTTP errors.
+ * See: https://github.com/sindresorhus/ky/issues/296
+ * @param fetchFn - A fetch-compatible function (input, init) => Promise<Response>
+ * @returns A new function with the same signature that logs and rethrows errors.
+ */
+export declare function applyFetchErrorTracing(fetchFn: (input: Input, init?: RequestInit) => Promise<Response>): (input: Input, init?: RequestInit) => Promise<Response>;
+/**
+ * Traces HTTP errors for observability using Output.ai tracing
+ */
+export declare const traceError: BeforeErrorHook;

package/dist/hooks/trace_error.js

@@ -0,0 +1,61 @@
+import { HTTPError } from 'ky';
+import { createTraceId, redactHeaders } from '#utils/index.js';
+import { Tracing } from '@outputai/core/sdk_activity_integration';
+/**
+ * Wraps a fetch-like function to log and rethrow errors.
+ *
+ * This is nessesary as ky's beforeError hook does not trace non-HTTP errors.
+ * See: https://github.com/sindresorhus/ky/issues/296
+ * @param fetchFn - A fetch-compatible function (input, init) => Promise<Response>
+ * @returns A new function with the same signature that logs and rethrows errors.
+ */
+export function applyFetchErrorTracing(fetchFn) {
+    return async (input, init) => {
+        try {
+            return await fetchFn(input, init);
+        }
+        catch (err) {
+            const isHTTPError = err instanceof HTTPError;
+            if (!isHTTPError) {
+                const traceId = createTraceId(input);
+                // Skip tracing if no X-Request-ID header is present
+                if (traceId) {
+                    const isAbortError = err instanceof DOMException && err.name === 'AbortError';
+                    const message = isAbortError ? 'Fetch aborted due to timeout or manual cancellation' : 'Unknown error occurred';
+                    Tracing.addEventError({
+                        id: traceId,
+                        details: {
+                            error: JSON.stringify(err, null, 2),
+                            message
+                        }
+                    });
+                }
+                else {
+                    console.warn('applyFetchErrorTracing: Skipping fetch error tracing - no X-Request-ID header');
+                }
+            }
+            throw err;
+        }
+    };
+}
+/**
+ * Traces HTTP errors for observability using Output.ai tracing
+ */
+export const traceError = (error, _state) => {
+    const traceId = createTraceId(error.request);
+    // Skip tracing if no X-Request-ID header is present
+    if (traceId) {
+        Tracing.addEventError({
+            id: traceId,
+            details: {
+                status: error.response.status,
+                statusText: error.response.statusText,
+                headers: redactHeaders(Object.fromEntries(error.response.headers.entries()))
+            }
+        });
+    }
+    else {
+        console.warn('traceError: Skipping HTTP error tracing - no X-Request-ID header');
+    }
+    return error;
+};

package/dist/hooks/trace_error.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/hooks/trace_error.spec.js

@@ -0,0 +1,35 @@
+import { describe, it, expect, beforeEach, vi } from 'vitest';
+import { HTTPError } from 'ky';
+import { traceError } from './trace_error.js';
+import { Tracing } from '@outputai/core/sdk_activity_integration';
+vi.mock('../utils/index.js', () => ({
+    redactHeaders: vi.fn((h) => h),
+    createTraceId: vi.fn(() => 'trace-id')
+}));
+vi.mock('@outputai/core/sdk_activity_integration', () => ({
+    Tracing: {
+        addEventError: vi.fn()
+    }
+}));
+const mockedTracing = vi.mocked(Tracing, true);
+describe('http/hooks/trace_error', () => {
+    beforeEach(() => {
+        mockedTracing.addEventError.mockClear();
+    });
+    it('traces error with response details when response exists', async () => {
+        const request = new Request('https://api.example.com/users/1', { method: 'GET' });
+        const response = new Response('Unauthorized', {
+            status: 401,
+            statusText: 'Unauthorized',
+            headers: { authorization: 'secret', 'x-custom': 'v' }
+        });
+        const error = new HTTPError(response, request, {});
+        const returned = await traceError(error, { retryCount: 0 });
+        expect(returned).toBe(error);
+        expect(mockedTracing.addEventError).toHaveBeenCalledTimes(1);
+        const arg = mockedTracing.addEventError.mock.calls[0][0];
+        expect(arg.details.status).toBe(401);
+        expect(arg.details.statusText).toBe('Unauthorized');
+        expect(arg.details.headers).toMatchObject({ authorization: 'secret', 'x-custom': 'v' });
+    });
+});

package/dist/hooks/trace_request.d.ts

@@ -0,0 +1,6 @@
+import type { BeforeRequestHook } from 'ky';
+/**
+ * Traces HTTP request for observability using Output.ai tracing
+ * Respects OUTPUT_TRACE_HTTP_VERBOSE environment variable for detailed logging
+ */
+export declare const traceRequest: BeforeRequestHook;

package/dist/hooks/trace_request.js

@@ -0,0 +1,25 @@
+import { Tracing } from '@outputai/core/sdk_activity_integration';
+import { redactHeaders, createTraceId, parseRequestBody } from '#utils/index.js';
+import { config } from '#config.js';
+/**
+ * Traces HTTP request for observability using Output.ai tracing
+ * Respects OUTPUT_TRACE_HTTP_VERBOSE environment variable for detailed logging
+ */
+export const traceRequest = async (request, _options, _state) => {
+    const traceId = createTraceId(request);
+    // Skip tracing if no X-Request-ID header is present
+    if (!traceId) {
+        console.warn('traceRequest: Skipping request tracing - no X-Request-ID header');
+        return;
+    }
+    const details = {
+        method: request.method,
+        url: request.url
+    };
+    if (config.logVerbose) {
+        const headers = Object.fromEntries(request.headers.entries());
+        details.headers = redactHeaders(headers);
+        details.body = await parseRequestBody(request);
+    }
+    Tracing.addEventStart({ id: traceId, kind: 'http', name: 'request', details });
+};

package/dist/hooks/trace_request.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/hooks/trace_request.spec.js

@@ -0,0 +1,60 @@
+import { describe, it, expect, beforeEach, vi } from 'vitest';
+import { traceRequest } from './trace_request.js';
+import { Tracing } from '@outputai/core/sdk_activity_integration';
+import { config } from '../config.js';
+vi.mock('../utils/index.js', () => ({
+    redactHeaders: vi.fn((h) => h),
+    parseRequestBody: vi.fn(async () => ({ mocked: true })),
+    createTraceId: vi.fn(() => 'trace-id')
+}));
+vi.mock('@outputai/core/sdk_activity_integration', () => ({
+    Tracing: {
+        addEventStart: vi.fn()
+    }
+}));
+vi.mock('../config.js', () => ({
+    config: { logVerbose: false }
+}));
+const mockedTracing = vi.mocked(Tracing, true);
+const mockedConfig = vi.mocked(config);
+describe('http/hooks/trace_request', () => {
+    beforeEach(() => {
+        mockedTracing.addEventStart.mockClear();
+        mockedConfig.logVerbose = false;
+    });
+    it('traces minimal details when verbose logging is disabled', async () => {
+        mockedConfig.logVerbose = false;
+        const request = new Request('https://api.example.com/users/1', { method: 'GET' });
+        const options = {};
+        const state = { retryCount: 0 };
+        await traceRequest(request, options, state);
+        expect(mockedTracing.addEventStart).toHaveBeenCalledTimes(1);
+        const arg = mockedTracing.addEventStart.mock.calls[0][0];
+        expect(arg).toHaveProperty('kind', 'http');
+        expect(arg).toHaveProperty('name', 'request');
+        expect(arg.details).toEqual({
+            method: 'GET',
+            url: 'https://api.example.com/users/1'
+        });
+    });
+    it('traces headers and parsed body when verbose logging is enabled', async () => {
+        mockedConfig.logVerbose = true;
+        const request = new Request('https://api.example.com/users', {
+            method: 'POST',
+            headers: {
+                authorization: 'secret',
+                'x-custom': 'value'
+            },
+            body: JSON.stringify({ name: 'test' })
+        });
+        const options = {};
+        const state = { retryCount: 0 };
+        await traceRequest(request, options, state);
+        expect(mockedTracing.addEventStart).toHaveBeenCalledTimes(1);
+        const arg = mockedTracing.addEventStart.mock.calls[0][0];
+        expect(arg.details.method).toBe('POST');
+        expect(arg.details.url).toBe('https://api.example.com/users');
+        expect(arg.details.headers).toMatchObject({ authorization: 'secret', 'x-custom': 'value' });
+        expect(arg.details.body).toEqual({ mocked: true });
+    });
+});

package/dist/hooks/trace_response.d.ts

@@ -0,0 +1,6 @@
+import type { AfterResponseHook } from 'ky';
+/**
+ * Traces HTTP response for observability using Output.ai tracing
+ * Respects OUTPUT_TRACE_HTTP_VERBOSE environment variable for detailed logging
+ */
+export declare const traceResponse: AfterResponseHook;

package/dist/hooks/trace_response.js

@@ -0,0 +1,26 @@
+import { Tracing } from '@outputai/core/sdk_activity_integration';
+import { redactHeaders, createTraceId, parseResponseBody } from '#utils/index.js';
+import { config } from '#config.js';
+/**
+ * Traces HTTP response for observability using Output.ai tracing
+ * Respects OUTPUT_TRACE_HTTP_VERBOSE environment variable for detailed logging
+ */
+export const traceResponse = async (request, _options, response, _state) => {
+    const traceId = createTraceId(request);
+    // Skip tracing if no X-Request-ID header is present
+    if (!traceId) {
+        console.warn('traceResponse: Skipping response tracing - no X-Request-ID header');
+        return response;
+    }
+    const details = {
+        status: response.status,
+        statusText: response.statusText
+    };
+    if (config.logVerbose) {
+        const responseHeaders = Object.fromEntries(response.headers.entries());
+        details.headers = redactHeaders(responseHeaders);
+        details.body = await parseResponseBody(response);
+    }
+    Tracing.addEventEnd({ id: traceId, details });
+    return response;
+};

package/dist/hooks/trace_response.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/hooks/trace_response.spec.js

@@ -0,0 +1,68 @@
+import { describe, it, expect, beforeEach, vi } from 'vitest';
+import { traceResponse } from './trace_response.js';
+import { Tracing } from '@outputai/core/sdk_activity_integration';
+import { config } from '../config.js';
+vi.mock('../utils/index.js', () => ({
+    redactHeaders: vi.fn((h) => h),
+    parseResponseBody: vi.fn(async () => ({ mocked: true })),
+    createTraceId: vi.fn(() => 'trace-id')
+}));
+vi.mock('@outputai/core/sdk_activity_integration', () => ({
+    Tracing: {
+        addEventEnd: vi.fn()
+    }
+}));
+vi.mock('../config.js', () => ({
+    config: { logVerbose: false }
+}));
+const mockedTracing = vi.mocked(Tracing, true);
+const mockedConfig = vi.mocked(config);
+describe('http/hooks/trace_response', () => {
+    beforeEach(() => {
+        mockedTracing.addEventEnd.mockClear();
+        mockedConfig.logVerbose = false;
+    });
+    it('traces minimal details when verbose logging is disabled', async () => {
+        mockedConfig.logVerbose = false;
+        const request = new Request('https://api.example.com/users/1', { method: 'GET' });
+        const response = new Response('ok', { status: 200, statusText: 'OK' });
+        const options = {};
+        const state = { retryCount: 0 };
+        const result = await traceResponse(request, options, response, state);
+        expect(result).toBe(response);
+        expect(mockedTracing.addEventEnd).toHaveBeenCalledTimes(1);
+        const arg = mockedTracing.addEventEnd.mock.calls[0][0];
+        expect(arg.details).toEqual({ status: 200, statusText: 'OK' });
+    });
+    it('traces headers and parsed JSON body when verbose logging is enabled', async () => {
+        mockedConfig.logVerbose = true;
+        const request = new Request('https://api.example.com/users', { method: 'POST' });
+        const response = new Response(JSON.stringify({ success: true }), {
+            status: 201,
+            statusText: 'Created',
+            headers: { 'content-type': 'application/json', authorization: 'secret', 'x-custom': 'v' }
+        });
+        const options = {};
+        const state = { retryCount: 0 };
+        await traceResponse(request, options, response, state);
+        const arg = mockedTracing.addEventEnd.mock.calls[0][0];
+        expect(arg.details.status).toBe(201);
+        expect(arg.details.statusText).toBe('Created');
+        expect(arg.details.headers).toEqual({ 'content-type': 'application/json', authorization: 'secret', 'x-custom': 'v' });
+        expect(arg.details.body).toEqual({ mocked: true });
+    });
+    it('traces text body for non-JSON content types', async () => {
+        mockedConfig.logVerbose = true;
+        const request = new Request('https://api.example.com/ping', { method: 'GET' });
+        const response = new Response('pong', {
+            status: 200,
+            statusText: 'OK',
+            headers: { 'content-type': 'text/plain' }
+        });
+        const options = {};
+        const state = { retryCount: 0 };
+        await traceResponse(request, options, response, state);
+        const arg = mockedTracing.addEventEnd.mock.calls[0][0];
+        expect(arg.details.body).toEqual({ mocked: true });
+    });
+});

package/dist/index.d.ts

@@ -0,0 +1,26 @@
+import type { Options } from 'ky';
+/**
+ * Creates a ky client.
+ *
+ * This client is customized with hooks to integrate with Output.ai tracing.
+ *
+ * @example
+ * ```ts
+ * import { httpClient } from '@outputai/http';
+ *
+ * const client = httpClient({
+ *   prefixUrl: 'https://api.example.com',
+ *   timeout: 30000,
+ *   retry: { limit: 3 }
+ * });
+ *
+ * const response = await client.get('users/1');
+ * const data = await response.json();
+ * ```
+ *
+ * @param options - The ky options to extend the base client.
+ * @returns A ky instance extended with Output.ai tracing hooks.
+ */
+export declare function httpClient(options?: Options): import("ky").KyInstance;
+export { HTTPError, TimeoutError } from 'ky';
+export type { Options as HttpClientOptions } from 'ky';

package/dist/index.integration.test.d.ts

@@ -0,0 +1 @@
+export {};