@vtex/api 6.45.22 → 6.45.24

package/CHANGELOG.md

@@ -7,6 +7,15 @@ 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
+- Fix metrics being restricted by tracing restrictions
+
 ## [6.45.22] - 2023-09-20
 
 ### Removed

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/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/lib/service/metrics/requestMetricsMiddleware.d.ts

@@ -0,0 +1,2 @@
+import { ServiceContext } from '../worker/runtime/typings';
+export declare const addRequestMetricsMiddleware: () => (ctx: ServiceContext<import("../..").IOClients, import("../worker/runtime/typings").RecorderState, import("../worker/runtime/typings").ParamsContext>, next: () => Promise<void>) => Promise<void>;

package/lib/service/metrics/requestMetricsMiddleware.js

@@ -0,0 +1,44 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const stream_1 = require("stream");
+const utils_1 = require("../../utils");
+const instruments_1 = require("../tracing/metrics/instruments");
+exports.addRequestMetricsMiddleware = () => {
+    const concurrentRequests = instruments_1.createConcurrentRequestsInstrument();
+    const requestTimings = instruments_1.createRequestsTimingsInstrument();
+    const totalRequests = instruments_1.createTotalRequestsInstrument();
+    const responseSizes = instruments_1.createRequestsResponseSizesInstrument();
+    const abortedRequests = instruments_1.createTotalAbortedRequestsInstrument();
+    return async function addRequestMetrics(ctx, next) {
+        const start = process.hrtime();
+        concurrentRequests.inc(1);
+        ctx.req.once('aborted', () => abortedRequests.inc({ ["handler" /* REQUEST_HANDLER */]: ctx.requestHandlerName }, 1));
+        let responseClosed = false;
+        ctx.res.once('close', () => (responseClosed = true));
+        try {
+            await next();
+        }
+        finally {
+            const responseLength = ctx.response.length;
+            if (responseLength) {
+                responseSizes.observe({ ["handler" /* REQUEST_HANDLER */]: ctx.requestHandlerName }, responseLength);
+            }
+            totalRequests.inc({
+                ["handler" /* REQUEST_HANDLER */]: ctx.requestHandlerName,
+                ["status_code" /* STATUS_CODE */]: ctx.response.status,
+            }, 1);
+            const onResFinished = () => {
+                requestTimings.observe({
+                    ["handler" /* REQUEST_HANDLER */]: ctx.requestHandlerName,
+                }, utils_1.hrToMillisFloat(process.hrtime(start)));
+                concurrentRequests.dec(1);
+            };
+            if (responseClosed) {
+                onResFinished();
+            }
+            else {
+                stream_1.finished(ctx.res, onResFinished);
+            }
+        }
+    };
+};

package/lib/service/tracing/tracingMiddlewares.js

@@ -7,23 +7,14 @@ const tracing_1 = require("../../tracing");
 const Tags_1 = require("../../tracing/Tags");
 const utils_1 = require("../../tracing/utils");
 const utils_2 = require("../../utils");
-const instruments_1 = require("./metrics/instruments");
 const PATHS_BLACKLISTED_FOR_TRACING = ['/_status', '/healthcheck'];
 exports.addTracingMiddleware = (tracer) => {
-    const concurrentRequests = instruments_1.createConcurrentRequestsInstrument();
-    const requestTimings = instruments_1.createRequestsTimingsInstrument();
-    const totalRequests = instruments_1.createTotalRequestsInstrument();
-    const responseSizes = instruments_1.createRequestsResponseSizesInstrument();
-    const abortedRequests = instruments_1.createTotalAbortedRequestsInstrument();
     return async function addTracing(ctx, next) {
         var _a;
-        const start = process.hrtime();
-        concurrentRequests.inc(1);
         const rootSpan = tracer.extract(opentracing_1.FORMAT_HTTP_HEADERS, ctx.request.headers);
         ctx.tracing = { tracer, currentSpan: undefined };
         if (!shouldTrace(ctx, rootSpan)) {
             await next();
-            concurrentRequests.dec(1);
             return;
         }
         const currentSpan = tracer.startSpan('unknown-operation', {
@@ -32,7 +23,6 @@ exports.addTracingMiddleware = (tracer) => {
         });
         const initialSamplingDecision = tracing_1.getTraceInfo(currentSpan).isSampled;
         ctx.tracing = { currentSpan, tracer };
-        ctx.req.once('aborted', () => abortedRequests.inc({ ["handler" /* REQUEST_HANDLER */]: currentSpan.operationName }, 1));
         let responseClosed = false;
         ctx.res.once('close', () => (responseClosed = true));
         try {
@@ -43,14 +33,6 @@ exports.addTracingMiddleware = (tracer) => {
             throw err;
         }
         finally {
-            const responseLength = ctx.response.length;
-            if (responseLength) {
-                responseSizes.observe({ ["handler" /* REQUEST_HANDLER */]: currentSpan.operationName }, responseLength);
-            }
-            totalRequests.inc({
-                ["handler" /* REQUEST_HANDLER */]: currentSpan.operationName,
-                ["status_code" /* STATUS_CODE */]: ctx.response.status,
-            }, 1);
             const traceInfo = tracing_1.getTraceInfo(currentSpan);
             if (traceInfo === null || traceInfo === void 0 ? void 0 : traceInfo.isSampled) {
                 if (!initialSamplingDecision) {
@@ -70,10 +52,6 @@ exports.addTracingMiddleware = (tracer) => {
                 ctx.set(constants_1.TRACE_ID_HEADER, traceInfo.traceId);
             }
             const onResFinished = () => {
-                requestTimings.observe({
-                    ["handler" /* REQUEST_HANDLER */]: currentSpan.operationName,
-                }, utils_2.hrToMillisFloat(process.hrtime(start)));
-                concurrentRequests.dec(1);
                 currentSpan === null || currentSpan === void 0 ? void 0 : currentSpan.finish();
             };
             if (responseClosed) {
@@ -88,7 +66,8 @@ exports.addTracingMiddleware = (tracer) => {
 exports.nameSpanOperationMiddleware = (operationType, operationName) => {
     return function nameSpanOperation(ctx, next) {
         var _a, _b;
-        (_b = (_a = ctx.tracing) === null || _a === void 0 ? void 0 : _a.currentSpan) === null || _b === void 0 ? void 0 : _b.setOperationName(`${operationType}:${operationName}`);
+        ctx.requestHandlerName = `${operationType}:${operationName}`;
+        (_b = (_a = ctx.tracing) === null || _a === void 0 ? void 0 : _a.currentSpan) === null || _b === void 0 ? void 0 : _b.setOperationName(ctx.requestHandlerName);
         return next();
     };
 };

package/lib/service/worker/index.js

@@ -13,6 +13,7 @@ const MetricsAccumulator_1 = require("../../metrics/MetricsAccumulator");
 const loaders_1 = require("../loaders");
 const console_1 = require("../logger/console");
 const logger_1 = require("../logger/logger");
+const requestMetricsMiddleware_1 = require("../metrics/requestMetricsMiddleware");
 const TracerSingleton_1 = require("../tracing/TracerSingleton");
 const tracingMiddlewares_1 = require("../tracing/tracingMiddlewares");
 const listeners_1 = require("./listeners");
@@ -157,6 +158,7 @@ exports.startWorker = (serviceJSON) => {
         .use(error_1.error)
         .use(middlewares_1.prometheusLoggerMiddleware())
         .use(tracingMiddlewares_1.addTracingMiddleware(tracer))
+        .use(requestMetricsMiddleware_1.addRequestMetricsMiddleware())
         .use(middlewares_1.addMetricsLoggerMiddleware())
         .use(rateLimit_1.concurrentRateLimiter((_a = serviceJSON === null || serviceJSON === void 0 ? void 0 : serviceJSON.rateLimitPerReplica) === null || _a === void 0 ? void 0 : _a.concurrent))
         .use(koa_compress_1.default())

package/lib/service/worker/runtime/typings.d.ts

@@ -29,6 +29,7 @@ export interface Context<T extends IOClients> {
     timings: Record<string, [number, number]>;
     metrics: Record<string, [number, number]>;
     previousTimerStart: [number, number];
+    requestHandlerName?: string;
     serverTiming?: ServerTiming;
     tracing?: TracingContext;
 }

package/package.json

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