@vtex/api 6.45.23 → 6.45.25-beta.0

package/CHANGELOG.md

@@ -7,6 +7,10 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ## [Unreleased]
 
+## [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/HttpClient.d.ts

@@ -8,6 +8,7 @@ export declare class HttpClient {
     name: string;
     private logger;
     private cacheableType;
+    private memoizable;
     private runMiddlewares;
     constructor(opts: ClientOptions);
     get: <T = any>(url: string, config?: RequestConfig) => Promise<T>;

package/lib/HttpClient/HttpClient.js

@@ -97,14 +97,15 @@ class HttpClient {
         };
         this.getConfig = (url, config = {}) => ({
             cacheable: this.cacheableType,
-            memoizable: true,
+            memoizable: this.memoizable,
             ...config,
             url,
         });
-        const { baseURL, authToken, authType, memoryCache, diskCache, locale, name, metrics, product, serverTiming, recorder, userAgent, timeout = DEFAULT_TIMEOUT_MS, segmentToken, sessionToken, retries, concurrency, headers: defaultHeaders, host, params, operationId, tenant, binding, verbose, cancellation, exponentialTimeoutCoefficient, initialBackoffDelay, exponentialBackoffCoefficient, httpsAgent, tracer, logger, cacheableType = cache_1.CacheType.Memory, } = opts;
+        const { baseURL, authToken, authType, memoryCache, diskCache, memoizable = true, locale, name, metrics, product, serverTiming, recorder, userAgent, timeout = DEFAULT_TIMEOUT_MS, segmentToken, sessionToken, retries, concurrency, headers: defaultHeaders, host, params, operationId, tenant, binding, verbose, cancellation, exponentialTimeoutCoefficient, initialBackoffDelay, exponentialBackoffCoefficient, httpsAgent, tracer, logger, cacheableType = cache_1.CacheType.Memory, } = opts;
         this.name = name || baseURL || 'unknown';
         this.logger = logger;
         this.cacheableType = cacheableType;
+        this.memoizable = memoizable;
         const limit = concurrency && concurrency > 0 && p_limit_1.default(concurrency) || undefined;
         const headers = {
             ...defaultHeaders,

package/lib/HttpClient/middlewares/cache.js

@@ -150,7 +150,7 @@ exports.cacheMiddleware = ({ type, storage }) => {
                 ? data.toString(responseEncoding)
                 : data;
             const expiration = Date.now() + (maxAge - currentAge) * 1000;
-            await storage.set(setKey, {
+            storage.set(setKey, {
                 etag,
                 expiration,
                 response: { data: cacheableData, headers, status },

package/lib/HttpClient/typings.d.ts

@@ -74,6 +74,16 @@ export interface InstanceOptions {
     timeout?: number;
     memoryCache?: CacheLayer<string, Cached>;
     diskCache?: CacheLayer<string, Cached>;
+    /**
+     * Enables memoization, ephemeral within each request, for all requests of this client.
+     * Useful for services that makes recursive requests, like graphql resolvers, which
+     * might fetch the same endpoint more than once.
+     * If that's not the case for your service, disabling it might improve the CPU and
+     * memory usage.
+     *
+     * Default value: true
+     */
+    memoizable?: boolean;
     baseURL?: string;
     retries?: number;
     exponentialTimeoutCoefficient?: number;

package/package.json

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