@vtex/api 6.45.25-beta.0 → 6.46.0

package/CHANGELOG.md

@@ -7,10 +7,18 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ## [Unreleased]
 
+## [6.46.0] - 2023-10-25
+### Added
+- Add disk cache steps and retry count to tracing
+
+### Changed
+- Stop updating client cache when revalidated and still expired
+
 ## [6.45.24] - 2023-10-05
 ### Added
 
 - Allow disabling memoization for all requests of a client
+
 ## [6.45.23] - 2023-10-04
 
 ### Fixed

package/lib/HttpClient/middlewares/cache.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 const constants_1 = require("../../constants");
+const tracing_1 = require("../../tracing");
 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
 exports.cacheKey = (config) => {
@@ -59,7 +60,7 @@ exports.cacheMiddleware = ({ type, storage }) => {
         if (!isLocallyCacheable(ctx.config, type)) {
             return await next();
         }
-        const span = (_a = ctx.tracing) === null || _a === void 0 ? void 0 : _a.rootSpan;
+        const { rootSpan: span, tracer, logger } = (_a = ctx.tracing) !== null && _a !== void 0 ? _a : {};
         const key = exports.cacheKey(ctx.config);
         const segmentToken = ctx.config.headers[constants_1.SEGMENT_HEADER];
         const keyWithSegment = key + segmentToken;
@@ -69,8 +70,19 @@ exports.cacheMiddleware = ({ type, storage }) => {
             ["key" /* KEY */]: key,
             ["key-with-segment" /* KEY_WITH_SEGMENT */]: keyWithSegment,
         });
-        const cacheHasWithSegment = await storage.has(keyWithSegment);
-        const cached = cacheHasWithSegment ? await storage.get(keyWithSegment) : await storage.get(key);
+        const cacheReadSpan = createCacheSpan(cacheType, 'read', tracer, span);
+        let cached;
+        try {
+            const cacheHasWithSegment = await storage.has(keyWithSegment);
+            cached = cacheHasWithSegment ? await storage.get(keyWithSegment) : await storage.get(key);
+        }
+        catch (error) {
+            tracing_1.ErrorReport.create({ originalError: error }).injectOnSpan(cacheReadSpan);
+            logger === null || logger === void 0 ? void 0 : logger.warn({ message: 'Error reading from the HttpClient cache', error });
+        }
+        finally {
+            cacheReadSpan === null || cacheReadSpan === void 0 ? void 0 : cacheReadSpan.finish();
+        }
         if (cached && cached.response) {
             const { etag: cachedEtag, response, expiration, responseType, responseEncoding } = cached;
             if (type === CacheType.Disk && responseType === 'arraybuffer') {
@@ -149,26 +161,48 @@ exports.cacheMiddleware = ({ type, storage }) => {
             const cacheableData = type === CacheType.Disk && responseType === 'arraybuffer'
                 ? data.toString(responseEncoding)
                 : data;
-            const expiration = Date.now() + (maxAge - currentAge) * 1000;
-            storage.set(setKey, {
-                etag,
-                expiration,
-                response: { data: cacheableData, headers, status },
-                responseEncoding,
-                responseType,
-            });
-            span === null || span === void 0 ? void 0 : span.log({
-                event: "local-cache-saved" /* LOCAL_CACHE_SAVED */,
-                ["cache-type" /* CACHE_TYPE */]: cacheType,
-                ["key-set" /* KEY_SET */]: setKey,
-                ["age" /* AGE */]: currentAge,
-                ["etag" /* ETAG */]: etag,
-                ["expiration-time" /* EXPIRATION_TIME */]: (expiration - Date.now()) / 1000,
-                ["response-encoding" /* RESPONSE_ENCONDING */]: responseEncoding,
-                ["response-type" /* RESPONSE_TYPE */]: responseType,
-            });
+            const now = Date.now();
+            const expiration = now + (maxAge - currentAge) * 1000;
+            const alreadyExpired = expiration <= now;
+            const reusingRevalidatedCache = cached && (ctx.response === cached.response);
+            const shouldSkipCacheUpdate = alreadyExpired && reusingRevalidatedCache;
+            if (shouldSkipCacheUpdate) {
+                return;
+            }
+            const cacheWriteSpan = createCacheSpan(cacheType, 'write', tracer, span);
+            try {
+                await storage.set(setKey, {
+                    etag,
+                    expiration,
+                    response: { data: cacheableData, headers, status },
+                    responseEncoding,
+                    responseType,
+                });
+                span === null || span === void 0 ? void 0 : span.log({
+                    event: "local-cache-saved" /* LOCAL_CACHE_SAVED */,
+                    ["cache-type" /* CACHE_TYPE */]: cacheType,
+                    ["key-set" /* KEY_SET */]: setKey,
+                    ["age" /* AGE */]: currentAge,
+                    ["etag" /* ETAG */]: etag,
+                    ["expiration-time" /* EXPIRATION_TIME */]: (expiration - Date.now()) / 1000,
+                    ["response-encoding" /* RESPONSE_ENCONDING */]: responseEncoding,
+                    ["response-type" /* RESPONSE_TYPE */]: responseType,
+                });
+            }
+            catch (error) {
+                tracing_1.ErrorReport.create({ originalError: error }).injectOnSpan(cacheWriteSpan);
+                logger === null || logger === void 0 ? void 0 : logger.warn({ message: 'Error writing to the HttpClient cache', error });
+            }
+            finally {
+                cacheWriteSpan === null || cacheWriteSpan === void 0 ? void 0 : cacheWriteSpan.finish();
+            }
             return;
         }
         span === null || span === void 0 ? void 0 : span.log({ event: "no-local-cache-save" /* NO_LOCAL_CACHE_SAVE */, ["cache-type" /* CACHE_TYPE */]: cacheType });
     };
 };
+const createCacheSpan = (cacheType, operation, tracer, parentSpan) => {
+    if (tracer && tracer.isTraceSampled && cacheType === 'disk') {
+        return tracer.startSpan(`${operation}-disk-cache`, { childOf: parentSpan });
+    }
+};

package/lib/HttpClient/middlewares/request/setupAxios/interceptors/exponentialBackoff.js

@@ -18,7 +18,7 @@ const exponentialDelay = (initialBackoffDelay, exponentialBackoffCoefficient, re
 // A lot of this code is based on:
 // https://github.com/softonic/axios-retry/blob/ffd4327f31d063522e58c525d28d4c5053d0ea7b/es/index.js#L109
 const onResponseError = (http) => (error) => {
-    var _a, _b;
+    var _a, _b, _c, _d;
     if (error.config == null) {
         return Promise.reject(error);
     }
@@ -40,6 +40,10 @@ const onResponseError = (http) => (error) => {
             : config.timeout;
         config.transformRequest = [data => data];
         (_b = (_a = config.tracing) === null || _a === void 0 ? void 0 : _a.rootSpan) === null || _b === void 0 ? void 0 : _b.log({ event: "setup-request-retry" /* SETUP_REQUEST_RETRY */, ["retry-number" /* RETRY_NUMBER */]: config.retryCount, ["retry-in" /* RETRY_IN */]: delay });
+        (_d = (_c = config.tracing) === null || _c === void 0 ? void 0 : _c.rootSpan) === null || _d === void 0 ? void 0 : _d.addTags({
+            ["http.retry.count" /* HTTP_RETRY_COUNT */]: config.retryCount,
+            ["http.retry.error.code" /* HTTP_RETRY_ERROR_CODE */]: error.code,
+        });
         return new Promise(resolve => setTimeout(() => resolve(http(config)), delay));
     }
     return Promise.reject(error);

package/lib/tracing/Tags.d.ts

@@ -51,7 +51,9 @@ export declare const enum CustomHttpTags {
     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_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";

package/package.json

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