@mondaydotcomorg/monday-authorization 1.0.15 → 1.0.16

package/README.md

@@ -18,28 +18,45 @@ yarn add @mondaydotcomorg/monday-authorization
 
 ## Usage
 
+First init the package in order for it to work properly
+
+app.ts:
+
+```ts
+import { startServer, getPrometheus } from '@mondaydotcomorg/monday-server-runner';
+import * as MondayAuthorization from '@mondaydotcomorg/monday-authorization';
+
+...
+
+MondayAuthorization.init({ prometheus: getPrometheus() });
+startServer(...)
 ```
+
+Then add this code to any route declaration:
+
+```ts
 import { Router } from 'express';
-import { getAuthorizationMiddleware, skipAuthorizationMiddleware, authorizationCheckMiddleware } from '@mondaydotcomorg/monday-authorization'
+import {
+  getAuthorizationMiddleware,
+  skipAuthorizationMiddleware,
+  authorizationCheckMiddleware,
+} from '@mondaydotcomorg/monday-authorization';
 import { like } from 'src/controllers/likes/likes-controller';
 
 const action = 'like';
-const resourceGetter = (request) => {
+const resourceGetter = request => {
   return [
     {
       id: request.params.postId,
       type: 'post',
-      wrapper_data: { item_id: 431234} //optional
-    }
+      wrapper_data: { item_id: 431234 }, //optional
+    },
   ];
 };
 router = Router();
 router.use(authorizationCheckMiddleware);
-router.post('/posts/:postId/like', getAuthorizationMiddleware(action, resourceGetter),
-  like
-);
+router.post('/posts/:postId/like', getAuthorizationMiddleware(action, resourceGetter), like);
 router.get('/internal/some_unauthorized_endpoint', skipAuthorizationMiddleware, handler);
-
 ```
 
 `resourceGetter` is a function that gets the request and return an array of resources.
@@ -51,7 +68,7 @@ The item_id is all that needed for the authorization of posts.
 by default. If you're not using the authentication middleware, you will have to provide a contextGetter
 function, that looks like this:
 
-```
+```ts
 (request) => {
   return ({
     accountId: ...,

package/dist/index.d.ts

@@ -1,2 +1,6 @@
+export interface InitOptions {
+    prometheus?: any;
+}
+export declare function init(options?: InitOptions): void;
 export { authorizationCheckMiddleware, getAuthorizationMiddleware, skipAuthorizationMiddleware, } from './lib/authorization-middleware';
 export { AuthorizationService } from './lib/authorization-service';

package/dist/index.js

@@ -1,6 +1,13 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.AuthorizationService = exports.skipAuthorizationMiddleware = exports.getAuthorizationMiddleware = exports.authorizationCheckMiddleware = void 0;
+exports.AuthorizationService = exports.skipAuthorizationMiddleware = exports.getAuthorizationMiddleware = exports.authorizationCheckMiddleware = exports.init = void 0;
+const prometheus_service_1 = require("./lib/prometheus-service");
+function init(options = {}) {
+    if (options.prometheus) {
+        prometheus_service_1.setPrometheus(options.prometheus);
+    }
+}
+exports.init = init;
 var authorization_middleware_1 = require("./lib/authorization-middleware");
 Object.defineProperty(exports, "authorizationCheckMiddleware", { enumerable: true, get: function () { return authorization_middleware_1.authorizationCheckMiddleware; } });
 Object.defineProperty(exports, "getAuthorizationMiddleware", { enumerable: true, get: function () { return authorization_middleware_1.getAuthorizationMiddleware; } });

package/dist/lib/authorization-service.js

@@ -35,6 +35,7 @@ exports.AuthorizationService = void 0;
 const monday_jwt_1 = require("@mondaydotcomorg/monday-jwt");
 const MondayLogger = __importStar(require("@mondaydotcomorg/monday-logger"));
 const monday_fetch_1 = __importDefault(require("@mondaydotcomorg/monday-fetch"));
+const prometheus_service_1 = require("./prometheus-service");
 const INTERNAL_APP_NAME = 'internal_ms';
 const URL = `${process.env.MONDAY_INTERNAL_URL}/internal_ms/authorization/authorize`;
 const IS_DEV_ENV = process.env.NODE_ENV === 'development';
@@ -60,10 +61,12 @@ class AuthorizationService {
             }
             const responseBody = yield response.json();
             const unauthorizedObjects = [];
-            responseBody.result.forEach(function (value, index) {
-                if (!value) {
-                    unauthorizedObjects.push(params.authorizationObjects[index]);
+            responseBody.result.forEach(function (isAuthorized, index) {
+                const authorizationObject = params.authorizationObjects[index];
+                if (!isAuthorized) {
+                    unauthorizedObjects.push(authorizationObject);
                 }
+                sendAuthorizationCheckMetric(authorizationObject.resource_type, isAuthorized);
             });
             if (unauthorizedObjects.length > 0) {
                 logger.info({
@@ -96,3 +99,12 @@ function createAuthorizationParams(resources, action) {
 function logOnFetchFail(retries, error, response) {
     logger.error({ attempt: retries, error }, 'Authorization attempt failed due to network issues');
 }
+function sendAuthorizationCheckMetric(resourceType, isAuthorized) {
+    const metricsManager = prometheus_service_1.getMetricsManager();
+    if (metricsManager) {
+        metricsManager.increaseCounter(prometheus_service_1.METRICS.AUTHORIZATION_CHECK, {
+            resourceType,
+            isAuthorized,
+        });
+    }
+}

package/dist/lib/prometheus-service.d.ts

@@ -0,0 +1,5 @@
+export declare const METRICS: {
+    AUTHORIZATION_CHECK: string;
+};
+export declare function setPrometheus(customPrometheus: any): void;
+export declare function getMetricsManager(): any;

package/dist/lib/prometheus-service.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getMetricsManager = exports.setPrometheus = exports.METRICS = void 0;
+let prometheus = null;
+exports.METRICS = {
+    AUTHORIZATION_CHECK: 'authorization_check',
+};
+function setPrometheus(customPrometheus) {
+    prometheus = customPrometheus;
+}
+exports.setPrometheus = setPrometheus;
+function getMetricsManager() {
+    return prometheus === null || prometheus === void 0 ? void 0 : prometheus.metricsManager;
+}
+exports.getMetricsManager = getMetricsManager;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mondaydotcomorg/monday-authorization",
-  "version": "1.0.15",
+  "version": "1.0.16",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "license": "BSD-3-Clause",
@@ -31,5 +31,5 @@
   "files": [
     "dist/"
   ],
-  "gitHead": "d679b58dc0c0f3c27ed0f938350a79302caa8aee"
+  "gitHead": "bc21495debb5e34772c3c1fd8dff26870081d103"
 }