@naturalcycles/datastore-lib 3.18.0 → 3.19.0

package/dist/datastore.db.js

@@ -35,8 +35,12 @@ class DatastoreDB extends db_lib_1.BaseCommonDB {
             const datastoreLib = require('@google-cloud/datastore');
             const DS = datastoreLib.Datastore;
             (_a = this.cfg).projectId || (_a.projectId = this.cfg.credentials?.project_id || process.env['GOOGLE_CLOUD_PROJECT']);
-            (0, js_lib_1._assert)(this.cfg.projectId, '"projectId" is not set for DatastoreDB');
-            this.cfg.logger.log(`DatastoreDB connected to ${(0, colors_1.boldWhite)(this.cfg.projectId)}`);
+            if (this.cfg.projectId) {
+                this.cfg.logger.log(`DatastoreDB connected to ${(0, colors_1.boldWhite)(this.cfg.projectId)}`);
+            }
+            else if (process.env['GOOGLE_APPLICATION_CREDENTIALS']) {
+                this.cfg.logger.log(`DatastoreDB connected via GOOGLE_APPLICATION_CREDENTIALS`);
+            }
             if (this.cfg.useLegacyGRPC) {
                 this.cfg.grpc = require('grpc');
             }
@@ -56,16 +60,31 @@ class DatastoreDB extends db_lib_1.BaseCommonDB {
             return [];
         const keys = ids.map(id => this.key(table, id));
         let rows;
-        try {
-            rows = (await this.ds().get(keys))[0];
+        if (this.cfg.timeout) {
+            // First try
+            try {
+                const r = await (0, js_lib_1.pTimeout)(this.ds().get(keys), {
+                    timeout: this.cfg.timeout,
+                    name: `datastore.getByIds(${table})`,
+                });
+                rows = r[0];
+            }
+            catch {
+                this.cfg.logger.log('datastore recreated on error');
+                // This is to debug "GCP Datastore Timeout issue"
+                const datastoreLib = require('@google-cloud/datastore');
+                const DS = datastoreLib.Datastore;
+                this.cachedDatastore = new DS(this.cfg);
+                // Second try (will throw)
+                const r = await (0, js_lib_1.pTimeout)(this.ds().get(keys), {
+                    timeout: this.cfg.timeout,
+                    name: `datastore.getByIds(${table}) second try`,
+                });
+                rows = r[0];
+            }
         }
-        catch (err) {
-            this.cfg.logger.log('datastore recreated on error');
-            // This is to debug "GCP Datastore Timeout issue"
-            const datastoreLib = require('@google-cloud/datastore');
-            const DS = datastoreLib.Datastore;
-            this.cachedDatastore = new DS(this.cfg);
-            throw err;
+        else {
+            rows = (await this.ds().get(keys))[0];
         }
         return (rows
             .map(r => this.mapId(r))
@@ -124,12 +143,12 @@ class DatastoreDB extends db_lib_1.BaseCommonDB {
      */
     async saveBatch(table, rows, opt = {}) {
         const entities = rows.map(obj => this.toDatastoreEntity(table, obj, opt.excludeFromIndexes));
-        const save = (0, js_lib_1.pRetry)(async (batch) => {
+        const save = (0, js_lib_1.pRetryFn)(async (batch) => {
             await (opt.tx || this.ds()).save(batch);
         }, {
             // Here we retry the GOAWAY errors that are somewhat common for Datastore
             // Currently only retrying them here in .saveBatch(), cause probably they're only thrown when saving
-            predicate: err => RETRY_ON.some(s => err?.message.includes(s)),
+            predicate: err => RETRY_ON.some(s => err?.message?.includes(s)),
             name: `DatastoreLib.saveBatch(${table})`,
             maxAttempts: 5,
             delay: 5000,
@@ -140,13 +159,19 @@ class DatastoreDB extends db_lib_1.BaseCommonDB {
             logger: this.cfg.logger,
         });
         try {
-            await (0, js_lib_1.pMap)((0, js_lib_1._chunk)(entities, MAX_ITEMS), async (batch) => await save(batch));
+            const chunks = (0, js_lib_1._chunk)(entities, MAX_ITEMS);
+            if (chunks.length === 1) {
+                // Not using pMap in hope to preserve stack trace
+                await save(chunks[0]);
+            }
+            else {
+                await (0, js_lib_1.pMap)(chunks, async (batch) => await save(batch));
+            }
         }
         catch (err) {
             // console.log(`datastore.save ${kind}`, { obj, entity })
             this.cfg.logger.error(`error in DatastoreLib.saveBatch for ${table} (${rows.length} rows)`, err);
-            // don't throw, because datastore SDK makes it in separate thread, so exception will be unhandled otherwise
-            return await Promise.reject(err);
+            throw err;
         }
     }
     async deleteByQuery(q, opt) {

package/dist/datastore.model.d.ts

@@ -34,6 +34,13 @@ export interface DatastoreDBCfg extends DatastoreOptions {
      * Default to `console`
      */
     logger?: CommonLogger;
+    /**
+     * Experimental option, currently only applies to `getByIds`.
+     * Applies pTimeout to Datastore operation, re-creates Datastore on any error.
+     *
+     * @experimental
+     */
+    timeout?: number;
 }
 export interface DatastoreCredentials {
     type?: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@naturalcycles/datastore-lib",
-  "version": "3.18.0",
+  "version": "3.19.0",
   "description": "Opinionated library to work with Google Datastore",
   "scripts": {
     "prepare": "husky install"

package/src/datastore.db.ts

@@ -17,13 +17,14 @@ import {
   JsonSchemaObject,
   JsonSchemaString,
   pMap,
-  pRetry,
   _assert,
   _chunk,
   _omit,
   JsonSchemaRootObject,
   CommonLogger,
   commonLoggerMinLevel,
+  pTimeout,
+  pRetryFn,
 } from '@naturalcycles/js-lib'
 import { ReadableTyped } from '@naturalcycles/nodejs-lib'
 import { boldWhite } from '@naturalcycles/nodejs-lib/dist/colors'
@@ -83,9 +84,11 @@ export class DatastoreDB extends BaseCommonDB implements CommonDB {
       const DS = datastoreLib.Datastore as typeof Datastore
       this.cfg.projectId ||= this.cfg.credentials?.project_id || process.env['GOOGLE_CLOUD_PROJECT']
 
-      _assert(this.cfg.projectId, '"projectId" is not set for DatastoreDB')
-
-      this.cfg.logger.log(`DatastoreDB connected to ${boldWhite(this.cfg.projectId)}`)
+      if (this.cfg.projectId) {
+        this.cfg.logger.log(`DatastoreDB connected to ${boldWhite(this.cfg.projectId)}`)
+      } else if (process.env['GOOGLE_APPLICATION_CREDENTIALS']) {
+        this.cfg.logger.log(`DatastoreDB connected via GOOGLE_APPLICATION_CREDENTIALS`)
+      }
 
       if (this.cfg.useLegacyGRPC) {
         this.cfg.grpc = require('grpc')
@@ -115,17 +118,31 @@ export class DatastoreDB extends BaseCommonDB implements CommonDB {
     const keys = ids.map(id => this.key(table, id))
     let rows: any[]
 
-    try {
+    if (this.cfg.timeout) {
+      // First try
+      try {
+        const r = await pTimeout(this.ds().get(keys), {
+          timeout: this.cfg.timeout,
+          name: `datastore.getByIds(${table})`,
+        })
+        rows = r[0]
+      } catch {
+        this.cfg.logger.log('datastore recreated on error')
+
+        // This is to debug "GCP Datastore Timeout issue"
+        const datastoreLib = require('@google-cloud/datastore')
+        const DS = datastoreLib.Datastore as typeof Datastore
+        this.cachedDatastore = new DS(this.cfg)
+
+        // Second try (will throw)
+        const r = await pTimeout(this.ds().get(keys), {
+          timeout: this.cfg.timeout,
+          name: `datastore.getByIds(${table}) second try`,
+        })
+        rows = r[0]
+      }
+    } else {
       rows = (await this.ds().get(keys))[0]
-    } catch (err) {
-      this.cfg.logger.log('datastore recreated on error')
-
-      // This is to debug "GCP Datastore Timeout issue"
-      const datastoreLib = require('@google-cloud/datastore')
-      const DS = datastoreLib.Datastore as typeof Datastore
-      this.cachedDatastore = new DS(this.cfg)
-
-      throw err
     }
 
     return (
@@ -226,14 +243,14 @@ export class DatastoreDB extends BaseCommonDB implements CommonDB {
       this.toDatastoreEntity(table, obj, opt.excludeFromIndexes as string[]),
     )
 
-    const save = pRetry(
+    const save = pRetryFn(
       async (batch: DatastorePayload<ROW>[]) => {
         await (opt.tx || this.ds()).save(batch)
       },
       {
         // Here we retry the GOAWAY errors that are somewhat common for Datastore
         // Currently only retrying them here in .saveBatch(), cause probably they're only thrown when saving
-        predicate: err => RETRY_ON.some(s => (err as Error)?.message.includes(s)),
+        predicate: err => RETRY_ON.some(s => err?.message?.includes(s)),
         name: `DatastoreLib.saveBatch(${table})`,
         maxAttempts: 5,
         delay: 5000,
@@ -246,15 +263,21 @@ export class DatastoreDB extends BaseCommonDB implements CommonDB {
     )
 
     try {
-      await pMap(_chunk(entities, MAX_ITEMS), async batch => await save(batch))
+      const chunks = _chunk(entities, MAX_ITEMS)
+      if (chunks.length === 1) {
+        // Not using pMap in hope to preserve stack trace
+        await save(chunks[0]!)
+      } else {
+        await pMap(chunks, async batch => await save(batch))
+      }
     } catch (err) {
       // console.log(`datastore.save ${kind}`, { obj, entity })
       this.cfg.logger.error(
         `error in DatastoreLib.saveBatch for ${table} (${rows.length} rows)`,
         err,
       )
-      // don't throw, because datastore SDK makes it in separate thread, so exception will be unhandled otherwise
-      return await Promise.reject(err)
+
+      throw err
     }
   }
 

package/src/datastore.model.ts

@@ -41,6 +41,14 @@ export interface DatastoreDBCfg extends DatastoreOptions {
    * Default to `console`
    */
   logger?: CommonLogger
+
+  /**
+   * Experimental option, currently only applies to `getByIds`.
+   * Applies pTimeout to Datastore operation, re-creates Datastore on any error.
+   *
+   * @experimental
+   */
+  timeout?: number
 }
 
 export interface DatastoreCredentials {