@naturalcycles/backend-lib 2.73.3 → 3.3.0

package/dist/server/handlers/requestTimeout.mw.d.ts

@@ -1,16 +0,0 @@
-import { RequestHandler } from 'express';
-export interface RequestTimeoutCfg {
-    /**
-     * @default 120
-     */
-    timeoutSeconds?: number;
-    /**
-     * @default 503
-     */
-    httpStatusCode?: number;
-    /**
-     * @default 'Request timed out'
-     */
-    httpErrorMessage?: string;
-}
-export declare function requestTimeout(cfg?: RequestTimeoutCfg): RequestHandler;

package/dist/server/handlers/requestTimeout.mw.js

@@ -1,34 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.requestTimeout = void 0;
-const js_lib_1 = require("@naturalcycles/js-lib");
-const index_1 = require("../../index");
-const code = 'REQUEST_TIMEOUT';
-const REQUEST_TIMEOUT_QUERY_KEY = 'requestTimeout';
-function requestTimeout(cfg = {}) {
-    const { timeoutSeconds: defTimeoutSeconds, httpStatusCode, httpErrorMessage, } = {
-        // Considerations about the default value of the timeout.
-        // Ideally the default value here would be HIGHER than the default timeout for getGot (in nodejs-lib),
-        // so, cross-service communication has a chance to fail SOONER than server times out,
-        // so, proper error from exact service is shown, rather than generic "503 request timed out"
-        timeoutSeconds: 120,
-        httpStatusCode: 503,
-        httpErrorMessage: 'Request timed out',
-        ...cfg,
-    };
-    return (req, res, next) => {
-        const timeoutSeconds = req.query[REQUEST_TIMEOUT_QUERY_KEY]
-            ? Number.parseInt(req.query[REQUEST_TIMEOUT_QUERY_KEY])
-            : defTimeoutSeconds;
-        const timer = setTimeout(() => {
-            (0, index_1.respondWithError)(req, res, new js_lib_1.HttpError(httpErrorMessage, {
-                code,
-                httpStatusCode,
-                // userFriendly: true, // no, cause this error is not expected
-            }));
-        }, timeoutSeconds * 1000);
-        (0, index_1.onFinished)(res, () => clearTimeout(timer));
-        next();
-    };
-}
-exports.requestTimeout = requestTimeout;

package/dist/server/handlers/sentryErrorHandler.mw.d.ts

@@ -1,10 +0,0 @@
-import { ErrorRequestHandler } from 'express';
-import { SentrySharedService } from '../..';
-export interface SentryErrorMiddlewareCfg {
-    sentryService: SentrySharedService;
-}
-/**
- * Mutates err with err.data.errorId.
- * Passes error further via next(err).
- */
-export declare function sentryErrorHandler(cfg: SentryErrorMiddlewareCfg): ErrorRequestHandler;

package/dist/server/handlers/sentryErrorHandler.mw.js

@@ -1,26 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.sentryErrorHandler = void 0;
-/**
- * Mutates err with err.data.errorId.
- * Passes error further via next(err).
- */
-function sentryErrorHandler(cfg) {
-    return (err, req, res, next) => {
-        if (!err)
-            return next();
-        err.data = {
-            ...err.data,
-        };
-        const httpStatusCode = err.data.httpStatusCode || 500;
-        if (shouldReportToSentry(httpStatusCode)) {
-            err.data.errorId = cfg.sentryService.captureException(err);
-        }
-        next(err);
-    };
-}
-exports.sentryErrorHandler = sentryErrorHandler;
-function shouldReportToSentry(httpCode) {
-    // Only report 5xx
-    return httpCode >= 500;
-}

package/dist/server/handlers/serverStatsMiddleware.d.ts

@@ -1,13 +0,0 @@
-import { RequestHandler } from 'express';
-/**
- * Depends on serverStatsMiddleware to work.
- *
- * @example
- *
- * router.get('/stats', serverStatsHTMLHandler)
- */
-export declare const serverStatsHTMLHandler: RequestHandler;
-/**
- * Unlocks serverStatsHTMLHandler
- */
-export declare function serverStatsMiddleware(): RequestHandler;

package/dist/server/handlers/simpleRequestLogger.mw.d.ts

@@ -1,12 +0,0 @@
-import { RequestHandler } from 'express';
-export interface SimpleRequestLoggerCfg {
-    /**
-     * @default false
-     */
-    logStart: boolean;
-    /**
-     * @default true
-     */
-    logFinish: boolean;
-}
-export declare function simpleRequestLogger(_cfg?: Partial<SimpleRequestLoggerCfg>): RequestHandler;

package/dist/server/handlers/statusHandler.d.ts

@@ -1,3 +0,0 @@
-import { RequestHandler } from 'express';
-export declare function statusHandler(projectDir?: string, extra?: any): RequestHandler;
-export declare function statusHandlerData(projectDir?: string, extra?: any): Record<string, any>;

package/src/server/handlers/notFoundHandler.mw.ts

@@ -1,7 +0,0 @@
-import { RequestHandler } from 'express'
-
-export function notFoundHandler(): RequestHandler {
-  return (req, res) => {
-    res.status(404).send(`404 Not Found: ${req.url}`)
-  }
-}

package/src/server/handlers/okHandler.mw.ts

@@ -1,7 +0,0 @@
-import { RequestHandler } from 'express'
-
-export function okHandler(): RequestHandler {
-  return (req, res) => {
-    res.json({ ok: 1 })
-  }
-}

package/src/server/handlers/requestTimeout.mw.ts

@@ -1,62 +0,0 @@
-import { HttpError } from '@naturalcycles/js-lib'
-import { RequestHandler } from 'express'
-import { onFinished, respondWithError } from '../../index'
-
-export interface RequestTimeoutCfg {
-  /**
-   * @default 120
-   */
-  timeoutSeconds?: number
-
-  /**
-   * @default 503
-   */
-  httpStatusCode?: number
-
-  /**
-   * @default 'Request timed out'
-   */
-  httpErrorMessage?: string
-}
-
-const code = 'REQUEST_TIMEOUT'
-const REQUEST_TIMEOUT_QUERY_KEY = 'requestTimeout'
-
-export function requestTimeout(cfg: RequestTimeoutCfg = {}): RequestHandler {
-  const {
-    timeoutSeconds: defTimeoutSeconds,
-    httpStatusCode,
-    httpErrorMessage,
-  } = {
-    // Considerations about the default value of the timeout.
-    // Ideally the default value here would be HIGHER than the default timeout for getGot (in nodejs-lib),
-    // so, cross-service communication has a chance to fail SOONER than server times out,
-    // so, proper error from exact service is shown, rather than generic "503 request timed out"
-    timeoutSeconds: 120,
-    httpStatusCode: 503,
-    httpErrorMessage: 'Request timed out',
-    ...cfg,
-  }
-
-  return (req, res, next) => {
-    const timeoutSeconds = req.query[REQUEST_TIMEOUT_QUERY_KEY]
-      ? Number.parseInt(req.query[REQUEST_TIMEOUT_QUERY_KEY] as string)
-      : defTimeoutSeconds
-
-    const timer = setTimeout(() => {
-      respondWithError(
-        req,
-        res,
-        new HttpError(httpErrorMessage, {
-          code,
-          httpStatusCode,
-          // userFriendly: true, // no, cause this error is not expected
-        }),
-      )
-    }, timeoutSeconds * 1000)
-
-    onFinished(res, () => clearTimeout(timer))
-
-    next()
-  }
-}

package/src/server/handlers/sentryErrorHandler.mw.ts

@@ -1,34 +0,0 @@
-import { HttpErrorData } from '@naturalcycles/js-lib'
-import { ErrorRequestHandler } from 'express'
-import { SentrySharedService } from '../..'
-
-export interface SentryErrorMiddlewareCfg {
-  sentryService: SentrySharedService
-}
-
-/**
- * Mutates err with err.data.errorId.
- * Passes error further via next(err).
- */
-export function sentryErrorHandler(cfg: SentryErrorMiddlewareCfg): ErrorRequestHandler {
-  return (err, req, res, next) => {
-    if (!err) return next()
-
-    err.data = {
-      ...err.data,
-    }
-
-    const httpStatusCode = (err.data as HttpErrorData).httpStatusCode || 500
-
-    if (shouldReportToSentry(httpStatusCode)) {
-      err.data.errorId = cfg.sentryService.captureException(err)
-    }
-
-    next(err)
-  }
-}
-
-function shouldReportToSentry(httpCode: number): boolean {
-  // Only report 5xx
-  return httpCode >= 500
-}