@vtex/api 6.48.0 → 6.48.1-beta

package/lib/clients/janus/Segment.js

@@ -1,88 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const cookie_1 = __importDefault(require("cookie"));
-const ramda_1 = require("ramda");
-const constants_1 = require("../../constants");
-const HttpClient_1 = require("../../HttpClient");
-const JanusClient_1 = require("./JanusClient");
-const SEGMENT_COOKIE = 'vtex_segment';
-const SEGMENT_MAX_AGE_S = 60 * 60; // 60 minutes - segment is actually immutable
-const ALLOWED_QUERY_PREFIXES = ['utm', 'cultureInfo', 'supportedLocales', '__bindingId'];
-const filterAndSortQuery = (query) => {
-    if (!query) {
-        return null;
-    }
-    const filteredKeys = Object.keys(query)
-        .filter((k) => !!k && ALLOWED_QUERY_PREFIXES.some((prefix) => k.startsWith(prefix)))
-        .sort();
-    return filteredKeys.reduce((acc, val) => {
-        acc[val] = query[val];
-        return acc;
-    }, {});
-};
-const routes = {
-    base: '/api/segments',
-    segments: (token) => (token ? `${routes.base}/${token}` : routes.base),
-};
-class Segment extends JanusClient_1.JanusClient {
-    constructor() {
-        super(...arguments);
-        /**
-         * Get the segment data using the current `ctx.vtex.segmentToken`
-         *
-         * @memberof Segment
-         */
-        this.getSegment = (tracingConfig) => this.rawSegment(this.context.segmentToken, undefined, tracingConfig).then(ramda_1.prop('data'));
-        /**
-         * Get the segment data from this specific segment token
-         *
-         * @memberof Segment
-         */
-        this.getSegmentByToken = (token, tracingConfig) => this.rawSegment(token, undefined, tracingConfig).then(ramda_1.prop('data'));
-        this.getOrCreateSegment = async (query, token, tracingConfig) => {
-            const { data: segmentData, headers } = await this.rawSegment(token, query, tracingConfig);
-            return {
-                segmentData,
-                segmentToken: extractSegmentCookie(headers),
-            };
-        };
-        this.rawSegment = (token, query, tracingConfig) => {
-            const { product, workspace } = this.context;
-            const filteredQuery = filterAndSortQuery(query);
-            const metric = token ? 'segment-get-token' : 'segment-get-new';
-            return this.http.getRaw(routes.segments(token), {
-                forceMaxAge: SEGMENT_MAX_AGE_S,
-                headers: {
-                    'Content-Type': 'application/json',
-                    [constants_1.PRODUCT_HEADER]: product || '',
-                },
-                inflightKey: HttpClient_1.inflightUrlWithQuery,
-                metric,
-                params: {
-                    ...filteredQuery,
-                    session_path: product || '',
-                    workspace,
-                },
-                tracing: {
-                    requestSpanNameSuffix: metric,
-                    ...tracingConfig === null || tracingConfig === void 0 ? void 0 : tracingConfig.tracing,
-                },
-            });
-        };
-    }
-}
-exports.Segment = Segment;
-function extractSegmentCookie(headers) {
-    var _a;
-    for (const setCookie of (_a = headers['set-cookie']) !== null && _a !== void 0 ? _a : []) {
-        const parsedCookie = cookie_1.default.parse(setCookie);
-        const segmentCookie = parsedCookie[SEGMENT_COOKIE];
-        if (segmentCookie != null) {
-            return segmentCookie;
-        }
-    }
-    return null;
-}

package/lib/clients/janus/Tenant.js

@@ -1,28 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const HttpClient_1 = require("../../HttpClient");
-const JanusClient_1 = require("./JanusClient");
-class TenantClient extends JanusClient_1.JanusClient {
-    constructor(ctx, opts) {
-        super(ctx, {
-            ...opts,
-            params: {
-                q: ctx.account,
-            },
-        });
-        this.info = (config) => {
-            const metric = 'get-tenant-info';
-            return this.http.get('/api/tenant/tenants', {
-                inflightKey: HttpClient_1.inflightUrlWithQuery,
-                memoizeable: true,
-                metric,
-                ...config,
-                tracing: {
-                    requestSpanNameSuffix: metric,
-                    ...config === null || config === void 0 ? void 0 : config.tracing,
-                },
-            });
-        };
-    }
-}
-exports.TenantClient = TenantClient;

package/lib/clients/janus/index.d.ts

@@ -1,5 +0,0 @@
-export * from './JanusClient';
-export * from './LicenseManager';
-export * from './Segment';
-export * from './Session';
-export * from './Tenant';

package/lib/clients/janus/index.js

@@ -1,10 +0,0 @@
-"use strict";
-function __export(m) {
-    for (var p in m) if (!exports.hasOwnProperty(p)) exports[p] = m[p];
-}
-Object.defineProperty(exports, "__esModule", { value: true });
-__export(require("./JanusClient"));
-__export(require("./LicenseManager"));
-__export(require("./Segment"));
-__export(require("./Session"));
-__export(require("./Tenant"));

package/lib/service/index.d.ts

@@ -1,2 +0,0 @@
-export declare const startApp: () => void;
-export { appPath } from './loaders';

package/lib/service/index.js

@@ -1,30 +0,0 @@
-"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 constants_1 = require("../constants");
-const loaders_1 = require("./loaders");
-const logger_1 = require("./logger");
-const master_1 = require("./master");
-const worker_1 = require("./worker");
-exports.startApp = () => {
-    const serviceJSON = loaders_1.getServiceJSON();
-    try {
-        // if it is a master process then call setting up worker process
-        if (cluster_1.default.isMaster) {
-            master_1.startMaster(serviceJSON);
-        }
-        else {
-            // to setup server configurations and share port address for incoming requests
-            worker_1.startWorker(serviceJSON).listen(constants_1.HTTP_SERVER_PORT);
-        }
-    }
-    catch (err) {
-        logger_1.logOnceToDevConsole(err.stack || err.message, logger_1.LogLevel.Error);
-        process.exit(2);
-    }
-};
-var loaders_2 = require("./loaders");
-exports.appPath = loaders_2.appPath;

package/lib/service/loaders.d.ts

@@ -1,8 +0,0 @@
-import { IOClients } from '../clients/IOClients';
-import { Service } from './worker/runtime/Service';
-import { ParamsContext, RecorderState, ServiceJSON } from './worker/runtime/typings';
-export declare const appPath: string;
-export declare const bundlePath: string;
-export declare const serviceJsonPath: string;
-export declare const getServiceJSON: () => ServiceJSON;
-export declare const getService: () => Service<IOClients, RecorderState, ParamsContext>;

package/lib/service/loaders.js

@@ -1,54 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const os_1 = require("os");
-const path_1 = require("path");
-const IOClients_1 = require("../clients/IOClients");
-const constants_1 = require("../constants");
-exports.appPath = path_1.join(process.cwd(), './service/src/node/');
-exports.bundlePath = path_1.join(exports.appPath, 'index');
-exports.serviceJsonPath = path_1.join(process.cwd(), './service/service.json');
-const getWorkers = (workers) => {
-    // We need to have only one worker while linking so the debugger
-    // works properly
-    if (constants_1.LINKED) {
-        return 1;
-    }
-    // If user didn't set workers property, let's use the cpu count
-    const workersFromUser = workers && Number.isInteger(workers) ? workers : os_1.cpus().length;
-    // never spawns more than MAX_WORKERS
-    return Math.min(workersFromUser, constants_1.MAX_WORKERS);
-};
-exports.getServiceJSON = () => {
-    const service = require(exports.serviceJsonPath);
-    return {
-        ...service,
-        workers: getWorkers(service.workers),
-    };
-};
-const defaultClients = {
-    options: {
-        messages: {
-            concurrency: 10,
-            retries: 2,
-            timeout: 1000,
-        },
-        messagesGraphQL: {
-            concurrency: 12,
-            retries: 2,
-            timeout: 2000,
-        },
-    },
-};
-exports.getService = () => {
-    var _a;
-    const { default: service } = require(exports.bundlePath);
-    const { config: { clients } } = service;
-    service.config.clients = {
-        implementation: (_a = clients === null || clients === void 0 ? void 0 : clients.implementation) !== null && _a !== void 0 ? _a : IOClients_1.IOClients,
-        options: {
-            ...defaultClients.options,
-            ...clients === null || clients === void 0 ? void 0 : clients.options,
-        },
-    };
-    return service;
-};

package/lib/service/logger/console.d.ts

@@ -1,10 +0,0 @@
-import { LogLevel } from './logger';
-export interface LogMessage {
-    cmd: typeof LOG_ONCE;
-    message: string;
-    level: LogLevel;
-}
-export declare const LOG_ONCE = "logOnce";
-export declare const isLog: (message: any) => message is LogMessage;
-export declare const log: (message: any, level: LogLevel) => void;
-export declare const logOnceToDevConsole: (message: any, level: LogLevel) => void;

package/lib/service/logger/console.js

@@ -1,36 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const cluster_1 = require("cluster");
-const caches_1 = require("../../caches");
-const history = new caches_1.LRUCache({
-    max: 42,
-});
-exports.LOG_ONCE = 'logOnce';
-exports.isLog = (message) => (message === null || message === void 0 ? void 0 : message.cmd) === exports.LOG_ONCE;
-exports.log = (message, level) => {
-    const logger = console[level];
-    if (typeof logger === 'function') {
-        logger(message);
-    }
-};
-// Since we are now using clusters, if we simply console.log something,
-// it may overwhelm the programmer's console with lots of repeated info.
-// This function should be used when you want to warn about something
-// only once
-exports.logOnceToDevConsole = (message, level) => {
-    const strigified = JSON.stringify(message);
-    if (!history.has(strigified)) {
-        history.set(strigified, true);
-        if (cluster_1.isMaster) {
-            exports.log(message, level);
-        }
-        else if (cluster_1.isWorker && process.send) {
-            const logMessage = {
-                cmd: exports.LOG_ONCE,
-                level,
-                message,
-            };
-            process.send(logMessage);
-        }
-    }
-};

package/lib/service/logger/logger.d.ts

@@ -1,29 +0,0 @@
-import { IUserLandTracer } from '../../tracing';
-import { IOContext } from '../worker/runtime/typings';
-export interface LoggerTracingContext {
-    requestTracer: IUserLandTracer;
-}
-export declare enum LogLevel {
-    Debug = "debug",
-    Info = "info",
-    Warn = "warn",
-    Error = "error"
-}
-interface LoggerContext extends Pick<IOContext, 'account' | 'workspace' | 'requestId' | 'operationId' | 'production'> {
-    tracer?: IOContext['tracer'];
-}
-export declare class Logger {
-    private account;
-    private workspace;
-    private operationId;
-    private requestId;
-    private production;
-    private tracingState?;
-    constructor(ctx: LoggerContext);
-    debug: (message: any) => void;
-    info: (message: any) => void;
-    warn: (warning: any) => void;
-    error: (error: any) => void;
-    log: (message: any, level: LogLevel) => void;
-}
-export {};

package/lib/service/logger/logger.js

@@ -1,61 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const constants_1 = require("../../constants");
-const error_1 = require("../../utils/error");
-const log_1 = require("../../utils/log");
-const linked = !!process.env.VTEX_APP_LINK;
-const app = constants_1.APP.ID;
-const EMPTY_MESSAGE = 'Logger.log was called with null or undefined message';
-var LogLevel;
-(function (LogLevel) {
-    LogLevel["Debug"] = "debug";
-    LogLevel["Info"] = "info";
-    LogLevel["Warn"] = "warn";
-    LogLevel["Error"] = "error";
-})(LogLevel = exports.LogLevel || (exports.LogLevel = {}));
-class Logger {
-    constructor(ctx) {
-        this.debug = (message) => this.log(message, LogLevel.Debug);
-        this.info = (message) => this.log(message, LogLevel.Info);
-        this.warn = (warning) => this.log(warning, LogLevel.Warn);
-        this.error = (error) => this.log(error, LogLevel.Error);
-        this.log = (message, level) => {
-            var _a;
-            const data = message ? error_1.cleanError(message) : EMPTY_MESSAGE;
-            log_1.cleanLog(data);
-            /* tslint:disable:object-literal-sort-keys */
-            const inflatedLog = {
-                __VTEX_IO_LOG: true,
-                level,
-                app,
-                account: this.account,
-                workspace: this.workspace,
-                production: this.production,
-                data,
-                operationId: this.operationId,
-                requestId: this.requestId,
-                ...(((_a = this.tracingState) === null || _a === void 0 ? void 0 : _a.isTraceSampled) ? { traceId: this.tracingState.traceId } : null),
-            };
-            // Mark third-party apps logs to send to skidder
-            if (constants_1.APP.IS_THIRD_PARTY()) {
-                Object.assign(inflatedLog, {
-                    __SKIDDER_TOPIC_1: `skidder.vendor.${constants_1.APP.VENDOR}`,
-                    __SKIDDER_TOPIC_2: `skidder.app.${constants_1.APP.VENDOR}.${constants_1.APP.NAME}`,
-                });
-            }
-            console.log(JSON.stringify(inflatedLog));
-        };
-        this.account = ctx.account;
-        this.workspace = ctx.workspace;
-        this.requestId = ctx.requestId;
-        this.operationId = ctx.operationId;
-        this.production = ctx.production;
-        if (ctx.tracer) {
-            this.tracingState = {
-                isTraceSampled: ctx.tracer.isTraceSampled,
-                traceId: ctx.tracer.traceId,
-            };
-        }
-    }
-}
-exports.Logger = Logger;

package/lib/service/logger/metricsLogger.d.ts

@@ -1,40 +0,0 @@
-/// <reference types="node" />
-interface ProcessEnv {
-    appName: string;
-    appVersion: string;
-    region: string;
-    vendor: string;
-    production: boolean;
-}
-interface Key {
-    name: string;
-}
-interface Metric {
-    Count: number;
-    Data: {
-        key: Key;
-        processEnv: ProcessEnv;
-        summary: NumericSummary | NodeJS.MemoryUsage | NodeJS.CpuUsage;
-    };
-    Max: number;
-    Min: number;
-    Name: string;
-    Sum: number;
-    Timestamp: number;
-    Unit: string;
-}
-interface NumericSummary {
-    count: number;
-    max: number;
-    median: number;
-    min: number;
-    percentile95: number;
-    percentile99: number;
-    sum: number;
-}
-export declare class MetricsLogger {
-    add: (key: Key, value: number) => void;
-    getSummaries: () => Metric[];
-    constructor();
-}
-export {};

package/lib/service/logger/metricsLogger.js

@@ -1,149 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const fast_json_stable_stringify_1 = __importDefault(require("fast-json-stable-stringify"));
-const ramda_1 = require("ramda");
-const stats_lite_1 = require("stats-lite");
-const constants_1 = require("../../constants");
-const diff_1 = require("../worker/runtime/utils/diff");
-const runtimeBaseDefaultMetricNames = ['routeStats'];
-const runtimeNodeDefaultMetricNames = {
-    cpuUsage: 'cpuUsage',
-    memoryUsage: 'memoryUsage',
-};
-const invalidMetricNames = runtimeBaseDefaultMetricNames.concat(Object.values(runtimeNodeDefaultMetricNames));
-class MetricsLogger {
-    constructor() {
-        //////////////////////
-        // private attributes
-        //////////////////////
-        let samples = {};
-        let lastCpu = diff_1.cpuSnapshot();
-        //////////////////////
-        // private methods definitions
-        //////////////////////
-        const summaries = ramda_1.compose(ramda_1.reject(ramda_1.isNil), ramda_1.values, ramda_1.mapObjIndexed(getSummary));
-        function getDefaultStoredashProperties() {
-            return {
-                Count: 1,
-                Max: 0,
-                Min: 0,
-                Name: 'runtime',
-                Sum: 0,
-                Timestamp: (new Date()).getTime(),
-                Unit: '',
-            };
-        }
-        function getProcessEnv() {
-            return {
-                appName: process.env.VTEX_APP_NAME || '',
-                appVersion: process.env.VTEX_APP_VERSION || '',
-                production: constants_1.PRODUCTION,
-                region: process.env.VTEX_REGION || '',
-                vendor: process.env.VTEX_APP_VENDOR || '',
-            };
-        }
-        function getCpuUsage() {
-            const cpu = diff_1.cpuSnapshot();
-            const cpuDiff = diff_1.snapshotDiff(cpu, lastCpu);
-            lastCpu = cpu;
-            const metric = {
-                Data: {
-                    key: {
-                        name: runtimeNodeDefaultMetricNames.cpuUsage,
-                    },
-                    processEnv: getProcessEnv(),
-                    summary: cpuDiff,
-                },
-                ...getDefaultStoredashProperties(),
-            };
-            return metric;
-        }
-        function getMemoryUsage() {
-            const metric = {
-                Data: {
-                    key: {
-                        name: runtimeNodeDefaultMetricNames.memoryUsage,
-                    },
-                    processEnv: getProcessEnv(),
-                    summary: process.memoryUsage(),
-                },
-                ...getDefaultStoredashProperties(),
-            };
-            return metric;
-        }
-        function getRuntimeSummaries() {
-            return [getCpuUsage(), getMemoryUsage()];
-        }
-        function getSummary(vals, strKey) {
-            if (strKey in samples) {
-                const summary = getNumericSummary(vals);
-                const keyObj = JSON.parse(strKey);
-                const metric = {
-                    Data: {
-                        key: keyObj,
-                        processEnv: getProcessEnv(),
-                        summary,
-                    },
-                    ...getDefaultStoredashProperties(),
-                };
-                return metric;
-            }
-            return null;
-        }
-        // TODO: create some kind of alert/log if metric is not valid
-        function validKey(key) {
-            if (!('name' in key)) {
-                return false;
-            }
-            if (invalidMetricNames.includes(key.name)) {
-                return false;
-            }
-            try {
-                fast_json_stable_stringify_1.default(key);
-            }
-            catch {
-                return false;
-            }
-            return true;
-        }
-        function getStrKey(key) {
-            return fast_json_stable_stringify_1.default(key);
-        }
-        function getNumericSummary(vals) {
-            return {
-                count: vals.length,
-                max: Math.max(...vals),
-                median: stats_lite_1.median(vals),
-                min: Math.min(...vals),
-                percentile95: stats_lite_1.percentile(vals, 0.95),
-                percentile99: stats_lite_1.percentile(vals, 0.99),
-                sum: stats_lite_1.sum(vals),
-            };
-        }
-        //////////////////////
-        // public methods definitions
-        //////////////////////
-        this.add = (key, value) => {
-            if (validKey(key)) {
-                const strKey = getStrKey(key);
-                if (!(strKey in samples)) {
-                    samples[strKey] = [];
-                }
-                samples[strKey].push(value);
-            }
-        };
-        this.getSummaries = () => {
-            const appSummaries = summaries(samples);
-            samples = {};
-            const runtimeSummaries = getRuntimeSummaries();
-            return runtimeSummaries.concat(appSummaries);
-        };
-        //////////////////////
-        // real constructor
-        //////////////////////
-    }
-}
-exports.MetricsLogger = MetricsLogger;

package/lib/service/master.d.ts

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

package/lib/service/master.js

@@ -1,87 +0,0 @@
-"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) => {
-    // 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/metrics/requestMetricsMiddleware.d.ts

@@ -1,2 +0,0 @@
-import { ServiceContext } from '../worker/runtime/typings';
-export declare const addRequestMetricsMiddleware: () => (ctx: ServiceContext<import("../..").IOClients, import("../worker/runtime/typings").RecorderState, import("../worker/runtime/typings").ParamsContext>, next: () => Promise<void>) => Promise<void>;