@vtex/api 7.2.3-beta.0 → 7.2.4-beta.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (5) hide show
  1. package/lib/constants.d.ts +56 -0
  2. package/lib/constants.js +58 -1
  3. package/lib/service/logger/logger.js +9 -11
  4. package/lib/service/metrics/otelRequestMetricsMiddleware.js +5 -1
  5. package/package.json +1 -1
package/lib/constants.d.ts CHANGED
@@ -46,6 +46,62 @@ export declare const AttributeKeys: {
46
46
  VTEX_IO_APP_ID: "vtex_io.app.id";
47
47
  VTEX_IO_APP_AUTHOR_TYPE: "vtex_io.app.author_type";
48
48
  };
49
+ /** @deprecated Use HeaderKeys.CACHE_CONTROL instead */
50
+ export declare const CACHE_CONTROL_HEADER: string;
51
+ /** @deprecated Use HeaderKeys.SEGMENT instead */
52
+ export declare const SEGMENT_HEADER: string;
53
+ /** @deprecated Use HeaderKeys.SESSION instead */
54
+ export declare const SESSION_HEADER: string;
55
+ /** @deprecated Use HeaderKeys.PRODUCT instead */
56
+ export declare const PRODUCT_HEADER: string;
57
+ /** @deprecated Use HeaderKeys.LOCALE instead */
58
+ export declare const LOCALE_HEADER: string;
59
+ /** @deprecated Use HeaderKeys.FORWARDED_HOST instead */
60
+ export declare const FORWARDED_HOST_HEADER: string;
61
+ /** @deprecated Use HeaderKeys.TENANT instead */
62
+ export declare const TENANT_HEADER: string;
63
+ /** @deprecated Use HeaderKeys.BINDING instead */
64
+ export declare const BINDING_HEADER: string;
65
+ /** @deprecated Use HeaderKeys.META instead */
66
+ export declare const META_HEADER: string;
67
+ /** @deprecated Use HeaderKeys.META_BUCKET instead */
68
+ export declare const META_HEADER_BUCKET: string;
69
+ /** @deprecated Use HeaderKeys.ETAG instead */
70
+ export declare const ETAG_HEADER: string;
71
+ /** @deprecated Use HeaderKeys.ACCOUNT instead */
72
+ export declare const ACCOUNT_HEADER: string;
73
+ /** @deprecated Use HeaderKeys.CREDENTIAL instead */
74
+ export declare const CREDENTIAL_HEADER: string;
75
+ /** @deprecated Use HeaderKeys.REQUEST_ID instead */
76
+ export declare const REQUEST_ID_HEADER: string;
77
+ /** @deprecated Use HeaderKeys.ROUTER_CACHE instead */
78
+ export declare const ROUTER_CACHE_HEADER: string;
79
+ /** @deprecated Use HeaderKeys.OPERATION_ID instead */
80
+ export declare const OPERATION_ID_HEADER: string;
81
+ /** @deprecated Use HeaderKeys.PLATFORM instead */
82
+ export declare const PLATFORM_HEADER: string;
83
+ /** @deprecated Use HeaderKeys.WORKSPACE_IS_PRODUCTION instead */
84
+ export declare const WORKSPACE_IS_PRODUCTION_HEADER: string;
85
+ /** @deprecated Use HeaderKeys.WORKSPACE instead */
86
+ export declare const WORKSPACE_HEADER: string;
87
+ /** @deprecated Use HeaderKeys.EVENT_KEY instead */
88
+ export declare const EVENT_KEY_HEADER: string;
89
+ /** @deprecated Use HeaderKeys.EVENT_SENDER instead */
90
+ export declare const EVENT_SENDER_HEADER: string;
91
+ /** @deprecated Use HeaderKeys.EVENT_SUBJECT instead */
92
+ export declare const EVENT_SUBJECT_HEADER: string;
93
+ /** @deprecated Use HeaderKeys.EVENT_HANDLER_ID instead */
94
+ export declare const EVENT_HANDLER_ID_HEADER: string;
95
+ /** @deprecated Use HeaderKeys.COLOSSUS_ROUTE_DECLARER instead */
96
+ export declare const COLOSSUS_ROUTE_DECLARER_HEADER: string;
97
+ /** @deprecated Use HeaderKeys.COLOSSUS_ROUTE_ID instead */
98
+ export declare const COLOSSUS_ROUTE_ID_HEADER: string;
99
+ /** @deprecated Use HeaderKeys.COLOSSUS_PARAMS instead */
100
+ export declare const COLOSSUS_PARAMS_HEADER: string;
101
+ /** @deprecated Use HeaderKeys.TRACE_ID instead */
102
+ export declare const TRACE_ID_HEADER: string;
103
+ /** @deprecated Use HeaderKeys.PROVIDER instead */
104
+ export declare const PROVIDER_HEADER: string;
49
105
  export type VaryHeaders = typeof HeaderKeys.SEGMENT | typeof HeaderKeys.SESSION | typeof HeaderKeys.PRODUCT | typeof HeaderKeys.LOCALE;
50
106
  export declare const BODY_HASH = "__graphqlBodyHash";
51
107
  export declare const UP_SIGNAL = "UP";
package/lib/constants.js CHANGED
@@ -1,6 +1,7 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.DIAGNOSTICS_TELEMETRY_ENABLED = 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.AttributeKeys = exports.HeaderKeys = exports.PID = exports.IS_IO = exports.DEFAULT_WORKSPACE = exports.NODE_VTEX_API_VERSION = void 0;
3
+ 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.AttributeKeys = exports.HeaderKeys = exports.PID = exports.IS_IO = exports.DEFAULT_WORKSPACE = exports.NODE_VTEX_API_VERSION = void 0;
4
+ exports.DIAGNOSTICS_TELEMETRY_ENABLED = exports.DK_APP_ID = exports.OTEL_EXPORTER_OTLP_ENDPOINT = void 0;
4
5
  const app_1 = require("./utils/app");
5
6
  const diagnostics_semconv_1 = require("@vtex/diagnostics-semconv");
6
7
  // tslint:disable-next-line
@@ -55,6 +56,62 @@ exports.AttributeKeys = {
55
56
  VTEX_IO_APP_ID: diagnostics_semconv_1.ATTR_VTEX_IO_APP_ID,
56
57
  VTEX_IO_APP_AUTHOR_TYPE: diagnostics_semconv_1.ATTR_VTEX_IO_APP_AUTHOR_TYPE,
57
58
  };
59
+ /** @deprecated Use HeaderKeys.CACHE_CONTROL instead */
60
+ exports.CACHE_CONTROL_HEADER = exports.HeaderKeys.CACHE_CONTROL;
61
+ /** @deprecated Use HeaderKeys.SEGMENT instead */
62
+ exports.SEGMENT_HEADER = exports.HeaderKeys.SEGMENT;
63
+ /** @deprecated Use HeaderKeys.SESSION instead */
64
+ exports.SESSION_HEADER = exports.HeaderKeys.SESSION;
65
+ /** @deprecated Use HeaderKeys.PRODUCT instead */
66
+ exports.PRODUCT_HEADER = exports.HeaderKeys.PRODUCT;
67
+ /** @deprecated Use HeaderKeys.LOCALE instead */
68
+ exports.LOCALE_HEADER = exports.HeaderKeys.LOCALE;
69
+ /** @deprecated Use HeaderKeys.FORWARDED_HOST instead */
70
+ exports.FORWARDED_HOST_HEADER = exports.HeaderKeys.FORWARDED_HOST;
71
+ /** @deprecated Use HeaderKeys.TENANT instead */
72
+ exports.TENANT_HEADER = exports.HeaderKeys.TENANT;
73
+ /** @deprecated Use HeaderKeys.BINDING instead */
74
+ exports.BINDING_HEADER = exports.HeaderKeys.BINDING;
75
+ /** @deprecated Use HeaderKeys.META instead */
76
+ exports.META_HEADER = exports.HeaderKeys.META;
77
+ /** @deprecated Use HeaderKeys.META_BUCKET instead */
78
+ exports.META_HEADER_BUCKET = exports.HeaderKeys.META_BUCKET;
79
+ /** @deprecated Use HeaderKeys.ETAG instead */
80
+ exports.ETAG_HEADER = exports.HeaderKeys.ETAG;
81
+ /** @deprecated Use HeaderKeys.ACCOUNT instead */
82
+ exports.ACCOUNT_HEADER = exports.HeaderKeys.ACCOUNT;
83
+ /** @deprecated Use HeaderKeys.CREDENTIAL instead */
84
+ exports.CREDENTIAL_HEADER = exports.HeaderKeys.CREDENTIAL;
85
+ /** @deprecated Use HeaderKeys.REQUEST_ID instead */
86
+ exports.REQUEST_ID_HEADER = exports.HeaderKeys.REQUEST_ID;
87
+ /** @deprecated Use HeaderKeys.ROUTER_CACHE instead */
88
+ exports.ROUTER_CACHE_HEADER = exports.HeaderKeys.ROUTER_CACHE;
89
+ /** @deprecated Use HeaderKeys.OPERATION_ID instead */
90
+ exports.OPERATION_ID_HEADER = exports.HeaderKeys.OPERATION_ID;
91
+ /** @deprecated Use HeaderKeys.PLATFORM instead */
92
+ exports.PLATFORM_HEADER = exports.HeaderKeys.PLATFORM;
93
+ /** @deprecated Use HeaderKeys.WORKSPACE_IS_PRODUCTION instead */
94
+ exports.WORKSPACE_IS_PRODUCTION_HEADER = exports.HeaderKeys.WORKSPACE_IS_PRODUCTION;
95
+ /** @deprecated Use HeaderKeys.WORKSPACE instead */
96
+ exports.WORKSPACE_HEADER = exports.HeaderKeys.WORKSPACE;
97
+ /** @deprecated Use HeaderKeys.EVENT_KEY instead */
98
+ exports.EVENT_KEY_HEADER = exports.HeaderKeys.EVENT_KEY;
99
+ /** @deprecated Use HeaderKeys.EVENT_SENDER instead */
100
+ exports.EVENT_SENDER_HEADER = exports.HeaderKeys.EVENT_SENDER;
101
+ /** @deprecated Use HeaderKeys.EVENT_SUBJECT instead */
102
+ exports.EVENT_SUBJECT_HEADER = exports.HeaderKeys.EVENT_SUBJECT;
103
+ /** @deprecated Use HeaderKeys.EVENT_HANDLER_ID instead */
104
+ exports.EVENT_HANDLER_ID_HEADER = exports.HeaderKeys.EVENT_HANDLER_ID;
105
+ /** @deprecated Use HeaderKeys.COLOSSUS_ROUTE_DECLARER instead */
106
+ exports.COLOSSUS_ROUTE_DECLARER_HEADER = exports.HeaderKeys.COLOSSUS_ROUTE_DECLARER;
107
+ /** @deprecated Use HeaderKeys.COLOSSUS_ROUTE_ID instead */
108
+ exports.COLOSSUS_ROUTE_ID_HEADER = exports.HeaderKeys.COLOSSUS_ROUTE_ID;
109
+ /** @deprecated Use HeaderKeys.COLOSSUS_PARAMS instead */
110
+ exports.COLOSSUS_PARAMS_HEADER = exports.HeaderKeys.COLOSSUS_PARAMS;
111
+ /** @deprecated Use HeaderKeys.TRACE_ID instead */
112
+ exports.TRACE_ID_HEADER = exports.HeaderKeys.TRACE_ID;
113
+ /** @deprecated Use HeaderKeys.PROVIDER instead */
114
+ exports.PROVIDER_HEADER = exports.HeaderKeys.PROVIDER;
58
115
  exports.BODY_HASH = '__graphqlBodyHash';
59
116
  exports.UP_SIGNAL = 'UP';
60
117
  exports.MAX_AGE = {
package/lib/service/logger/logger.js CHANGED
@@ -17,21 +17,24 @@ class Logger {
17
17
  this.warn = (warning) => this.log(warning, loggerTypes_1.LogLevel.Warn);
18
18
  this.error = (error) => this.log(error, loggerTypes_1.LogLevel.Error);
19
19
  this.log = (message, level) => {
20
- var _a, _b;
20
+ var _a;
21
21
  const data = message ? (0, error_1.cleanError)(message) : EMPTY_MESSAGE;
22
22
  (0, log_1.cleanLog)(data);
23
23
  /* tslint:disable:object-literal-sort-keys */
24
- const inflatedLog = {
24
+ const commonLogFields = {
25
25
  __VTEX_IO_LOG: true,
26
26
  level,
27
+ operationId: this.operationId,
28
+ requestId: this.requestId,
29
+ ...(((_a = this.tracingState) === null || _a === void 0 ? void 0 : _a.isTraceSampled) ? { traceId: this.tracingState.traceId } : null),
30
+ };
31
+ const inflatedLog = {
27
32
  app,
28
33
  account: this.account,
29
34
  workspace: this.workspace,
30
35
  production: this.production,
31
- operationId: this.operationId,
32
- requestId: this.requestId,
33
36
  data,
34
- ...(((_a = this.tracingState) === null || _a === void 0 ? void 0 : _a.isTraceSampled) ? { traceId: this.tracingState.traceId } : null),
37
+ ...commonLogFields,
35
38
  };
36
39
  // Mark third-party apps logs to send to skidder
37
40
  if (constants_1.APP.IS_THIRD_PARTY()) {
@@ -42,17 +45,12 @@ class Logger {
42
45
  }
43
46
  console.log(JSON.stringify(inflatedLog));
44
47
  const diagnosticsLog = {
45
- __VTEX_IO_LOG: true,
46
- level,
47
48
  [constants_1.AttributeKeys.VTEX_IO_APP_ID]: app,
48
49
  [constants_1.AttributeKeys.VTEX_ACCOUNT_NAME]: this.account,
49
50
  [constants_1.AttributeKeys.VTEX_IO_WORKSPACE_NAME]: this.workspace,
50
51
  [constants_1.AttributeKeys.VTEX_IO_WORKSPACE_TYPE]: this.production ? 'production' : 'development',
51
52
  [constants_1.AttributeKeys.VTEX_IO_APP_AUTHOR_TYPE]: constants_1.APP.IS_THIRD_PARTY() ? '3p' : '1p',
52
- operationId: this.operationId,
53
- requestId: this.requestId,
54
- data,
55
- ...(((_b = this.tracingState) === null || _b === void 0 ? void 0 : _b.isTraceSampled) ? { traceId: this.tracingState.traceId } : null),
53
+ ...commonLogFields,
56
54
  };
57
55
  if (this.logClient) {
58
56
  try {
package/lib/service/metrics/otelRequestMetricsMiddleware.js CHANGED
@@ -41,7 +41,10 @@ const addOtelRequestMetricsMiddleware = () => {
41
41
  finally {
42
42
  const responseLength = ctx.response.length;
43
43
  if (responseLength && instruments) {
44
- instruments.responseSizes.record(responseLength, { ["handler" /* RequestsMetricLabels.REQUEST_HANDLER */]: ctx.requestHandlerName });
44
+ instruments.responseSizes.record(responseLength, {
45
+ ["handler" /* RequestsMetricLabels.REQUEST_HANDLER */]: ctx.requestHandlerName,
46
+ ["status_code" /* RequestsMetricLabels.STATUS_CODE */]: ctx.response.status,
47
+ });
45
48
  }
46
49
  if (instruments) {
47
50
  instruments.totalRequests.add(1, {
@@ -53,6 +56,7 @@ const addOtelRequestMetricsMiddleware = () => {
53
56
  if (instruments) {
54
57
  instruments.requestTimings.record((0, utils_1.hrToMillisFloat)(process.hrtime(start)), {
55
58
  ["handler" /* RequestsMetricLabels.REQUEST_HANDLER */]: ctx.requestHandlerName,
59
+ ["status_code" /* RequestsMetricLabels.STATUS_CODE */]: ctx.response.status,
56
60
  });
57
61
  instruments.concurrentRequests.subtract(1);
58
62
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@vtex/api",
3
- "version": "7.2.3-beta.0",
3
+ "version": "7.2.4-beta.0",
4
4
  "description": "VTEX I/O API client",
5
5
  "main": "lib/index.js",
6
6
  "typings": "lib/index.d.ts",