@vtex/api 6.45.4

package/lib/service/master.d.ts

@@ -0,0 +1,2 @@
+import { ServiceJSON } from './worker/runtime/typings';
+export declare const startMaster: (service: ServiceJSON) => void;

package/lib/service/master.js

@@ -0,0 +1,91 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const cluster_1 = __importDefault(require("cluster"));
+const os_1 = require("os");
+const constants_1 = require("../constants");
+const logger_1 = require("./logger");
+const listeners_1 = require("./worker/listeners");
+const statusTrack_1 = require("./worker/runtime/statusTrack");
+let handledSignal;
+const onMessage = (worker, message) => {
+    if (logger_1.isLog(message)) {
+        logger_1.logOnceToDevConsole(message.message, message.level);
+    }
+    else if (statusTrack_1.isStatusTrackBroadcast(message)) {
+        statusTrack_1.trackStatus();
+        statusTrack_1.broadcastStatusTrack();
+    }
+    else {
+        listeners_1.logger.warn({
+            content: message,
+            message: 'Worker sent message',
+            pid: worker.process.pid,
+        });
+    }
+};
+const onExit = (worker, code, signal) => {
+    if (!constants_1.LINKED && worker.exitedAfterDisconnect === false) {
+        listeners_1.logger.error({
+            code,
+            message: 'Worker Died',
+            pid: worker.process.pid,
+            signal,
+        });
+        cluster_1.default.fork();
+    }
+    const exitOn = ['SIGTERM', 'SIGINT'];
+    if (handledSignal && exitOn.includes(handledSignal) && Object.keys(cluster_1.default.workers).length === 0) {
+        process.exit(os_1.constants.signals[handledSignal]);
+    }
+};
+let workersOnline = 0;
+const onOnline = (worker) => {
+    console.log('Worker ' + worker.process.pid + ' is listening');
+    workersOnline += 1;
+    if (workersOnline === 1) {
+        worker.send(constants_1.UP_SIGNAL);
+    }
+};
+const GRACEFULLY_SHUTDOWN_TIMEOUT_S = 30;
+const SIGINT_TIMEOUT_S = 1;
+const handleSignal = (timeout) => (signal) => {
+    // Log the Master Process received a signal
+    const message = `Master process ${process.pid} received signal ${signal}`;
+    console.warn(message);
+    listeners_1.logger.warn({ message, signal });
+    // For each worker, let's try to kill it gracefully
+    Object.values(cluster_1.default.workers).forEach((worker) => worker === null || worker === void 0 ? void 0 : worker.kill(signal));
+    // Let's raise the flag to kill the master process after all workers have died
+    handledSignal = signal;
+    // Let's wait for all in-flight requests finish before send any kill signal
+    const waitTimeToForceKill = timeout * 1e3;
+    // Force workers and master to die after a graceful timeout
+    setTimeout(() => {
+        Object.values(cluster_1.default.workers).forEach((worker) => worker === null || worker === void 0 ? void 0 : worker.process.kill('SIGKILL'));
+        process.exit(os_1.constants.signals[signal]);
+    }, waitTimeToForceKill);
+};
+exports.startMaster = (service) => {
+    const { workers: numWorkers, timeout = GRACEFULLY_SHUTDOWN_TIMEOUT_S } = service;
+    if (service.deterministicVary) {
+        process.env.DETERMINISTIC_VARY = 'true';
+    }
+    // Setup dubugger
+    if (constants_1.LINKED) {
+        cluster_1.default.setupMaster({ inspectPort: constants_1.INSPECT_DEBUGGER_PORT });
+    }
+    const shutdownTimeout = Math.max(GRACEFULLY_SHUTDOWN_TIMEOUT_S, timeout);
+    console.log(`Spawning ${numWorkers} workers`);
+    console.log(`Using ${shutdownTimeout} seconds as worker graceful shutdown timeout`);
+    for (let i = 0; i < numWorkers; i++) {
+        cluster_1.default.fork();
+    }
+    cluster_1.default.on('online', onOnline);
+    cluster_1.default.on('exit', onExit);
+    cluster_1.default.on('message', onMessage);
+    process.on('SIGINT', handleSignal(SIGINT_TIMEOUT_S));
+    process.on('SIGTERM', handleSignal(shutdownTimeout));
+};

package/lib/service/tracing/TracerSingleton.d.ts

@@ -0,0 +1,7 @@
+import { Tracer } from 'opentracing';
+export declare class TracerSingleton {
+    static getTracer(): Tracer;
+    private static singleton;
+    private static initServiceTracer;
+    private static createJaegerTracer;
+}

package/lib/service/tracing/TracerSingleton.js

@@ -0,0 +1,54 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const jaeger_client_1 = require("jaeger-client");
+const prom_client_1 = __importDefault(require("prom-client"));
+const constants_1 = require("../../constants");
+const utils_1 = require("../../utils");
+class TracerSingleton {
+    static getTracer() {
+        if (!TracerSingleton.singleton) {
+            TracerSingleton.singleton = TracerSingleton.initServiceTracer();
+        }
+        return TracerSingleton.singleton;
+    }
+    static initServiceTracer() {
+        return TracerSingleton.createJaegerTracer(utils_1.appIdToAppAtMajor(constants_1.APP.ID), {
+            ["app.linked" /* VTEX_APP_LINKED */]: constants_1.LINKED,
+            ["app.node_vtex_api_version" /* VTEX_APP_NODE_VTEX_API_VERSION */]: constants_1.NODE_VTEX_API_VERSION,
+            ["app.production" /* VTEX_APP_PRODUCTION */]: constants_1.PRODUCTION,
+            ["app.region" /* VTEX_APP_REGION */]: constants_1.REGION,
+            ["app.version" /* VTEX_APP_VERSION */]: constants_1.APP.VERSION,
+            ["app.workspace" /* VTEX_APP_WORKSPACE */]: constants_1.WORKSPACE,
+            ["app.node_env" /* VTEX_APP_NODE_ENV */]: constants_1.NODE_ENV !== null && constants_1.NODE_ENV !== void 0 ? constants_1.NODE_ENV : 'undefined',
+        });
+    }
+    static createJaegerTracer(serviceName, defaultTags) {
+        const config = {
+            reporter: {
+                agentHost: process.env.VTEX_OWN_NODE_IP,
+            },
+            sampler: {
+                host: process.env.VTEX_OWN_NODE_IP,
+                param: 0.05,
+                refreshIntervalMs: 60 * 1000,
+                type: 'remote',
+            },
+            serviceName,
+        };
+        const options = {
+            /**
+             * Jaeger metric names are available in:
+             * https://github.com/jaegertracing/jaeger-client-node/blob/master/src/metrics/metrics.js
+             *
+             * Runtime will prefix these metrics with 'runtime:'
+             */
+            metrics: new jaeger_client_1.PrometheusMetricsFactory(prom_client_1.default, 'runtime'),
+            tags: defaultTags,
+        };
+        return jaeger_client_1.initTracer(config, options);
+    }
+}
+exports.TracerSingleton = TracerSingleton;

package/lib/service/tracing/metrics/MetricNames.d.ts

@@ -0,0 +1,60 @@
+declare const enum METRIC_TYPES {
+    /** Counter is monotonic */
+    COUNTER = "counter",
+    /** Gauge is a counter that can be increased and decreased */
+    GAUGE = "gauge",
+    /** Histogram creates a counter timeseries for each bucket specified */
+    HISTOGRAM = "histogram"
+}
+export declare const enum RequestsMetricLabels {
+    /** The status code for the HTTP request */
+    STATUS_CODE = "status_code",
+    /** The service.json handler name for the current request (e.g. 'public-handler:render') */
+    REQUEST_HANDLER = "handler"
+}
+export declare const enum EventLoopMetricLabels {
+    PERCENTILE = "percentile"
+}
+export declare const CONCURRENT_REQUESTS: {
+    name: string;
+    help: string;
+    type: METRIC_TYPES;
+};
+export declare const REQUESTS_TOTAL: {
+    name: string;
+    help: string;
+    labelNames: RequestsMetricLabels[];
+    type: METRIC_TYPES;
+};
+export declare const REQUESTS_ABORTED: {
+    name: string;
+    help: string;
+    labelNames: RequestsMetricLabels[];
+    type: METRIC_TYPES;
+};
+export declare const REQUEST_TIMINGS: {
+    name: string;
+    help: string;
+    labelNames: RequestsMetricLabels[];
+    buckets: number[];
+    type: METRIC_TYPES;
+};
+export declare const REQUEST_RESPONSE_SIZES: {
+    name: string;
+    help: string;
+    labelNames: RequestsMetricLabels[];
+    buckets: number[];
+    type: METRIC_TYPES;
+};
+export declare const BETWEEN_SCRAPES_EVENT_LOOP_LAG_MAX: {
+    name: string;
+    help: string;
+    type: METRIC_TYPES;
+};
+export declare const BETWEEN_SCRAPES_EVENT_LOOP_LAG_PERCENTILES: {
+    name: string;
+    help: string;
+    labelNames: EventLoopMetricLabels[];
+    type: METRIC_TYPES;
+};
+export {};

package/lib/service/tracing/metrics/MetricNames.js

@@ -0,0 +1,44 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CONCURRENT_REQUESTS = {
+    name: 'io_http_requests_current',
+    help: 'The current number of requests in course.',
+    type: "gauge" /* GAUGE */,
+};
+exports.REQUESTS_TOTAL = {
+    name: 'runtime_http_requests_total',
+    help: 'The total number of HTTP requests.',
+    labelNames: ["status_code" /* STATUS_CODE */, "handler" /* REQUEST_HANDLER */],
+    type: "counter" /* COUNTER */,
+};
+exports.REQUESTS_ABORTED = {
+    name: 'runtime_http_aborted_requests_total',
+    help: 'The total number of HTTP requests aborted.',
+    labelNames: ["handler" /* REQUEST_HANDLER */],
+    type: "counter" /* COUNTER */,
+};
+exports.REQUEST_TIMINGS = {
+    name: 'runtime_http_requests_duration_milliseconds',
+    help: 'The incoming http requests total duration.',
+    labelNames: ["handler" /* REQUEST_HANDLER */],
+    buckets: [10, 20, 40, 80, 160, 320, 640, 1280, 2560, 5120],
+    type: "histogram" /* HISTOGRAM */,
+};
+exports.REQUEST_RESPONSE_SIZES = {
+    name: 'runtime_http_response_size_bytes',
+    help: `The outgoing response sizes (only applicable when the response isn't a stream).`,
+    labelNames: ["handler" /* REQUEST_HANDLER */],
+    buckets: [500, 2000, 8000, 16000, 64000, 256000, 1024000, 4096000],
+    type: "histogram" /* HISTOGRAM */,
+};
+exports.BETWEEN_SCRAPES_EVENT_LOOP_LAG_MAX = {
+    name: 'runtime_event_loop_lag_max_between_scrapes_seconds',
+    help: 'The max event loop lag that occurred between this and the previous scrape',
+    type: "gauge" /* GAUGE */,
+};
+exports.BETWEEN_SCRAPES_EVENT_LOOP_LAG_PERCENTILES = {
+    name: 'runtime_event_loop_lag_percentiles_between_scrapes_seconds',
+    help: 'Event loop lag percentiles from the observations that occurred between this and the previous scrape',
+    labelNames: ["percentile" /* PERCENTILE */],
+    type: "gauge" /* GAUGE */,
+};

package/lib/service/tracing/metrics/instruments.d.ts

@@ -0,0 +1,9 @@
+import { Counter, Gauge, Histogram } from 'prom-client';
+export { EventLoopMetricLabels, RequestsMetricLabels } from './MetricNames';
+export declare const createTotalRequestsInstrument: () => Counter<import("./MetricNames").RequestsMetricLabels>;
+export declare const createTotalAbortedRequestsInstrument: () => Counter<import("./MetricNames").RequestsMetricLabels>;
+export declare const createRequestsTimingsInstrument: () => Histogram<import("./MetricNames").RequestsMetricLabels>;
+export declare const createRequestsResponseSizesInstrument: () => Histogram<import("./MetricNames").RequestsMetricLabels>;
+export declare const createConcurrentRequestsInstrument: () => Gauge<string>;
+export declare const createEventLoopLagMaxInstrument: () => Gauge<string>;
+export declare const createEventLoopLagPercentilesInstrument: () => Gauge<import("./MetricNames").EventLoopMetricLabels>;

package/lib/service/tracing/metrics/instruments.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const prom_client_1 = require("prom-client");
+const MetricNames_1 = require("./MetricNames");
+exports.createTotalRequestsInstrument = () => new prom_client_1.Counter(MetricNames_1.REQUESTS_TOTAL);
+exports.createTotalAbortedRequestsInstrument = () => new prom_client_1.Counter(MetricNames_1.REQUESTS_ABORTED);
+exports.createRequestsTimingsInstrument = () => new prom_client_1.Histogram(MetricNames_1.REQUEST_TIMINGS);
+exports.createRequestsResponseSizesInstrument = () => new prom_client_1.Histogram(MetricNames_1.REQUEST_RESPONSE_SIZES);
+exports.createConcurrentRequestsInstrument = () => new prom_client_1.Gauge(MetricNames_1.CONCURRENT_REQUESTS);
+exports.createEventLoopLagMaxInstrument = () => new prom_client_1.Gauge(MetricNames_1.BETWEEN_SCRAPES_EVENT_LOOP_LAG_MAX);
+exports.createEventLoopLagPercentilesInstrument = () => new prom_client_1.Gauge(MetricNames_1.BETWEEN_SCRAPES_EVENT_LOOP_LAG_PERCENTILES);

package/lib/service/tracing/metrics/measurers/EventLoopLagMeasurer.d.ts

@@ -0,0 +1,9 @@
+export declare class EventLoopLagMeasurer {
+    private eventLoopDelayMonitor;
+    private percentilesInstrument;
+    private maxInstrument;
+    constructor();
+    start(): void;
+    updateInstrumentsAndReset(): Promise<void>;
+    private setPercentileObservation;
+}

package/lib/service/tracing/metrics/measurers/EventLoopLagMeasurer.js

@@ -0,0 +1,25 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const perf_hooks_1 = require("perf_hooks");
+const utils_1 = require("../../../../utils");
+const instruments_1 = require("../instruments");
+class EventLoopLagMeasurer {
+    constructor() {
+        this.eventLoopDelayMonitor = perf_hooks_1.monitorEventLoopDelay({ resolution: 10 });
+        this.percentilesInstrument = instruments_1.createEventLoopLagPercentilesInstrument();
+        this.maxInstrument = instruments_1.createEventLoopLagMaxInstrument();
+    }
+    start() {
+        this.eventLoopDelayMonitor.enable();
+    }
+    async updateInstrumentsAndReset() {
+        this.maxInstrument.set(utils_1.nanosecondsToSeconds(this.eventLoopDelayMonitor.max));
+        this.setPercentileObservation(95);
+        this.setPercentileObservation(99);
+        this.eventLoopDelayMonitor.reset();
+    }
+    setPercentileObservation(percentile) {
+        this.percentilesInstrument.set({ ["percentile" /* PERCENTILE */]: percentile }, utils_1.nanosecondsToSeconds(this.eventLoopDelayMonitor.percentile(percentile)));
+    }
+}
+exports.EventLoopLagMeasurer = EventLoopLagMeasurer;

package/lib/service/tracing/tracingMiddlewares.d.ts

@@ -0,0 +1,5 @@
+import { Tracer } from 'opentracing';
+import { ServiceContext } from '../worker/runtime/typings';
+export declare const addTracingMiddleware: (tracer: Tracer) => (ctx: ServiceContext<import("../..").IOClients, import("../worker/runtime/typings").RecorderState, import("../worker/runtime/typings").ParamsContext>, next: () => Promise<void>) => Promise<void>;
+export declare const nameSpanOperationMiddleware: (operationType: string, operationName: string) => (ctx: ServiceContext<import("../..").IOClients, import("../worker/runtime/typings").RecorderState, import("../worker/runtime/typings").ParamsContext>, next: () => Promise<void>) => Promise<void>;
+export declare const traceUserLandRemainingPipelineMiddleware: () => (ctx: ServiceContext<import("../..").IOClients, import("../worker/runtime/typings").RecorderState, import("../worker/runtime/typings").ParamsContext>, next: () => Promise<void>) => Promise<void>;

package/lib/service/tracing/tracingMiddlewares.js

@@ -0,0 +1,119 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const opentracing_1 = require("opentracing");
+const stream_1 = require("stream");
+const constants_1 = require("../../constants");
+const tracing_1 = require("../../tracing");
+const Tags_1 = require("../../tracing/Tags");
+const utils_1 = require("../../tracing/utils");
+const utils_2 = require("../../utils");
+const instruments_1 = require("./metrics/instruments");
+const PATHS_BLACKLISTED_FOR_TRACING = ['/_status', '/healthcheck'];
+exports.addTracingMiddleware = (tracer) => {
+    const concurrentRequests = instruments_1.createConcurrentRequestsInstrument();
+    const requestTimings = instruments_1.createRequestsTimingsInstrument();
+    const totalRequests = instruments_1.createTotalRequestsInstrument();
+    const responseSizes = instruments_1.createRequestsResponseSizesInstrument();
+    const abortedRequests = instruments_1.createTotalAbortedRequestsInstrument();
+    return async function addTracing(ctx, next) {
+        var _a;
+        const start = process.hrtime();
+        concurrentRequests.inc(1);
+        if (PATHS_BLACKLISTED_FOR_TRACING.includes(ctx.request.path)) {
+            await next();
+            concurrentRequests.dec(1);
+            return;
+        }
+        const rootSpan = tracer.extract(opentracing_1.FORMAT_HTTP_HEADERS, ctx.request.headers);
+        const currentSpan = tracer.startSpan('unknown-operation', {
+            childOf: rootSpan,
+            tags: { [Tags_1.OpentracingTags.SPAN_KIND]: Tags_1.OpentracingTags.SPAN_KIND_RPC_SERVER },
+        });
+        const initialSamplingDecision = tracing_1.getTraceInfo(currentSpan).isSampled;
+        ctx.tracing = { currentSpan, tracer };
+        ctx.req.once('aborted', () => abortedRequests.inc({ ["handler" /* REQUEST_HANDLER */]: currentSpan.operationName }, 1));
+        let responseClosed = false;
+        ctx.res.once('close', () => (responseClosed = true));
+        try {
+            await next();
+        }
+        catch (err) {
+            tracing_1.ErrorReport.create({ originalError: err }).injectOnSpan(currentSpan, (_a = ctx.vtex) === null || _a === void 0 ? void 0 : _a.logger);
+            throw err;
+        }
+        finally {
+            const responseLength = ctx.response.length;
+            if (responseLength) {
+                responseSizes.observe({ ["handler" /* REQUEST_HANDLER */]: currentSpan.operationName }, responseLength);
+            }
+            totalRequests.inc({
+                ["handler" /* REQUEST_HANDLER */]: currentSpan.operationName,
+                ["status_code" /* STATUS_CODE */]: ctx.response.status,
+            }, 1);
+            const traceInfo = tracing_1.getTraceInfo(currentSpan);
+            if (traceInfo.isSampled) {
+                if (!initialSamplingDecision) {
+                    currentSpan.setTag(Tags_1.OpentracingTags.SPAN_KIND, Tags_1.OpentracingTags.SPAN_KIND_RPC_SERVER);
+                }
+                currentSpan.addTags({
+                    [Tags_1.OpentracingTags.HTTP_URL]: ctx.request.href,
+                    [Tags_1.OpentracingTags.HTTP_METHOD]: ctx.request.method,
+                    [Tags_1.OpentracingTags.HTTP_STATUS_CODE]: ctx.response.status,
+                    ["http.path" /* HTTP_PATH */]: ctx.request.path,
+                    ["vtex.request_id" /* VTEX_REQUEST_ID */]: ctx.get(constants_1.REQUEST_ID_HEADER),
+                    ["vtex.incoming.workspace" /* VTEX_WORKSPACE */]: ctx.get(constants_1.WORKSPACE_HEADER),
+                    ["vtex.incoming.account" /* VTEX_ACCOUNT */]: ctx.get(constants_1.ACCOUNT_HEADER),
+                });
+                currentSpan.log(utils_1.cloneAndSanitizeHeaders(ctx.request.headers, 'req.headers.'));
+                currentSpan.log(utils_1.cloneAndSanitizeHeaders(ctx.response.headers, 'res.headers.'));
+                ctx.set(constants_1.TRACE_ID_HEADER, traceInfo.traceId);
+            }
+            const onResFinished = () => {
+                requestTimings.observe({
+                    ["handler" /* REQUEST_HANDLER */]: currentSpan.operationName,
+                }, utils_2.hrToMillisFloat(process.hrtime(start)));
+                concurrentRequests.dec(1);
+                currentSpan.finish();
+            };
+            if (responseClosed) {
+                onResFinished();
+            }
+            else {
+                stream_1.finished(ctx.res, onResFinished);
+            }
+        }
+    };
+};
+exports.nameSpanOperationMiddleware = (operationType, operationName) => {
+    return function nameSpanOperation(ctx, next) {
+        var _a;
+        (_a = ctx.tracing) === null || _a === void 0 ? void 0 : _a.currentSpan.setOperationName(`${operationType}:${operationName}`);
+        return next();
+    };
+};
+exports.traceUserLandRemainingPipelineMiddleware = () => {
+    return async function traceUserLandRemainingPipeline(ctx, next) {
+        const tracingCtx = ctx.tracing;
+        ctx.tracing = undefined;
+        const span = tracingCtx.currentSpan;
+        const userLandTracer = ctx.vtex.tracer;
+        userLandTracer.setFallbackSpan(span);
+        userLandTracer.lockFallbackSpan();
+        const startTime = process.hrtime();
+        try {
+            span.log({ event: "user-middlewares-start" /* USER_MIDDLEWARES_START */ });
+            await next();
+        }
+        catch (err) {
+            tracing_1.ErrorReport.create({ originalError: err }).injectOnSpan(span, ctx.vtex.logger);
+            throw err;
+        }
+        finally {
+            span.log({
+                event: "user-middlewares-finish" /* USER_MIDDLEWARES_FINISH */,
+                ["user-middlewares-duration" /* USER_MIDDLEWARES_DURATION */]: utils_2.hrToMillis(process.hrtime(startTime)),
+            });
+            ctx.tracing = tracingCtx;
+        }
+    };
+};