Press n or j to go to the next uncovered block, b, p or k for the previous block.
| 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 | 1x 20x 20x 20x 20x 20x 20x 20x 20x 20x 3x 3x 3x 3x 20x 1x 20x 1x 20x 1x 20x 1x 20x 1x 20x 1x 1x 20x 1x 20x 20x 2x 20x 2x 20x 20x 20x 19x 19x 19x | /**
* Runtime substrate factory.
*
* Wires together connectivity detection, adaptive API client,
* resilience primitives, and telemetry into a single surface.
*/
import { createApiClient, type ApiClientOptions, type IApiClient } from '@gtcx/api-client';
import {
ConnectivityDetector,
createAdaptiveClientOptions,
createOfflineHandlerFromDetector,
type ConnectivityDetectorOptions,
} from '@gtcx/connectivity';
import { createLogger, type Logger } from '@gtcx/logging';
import {
createCircuitBreaker,
createBulkhead,
type CircuitBreaker,
type Bulkhead,
} from '@gtcx/resilience';
import {
createNoopTracer,
createOtelTracer,
createInMemoryMetricsCollector,
PrometheusMetricsCollector,
type MetricsCollector,
type SpanContext,
type Tracer,
} from '@gtcx/telemetry';
/** Runtime deployment target. */
export type DeploymentProfile = 'edge' | 'satellite' | 'standard' | 'test';
/** Substrate configuration. */
export interface RuntimeOptions {
/** Base URL for API requests. */
baseUrl: string;
/** Deployment profile — influences defaults. */
deployment?: DeploymentProfile;
/** Optional request signer. */
signer?: ApiClientOptions['signer'];
/** Custom fetcher (for testing or undici). */
fetcher?: ApiClientOptions['fetcher'];
/** Connectivity detector options. */
connectivity?: ConnectivityDetectorOptions;
/** Enable connectivity-driven offline queueing. */
offlineQueue?: boolean;
/** Enable circuit breaker on the API client. */
circuitBreaker?: boolean;
/** Enable bulkhead (concurrency limiting) on the API client. */
bulkhead?: boolean;
/** Telemetry mode. */
telemetry?: 'none' | 'in-memory' | 'prometheus' | 'otel';
/** Service name for telemetry. */
serviceName?: string;
/** Initial trace context. */
traceContext?: SpanContext | (() => SpanContext | undefined);
/** Request/response interceptors. */
interceptors?: ApiClientOptions['interceptors'];
/** Custom logger; if omitted, a default logger is created. */
logger?: Logger;
/** Extra headers sent on every request. */
headers?: Record<string, string>;
}
/** The runtime substrate surface. */
export interface Runtime {
/** Pre-configured API client. */
client: IApiClient;
/** Connectivity detector. */
connectivity: ConnectivityDetector;
/** Circuit breaker (if enabled). */
circuitBreaker?: CircuitBreaker | undefined;
/** Bulkhead (if enabled). */
bulkhead?: Bulkhead | undefined;
/** Metrics collector. */
metrics: MetricsCollector;
/** Tracer. */
tracer: Tracer;
/** Logger. */
logger: Logger;
/** Clean up timers, listeners, and resources. */
destroy(): void;
}
const DEPLOYMENT_OVERRIDES: Record<
DeploymentProfile,
Partial<ApiClientOptions & { telemetry: RuntimeOptions['telemetry'] }>
> = {
edge: { timeout: 60_000, retries: 1, telemetry: 'in-memory' },
satellite: { timeout: 120_000, retries: 5, telemetry: 'in-memory' },
standard: { timeout: 30_000, retries: 3, telemetry: 'prometheus' },
test: { timeout: 5_000, retries: 0, telemetry: 'none' },
};
/** Create a batteries-included runtime substrate. */
export function createRuntime(options: RuntimeOptions): Runtime {
const deployment = options.deployment ?? 'standard';
const overrides = DEPLOYMENT_OVERRIDES[deployment];
const logger = options.logger ?? createLogger({ service: options.serviceName ?? 'gtcx-runtime' });
// Connectivity
const connectivity = new ConnectivityDetector(options.connectivity);
// Telemetry
const telemetryMode = options.telemetry ?? overrides.telemetry ?? 'none';
const metrics: MetricsCollector =
telemetryMode === 'prometheus'
? new PrometheusMetricsCollector()
: createInMemoryMetricsCollector();
const tracer: Tracer = telemetryMode === 'otel' ? createOtelTracer() : createNoopTracer();
// Build API client options — avoid spreading undefined values under exactOptionalPropertyTypes
const baseClientOptions: ApiClientOptions = { baseUrl: options.baseUrl };
if (options.deployment) {
Eif (overrides.timeout !== undefined) {
baseClientOptions.timeout = overrides.timeout;
}
Eif (overrides.retries !== undefined) {
baseClientOptions.retries = overrides.retries;
}
}
if (options.headers !== undefined) {
baseClientOptions.headers = options.headers;
}
if (options.signer !== undefined) {
baseClientOptions.signer = options.signer;
}
if (options.fetcher !== undefined) {
baseClientOptions.fetcher = options.fetcher;
}
if (options.interceptors !== undefined) {
baseClientOptions.interceptors = options.interceptors;
}
if (options.traceContext !== undefined) {
baseClientOptions.traceContext = options.traceContext;
}
baseClientOptions.telemetry = {
onRequestStart(ctx) {
metrics.counter('http_requests_total', { method: ctx.method }).increment();
logger.debug('request start', ctx);
},
onRequestComplete(ctx) {
metrics
.counter('http_responses_total', { method: ctx.method, status: String(ctx.status) })
.increment();
metrics
.histogram('http_request_duration_ms', [10, 50, 100, 250, 500, 1000, 2500, 5000, 10000], {
method: ctx.method,
})
.observe(ctx.durationMs);
logger.debug('request complete', ctx);
},
onRequestError(ctx) {
metrics
.counter('http_errors_total', { method: ctx.method, retryable: String(ctx.retryable) })
.increment();
logger.warn('request error', {
...ctx,
error: (ctx.error as Error)?.message ?? String(ctx.error),
});
},
};
if (options.offlineQueue) {
baseClientOptions.offline = createOfflineHandlerFromDetector(connectivity);
}
// Adapt options to connectivity profile
const adaptive = createAdaptiveClientOptions(connectivity, baseClientOptions);
// Resilience primitives
let circuitBreaker: CircuitBreaker | undefined;
let bulkhead: Bulkhead | undefined;
if (options.circuitBreaker) {
circuitBreaker = createCircuitBreaker({
failureThreshold: 5,
resetTimeoutMs: 30_000,
});
}
if (options.bulkhead) {
bulkhead = createBulkhead({ maxConcurrent: 10, maxQueue: 50 });
}
// Create the API client with the adaptive options.
const client = createApiClient(adaptive.options);
// Start connectivity checks
connectivity.start();
return {
client,
connectivity,
circuitBreaker,
bulkhead,
metrics,
tracer,
logger,
destroy() {
connectivity.destroy();
adaptive.unsubscribe();
circuitBreaker?.reset();
},
};
}
|