@trunkrs/common 1.9.0 → 1.9.1

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.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@trunkrs/common",
3
- "version": "1.9.0",
3
+ "version": "1.9.1",
4
4
  "description": "Common standards library for development in Trunkrs",
5
5
  "types": "./index.d.ts",
6
6
  "repository": "https://github.com/Trunkrs/common.git",
@@ -4,7 +4,8 @@ declare class Tracing {
4
4
  private static readonly stack;
5
5
  static asyncMethod(className: string, name?: string): MethodDecorator;
6
6
  static get current(): SegmentLike | undefined;
7
- static prepare(): void;
7
+ static prepare(defaultName?: string): void;
8
+ static hookRequestCycle(request: AWSLambda.APIGatewayProxyEventV2, actionExecutor: () => Promise<AWSLambda.APIGatewayProxyResultV2>): Promise<AWSLambda.APIGatewayProxyResultV2>;
8
9
  static addSegment(name: string, parent?: SegmentLike): Subsegment;
9
10
  static closeSegment(error?: unknown): void;
10
11
  static tracePromise<TResult>(name: string, promise: Promise<TResult>, parent?: SegmentLike): Promise<TResult>;
package/utils/tracing.js CHANGED
@@ -1,9 +1,29 @@
1
1
  "use strict";
2
+ var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
3
+ if (k2 === undefined) k2 = k;
4
+ Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
5
+ }) : (function(o, m, k, k2) {
6
+ if (k2 === undefined) k2 = k;
7
+ o[k2] = m[k];
8
+ }));
9
+ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
10
+ Object.defineProperty(o, "default", { enumerable: true, value: v });
11
+ }) : function(o, v) {
12
+ o["default"] = v;
13
+ });
14
+ var __importStar = (this && this.__importStar) || function (mod) {
15
+ if (mod && mod.__esModule) return mod;
16
+ var result = {};
17
+ if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
18
+ __setModuleDefault(result, mod);
19
+ return result;
20
+ };
2
21
  var __importDefault = (this && this.__importDefault) || function (mod) {
3
22
  return (mod && mod.__esModule) ? mod : { "default": mod };
4
23
  };
5
24
  Object.defineProperty(exports, "__esModule", { value: true });
6
- const aws_xray_sdk_1 = __importDefault(require("aws-xray-sdk"));
25
+ const aws_xray_sdk_1 = __importStar(require("aws-xray-sdk"));
26
+ const aws_xray_sdk_core_1 = __importDefault(require("aws-xray-sdk-core"));
7
27
  class Tracing {
8
28
  static asyncMethod(className, name) {
9
29
  return (target, propertyName, descriptor) => {
@@ -17,9 +37,10 @@ class Tracing {
17
37
  }
18
38
  return Tracing.stack[Tracing.stack.length - 1];
19
39
  }
20
- static prepare() {
40
+ static prepare(defaultName) {
21
41
  try {
22
42
  aws_xray_sdk_1.default.setContextMissingStrategy('LOG_ERROR');
43
+ aws_xray_sdk_core_1.default.middleware.setDefaultName(defaultName !== null && defaultName !== void 0 ? defaultName : process.env.AWS_LAMBDA_FUNCTION_NAME);
23
44
  aws_xray_sdk_1.default.captureHTTPsGlobal(require('http'));
24
45
  aws_xray_sdk_1.default.captureHTTPsGlobal(require('https'));
25
46
  aws_xray_sdk_1.default.capturePromise();
@@ -28,6 +49,55 @@ class Tracing {
28
49
  console.warn(`[Tracing]: ${error.message}`);
29
50
  }
30
51
  }
52
+ static async hookRequestCycle(request, actionExecutor) {
53
+ const headers = Object.keys(request.headers).reduce((newHeaders, headerName) => Object.assign(newHeaders, {
54
+ [headerName.toLowerCase()]: request.headers[headerName],
55
+ }), {});
56
+ const mimickedRequest = {
57
+ headers,
58
+ method: request.requestContext.http.method,
59
+ url: request.rawPath,
60
+ connection: {
61
+ secure: true,
62
+ },
63
+ };
64
+ const tracingHeader = aws_xray_sdk_core_1.default.middleware.processHeaders({ headers });
65
+ console.info('[Tracing]: Established xray header value', tracingHeader);
66
+ const name = aws_xray_sdk_core_1.default.middleware.resolveName(headers.host);
67
+ console.info('[Tracing]: Established handler name', name);
68
+ const segment = new aws_xray_sdk_1.Segment(name, tracingHeader.root, tracingHeader.parent);
69
+ console.info('[Tracing]: Created new segment', segment);
70
+ const combinedRequest = {
71
+ header: {},
72
+ req: mimickedRequest,
73
+ };
74
+ aws_xray_sdk_core_1.default.middleware.resolveSampling(tracingHeader, segment, combinedRequest);
75
+ console.info('[Tracing]: Resolved sampling & created request data', new aws_xray_sdk_core_1.default.middleware.IncomingRequestData(mimickedRequest));
76
+ segment.addIncomingRequestData(new aws_xray_sdk_core_1.default.middleware.IncomingRequestData(mimickedRequest));
77
+ console.info('[Tracing]: Starting action execution.');
78
+ try {
79
+ const response = (await actionExecutor());
80
+ console.info('[Tracing]: Action execution done. Processing result', response);
81
+ if (response.statusCode === 429) {
82
+ segment.addThrottleFlag();
83
+ }
84
+ const cause = aws_xray_sdk_core_1.default.utils.getCauseTypeFromHttpStatus(response.statusCode);
85
+ if (response.statusCode === 429)
86
+ segment.addThrottleFlag();
87
+ if (cause === 'error')
88
+ segment.addErrorFlag();
89
+ if (cause === 'fault')
90
+ segment.addFaultFlag();
91
+ segment.http.close(response);
92
+ segment.close();
93
+ console.info('[Tracing]: Segment processed successfully.');
94
+ return response;
95
+ }
96
+ catch (error) {
97
+ segment.close(error);
98
+ throw error;
99
+ }
100
+ }
31
101
  static addSegment(name, parent) {
32
102
  var _a;
33
103
  const subSeg = (_a = (parent !== null && parent !== void 0 ? parent : Tracing.current)) === null || _a === void 0 ? void 0 : _a.addNewSubsegment(name);
@@ -51,9 +121,17 @@ class Tracing {
51
121
  });
52
122
  }
53
123
  static traceAsyncFunction(methodName, fn, parent) {
54
- return (...args) => {
55
- return Tracing.tracePromise(methodName, fn(...args), parent);
56
- };
124
+ return (...args) => aws_xray_sdk_1.default.captureAsyncFunc(methodName, (subsegment) => {
125
+ return fn(...args)
126
+ .then((result) => {
127
+ subsegment === null || subsegment === void 0 ? void 0 : subsegment.close();
128
+ return result;
129
+ })
130
+ .catch((error) => {
131
+ subsegment === null || subsegment === void 0 ? void 0 : subsegment.close(error);
132
+ throw error;
133
+ });
134
+ });
57
135
  }
58
136
  }
59
137
  Tracing.stack = [];
@@ -1 +1 @@
1
- {"version":3,"file":"tracing.js","sourceRoot":"","sources":["../../utils/tracing.ts"],"names":[],"mappings":";;;;;AACA,gEAA4D;AAG5D,MAAM,OAAO;IAQJ,MAAM,CAAC,WAAW,CAAC,SAAiB,EAAE,IAAa;QACxD,OAAO,CAAC,MAAM,EAAE,YAAY,EAAE,UAAU,EAAE,EAAE;YAC1C,MAAM,UAAU,GAAG,IAAI,aAAJ,IAAI,cAAJ,IAAI,GAAI,MAAM,CAAC,YAAY,CAAC,CAAA;YAG/C,UAAU,CAAC,KAAK,GAAG,OAAO,CAAC,kBAAkB,CAC3C,IAAI,SAAS,MAAM,UAAU,EAAE,EAC/B,UAAU,aAAV,UAAU,uBAAV,UAAU,CAAE,KAAY,CAClB,CAAA;QACV,CAAC,CAAA;IACH,CAAC;IAEM,MAAM,KAAK,OAAO;QACvB,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,MAAM,EAAE;YACzB,OAAO,sBAAI,CAAC,UAAU,EAAE,CAAA;SACzB;QAED,OAAO,OAAO,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAA;IAChD,CAAC;IAEM,MAAM,CAAC,OAAO;QACnB,IAAI;YACF,sBAAI,CAAC,yBAAyB,CAAC,WAAW,CAAC,CAAA;YAE3C,sBAAI,CAAC,kBAAkB,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAA;YACxC,sBAAI,CAAC,kBAAkB,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAA;YACzC,sBAAI,CAAC,cAAc,EAAE,CAAA;SACtB;QAAC,OAAO,KAAK,EAAE;YACd,OAAO,CAAC,IAAI,CAAC,cAAe,KAAe,CAAC,OAAO,EAAE,CAAC,CAAA;SACvD;IACH,CAAC;IAEM,MAAM,CAAC,UAAU,CAAC,IAAY,EAAE,MAAoB;;QACzD,MAAM,MAAM,GAAG,MAAA,CACb,MAAM,aAAN,MAAM,cAAN,MAAM,GAAK,OAAO,CAAC,OAAuB,CAC3C,0CAAE,gBAAgB,CAAC,IAAI,CAAC,CAAA;QACzB,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;QAE1B,OAAO,MAAM,CAAA;IACf,CAAC;IAEM,MAAM,CAAC,YAAY,CAAC,KAAe;QACxC,MAAM,OAAO,GAAG,OAAO,CAAC,KAAK,CAAC,GAAG,EAAE,CAAA;QACnC,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,KAAK,CAAC,KAA0B,CAAC,CAAA;IAC5C,CAAC;IAQM,MAAM,CAAC,YAAY,CACxB,IAAY,EACZ,OAAyB,EACzB,MAAoB;QAEpB,OAAO,CAAC,UAAU,CAAC,IAAI,EAAE,MAAM,CAAC,CAAA;QAEhC,OAAO,OAAO;aACX,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE;YACf,OAAO,CAAC,YAAY,EAAE,CAAA;YACtB,OAAO,MAAM,CAAA;QACf,CAAC,CAAC;aACD,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE;YACf,OAAO,CAAC,YAAY,CAAC,KAAK,CAAC,CAAA;YAC3B,MAAM,KAAK,CAAA;QACb,CAAC,CAAC,CAAA;IACN,CAAC;IAQM,MAAM,CAAC,kBAAkB,CAC9B,UAAkB,EAClB,EAAwC,EACxC,MAAoB;QAEpB,OAAO,CAAC,GAAG,IAAW,EAAE,EAAE;YACxB,OAAO,OAAO,CAAC,YAAY,CAAC,UAAU,EAAE,EAAE,CAAC,GAAG,IAAI,CAAC,EAAE,MAAM,CAAC,CAAA;QAC9D,CAAC,CAAA;IACH,CAAC;;AA3FuB,aAAK,GAAuB,EAAE,CAAA;AA6FxC,kBAAU,GAAoB,GAAG,EAAE;IAC/C,OAAO,CAAC,OAAO,EAAE,CAAA;AACnB,CAAC,CAAA;AAGH,kBAAe,OAAO,CAAA"}
1
+ {"version":3,"file":"tracing.js","sourceRoot":"","sources":["../../utils/tracing.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;AACA,6DAAqE;AACrE,0EAAwC;AAIxC,MAAM,OAAO;IAQJ,MAAM,CAAC,WAAW,CAAC,SAAiB,EAAE,IAAa;QACxD,OAAO,CAAC,MAAM,EAAE,YAAY,EAAE,UAAU,EAAE,EAAE;YAC1C,MAAM,UAAU,GAAG,IAAI,aAAJ,IAAI,cAAJ,IAAI,GAAI,MAAM,CAAC,YAAY,CAAC,CAAA;YAG/C,UAAU,CAAC,KAAK,GAAG,OAAO,CAAC,kBAAkB,CAC3C,IAAI,SAAS,MAAM,UAAU,EAAE,EAC/B,UAAU,aAAV,UAAU,uBAAV,UAAU,CAAE,KAAY,CAClB,CAAA;QACV,CAAC,CAAA;IACH,CAAC;IAEM,MAAM,KAAK,OAAO;QACvB,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,MAAM,EAAE;YACzB,OAAO,sBAAI,CAAC,UAAU,EAAE,CAAA;SACzB;QAED,OAAO,OAAO,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAA;IAChD,CAAC;IAEM,MAAM,CAAC,OAAO,CAAC,WAAoB;QACxC,IAAI;YACF,sBAAI,CAAC,yBAAyB,CAAC,WAAW,CAAC,CAAA;YAE3C,2BAAQ,CAAC,UAAU,CAAC,cAAc,CAChC,WAAW,aAAX,WAAW,cAAX,WAAW,GAAK,OAAO,CAAC,GAAG,CAAC,wBAAmC,CAChE,CAAA;YAED,sBAAI,CAAC,kBAAkB,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAA;YACxC,sBAAI,CAAC,kBAAkB,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAA;YACzC,sBAAI,CAAC,cAAc,EAAE,CAAA;SACtB;QAAC,OAAO,KAAK,EAAE;YACd,OAAO,CAAC,IAAI,CAAC,cAAe,KAAe,CAAC,OAAO,EAAE,CAAC,CAAA;SACvD;IACH,CAAC;IAEM,MAAM,CAAC,KAAK,CAAC,gBAAgB,CAClC,OAAyC,EACzC,cAAgE;QAEhE,MAAM,OAAO,GAAG,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,MAAM,CACjD,CAAC,UAAU,EAAE,UAAU,EAAE,EAAE,CACzB,MAAM,CAAC,MAAM,CAAC,UAAU,EAAE;YACxB,CAAC,UAAU,CAAC,WAAW,EAAE,CAAC,EAAE,OAAO,CAAC,OAAO,CAAC,UAAU,CAAC;SACxD,CAAC,EACJ,EAAyB,CAC1B,CAAA;QACD,MAAM,eAAe,GAAG;YACtB,OAAO;YACP,MAAM,EAAE,OAAO,CAAC,cAAc,CAAC,IAAI,CAAC,MAAM;YAC1C,GAAG,EAAE,OAAO,CAAC,OAAO;YACpB,UAAU,EAAE;gBACV,MAAM,EAAE,IAAI;aACb;SAC4B,CAAA;QAE/B,MAAM,aAAa,GAAG,2BAAQ,CAAC,UAAU,CAAC,cAAc,CAAC,EAAE,OAAO,EAAE,CAAC,CAAA;QACrE,OAAO,CAAC,IAAI,CAAC,0CAA0C,EAAE,aAAa,CAAC,CAAA;QAEvE,MAAM,IAAI,GAAG,2BAAQ,CAAC,UAAU,CAAC,WAAW,CAAC,OAAO,CAAC,IAAI,CAAC,CAAA;QAC1D,OAAO,CAAC,IAAI,CAAC,qCAAqC,EAAE,IAAI,CAAC,CAAA;QAEzD,MAAM,OAAO,GAAG,IAAI,sBAAO,CAAC,IAAI,EAAE,aAAa,CAAC,IAAI,EAAE,aAAa,CAAC,MAAM,CAAC,CAAA;QAC3E,OAAO,CAAC,IAAI,CAAC,gCAAgC,EAAE,OAAO,CAAC,CAAA;QAEvD,MAAM,eAAe,GAAG;YACtB,MAAM,EAAE,EAAE;YACV,GAAG,EAAE,eAAe;SACrB,CAAA;QAED,2BAAQ,CAAC,UAAU,CAAC,eAAe,CACjC,aAAa,EACb,OAAO,EACP,eAA4C,CAC7C,CAAA;QAED,OAAO,CAAC,IAAI,CACV,qDAAqD,EACrD,IAAI,2BAAQ,CAAC,UAAU,CAAC,mBAAmB,CAAC,eAAe,CAAC,CAC7D,CAAA;QAED,OAAO,CAAC,sBAAsB,CAC5B,IAAI,2BAAQ,CAAC,UAAU,CAAC,mBAAmB,CAAC,eAAe,CAAC,CAC7D,CAAA;QAED,OAAO,CAAC,IAAI,CAAC,uCAAuC,CAAC,CAAA;QAErD,IAAI;YACF,MAAM,QAAQ,GACZ,CAAC,MAAM,cAAc,EAAE,CAAgD,CAAA;YAEzE,OAAO,CAAC,IAAI,CACV,qDAAqD,EACrD,QAAQ,CACT,CAAA;YAED,IAAI,QAAQ,CAAC,UAAU,KAAK,GAAG,EAAE;gBAC/B,OAAO,CAAC,eAAe,EAAE,CAAA;aAC1B;YACD,MAAM,KAAK,GAAG,2BAAQ,CAAC,KAAK,CAAC,0BAA0B,CACrD,QAAQ,CAAC,UAAoB,CAC9B,CAAA;YAGD,IAAI,QAAQ,CAAC,UAAU,KAAK,GAAG;gBAAE,OAAO,CAAC,eAAe,EAAE,CAAA;YAC1D,IAAI,KAAK,KAAK,OAAO;gBAAE,OAAO,CAAC,YAAY,EAAE,CAAA;YAC7C,IAAI,KAAK,KAAK,OAAO;gBAAE,OAAO,CAAC,YAAY,EAAE,CAAA;YAI7C,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAA;YAC5B,OAAO,CAAC,KAAK,EAAE,CAAA;YAEf,OAAO,CAAC,IAAI,CAAC,4CAA4C,CAAC,CAAA;YAE1D,OAAO,QAAQ,CAAA;SAChB;QAAC,OAAO,KAAK,EAAE;YACd,OAAO,CAAC,KAAK,CAAC,KAAuB,CAAC,CAAA;YACtC,MAAM,KAAK,CAAA;SACZ;IACH,CAAC;IAEM,MAAM,CAAC,UAAU,CAAC,IAAY,EAAE,MAAoB;;QACzD,MAAM,MAAM,GAAG,MAAA,CACb,MAAM,aAAN,MAAM,cAAN,MAAM,GAAK,OAAO,CAAC,OAAuB,CAC3C,0CAAE,gBAAgB,CAAC,IAAI,CAAC,CAAA;QACzB,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;QAE1B,OAAO,MAAM,CAAA;IACf,CAAC;IAEM,MAAM,CAAC,YAAY,CAAC,KAAe;QACxC,MAAM,OAAO,GAAG,OAAO,CAAC,KAAK,CAAC,GAAG,EAAE,CAAA;QACnC,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,KAAK,CAAC,KAA0B,CAAC,CAAA;IAC5C,CAAC;IAQM,MAAM,CAAC,YAAY,CACxB,IAAY,EACZ,OAAyB,EACzB,MAAoB;QAEpB,OAAO,CAAC,UAAU,CAAC,IAAI,EAAE,MAAM,CAAC,CAAA;QAEhC,OAAO,OAAO;aACX,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE;YACf,OAAO,CAAC,YAAY,EAAE,CAAA;YACtB,OAAO,MAAM,CAAA;QACf,CAAC,CAAC;aACD,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE;YACf,OAAO,CAAC,YAAY,CAAC,KAAK,CAAC,CAAA;YAC3B,MAAM,KAAK,CAAA;QACb,CAAC,CAAC,CAAA;IACN,CAAC;IAQM,MAAM,CAAC,kBAAkB,CAC9B,UAAkB,EAClB,EAAwC,EACxC,MAAoB;QAEpB,OAAO,CAAC,GAAG,IAAW,EAAE,EAAE,CACxB,sBAAI,CAAC,gBAAgB,CAAC,UAAU,EAAE,CAAC,UAAU,EAAE,EAAE;YAC/C,OAAO,EAAE,CAAC,GAAG,IAAI,CAAC;iBACf,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE;gBACf,UAAU,aAAV,UAAU,uBAAV,UAAU,CAAE,KAAK,EAAE,CAAA;gBACnB,OAAO,MAAM,CAAA;YACf,CAAC,CAAC;iBACD,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE;gBACf,UAAU,aAAV,UAAU,uBAAV,UAAU,CAAE,KAAK,CAAC,KAAK,CAAC,CAAA;gBACxB,MAAM,KAAK,CAAA;YACb,CAAC,CAAC,CAAA;QACN,CAAC,CAAC,CAAA;IACN,CAAC;;AA9LuB,aAAK,GAAuB,EAAE,CAAA;AAgMxC,kBAAU,GAAoB,GAAG,EAAE;IAC/C,OAAO,CAAC,OAAO,EAAE,CAAA;AACnB,CAAC,CAAA;AAGH,kBAAe,OAAO,CAAA"}