@vtex/api 7.2.1-beta.2 → 7.2.2-beta.0

package/lib/HttpClient/HttpClient.js

@@ -112,14 +112,14 @@ class HttpClient {
             ...defaultHeaders,
             'Accept-Encoding': 'gzip',
             'User-Agent': userAgent,
-            ...host ? { [constants_1.FORWARDED_HOST_HEADER]: host } : null,
-            ...tenant ? { [constants_1.TENANT_HEADER]: (0, tenant_1.formatTenantHeaderValue)(tenant) } : null,
-            ...binding ? { [constants_1.BINDING_HEADER]: (0, binding_1.formatBindingHeaderValue)(binding) } : null,
-            ...locale ? { [constants_1.LOCALE_HEADER]: locale } : null,
-            ...operationId ? { 'x-vtex-operation-id': operationId } : null,
-            ...product ? { [constants_1.PRODUCT_HEADER]: product } : null,
-            ...segmentToken ? { [constants_1.SEGMENT_HEADER]: segmentToken } : null,
-            ...sessionToken ? { [constants_1.SESSION_HEADER]: sessionToken } : null,
+            ...host ? { [constants_1.HeaderKeys.FORWARDED_HOST]: host } : null,
+            ...tenant ? { [constants_1.HeaderKeys.TENANT]: (0, tenant_1.formatTenantHeaderValue)(tenant) } : null,
+            ...binding ? { [constants_1.HeaderKeys.BINDING]: (0, binding_1.formatBindingHeaderValue)(binding) } : null,
+            ...locale ? { [constants_1.HeaderKeys.LOCALE]: locale } : null,
+            ...operationId ? { [constants_1.HeaderKeys.OPERATION_ID]: operationId } : null,
+            ...product ? { [constants_1.HeaderKeys.PRODUCT]: product } : null,
+            ...segmentToken ? { [constants_1.HeaderKeys.SEGMENT]: segmentToken } : null,
+            ...sessionToken ? { [constants_1.HeaderKeys.SESSION]: sessionToken } : null,
         };
         if (authType && authToken) {
             headers['Authorization'] = `${authType} ${authToken}`; // tslint:disable-line

package/lib/HttpClient/middlewares/cache.js

@@ -7,7 +7,7 @@ const RANGE_HEADER_QS_KEY = '__range_header';
 const cacheableStatusCodes = [200, 203, 204, 206, 300, 301, 404, 405, 410, 414, 501]; // https://tools.ietf.org/html/rfc7231#section-6.1
 const cacheKey = (config) => {
     const { baseURL = '', url = '', params, headers } = config;
-    const locale = headers === null || headers === void 0 ? void 0 : headers[constants_1.LOCALE_HEADER];
+    const locale = headers === null || headers === void 0 ? void 0 : headers[constants_1.HeaderKeys.LOCALE];
     const encodedBaseURL = baseURL.replace(/\//g, '\\');
     const encodedURL = url.replace(/\//g, '\\');
     let key = `${locale}--${encodedBaseURL}--${encodedURL}?`;
@@ -64,7 +64,7 @@ const cacheMiddleware = ({ type, storage, asyncSet }) => {
         }
         const { rootSpan: span, tracer, logger } = (_a = ctx.tracing) !== null && _a !== void 0 ? _a : {};
         const key = (0, exports.cacheKey)(ctx.config);
-        const segmentToken = (_b = ctx.config.headers) === null || _b === void 0 ? void 0 : _b[constants_1.SEGMENT_HEADER];
+        const segmentToken = (_b = ctx.config.headers) === null || _b === void 0 ? void 0 : _b[constants_1.HeaderKeys.SEGMENT];
         const keyWithSegment = key + segmentToken;
         span === null || span === void 0 ? void 0 : span.log({
             event: "cache-key-created" /* HttpLogEvents.CACHE_KEY_CREATE */,
@@ -156,11 +156,11 @@ const cacheMiddleware = ({ type, storage, asyncSet }) => {
             return;
         }
         const shouldCache = maxAge || etag;
-        const varySession = ctx.response.headers.vary && ctx.response.headers.vary.includes(constants_1.SESSION_HEADER);
+        const varySession = ctx.response.headers.vary && ctx.response.headers.vary.includes(constants_1.HeaderKeys.SESSION);
         if (shouldCache && !varySession) {
             const { responseType, responseEncoding: configResponseEncoding } = ctx.config;
             const currentAge = revalidated ? 0 : age;
-            const varySegment = ctx.response.headers.vary && ctx.response.headers.vary.includes(constants_1.SEGMENT_HEADER);
+            const varySegment = ctx.response.headers.vary && ctx.response.headers.vary.includes(constants_1.HeaderKeys.SEGMENT);
             const setKey = varySegment ? keyWithSegment : key;
             const responseEncoding = configResponseEncoding || (responseType === 'arraybuffer' ? 'base64' : undefined);
             const cacheableData = type === CacheType.Disk && responseType === 'arraybuffer'

package/lib/HttpClient/middlewares/request/setupAxios/interceptors/tracing/spanSetup.js

@@ -25,8 +25,8 @@ const injectResponseInfoOnSpan = (span, response) => {
     }
     span === null || span === void 0 ? void 0 : span.log({ 'response-headers': (0, utils_1.cloneAndSanitizeHeaders)(response.headers) });
     span === null || span === void 0 ? void 0 : span.setTag(Tags_1.OpentracingTags.HTTP_STATUS_CODE, response.status);
-    if (response.headers[constants_1.ROUTER_CACHE_HEADER]) {
-        span === null || span === void 0 ? void 0 : span.setTag("http.cache.router" /* CustomHttpTags.HTTP_ROUTER_CACHE_RESULT */, response.headers[constants_1.ROUTER_CACHE_HEADER]);
+    if (response.headers[constants_1.HeaderKeys.ROUTER_CACHE]) {
+        span === null || span === void 0 ? void 0 : span.setTag("http.cache.router" /* CustomHttpTags.HTTP_ROUTER_CACHE_RESULT */, response.headers[constants_1.HeaderKeys.ROUTER_CACHE]);
     }
 };
 exports.injectResponseInfoOnSpan = injectResponseInfoOnSpan;

package/lib/clients/janus/Segment.js

@@ -58,7 +58,7 @@ class Segment extends JanusClient_1.JanusClient {
                 forceMaxAge: SEGMENT_MAX_AGE_S,
                 headers: {
                     'Content-Type': 'application/json',
-                    [constants_1.PRODUCT_HEADER]: product || '',
+                    [constants_1.HeaderKeys.PRODUCT]: product || '',
                 },
                 inflightKey: HttpClient_1.inflightUrlWithQuery,
                 metric,

package/lib/constants.d.ts

@@ -2,35 +2,51 @@ export declare const NODE_VTEX_API_VERSION: any;
 export declare const DEFAULT_WORKSPACE = "master";
 export declare const IS_IO: string | undefined;
 export declare const PID: number;
-export declare const CACHE_CONTROL_HEADER = "cache-control";
-export declare const SEGMENT_HEADER = "x-vtex-segment";
-export declare const SESSION_HEADER = "x-vtex-session";
-export declare const PRODUCT_HEADER = "x-vtex-product";
-export declare const LOCALE_HEADER = "x-vtex-locale";
-export declare const FORWARDED_HOST_HEADER = "x-forwarded-host";
-export declare const TENANT_HEADER = "x-vtex-tenant";
-export declare const BINDING_HEADER = "x-vtex-binding";
-export declare const META_HEADER = "x-vtex-meta";
-export declare const META_HEADER_BUCKET = "x-vtex-meta-bucket";
-export declare const ETAG_HEADER = "etag";
-export declare const ACCOUNT_HEADER = "x-vtex-account";
-export declare const CREDENTIAL_HEADER = "x-vtex-credential";
-export declare const REQUEST_ID_HEADER = "x-request-id";
-export declare const ROUTER_CACHE_HEADER = "x-router-cache";
-export declare const OPERATION_ID_HEADER = "x-vtex-operation-id";
-export declare const PLATFORM_HEADER = "x-vtex-platform";
-export declare const WORKSPACE_IS_PRODUCTION_HEADER = "x-vtex-workspace-is-production";
-export declare const WORKSPACE_HEADER = "x-vtex-workspace";
-export declare const EVENT_KEY_HEADER = "x-event-key";
-export declare const EVENT_SENDER_HEADER = "x-event-sender";
-export declare const EVENT_SUBJECT_HEADER = "x-event-subject";
-export declare const EVENT_HANDLER_ID_HEADER = "x-event-handler-id";
-export declare const COLOSSUS_ROUTE_DECLARER_HEADER = "x-colossus-route-declarer";
-export declare const COLOSSUS_ROUTE_ID_HEADER = "x-colossus-route-id";
-export declare const COLOSSUS_PARAMS_HEADER = "x-colossus-params";
-export declare const TRACE_ID_HEADER = "x-trace-id";
-export declare const PROVIDER_HEADER = "x-vtex-provider";
-export type VaryHeaders = typeof SEGMENT_HEADER | typeof SESSION_HEADER | typeof PRODUCT_HEADER | typeof LOCALE_HEADER;
+export declare const HeaderKeys: {
+    CACHE_CONTROL: string;
+    SEGMENT: string;
+    SESSION: string;
+    PRODUCT: string;
+    LOCALE: string;
+    FORWARDED_HOST: string;
+    FORWARDED_FOR: string;
+    TENANT: string;
+    BINDING: string;
+    META: string;
+    META_BUCKET: string;
+    ETAG: string;
+    ACCOUNT: string;
+    CREDENTIAL: string;
+    REQUEST_ID: string;
+    ROUTER_CACHE: string;
+    OPERATION_ID: string;
+    PLATFORM: string;
+    WORKSPACE_IS_PRODUCTION: string;
+    WORKSPACE: string;
+    EVENT_KEY: string;
+    EVENT_SENDER: string;
+    EVENT_SUBJECT: string;
+    EVENT_HANDLER_ID: string;
+    COLOSSUS_ROUTE_DECLARER: string;
+    COLOSSUS_ROUTE_ID: string;
+    COLOSSUS_PARAMS: string;
+    TRACE_ID: string;
+    PROVIDER: string;
+    USER_AGENT: string;
+    VTEX_USER_AGENT: string;
+    VTEX_IO_CALLER: string;
+    VTEX_APP_SERVICE: string;
+    VTEX_APP_KEY: string;
+    VTEX_RETRY_COUNT: string;
+};
+export declare const AttributeKeys: {
+    VTEX_ACCOUNT_NAME: "vtex.account.name";
+    VTEX_IO_WORKSPACE_NAME: "vtex_io.workspace.name";
+    VTEX_IO_WORKSPACE_TYPE: "vtex_io.workspace.type";
+    VTEX_IO_APP_ID: "vtex_io.app.id";
+    VTEX_IO_APP_AUTHOR_TYPE: "vtex_io.app.author_type";
+};
+export type VaryHeaders = typeof HeaderKeys.SEGMENT | typeof HeaderKeys.SESSION | typeof HeaderKeys.PRODUCT | typeof HeaderKeys.LOCALE;
 export declare const BODY_HASH = "__graphqlBodyHash";
 export declare const UP_SIGNAL = "UP";
 export declare const MAX_AGE: {

package/lib/constants.js

@@ -1,42 +1,60 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.DK_APP_ID = exports.OTEL_EXPORTER_OTLP_ENDPOINT = exports.LOG_CLIENT_INIT_TIMEOUT_MS = exports.cancellableMethods = exports.INSPECT_DEBUGGER_PORT = exports.PRODUCTION = exports.WORKSPACE = exports.ACCOUNT = exports.NODE_ENV = exports.APP = exports.PUBLIC_ENDPOINT = exports.REGION = exports.LINKED = exports.MAX_WORKERS = exports.HTTP_SERVER_PORT = exports.MAX_AGE = exports.UP_SIGNAL = exports.BODY_HASH = exports.PROVIDER_HEADER = exports.TRACE_ID_HEADER = exports.COLOSSUS_PARAMS_HEADER = exports.COLOSSUS_ROUTE_ID_HEADER = exports.COLOSSUS_ROUTE_DECLARER_HEADER = exports.EVENT_HANDLER_ID_HEADER = exports.EVENT_SUBJECT_HEADER = exports.EVENT_SENDER_HEADER = exports.EVENT_KEY_HEADER = exports.WORKSPACE_HEADER = exports.WORKSPACE_IS_PRODUCTION_HEADER = exports.PLATFORM_HEADER = exports.OPERATION_ID_HEADER = exports.ROUTER_CACHE_HEADER = exports.REQUEST_ID_HEADER = exports.CREDENTIAL_HEADER = exports.ACCOUNT_HEADER = exports.ETAG_HEADER = exports.META_HEADER_BUCKET = exports.META_HEADER = exports.BINDING_HEADER = exports.TENANT_HEADER = exports.FORWARDED_HOST_HEADER = exports.LOCALE_HEADER = exports.PRODUCT_HEADER = exports.SESSION_HEADER = exports.SEGMENT_HEADER = exports.CACHE_CONTROL_HEADER = exports.PID = exports.IS_IO = exports.DEFAULT_WORKSPACE = exports.NODE_VTEX_API_VERSION = void 0;
-exports.DIAGNOSTICS_TELEMETRY_ENABLED = void 0;
+exports.DIAGNOSTICS_TELEMETRY_ENABLED = exports.DK_APP_ID = exports.OTEL_EXPORTER_OTLP_ENDPOINT = exports.LOG_CLIENT_INIT_TIMEOUT_MS = exports.cancellableMethods = exports.INSPECT_DEBUGGER_PORT = exports.PRODUCTION = exports.WORKSPACE = exports.ACCOUNT = exports.NODE_ENV = exports.APP = exports.PUBLIC_ENDPOINT = exports.REGION = exports.LINKED = exports.MAX_WORKERS = exports.HTTP_SERVER_PORT = exports.MAX_AGE = exports.UP_SIGNAL = exports.BODY_HASH = exports.AttributeKeys = exports.HeaderKeys = exports.PID = exports.IS_IO = exports.DEFAULT_WORKSPACE = exports.NODE_VTEX_API_VERSION = void 0;
 const app_1 = require("./utils/app");
+const diagnostics_semconv_1 = require("@vtex/diagnostics-semconv");
 // tslint:disable-next-line
 const pkg = require('../package.json');
 exports.NODE_VTEX_API_VERSION = pkg.version;
 exports.DEFAULT_WORKSPACE = 'master';
 exports.IS_IO = process.env.VTEX_IO;
 exports.PID = process.pid;
-exports.CACHE_CONTROL_HEADER = 'cache-control';
-exports.SEGMENT_HEADER = 'x-vtex-segment';
-exports.SESSION_HEADER = 'x-vtex-session';
-exports.PRODUCT_HEADER = 'x-vtex-product';
-exports.LOCALE_HEADER = 'x-vtex-locale';
-exports.FORWARDED_HOST_HEADER = 'x-forwarded-host';
-exports.TENANT_HEADER = 'x-vtex-tenant';
-exports.BINDING_HEADER = 'x-vtex-binding';
-exports.META_HEADER = 'x-vtex-meta';
-exports.META_HEADER_BUCKET = 'x-vtex-meta-bucket';
-exports.ETAG_HEADER = 'etag';
-exports.ACCOUNT_HEADER = 'x-vtex-account';
-exports.CREDENTIAL_HEADER = 'x-vtex-credential';
-exports.REQUEST_ID_HEADER = 'x-request-id';
-exports.ROUTER_CACHE_HEADER = 'x-router-cache';
-exports.OPERATION_ID_HEADER = 'x-vtex-operation-id';
-exports.PLATFORM_HEADER = 'x-vtex-platform';
-exports.WORKSPACE_IS_PRODUCTION_HEADER = 'x-vtex-workspace-is-production';
-exports.WORKSPACE_HEADER = 'x-vtex-workspace';
-exports.EVENT_KEY_HEADER = 'x-event-key';
-exports.EVENT_SENDER_HEADER = 'x-event-sender';
-exports.EVENT_SUBJECT_HEADER = 'x-event-subject';
-exports.EVENT_HANDLER_ID_HEADER = 'x-event-handler-id';
-exports.COLOSSUS_ROUTE_DECLARER_HEADER = 'x-colossus-route-declarer';
-exports.COLOSSUS_ROUTE_ID_HEADER = 'x-colossus-route-id';
-exports.COLOSSUS_PARAMS_HEADER = 'x-colossus-params';
-exports.TRACE_ID_HEADER = 'x-trace-id';
-exports.PROVIDER_HEADER = 'x-vtex-provider';
+exports.HeaderKeys = {
+    CACHE_CONTROL: 'cache-control',
+    SEGMENT: 'x-vtex-segment',
+    SESSION: 'x-vtex-session',
+    PRODUCT: 'x-vtex-product',
+    LOCALE: 'x-vtex-locale',
+    FORWARDED_HOST: 'x-forwarded-host',
+    FORWARDED_FOR: 'x-forwarded-for',
+    TENANT: 'x-vtex-tenant',
+    BINDING: 'x-vtex-binding',
+    META: 'x-vtex-meta',
+    META_BUCKET: 'x-vtex-meta-bucket',
+    ETAG: 'etag',
+    ACCOUNT: 'x-vtex-account',
+    CREDENTIAL: 'x-vtex-credential',
+    REQUEST_ID: 'x-request-id',
+    ROUTER_CACHE: 'x-router-cache',
+    OPERATION_ID: 'x-vtex-operation-id',
+    PLATFORM: 'x-vtex-platform',
+    WORKSPACE_IS_PRODUCTION: 'x-vtex-workspace-is-production',
+    WORKSPACE: 'x-vtex-workspace',
+    EVENT_KEY: 'x-event-key',
+    EVENT_SENDER: 'x-event-sender',
+    EVENT_SUBJECT: 'x-event-subject',
+    EVENT_HANDLER_ID: 'x-event-handler-id',
+    COLOSSUS_ROUTE_DECLARER: 'x-colossus-route-declarer',
+    COLOSSUS_ROUTE_ID: 'x-colossus-route-id',
+    COLOSSUS_PARAMS: 'x-colossus-params',
+    TRACE_ID: 'x-trace-id',
+    PROVIDER: 'x-vtex-provider',
+    USER_AGENT: 'user-agent',
+    VTEX_USER_AGENT: 'x-vtex-user-agent',
+    VTEX_IO_CALLER: 'x-vtex-io-caller',
+    VTEX_APP_SERVICE: 'x-vtex-app-service',
+    VTEX_APP_KEY: 'x-vtex-app-key',
+    VTEX_RETRY_COUNT: 'x-vtex-retry-count'
+};
+exports.AttributeKeys = {
+    // VTEX Semantic Attributes
+    VTEX_ACCOUNT_NAME: diagnostics_semconv_1.ATTR_VTEX_ACCOUNT_NAME,
+    // VTEX IO Semantic Attributes
+    VTEX_IO_WORKSPACE_NAME: diagnostics_semconv_1.ATTR_VTEX_IO_WORKSPACE_NAME,
+    VTEX_IO_WORKSPACE_TYPE: diagnostics_semconv_1.ATTR_VTEX_IO_WORKSPACE_TYPE,
+    VTEX_IO_APP_ID: diagnostics_semconv_1.ATTR_VTEX_IO_APP_ID,
+    VTEX_IO_APP_AUTHOR_TYPE: diagnostics_semconv_1.ATTR_VTEX_IO_APP_AUTHOR_TYPE,
+};
 exports.BODY_HASH = '__graphqlBodyHash';
 exports.UP_SIGNAL = 'UP';
 exports.MAX_AGE = {

package/lib/service/logger/logger.js

@@ -24,13 +24,14 @@ class Logger {
             const inflatedLog = {
                 __VTEX_IO_LOG: true,
                 level,
-                app,
-                account: this.account,
-                workspace: this.workspace,
-                production: this.production,
-                data,
+                [constants_1.AttributeKeys.VTEX_IO_APP_ID]: app,
+                [constants_1.AttributeKeys.VTEX_ACCOUNT_NAME]: this.account,
+                [constants_1.AttributeKeys.VTEX_IO_WORKSPACE_NAME]: this.workspace,
+                [constants_1.AttributeKeys.VTEX_IO_WORKSPACE_TYPE]: this.production ? 'production' : 'development',
+                [constants_1.AttributeKeys.VTEX_IO_APP_AUTHOR_TYPE]: constants_1.APP.IS_THIRD_PARTY() ? '3p' : '1p',
                 operationId: this.operationId,
                 requestId: this.requestId,
+                data,
                 ...(((_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

package/lib/service/tracing/tracingMiddlewares.js

@@ -44,13 +44,13 @@ const addTracingMiddleware = (tracer) => {
                     [Tags_1.OpentracingTags.HTTP_METHOD]: ctx.request.method,
                     [Tags_1.OpentracingTags.HTTP_STATUS_CODE]: ctx.response.status,
                     ["http.path" /* CustomHttpTags.HTTP_PATH */]: ctx.request.path,
-                    ["vtex.request_id" /* VTEXIncomingRequestTags.VTEX_REQUEST_ID */]: ctx.get(constants_1.REQUEST_ID_HEADER),
-                    ["vtex.incoming.workspace" /* VTEXIncomingRequestTags.VTEX_WORKSPACE */]: ctx.get(constants_1.WORKSPACE_HEADER),
-                    ["vtex.incoming.account" /* VTEXIncomingRequestTags.VTEX_ACCOUNT */]: ctx.get(constants_1.ACCOUNT_HEADER),
+                    ["vtex.request_id" /* VTEXIncomingRequestTags.VTEX_REQUEST_ID */]: ctx.get(constants_1.HeaderKeys.REQUEST_ID),
+                    ["vtex.incoming.workspace" /* VTEXIncomingRequestTags.VTEX_WORKSPACE */]: ctx.get(constants_1.HeaderKeys.WORKSPACE),
+                    ["vtex.incoming.account" /* VTEXIncomingRequestTags.VTEX_ACCOUNT */]: ctx.get(constants_1.HeaderKeys.ACCOUNT),
                 });
                 currentSpan === null || currentSpan === void 0 ? void 0 : currentSpan.log((0, utils_1.cloneAndSanitizeHeaders)(ctx.request.headers, 'req.headers.'));
                 currentSpan === null || currentSpan === void 0 ? void 0 : currentSpan.log((0, utils_1.cloneAndSanitizeHeaders)(ctx.response.headers, 'res.headers.'));
-                ctx.set(constants_1.TRACE_ID_HEADER, traceInfo.traceId);
+                ctx.set(constants_1.HeaderKeys.TRACE_ID, traceInfo.traceId);
             }
             const onResFinished = () => {
                 currentSpan === null || currentSpan === void 0 ? void 0 : currentSpan.finish();

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

@@ -30,7 +30,7 @@ const prometheusLoggerMiddleware = () => {
         if (ctx.request.path !== '/metrics') {
             return next();
         }
-        const routeId = ctx.get(constants_1.COLOSSUS_ROUTE_ID_HEADER);
+        const routeId = ctx.get(constants_1.HeaderKeys.COLOSSUS_ROUTE_ID);
         if (routeId) {
             return next();
         }

package/lib/service/worker/runtime/events/middlewares/context.js

@@ -8,12 +8,12 @@ async function eventContextMiddleware(ctx, next) {
     ctx.vtex = {
         ...(0, context_1.prepareHandlerCtx)(header, ctx.tracing),
         eventInfo: {
-            key: header[constants_1.EVENT_KEY_HEADER],
-            sender: header[constants_1.EVENT_SENDER_HEADER],
-            subject: header[constants_1.EVENT_SUBJECT_HEADER],
+            key: header[constants_1.HeaderKeys.EVENT_KEY],
+            sender: header[constants_1.HeaderKeys.EVENT_SENDER],
+            subject: header[constants_1.HeaderKeys.EVENT_SUBJECT],
         },
         route: {
-            id: header[constants_1.EVENT_HANDLER_ID_HEADER],
+            id: header[constants_1.HeaderKeys.EVENT_HANDLER_ID],
             params: {},
             type: 'event',
         },

package/lib/service/worker/runtime/events/router.js

@@ -6,7 +6,7 @@ const logger_1 = require("../../../logger");
 const console_1 = require("./../../../logger/console");
 const routerFromEventHandlers = (events) => {
     return async (ctx, next) => {
-        const handlerId = ctx.get(constants_1.EVENT_HANDLER_ID_HEADER);
+        const handlerId = ctx.get(constants_1.HeaderKeys.EVENT_HANDLER_ID);
         if (!handlerId || !events) {
             return next();
         }

package/lib/service/worker/runtime/graphql/middlewares/response.js

@@ -4,13 +4,13 @@ exports.response = void 0;
 const constants_1 = require("../../../../../constants");
 const cacheControl_1 = require("../utils/cacheControl");
 function setVaryHeaders(ctx, cacheControl) {
-    ctx.vary(constants_1.FORWARDED_HOST_HEADER);
+    ctx.vary(constants_1.HeaderKeys.FORWARDED_HOST);
     if (cacheControl.scope === 'segment') {
-        ctx.vary(constants_1.SEGMENT_HEADER);
+        ctx.vary(constants_1.HeaderKeys.SEGMENT);
     }
     if (cacheControl.scope === 'private' || ctx.query.scope === 'private') {
-        ctx.vary(constants_1.SEGMENT_HEADER);
-        ctx.vary(constants_1.SESSION_HEADER);
+        ctx.vary(constants_1.HeaderKeys.SEGMENT);
+        ctx.vary(constants_1.HeaderKeys.SESSION);
     }
     else if (ctx.vtex.sessionToken) {
         ctx.vtex.logger.warn({
@@ -24,11 +24,11 @@ async function response(ctx, next) {
     await next();
     const { cacheControl, status, graphqlResponse, } = ctx.graphql;
     const cacheControlHeader = (0, cacheControl_1.cacheControlHTTP)(ctx);
-    ctx.set(constants_1.CACHE_CONTROL_HEADER, cacheControlHeader);
+    ctx.set(constants_1.HeaderKeys.CACHE_CONTROL, cacheControlHeader);
     if (status === 'error') {
         // Do not generate etag for errors
-        ctx.remove(constants_1.META_HEADER);
-        ctx.remove(constants_1.ETAG_HEADER);
+        ctx.remove(constants_1.HeaderKeys.META);
+        ctx.remove(constants_1.HeaderKeys.ETAG);
         (_a = ctx.vtex.recorder) === null || _a === void 0 ? void 0 : _a.clear();
     }
     if (ctx.method.toUpperCase() === 'GET') {

package/lib/service/worker/runtime/graphql/middlewares/updateSchema.js

@@ -6,20 +6,20 @@ const utils_1 = require("../../../../../utils");
 const index_1 = require("../schema/index");
 const updateSchema = (graphql, executableSchema) => async function updateRunnableSchema(ctx, next) {
     const { clients: { apps }, vtex: { logger }, app, } = ctx;
-    if (!ctx.headers[constants_1.PROVIDER_HEADER]) {
+    if (!ctx.headers[constants_1.HeaderKeys.PROVIDER]) {
         await next();
         return;
     }
     // fetches the new schema and generate a new runnable schema, updates the provider app,
     if (executableSchema.hasProvider &&
         (!executableSchema.provider ||
-            (0, utils_1.majorEqualAndGreaterThan)((0, utils_1.parseAppId)(ctx.headers[constants_1.PROVIDER_HEADER]).version, (0, utils_1.parseAppId)(executableSchema.provider).version))) {
+            (0, utils_1.majorEqualAndGreaterThan)((0, utils_1.parseAppId)(ctx.headers[constants_1.HeaderKeys.PROVIDER]).version, (0, utils_1.parseAppId)(executableSchema.provider).version))) {
         try {
-            const newSchema = (await apps.getAppFile(ctx.headers[constants_1.PROVIDER_HEADER], 'public/schema.graphql')).data.toString('utf-8');
+            const newSchema = (await apps.getAppFile(ctx.headers[constants_1.HeaderKeys.PROVIDER], 'public/schema.graphql')).data.toString('utf-8');
             graphql.schema = newSchema;
             const newRunnableSchema = (0, index_1.makeSchema)(graphql);
             executableSchema.schema = newRunnableSchema.schema;
-            executableSchema.provider = ctx.headers[constants_1.PROVIDER_HEADER];
+            executableSchema.provider = ctx.headers[constants_1.HeaderKeys.PROVIDER];
         }
         catch (error) {
             logger.error({ error, message: 'Update schema failed', app });

package/lib/service/worker/runtime/http/middlewares/context.js

@@ -27,9 +27,9 @@ const createPubContextMiddleware = (routeId, { smartcache }) => {
             ...(0, context_1.prepareHandlerCtx)(header, ctx.tracing),
             ...(smartcache && { recorder: ctx.state.recorder }),
             route: {
-                declarer: header[constants_1.COLOSSUS_ROUTE_DECLARER_HEADER],
+                declarer: header[constants_1.HeaderKeys.COLOSSUS_ROUTE_DECLARER],
                 id: routeId,
-                params: (0, querystring_1.parse)(header[constants_1.COLOSSUS_PARAMS_HEADER]),
+                params: (0, querystring_1.parse)(header[constants_1.HeaderKeys.COLOSSUS_PARAMS]),
                 type: 'public',
             },
         };

package/lib/service/worker/runtime/http/middlewares/vary.js

@@ -6,17 +6,17 @@ const cachingStrategies = [
     {
         forbidden: [],
         path: '/_v/private/',
-        vary: [constants_1.SEGMENT_HEADER, constants_1.SESSION_HEADER],
+        vary: [constants_1.HeaderKeys.SEGMENT, constants_1.HeaderKeys.SESSION],
     },
     {
-        forbidden: [constants_1.SEGMENT_HEADER, constants_1.SESSION_HEADER],
+        forbidden: [constants_1.HeaderKeys.SEGMENT, constants_1.HeaderKeys.SESSION],
         path: '/_v/public/',
         vary: [],
     },
     {
-        forbidden: [constants_1.SESSION_HEADER],
+        forbidden: [constants_1.HeaderKeys.SESSION],
         path: '/_v/segment/',
-        vary: [constants_1.SEGMENT_HEADER],
+        vary: [constants_1.HeaderKeys.SEGMENT],
     },
 ];
 const shouldVaryByHeader = (ctx, header, strategy) => {
@@ -41,12 +41,12 @@ async function vary(ctx, next) {
         await next();
         return;
     }
-    ctx.vary(constants_1.LOCALE_HEADER);
-    if (shouldVaryByHeader(ctx, constants_1.SEGMENT_HEADER, strategy)) {
-        ctx.vary(constants_1.SEGMENT_HEADER);
+    ctx.vary(constants_1.HeaderKeys.LOCALE);
+    if (shouldVaryByHeader(ctx, constants_1.HeaderKeys.SEGMENT, strategy)) {
+        ctx.vary(constants_1.HeaderKeys.SEGMENT);
     }
-    if (shouldVaryByHeader(ctx, constants_1.SESSION_HEADER, strategy)) {
-        ctx.vary(constants_1.SESSION_HEADER);
+    if (shouldVaryByHeader(ctx, constants_1.HeaderKeys.SESSION, strategy)) {
+        ctx.vary(constants_1.HeaderKeys.SESSION);
     }
     await next();
 }

package/lib/service/worker/runtime/http/router.js

@@ -7,7 +7,7 @@ const console_1 = require("./../../../logger/console");
 const routerFromPublicHttpHandlers = (routes) => {
     return async (ctx, next) => {
         var _a;
-        const routeId = ctx.get(constants_1.COLOSSUS_ROUTE_ID_HEADER);
+        const routeId = ctx.get(constants_1.HeaderKeys.COLOSSUS_ROUTE_ID);
         if (!routeId) {
             return next();
         }

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

@@ -16,23 +16,23 @@ const getPlatform = (account) => {
 const prepareHandlerCtx = (header, tracingContext) => {
     var _a;
     const partialContext = {
-        account: header[constants_1.ACCOUNT_HEADER],
-        authToken: header[constants_1.CREDENTIAL_HEADER],
-        binding: header[constants_1.BINDING_HEADER] ? (0, binding_1.parseBindingHeaderValue)(header[constants_1.BINDING_HEADER]) : undefined,
-        host: header[constants_1.FORWARDED_HOST_HEADER],
-        locale: header[constants_1.LOCALE_HEADER],
-        operationId: header[constants_1.OPERATION_ID_HEADER] || (0, v4_1.default)(),
-        platform: header[constants_1.PLATFORM_HEADER] || getPlatform(header[constants_1.ACCOUNT_HEADER]),
-        product: header[constants_1.PRODUCT_HEADER],
-        production: ((_a = header[constants_1.WORKSPACE_IS_PRODUCTION_HEADER]) === null || _a === void 0 ? void 0 : _a.toLowerCase()) === 'true' || false,
+        account: header[constants_1.HeaderKeys.ACCOUNT],
+        authToken: header[constants_1.HeaderKeys.CREDENTIAL],
+        binding: header[constants_1.HeaderKeys.BINDING] ? (0, binding_1.parseBindingHeaderValue)(header[constants_1.HeaderKeys.BINDING]) : undefined,
+        host: header[constants_1.HeaderKeys.FORWARDED_HOST],
+        locale: header[constants_1.HeaderKeys.LOCALE],
+        operationId: header[constants_1.HeaderKeys.OPERATION_ID] || (0, v4_1.default)(),
+        platform: header[constants_1.HeaderKeys.PLATFORM] || getPlatform(header[constants_1.HeaderKeys.ACCOUNT]),
+        product: header[constants_1.HeaderKeys.PRODUCT],
+        production: ((_a = header[constants_1.HeaderKeys.WORKSPACE_IS_PRODUCTION]) === null || _a === void 0 ? void 0 : _a.toLowerCase()) === 'true' || false,
         region: constants_1.REGION,
-        requestId: header[constants_1.REQUEST_ID_HEADER],
-        segmentToken: header[constants_1.SEGMENT_HEADER],
-        sessionToken: header[constants_1.SESSION_HEADER],
-        tenant: header[constants_1.TENANT_HEADER] ? (0, tenant_1.parseTenantHeaderValue)(header[constants_1.TENANT_HEADER]) : undefined,
+        requestId: header[constants_1.HeaderKeys.REQUEST_ID],
+        segmentToken: header[constants_1.HeaderKeys.SEGMENT],
+        sessionToken: header[constants_1.HeaderKeys.SESSION],
+        tenant: header[constants_1.HeaderKeys.TENANT] ? (0, tenant_1.parseTenantHeaderValue)(header[constants_1.HeaderKeys.TENANT]) : undefined,
         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],
+        workspace: header[constants_1.HeaderKeys.WORKSPACE],
     };
     return {
         ...partialContext,

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

@@ -3,7 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.Recorder = void 0;
 const ramda_1 = require("ramda");
 const constants_1 = require("./../../../../constants");
-const HEADERS = [constants_1.META_HEADER, constants_1.META_HEADER_BUCKET];
+const HEADERS = [constants_1.HeaderKeys.META, constants_1.HeaderKeys.META_BUCKET];
 class Recorder {
     constructor() {
         this._record = HEADERS.reduce((acc, headerName) => {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vtex/api",
-  "version": "7.2.1-beta.2",
+  "version": "7.2.2-beta.0",
   "description": "VTEX I/O API client",
   "main": "lib/index.js",
   "typings": "lib/index.d.ts",
@@ -54,6 +54,7 @@
     "@types/koa": "^2.11.0",
     "@types/koa-compose": "^3.2.3",
     "@vtex/diagnostics-nodejs": "0.1.0-io-beta.20",
+    "@vtex/diagnostics-semconv": "^1.1.2",
     "@vtex/node-error-report": "^0.0.3",
     "@wry/equality": "^0.1.9",
     "agentkeepalive": "^4.0.2",