@naturalcycles/backend-lib 4.23.3 → 5.0.0

package/dist/admin/adminMiddleware.js

@@ -2,8 +2,8 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getLoginHtmlRedirect = exports.loginHtml = exports.requireAdminPermissions = exports.createAdminMiddleware = void 0;
 const tslib_1 = require("tslib");
-const node_fs_1 = tslib_1.__importDefault(require("node:fs"));
 const js_lib_1 = require("@naturalcycles/js-lib");
+const nodejs_lib_1 = require("@naturalcycles/nodejs-lib");
 const ejs_1 = tslib_1.__importDefault(require("ejs"));
 function createAdminMiddleware(adminService, cfgDefaults = {}) {
     return (reqPermissions, cfg) => requireAdminPermissions(adminService, reqPermissions, {
@@ -53,7 +53,7 @@ function loginHtml(firebaseServiceCfg) {
 exports.loginHtml = loginHtml;
 const getLoginHtml = (0, js_lib_1._memoFn)((cfg) => {
     console.log(`reading login.html`);
-    const tmpl = node_fs_1.default.readFileSync(`${__dirname}/login.html`, 'utf8');
+    const tmpl = nodejs_lib_1.fs2.readText(`${__dirname}/login.html`);
     return ejs_1.default.render(tmpl, cfg);
 });
 function getLoginHtmlRedirect(href) {

package/dist/db/httpDB.d.ts

@@ -20,7 +20,7 @@ export declare class HttpDB extends BaseCommonDB implements CommonDB {
     getByIds<ROW extends ObjectWithId>(table: string, ids: ROW['id'][], opt?: CommonDBOptions): Promise<ROW[]>;
     runQuery<ROW extends ObjectWithId>(query: DBQuery<ROW>, opt?: CommonDBOptions): Promise<RunQueryResult<ROW>>;
     runQueryCount<ROW extends ObjectWithId>(query: DBQuery<ROW>, opt?: CommonDBOptions): Promise<number>;
-    saveBatch<ROW extends Partial<ObjectWithId>>(table: string, rows: ROW[], opt?: CommonDBSaveOptions<ROW>): Promise<void>;
+    saveBatch<ROW extends ObjectWithId>(table: string, rows: ROW[], opt?: CommonDBSaveOptions<ROW>): Promise<void>;
     deleteByIds(table: string, ids: string[], opt?: CommonDBOptions): Promise<number>;
     deleteByQuery<ROW extends ObjectWithId>(query: DBQuery<ROW>, opt?: CommonDBOptions): Promise<number>;
     streamQuery<ROW extends ObjectWithId>(_q: DBQuery<ROW>, _opt?: CommonDBStreamOptions): ReadableTyped<ROW>;

package/dist/db/httpDBRequestHandler.d.ts

@@ -15,7 +15,7 @@ export interface RunQueryInput {
 export interface SaveBatchInput {
     table: string;
     rows: ObjectWithId[];
-    opt?: CommonDBSaveOptions;
+    opt?: CommonDBSaveOptions<any>;
 }
 /**
  * Exposes CommonDB interface from provided CommonDB as HTTP endpoint (Express RequestHandler).

package/dist/deploy/backend.cfg.util.d.ts

@@ -7,19 +7,6 @@ export interface BackendCfg {
      */
     gaeService: string;
     gaeServiceByBranch?: StringMap;
-    /**
-     * @default true
-     *
-     * If true - service name will look like ${branchName}--${gaeService}, similar to Netlify.
-     * If false - ${gaeService}.
-     *
-     * Prod branch NEVER includes branchName in service name.
-     */
-    serviceWithBranchName?: boolean;
-    /**
-     * @example prod
-     */
-    prodBranch: string;
     /**
      * List of file patterns to include in deployment.
      */

package/dist/deploy/backend.cfg.util.js

@@ -10,7 +10,6 @@ function getBackendCfg(projectDir = '.') {
     const backendCfgYamlPath = `${projectDir}/backend.cfg.yaml`;
     (0, nodejs_lib_1.requireFileToExist)(backendCfgYamlPath);
     const backendCfg = {
-        serviceWithBranchName: true,
         ...nodejs_lib_1.fs2.readYaml(backendCfgYamlPath),
     };
     backendCfgSchema.validate(backendCfg);

package/dist/deploy/deploy.model.d.ts

@@ -7,7 +7,6 @@ export interface DeployInfo {
     serviceUrl: string;
     gitRev: string;
     gitBranch: string;
-    prod: boolean;
     /**
      * Unix timestamp of deployInfo.json being generated.
      */

package/dist/deploy/deploy.util.js

@@ -1,11 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.validateGAEServiceName = exports.createAppYaml = exports.createAndSaveAppYaml = exports.createDeployInfo = exports.createAndSaveDeployInfo = void 0;
-const tslib_1 = require("tslib");
-const node_fs_1 = tslib_1.__importDefault(require("node:fs"));
 const js_lib_1 = require("@naturalcycles/js-lib");
 const nodejs_lib_1 = require("@naturalcycles/nodejs-lib");
-const js_yaml_1 = tslib_1.__importDefault(require("js-yaml"));
 const APP_YAML_DEFAULT = () => ({
     runtime: 'nodejs20',
     service: 'default',
@@ -27,7 +24,7 @@ const APP_YAML_DEFAULT = () => ({
 async function createAndSaveDeployInfo(backendCfg, targetDir) {
     const deployInfo = await createDeployInfo(backendCfg);
     const deployInfoPath = `${targetDir}/deployInfo.json`;
-    node_fs_1.default.writeFileSync(deployInfoPath, JSON.stringify(deployInfo, null, 2));
+    nodejs_lib_1.fs2.writeJson(deployInfoPath, deployInfo, { spaces: 2 });
     console.log(`saved ${(0, nodejs_lib_1.dimGrey)(deployInfoPath)}`);
     return deployInfo;
 }
@@ -38,11 +35,12 @@ async function createDeployInfo(backendCfg, overrideBranch) {
     const now = (0, js_lib_1.localTimeNow)();
     const gitBranch = overrideBranch || (await git.status()).current;
     const gitRev = (await git.revparse(['HEAD'])).slice(0, 7);
-    let { gaeProject, gaeProjectByBranch = {}, gaeService, gaeServiceByBranch = {}, serviceWithBranchName, prodBranch, branchesWithTimestampVersions = [], } = backendCfg;
+    let { gaeProject, gaeProjectByBranch = {}, gaeService, gaeServiceByBranch = {}, branchesWithTimestampVersions = [], } = backendCfg;
     gaeProject = gaeProjectByBranch[gitBranch] || gaeProject;
-    gaeService = validateGAEServiceName(gaeServiceByBranch[gitBranch] || gaeService);
-    const prod = gitBranch === prodBranch;
-    if (!prod && serviceWithBranchName && !gaeServiceByBranch[gitBranch]) {
+    if (gaeServiceByBranch[gitBranch]) {
+        gaeService = validateGAEServiceName(gaeServiceByBranch[gitBranch]);
+    }
+    else {
         gaeService = validateGAEServiceName([gitBranch, gaeService].join('--'));
     }
     let gaeVersion = '1';
@@ -67,7 +65,6 @@ async function createDeployInfo(backendCfg, overrideBranch) {
         serviceUrl,
         gitBranch,
         gitRev,
-        prod,
         ts: now.unix(),
     };
     console.log({ deployInfo });
@@ -77,7 +74,7 @@ exports.createDeployInfo = createDeployInfo;
 function createAndSaveAppYaml(backendCfg, deployInfo, projectDir, targetDir, appYamlPassEnv = '') {
     const appYaml = createAppYaml(backendCfg, deployInfo, projectDir, appYamlPassEnv);
     const appYamlPath = `${targetDir}/app.yaml`;
-    node_fs_1.default.writeFileSync(appYamlPath, js_yaml_1.default.dump(appYaml));
+    nodejs_lib_1.fs2.writeYaml(appYamlPath, appYaml);
     console.log(`saved ${(0, nodejs_lib_1.dimGrey)(appYamlPath)}`);
     return appYaml;
 }
@@ -93,14 +90,14 @@ function createAppYaml(backendCfg, deployInfo, projectDir, appYamlPassEnv = '')
     const appYaml = APP_YAML_DEFAULT();
     // Check existing app.yaml
     const appYamlPath = `${projectDir}/app.yaml`;
-    if (node_fs_1.default.existsSync(appYamlPath)) {
+    if (nodejs_lib_1.fs2.pathExists(appYamlPath)) {
         console.log(`merging-in ${(0, nodejs_lib_1.dimGrey)(appYamlPath)}`);
-        (0, js_lib_1._merge)(appYaml, js_yaml_1.default.load(node_fs_1.default.readFileSync(appYamlPath, 'utf8')));
+        (0, js_lib_1._merge)(appYaml, nodejs_lib_1.fs2.readYaml(appYamlPath));
     }
     const appEnvYamlPath = `${projectDir}/app.${APP_ENV}.yaml`;
-    if (node_fs_1.default.existsSync(appEnvYamlPath)) {
+    if (nodejs_lib_1.fs2.pathExists(appEnvYamlPath)) {
         console.log(`merging-in ${(0, nodejs_lib_1.dimGrey)(appEnvYamlPath)}`);
-        (0, js_lib_1._merge)(appYaml, js_yaml_1.default.load(node_fs_1.default.readFileSync(appEnvYamlPath, 'utf8')));
+        (0, js_lib_1._merge)(appYaml, nodejs_lib_1.fs2.readYaml(appEnvYamlPath));
     }
     // appYamlPassEnv
     require('dotenv').config(); // ensure .env is read

package/dist/deploy/deployGae.js

@@ -66,11 +66,11 @@ exports.deployGae = deployGae;
 async function undeployGae(branch) {
     const projectDir = '.';
     const backendCfg = (0, backend_cfg_util_1.getBackendCfg)(projectDir);
-    const { gaeProject, gaeService, gaeVersion, prod } = await (0, deploy_util_1.createDeployInfo)(backendCfg, branch);
-    if (prod) {
-        console.log(`undeployGae (branch: ${branch}): not removing prod version (safety check)`);
-        return;
-    }
+    const { gaeProject, gaeService, gaeVersion } = await (0, deploy_util_1.createDeployInfo)(backendCfg, branch);
+    // if (prod) {
+    //   console.log(`undeployGae (branch: ${branch}): not removing prod version (safety check)`)
+    //   return
+    // }
     console.log(`undeployGae (branch: ${branch}): going to remove ${gaeProject}/${gaeService}/${gaeVersion}`);
     (0, nodejs_lib_1.execVoidCommandSync)(`gcloud app versions delete --project ${gaeProject} --service ${gaeService} ${gaeVersion} --quiet`, [], { shell: true });
 }

package/dist/server/deployInfo.util.js

@@ -1,13 +1,12 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getDeployInfo = void 0;
-const tslib_1 = require("tslib");
-const node_fs_1 = tslib_1.__importDefault(require("node:fs"));
 const js_lib_1 = require("@naturalcycles/js-lib");
+const nodejs_lib_1 = require("@naturalcycles/nodejs-lib");
 exports.getDeployInfo = (0, js_lib_1._memoFn)((projectDir) => {
     const deployInfoPath = `${projectDir}/deployInfo.json`;
     try {
-        return JSON.parse(node_fs_1.default.readFileSync(deployInfoPath, 'utf8'));
+        return nodejs_lib_1.fs2.readJson(deployInfoPath);
     }
     catch {
         // console.error(`cannot read ${deployInfoPath}, returning empty version`)
@@ -23,7 +22,6 @@ function getDeployInfoStub(stub = '') {
         versionUrl: stub,
         gitBranch: stub,
         gitRev: stub,
-        prod: false,
         ts: Math.floor(Date.now() / 1000),
     };
 }

package/dist/server/serverStatusMiddleware.js

@@ -13,7 +13,7 @@ function serverStatusMiddleware(projectDir, extra) {
 }
 exports.serverStatusMiddleware = serverStatusMiddleware;
 function getServerStatusData(projectDir = process.cwd(), extra) {
-    const { gitRev, gitBranch, prod, ts } = (0, deployInfo_util_1.getDeployInfo)(projectDir);
+    const { gitRev, gitBranch, ts } = (0, deployInfo_util_1.getDeployInfo)(projectDir);
     const t = (0, js_lib_1.localTime)(ts);
     const deployBuildTime = t.toPretty();
     const buildInfo = [t.toStringCompact(), gitBranch, gitRev].filter(Boolean).join('_');
@@ -21,7 +21,6 @@ function getServerStatusData(projectDir = process.cwd(), extra) {
         started: getStartedStr(),
         deployBuildTime,
         APP_ENV,
-        prod,
         buildInfo,
         GAE_APPLICATION,
         GAE_SERVICE,

package/package.json

@@ -1,9 +1,9 @@
 {
   "name": "@naturalcycles/backend-lib",
-  "version": "4.23.3",
+  "version": "5.0.0",
   "scripts": {
-    "prepare": "husky install",
-    "serve": "APP_ENV=dev nodemon",
+    "prepare": "husky",
+    "dev": "APP_ENV=dev nodemon",
     "docs-serve": "NODE_OPTIONS=--openssl-legacy-provider vuepress dev docs",
     "docs-build": "NODE_OPTIONS=--openssl-legacy-provider vuepress build docs",
     "deploy-gae": "yarn tsn ./src/bin/deploy-gae.ts",

package/resources/backendCfg.schema.json

@@ -17,8 +17,6 @@
         ".*": { "type": "string" }
       }
     },
-    "serviceWithBranchName": { "type": "boolean", "default": true },
-    "prodBranch": { "type": "string" },
     "files": {
       "type": "array",
       "items": { "type": "string" }

package/src/admin/adminMiddleware.ts

@@ -1,5 +1,5 @@
-import fs from 'node:fs'
 import { _memoFn, AppError } from '@naturalcycles/js-lib'
+import { fs2 } from '@naturalcycles/nodejs-lib'
 import ejs from 'ejs'
 import { BackendRequestHandler } from '../server/server.model'
 import { BaseAdminService } from './base.admin.service'
@@ -101,7 +101,7 @@ export function loginHtml(firebaseServiceCfg: FirebaseSharedServiceCfg): Backend
 
 const getLoginHtml = _memoFn((cfg: LoginHtmlCfg) => {
   console.log(`reading login.html`)
-  const tmpl = fs.readFileSync(`${__dirname}/login.html`, 'utf8')
+  const tmpl = fs2.readText(`${__dirname}/login.html`)
   return ejs.render(tmpl, cfg)
 })
 

package/src/db/httpDB.ts

@@ -105,7 +105,7 @@ export class HttpDB extends BaseCommonDB implements CommonDB {
     })
   }
 
-  override async saveBatch<ROW extends Partial<ObjectWithId>>(
+  override async saveBatch<ROW extends ObjectWithId>(
     table: string,
     rows: ROW[],
     opt?: CommonDBSaveOptions<ROW>,

package/src/db/httpDBRequestHandler.ts

@@ -39,7 +39,7 @@ const runQueryInputSchema = objectSchema<RunQueryInput>({
 export interface SaveBatchInput {
   table: string
   rows: ObjectWithId[]
-  opt?: CommonDBSaveOptions
+  opt?: CommonDBSaveOptions<any>
 }
 
 const saveBatchInputSchema = objectSchema<SaveBatchInput>({

package/src/deploy/backend.cfg.util.ts

@@ -4,31 +4,14 @@ import { resourcesDir } from '../paths.cnst'
 
 export interface BackendCfg {
   gaeProject: string
-
   gaeProjectByBranch?: StringMap
 
   /**
    * @example default
    */
   gaeService: string
-
   gaeServiceByBranch?: StringMap
 
-  /**
-   * @default true
-   *
-   * If true - service name will look like ${branchName}--${gaeService}, similar to Netlify.
-   * If false - ${gaeService}.
-   *
-   * Prod branch NEVER includes branchName in service name.
-   */
-  serviceWithBranchName?: boolean
-
-  /**
-   * @example prod
-   */
-  prodBranch: string
-
   /**
    * List of file patterns to include in deployment.
    */
@@ -61,7 +44,6 @@ export function getBackendCfg(projectDir: string = '.'): BackendCfg {
   requireFileToExist(backendCfgYamlPath)
 
   const backendCfg: BackendCfg = {
-    serviceWithBranchName: true,
     ...fs2.readYaml(backendCfgYamlPath),
   }
 

package/src/deploy/deploy.model.ts

@@ -8,7 +8,6 @@ export interface DeployInfo {
   serviceUrl: string
   gitRev: string
   gitBranch: string
-  prod: boolean
 
   /**
    * Unix timestamp of deployInfo.json being generated.

package/src/deploy/deploy.util.ts

@@ -1,7 +1,5 @@
-import fs from 'node:fs'
 import { _assert, _mapValues, _merge, _truncate, localTimeNow } from '@naturalcycles/js-lib'
-import { dimGrey, white } from '@naturalcycles/nodejs-lib'
-import yaml from 'js-yaml'
+import { dimGrey, fs2, white } from '@naturalcycles/nodejs-lib'
 import { BackendCfg } from './backend.cfg.util'
 import { AppYaml, DeployInfo } from './deploy.model'
 
@@ -29,12 +27,9 @@ export async function createAndSaveDeployInfo(
   targetDir: string,
 ): Promise<DeployInfo> {
   const deployInfo = await createDeployInfo(backendCfg)
-
   const deployInfoPath = `${targetDir}/deployInfo.json`
-
-  fs.writeFileSync(deployInfoPath, JSON.stringify(deployInfo, null, 2))
+  fs2.writeJson(deployInfoPath, deployInfo, { spaces: 2 })
   console.log(`saved ${dimGrey(deployInfoPath)}`)
-
   return deployInfo
 }
 
@@ -54,18 +49,14 @@ export async function createDeployInfo(
     gaeProjectByBranch = {},
     gaeService,
     gaeServiceByBranch = {},
-    serviceWithBranchName,
-    prodBranch,
     branchesWithTimestampVersions = [],
   } = backendCfg
 
   gaeProject = gaeProjectByBranch[gitBranch] || gaeProject
 
-  gaeService = validateGAEServiceName(gaeServiceByBranch[gitBranch] || gaeService)
-
-  const prod = gitBranch === prodBranch
-
-  if (!prod && serviceWithBranchName && !gaeServiceByBranch[gitBranch]) {
+  if (gaeServiceByBranch[gitBranch]) {
+    gaeService = validateGAEServiceName(gaeServiceByBranch[gitBranch]!)
+  } else {
     gaeService = validateGAEServiceName([gitBranch, gaeService].join('--'))
   }
 
@@ -99,7 +90,6 @@ export async function createDeployInfo(
     serviceUrl,
     gitBranch,
     gitRev,
-    prod,
     ts: now.unix(),
   }
 
@@ -116,12 +106,9 @@ export function createAndSaveAppYaml(
   appYamlPassEnv = '',
 ): AppYaml {
   const appYaml = createAppYaml(backendCfg, deployInfo, projectDir, appYamlPassEnv)
-
   const appYamlPath = `${targetDir}/app.yaml`
-
-  fs.writeFileSync(appYamlPath, yaml.dump(appYaml))
+  fs2.writeYaml(appYamlPath, appYaml)
   console.log(`saved ${dimGrey(appYamlPath)}`)
-
   return appYaml
 }
 
@@ -144,15 +131,15 @@ export function createAppYaml(
 
   // Check existing app.yaml
   const appYamlPath = `${projectDir}/app.yaml`
-  if (fs.existsSync(appYamlPath)) {
+  if (fs2.pathExists(appYamlPath)) {
     console.log(`merging-in ${dimGrey(appYamlPath)}`)
-    _merge(appYaml, yaml.load(fs.readFileSync(appYamlPath, 'utf8')))
+    _merge(appYaml, fs2.readYaml(appYamlPath))
   }
 
   const appEnvYamlPath = `${projectDir}/app.${APP_ENV}.yaml`
-  if (fs.existsSync(appEnvYamlPath)) {
+  if (fs2.pathExists(appEnvYamlPath)) {
     console.log(`merging-in ${dimGrey(appEnvYamlPath)}`)
-    _merge(appYaml, yaml.load(fs.readFileSync(appEnvYamlPath, 'utf8')))
+    _merge(appYaml, fs2.readYaml(appEnvYamlPath))
   }
 
   // appYamlPassEnv

package/src/deploy/deployGae.ts

@@ -89,12 +89,12 @@ export async function undeployGae(branch: string): Promise<void> {
   const projectDir = '.'
   const backendCfg = getBackendCfg(projectDir)
 
-  const { gaeProject, gaeService, gaeVersion, prod } = await createDeployInfo(backendCfg, branch)
+  const { gaeProject, gaeService, gaeVersion } = await createDeployInfo(backendCfg, branch)
 
-  if (prod) {
-    console.log(`undeployGae (branch: ${branch}): not removing prod version (safety check)`)
-    return
-  }
+  // if (prod) {
+  //   console.log(`undeployGae (branch: ${branch}): not removing prod version (safety check)`)
+  //   return
+  // }
 
   console.log(
     `undeployGae (branch: ${branch}): going to remove ${gaeProject}/${gaeService}/${gaeVersion}`,

package/src/server/deployInfo.util.ts

@@ -1,11 +1,11 @@
-import fs from 'node:fs'
 import { _memoFn } from '@naturalcycles/js-lib'
+import { fs2 } from '@naturalcycles/nodejs-lib'
 import type { DeployInfo } from '../deploy'
 
 export const getDeployInfo = _memoFn((projectDir: string): DeployInfo => {
   const deployInfoPath = `${projectDir}/deployInfo.json`
   try {
-    return JSON.parse(fs.readFileSync(deployInfoPath, 'utf8'))
+    return fs2.readJson(deployInfoPath)
   } catch {
     // console.error(`cannot read ${deployInfoPath}, returning empty version`)
     return getDeployInfoStub()
@@ -21,7 +21,6 @@ function getDeployInfoStub(stub = ''): DeployInfo {
     versionUrl: stub,
     gitBranch: stub,
     gitRev: stub,
-    prod: false,
     ts: Math.floor(Date.now() / 1000),
   }
 }

package/src/server/serverStatusMiddleware.ts

@@ -16,7 +16,7 @@ export function getServerStatusData(
   projectDir: string = process.cwd(),
   extra?: any,
 ): Record<string, any> {
-  const { gitRev, gitBranch, prod, ts } = getDeployInfo(projectDir)
+  const { gitRev, gitBranch, ts } = getDeployInfo(projectDir)
   const t = localTime(ts)
   const deployBuildTime = t.toPretty()
   const buildInfo = [t.toStringCompact(), gitBranch, gitRev].filter(Boolean).join('_')
@@ -25,7 +25,6 @@ export function getServerStatusData(
     started: getStartedStr(),
     deployBuildTime,
     APP_ENV,
-    prod,
     buildInfo,
     GAE_APPLICATION,
     GAE_SERVICE,