idea-aws 3.15.0 → 3.15.1

package/dist/src/metrics.js

@@ -7,7 +7,7 @@ const metrics_1 = require("@aws-lambda-powertools/metrics");
  */
 class CloudWatchMetrics {
     constructor(options) {
-        const project = options?.project ?? process.env.PROJECT ?? 'unknownProject';
+        const project = options?.project ?? 'unknownProject';
         this.metrics = new metrics_1.Metrics({ namespace: project });
     }
     /**

package/dist/src/resourceController.d.ts

@@ -16,14 +16,18 @@ export declare abstract class ResourceController extends GenericController {
     protected principalId: string;
     protected cognitoUser: CognitoUser;
     protected auth0User: Auth0User;
+    protected project: string;
     protected stage: string;
     protected httpMethod: string;
     protected body: any;
     protected queryParams: any;
-    protected resource: string;
+    protected resourcePath: string;
     protected path: string;
     protected pathParameters: any;
+    protected resource: string;
     protected resourceId: string;
+    protected clientVersion: string;
+    protected clientPlatform: string;
     protected returnStatusCode?: number;
     protected logger: Logger;
     protected logRequestsWithKey: string;

package/dist/src/resourceController.js

@@ -15,8 +15,13 @@ class ResourceController extends genericController_1.GenericController {
     constructor(event, callback, options = {}) {
         super(event, callback, options);
         this.initError = false;
+        this.project = process?.env?.PROJECT;
+        this.stage = process?.env?.STAGE;
+        this.resource = process?.env?.RESOURCE;
+        this.clientVersion = '?';
+        this.clientPlatform = '?';
         this.logger = new logger_1.Logger();
-        this.metrics = new metrics_1.CloudWatchMetrics();
+        this.metrics = new metrics_1.CloudWatchMetrics({ project: this.project });
         this.templateMatcher = /{{\s?([^{}\s]*)\s?}}/g;
         ///
         /// REQUEST HANDLERS
@@ -97,18 +102,23 @@ class ResourceController extends genericController_1.GenericController {
                 this.initFromEventV1(event, options);
             this.logRequestsWithKey = options.logRequestsWithKey;
             // acquire some info about the client, if available
-            let version = '?', platform = '?';
             if (this.queryParams['_v']) {
-                version = this.queryParams['_v'];
+                this.clientVersion = this.queryParams['_v'];
                 delete this.queryParams['_v'];
             }
             if (this.queryParams['_p']) {
-                platform = this.queryParams['_p'];
+                this.clientPlatform = this.queryParams['_p'];
                 delete this.queryParams['_p'];
             }
             this.prepareMetrics();
             // print the initial log
-            const info = { principalId: this.principalId, queryParams: this.queryParams, body: this.body, version, platform };
+            const info = {
+                principalId: this.principalId,
+                queryParams: this.queryParams,
+                body: this.body,
+                version: this.clientVersion,
+                platform: this.clientPlatform
+            };
             this.logger.info(`START: ${this.httpMethod} ${this.path}`, info);
         }
         catch (err) {
@@ -123,9 +133,9 @@ class ResourceController extends genericController_1.GenericController {
         this.principalId = contextFromAuthorizer.principalId ?? contextFromAuthorizer.sub ?? null;
         this.cognitoUser = authorizer.jwt?.claims ? new idea_toolbox_1.CognitoUser(authorizer.jwt?.claims) : null;
         this.auth0User = contextFromAuthorizer.auth0User ? new idea_toolbox_1.Auth0User(contextFromAuthorizer.auth0User) : null;
-        this.stage = event.requestContext.stage;
+        this.stage = this.stage ?? event.requestContext.stage;
         this.httpMethod = event.requestContext.http.method;
-        this.resource = event.routeKey.replace('+', ''); // {proxy+} -> {proxy}
+        this.resourcePath = event.routeKey.replace('+', ''); // {proxy+} -> {proxy}
         this.path = event.rawPath;
         this.pathParameters = {};
         for (const param in event.pathParameters)
@@ -145,9 +155,9 @@ class ResourceController extends genericController_1.GenericController {
         this.principalId = this.claims.sub;
         this.cognitoUser = this.principalId ? new idea_toolbox_1.CognitoUser(this.claims) : null;
         this.auth0User = null;
-        this.stage = event.requestContext.stage;
+        this.stage = this.stage ?? event.requestContext.stage;
         this.httpMethod = event.httpMethod;
-        this.resource = event.resource.replace('+', ''); // {proxy+} -> {proxy}
+        this.resourcePath = event.resource.replace('+', ''); // {proxy+} -> {proxy}
         this.path = event.path;
         this.pathParameters = {};
         for (const param in event.pathParameters)
@@ -280,7 +290,7 @@ class ResourceController extends genericController_1.GenericController {
         const log = new idea_toolbox_1.APIRequestLog({
             logId: this.logRequestsWithKey,
             userId: this.principalId,
-            resource: this.resource,
+            resource: this.resourcePath,
             path: this.path,
             resourceId: this.resourceId,
             method: this.httpMethod,
@@ -316,12 +326,14 @@ class ResourceController extends genericController_1.GenericController {
      * Prepare the CloudWatch metrics at the beginning of a request.
      */
     prepareMetrics() {
-        this.metrics.addDimension('stage', process.env.STAGE);
-        this.metrics.addDimension('resource', process.env.RESOURCE);
+        this.metrics.addDimension('stage', this.stage);
+        this.metrics.addDimension('resource', this.resource);
         this.metrics.addDimension('method', this.httpMethod);
         this.metrics.addDimension('target', this.resourceId ? 'id' : 'list');
         this.metrics.addDimension('action', this.body?.action);
         this.metrics.addDimension('userId', this.principalId);
+        this.metrics.addDimension('clientVersion', this.clientVersion);
+        this.metrics.addDimension('clientPlatform', this.clientPlatform);
         this.metrics.addMetadata('resourceId', this.resourceId);
     }
     /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "idea-aws",
-  "version": "3.15.0",
+  "version": "3.15.1",
   "description": "AWS wrappers to use in IDEA's back-ends",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",