@foss.global/codefeed 2.0.1 → 2.1.0

package/ts/forgeinventory.client.ts

@@ -0,0 +1,88 @@
+import type * as transport from './forgeinventory.transport.js';
+import * as validation from './forgeinventory.validation.js';
+
+export interface IForgeRequestMetrics {
+  requests: number;
+  responseBytes: number;
+  rateLimitedRequests: number;
+}
+
+export interface IForgeRequestClientOptions {
+  transport: transport.TForgeTransport;
+  /** Credential headers, sent with every request and never reported. */
+  headers: Record<string, string>;
+  requestTimeoutMs: number;
+  maxResponseBytes: number;
+}
+
+export interface IForgeRequestOptions {
+  signal?: AbortSignal;
+  /** Optional lower response-body budget for this request. */
+  maxResponseBytes?: number;
+  /** Additional request headers, such as a provider's impersonation header. */
+  headers?: Record<string, string>;
+}
+
+export interface IForgeJsonResponse {
+  body: unknown;
+  headers: transport.IForgeTransportResponse['headers'];
+}
+
+/**
+ * One bounded, credential-scoped JSON GET at a time: a per-request deadline, a
+ * response-size budget and a strict JSON content type. Failures surface as
+ * `ForgeInventoryError` codes that never contain bodies, URLs or credentials.
+ */
+export class ForgeRequestClient {
+  readonly #options: IForgeRequestClientOptions;
+  readonly #metrics: IForgeRequestMetrics = { requests: 0, responseBytes: 0, rateLimitedRequests: 0 };
+
+  constructor(optionsArg: IForgeRequestClientOptions) {
+    this.#options = { ...optionsArg, headers: { ...optionsArg.headers } };
+  }
+
+  public get metrics(): IForgeRequestMetrics { return { ...this.#metrics }; }
+
+  public async request(url: URL, requestArg: IForgeRequestOptions = {}): Promise<IForgeJsonResponse> {
+    const { signal } = requestArg;
+    const maxBytes = requestArg.maxResponseBytes ?? this.#options.maxResponseBytes;
+    if (!Number.isSafeInteger(maxBytes) || maxBytes < 1) throw new validation.ForgeInventoryError('invalid-response-budget');
+    const controller = new AbortController();
+    const abort = () => controller.abort();
+    if (signal?.aborted) throw new validation.ForgeInventoryError('request-aborted');
+    signal?.addEventListener('abort', abort, { once: true });
+    const timeout = setTimeout(abort, this.#options.requestTimeoutMs);
+    const deadline = Date.now() + this.#options.requestTimeoutMs;
+    let bodyChunks: AsyncIterator<Uint8Array> | undefined;
+    try {
+      this.#metrics.requests++;
+      const headers = { accept: 'application/json', ...requestArg.headers, ...this.#options.headers };
+      const response = await this.#options.transport(url, headers, controller.signal);
+      bodyChunks = response.body?.[Symbol.asyncIterator]();
+      if (response.status === 429) this.#metrics.rateLimitedRequests++;
+      if (response.status !== 200) throw new validation.ForgeInventoryError(`http-${response.status}`);
+      if (response.headers.get('content-type')?.split(';')[0].trim().toLowerCase() !== 'application/json' || !bodyChunks) throw new validation.ForgeInventoryError('invalid-content-type');
+      const chunks: Uint8Array[] = [];
+      let bytes = 0;
+      while (true) {
+        const result = await bodyChunks.next();
+        if (result.done) break;
+        bytes += result.value.byteLength; this.#metrics.responseBytes += result.value.byteLength;
+        if (bytes > Math.min(maxBytes, this.#options.maxResponseBytes)) throw new validation.ForgeInventoryError('response-size-limit');
+        if (controller.signal.aborted || Date.now() >= deadline) throw new validation.ForgeInventoryError('request-aborted-or-timed-out');
+        chunks.push(result.value);
+      }
+      const text = new TextDecoder('utf-8', { fatal: true }).decode(Buffer.concat(chunks));
+      const body = JSON.parse(text) as unknown;
+      if (controller.signal.aborted || Date.now() >= deadline) throw new validation.ForgeInventoryError('request-aborted-or-timed-out');
+      return { body, headers: response.headers };
+    } catch (error) {
+      if (error instanceof validation.ForgeInventoryError) throw error;
+      throw new validation.ForgeInventoryError(controller.signal.aborted ? 'request-aborted-or-timed-out' : 'request-or-json-failed');
+    } finally {
+      controller.abort(); clearTimeout(timeout); signal?.removeEventListener('abort', abort);
+      // Cancels an unread or partly read body; a completely read one has already released its connection.
+      try { await bodyChunks?.return?.(); } catch { /* The request has already been aborted. */ }
+    }
+  }
+}

package/ts/index.ts

@@ -487,3 +487,4 @@ export class CodeFeed {
 }
 export * from './classes.forgeinventory.js';
 export * from './classes.forgeinventoryscanner.js';
+export * from './classes.giteasourceinventory.js';