@vtex/api 6.49.3-beta.2 → 6.49.3-beta.4

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[constants_1.LOCALE_HEADER];
+    const locale = headers === null || headers === void 0 ? void 0 : headers[constants_1.LOCALE_HEADER];
     const encodedBaseURL = baseURL.replace(/\//g, '\\');
     const encodedURL = url.replace(/\//g, '\\');
     let key = `${locale}--${encodedBaseURL}--${encodedURL}?`;
@@ -58,13 +58,13 @@ const cacheMiddleware = ({ type, storage, asyncSet }) => {
     const CACHE_RESULT_TAG = type === CacheType.Disk ? "http.cache.disk" /* CustomHttpTags.HTTP_DISK_CACHE_RESULT */ : "http.cache.memory" /* CustomHttpTags.HTTP_MEMORY_CACHE_RESULT */;
     const cacheType = CacheTypeNames[type];
     return async (ctx, next) => {
-        var _a;
+        var _a, _b;
         if (!isLocallyCacheable(ctx.config, type)) {
             return await next();
         }
         const { rootSpan: span, tracer, logger } = (_a = ctx.tracing) !== null && _a !== void 0 ? _a : {};
         const key = (0, exports.cacheKey)(ctx.config);
-        const segmentToken = ctx.config.headers[constants_1.SEGMENT_HEADER];
+        const segmentToken = (_b = ctx.config.headers) === null || _b === void 0 ? void 0 : _b[constants_1.SEGMENT_HEADER];
         const keyWithSegment = key + segmentToken;
         span === null || span === void 0 ? void 0 : span.log({
             event: "cache-key-created" /* HttpLogEvents.CACHE_KEY_CREATE */,
@@ -112,7 +112,10 @@ const cacheMiddleware = ({ type, storage, asyncSet }) => {
             span === null || span === void 0 ? void 0 : span.setTag(CACHE_RESULT_TAG, "STALE" /* CacheResult.STALE */);
             const validateStatus = addNotModified(ctx.config.validateStatus);
             if (cachedEtag && validateStatus(response.status)) {
-                ctx.config.headers['if-none-match'] = cachedEtag;
+                ctx.config.headers = {
+                    ...ctx.config.headers,
+                    'if-none-match': cachedEtag
+                };
                 ctx.config.validateStatus = validateStatus;
             }
         }
@@ -177,7 +180,7 @@ const cacheMiddleware = ({ type, storage, asyncSet }) => {
                     etag,
                     expiration,
                     response: { data: cacheableData, headers, status },
-                    responseEncoding,
+                    responseEncoding: responseEncoding,
                     responseType,
                 });
                 if (asyncSet) {

package/lib/HttpClient/middlewares/request/index.js

@@ -4,7 +4,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.requestMiddleware = exports.routerCacheMiddleware = exports.defaultsMiddleware = void 0;
-const buildFullPath_1 = __importDefault(require("axios/lib/core/buildFullPath"));
+const buildFullPath_1 = __importDefault(require("../../../utils/buildFullPath"));
 const qs_1 = require("qs");
 const ramda_1 = require("ramda");
 const Tags_1 = require("../../../tracing/Tags");

package/lib/HttpClient/middlewares/request/setupAxios/index.d.ts

@@ -1 +1,2 @@
+/// <reference types="axios" />
 export declare const getConfiguredAxios: () => import("axios").AxiosInstance;

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

@@ -4,7 +4,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.injectResponseInfoOnSpan = exports.injectRequestInfoOnSpan = void 0;
-const buildFullPath_1 = __importDefault(require("axios/lib/core/buildFullPath"));
+const buildFullPath_1 = __importDefault(require("../../../../../../utils/buildFullPath"));
 const constants_1 = require("../../../../../../constants");
 const Tags_1 = require("../../../../../../tracing/Tags");
 const utils_1 = require("../../../../../../tracing/utils");

package/lib/HttpClient/typings.d.ts

@@ -44,7 +44,7 @@ export interface RequestConfig extends AxiosRequestConfig, RequestTracingConfig
     memoizeable?: boolean;
     inflightKey?: InflightKeyGenerator;
     forceMaxAge?: number;
-    responseEncoding?: BufferEncoding;
+    responseEncoding?: BufferEncoding | string;
     nullIfNotFound?: boolean;
     ignoreRecorder?: boolean;
 }

package/lib/caches/MultilayeredCache.js

@@ -8,7 +8,7 @@ class MultilayeredCache {
         this.hits = 0;
         this.total = 0;
         this.get = async (key, fetcher) => {
-            let value;
+            let value = undefined;
             let maxAge;
             let successIndex = await this.findIndex(async (cache) => {
                 const [getValue, hasKey] = await Promise.all([cache.get(key), cache.has(key)]);

package/lib/clients/infra/VBase.js

@@ -139,7 +139,7 @@ class VBase extends InfraClient_1.InfraClient {
             return this.saveContent(bucket, path, stream, { unzip: true }, tracingConfig, ifMatch);
         };
         this.deleteFile = (bucket, path, tracingConfig, ifMatch) => {
-            const headers = ifMatch ? { 'If-Match': ifMatch } : null;
+            const headers = ifMatch ? { 'If-Match': ifMatch } : {};
             const metric = 'vbase-delete-file';
             return this.http.delete(routes.File(bucket, path), { headers, metric, tracing: {
                     requestSpanNameSuffix: metric,

package/lib/service/worker/runtime/graphql/schema/schemaDirectives/Auth.js

@@ -41,7 +41,7 @@ async function auth(ctx, authArgs) {
         throw new apollo_server_errors_1.AuthenticationError('VtexIdclientAutCookie not found.');
     }
     const parsedToken = await parseIdToken(ctx.vtex.authToken, vtexIdToken);
-    if (!parsedToken || parsedToken.account != ctx.vtex.account) {
+    if (!parsedToken || parsedToken.account !== ctx.vtex.account) {
         throw new apollo_server_errors_1.AuthenticationError('Could not find user specified by VtexIdclientAutCookie.');
     }
     const userCanAccessResource = await getUserCanAccessResource(ctx.vtex.authToken, ctx.vtex.account, parsedToken.user, authArgs.productCode, authArgs.resourceCode);

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

@@ -62,7 +62,7 @@ async function error(ctx, next) {
         console.error('[node-vtex-api error]', e);
         const err = (0, error_1.cleanError)(e);
         // Add response
-        ctx.status = e && e.status >= 400 && e.status <= 599
+        ctx.status = (e === null || e === void 0 ? void 0 : e.status) && e.status >= 400 && e.status <= 599
             ? e.status
             : ctx.status >= 500 && ctx.status <= 599
                 ? ctx.status

package/lib/tracing/utils.d.ts

@@ -3,9 +3,14 @@ export interface TraceInfo {
     traceId?: string;
     isSampled: boolean;
 }
+/**
+ * Headers that are interesting for tracing and debugging purposes
+ */
+export declare const INTERESTING_HEADERS: string[];
 export declare function getTraceInfo(span?: Span): TraceInfo;
 /**
  * Do a shallow copy of a headers object and redacts sensitive information.
+ * Only includes headers that are in the INTERESTING_HEADERS whitelist.
  *
  * @param headersObj The headers object
  * @param resultFieldsPrefix The prefix that will be added to each field on the result object

package/lib/tracing/utils.js

@@ -1,7 +1,53 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.cloneAndSanitizeHeaders = exports.getTraceInfo = void 0;
+exports.cloneAndSanitizeHeaders = exports.getTraceInfo = exports.INTERESTING_HEADERS = void 0;
 const node_error_report_1 = require("@vtex/node-error-report");
+/**
+ * Headers that are interesting for tracing and debugging purposes
+ */
+exports.INTERESTING_HEADERS = [
+    // Request/Response Identification & Routing
+    'x-request-id',
+    'x-correlation-id',
+    'x-trace-id',
+    'x-span-id',
+    'x-forwarded-for',
+    'x-real-ip',
+    'host',
+    'referer',
+    // Content & Encoding
+    'content-type',
+    'content-length',
+    'content-encoding',
+    'accept',
+    'accept-encoding',
+    'accept-language',
+    // Caching & Performance
+    'cache-control',
+    'etag',
+    'if-none-match',
+    'expires',
+    'last-modified',
+    // Client Information
+    'user-agent',
+    'x-forwarded-proto',
+    'x-forwarded-host',
+    'x-forwarded-port',
+    // VTEX/E-commerce Specific (x-vtex-* headers are handled automatically)
+    'x-router-cache',
+    'x-powered-by-vtex-cache',
+    'jaeger-debug-id',
+    // API & Service Headers
+    'x-api-version',
+    'x-service-name',
+    'x-timeout',
+    'retry-after',
+    // Security (will be sanitized)
+    'authorization',
+    'cookie',
+];
+// Create the set once for performance
+const INTERESTING_HEADERS_SET = new Set(exports.INTERESTING_HEADERS.map(h => h.toLowerCase()));
 function getTraceInfo(span) {
     var _a, _b;
     const spanContext = span === null || span === void 0 ? void 0 : span.context();
@@ -13,6 +59,7 @@ function getTraceInfo(span) {
 exports.getTraceInfo = getTraceInfo;
 /**
  * Do a shallow copy of a headers object and redacts sensitive information.
+ * Only includes headers that are in the INTERESTING_HEADERS whitelist.
  *
  * @param headersObj The headers object
  * @param resultFieldsPrefix The prefix that will be added to each field on the result object
@@ -21,6 +68,11 @@ const cloneAndSanitizeHeaders = (headersObj, resultFieldsPrefix = '') => {
     const ret = {};
     const entries = Object.entries(headersObj);
     for (const [key, val] of entries) {
+        const lowerKey = key.toLowerCase();
+        // Only include headers that are in our whitelist or start with x-vtex-
+        if (!INTERESTING_HEADERS_SET.has(lowerKey) && !lowerKey.startsWith('x-vtex-')) {
+            continue;
+        }
         // 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:
         // ```

package/lib/utils/buildFullPath.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Creates a new URL by combining the baseURL with the requestedURL,
+ * only when the requestedURL is not already an absolute URL.
+ * If the requestURL is absolute, this function returns the requestedURL untouched.
+ *
+ * @param {string} baseURL The base URL
+ * @param {string} requestedURL Absolute or relative URL to combine
+ *
+ * @returns {string} The combined full path
+ */
+export default function (baseURL?: string, requestedURL?: string, allowAbsoluteUrls?: boolean): string | undefined;

package/lib/utils/buildFullPath.js

@@ -0,0 +1,54 @@
+"use strict";
+// This module is part of the Axios library.
+// It is used to build a full URL by combining a base URL with a relative URL.
+Object.defineProperty(exports, "__esModule", { value: true });
+// It is originally not intended to be used directly, but rather as a utility function within the Axios library.
+// Since Axios 1.0, this function is not exported by default, and the team does not recommend using it directly, 
+// as it may not be available in future versions.
+// The function takes a base URL and a relative URL as input, and returns the full URL.
+// It handles both absolute and relative URLs, and ensures that the resulting URL is properly formatted.
+// It is used internally by Axios to construct the full URL for HTTP requests.
+/**
+ * Creates a new URL by combining the baseURL with the requestedURL,
+ * only when the requestedURL is not already an absolute URL.
+ * If the requestURL is absolute, this function returns the requestedURL untouched.
+ *
+ * @param {string} baseURL The base URL
+ * @param {string} requestedURL Absolute or relative URL to combine
+ *
+ * @returns {string} The combined full path
+ */
+function default_1(baseURL, requestedURL, allowAbsoluteUrls) {
+    let isRelativeUrl = !isAbsoluteURL(requestedURL);
+    if (baseURL && (isRelativeUrl || allowAbsoluteUrls == false)) {
+        return combineURLs(baseURL, requestedURL);
+    }
+    return requestedURL;
+}
+exports.default = default_1;
+/**
+ * Determines whether the specified URL is absolute
+ *
+ * @param {string} url The URL to test
+ *
+ * @returns {boolean} True if the specified URL is absolute, otherwise false
+ */
+function isAbsoluteURL(url) {
+    // A URL is considered absolute if it begins with "<scheme>://" or "//" (protocol-relative URL).
+    // RFC 3986 defines scheme name as a sequence of characters beginning with a letter and followed
+    // by any combination of letters, digits, plus, period, or hyphen.
+    return !!url && /^([a-z][a-z\d+\-.]*:)?\/\//i.test(url);
+}
+/**
+ * Creates a new URL by combining the specified URLs
+ *
+ * @param {string} baseURL The base URL
+ * @param {string} relativeURL The relative URL
+ *
+ * @returns {string} The combined URL
+ */
+function combineURLs(baseURL, relativeURL) {
+    return relativeURL && baseURL
+        ? baseURL.replace(/\/?\/$/, '') + '/' + relativeURL.replace(/^\/+/, '')
+        : baseURL;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vtex/api",
-  "version": "6.49.3-beta.2",
+  "version": "6.49.3-beta.4",
   "description": "VTEX I/O API client",
   "main": "lib/index.js",
   "typings": "lib/index.d.ts",
@@ -18,8 +18,6 @@
     "format": "prettier --config ./.prettierrc --write \"src/**/*.ts\" \"src/**/*.js\"",
     "format-lint": "yarn format && yarn lint",
     "prepublishOnly": "bash ./scripts/publishLock.sh",
-    "postinstall": "patch-package",
-    "prebuild": "patch-package",
     "ci:build": "yarn build && yarn gen",
     "ci:test": "yarn test --ci",
     "ci:prettier-check": "prettier --check --config ./.prettierrc \"src/**/*.ts\" \"src/**/*.js\""
@@ -51,13 +49,13 @@
   "dependencies": {
     "@types/koa": "^2.11.0",
     "@types/koa-compose": "^3.2.3",
-    "@vtex/diagnostics-nodejs": "0.1.0-beta.10",
+    "@vtex/diagnostics-nodejs": "0.1.0-beta.8",
     "@vtex/node-error-report": "^0.0.3",
     "@wry/equality": "^0.1.9",
     "agentkeepalive": "^4.0.2",
     "apollo-server-errors": "^2.2.1",
     "archiver": "^3.0.0",
-    "axios": "^0.21.1",
+    "axios": "^1.8.4",
     "axios-retry": "^3.1.2",
     "bluebird": "^3.5.4",
     "chalk": "^2.4.2",
@@ -79,8 +77,6 @@
     "mime-types": "^2.1.12",
     "opentracing": "^0.14.4",
     "p-limit": "^2.2.0",
-    "patch-package": "^8.0.0",
-    "postinstall-postinstall": "^2.1.0",
     "prom-client": "^14.2.0",
     "qs": "^6.5.1",
     "querystring": "^0.2.0",
@@ -128,5 +124,26 @@
     "typemoq": "^2.1.0",
     "typescript": "^4.4.4",
     "typescript-json-schema": "^0.52.0"
+  },
+  "resolutions": {
+    "@opentelemetry/core": "1.30.1",
+    "@opentelemetry/exporter-metrics-otlp-grpc": "0.57.2",
+    "@opentelemetry/exporter-metrics-otlp-http": "0.57.2",
+    "@opentelemetry/exporter-logs-otlp-grpc": "0.57.2",
+    "@opentelemetry/exporter-logs-otlp-http": "0.57.2",
+    "@opentelemetry/exporter-trace-otlp-grpc": "0.57.2",
+    "@opentelemetry/exporter-trace-otlp-http": "0.57.2",
+    "@opentelemetry/instrumentation": "0.57.2",
+    "@opentelemetry/instrumentation-http": "0.57.2",
+    "@opentelemetry/instrumentation-grpc": "0.57.2",
+    "@opentelemetry/instrumentation-net": "0.43.1",
+    "@opentelemetry/propagator-b3": "1.30.1",
+    "@opentelemetry/resource-detector-aws": "1.12.0",
+    "@opentelemetry/resources": "1.30.1",
+    "@opentelemetry/sdk-node": "0.57.2",
+    "@opentelemetry/sdk-logs": "0.57.2",
+    "@opentelemetry/sdk-metrics": "1.30.1",
+    "@opentelemetry/sdk-trace-base": "1.30.1",
+    "@opentelemetry/sdk-trace-node": "1.30.1"
   }
 }