@naturalcycles/backend-lib 9.40.0 → 9.42.0

package/dist/deploy/deployHealthCheck.d.ts

@@ -9,6 +9,7 @@ export interface DeployHealthCheckOptions {
     gaeProject?: string;
     gaeService?: string;
     gaeVersion?: string;
+    authHeader?: string;
 }
 export declare const deployHealthCheckYargsOptions: {
     readonly thresholdHealthy: {
@@ -50,6 +51,9 @@ export declare const deployHealthCheckYargsOptions: {
     readonly gaeVersion: {
         readonly type: "string";
     };
+    readonly authHeader: {
+        readonly type: "string";
+    };
 };
 /**
  * Requires up to `healthyThreshold` consecutive OK responses to succeed.

package/dist/deploy/deployHealthCheck.js

@@ -1,7 +1,7 @@
 import { inspect } from 'node:util';
 import { _ms, _since } from '@naturalcycles/js-lib/datetime';
 import { getFetcher } from '@naturalcycles/js-lib/http';
-import { _filterFalsyValues } from '@naturalcycles/js-lib/object/object.util.js';
+import { _filterFalsyValues, _filterUndefinedValues, } from '@naturalcycles/js-lib/object/object.util.js';
 import { pDelay } from '@naturalcycles/js-lib/promise/pDelay.js';
 import { dimGrey, red } from '@naturalcycles/nodejs-lib/colors';
 import { exec2 } from '@naturalcycles/nodejs-lib/exec2';
@@ -46,6 +46,9 @@ export const deployHealthCheckYargsOptions = {
     gaeVersion: {
         type: 'string',
     },
+    authHeader: {
+        type: 'string',
+    },
 };
 const inspectOpt = {
     colors: true,
@@ -57,7 +60,7 @@ const inspectOpt = {
  * Fails after maxTries.
  */
 export async function deployHealthCheck(url, opt = {}) {
-    const { thresholdHealthy = 5, thresholdUnhealthy = 8, maxTries = 30, timeoutSec = 30, intervalSec = 1, logOnFailure, logOnSuccess, gaeProject, gaeService, gaeVersion, } = opt;
+    const { thresholdHealthy = 5, thresholdUnhealthy = 8, maxTries = 30, timeoutSec = 30, intervalSec = 1, logOnFailure, logOnSuccess, gaeProject, gaeService, gaeVersion, authHeader, } = opt;
     let attempt = 0;
     let countHealthy = 0;
     let countUnhealthy = 0;
@@ -89,7 +92,7 @@ export async function deployHealthCheck(url, opt = {}) {
         attempt++;
         console.log([`>>`, dimGrey(url), inspect({ attempt }, inspectOpt)].join(' '));
         const started = Date.now();
-        const { err, statusCode = 0 } = await fetcher.doFetch({
+        const { err, statusCode = 0 } = await fetcher.doFetch(_filterUndefinedValues({
             url,
             responseType: 'json',
             timeoutSeconds: timeoutSec,
@@ -97,7 +100,10 @@ export async function deployHealthCheck(url, opt = {}) {
                 count: 0,
             },
             redirect: 'error',
-        });
+            headers: {
+                Authorization: authHeader,
+            },
+        }));
         if (err) {
             console.log(err);
         }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@naturalcycles/backend-lib",
   "type": "module",
-  "version": "9.40.0",
+  "version": "9.42.0",
   "peerDependencies": {
     "@sentry/node": "^10"
   },
@@ -72,7 +72,7 @@
     "directory": "packages/backend-lib"
   },
   "engines": {
-    "node": ">=22.12.0"
+    "node": ">=24.10.0"
   },
   "description": "Standard library for making Express.js / AppEngine based backend services",
   "author": "Natural Cycles Team",

package/readme.md

@@ -9,10 +9,3 @@
 [![Actions](https://github.com/NaturalCycles/backend-lib/workflows/ci/badge.svg)](https://github.com/NaturalCycles/backend-lib/actions)
 
 # [Documentation](https://naturalcycles.github.io/backend-lib/)
-
-# Packaging
-
-- `engines.node`: latest Node.js LTS
-- `main: dist/index.js`: commonjs, es2020
-- `types: dist/index.d.ts`: typescript types
-- `/src` folder with source `*.ts` files included

package/src/deploy/deployHealthCheck.ts

@@ -2,7 +2,10 @@ import type { InspectOptions } from 'node:util'
 import { inspect } from 'node:util'
 import { _ms, _since } from '@naturalcycles/js-lib/datetime'
 import { getFetcher } from '@naturalcycles/js-lib/http'
-import { _filterFalsyValues } from '@naturalcycles/js-lib/object/object.util.js'
+import {
+  _filterFalsyValues,
+  _filterUndefinedValues,
+} from '@naturalcycles/js-lib/object/object.util.js'
 import { pDelay } from '@naturalcycles/js-lib/promise/pDelay.js'
 import type { UnixTimestampMillis } from '@naturalcycles/js-lib/types'
 import { dimGrey, red } from '@naturalcycles/nodejs-lib/colors'
@@ -20,6 +23,7 @@ export interface DeployHealthCheckOptions {
   gaeProject?: string
   gaeService?: string
   gaeVersion?: string
+  authHeader?: string
 }
 
 export const deployHealthCheckYargsOptions = {
@@ -62,6 +66,9 @@ export const deployHealthCheckYargsOptions = {
   gaeVersion: {
     type: 'string',
   },
+  authHeader: {
+    type: 'string',
+  },
 } as const
 
 const inspectOpt: InspectOptions = {
@@ -89,6 +96,7 @@ export async function deployHealthCheck(
     gaeProject,
     gaeService,
     gaeVersion,
+    authHeader,
   } = opt
 
   let attempt = 0
@@ -134,15 +142,20 @@ export async function deployHealthCheck(
 
     const started = Date.now() as UnixTimestampMillis
 
-    const { err, statusCode = 0 } = await fetcher.doFetch({
-      url,
-      responseType: 'json',
-      timeoutSeconds: timeoutSec,
-      retry: {
-        count: 0,
-      },
-      redirect: 'error',
-    })
+    const { err, statusCode = 0 } = await fetcher.doFetch(
+      _filterUndefinedValues({
+        url,
+        responseType: 'json',
+        timeoutSeconds: timeoutSec,
+        retry: {
+          count: 0,
+        },
+        redirect: 'error',
+        headers: {
+          Authorization: authHeader,
+        },
+      }),
+    )
 
     if (err) {
       console.log(err)