@vtex/api 6.48.0 → 6.48.1-beta

package/lib/tracing/Tags.d.ts

@@ -1,81 +0,0 @@
-import { Tags as OpentracingTags } from 'opentracing';
-export { OpentracingTags };
-/**
- * The following tags are process tags - defined when the tracer is instantiated.
- * Those will annotate all spans created
- */
-export declare const enum AppTags {
-    /** Boolean indicating if the app is linked or not */
-    VTEX_APP_LINKED = "app.linked",
-    /** The value of the NODE_ENV environment variable */
-    VTEX_APP_NODE_ENV = "app.node_env",
-    /** The @vtex/api version used (e.g. '6.1.2') */
-    VTEX_APP_NODE_VTEX_API_VERSION = "app.node_vtex_api_version",
-    /** The value of the VTEX_PRODUCTION environment variable - whether the app is in a production workspace */
-    VTEX_APP_PRODUCTION = "app.production",
-    /** The value of the VTEX_REGION environment variable (e.g. 'aws-us-east-1') */
-    VTEX_APP_REGION = "app.region",
-    /** The app version (e.g. '1.2.0') */
-    VTEX_APP_VERSION = "app.version",
-    /** The workspace in which the app is installed or linked */
-    VTEX_APP_WORKSPACE = "app.workspace"
-}
-/** The following tags annotate the entrypoint span on incoming requests */
-export declare const enum VTEXIncomingRequestTags {
-    /** The account being served by the request */
-    VTEX_ACCOUNT = "vtex.incoming.account",
-    /** The request id header value */
-    VTEX_REQUEST_ID = "vtex.request_id",
-    /** The workspace being served by the request */
-    VTEX_WORKSPACE = "vtex.incoming.workspace"
-}
-export declare const enum CustomHttpTags {
-    HTTP_PATH = "http.path",
-    /** Set to true when the client had no response, probably meaning that there was a client error */
-    HTTP_NO_RESPONSE = "http.no_response",
-    /** The HTTP client name (e.g. Apps, Registry, Router) */
-    HTTP_CLIENT_NAME = "http.client.name",
-    /**
-     * CACHE_ENABLED tags indicate if the Cache strategy is enabled
-     * for the specific request.
-     */
-    HTTP_MEMOIZATION_CACHE_ENABLED = "http.cache.memoization.enabled",
-    HTTP_DISK_CACHE_ENABLED = "http.cache.disk.enabled",
-    HTTP_MEMORY_CACHE_ENABLED = "http.cache.memory.enabled",
-    /**
-     * CACHE_RESULT tags indicate the result for that cache strategy
-     * (HIT or MISS for example). Since there may be many layers
-     * of cache a ENABLED flag for a strategy may be 'true', but
-     * the RESULT for that strategy may not be present.
-     */
-    HTTP_MEMORY_CACHE_RESULT = "http.cache.memory",
-    HTTP_MEMOIZATION_CACHE_RESULT = "http.cache.memoization",
-    HTTP_DISK_CACHE_RESULT = "http.cache.disk",
-    HTTP_ROUTER_CACHE_RESULT = "http.cache.router",
-    HTTP_RETRY_ERROR_CODE = "http.retry.error.code",
-    HTTP_RETRY_COUNT = "http.retry.count"
-}
-export declare const UserlandTags: {
-    SPAN_KIND: "span.kind";
-    SPAN_KIND_RPC_CLIENT: "client";
-    SPAN_KIND_RPC_SERVER: "server";
-    SPAN_KIND_MESSAGING_PRODUCER: "producer";
-    SPAN_KIND_MESSAGING_CONSUMER: "consumer";
-    ERROR: "error";
-    COMPONENT: "component";
-    SAMPLING_PRIORITY: "sampling.priority";
-    PEER_SERVICE: "peer.service";
-    PEER_HOSTNAME: "peer.hostname";
-    PEER_ADDRESS: "peer.address";
-    PEER_HOST_IPV4: "peer.ipv4";
-    PEER_HOST_IPV6: "peer.ipv6";
-    PEER_PORT: "peer.port";
-    HTTP_URL: "http.url";
-    HTTP_METHOD: "http.method";
-    HTTP_STATUS_CODE: "http.status_code";
-    MESSAGE_BUS_DESTINATION: "message_bus.destination";
-    DB_INSTANCE: "db.instance";
-    DB_STATEMENT: "db.statement";
-    DB_TYPE: "db.type";
-    DB_USER: "db.user";
-};

package/lib/tracing/Tags.js

@@ -1,7 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const opentracing_1 = require("opentracing");
-exports.OpentracingTags = opentracing_1.Tags;
-exports.UserlandTags = {
-    ...opentracing_1.Tags,
-};

package/lib/tracing/UserLandTracer.d.ts

@@ -1,27 +0,0 @@
-import { Span, SpanContext, SpanOptions, Tracer } from 'opentracing';
-export interface IUserLandTracer {
-    traceId?: string;
-    isTraceSampled: boolean;
-    startSpan: Tracer['startSpan'];
-    inject: Tracer['inject'];
-    fallbackSpanContext: () => SpanContext | undefined;
-}
-export declare const createTracingContextFromCarrier: (newSpanName: string, carrier: Record<string, any>) => {
-    span: Span;
-    tracer: IUserLandTracer;
-};
-export declare class UserLandTracer implements IUserLandTracer {
-    private tracer;
-    private fallbackSpan;
-    private fallbackSpanLock;
-    private _isSampled;
-    private _traceId?;
-    constructor(tracer: Tracer, fallbackSpan?: Span);
-    get traceId(): string | undefined;
-    get isTraceSampled(): boolean;
-    lockFallbackSpan(): void;
-    setFallbackSpan(newSpan?: Span): void;
-    startSpan(name: string, options?: SpanOptions): Span;
-    inject(spanContext: SpanContext | Span, format: string, carrier: any): void;
-    fallbackSpanContext(): SpanContext | undefined;
-}

package/lib/tracing/UserLandTracer.js

@@ -1,56 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const opentracing_1 = require("opentracing");
-const TracerSingleton_1 = require("../service/tracing/TracerSingleton");
-const utils_1 = require("./utils");
-exports.createTracingContextFromCarrier = (newSpanName, carrier) => {
-    const tracer = TracerSingleton_1.TracerSingleton.getTracer();
-    const rootSpan = tracer.extract(opentracing_1.FORMAT_HTTP_HEADERS, carrier);
-    if (rootSpan == null) {
-        throw new Error('Missing span context data on carrier');
-    }
-    const span = tracer.startSpan(newSpanName, { childOf: rootSpan });
-    const userlandTracer = new UserLandTracer(tracer, span);
-    userlandTracer.lockFallbackSpan();
-    return { span, tracer: userlandTracer };
-};
-class UserLandTracer {
-    constructor(tracer, fallbackSpan) {
-        this.tracer = tracer;
-        this.fallbackSpan = fallbackSpan;
-        this.fallbackSpanLock = false;
-        const { traceId, isSampled } = utils_1.getTraceInfo(fallbackSpan);
-        this._traceId = traceId;
-        this._isSampled = isSampled;
-    }
-    get traceId() {
-        return this._traceId;
-    }
-    get isTraceSampled() {
-        return this._isSampled;
-    }
-    lockFallbackSpan() {
-        this.fallbackSpanLock = true;
-    }
-    setFallbackSpan(newSpan) {
-        if (this.fallbackSpanLock) {
-            throw new Error(`FallbackSpan is locked, can't change it`);
-        }
-        this.fallbackSpan = newSpan;
-    }
-    startSpan(name, options) {
-        var _a;
-        if (options && (options.childOf || ((_a = options.references) === null || _a === void 0 ? void 0 : _a.length))) {
-            return this.tracer.startSpan(name, options);
-        }
-        return this.tracer.startSpan(name, { ...options, childOf: this.fallbackSpan });
-    }
-    inject(spanContext, format, carrier) {
-        return this.tracer.inject(spanContext, format, carrier);
-    }
-    fallbackSpanContext() {
-        var _a;
-        return (_a = this.fallbackSpan) === null || _a === void 0 ? void 0 : _a.context();
-    }
-}
-exports.UserLandTracer = UserLandTracer;

package/lib/tracing/errorReporting/ErrorReport.d.ts

@@ -1,31 +0,0 @@
-import { ErrorReportBase, ErrorReportCreateArgs } from '@vtex/node-error-report';
-import { Span } from 'opentracing';
-import { IOContext } from '../../service/worker/runtime/typings';
-export declare class ErrorReport extends ErrorReportBase {
-    /**
-     * Create a new ErrorReport wrapping args.originalError
-     *
-     * In case the args.originalError argument is already an ErrorReport
-     * instance, then ErrorReport.create just returns it. If it's not,
-     * it returns a new ErrorReport wrapping the error. This way you can
-     * use ErrorReport.create on a catchAll, e.g.:
-     *
-     * ```
-     * try {
-     *   await next()
-     * } catch(err) {
-     *   ErrorReport.create({ originalError: err }).injectOnSpan(span)
-     * }
-     * ```
-     *
-     * More docs on the ErrorReport available on: https://github.com/vtex/node-error-report
-     */
-    static create(args: ErrorReportCreateArgs): ErrorReport;
-    /**
-     * Inject information about the error wrapped by this ErrorReport
-     * instance on the provided Span. If a logger is provided and the
-     * span is part of a **sampled** trace, then the error will be logged.
-     */
-    injectOnSpan(span?: Span, logger?: IOContext['logger']): this;
-    private shouldLogToSplunk;
-}

package/lib/tracing/errorReporting/ErrorReport.js

@@ -1,70 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const node_error_report_1 = require("@vtex/node-error-report");
-const __1 = require("..");
-const utils_1 = require("../utils");
-class ErrorReport extends node_error_report_1.ErrorReportBase {
-    /**
-     * Create a new ErrorReport wrapping args.originalError
-     *
-     * In case the args.originalError argument is already an ErrorReport
-     * instance, then ErrorReport.create just returns it. If it's not,
-     * it returns a new ErrorReport wrapping the error. This way you can
-     * use ErrorReport.create on a catchAll, e.g.:
-     *
-     * ```
-     * try {
-     *   await next()
-     * } catch(err) {
-     *   ErrorReport.create({ originalError: err }).injectOnSpan(span)
-     * }
-     * ```
-     *
-     * More docs on the ErrorReport available on: https://github.com/vtex/node-error-report
-     */
-    static create(args) {
-        if (args.originalError instanceof ErrorReport) {
-            return args.originalError;
-        }
-        return new ErrorReport(node_error_report_1.createErrorReportBaseArgs(args));
-    }
-    /**
-     * Inject information about the error wrapped by this ErrorReport
-     * instance on the provided Span. If a logger is provided and the
-     * span is part of a **sampled** trace, then the error will be logged.
-     */
-    injectOnSpan(span, logger) {
-        var _a, _b, _c, _d;
-        span === null || span === void 0 ? void 0 : span.setTag(__1.TracingTags.ERROR, 'true');
-        const indexedLogs = {
-            ["error.kind" /* ERROR_KIND */]: this.kind,
-            ["error.id" /* ERROR_ID */]: this.metadata.errorId,
-        };
-        if (node_error_report_1.isRequestInfo(this.parsedInfo) &&
-            this.parsedInfo.response &&
-            node_error_report_1.isInfraErrorData((_a = this.parsedInfo.response) === null || _a === void 0 ? void 0 : _a.data)) {
-            indexedLogs["error.server.code" /* ERROR_SERVER_CODE */] = this.parsedInfo.response.data.code;
-            indexedLogs["error.server.request_id" /* ERROR_SERVER_REQUEST_ID */] = this.parsedInfo.response.data.requestId;
-        }
-        const serializableError = this.toObject();
-        span === null || span === void 0 ? void 0 : span.log({
-            event: 'error',
-            ...indexedLogs,
-            ["error.message" /* ERROR_MESSAGE */]: serializableError.message,
-            ["error.metadata.metrics.InstantiationTime" /* ERROR_METADATA_METRICS_INSTANTIATION_TIME */]: (_b = serializableError.metadata) === null || _b === void 0 ? void 0 : _b.reportCount,
-            ["error.metadata.reportCount" /* ERROR_METADATA_REPORT_COUNT */]: (_d = (_c = serializableError.metadata) === null || _c === void 0 ? void 0 : _c.metrics) === null || _d === void 0 ? void 0 : _d.instantiationTime,
-            ["error.stack" /* ERROR_STACK */]: serializableError.stack,
-            ["error.code" /* ERROR_CODE */]: serializableError.code,
-        });
-        if (logger && this.shouldLogToSplunk(span)) {
-            logger.error(serializableError);
-            this.markErrorAsReported();
-        }
-        return this;
-    }
-    shouldLogToSplunk(span) {
-        var _a;
-        return !this.isErrorReported() && ((_a = utils_1.getTraceInfo(span)) === null || _a === void 0 ? void 0 : _a.isSampled);
-    }
-}
-exports.ErrorReport = ErrorReport;

package/lib/tracing/index.d.ts

@@ -1,9 +0,0 @@
-import { FORMAT_HTTP_HEADERS, Span } from 'opentracing';
-export { ErrorKindsBase as ErrorKinds } from '@vtex/node-error-report';
-export { ErrorReport } from './errorReporting/ErrorReport';
-export { createSpanReference } from './spanReference/createSpanReference';
-export { SpanReferenceTypes } from './spanReference/SpanReferenceTypes';
-export { UserlandTags as TracingTags } from './Tags';
-export { createTracingContextFromCarrier, IUserLandTracer } from './UserLandTracer';
-export { getTraceInfo, TraceInfo } from './utils';
-export { Span, FORMAT_HTTP_HEADERS };

package/lib/tracing/index.js

@@ -1,19 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const opentracing_1 = require("opentracing");
-exports.FORMAT_HTTP_HEADERS = opentracing_1.FORMAT_HTTP_HEADERS;
-exports.Span = opentracing_1.Span;
-var node_error_report_1 = require("@vtex/node-error-report");
-exports.ErrorKinds = node_error_report_1.ErrorKindsBase;
-var ErrorReport_1 = require("./errorReporting/ErrorReport");
-exports.ErrorReport = ErrorReport_1.ErrorReport;
-var createSpanReference_1 = require("./spanReference/createSpanReference");
-exports.createSpanReference = createSpanReference_1.createSpanReference;
-var SpanReferenceTypes_1 = require("./spanReference/SpanReferenceTypes");
-exports.SpanReferenceTypes = SpanReferenceTypes_1.SpanReferenceTypes;
-var Tags_1 = require("./Tags");
-exports.TracingTags = Tags_1.UserlandTags;
-var UserLandTracer_1 = require("./UserLandTracer");
-exports.createTracingContextFromCarrier = UserLandTracer_1.createTracingContextFromCarrier;
-var utils_1 = require("./utils");
-exports.getTraceInfo = utils_1.getTraceInfo;

package/lib/tracing/spanReference/SpanReferenceTypes.d.ts

@@ -1,4 +0,0 @@
-export declare enum SpanReferenceTypes {
-    CHILD_OF = 0,
-    FOLLOWS_FROM = 1
-}

package/lib/tracing/spanReference/SpanReferenceTypes.js

@@ -1,7 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-var SpanReferenceTypes;
-(function (SpanReferenceTypes) {
-    SpanReferenceTypes[SpanReferenceTypes["CHILD_OF"] = 0] = "CHILD_OF";
-    SpanReferenceTypes[SpanReferenceTypes["FOLLOWS_FROM"] = 1] = "FOLLOWS_FROM";
-})(SpanReferenceTypes = exports.SpanReferenceTypes || (exports.SpanReferenceTypes = {}));

package/lib/tracing/spanReference/createSpanReference.d.ts

@@ -1,3 +0,0 @@
-import { Reference, Span } from 'opentracing';
-import { SpanReferenceTypes } from './SpanReferenceTypes';
-export declare function createSpanReference(span: Span, type: SpanReferenceTypes): Reference;

package/lib/tracing/spanReference/createSpanReference.js

@@ -1,8 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const opentracing_1 = require("opentracing");
-const SpanReferenceTypes_1 = require("./SpanReferenceTypes");
-function createSpanReference(span, type) {
-    return new opentracing_1.Reference(type === SpanReferenceTypes_1.SpanReferenceTypes.CHILD_OF ? opentracing_1.REFERENCE_CHILD_OF : opentracing_1.REFERENCE_FOLLOWS_FROM, span.context());
-}
-exports.createSpanReference = createSpanReference;

package/lib/tracing/utils.d.ts

@@ -1,13 +0,0 @@
-import { Span } from 'opentracing';
-export interface TraceInfo {
-    traceId?: string;
-    isSampled: boolean;
-}
-export declare function getTraceInfo(span?: Span): TraceInfo;
-/**
- * Do a shallow copy of a headers object and redacts sensitive information.
- *
- * @param headersObj The headers object
- * @param resultFieldsPrefix The prefix that will be added to each field on the result object
- */
-export declare const cloneAndSanitizeHeaders: (headersObj: Record<string, any>, resultFieldsPrefix?: string) => Record<string, string>;

package/lib/tracing/utils.js

@@ -1,40 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const node_error_report_1 = require("@vtex/node-error-report");
-function getTraceInfo(span) {
-    var _a, _b, _c;
-    const spanContext = span === null || span === void 0 ? void 0 : span.context();
-    return {
-        isSampled: (_c = (_b = (_a = spanContext) === null || _a === void 0 ? void 0 : _a.isSampled) === null || _b === void 0 ? void 0 : _b.call(_a)) !== null && _c !== void 0 ? _c : false,
-        traceId: spanContext === null || spanContext === void 0 ? void 0 : spanContext.toTraceId(),
-    };
-}
-exports.getTraceInfo = getTraceInfo;
-/**
- * Do a shallow copy of a headers object and redacts sensitive information.
- *
- * @param headersObj The headers object
- * @param resultFieldsPrefix The prefix that will be added to each field on the result object
- */
-exports.cloneAndSanitizeHeaders = (headersObj, resultFieldsPrefix = '') => {
-    const ret = {};
-    const entries = Object.entries(headersObj);
-    for (const [key, val] of entries) {
-        // Most of the time val is a string, but there are some cases, for example when we do a axios interceptor,
-        // that a header field can contain an object, for example:
-        // ```
-        // "common": {
-        //   "Accept": "application/json, text/plain, */*"
-        // },
-        // "delete": { },
-        // "get": { },
-        // "head": { },
-        // "post": {
-        //   "Content-Type": "application/x-www-form-urlencoded"
-        // },
-        // ```
-        // In those corner cases we probably won't have a sensitive string as key, so we don't treat them here
-        ret[`${resultFieldsPrefix}${key}`] = node_error_report_1.authFields.includes(key) ? node_error_report_1.sanitizeAuth(val) : val;
-    }
-    return ret;
-};

package/lib/utils/conflicts.mock.d.ts

@@ -1,17 +0,0 @@
-export declare function getMockConflicts(path: string, base: object, mine: object, master: object): {
-    data: {
-        base: {
-            content: string;
-            mimeType: string;
-        };
-        master: {
-            content: string;
-            mimeType: string;
-        };
-        mine: {
-            content: string;
-            mimeType: string;
-        };
-        path: string;
-    }[];
-};

package/lib/utils/conflicts.mock.js

@@ -1,27 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-function jsonToBase64(json) {
-    return Buffer.from(JSON.stringify(json)).toString('base64');
-}
-function getMockConflicts(path, base, mine, master) {
-    return {
-        data: [
-            {
-                base: {
-                    content: jsonToBase64(base),
-                    mimeType: 'application/json',
-                },
-                master: {
-                    content: jsonToBase64(master),
-                    mimeType: 'application/json',
-                },
-                mine: {
-                    content: jsonToBase64(mine),
-                    mimeType: 'application/json',
-                },
-                path,
-            },
-        ],
-    };
-}
-exports.getMockConflicts = getMockConflicts;