@vtex/api 7.1.0-beta.0 → 7.2.0

package/lib/constants.d.ts

@@ -58,3 +58,6 @@ export declare const PRODUCTION: boolean;
 export declare const INSPECT_DEBUGGER_PORT = 5858;
 export declare const cancellableMethods: Set<string>;
 export declare const LOG_CLIENT_INIT_TIMEOUT_MS = 5000;
+export declare const OTEL_EXPORTER_OTLP_ENDPOINT: string;
+export declare const DK_APP_ID: string;
+export declare const DIAGNOSTICS_TELEMETRY_ENABLED: boolean;

package/lib/constants.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.LOG_CLIENT_INIT_TIMEOUT_MS = exports.cancellableMethods = exports.INSPECT_DEBUGGER_PORT = exports.PRODUCTION = exports.WORKSPACE = exports.ACCOUNT = exports.NODE_ENV = exports.APP = exports.PUBLIC_ENDPOINT = exports.REGION = exports.LINKED = exports.MAX_WORKERS = exports.HTTP_SERVER_PORT = exports.MAX_AGE = exports.UP_SIGNAL = exports.BODY_HASH = exports.PROVIDER_HEADER = exports.TRACE_ID_HEADER = exports.COLOSSUS_PARAMS_HEADER = exports.COLOSSUS_ROUTE_ID_HEADER = exports.COLOSSUS_ROUTE_DECLARER_HEADER = exports.EVENT_HANDLER_ID_HEADER = exports.EVENT_SUBJECT_HEADER = exports.EVENT_SENDER_HEADER = exports.EVENT_KEY_HEADER = exports.WORKSPACE_HEADER = exports.WORKSPACE_IS_PRODUCTION_HEADER = exports.PLATFORM_HEADER = exports.OPERATION_ID_HEADER = exports.ROUTER_CACHE_HEADER = exports.REQUEST_ID_HEADER = exports.CREDENTIAL_HEADER = exports.ACCOUNT_HEADER = exports.ETAG_HEADER = exports.META_HEADER_BUCKET = exports.META_HEADER = exports.BINDING_HEADER = exports.TENANT_HEADER = exports.FORWARDED_HOST_HEADER = exports.LOCALE_HEADER = exports.PRODUCT_HEADER = exports.SESSION_HEADER = exports.SEGMENT_HEADER = exports.CACHE_CONTROL_HEADER = exports.PID = exports.IS_IO = exports.DEFAULT_WORKSPACE = exports.NODE_VTEX_API_VERSION = void 0;
+exports.DK_APP_ID = exports.OTEL_EXPORTER_OTLP_ENDPOINT = exports.LOG_CLIENT_INIT_TIMEOUT_MS = exports.cancellableMethods = exports.INSPECT_DEBUGGER_PORT = exports.PRODUCTION = exports.WORKSPACE = exports.ACCOUNT = exports.NODE_ENV = exports.APP = exports.PUBLIC_ENDPOINT = exports.REGION = exports.LINKED = exports.MAX_WORKERS = exports.HTTP_SERVER_PORT = exports.MAX_AGE = exports.UP_SIGNAL = exports.BODY_HASH = exports.PROVIDER_HEADER = exports.TRACE_ID_HEADER = exports.COLOSSUS_PARAMS_HEADER = exports.COLOSSUS_ROUTE_ID_HEADER = exports.COLOSSUS_ROUTE_DECLARER_HEADER = exports.EVENT_HANDLER_ID_HEADER = exports.EVENT_SUBJECT_HEADER = exports.EVENT_SENDER_HEADER = exports.EVENT_KEY_HEADER = exports.WORKSPACE_HEADER = exports.WORKSPACE_IS_PRODUCTION_HEADER = exports.PLATFORM_HEADER = exports.OPERATION_ID_HEADER = exports.ROUTER_CACHE_HEADER = exports.REQUEST_ID_HEADER = exports.CREDENTIAL_HEADER = exports.ACCOUNT_HEADER = exports.ETAG_HEADER = exports.META_HEADER_BUCKET = exports.META_HEADER = exports.BINDING_HEADER = exports.TENANT_HEADER = exports.FORWARDED_HOST_HEADER = exports.LOCALE_HEADER = exports.PRODUCT_HEADER = exports.SESSION_HEADER = exports.SEGMENT_HEADER = exports.CACHE_CONTROL_HEADER = exports.PID = exports.IS_IO = exports.DEFAULT_WORKSPACE = exports.NODE_VTEX_API_VERSION = void 0;
+exports.DIAGNOSTICS_TELEMETRY_ENABLED = void 0;
 const app_1 = require("./utils/app");
 // tslint:disable-next-line
 const pkg = require('../package.json');
@@ -65,3 +66,6 @@ exports.PRODUCTION = process.env.VTEX_PRODUCTION === 'true';
 exports.INSPECT_DEBUGGER_PORT = 5858;
 exports.cancellableMethods = new Set(['GET', 'OPTIONS', 'HEAD']);
 exports.LOG_CLIENT_INIT_TIMEOUT_MS = 5000;
+exports.OTEL_EXPORTER_OTLP_ENDPOINT = process.env.OTEL_EXPORTER_OTLP_ENDPOINT;
+exports.DK_APP_ID = process.env.NODE_VTEX_API_DK_APP_ID || "apps-team";
+exports.DIAGNOSTICS_TELEMETRY_ENABLED = process.env.VTEX_DIAGNOSTICS_TELEMETRY_ENABLED === 'true';

package/lib/service/logger/logger.js

@@ -77,7 +77,7 @@ class Logger {
                 traceId: ctx.tracer.traceId,
             };
         }
-        // this.initLogClient();
+        this.initLogClient();
     }
     initLogClient() {
         if (this.clientInitPromise) {

package/lib/service/metrics/client.d.ts

@@ -1,2 +1,2 @@
 import { Types } from "@vtex/diagnostics-nodejs";
-export declare function getMetricClient(): Promise<Types.MetricClient>;
+export declare const getMetricClient: () => Promise<Types.MetricClient>;

package/lib/service/metrics/client.js

@@ -2,34 +2,37 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getMetricClient = void 0;
 const telemetry_1 = require("../telemetry");
-let client;
-let isInitializing = false;
-let initPromise = undefined;
-async function getMetricClient() {
-    if (client) {
-        return client;
+class MetricClientSingleton {
+    constructor() { }
+    static getInstance() {
+        if (!MetricClientSingleton.instance) {
+            MetricClientSingleton.instance = new MetricClientSingleton();
+        }
+        return MetricClientSingleton.instance;
     }
-    if (initPromise) {
-        return initPromise;
+    async getClient() {
+        if (this.client) {
+            return this.client;
+        }
+        if (this.initPromise) {
+            return this.initPromise;
+        }
+        this.initPromise = this.initializeClient();
+        return this.initPromise;
     }
-    isInitializing = true;
-    initPromise = initializeClient();
-    return initPromise;
-}
-exports.getMetricClient = getMetricClient;
-async function initializeClient() {
-    try {
-        const { metricsClient } = await (0, telemetry_1.initializeTelemetry)();
-        client = metricsClient;
-        initPromise = undefined;
-        return metricsClient;
-    }
-    catch (error) {
-        console.error('Failed to initialize metrics client:', error);
-        initPromise = undefined;
-        throw error;
-    }
-    finally {
-        isInitializing = false;
+    async initializeClient() {
+        try {
+            const { metricsClient } = await (0, telemetry_1.initializeTelemetry)();
+            this.client = metricsClient;
+            this.initPromise = undefined;
+            return metricsClient;
+        }
+        catch (error) {
+            console.error('Failed to initialize metrics client:', error);
+            this.initPromise = undefined;
+            throw error;
+        }
     }
 }
+const getMetricClient = () => MetricClientSingleton.getInstance().getClient();
+exports.getMetricClient = getMetricClient;

package/lib/service/metrics/metrics.js

@@ -2,8 +2,6 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getOtelInstruments = void 0;
 const client_1 = require("./client");
-let instruments;
-let initializingPromise;
 const createOtelConcurrentRequestsInstrument = async () => {
     const metricsClient = await (0, client_1.getMetricClient)();
     return metricsClient.createGauge('io_http_requests_current', {
@@ -39,36 +37,51 @@ const createOtelTotalAbortedRequestsInstrument = async () => {
         unit: '1'
     });
 };
-const getOtelInstruments = async () => {
-    if (instruments) {
-        return instruments;
+class OtelInstrumentsSingleton {
+    constructor() { }
+    static getInstance() {
+        if (!OtelInstrumentsSingleton.instance) {
+            OtelInstrumentsSingleton.instance = new OtelInstrumentsSingleton();
+        }
+        return OtelInstrumentsSingleton.instance;
     }
-    if (initializingPromise) {
-        return initializingPromise;
+    async getInstruments() {
+        if (this.instruments) {
+            return this.instruments;
+        }
+        if (this.initializingPromise) {
+            return this.initializingPromise;
+        }
+        this.initializingPromise = this.initializeInstruments();
+        try {
+            this.instruments = await this.initializingPromise;
+            return this.instruments;
+        }
+        catch (error) {
+            console.error('Failed to initialize OTel instruments:', error);
+            this.initializingPromise = undefined;
+            throw error;
+        }
+        finally {
+            this.initializingPromise = undefined;
+        }
     }
-    initializingPromise = initializeOtelInstruments();
-    try {
-        instruments = await initializingPromise;
-        return instruments;
+    async initializeInstruments() {
+        const [concurrentRequests, requestTimings, totalRequests, responseSizes, abortedRequests] = await Promise.all([
+            createOtelConcurrentRequestsInstrument(),
+            createOtelRequestsTimingsInstrument(),
+            createOtelTotalRequestsInstrument(),
+            createOtelRequestsResponseSizesInstrument(),
+            createOtelTotalAbortedRequestsInstrument()
+        ]);
+        return {
+            concurrentRequests,
+            requestTimings,
+            totalRequests,
+            responseSizes,
+            abortedRequests
+        };
     }
-    finally {
-        initializingPromise = undefined;
-    }
-};
+}
+const getOtelInstruments = () => OtelInstrumentsSingleton.getInstance().getInstruments();
 exports.getOtelInstruments = getOtelInstruments;
-const initializeOtelInstruments = async () => {
-    const [concurrentRequests, requestTimings, totalRequests, responseSizes, abortedRequests] = await Promise.all([
-        createOtelConcurrentRequestsInstrument(),
-        createOtelRequestsTimingsInstrument(),
-        createOtelTotalRequestsInstrument(),
-        createOtelRequestsResponseSizesInstrument(),
-        createOtelTotalAbortedRequestsInstrument()
-    ]);
-    return {
-        concurrentRequests,
-        requestTimings,
-        totalRequests,
-        responseSizes,
-        abortedRequests
-    };
-};

package/lib/service/metrics/otelRequestMetricsMiddleware.js

@@ -7,20 +7,24 @@ const metrics_1 = require("./metrics");
 const INSTRUMENTS_INITIALIZATION_TIMEOUT = 500;
 const addOtelRequestMetricsMiddleware = () => {
     let instruments;
+    const tryGetInstruments = async (ctx) => {
+        try {
+            return await Promise.race([
+                (0, metrics_1.getOtelInstruments)(),
+                new Promise((_, reject) => setTimeout(() => reject(new Error('Timeout waiting for OpenTelemetry instruments initialization')), INSTRUMENTS_INITIALIZATION_TIMEOUT))
+            ]);
+        }
+        catch (error) {
+            const errorMessage = error instanceof Error ? error.message : String(error);
+            console.warn(`OpenTelemetry instruments not ready for request ${ctx.requestHandlerName}: ${errorMessage}`);
+            return undefined;
+        }
+    };
     return async function addOtelRequestMetrics(ctx, next) {
+        instruments = instruments ? instruments : await tryGetInstruments(ctx);
         if (!instruments) {
-            try {
-                instruments = await Promise.race([
-                    (0, metrics_1.getOtelInstruments)(),
-                    new Promise((_, reject) => setTimeout(() => reject(new Error('Timeout waiting for OpenTelemetry instruments initialization')), INSTRUMENTS_INITIALIZATION_TIMEOUT))
-                ]);
-            }
-            catch (error) {
-                const errorMessage = error instanceof Error ? error.message : String(error);
-                console.warn(`OpenTelemetry instruments not ready for request ${ctx.requestHandlerName}: ${errorMessage}`);
-                await next();
-                return;
-            }
+            await next();
+            return;
         }
         const start = process.hrtime();
         instruments.concurrentRequests.add(1);

package/lib/service/telemetry/client.js

@@ -5,27 +5,25 @@ const diagnostics_nodejs_1 = require("@vtex/diagnostics-nodejs");
 const constants_1 = require("../../constants");
 const instrumentation_koa_1 = require("@opentelemetry/instrumentation-koa");
 const hostMetrics_1 = require("../metrics/instruments/hostMetrics");
-const CLIENT_NAME = constants_1.APP.NAME || 'node-vtex-api';
 const APPLICATION_ID = constants_1.APP.ID || 'vtex-io-app';
-const EXPORTER_OTLP_ENDPOINT = process.env.EXPORTER_OTLP_ENDPOINT;
 class TelemetryClientSingleton {
     constructor() {
         this.initializationPromise = undefined;
         this.initializeTracesClient = async (telemetryClient) => await telemetryClient.newTracesClient({
             exporter: diagnostics_nodejs_1.Exporters.CreateExporter(diagnostics_nodejs_1.Exporters.CreateTracesExporterConfig({
-                endpoint: EXPORTER_OTLP_ENDPOINT,
+                endpoint: constants_1.OTEL_EXPORTER_OTLP_ENDPOINT,
             }), 'otlp'),
         });
         this.initializeMetricsClient = async (telemetryClient) => await telemetryClient.newMetricsClient({
             exporter: diagnostics_nodejs_1.Exporters.CreateExporter(diagnostics_nodejs_1.Exporters.CreateMetricsExporterConfig({
-                endpoint: EXPORTER_OTLP_ENDPOINT,
+                endpoint: constants_1.OTEL_EXPORTER_OTLP_ENDPOINT,
                 interval: 5,
                 timeoutSeconds: 5,
             }), 'otlp'),
         });
         this.initializeLogsClient = async (telemetryClient) => await telemetryClient.newLogsClient({
             exporter: diagnostics_nodejs_1.Exporters.CreateExporter(diagnostics_nodejs_1.Exporters.CreateLogsExporterConfig({
-                endpoint: EXPORTER_OTLP_ENDPOINT,
+                endpoint: constants_1.OTEL_EXPORTER_OTLP_ENDPOINT,
             }), 'otlp'),
             loggerName: `node-vtex-api-${APPLICATION_ID}`,
         });
@@ -38,10 +36,15 @@ class TelemetryClientSingleton {
     }
     async initializeTelemetryClients() {
         try {
-            const telemetryClient = await (0, diagnostics_nodejs_1.NewTelemetryClient)(APPLICATION_ID, CLIENT_NAME, 'node-vtex-api', {
+            const telemetryClient = await (0, diagnostics_nodejs_1.NewTelemetryClient)(constants_1.DK_APP_ID, 'node-vtex-api', APPLICATION_ID, {
+                // Use built-in no-op functionality when telemetry is disabled
+                noop: !constants_1.DIAGNOSTICS_TELEMETRY_ENABLED,
                 additionalAttrs: {
+                    'app.id': APPLICATION_ID,
+                    'vendor': constants_1.APP.VENDOR,
                     'version': constants_1.APP.VERSION || '',
-                    'environment': process.env.VTEX_WORKSPACE || 'development',
+                    'workspace': constants_1.WORKSPACE,
+                    'production': constants_1.PRODUCTION.toString(),
                 },
             });
             const [tracesClient, metricsClient, logsClient] = await Promise.all([
@@ -49,15 +52,18 @@ class TelemetryClientSingleton {
                 this.initializeMetricsClient(telemetryClient),
                 this.initializeLogsClient(telemetryClient),
             ]);
-            const instrumentations = [
-                ...diagnostics_nodejs_1.Instrumentation.CommonInstrumentations.minimal(),
-                new instrumentation_koa_1.KoaInstrumentation(),
-                new hostMetrics_1.HostMetricsInstrumentation({
-                    name: 'host-metrics-instrumentation',
-                    meterProvider: metricsClient.provider(),
-                }),
-            ];
-            telemetryClient.registerInstrumentations(instrumentations);
+            if (constants_1.DIAGNOSTICS_TELEMETRY_ENABLED) {
+                console.log(`Telemetry enabled for app: ${constants_1.APP.ID} (vendor: ${constants_1.APP.VENDOR})`);
+                const instrumentations = [
+                    ...diagnostics_nodejs_1.Instrumentation.CommonInstrumentations.minimal(),
+                    new instrumentation_koa_1.KoaInstrumentation(),
+                    new hostMetrics_1.HostMetricsInstrumentation({
+                        name: 'host-metrics-instrumentation',
+                        meterProvider: metricsClient.provider(),
+                    }),
+                ];
+                telemetryClient.registerInstrumentations(instrumentations);
+            }
             const clients = {
                 logsClient,
                 metricsClient,

package/lib/service/worker/runtime/graphql/schema/schemaDirectives/Auth.d.ts

@@ -3,4 +3,4 @@ import { SchemaDirectiveVisitor } from 'graphql-tools';
 export declare class Auth extends SchemaDirectiveVisitor {
     visitFieldDefinition(field: GraphQLField<any, any>): void;
 }
-export declare const authDirectiveTypeDefs = "\ndirective @auth(\n  productCode: String\n  resourceCode: String\n) on FIELD_DEFINITION\n";
+export declare const authDirectiveTypeDefs = "\n\nenum IOAuthScope {\n  PUBLIC\n  PRIVATE\n}\n\ndirective @auth(\n  scope: IOAuthScope\n  productCode: String\n  resourceCode: String\n) on FIELD_DEFINITION\n";

package/lib/service/worker/runtime/graphql/schema/schemaDirectives/Auth.js

@@ -50,8 +50,11 @@ async function auth(ctx, authArgs) {
     }
 }
 function parseArgs(authArgs) {
+    if (authArgs.scope == 'PUBLIC') {
+        return authArgs;
+    }
     if (!authArgs.productCode || !authArgs.resourceCode) {
-        throw new apollo_server_errors_1.UserInputError('Invalid auth schema directive args. Usage: @auth(productCode: String, resourceCode: String).');
+        throw new apollo_server_errors_1.UserInputError('Invalid auth schema directive args. Usage: @auth(scope: IOAuthScope, productCode: String, resourceCode: String).');
     }
     return authArgs;
 }
@@ -60,14 +63,23 @@ class Auth extends graphql_tools_1.SchemaDirectiveVisitor {
         const { resolve = graphql_1.defaultFieldResolver } = field;
         field.resolve = async (root, args, ctx, info) => {
             const authArgs = parseArgs(this.args);
-            await auth(ctx, authArgs);
+            if (!authArgs.scope || authArgs.scope == 'PRIVATE') {
+                await auth(ctx, authArgs);
+            }
             return resolve(root, args, ctx, info);
         };
     }
 }
 exports.Auth = Auth;
 exports.authDirectiveTypeDefs = `
+
+enum IOAuthScope {
+  PUBLIC
+  PRIVATE
+}
+
 directive @auth(
+  scope: IOAuthScope
   productCode: String
   resourceCode: String
 ) on FIELD_DEFINITION

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vtex/api",
-  "version": "7.1.0-beta.0",
+  "version": "7.2.0",
   "description": "VTEX I/O API client",
   "main": "lib/index.js",
   "typings": "lib/index.d.ts",
@@ -53,7 +53,7 @@
     "@opentelemetry/instrumentation-koa": "0.47.1",
     "@types/koa": "^2.11.0",
     "@types/koa-compose": "^3.2.3",
-    "@vtex/diagnostics-nodejs": "0.1.0-io-beta.19",
+    "@vtex/diagnostics-nodejs": "0.1.0-io-beta.20",
     "@vtex/node-error-report": "^0.0.3",
     "@wry/equality": "^0.1.9",
     "agentkeepalive": "^4.0.2",