@naturalcycles/datastore-lib 3.23.2 → 3.24.0

package/dist/datastore.db.d.ts

@@ -57,4 +57,5 @@ export declare class DatastoreDB extends BaseCommonDB implements CommonDB {
     getKey(key: Key): string | undefined;
     getTables(): Promise<string[]>;
     getTableSchema<ROW extends ObjectWithId>(table: string): Promise<JsonSchemaRootObject<ROW>>;
+    private getPRetryOptions;
 }

package/dist/datastore.db.js

@@ -155,19 +155,7 @@ class DatastoreDB extends db_lib_1.BaseCommonDB {
         const method = methodMap[opt.saveMethod || 'upsert'] || 'save';
         const save = (0, js_lib_1.pRetryFn)(async (batch) => {
             await (opt.tx || this.ds())[method](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)),
-            name: `DatastoreLib.saveBatch(${table})`,
-            maxAttempts: 5,
-            delay: 5000,
-            delayMultiplier: 2,
-            logFirstAttempt: false,
-            logFailures: true,
-            // logAll: true,
-            logger: this.cfg.logger,
-        });
+        }, this.getPRetryOptions(`DatastoreLib.saveBatch(${table})`));
         try {
             const chunks = (0, js_lib_1._chunk)(entities, MAX_ITEMS);
             if (chunks.length === 1) {
@@ -203,27 +191,30 @@ class DatastoreDB extends db_lib_1.BaseCommonDB {
      * https://cloud.google.com/datastore/docs/concepts/transactions#datastore-datastore-transactional-update-nodejs
      */
     async commitTransaction(_tx, opt) {
-        const tx = this.ds().transaction();
-        try {
-            await tx.run();
-            // const ops = mergeDBOperations(_tx.ops)
-            for await (const op of _tx.ops) {
-                if (op.type === 'saveBatch') {
-                    await this.saveBatch(op.table, op.rows, { ...opt, tx });
-                }
-                else if (op.type === 'deleteByIds') {
-                    await this.deleteByIds(op.table, op.ids, { ...opt, tx });
-                }
-                else {
-                    throw new Error(`DBOperation not supported: ${op.type}`);
+        // Using Retry, because Datastore can throw errors like "too much contention" here
+        await (0, js_lib_1.pRetry)(async () => {
+            const tx = this.ds().transaction();
+            try {
+                await tx.run();
+                const ops = (0, db_lib_1.mergeDBOperations)(_tx.ops);
+                for await (const op of ops) {
+                    if (op.type === 'saveBatch') {
+                        await this.saveBatch(op.table, op.rows, { ...opt, tx });
+                    }
+                    else if (op.type === 'deleteByIds') {
+                        await this.deleteByIds(op.table, op.ids, { ...opt, tx });
+                    }
+                    else {
+                        throw new Error(`DBOperation not supported: ${op.type}`);
+                    }
                 }
+                await tx.commit();
             }
-            await tx.commit();
-        }
-        catch (err) {
-            void tx.rollback();
-            throw err; // rethrow
-        }
+            catch (err) {
+                await tx.rollback();
+                throw err; // rethrow
+            }
+        }, this.getPRetryOptions(`DatastoreLib.commitTransaction`));
     }
     async getAllStats() {
         const q = this.ds().createQuery('__Stat_Kind__');
@@ -356,5 +347,18 @@ class DatastoreDB extends db_lib_1.BaseCommonDB {
         });
         return s;
     }
+    getPRetryOptions(name) {
+        return {
+            predicate: err => RETRY_ON.some(s => err?.message?.includes(s)),
+            name,
+            maxAttempts: 5,
+            delay: 5000,
+            delayMultiplier: 2,
+            logFirstAttempt: false,
+            logFailures: true,
+            // logAll: true,
+            logger: this.cfg.logger,
+        };
+    }
 }
 exports.DatastoreDB = DatastoreDB;

package/dist/datastore.model.d.ts

@@ -1,6 +1,6 @@
 import type { DatastoreOptions, Key, Transaction } from '@google-cloud/datastore';
 import { CommonDBOptions, CommonDBSaveOptions } from '@naturalcycles/db-lib';
-import { AnyObjectWithId, CommonLogger, ObjectWithId } from '@naturalcycles/js-lib';
+import { CommonLogger, ObjectWithId } from '@naturalcycles/js-lib';
 export interface DatastorePayload<T = any> {
     key: Key;
     data: T;
@@ -99,7 +99,7 @@ export interface DatastoreDBStreamOptions extends DatastoreDBOptions {
 export interface DatastoreDBOptions extends CommonDBOptions {
     tx?: Transaction;
 }
-export interface DatastoreDBSaveOptions<ROW extends Partial<ObjectWithId> = AnyObjectWithId> extends CommonDBSaveOptions<ROW> {
+export interface DatastoreDBSaveOptions<ROW extends Partial<ObjectWithId> = any> extends CommonDBSaveOptions<ROW> {
     tx?: Transaction;
 }
 export interface DatastoreStats {

package/package.json

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

package/src/datastore.db.ts

@@ -6,6 +6,7 @@ import {
   CommonDBSaveMethod,
   DBQuery,
   DBTransaction,
+  mergeDBOperations,
   RunQueryResult,
 } from '@naturalcycles/db-lib'
 import {
@@ -25,6 +26,8 @@ import {
   commonLoggerMinLevel,
   pTimeout,
   pRetryFn,
+  pRetry,
+  PRetryOptions,
 } from '@naturalcycles/js-lib'
 import { ReadableTyped } from '@naturalcycles/nodejs-lib'
 import { boldWhite } from '@naturalcycles/nodejs-lib/dist/colors'
@@ -255,24 +258,9 @@ export class DatastoreDB extends BaseCommonDB implements CommonDB {
 
     const method = methodMap[opt.saveMethod || 'upsert'] || 'save'
 
-    const save = pRetryFn(
-      async (batch: DatastorePayload<ROW>[]) => {
-        await (opt.tx || this.ds())[method](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)),
-        name: `DatastoreLib.saveBatch(${table})`,
-        maxAttempts: 5,
-        delay: 5000,
-        delayMultiplier: 2,
-        logFirstAttempt: false,
-        logFailures: true,
-        // logAll: true,
-        logger: this.cfg.logger,
-      },
-    )
+    const save = pRetryFn(async (batch: DatastorePayload<ROW>[]) => {
+      await (opt.tx || this.ds())[method](batch)
+    }, this.getPRetryOptions(`DatastoreLib.saveBatch(${table})`))
 
     try {
       const chunks = _chunk(entities, MAX_ITEMS)
@@ -328,28 +316,31 @@ export class DatastoreDB extends BaseCommonDB implements CommonDB {
     _tx: DBTransaction,
     opt?: DatastoreDBSaveOptions,
   ): Promise<void> {
-    const tx = this.ds().transaction()
+    // Using Retry, because Datastore can throw errors like "too much contention" here
+    await pRetry(async () => {
+      const tx = this.ds().transaction()
 
-    try {
-      await tx.run()
+      try {
+        await tx.run()
 
-      // const ops = mergeDBOperations(_tx.ops)
+        const ops = mergeDBOperations(_tx.ops)
 
-      for await (const op of _tx.ops) {
-        if (op.type === 'saveBatch') {
-          await this.saveBatch(op.table, op.rows, { ...opt, tx })
-        } else if (op.type === 'deleteByIds') {
-          await this.deleteByIds(op.table, op.ids, { ...opt, tx })
-        } else {
-          throw new Error(`DBOperation not supported: ${(op as any).type}`)
+        for await (const op of ops) {
+          if (op.type === 'saveBatch') {
+            await this.saveBatch(op.table, op.rows, { ...opt, tx })
+          } else if (op.type === 'deleteByIds') {
+            await this.deleteByIds(op.table, op.ids, { ...opt, tx })
+          } else {
+            throw new Error(`DBOperation not supported: ${(op as any).type}`)
+          }
         }
-      }
 
-      await tx.commit()
-    } catch (err) {
-      void tx.rollback()
-      throw err // rethrow
-    }
+        await tx.commit()
+      } catch (err) {
+        await tx.rollback()
+        throw err // rethrow
+      }
+    }, this.getPRetryOptions(`DatastoreLib.commitTransaction`))
   }
 
   async getAllStats(): Promise<DatastoreStats[]> {
@@ -496,4 +487,18 @@ export class DatastoreDB extends BaseCommonDB implements CommonDB {
 
     return s
   }
+
+  private getPRetryOptions(name: string): PRetryOptions {
+    return {
+      predicate: err => RETRY_ON.some(s => err?.message?.includes(s)),
+      name,
+      maxAttempts: 5,
+      delay: 5000,
+      delayMultiplier: 2,
+      logFirstAttempt: false,
+      logFailures: true,
+      // logAll: true,
+      logger: this.cfg.logger,
+    }
+  }
 }

package/src/datastore.model.ts

@@ -1,6 +1,6 @@
 import type { DatastoreOptions, Key, Transaction } from '@google-cloud/datastore'
 import { CommonDBOptions, CommonDBSaveOptions } from '@naturalcycles/db-lib'
-import { AnyObjectWithId, CommonLogger, ObjectWithId } from '@naturalcycles/js-lib'
+import { CommonLogger, ObjectWithId } from '@naturalcycles/js-lib'
 
 export interface DatastorePayload<T = any> {
   key: Key
@@ -114,7 +114,7 @@ export interface DatastoreDBStreamOptions extends DatastoreDBOptions {
 export interface DatastoreDBOptions extends CommonDBOptions {
   tx?: Transaction
 }
-export interface DatastoreDBSaveOptions<ROW extends Partial<ObjectWithId> = AnyObjectWithId>
+export interface DatastoreDBSaveOptions<ROW extends Partial<ObjectWithId> = any>
   extends CommonDBSaveOptions<ROW> {
   tx?: Transaction
 }