@naturalcycles/backend-lib 9.79.0 → 9.81.0

package/dist/deploy/deployHealthCheck.d.ts

@@ -4,11 +4,6 @@ export interface DeployHealthCheckOptions {
     maxTries?: number;
     timeoutSec?: number;
     intervalSec?: number;
-    logOnFailure?: boolean;
-    logOnSuccess?: boolean;
-    gaeProject?: string;
-    gaeService?: string;
-    gaeVersion?: string;
     authHeader?: string;
 }
 export declare const deployHealthCheckCliOptions: CliOptions;
@@ -16,5 +11,6 @@ export declare const deployHealthCheckCliOptions: CliOptions;
  * Requires up to `healthyThreshold` consecutive OK responses to succeed.
  * Fails on up to `unhealthyThreshold` consecutive FAIL responses.
  * Fails after maxTries.
+ * Throws on failure.
  */
 export declare function deployHealthCheck(url: string, opt?: DeployHealthCheckOptions): Promise<void>;

package/dist/deploy/deployHealthCheck.js

@@ -4,7 +4,6 @@ import { getFetcher } from '@naturalcycles/js-lib/http';
 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';
 import { coloredHttpCode } from '../server/request.log.util.js';
 export const deployHealthCheckCliOptions = {
     thresholdHealthy: {
@@ -27,25 +26,6 @@ export const deployHealthCheckCliOptions = {
         type: 'number',
         default: 1,
     },
-    logOnFailure: {
-        type: 'boolean',
-        default: true,
-        desc: 'Show server logs on health check failure (requires gaeProject, gaeService, gaeVersion)',
-    },
-    logOnSuccess: {
-        type: 'boolean',
-        default: false,
-        desc: 'Show server logs on health check success (requires gaeProject, gaeService, gaeVersion)',
-    },
-    gaeProject: {
-        type: 'string',
-    },
-    gaeService: {
-        type: 'string',
-    },
-    gaeVersion: {
-        type: 'string',
-    },
     authHeader: {
         type: 'string',
     },
@@ -58,9 +38,10 @@ const inspectOpt = {
  * Requires up to `healthyThreshold` consecutive OK responses to succeed.
  * Fails on up to `unhealthyThreshold` consecutive FAIL responses.
  * Fails after maxTries.
+ * Throws on failure.
  */
 export async function deployHealthCheck(url, opt = {}) {
-    const { thresholdHealthy = 5, thresholdUnhealthy = 8, maxTries = 30, timeoutSec = 30, intervalSec = 1, logOnFailure, logOnSuccess, gaeProject, gaeService, gaeVersion, authHeader, } = opt;
+    const { thresholdHealthy = 5, thresholdUnhealthy = 8, maxTries = 30, timeoutSec = 30, intervalSec = 1, authHeader, } = opt;
     let attempt = 0;
     let countHealthy = 0;
     let countUnhealthy = 0;
@@ -74,19 +55,7 @@ export async function deployHealthCheck(url, opt = {}) {
     }
     if (failed) {
         console.log(red(`Health check failed!`));
-        if (logOnFailure) {
-            try {
-                exec2.spawn(`gcloud app logs read --project ${gaeProject} --service ${gaeService} --version ${gaeVersion}`);
-            }
-            catch { }
-        }
-        process.exit(1);
-    }
-    if (logOnSuccess) {
-        try {
-            exec2.spawn(`gcloud app logs read --project ${gaeProject} --service ${gaeService} --version ${gaeVersion}`);
-        }
-        catch { }
+        throw new Error(`Health check failed: ${doneReason}`);
     }
     async function makeAttempt() {
         attempt++;

package/dist/deploy/index.d.ts

@@ -1,11 +1,4 @@
-import type { BackendCfg } from './backend.cfg.util.js';
-import { getBackendCfg } from './backend.cfg.util.js';
-import type { DeployInfo } from './deploy.model.js';
-import { createAppYaml, createDeployInfo } from './deploy.util.js';
-import { deployGae } from './deployGae.js';
 import type { DeployHealthCheckOptions } from './deployHealthCheck.js';
 import { deployHealthCheck } from './deployHealthCheck.js';
-import { deployPrepare } from './deployPrepare.js';
-export type { BackendCfg, DeployHealthCheckOptions, DeployInfo };
-export { createAppYaml, createDeployInfo, deployGae, deployHealthCheck, deployPrepare, getBackendCfg, };
-export * from './deployInfo.util.js';
+export type { DeployHealthCheckOptions };
+export { deployHealthCheck };

package/dist/deploy/index.js

@@ -1,7 +1,2 @@
-import { getBackendCfg } from './backend.cfg.util.js';
-import { createAppYaml, createDeployInfo } from './deploy.util.js';
-import { deployGae } from './deployGae.js';
 import { deployHealthCheck } from './deployHealthCheck.js';
-import { deployPrepare } from './deployPrepare.js';
-export { createAppYaml, createDeployInfo, deployGae, deployHealthCheck, deployPrepare, getBackendCfg, };
-export * from './deployInfo.util.js';
+export { deployHealthCheck };

package/dist/express/createDefaultApp.d.ts

@@ -32,4 +32,27 @@ export interface DefaultAppCfg {
     bodyParserRawOptions?: Options;
     corsOptions?: CorsOptions;
     genericErrorMwCfg?: GenericErrorMiddlewareCfg;
+    /**
+     * Value for Express `trust proxy` setting, which defines how `req.ip`, `req.ips`,
+     * `req.protocol` and `req.hostname` are resolved from `X-Forwarded-*` headers.
+     *
+     * Defaults to `2` - trust exactly 2 hops: the socket peer (Google Front End) and the
+     * rightmost `X-Forwarded-For` entry (appended by the Google Cloud Load Balancer).
+     * This is the setup of Cloud Run behind a Load Balancer.
+     * Any further entries to the left could be injected by the client, so they are not trusted,
+     * which prevents IP address spoofing via `X-Forwarded-For` header.
+     *
+     * Do NOT set it to `true` in production - it trusts the leftmost `X-Forwarded-For` entry,
+     * which is fully client-controlled.
+     *
+     * Adjust it to match the hosting environment (number of proxies in front of the app).
+     *
+     * @default 2
+     */
+    trustProxy?: TrustProxy;
 }
+/**
+ * Accepted values of Express `trust proxy` setting.
+ * See https://expressjs.com/en/guide/behind-proxies.html
+ */
+export type TrustProxy = boolean | number | string | string[] | ((ip: string | undefined, hopIndex: number) => boolean);

package/dist/express/createDefaultApp.js

@@ -5,9 +5,10 @@ import { logMiddleware } from '../server/logMiddleware.js';
 import { notFoundMiddleware } from '../server/notFoundMiddleware.js';
 import { requestTimeoutMiddleware } from '../server/requestTimeoutMiddleware.js';
 import { simpleRequestLoggerMiddleware } from '../server/simpleRequestLoggerMiddleware.js';
-import { isGAE } from '../util.js';
+import { isCloudRun } from '../util.js';
 const isTest = process.env['APP_ENV'] === 'test';
 const isDev = process.env['APP_ENV'] === 'dev';
+const isGAE = !!process.env['GAE_INSTANCE'];
 export async function createDefaultApp(cfg) {
     const { sentryService } = cfg;
     const { default: express } = await import('express');
@@ -16,7 +17,7 @@ export async function createDefaultApp(cfg) {
     const app = express();
     app.disable('etag');
     app.disable('x-powered-by');
-    app.set('trust proxy', true);
+    app.set('trust proxy', cfg.trustProxy ?? 2);
     // preHandlers
     useHandlers(app, cfg.preHandlers);
     app.use(logMiddleware());
@@ -43,8 +44,9 @@ export async function createDefaultApp(cfg) {
         maxAge: 86400,
         ...cfg.corsOptions,
     }));
-    if (!isGAE() && isTest) {
+    if (!isGAE && (isTest || isCloudRun())) {
         // compression is not used in AppEngine, because AppEngine provides it by default
+        // Cloud Run doesn't compress responses, so we do it ourselves
         app.use(compressionMiddleware());
     }
     // app.use(safeJsonMiddleware()) // optional

package/dist/server/serverStatusMiddleware.d.ts

@@ -1,3 +1,3 @@
 import type { BackendRequestHandler } from './server.model.js';
-export declare function serverStatusMiddleware(projectDir?: string, extra?: any): BackendRequestHandler;
-export declare function getServerStatusData(projectDir?: string, extra?: any): Record<string, any>;
+export declare function serverStatusMiddleware(extra?: any): BackendRequestHandler;
+export declare function getServerStatusData(extra?: any): Record<string, any>;

package/dist/server/serverStatusMiddleware.js

@@ -2,31 +2,22 @@ import os from 'node:os';
 import { localTime } from '@naturalcycles/js-lib/datetime/localTime.js';
 import { _filterNullishValues } from '@naturalcycles/js-lib/object/object.util.js';
 import { memoryUsageFull, processSharedUtil } from '@naturalcycles/nodejs-lib';
-import { getDeployInfo } from '../deploy/deployInfo.util.js';
 const { versions, arch, platform } = process;
 const availableParallelismAtStart = os.availableParallelism();
-const { GAE_APPLICATION, GAE_SERVICE, GAE_VERSION, GOOGLE_CLOUD_PROJECT, K_SERVICE, K_REVISION, APP_ENV, NODE_ENV, NODE_OPTIONS, UV_THREADPOOL_SIZE, MALLOC_ARENA_MAX, DEPLOY_BUILD_TIME, BUILD_VERSION, } = process.env;
-export function serverStatusMiddleware(projectDir, extra) {
+const { GOOGLE_CLOUD_PROJECT, K_SERVICE, K_REVISION, APP_ENV, NODE_ENV, NODE_OPTIONS, UV_THREADPOOL_SIZE, MALLOC_ARENA_MAX, DEPLOY_BUILD_TIME, BUILD_VERSION, } = process.env;
+export function serverStatusMiddleware(extra) {
     return async (_req, res) => {
-        res.json(getServerStatusData(projectDir, extra));
+        res.json(getServerStatusData(extra));
     };
 }
-export function getServerStatusData(projectDir = process.cwd(), extra) {
-    let deployBuildTime = DEPLOY_BUILD_TIME;
-    if (!deployBuildTime) {
-        const { ts } = getDeployInfo(projectDir);
-        deployBuildTime = localTime(ts).toPretty();
-    }
+export function getServerStatusData(extra) {
     const availableParallelism = os.availableParallelism();
     return _filterNullishValues({
         nodeProcessStarted: getStartedStr(),
-        deployBuildTime,
+        DEPLOY_BUILD_TIME,
         BUILD_VERSION,
         APP_ENV,
         GOOGLE_CLOUD_PROJECT,
-        GAE_APPLICATION,
-        GAE_SERVICE,
-        GAE_VERSION,
         K_SERVICE,
         K_REVISION,
         processInfo: {

package/dist/util.d.ts

@@ -1,2 +1 @@
-export declare function isGAE(): boolean;
 export declare function isCloudRun(): boolean;

package/dist/util.js

@@ -1,7 +1,4 @@
-const { GAE_INSTANCE, K_SERVICE } = process.env;
-export function isGAE() {
-    return !!GAE_INSTANCE;
-}
+const { K_SERVICE } = process.env;
 export function isCloudRun() {
     return !!K_SERVICE;
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@naturalcycles/backend-lib",
   "type": "module",
-  "version": "9.79.0",
+  "version": "9.81.0",
   "dependencies": {
     "@naturalcycles/db-lib": "^10",
     "@naturalcycles/js-lib": "^15",
@@ -20,8 +20,7 @@
   },
   "peerDependencies": {
     "@sentry/node-core": "^10",
-    "firebase-admin": "^14",
-    "simple-git": "^4"
+    "firebase-admin": "^14"
   },
   "peerDependenciesMeta": {
     "@sentry/node-core": {
@@ -29,9 +28,6 @@
     },
     "firebase-admin": {
       "optional": true
-    },
-    "simple-git": {
-      "optional": true
     }
   },
   "devDependencies": {
@@ -68,9 +64,6 @@
     "!src/**/__exclude"
   ],
   "bin": {
-    "deploy-gae": "bin/deploy-gae.js",
-    "undeploy-gae": "bin/undeploy-gae.js",
-    "deploy-prepare": "bin/deploy-prepare.js",
     "deploy-health-check": "bin/deploy-health-check.js"
   },
   "types": "dist/index.d.ts",
@@ -85,7 +78,7 @@
   "engines": {
     "node": ">=24.10.0"
   },
-  "description": "Standard library for making Express.js / AppEngine based backend services",
+  "description": "Standard library for making Express.js based backend services",
   "author": "Natural Cycles Team",
   "license": "MIT",
   "scripts": {
@@ -97,9 +90,6 @@
     "check": "dev-lib check",
     "typecheck": "dev-lib typecheck",
     "dev": "APP_ENV=dev tsx watch src/test/server/server.ts",
-    "deploy-gae": "tsx src/bin/deploy-gae.ts",
-    "deploy-prepare": "tsx src/bin/deploy-prepare.ts",
-    "deploy-prepare-debug": "AA=AA1 BB=BB1 tsx src/bin/deploy-prepare.ts --projectDir ./src/test/project",
     "deploy-health-check-debug1": "tsx src/bin/deploy-health-check.ts --url https://api-master.naturalcycles.com",
     "deploy-health-check-debug2": "tsx src/bin/deploy-health-check.ts --url https://api-master2.naturalcycles.com --thresholdUnhealthy 5"
   }

package/src/admin/login.html

@@ -6,38 +6,59 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no" />
 
-    <!-- CSS only -->
-    <link
-      href="https://cdn.jsdelivr.net/npm/bootstrap@5.1.2/dist/css/bootstrap.min.css"
-      rel="stylesheet"
-      crossorigin="anonymous"
-    />
+    <style>
+      body {
+        max-width: 45rem;
+        margin: 0 auto;
+        padding: 40px 1rem;
+        font-family: system-ui, sans-serif;
+        font-size: 1.15rem;
+        line-height: 1.5;
+      }
+      pre {
+        padding: 1rem 1.4rem;
+        overflow-x: auto;
+        background: #f5f7ff;
+        border: 1px solid #ccc;
+        border-radius: 5px;
+      }
+      button {
+        padding: 1rem 1.4rem;
+        font-size: 1.5rem;
+        color: #fff;
+        cursor: pointer;
+        background: #0d47a1;
+        border: none;
+        border-radius: 5px;
+      }
+      button:hover {
+        opacity: 0.8;
+      }
+    </style>
   </head>
   <body>
-    <div id="app" style="padding: 40px 50px">
-      <pre v-if="loading">Checking login...</pre>
-      <div v-else>
-        <div v-if="user">
-          <p>Logged in as:</p>
-          <pre><mark>{{ user.email }}</mark></pre>
-          <pre><mark>{{ user.token }}</mark></pre>
-          <button class="btn btn-primary btn-lg" @click="logout">Logout</button>
-        </div>
-        <div v-else>
-          <button class="btn btn-primary btn-lg" @click="login" id="loginBtn">Login</button>
-        </div>
-      </div>
+    <pre id="loading">Checking login...</pre>
+
+    <div id="loggedIn" hidden>
+      <p>Logged in as:</p>
+      <pre><code id="email"></code></pre>
+      <pre><code id="token"></code></pre>
+      <button id="logoutButton">Logout</button>
+    </div>
+
+    <div id="loggedOut" hidden>
+      <button id="loginBtn">Login</button>
     </div>
 
     <script type="module">
-      import { createApp } from 'https://cdn.jsdelivr.net/npm/vue@3.2.20/dist/vue.esm-browser.prod.js'
-      import { initializeApp } from 'https://www.gstatic.com/firebasejs/9.1.2/firebase-app.js'
+      import { initializeApp } from 'https://www.gstatic.com/firebasejs/13.1.0/firebase-app.js'
       import {
         getAuth,
         GoogleAuthProvider,
         onAuthStateChanged,
         signInWithRedirect,
-      } from 'https://www.gstatic.com/firebasejs/9.1.2/firebase-auth.js'
+        signOut,
+      } from 'https://www.gstatic.com/firebasejs/13.1.0/firebase-auth.js'
 
       const apiKey = '<%= firebaseApiKey %>'
       const authDomain = '<%= firebaseAuthDomain %>'
@@ -47,84 +68,59 @@
         alert(`Error: 'apiKey' or 'authDomain' is missing!`)
       }
 
-      // Initialize Firebase
-      initializeApp({
-        apiKey,
-        authDomain,
-      })
-
-      const auth = getAuth()
-      const provider = new GoogleAuthProvider()
-
-      onAuthStateChanged(auth, user => {
-        // console.log('onAuthStateChanged, user: ', JSON.stringify(user, null, 2))
-        // console.log('onAuthStateChanged, user: ', user)
-        onUser(user)
-      })
-
       const qs = Object.fromEntries(new URLSearchParams(location.search))
-      const { autoLogin, logout, adminTokenKey = 'admin_token' } = qs
+      const { autoLogin, adminTokenKey = 'admin_token' } = qs
       const returnUrl = toSafeReturnUrl(qs.returnUrl)
       // console.log(qs)
 
-      const app = createApp({
-        data() {
-          return {
-            loading: 'Loading...',
-            user: undefined,
-          }
-        },
-        methods: {
-          login: async function () {
-            try {
-              await signInWithRedirect(auth, provider)
-            } catch (err) {
-              logError(err)
-            }
-          },
+      // Initialize Firebase
+      const auth = getAuth(
+        initializeApp({
+          apiKey,
+          authDomain,
+        }),
+      )
+      const provider = new GoogleAuthProvider()
 
-          logout: async function () {
-            try {
-              await auth.signOut()
+      const el = {
+        loading: document.getElementById('loading'),
+        loggedIn: document.getElementById('loggedIn'),
+        loggedOut: document.getElementById('loggedOut'),
+        email: document.getElementById('email'),
+        token: document.getElementById('token'),
+      }
 
-              await postToken('logout') // magic string
+      document.getElementById('loginBtn').addEventListener('click', login)
+      document.getElementById('logoutButton').addEventListener('click', logout)
 
-              if (logout && returnUrl) {
-                alert('Logged out, redurecting back...')
-                location.href = returnUrl
-              }
-            } catch (err) {
-              logError(err)
-            }
-          },
-        },
-      }).mount('#app')
+      onAuthStateChanged(auth, user => {
+        // console.log('onAuthStateChanged, user: ', JSON.stringify(user, null, 2))
+        // console.log('onAuthStateChanged, user: ', user)
+        void onUser(user)
+      })
 
-      if (logout) app.logout()
+      if (qs.logout) void logout()
 
       ////
 
       async function onUser(user) {
         try {
           // alert('onUser')
-          app.user = user
-          app.loading = false
+          render(user)
           if (!user) {
-            if (autoLogin) app.login()
+            if (autoLogin) void login()
           } else {
-            const token = await auth.currentUser.getIdToken()
+            const token = await user.getIdToken()
 
             // alert('idToken')
             // console.log(idToken)
-            app.user = Object.assign({}, app.user, {
-              token,
-            })
+            render(user, token)
 
             await postToken(token)
 
             // Redirect if needed
             if (returnUrl) {
-              // alert(`Logged in as ${app.user.email}, redirecting back...`)
+              // alert(`Logged in as ${user.email}, redirecting back...`)
               location.href = returnUrl
             }
           }
@@ -133,6 +129,37 @@
         }
       }
 
+      function render(user, token = '') {
+        el.loading.hidden = true
+        el.loggedIn.hidden = !user
+        el.loggedOut.hidden = !!user
+        el.email.textContent = user?.email || ''
+        el.token.textContent = token
+      }
+
+      async function login() {
+        try {
+          await signInWithRedirect(auth, provider)
+        } catch (err) {
+          logError(err)
+        }
+      }
+
+      async function logout() {
+        try {
+          await signOut(auth)
+
+          await postToken('logout') // magic string
+
+          if (qs.logout && returnUrl) {
+            alert('Logged out, redirecting back...')
+            location.href = returnUrl
+          }
+        } catch (err) {
+          logError(err)
+        }
+      }
+
       function logError(err) {
         console.error(err)
         alert('Error\n ' + JSON.stringify(err, null, 2))

package/src/deploy/deployHealthCheck.ts

@@ -10,7 +10,6 @@ import { pDelay } from '@naturalcycles/js-lib/promise/pDelay.js'
 import type { UnixTimestampMillis } from '@naturalcycles/js-lib/types'
 import type { CliOptions } from '@naturalcycles/nodejs-lib/args'
 import { dimGrey, red } from '@naturalcycles/nodejs-lib/colors'
-import { exec2 } from '@naturalcycles/nodejs-lib/exec2'
 import { coloredHttpCode } from '../server/request.log.util.js'
 
 export interface DeployHealthCheckOptions {
@@ -19,11 +18,6 @@ export interface DeployHealthCheckOptions {
   maxTries?: number
   timeoutSec?: number
   intervalSec?: number
-  logOnFailure?: boolean
-  logOnSuccess?: boolean
-  gaeProject?: string
-  gaeService?: string
-  gaeVersion?: string
   authHeader?: string
 }
 
@@ -48,25 +42,6 @@ export const deployHealthCheckCliOptions = {
     type: 'number',
     default: 1,
   },
-  logOnFailure: {
-    type: 'boolean',
-    default: true,
-    desc: 'Show server logs on health check failure (requires gaeProject, gaeService, gaeVersion)',
-  },
-  logOnSuccess: {
-    type: 'boolean',
-    default: false,
-    desc: 'Show server logs on health check success (requires gaeProject, gaeService, gaeVersion)',
-  },
-  gaeProject: {
-    type: 'string',
-  },
-  gaeService: {
-    type: 'string',
-  },
-  gaeVersion: {
-    type: 'string',
-  },
   authHeader: {
     type: 'string',
   },
@@ -81,6 +56,7 @@ const inspectOpt: InspectOptions = {
  * Requires up to `healthyThreshold` consecutive OK responses to succeed.
  * Fails on up to `unhealthyThreshold` consecutive FAIL responses.
  * Fails after maxTries.
+ * Throws on failure.
  */
 export async function deployHealthCheck(
   url: string,
@@ -92,11 +68,6 @@ export async function deployHealthCheck(
     maxTries = 30,
     timeoutSec = 30,
     intervalSec = 1,
-    logOnFailure,
-    logOnSuccess,
-    gaeProject,
-    gaeService,
-    gaeVersion,
     authHeader,
   } = opt
 
@@ -116,24 +87,7 @@ export async function deployHealthCheck(
 
   if (failed) {
     console.log(red(`Health check failed!`))
-
-    if (logOnFailure) {
-      try {
-        exec2.spawn(
-          `gcloud app logs read --project ${gaeProject} --service ${gaeService} --version ${gaeVersion}`,
-        )
-      } catch {}
-    }
-
-    process.exit(1)
-  }
-
-  if (logOnSuccess) {
-    try {
-      exec2.spawn(
-        `gcloud app logs read --project ${gaeProject} --service ${gaeService} --version ${gaeVersion}`,
-      )
-    } catch {}
+    throw new Error(`Health check failed: ${doneReason}`)
   }
 
   async function makeAttempt(): Promise<void> {

package/src/deploy/index.ts

@@ -1,21 +1,6 @@
-import type { BackendCfg } from './backend.cfg.util.js'
-import { getBackendCfg } from './backend.cfg.util.js'
-import type { DeployInfo } from './deploy.model.js'
-import { createAppYaml, createDeployInfo } from './deploy.util.js'
-import { deployGae } from './deployGae.js'
 import type { DeployHealthCheckOptions } from './deployHealthCheck.js'
 import { deployHealthCheck } from './deployHealthCheck.js'
-import { deployPrepare } from './deployPrepare.js'
 
-export type { BackendCfg, DeployHealthCheckOptions, DeployInfo }
+export type { DeployHealthCheckOptions }
 
-export {
-  createAppYaml,
-  createDeployInfo,
-  deployGae,
-  deployHealthCheck,
-  deployPrepare,
-  getBackendCfg,
-}
-
-export * from './deployInfo.util.js'
+export { deployHealthCheck }