Merge pull request #547 from vtex/feat/disableMemoFlag

Allow disabling memoization for all requests of a client

Author: filafb

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.json

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

src/HttpClient/HttpClient.ts

@@ -39,6 +39,7 @@ export class HttpClient {
 
   private logger: Logger
   private cacheableType: CacheType
+  private memoizable: boolean
 
   private runMiddlewares: compose.ComposedMiddleware<MiddlewareContext>
 
@@ -49,6 +50,7 @@ export class HttpClient {
       authType,
       memoryCache,
       diskCache,
+      memoizable = true,
       locale,
       name,
       metrics,
@@ -79,6 +81,7 @@ export class HttpClient {
     this.name = name || baseURL || 'unknown'
     this.logger = logger
     this.cacheableType = cacheableType
+    this.memoizable = memoizable
 
     const limit = concurrency && concurrency > 0 && pLimit(concurrency) || undefined
     const headers: Record<string, string> = {
@@ -210,7 +213,7 @@ export class HttpClient {
 
   private getConfig = (url: string, config: RequestConfig = {}): CacheableRequestConfig => ({
     cacheable: this.cacheableType,
-    memoizable: true,
+    memoizable: this.memoizable,
     ...config,
     url,
   })

src/HttpClient/typings.ts

@@ -83,6 +83,18 @@ 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