@naturalcycles/backend-lib 9.42.3 → 9.43.0

package/dist/express/createDefaultApp.js

@@ -33,6 +33,10 @@ export async function createDefaultApp(cfg) {
     // accepts application/json
     app.use(express.json({
         limit: '1mb',
+        verify(req, _res, buf) {
+            // Store the raw Buffer body
+            req.rawBody = buf;
+        },
         ...cfg.bodyParserJsonOptions,
     }));
     app.use(express.urlencoded({
@@ -44,6 +48,10 @@ export async function createDefaultApp(cfg) {
     app.use(express.raw({
         // inflate: true, // default is `true`
         limit: '1mb',
+        verify(req, _res, buf) {
+            // Store the raw Buffer body
+            req.rawBody = buf;
+        },
         ...cfg.bodyParserRawOptions,
     }));
     app.use(cookieParser());

package/dist/server/server.model.d.ts

@@ -18,6 +18,15 @@ export interface BackendRequest extends Request {
      * Only used for request logging purposes.
      */
     userId?: string;
+    /**
+     * Raw Buffer of the `req.body`, before it's stringified and json-parsed.
+     * Useful for when something mutates `req.body` json (e.g j validation), and you
+     * want access to the original input.
+     *
+     * For `req.rawBody` to exist - you need to use `createDefaultApp`, or use the
+     * `verify` option of the json parser (copy-paste it from `createDefaultApp`).
+     */
+    rawBody?: Buffer;
     /**
      * Set by requestTimeoutMiddleware.
      * Can be used to cancel/override the timeout.

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@naturalcycles/backend-lib",
   "type": "module",
-  "version": "9.42.3",
+  "version": "9.43.0",
   "peerDependencies": {
     "@sentry/node": "^10"
   },
@@ -29,13 +29,12 @@
     "@sentry/node": "^10",
     "@types/ejs": "^3",
     "fastify": "^5",
-    "@naturalcycles/dev-lib": "20.11.1"
+    "@naturalcycles/dev-lib": "18.4.2"
   },
   "exports": {
     ".": "./dist/index.js",
     "./admin": "./dist/admin/index.js",
     "./admin/*.js": "./dist/admin/*.js",
-    "./cloudrun": "./dist/cloudrun/cloudRun.js",
     "./db": "./dist/db/index.js",
     "./deploy": "./dist/deploy/index.js",
     "./deploy/*.js": "./dist/deploy/*.js",

package/src/express/createDefaultApp.ts

@@ -10,7 +10,11 @@ import { logMiddleware } from '../server/logMiddleware.js'
 import { methodOverrideMiddleware } from '../server/methodOverrideMiddleware.js'
 import { notFoundMiddleware } from '../server/notFoundMiddleware.js'
 import { requestTimeoutMiddleware } from '../server/requestTimeoutMiddleware.js'
-import type { BackendApplication, BackendRequestHandler } from '../server/server.model.js'
+import type {
+  BackendApplication,
+  BackendRequest,
+  BackendRequestHandler,
+} from '../server/server.model.js'
 import { simpleRequestLoggerMiddleware } from '../server/simpleRequestLoggerMiddleware.js'
 
 const isTest = process.env['APP_ENV'] === 'test'
@@ -53,6 +57,10 @@ export async function createDefaultApp(cfg: DefaultAppCfg): Promise<BackendAppli
   app.use(
     express.json({
       limit: '1mb',
+      verify(req: BackendRequest, _res, buf) {
+        // Store the raw Buffer body
+        req.rawBody = buf
+      },
       ...cfg.bodyParserJsonOptions,
     }),
   )
@@ -70,6 +78,10 @@ export async function createDefaultApp(cfg: DefaultAppCfg): Promise<BackendAppli
     express.raw({
       // inflate: true, // default is `true`
       limit: '1mb',
+      verify(req: BackendRequest, _res, buf) {
+        // Store the raw Buffer body
+        req.rawBody = buf
+      },
       ...cfg.bodyParserRawOptions,
     }),
   )

package/src/server/server.model.ts

@@ -20,6 +20,15 @@ export interface BackendRequest extends Request {
    * Only used for request logging purposes.
    */
   userId?: string
+  /**
+   * Raw Buffer of the `req.body`, before it's stringified and json-parsed.
+   * Useful for when something mutates `req.body` json (e.g j validation), and you
+   * want access to the original input.
+   *
+   * For `req.rawBody` to exist - you need to use `createDefaultApp`, or use the
+   * `verify` option of the json parser (copy-paste it from `createDefaultApp`).
+   */
+  rawBody?: Buffer
 
   /**
    * Set by requestTimeoutMiddleware.

package/dist/cloudrun/cloudRun.d.ts

@@ -1,114 +0,0 @@
-import type { AnyObject, NonNegativeInteger, NumberOfMilliseconds, NumberOfSeconds, PositiveInteger, UnixTimestamp } from '@naturalcycles/js-lib/types';
-export interface CloudRunConfig {
-    gcpProject: string;
-    /**
-     * Name of the Cloud Run service.
-     */
-    cloudRunService: string;
-    cloudRunServiceBase?: string;
-    runtimeServiceAccount: string;
-    /**
-     * GCP region where the Cloud Run service is deployed. Example: 'europe-west1'
-     */
-    cloudRunRegion: string;
-    sqlInstance?: string;
-    vpcConnector?: string;
-    serviceUrl?: string;
-    /**
-     * Service URL that is used to access the service externally (through load balancer)
-     * todo: overlaps with env.K_EXTERNAL_URL
-     */
-    externalUrl?: string;
-    buildVersion: string;
-    /**
-     * Unix timestamp of the build/deployment time.
-     */
-    tsUnix: UnixTimestamp;
-    targetDockerImageId: string;
-    dockerImageTag: string;
-    /**
-     * Short SHA of the commit used for this deployment.
-     */
-    gitRev: string;
-    gitBranch: string;
-    /**
-     * Example: 'APP_ENV=prod,BUILD_VERSION=abcd,a=b'
-     */
-    envString: string;
-    /**
-     * Example: httpGet.path='/',httpGet.port=8080,initialDelaySeconds=3,failureThreshold=50,timeoutSeconds=1,periodSeconds=2
-     */
-    startupProbeConfigString: string;
-    livenessProbeConfigString?: string;
-    minInstances: NonNegativeInteger;
-    maxInstances: PositiveInteger;
-    /**
-     * CloudRun concurrency setting.
-     * Example: 80
-     */
-    concurrency: PositiveInteger;
-    /**
-     * Example: '512Mi'
-     */
-    memoryPerInstance: string;
-}
-export interface CloudRunProbeConfig {
-    /**
-     * Example: '/'
-     */
-    'httpGet.path': string;
-    'httpGet.port': PositiveInteger;
-    initialDelaySeconds: NumberOfSeconds;
-    failureThreshold: PositiveInteger;
-    timeoutSeconds: NumberOfSeconds;
-    periodSeconds: NumberOfSeconds;
-}
-export interface CloudRunEnv {
-    APP_ENV: string;
-    /**
-     * Example: '--max-old-space-size=864'
-     */
-    NODE_OPTIONS?: string;
-    /**
-     * Example: '2025-09-01T15:23:20.769Z'
-     * The result of running `new Date().toISOString()`
-     */
-    DEPLOY_BUILD_TIME: string;
-    /**
-     * Example: 'abcd'
-     * Should match the name of the GCP project.
-     */
-    GOOGLE_CLOUD_PROJECT: string;
-    /**
-     * Anything (a string) that would identify the build.
-     */
-    BUILD_VERSION: string;
-    /**
-     * External url of the deployed service.
-     */
-    K_EXTERNAL_URL?: string;
-    OTEL_SERVICE_NAME?: string;
-    OTEL_METRICS_EXPORTER?: 'console' | 'otlp' | string;
-    OTEL_METRIC_EXPORT_INTERVAL?: NumberOfMilliseconds;
-    OTEL_METRIC_EXPORT_TIMEOUT?: NumberOfMilliseconds;
-    OTEL_EXPORTER_OTLP_PROTOCOL?: 'http/protobuf' | string;
-    /**
-     * Example: 'http://localhost:4317'
-     */
-    OTEL_EXPORTER_OTLP_ENDPOINT?: string;
-    OTEL_LOG_LEVEL?: 'INFO' | 'DEBUG';
-}
-/**
- * @experimental
- */
-declare class CloudRunUtil {
-    /**
-     * Turns an object into a string representation where each
-     * key-value pair is represented as `key1=value1,key2=value2,...`.
-     */
-    stringifyObject(obj: AnyObject): string;
-    readonly defaultStartupProbeConfig: CloudRunProbeConfig;
-    readonly defaultLivenessProbeConfig: CloudRunProbeConfig;
-}
-export declare const cloudRunUtil: CloudRunUtil;
-export {};

package/dist/cloudrun/cloudRun.js

@@ -1,37 +0,0 @@
-import { _filterUndefinedValues } from '@naturalcycles/js-lib/object';
-/**
- * @experimental
- */
-class CloudRunUtil {
-    /**
-     * Turns an object into a string representation where each
-     * key-value pair is represented as `key1=value1,key2=value2,...`.
-     */
-    stringifyObject(obj) {
-        const filteredObj = _filterUndefinedValues(obj);
-        return Object.entries(filteredObj)
-            .map(([key, value]) => `${key}=${value}`)
-            .join(',');
-    }
-    defaultStartupProbeConfig = {
-        'httpGet.path': '/',
-        'httpGet.port': 8080,
-        initialDelaySeconds: 3,
-        failureThreshold: 50,
-        timeoutSeconds: 1,
-        periodSeconds: 2,
-    };
-    defaultLivenessProbeConfig = {
-        'httpGet.path': '/',
-        'httpGet.port': 8080,
-        // how long to wait before doing the first check, AFTER the startup probe has succeeded
-        initialDelaySeconds: 60,
-        // after how many failure it should kill/restart the container
-        failureThreshold: 5,
-        // how long to wait until liveness probe considers the endpoint unhealthy
-        timeoutSeconds: 30,
-        // check every periodSeconds
-        periodSeconds: 60,
-    };
-}
-export const cloudRunUtil = new CloudRunUtil();

package/src/cloudrun/cloudRun.ts

@@ -1,171 +0,0 @@
-import { _filterUndefinedValues } from '@naturalcycles/js-lib/object'
-import type {
-  AnyObject,
-  NonNegativeInteger,
-  NumberOfMilliseconds,
-  NumberOfSeconds,
-  PositiveInteger,
-  UnixTimestamp,
-} from '@naturalcycles/js-lib/types'
-
-export interface CloudRunConfig {
-  //
-  // GCP settings
-  //
-  gcpProject: string
-  /**
-   * Name of the Cloud Run service.
-   */
-  cloudRunService: string
-  cloudRunServiceBase?: string // todo: review
-  runtimeServiceAccount: string
-  /**
-   * GCP region where the Cloud Run service is deployed. Example: 'europe-west1'
-   */
-  cloudRunRegion: string
-  sqlInstance?: string
-  vpcConnector?: string
-  //
-  // Urls
-  //
-  serviceUrl?: string
-  /**
-   * Service URL that is used to access the service externally (through load balancer)
-   * todo: overlaps with env.K_EXTERNAL_URL
-   */
-  externalUrl?: string
-  //
-  // Versioning
-  //
-  buildVersion: string // todo: overlaps with env.BUILD_VERSION
-  /**
-   * Unix timestamp of the build/deployment time.
-   */
-  tsUnix: UnixTimestamp
-  //
-  // Docker
-  //
-  targetDockerImageId: string
-  dockerImageTag: string
-  //
-  // Git
-  //
-  /**
-   * Short SHA of the commit used for this deployment.
-   */
-  gitRev: string
-  gitBranch: string
-  //
-  // Cloud Run environment settings
-  //
-  /**
-   * Example: 'APP_ENV=prod,BUILD_VERSION=abcd,a=b'
-   */
-  envString: string
-  /**
-   * Example: httpGet.path='/',httpGet.port=8080,initialDelaySeconds=3,failureThreshold=50,timeoutSeconds=1,periodSeconds=2
-   */
-  startupProbeConfigString: string
-  livenessProbeConfigString?: string
-  minInstances: NonNegativeInteger
-  maxInstances: PositiveInteger
-  /**
-   * CloudRun concurrency setting.
-   * Example: 80
-   */
-  concurrency: PositiveInteger
-  /**
-   * Example: '512Mi'
-   */
-  memoryPerInstance: string
-}
-
-export interface CloudRunProbeConfig {
-  /**
-   * Example: '/'
-   */
-  'httpGet.path': string
-  'httpGet.port': PositiveInteger
-  initialDelaySeconds: NumberOfSeconds
-  failureThreshold: PositiveInteger
-  timeoutSeconds: NumberOfSeconds
-  periodSeconds: NumberOfSeconds
-}
-
-export interface CloudRunEnv {
-  APP_ENV: string
-  /**
-   * Example: '--max-old-space-size=864'
-   */
-  NODE_OPTIONS?: string
-  /**
-   * Example: '2025-09-01T15:23:20.769Z'
-   * The result of running `new Date().toISOString()`
-   */
-  DEPLOY_BUILD_TIME: string
-  /**
-   * Example: 'abcd'
-   * Should match the name of the GCP project.
-   */
-  GOOGLE_CLOUD_PROJECT: string
-  /**
-   * Anything (a string) that would identify the build.
-   */
-  BUILD_VERSION: string
-  /**
-   * External url of the deployed service.
-   */
-  K_EXTERNAL_URL?: string
-  // UV_THREADPOOL_SIZE?: number
-
-  OTEL_SERVICE_NAME?: string
-  OTEL_METRICS_EXPORTER?: 'console' | 'otlp' | string
-  OTEL_METRIC_EXPORT_INTERVAL?: NumberOfMilliseconds
-  OTEL_METRIC_EXPORT_TIMEOUT?: NumberOfMilliseconds
-  OTEL_EXPORTER_OTLP_PROTOCOL?: 'http/protobuf' | string
-  /**
-   * Example: 'http://localhost:4317'
-   */
-  OTEL_EXPORTER_OTLP_ENDPOINT?: string
-  OTEL_LOG_LEVEL?: 'INFO' | 'DEBUG'
-}
-
-/**
- * @experimental
- */
-class CloudRunUtil {
-  /**
-   * Turns an object into a string representation where each
-   * key-value pair is represented as `key1=value1,key2=value2,...`.
-   */
-  stringifyObject(obj: AnyObject): string {
-    const filteredObj = _filterUndefinedValues(obj)
-    return Object.entries(filteredObj)
-      .map(([key, value]) => `${key}=${value}`)
-      .join(',')
-  }
-
-  readonly defaultStartupProbeConfig: CloudRunProbeConfig = {
-    'httpGet.path': '/',
-    'httpGet.port': 8080,
-    initialDelaySeconds: 3,
-    failureThreshold: 50,
-    timeoutSeconds: 1,
-    periodSeconds: 2,
-  }
-
-  readonly defaultLivenessProbeConfig: CloudRunProbeConfig = {
-    'httpGet.path': '/',
-    'httpGet.port': 8080,
-    // how long to wait before doing the first check, AFTER the startup probe has succeeded
-    initialDelaySeconds: 60,
-    // after how many failure it should kill/restart the container
-    failureThreshold: 5,
-    // how long to wait until liveness probe considers the endpoint unhealthy
-    timeoutSeconds: 30,
-    // check every periodSeconds
-    periodSeconds: 60,
-  }
-}
-
-export const cloudRunUtil = new CloudRunUtil()