@naturalcycles/backend-lib 4.15.0 → 4.17.0

package/dist/index.d.ts

@@ -18,6 +18,7 @@ export * from './server/serverStatsMiddleware';
 export * from './server/methodOverrideMiddleware';
 export * from './server/notFoundMiddleware';
 export * from './server/okMiddleware';
+export * from './server/basicAuthMiddleware';
 export * from './server/requestTimeoutMiddleware';
 export * from './server/reqValidationMiddleware';
 export * from './server/simpleRequestLoggerMiddleware';

package/dist/index.js

@@ -23,6 +23,7 @@ tslib_1.__exportStar(require("./server/serverStatsMiddleware"), exports);
 tslib_1.__exportStar(require("./server/methodOverrideMiddleware"), exports);
 tslib_1.__exportStar(require("./server/notFoundMiddleware"), exports);
 tslib_1.__exportStar(require("./server/okMiddleware"), exports);
+tslib_1.__exportStar(require("./server/basicAuthMiddleware"), exports);
 tslib_1.__exportStar(require("./server/requestTimeoutMiddleware"), exports);
 tslib_1.__exportStar(require("./server/reqValidationMiddleware"), exports);
 tslib_1.__exportStar(require("./server/simpleRequestLoggerMiddleware"), exports);

package/dist/sentry/sentry.shared.service.js

@@ -76,6 +76,12 @@ class SentrySharedService {
             // Skip reporting the error
             return;
         }
+        if (err?.data?.reportRate) {
+            const reportRate = err.data.reportRate;
+            // E.g rate of 0.1 means 10% of errors are reported
+            if (Math.random() > reportRate)
+                return;
+        }
         // This is to avoid Sentry cutting err.message to 253 characters
         // It will log additional "breadcrumb object" before the error
         // It's a Breadcrumb, not a console.log, because console.log are NOT automatically attached as Breadcrumbs in cron-job environments (outside of Express)

package/dist/server/basicAuthMiddleware.d.ts

@@ -0,0 +1,13 @@
+import { StringMap } from '@naturalcycles/js-lib';
+import { BackendRequestHandler } from './server.model';
+export interface BasicAuthMiddlewareCfg {
+    /**
+     * Map from login (Sting) to password (String).
+     */
+    loginPasswordMap: StringMap;
+    /**
+     *
+     */
+    realm?: string;
+}
+export declare function basicAuthMiddleware(cfg: BasicAuthMiddlewareCfg): BackendRequestHandler;

package/dist/server/basicAuthMiddleware.js

@@ -0,0 +1,23 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.basicAuthMiddleware = void 0;
+const js_lib_1 = require("@naturalcycles/js-lib");
+const nodejs_lib_1 = require("@naturalcycles/nodejs-lib");
+function basicAuthMiddleware(cfg) {
+    const { realm } = cfg;
+    return function basicAuthMiddlewareHandler(req, res, next) {
+        const hash = (req.headers.authorization || '').split(' ')[1];
+        if (hash) {
+            const [login, password] = (0, js_lib_1._split)((0, nodejs_lib_1.base64ToString)(hash), ':', 2);
+            if (login && password && cfg.loginPasswordMap[login] === password) {
+                return next();
+            }
+        }
+        // Unauthorized
+        res
+            .set('WWW-Authenticate', `Basic${realm ? ` realm="${realm}"` : ''}`)
+            .status(401)
+            .send('Unauthorized');
+    };
+}
+exports.basicAuthMiddleware = basicAuthMiddleware;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@naturalcycles/backend-lib",
-  "version": "4.15.0",
+  "version": "4.17.0",
   "scripts": {
     "prepare": "husky install && patch-package",
     "serve": "APP_ENV=dev nodemon",

package/src/index.ts

@@ -18,6 +18,7 @@ export * from './server/serverStatsMiddleware'
 export * from './server/methodOverrideMiddleware'
 export * from './server/notFoundMiddleware'
 export * from './server/okMiddleware'
+export * from './server/basicAuthMiddleware'
 export * from './server/requestTimeoutMiddleware'
 export * from './server/reqValidationMiddleware'
 export * from './server/simpleRequestLoggerMiddleware'

package/src/sentry/sentry.shared.service.ts

@@ -1,4 +1,4 @@
-import { _anyToError, _Memo, CommonLogger, CommonLogLevel } from '@naturalcycles/js-lib'
+import { _anyToError, _Memo, AppError, CommonLogger, CommonLogLevel } from '@naturalcycles/js-lib'
 import { inspectAny } from '@naturalcycles/nodejs-lib'
 import type { Breadcrumb, NodeOptions, SeverityLevel } from '@sentry/node'
 import type * as SentryLib from '@sentry/node'
@@ -88,6 +88,12 @@ export class SentrySharedService {
       return
     }
 
+    if (err?.data?.reportRate) {
+      const reportRate = (err as AppError).data.reportRate!
+      // E.g rate of 0.1 means 10% of errors are reported
+      if (Math.random() > reportRate) return
+    }
+
     // This is to avoid Sentry cutting err.message to 253 characters
     // It will log additional "breadcrumb object" before the error
     // It's a Breadcrumb, not a console.log, because console.log are NOT automatically attached as Breadcrumbs in cron-job environments (outside of Express)

package/src/server/basicAuthMiddleware.ts

@@ -0,0 +1,35 @@
+import { _split, StringMap } from '@naturalcycles/js-lib'
+import { base64ToString } from '@naturalcycles/nodejs-lib'
+import { BackendRequestHandler } from './server.model'
+
+export interface BasicAuthMiddlewareCfg {
+  /**
+   * Map from login (Sting) to password (String).
+   */
+  loginPasswordMap: StringMap
+
+  /**
+   *
+   */
+  realm?: string
+}
+
+export function basicAuthMiddleware(cfg: BasicAuthMiddlewareCfg): BackendRequestHandler {
+  const { realm } = cfg
+
+  return function basicAuthMiddlewareHandler(req, res, next) {
+    const hash = (req.headers.authorization || '').split(' ')[1]
+    if (hash) {
+      const [login, password] = _split(base64ToString(hash), ':', 2)
+      if (login && password && cfg.loginPasswordMap[login] === password) {
+        return next()
+      }
+    }
+
+    // Unauthorized
+    res
+      .set('WWW-Authenticate', `Basic${realm ? ` realm="${realm}"` : ''}`)
+      .status(401)
+      .send('Unauthorized')
+  }
+}