@squiz/dx-common-lib 1.72.3 → 1.72.5

package/src/outbound-http/createServiceUserAgent.spec.ts

@@ -0,0 +1,11 @@
+import { createServiceUserAgent } from './createServiceUserAgent';
+
+describe('createServiceUserAgent', () => {
+  it('returns Squiz/<name> for a scoped package name', () => {
+    expect(createServiceUserAgent('@squiz/content-api')).toBe('Squiz/content-api');
+  });
+
+  it('returns Squiz/<name> for an unscoped service name', () => {
+    expect(createServiceUserAgent('content-api')).toBe('Squiz/content-api');
+  });
+});

package/src/outbound-http/createServiceUserAgent.ts

@@ -0,0 +1,9 @@
+/**
+ * Builds a User-Agent string for outbound service-to-service HTTP requests.
+ *
+ * @param serviceName Service identifier, e.g. `content-api` or `@squiz/content-api`
+ */
+export function createServiceUserAgent(serviceName: string): string {
+  const name = serviceName.replace(/^@squiz\//, '');
+  return `Squiz/${name}`;
+}

package/src/outbound-http/index.ts

@@ -0,0 +1,2 @@
+export { createServiceUserAgent } from './createServiceUserAgent';
+export { outboundFetch, type OutboundFetchInput } from './outboundHttp';

package/src/outbound-http/outboundHttp.spec.ts

@@ -0,0 +1,69 @@
+import { outboundFetch } from './outboundHttp';
+
+describe('outboundFetch', () => {
+  const userAgent = 'Squiz/test-service';
+  const originalFetch = global.fetch;
+
+  beforeEach(() => {
+    global.fetch = jest.fn().mockResolvedValue(new Response());
+  });
+
+  afterEach(() => {
+    global.fetch = originalFetch;
+  });
+
+  it('adds User-Agent to string URL requests with init headers', async () => {
+    await outboundFetch(userAgent, 'https://example.com/resource', {
+      headers: { 'x-api-key': 'secret' },
+    });
+
+    const init = (global.fetch as jest.Mock).mock.calls[0][1] as RequestInit;
+    const headers = init.headers as Headers;
+    expect(headers.get('x-api-key')).toBe('secret');
+    expect(headers.get('User-Agent')).toBe(userAgent);
+  });
+
+  it('preserves headers from a Request input and adds User-Agent', async () => {
+    const request = new Request('https://example.com/resource', {
+      method: 'GET',
+      headers: {
+        Authorization: 'Bearer token',
+        'x-dxp-tenant': 'tenant-1',
+      },
+    });
+
+    await outboundFetch(userAgent, request);
+
+    const init = (global.fetch as jest.Mock).mock.calls[0][1] as RequestInit;
+    const headers = init.headers as Headers;
+    expect(headers.get('Authorization')).toBe('Bearer token');
+    expect(headers.get('x-dxp-tenant')).toBe('tenant-1');
+    expect(headers.get('User-Agent')).toBe(userAgent);
+  });
+
+  it('merges init headers on top of Request headers without dropping existing values', async () => {
+    const request = new Request('https://example.com/resource', {
+      headers: { 'x-api-key': 'from-request' },
+    });
+
+    await outboundFetch(userAgent, request, {
+      headers: { 'x-dxp-session': 'session-token' },
+    });
+
+    const init = (global.fetch as jest.Mock).mock.calls[0][1] as RequestInit;
+    const headers = init.headers as Headers;
+    expect(headers.get('x-api-key')).toBe('from-request');
+    expect(headers.get('x-dxp-session')).toBe('session-token');
+    expect(headers.get('User-Agent')).toBe(userAgent);
+  });
+
+  it('Overrides an explicit User-Agent header', async () => {
+    await outboundFetch(userAgent, 'https://example.com/resource', {
+      headers: { 'User-Agent': 'custom-agent' },
+    });
+
+    const init = (global.fetch as jest.Mock).mock.calls[0][1] as RequestInit;
+    const headers = init.headers as Headers;
+    expect(headers.get('User-Agent')).toBe(userAgent);
+  });
+});

package/src/outbound-http/outboundHttp.ts

@@ -0,0 +1,26 @@
+export type OutboundFetchInput = string | URL | Request;
+
+function buildOutboundHeaders(userAgent: string, input: OutboundFetchInput, init?: RequestInit): Headers {
+  const headers = new Headers();
+
+  if (input instanceof Request) {
+    input.headers.forEach((value, key) => {
+      headers.set(key, value);
+    });
+  }
+
+  if (init?.headers) {
+    new Headers(init.headers).forEach((value, key) => {
+      headers.set(key, value);
+    });
+  }
+
+  headers.set('User-Agent', userAgent);
+
+  return headers;
+}
+
+export function outboundFetch(userAgent: string, input: OutboundFetchInput, init?: RequestInit): Promise<Response> {
+  const headers = buildOutboundHeaders(userAgent, input, init);
+  return fetch(input, { ...init, headers });
+}

package/src/stream/EventStreamHandler.spec.ts

@@ -3,7 +3,7 @@
  * Copyright Squiz Australia Pty Ltd. All Rights Reserved.
  */
 import { createEventStreamHandler, EventMapper } from './EventStreamHandler';
-import { DynamoDBStreamEvent, DynamoDBRecord, Context } from 'aws-lambda';
+import type { DynamoDBStreamEvent, DynamoDBRecord, Context } from 'aws-lambda';
 
 interface MockLogger {
   info: jest.Mock;

package/src/stream/EventStreamHandler.ts

@@ -2,7 +2,7 @@
  * @license
  * Copyright Squiz Australia Pty Ltd. All Rights Reserved.
  */
-import { DynamoDBStreamEvent, DynamoDBRecord, Context, DynamoDBBatchResponse } from 'aws-lambda';
+import type { DynamoDBStreamEvent, DynamoDBRecord, Context, DynamoDBBatchResponse } from 'aws-lambda';
 import { Logger } from '@squiz/dx-logger-lib';
 import { EventBusService } from '../events/EventBusService';
 
@@ -16,6 +16,8 @@ export type EventMapper = (record: DynamoDBRecord) => Promise<EventPayload[]>;
 /** Resolves tenant id for publishing; use `record` when tenant is carried on the item rather than derivable from the table ARN. */
 export type ExtractTenantId = (arn: string, tableServiceIdentifier: string, record: DynamoDBRecord) => string;
 
+export type EventStreamHandler = (event: DynamoDBStreamEvent, context: Context) => Promise<DynamoDBBatchResponse>;
+
 interface MappedRecord {
   recordIndex: number;
   record: DynamoDBRecord;
@@ -46,7 +48,7 @@ interface EventStreamHandlerConfig<T extends string> {
  * - Batch event publishing with retry tracking
  * - Failure reporting for Lambda retry mechanism
  */
-export function createEventStreamHandler<T extends string>(config: EventStreamHandlerConfig<T>) {
+export function createEventStreamHandler<T extends string>(config: EventStreamHandlerConfig<T>): EventStreamHandler {
   const {
     logger,
     eventBusService,