@vtex/api 6.45.21-beta → 6.45.21-beta.1

package/CHANGELOG.md

@@ -7,6 +7,10 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ## [Unreleased]
 
+## [6.45.21-beta.1] - 2023-09-07
+
+## [6.45.21-beta.0] - 2023-09-04
+
 ## [6.45.21-beta] - 2023-09-04
 
 ## [6.45.20] - 2023-08-30
@@ -1778,11 +1782,13 @@ instead
 - `HttpClient` now adds `'Accept-Encoding': 'gzip'` header by default.
 
 
-[Unreleased]: https://github.com/vtex/node-vtex-api/compare/v6.45.21-beta...HEAD
+[Unreleased]: https://github.com/vtex/node-vtex-api/compare/v6.45.21-beta.1...HEAD
 [6.45.15]: https://github.com/vtex/node-vtex-api/compare/v6.45.14...v6.45.15
 [6.45.14]: https://github.com/vtex/node-vtex-api/compare/v6.45.13...v6.45.14
 [6.45.13]: https://github.com/vtex/node-vtex-api/compare/v6.45.12...v6.45.13
 
+[6.45.21-beta.1]: https://github.com/vtex/node-vtex-api/compare/v6.45.21-beta.0...v6.45.21-beta.1
+[6.45.21-beta.0]: https://github.com/vtex/node-vtex-api/compare/v6.45.21-beta...v6.45.21-beta.0
 [6.45.21-beta]: https://github.com/vtex/node-vtex-api/compare/v6.45.20...v6.45.21-beta
 [6.45.20]: https://github.com/vtex/node-vtex-api/compare/v6.45.20-beta...v6.45.20
 [6.45.20-beta]: https://github.com/vtex/node-vtex-api/compare/v6.45.19...v6.45.20-beta

package/lib/service/tracing/tracingMiddlewares.js

@@ -20,6 +20,7 @@ exports.addTracingMiddleware = (tracer) => {
         const start = process.hrtime();
         concurrentRequests.inc(1);
         const rootSpan = tracer.extract(opentracing_1.FORMAT_HTTP_HEADERS, ctx.request.headers);
+        ctx.tracing = { tracer, currentSpan: undefined };
         if (!shouldTrace(ctx, rootSpan)) {
             await next();
             concurrentRequests.dec(1);
@@ -86,8 +87,8 @@ exports.addTracingMiddleware = (tracer) => {
 };
 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}`);
+        var _a, _b;
+        (_b = (_a = ctx.tracing) === null || _a === void 0 ? void 0 : _a.currentSpan) === null || _b === void 0 ? void 0 : _b.setOperationName(`${operationType}:${operationName}`);
         return next();
     };
 };
@@ -101,7 +102,7 @@ exports.traceUserLandRemainingPipelineMiddleware = () => {
         userLandTracer.lockFallbackSpan();
         const startTime = process.hrtime();
         try {
-            span.log({ event: "user-middlewares-start" /* USER_MIDDLEWARES_START */ });
+            span === null || span === void 0 ? void 0 : span.log({ event: "user-middlewares-start" /* USER_MIDDLEWARES_START */ });
             await next();
         }
         catch (err) {
@@ -109,7 +110,7 @@ exports.traceUserLandRemainingPipelineMiddleware = () => {
             throw err;
         }
         finally {
-            span.log({
+            span === null || span === void 0 ? void 0 : span.log({
                 event: "user-middlewares-finish" /* USER_MIDDLEWARES_FINISH */,
                 ["user-middlewares-duration" /* USER_MIDDLEWARES_DURATION */]: utils_2.hrToMillis(process.hrtime(startTime)),
             });
@@ -120,8 +121,8 @@ exports.traceUserLandRemainingPipelineMiddleware = () => {
 function shouldTrace(ctx, rootSpan) {
     var _a, _b, _c;
     /** Should trace if path isnt blacklisted and sampling decision came from the edge
-    * ((rootSpan as any).isSampled. returns whether or not this span context was sampled
-    * There is a cast to bypass opentracing typescript
-    */
+     * ((rootSpan as any).isSampled. returns whether or not this span context was sampled
+     * There is a cast to bypass opentracing typescript
+     */
     return !PATHS_BLACKLISTED_FOR_TRACING.includes(ctx.request.path) && ((_c = (_b = (_a = rootSpan).isSampled) === null || _b === void 0 ? void 0 : _b.call(_a)) !== null && _c !== void 0 ? _c : false);
 }

package/lib/service/worker/runtime/builtIn/handlers.js

@@ -1,8 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.whoAmIHandler = ({ events, routes, }) => (ctx) => {
-    var _a;
-    (_a = ctx.tracing) === null || _a === void 0 ? void 0 : _a.currentSpan.setOperationName('builtin:whoami');
+    var _a, _b;
+    (_b = (_a = ctx.tracing) === null || _a === void 0 ? void 0 : _a.currentSpan) === null || _b === void 0 ? void 0 : _b.setOperationName('builtin:whoami');
     ctx.status = 200;
     ctx.body = {
         events,
@@ -11,8 +11,8 @@ exports.whoAmIHandler = ({ events, routes, }) => (ctx) => {
     ctx.set('Cache-Control', 'public, max-age=86400'); // cache for 24 hours
 };
 exports.healthcheckHandler = ({ events, routes, }) => (ctx) => {
-    var _a;
-    (_a = ctx.tracing) === null || _a === void 0 ? void 0 : _a.currentSpan.setOperationName('builtin:healthcheck');
+    var _a, _b;
+    (_b = (_a = ctx.tracing) === null || _a === void 0 ? void 0 : _a.currentSpan) === null || _b === void 0 ? void 0 : _b.setOperationName('builtin:healthcheck');
     ctx.status = 200;
     ctx.body = {
         events,
@@ -20,8 +20,8 @@ exports.healthcheckHandler = ({ events, routes, }) => (ctx) => {
     };
 };
 exports.metricsLoggerHandler = (ctx) => {
-    var _a;
-    (_a = ctx.tracing) === null || _a === void 0 ? void 0 : _a.currentSpan.setOperationName('builtin:metrics-logger');
+    var _a, _b;
+    (_b = (_a = ctx.tracing) === null || _a === void 0 ? void 0 : _a.currentSpan) === null || _b === void 0 ? void 0 : _b.setOperationName('builtin:metrics-logger');
     ctx.status = 200;
     ctx.body = ctx.metricsLogger.getSummaries();
 };

package/lib/service/worker/runtime/statusTrack.js

@@ -10,10 +10,10 @@ const STATUS_TRACK = 'statusTrack';
 exports.isStatusTrack = (message) => message === STATUS_TRACK;
 exports.isStatusTrackBroadcast = (message) => message === BROADCAST_STATUS_TRACK;
 exports.statusTrackHandler = async (ctx) => {
-    var _a, _b;
-    (_a = ctx.tracing) === null || _a === void 0 ? void 0 : _a.currentSpan.setOperationName('builtin:status-track');
+    var _a, _b, _c;
+    (_b = (_a = ctx.tracing) === null || _a === void 0 ? void 0 : _a.currentSpan) === null || _b === void 0 ? void 0 : _b.setOperationName('builtin:status-track');
     if (!constants_1.LINKED) {
-        (_b = process.send) === null || _b === void 0 ? void 0 : _b.call(process, BROADCAST_STATUS_TRACK);
+        (_c = process.send) === null || _c === void 0 ? void 0 : _c.call(process, BROADCAST_STATUS_TRACK);
     }
     ctx.body = [];
     return;

package/lib/service/worker/runtime/typings.d.ts

@@ -21,7 +21,7 @@ declare type ServerTiming = Record<string, string>;
 export declare type Maybe<T> = T | null | undefined;
 export interface TracingContext {
     tracer: Tracer;
-    currentSpan: Span;
+    currentSpan: Span | undefined;
 }
 export interface Context<T extends IOClients> {
     clients: T;

package/lib/service/worker/runtime/utils/context.js

@@ -29,7 +29,7 @@ exports.prepareHandlerCtx = (header, tracingContext) => {
         segmentToken: header[constants_1.SEGMENT_HEADER],
         sessionToken: header[constants_1.SESSION_HEADER],
         tenant: header[constants_1.TENANT_HEADER] ? tenant_1.parseTenantHeaderValue(header[constants_1.TENANT_HEADER]) : undefined,
-        tracer: new UserLandTracer_1.UserLandTracer(tracingContext.tracer, tracingContext.currentSpan),
+        tracer: new UserLandTracer_1.UserLandTracer(tracingContext === null || tracingContext === void 0 ? void 0 : tracingContext.tracer, tracingContext === null || tracingContext === void 0 ? void 0 : tracingContext.currentSpan),
         userAgent: process.env.VTEX_APP_ID || '',
         workspace: header[constants_1.WORKSPACE_HEADER],
     };

package/lib/tracing/UserLandTracer.d.ts

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

package/lib/tracing/UserLandTracer.js

@@ -49,7 +49,8 @@ class UserLandTracer {
         return this.tracer.inject(spanContext, format, carrier);
     }
     fallbackSpanContext() {
-        return this.fallbackSpan.context();
+        var _a;
+        return (_a = this.fallbackSpan) === null || _a === void 0 ? void 0 : _a.context();
     }
 }
 exports.UserLandTracer = UserLandTracer;

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

@@ -26,6 +26,6 @@ export declare class ErrorReport extends ErrorReportBase {
      * 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;
+    injectOnSpan(span?: Span, logger?: IOContext['logger']): this;
     private shouldLogToSplunk;
 }

package/lib/tracing/errorReporting/ErrorReport.js

@@ -35,7 +35,7 @@ class ErrorReport extends node_error_report_1.ErrorReportBase {
      */
     injectOnSpan(span, logger) {
         var _a;
-        span.setTag(__1.TracingTags.ERROR, 'true');
+        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,
@@ -47,7 +47,7 @@ class ErrorReport extends node_error_report_1.ErrorReportBase {
             indexedLogs["error.server.request_id" /* ERROR_SERVER_REQUEST_ID */] = this.parsedInfo.response.data.requestId;
         }
         const serializableError = this.toObject();
-        span.log({ event: 'error', ...indexedLogs, error: serializableError });
+        span === null || span === void 0 ? void 0 : span.log({ event: 'error', ...indexedLogs, error: serializableError });
         if (logger && this.shouldLogToSplunk(span)) {
             logger.error(serializableError);
             this.markErrorAsReported();

package/lib/tracing/utils.d.ts

@@ -1,9 +1,9 @@
 import { Span } from 'opentracing';
 export interface TraceInfo {
-    traceId: string;
+    traceId?: string;
     isSampled: boolean;
 }
-export declare function getTraceInfo(span: Span): TraceInfo;
+export declare function getTraceInfo(span?: Span): TraceInfo;
 /**
  * Do a shallow copy of a headers object and redacts sensitive information.
  *

package/lib/tracing/utils.js

@@ -3,10 +3,10 @@ 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.context();
+    const spanContext = span === null || span === void 0 ? void 0 : span.context();
     return {
-        isSampled: (_c = (_b = (_a = spanContext).isSampled) === null || _b === void 0 ? void 0 : _b.call(_a)) !== null && _c !== void 0 ? _c : false,
-        traceId: spanContext.toTraceId(),
+        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;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vtex/api",
-  "version": "6.45.21-beta",
+  "version": "6.45.21-beta.1",
   "description": "VTEX I/O API client",
   "main": "lib/index.js",
   "typings": "lib/index.d.ts",