@vtex/api 6.46.0 → 6.47.0-beta.0

package/CHANGELOG.md

@@ -7,6 +7,17 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ## [Unreleased]
 
+## Fixed
+- Add handler name for runtime http handlers
+
+## [6.46.1] - 2024-01-31
+
+### Fixed
+- Return type for the saveJSON method of VBase client
+
+### Changed
+- Increase timeout for messagesGraphQL client
+
 ## [6.46.0] - 2023-10-25
 ### Added
 - Add disk cache steps and retry count to tracing
@@ -134,7 +145,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ## [6.54.5] - 2021-10-22
 
-### Fixed
+### Fixed 
 
 - Extract session cookie in a safe manner
 

package/lib/HttpClient/HttpClient.js

@@ -101,7 +101,7 @@ class HttpClient {
             ...config,
             url,
         });
-        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;
+        const { baseURL, authToken, authType, memoryCache, diskCache, memoizable = true, asyncSetCache, 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;
@@ -134,8 +134,8 @@ class HttpClient {
             cancellationToken_1.cancellationToken(cancellation),
             inflight_1.singleFlightMiddleware,
             notFound_1.acceptNotFoundMiddleware,
-            ...memoryCache ? [cache_1.cacheMiddleware({ type: cache_1.CacheType.Memory, storage: memoryCache })] : [],
-            ...diskCache ? [cache_1.cacheMiddleware({ type: cache_1.CacheType.Disk, storage: diskCache })] : [],
+            ...memoryCache ? [cache_1.cacheMiddleware({ type: cache_1.CacheType.Memory, storage: memoryCache, asyncSet: asyncSetCache })] : [],
+            ...diskCache ? [cache_1.cacheMiddleware({ type: cache_1.CacheType.Disk, storage: diskCache, asyncSet: asyncSetCache })] : [],
             notFound_1.notFoundFallbackMiddleware,
             request_1.routerCacheMiddleware,
             request_1.requestMiddleware(limit),

package/lib/HttpClient/middlewares/cache.d.ts

@@ -18,8 +18,9 @@ export declare const enum CacheResult {
 interface CacheOptions {
     type: CacheType;
     storage: CacheLayer<string, Cached>;
+    asyncSet?: boolean;
 }
-export declare const cacheMiddleware: ({ type, storage }: CacheOptions) => (ctx: MiddlewareContext, next: () => Promise<void>) => Promise<void>;
+export declare const cacheMiddleware: ({ type, storage, asyncSet }: CacheOptions) => (ctx: MiddlewareContext, next: () => Promise<void>) => Promise<void>;
 export interface Cached {
     etag: string;
     expiration: number;

package/lib/HttpClient/middlewares/cache.js

@@ -52,7 +52,7 @@ const CacheTypeNames = {
     [CacheType.Disk]: 'disk',
     [CacheType.Any]: 'any',
 };
-exports.cacheMiddleware = ({ type, storage }) => {
+exports.cacheMiddleware = ({ type, storage, asyncSet }) => {
     const CACHE_RESULT_TAG = type === CacheType.Disk ? "http.cache.disk" /* HTTP_DISK_CACHE_RESULT */ : "http.cache.memory" /* HTTP_MEMORY_CACHE_RESULT */;
     const cacheType = CacheTypeNames[type];
     return async (ctx, next) => {
@@ -171,23 +171,29 @@ exports.cacheMiddleware = ({ type, storage }) => {
             }
             const cacheWriteSpan = createCacheSpan(cacheType, 'write', tracer, span);
             try {
-                await storage.set(setKey, {
+                const storageSet = () => 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,
-                });
+                if (asyncSet) {
+                    storageSet();
+                }
+                else {
+                    await storageSet();
+                    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);

package/lib/HttpClient/typings.d.ts

@@ -74,6 +74,7 @@ export interface InstanceOptions {
     timeout?: number;
     memoryCache?: CacheLayer<string, Cached>;
     diskCache?: CacheLayer<string, Cached>;
+    asyncSetCache?: boolean;
     /**
      * Enables memoization, ephemeral within each request, for all requests of this client.
      * Useful for services that makes recursive requests, like graphql resolvers, which

package/lib/clients/infra/VBase.d.ts

@@ -3,7 +3,7 @@ import { IncomingMessage } from 'http';
 import { Readable } from 'stream';
 import { Logger } from './../../service/logger/logger';
 import { InstanceOptions, IOResponse, RequestTracingConfig } from '../../HttpClient';
-import { BucketMetadata, FileListItem } from '../../responses';
+import { BucketMetadata, FileListItem, VBaseSaveResponse } from '../../responses';
 import { IOContext } from '../../service/worker/runtime/typings';
 import { InfraClient } from './InfraClient';
 export declare class VBase extends InfraClient {
@@ -20,7 +20,7 @@ export declare class VBase extends InfraClient {
     getFileStream: (bucket: string, path: string, tracingConfig?: RequestTracingConfig | undefined) => Promise<IncomingMessage>;
     saveFile: (bucket: string, path: string, stream: Readable, gzip?: boolean, ttl?: number | undefined, tracingConfig?: RequestTracingConfig | undefined, ifMatch?: string | undefined) => Promise<void>;
     getFileMetadata: (bucket: string, path: string, tracingConfig?: RequestTracingConfig | undefined) => Promise<IOResponse<void>>;
-    saveJSON: <T>(bucket: string, path: string, data: T, tracingConfig?: RequestTracingConfig | undefined, ifMatch?: string | undefined) => Promise<void>;
+    saveJSON: <T>(bucket: string, path: string, data: T, tracingConfig?: RequestTracingConfig | undefined, ifMatch?: string | undefined) => Promise<VBaseSaveResponse>;
     saveZippedContent: (bucket: string, path: string, stream: Readable, tracingConfig?: RequestTracingConfig | undefined, ifMatch?: string | undefined) => Promise<void>;
     deleteFile: (bucket: string, path: string, tracingConfig?: RequestTracingConfig | undefined, ifMatch?: string | undefined) => Promise<IOResponse<void>>;
     getConflicts: <T>(bucket: string, tracingConfig?: RequestTracingConfig | undefined) => Promise<T>;

package/lib/responses.d.ts

@@ -76,4 +76,5 @@ export interface HousekeeperStatesAndUpdates {
     state: HouseKeeperState;
     updates: HouseKeeperUpdates;
 }
+export declare type VBaseSaveResponse = FileListItem[];
 export {};

package/lib/service/loaders.js

@@ -33,9 +33,9 @@ const defaultClients = {
             timeout: 1000,
         },
         messagesGraphQL: {
-            concurrency: 10,
+            concurrency: 12,
             retries: 2,
-            timeout: 1000,
+            timeout: 2000,
         },
     },
 };

package/lib/service/worker/runtime/builtIn/handlers.js

@@ -2,7 +2,8 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.whoAmIHandler = ({ events, routes, }) => (ctx) => {
     var _a, _b;
-    (_b = (_a = ctx.tracing) === null || _a === void 0 ? void 0 : _a.currentSpan) === null || _b === void 0 ? void 0 : _b.setOperationName('builtin:whoami');
+    ctx.requestHandlerName = 'builtin:whoami';
+    (_b = (_a = ctx.tracing) === null || _a === void 0 ? void 0 : _a.currentSpan) === null || _b === void 0 ? void 0 : _b.setOperationName(ctx.requestHandlerName);
     ctx.status = 200;
     ctx.body = {
         events,
@@ -12,7 +13,8 @@ exports.whoAmIHandler = ({ events, routes, }) => (ctx) => {
 };
 exports.healthcheckHandler = ({ events, routes, }) => (ctx) => {
     var _a, _b;
-    (_b = (_a = ctx.tracing) === null || _a === void 0 ? void 0 : _a.currentSpan) === null || _b === void 0 ? void 0 : _b.setOperationName('builtin:healthcheck');
+    ctx.requestHandlerName = 'builtin:healthcheck';
+    (_b = (_a = ctx.tracing) === null || _a === void 0 ? void 0 : _a.currentSpan) === null || _b === void 0 ? void 0 : _b.setOperationName(ctx.requestHandlerName);
     ctx.status = 200;
     ctx.body = {
         events,
@@ -21,7 +23,8 @@ exports.healthcheckHandler = ({ events, routes, }) => (ctx) => {
 };
 exports.metricsLoggerHandler = (ctx) => {
     var _a, _b;
-    (_b = (_a = ctx.tracing) === null || _a === void 0 ? void 0 : _a.currentSpan) === null || _b === void 0 ? void 0 : _b.setOperationName('builtin:metrics-logger');
+    ctx.requestHandlerName = 'builtin:metrics-logger';
+    (_b = (_a = ctx.tracing) === null || _a === void 0 ? void 0 : _a.currentSpan) === null || _b === void 0 ? void 0 : _b.setOperationName(ctx.requestHandlerName);
     ctx.status = 200;
     ctx.body = ctx.metricsLogger.getSummaries();
 };

package/package.json

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