@naturalcycles/backend-lib 9.34.2 → 9.36.0

package/dist/admin/base.admin.service.js

@@ -40,7 +40,7 @@ export class BaseAdminService {
     /**
      * To be extended.
      */
-    // eslint-disable-next-line max-params
+    // oxlint-disable-next-line max-params
     async onPermissionCheck(req, email, reqPermissions, required, granted, meta = {}) {
         req.log(`${dimGrey(email)} ${required ? 'required' : 'optional'} permissions check [${dimGrey(reqPermissions.join(', '))}]: ${granted ? green('GRANTED') : red('DENIED')}`, meta);
     }

package/dist/cloudrun/cloudRun.d.ts

@@ -39,6 +39,7 @@ export interface CloudRunConfig {
      * Example: httpGet.path='/',httpGet.port=8080,initialDelaySeconds=3,failureThreshold=50,timeoutSeconds=1,periodSeconds=2
      */
     startupProbeConfigString: string;
+    livenessProbeConfigString?: string;
     minInstances: NonNegativeInteger;
     maxInstances: PositiveInteger;
     /**
@@ -51,7 +52,7 @@ export interface CloudRunConfig {
      */
     memoryPerInstance: string;
 }
-export interface CloudRunStartupProbeConfig {
+export interface CloudRunProbeConfig {
     /**
      * Example: '/'
      */
@@ -106,7 +107,8 @@ declare class CloudRunUtil {
      * key-value pair is represented as `key1=value1,key2=value2,...`.
      */
     stringifyObject(obj: AnyObject): string;
-    readonly defaultStartupProbeConfig: CloudRunStartupProbeConfig;
+    readonly defaultStartupProbeConfig: CloudRunProbeConfig;
+    readonly defaultLivenessProbeConfig: CloudRunProbeConfig;
 }
 export declare const cloudRunUtil: CloudRunUtil;
 export {};

package/dist/cloudrun/cloudRun.js

@@ -21,5 +21,17 @@ class CloudRunUtil {
         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/dist/deploy/deploy.util.js

@@ -110,7 +110,7 @@ export function createAppYaml(backendCfg, deployInfo, projectDir, appYamlPassEnv
     const passEnv = appYamlPassEnv
         .split(',')
         .filter(Boolean)
-        // eslint-disable-next-line unicorn/no-array-reduce
+        // oxlint-disable-next-line unicorn/no-array-reduce
         .reduce((map, key) => {
         const v = process.env[key];
         if (!v) {

package/dist/validation/ajv/ajvValidateRequest.d.ts

@@ -1,11 +1,10 @@
-import type { ZodType } from '@naturalcycles/js-lib/zod';
-import { AjvSchema, type AjvValidationError } from '@naturalcycles/nodejs-lib/ajv';
+import { type AjvValidationError, type SchemaHandledByAjv } from '@naturalcycles/nodejs-lib/ajv';
 import type { BackendRequest } from '../../server/server.model.js';
 import { type ReqValidationOptions } from '../validateRequest.util.js';
 declare class AjvValidateRequest {
-    body<T>(req: BackendRequest, schema: AjvSchema<T> | ZodType<T>, opt?: ReqValidationOptions<AjvValidationError>): T;
-    query<T>(req: BackendRequest, schema: AjvSchema<T> | ZodType<T>, opt?: ReqValidationOptions<AjvValidationError>): T;
-    params<T>(req: BackendRequest, schema: AjvSchema<T> | ZodType<T>, opt?: ReqValidationOptions<AjvValidationError>): T;
+    body<T>(req: BackendRequest, schema: SchemaHandledByAjv<T>, opt?: ReqValidationOptions<AjvValidationError>): T;
+    query<T>(req: BackendRequest, schema: SchemaHandledByAjv<T>, opt?: ReqValidationOptions<AjvValidationError>): T;
+    params<T>(req: BackendRequest, schema: SchemaHandledByAjv<T>, opt?: ReqValidationOptions<AjvValidationError>): T;
     /**
      * Does NOT mutate `req.headers`,
      * but returns validated/transformed headers.
@@ -14,7 +13,7 @@ declare class AjvValidateRequest {
      * We want to non-mutate the `req.headers`, because we anticipate that
      * there may be additional consumers for `req.headers` (e.g middlewares, etc).
      */
-    headers<T>(req: BackendRequest, schema: AjvSchema<T>, opt?: ReqValidationOptions<AjvValidationError>): T;
+    headers<T>(req: BackendRequest, schema: SchemaHandledByAjv<T>, opt?: ReqValidationOptions<AjvValidationError>): T;
     private validate;
 }
 export declare const ajvValidateRequest: AjvValidateRequest;

package/dist/validation/ajv/ajvValidateRequest.js

@@ -1,5 +1,5 @@
 import { _deepCopy } from '@naturalcycles/js-lib/object';
-import { AjvSchema } from '@naturalcycles/nodejs-lib/ajv';
+import { AjvSchema, } from '@naturalcycles/nodejs-lib/ajv';
 import { handleValidationError } from '../validateRequest.util.js';
 class AjvValidateRequest {
     body(req, schema, opt = {}) {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@naturalcycles/backend-lib",
   "type": "module",
-  "version": "9.34.2",
+  "version": "9.36.0",
   "peerDependencies": {
     "@sentry/node": "^10"
   },

package/src/admin/base.admin.service.ts

@@ -71,7 +71,7 @@ export class BaseAdminService {
   /**
    * To be extended.
    */
-  // eslint-disable-next-line max-params
+  // oxlint-disable-next-line max-params
   protected async onPermissionCheck(
     req: BackendRequest,
     email: string,

package/src/cloudrun/cloudRun.ts

@@ -66,6 +66,7 @@ export interface CloudRunConfig {
    * Example: httpGet.path='/',httpGet.port=8080,initialDelaySeconds=3,failureThreshold=50,timeoutSeconds=1,periodSeconds=2
    */
   startupProbeConfigString: string
+  livenessProbeConfigString?: string
   minInstances: NonNegativeInteger
   maxInstances: PositiveInteger
   /**
@@ -79,7 +80,7 @@ export interface CloudRunConfig {
   memoryPerInstance: string
 }
 
-export interface CloudRunStartupProbeConfig {
+export interface CloudRunProbeConfig {
   /**
    * Example: '/'
    */
@@ -144,7 +145,7 @@ class CloudRunUtil {
       .join(',')
   }
 
-  readonly defaultStartupProbeConfig: CloudRunStartupProbeConfig = {
+  readonly defaultStartupProbeConfig: CloudRunProbeConfig = {
     'httpGet.path': '/',
     'httpGet.port': 8080,
     initialDelaySeconds: 3,
@@ -152,6 +153,19 @@ class CloudRunUtil {
     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()

package/src/deploy/deploy.util.ts

@@ -161,7 +161,7 @@ export function createAppYaml(
   const passEnv = appYamlPassEnv
     .split(',')
     .filter(Boolean)
-    // eslint-disable-next-line unicorn/no-array-reduce
+    // oxlint-disable-next-line unicorn/no-array-reduce
     .reduce(
       (map, key) => {
         const v = process.env[key]

package/src/validation/ajv/ajvValidateRequest.ts

@@ -1,13 +1,16 @@
 import { _deepCopy } from '@naturalcycles/js-lib/object'
-import type { ZodType } from '@naturalcycles/js-lib/zod'
-import { AjvSchema, type AjvValidationError } from '@naturalcycles/nodejs-lib/ajv'
+import {
+  AjvSchema,
+  type AjvValidationError,
+  type SchemaHandledByAjv,
+} from '@naturalcycles/nodejs-lib/ajv'
 import type { BackendRequest } from '../../server/server.model.js'
 import { handleValidationError, type ReqValidationOptions } from '../validateRequest.util.js'
 
 class AjvValidateRequest {
   body<T>(
     req: BackendRequest,
-    schema: AjvSchema<T> | ZodType<T>,
+    schema: SchemaHandledByAjv<T>,
     opt: ReqValidationOptions<AjvValidationError> = {},
   ): T {
     return this.validate(req, 'body', schema, opt)
@@ -15,7 +18,7 @@ class AjvValidateRequest {
 
   query<T>(
     req: BackendRequest,
-    schema: AjvSchema<T> | ZodType<T>,
+    schema: SchemaHandledByAjv<T>,
     opt: ReqValidationOptions<AjvValidationError> = {},
   ): T {
     return this.validate(req, 'query', schema, opt)
@@ -23,7 +26,7 @@ class AjvValidateRequest {
 
   params<T>(
     req: BackendRequest,
-    schema: AjvSchema<T> | ZodType<T>,
+    schema: SchemaHandledByAjv<T>,
     opt: ReqValidationOptions<AjvValidationError> = {},
   ): T {
     return this.validate(req, 'params', schema, opt)
@@ -39,7 +42,7 @@ class AjvValidateRequest {
    */
   headers<T>(
     req: BackendRequest,
-    schema: AjvSchema<T>,
+    schema: SchemaHandledByAjv<T>,
     opt: ReqValidationOptions<AjvValidationError> = {},
   ): T {
     const originalHeaders = _deepCopy(req.headers)
@@ -51,7 +54,7 @@ class AjvValidateRequest {
   private validate<T>(
     req: BackendRequest,
     reqProperty: 'body' | 'params' | 'query' | 'headers',
-    schema: AjvSchema<T> | ZodType<T>,
+    schema: SchemaHandledByAjv<T>,
     opt: ReqValidationOptions<AjvValidationError> = {},
   ): T {
     const input: T = req[reqProperty] || {}