nesoi 3.3.30 → 3.4.1

package/lib/engine/transaction/trx_engine.js

@@ -26,6 +26,7 @@ class TrxEngine {
      */
     innerTrx;
     adapter;
+    log_adapter;
     constructor(origin, module, authnProviders, config, services = {}) {
         this.origin = origin;
         this.module = module;
@@ -35,29 +36,35 @@ class TrxEngine {
         this.innerTrx = new trx_1.Trx(this, this.module, `trx:${origin}`, true);
         this.$TrxBucket = new elements_1.$Bucket(this.module.name, '__trx__', `Transaction of Module '${this.module.name}'`, new bucket_model_schema_1.$BucketModel({
             id: new bucket_model_schema_1.$BucketModelField('id', 'id', 'string', 'ID', true),
+            state: new bucket_model_schema_1.$BucketModelField('state', 'state', 'string', 'State', true), // TrxNodeState
             origin: new bucket_model_schema_1.$BucketModelField('origin', 'origin', 'string', 'Origin', true),
             module: new bucket_model_schema_1.$BucketModelField('module', 'module', 'string', 'Module', true),
             start: new bucket_model_schema_1.$BucketModelField('start', 'start', 'datetime', 'Start', true),
-            end: new bucket_model_schema_1.$BucketModelField('end', 'end', 'datetime', 'End', false),
+            end: new bucket_model_schema_1.$BucketModelField('end', 'end', 'datetime', 'End', false)
         }), new bucket_graph_schema_1.$BucketGraph(), {});
-        this.adapter = config?.adapter?.(module.schema) || new memory_bucket_adapter_1.MemoryBucketAdapter(this.$TrxBucket, {});
+        this.adapter = config?.adapter?.(this.$TrxBucket) || new memory_bucket_adapter_1.MemoryBucketAdapter(this.$TrxBucket, {});
+        if (config?.log_adapter) {
+            this.log_adapter = config?.log_adapter?.(this.$TrxBucket);
+        }
     }
     getModule() {
         return this.module;
     }
-    async get(id, origin, idempotent = false) {
+    async get(id, origin, req_idempotent = false) {
         const _origin = origin ?? this.origin;
         let trx;
         // New transaction
         if (!id) {
-            trx = new trx_1.Trx(this, this.module, _origin, idempotent);
-            log_1.Log.info('module', this.module.name, `Begin${idempotent ? '*' : ''} ${(0, log_1.scopeTag)('trx', trx.id + trx.root.id)} @ ${(0, log_1.anyScopeTag)(_origin)}`);
+            trx = new trx_1.Trx(this, this.module, _origin, req_idempotent);
+            log_1.Log.debug('module', this.module.name, `Begin${req_idempotent ? '*' : ''} ${(0, log_1.scopeTag)('trx', trx.root.globalId)} @ ${(0, log_1.anyScopeTag)(_origin)}`);
             for (const wrap of this.config?.wrap || []) {
+                // The wrappers decide how to begin a db transaction, based on the trx idempotent flag.
                 await wrap.begin(trx, this.services);
             }
-            if (!idempotent) {
+            if (!req_idempotent) {
                 await this.adapter.create(this.innerTrx.root, {
                     id: trx.id,
+                    state: 'open',
                     origin: trx.origin,
                     start: trx.start,
                     end: trx.end,
@@ -69,49 +76,78 @@ class TrxEngine {
         // Chain/Continue transaction
         else {
             const trxData = await this.adapter.get(this.innerTrx.root, id);
+            // If trxData exists, the transaction to which it refers is non-idempotent,
+            // since idempotent transactions are not stored.
+            //
             // If a transaction is being continued it cannot become idempotent,
             // since the data it needs is inside the transaction.
-            // > Started as NOT idempotent on this module, is NEVER idempotent
-            // This only affects services which need this info for deciding whether
-            // to commit/rollback a transaction. The trx engine still uses the requested
-            // idempotent value to decide whether to run or not a commit/rollback,
-            // because otherwise it would commit/rollback partially idempotent transactions
-            // before they're actually finished.
-            if (trxData)
-                idempotent = false;
+            //
+            // If the transaction started as non-idempotent and is continued as idempotent,
+            // the code below will transform it into non-idempotent, however
+            // the engine.ok and engine.error still treat it as idempotent, to avoid commit/rollback
+            // of the original transaction.
+            //
             // Differently, a transaction with specific id which doesn't exist can
             // be either an ongoing idempotent transaction from this module or an
             // external transaction starting at a different module.
-            // On either case, it's allowed to become idempotent.
-            // > Not stored, can become idempotent.
-            // if (!trxData) idempotent = idempotent;
+            // On either case, it's allowed to be idempotent or not.
+            const idempotent = trxData ? false : req_idempotent;
             trx = new trx_1.Trx(this, this.module, _origin, idempotent, undefined, id);
-            // (Continue*)
-            if (idempotent) {
-                log_1.Log.info('module', this.module.name, `Continue* ${(0, log_1.scopeTag)('trx', id)} @ ${(0, log_1.anyScopeTag)(_origin)}`);
-                for (const wrap of this.config?.wrap || []) {
-                    await wrap.continue(trx, this.services);
+            // (Begin/Continue*)
+            // The request is for an idempotent transaction.
+            if (req_idempotent) {
+                // A non-idempotent transaction with the same id exists on this module.
+                // so it's being continued as an idempotent transaction.
+                if (trxData) {
+                    log_1.Log.debug('module', this.module.name, `Continue* ${(0, log_1.scopeTag)('trx', trx.root.globalId)} @ ${(0, log_1.anyScopeTag)(_origin)}`);
+                    if (trxData.state !== 'hold') {
+                        throw new Error(`Attempt to continue transaction ${trxData.id}, currently at '${trxData.state}', failed. Should be at 'hold'. This might mean there are parallel attempts to continue a transaction, which must be handled with a queue.`);
+                    }
+                    for (const wrap of this.config?.wrap || []) {
+                        // The wrappers decide how to continue a db transaction, based on the trx idempotent flag.
+                        await wrap.continue(trx, this.services);
+                    }
+                }
+                // No transaction with the same id exists on this module.
+                // so it's starting as an idempotent transaction.
+                else {
+                    log_1.Log.debug('module', this.module.name, `Begin* ${(0, log_1.scopeTag)('trx', trx.root.globalId)} @ ${(0, log_1.anyScopeTag)(_origin)}`);
+                    for (const wrap of this.config?.wrap || []) {
+                        // The wrappers decide how to begin a db transaction, based on the trx idempotent flag.
+                        await wrap.begin(trx, this.services);
+                    }
                 }
                 return trx;
             }
             // (Continue)
+            // A non-idempotent transaction with the same id exists on this module,
+            // so it's being continued.
             if (trxData) {
+                log_1.Log.debug('module', this.module.name, `Continue ${(0, log_1.scopeTag)('trx', trx.root.globalId)} @ ${(0, log_1.anyScopeTag)(_origin)}`);
+                if (trxData.state !== 'hold') {
+                    throw new Error(`Attempt to continue transaction ${trxData.id}, currently at '${trxData.state}', failed. Should be at 'hold'. This might mean there are parallel attempts to continue a transaction, which must be handled with a queue.`);
+                }
                 // Update transaction with data read from adapter
                 trx.start = trxData.start;
                 trx.end = trxData.end;
-                log_1.Log.info('module', this.module.name, `Continue ${(0, log_1.scopeTag)('trx', trx.id + trx.root.id)} @ ${(0, log_1.anyScopeTag)(_origin)}`);
                 for (const wrap of this.config?.wrap || []) {
+                    // The wrappers decide how to continue a db transaction, based on the trx idempotent flag.
                     await wrap.continue(trx, this.services);
                 }
             }
             // (Chain)
+            // No transaction with the same id exists on this module,
+            // so it's starting as a "chained" transaction - a new one with
+            // the same ID as the one from some module.
             else {
-                log_1.Log.info('module', this.module.name, `Chain ${(0, log_1.scopeTag)('trx', id + trx.root.id)} @ ${(0, log_1.anyScopeTag)(_origin)}`);
+                log_1.Log.debug('module', this.module.name, `Chain${trx.idempotent ? '*' : ''} ${(0, log_1.scopeTag)('trx', trx.root.globalId)} @ ${(0, log_1.anyScopeTag)(_origin)}`);
                 for (const wrap of this.config?.wrap || []) {
+                    // The wrappers decide how to begin a db transaction, based on the trx idempotent flag.
                     await wrap.begin(trx, this.services);
                 }
                 await this.adapter.create(this.innerTrx.root, {
                     id: trx.id,
+                    state: 'open',
                     origin: _origin,
                     start: trx.start,
                     end: trx.end,
@@ -126,29 +162,29 @@ class TrxEngine {
         try {
             await this.authenticate(trx.root, tokens, users);
             const output = await fn(trx.root);
-            await this.commit(trx, output, idempotent);
+            await this.ok(trx, output, idempotent);
         }
         catch (e) {
-            await this.rollback(trx, e, idempotent);
+            await this.error(trx, e, idempotent);
         }
         return trx.status();
     }
-    async trx_hold(fn, id, authn, users, origin, idempotent = false) {
-        const trx = await this.get(id, origin, idempotent);
+    async trx_hold(fn, id, authn, users, origin) {
+        const trx = await this.get(id, origin, false);
         let output = {};
         try {
             await this.authenticate(trx.root, authn, users);
             output = await fn(trx.root);
-            await this.hold(trx, output, idempotent);
+            await this.hold(trx, output);
         }
         catch (e) {
-            await this.rollback(trx, e, idempotent);
+            await this.error(trx, e, false);
         }
         return {
             id: trx.id,
             status: trx.status(),
-            commit: () => this.commit(trx, output, idempotent),
-            rollback: (error) => this.rollback(trx, error, idempotent)
+            commit: () => this.ok(trx, output, false),
+            rollback: (error) => this.error(trx, error, false)
         };
     }
     /* Metadata sharing between modules */
@@ -188,13 +224,12 @@ class TrxEngine {
         trx_node_1.TrxNode.addAuthn(node, _tokens, _users);
     }
     //
-    async hold(trx, output, idempotent) {
-        log_1.Log.debug('module', this.module.name, `Hold ${(0, log_1.scopeTag)('trx', trx.id)} @ ${(0, log_1.anyScopeTag)(this.origin)}`);
+    async hold(trx, output) {
+        log_1.Log.debug('module', this.module.name, `Hold ${(0, log_1.scopeTag)('trx', trx.root.globalId)}`);
         trx_node_1.TrxNode.hold(trx.root, output);
-        if (idempotent)
-            return trx;
         await this.adapter.put(this.innerTrx.root, {
             id: trx.id,
+            state: 'hold',
             origin: this.origin,
             start: trx.start,
             end: trx.end,
@@ -202,40 +237,59 @@ class TrxEngine {
         });
         return trx;
     }
-    async commit(trx, output, idempotent) {
+    async ok(trx, output, idempotent) {
+        log_1.Log.debug('module', this.module.name, `Ok${idempotent ? '*' : ''} ${(0, log_1.scopeTag)('trx', trx.root.globalId)}`);
         trx_node_1.TrxNode.ok(trx.root, output);
         trx.end = datetime_1.NesoiDatetime.now();
+        const held_children = Object.keys(trx.holds).length;
+        if (held_children) {
+            log_1.Log.debug('module', this.module.name, `Commit Holds ${(0, log_1.scopeTag)('trx', trx.root.globalId)} (${held_children})`);
+            await trx_1.Trx.commitHolds(trx);
+        }
         if (idempotent)
             return trx;
-        await trx_1.Trx.onCommit(trx);
-        log_1.Log.info('module', this.module.name, `Commit ${(0, log_1.scopeTag)('trx', trx.id)} @ ${(0, log_1.anyScopeTag)(this.origin)} (held: ${Object.keys(trx.holds).length})`);
-        await this.adapter.put(this.innerTrx.root, {
+        return this.commit(trx);
+    }
+    async commit(trx) {
+        log_1.Log.debug('module', this.module.name, `Commit ${(0, log_1.scopeTag)('trx', trx.root.globalId)}`);
+        await this.log_adapter?.put(this.innerTrx.root, {
             id: trx.id,
+            state: 'ok',
             origin: this.origin,
             start: trx.start,
             end: trx.end,
             module: this.module.name,
         });
+        await this.adapter.delete(this.innerTrx.root, trx.id);
         for (const wrap of this.config?.wrap || []) {
             await wrap.commit(trx, this.services);
         }
         return trx;
     }
-    async rollback(trx, error, idempotent) {
-        log_1.Log.error('module', this.module.name, `[${error.status}] ${error.toString()}`, error.stack);
+    async error(trx, error, idempotent) {
+        log_1.Log.error('module', this.module.name, `[${error.status}]${idempotent ? '*' : ''} ${error.toString()}`, error.stack);
         trx_node_1.TrxNode.error(trx.root, error);
         trx.end = datetime_1.NesoiDatetime.now();
+        const held_children = Object.keys(trx.holds).length;
+        if (held_children) {
+            log_1.Log.debug('module', this.module.name, `Rollback Holds ${(0, log_1.scopeTag)('trx', trx.root.globalId)} (${held_children})`);
+            await trx_1.Trx.rollbackHolds(trx);
+        }
         if (idempotent)
             return trx;
-        await trx_1.Trx.onRollback(trx);
-        log_1.Log.warn('module', this.module.name, `Rollback ${(0, log_1.scopeTag)('trx', trx.id)} @ ${(0, log_1.anyScopeTag)(this.origin)} (held: ${Object.keys(trx.holds).length})`);
-        await this.adapter.put(this.innerTrx.root, {
+        return this.rollback(trx);
+    }
+    async rollback(trx) {
+        log_1.Log.warn('module', this.module.name, `Rollback ${(0, log_1.scopeTag)('trx', trx.root.globalId)} (held: ${Object.keys(trx.holds).length})`);
+        await this.log_adapter?.put(this.innerTrx.root, {
             id: trx.id,
+            state: 'error',
             origin: this.origin,
             start: trx.start,
             end: trx.end,
             module: this.module.name,
         });
+        await this.adapter.delete(this.innerTrx.root, trx.id);
         for (const wrap of this.config?.wrap || []) {
             await wrap.rollback(trx, this.services);
         }

package/lib/engine/transaction/trx_node.d.ts

@@ -27,6 +27,9 @@ export type TrxNodeStatus = {
     cached_buckets: number;
     nodes: TrxNodeStatus[];
     app: number;
+    ext?: {
+        idempotent: boolean;
+    };
 };
 /**
  * @category Engine
@@ -53,7 +56,7 @@ export declare class TrxNode<Space extends $Space, M extends $Module, AuthUsers
     constructor(scope: 'root' | `${string}::${TrxNodeBlock}:${string}` | `${string}::virtual`, trx: AnyTrx, parent: AnyTrxNode | undefined, module: AnyModule, auth?: {
         tokens: AuthRequest<any>;
         users: AuthUsers;
-    } | undefined, external?: boolean | undefined, id?: string);
+    } | undefined, external?: boolean | undefined);
     static open(node: AnyTrxNode, action: string, input: Record<string, any>): void;
     static hold(node: AnyTrxNode, output?: Record<string, any>): void;
     static ok(node: AnyTrxNode, output?: Record<string, any>): void;

package/lib/engine/transaction/trx_node.js

@@ -44,19 +44,16 @@ class TrxNode {
         hold: undefined,
         end: undefined
     };
-    constructor(scope, trx, parent, module, auth, external, id) {
+    constructor(scope, trx, parent, module, auth, external) {
         this.scope = scope;
         this.trx = trx;
         this.parent = parent;
         this.module = module;
         this.auth = auth;
         this.external = external;
-        if (parent) {
-            this.id = id || (Math.random() + 1).toString(36).substring(7);
-        }
-        else {
-            this.id = '#' + (Math.random() + 1).toString(36).substring(7);
-        }
+        this.id = parent
+            ? (Math.random() + 1).toString(36).substring(7)
+            : '#';
         this.globalId = `${this.trx.id}.${this.id}`;
     }
     static open(node, action, input) {
@@ -201,7 +198,7 @@ class TrxNode {
     // Status
     status() {
         return {
-            id: this.id,
+            id: this.globalId,
             scope: this.scope,
             state: this.state,
             action: this.action,
@@ -210,7 +207,10 @@ class TrxNode {
             error: this.error,
             cached_buckets: Object.keys(this._cache).length,
             nodes: this.children.map(child => child.status()),
-            app: this.time.end ? (this.time.end.epoch - this.time.start.epoch) : -1
+            app: this.time.end ? (this.time.end.epoch - this.time.start.epoch) : -1,
+            ext: this.action === '~' ? {
+                idempotent: this.input?.idempotent
+            } : undefined
         };
     }
     //
@@ -219,6 +219,9 @@ class TrxNode {
             to.children.push(child);
             to.trx.addNode(child);
         }
+        to.input = {
+            idempotent: from.trx.idempotent
+        };
     }
     static makeChildNode(node, module, block, name) {
         const child = new TrxNode(`${module}::${block}:${name}`, node.trx, node, node.module, node.auth);

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "nesoi",
-    "version": "3.3.30",
+    "version": "3.4.1",
     "description": "Declarative framework for data-driven applications",
     "repository": {
         "type": "git",

package/tools/joaquin/bucket.d.ts

@@ -18,11 +18,15 @@ export declare function expectBucket(def: (builder: AnyBucketBuilder) => any, in
     builder: AnyBucketBuilder;
     data: Record<string, any>;
 })[]): {
-    toBuildOne(raw: Record<string, any>, view: string): {
+    toBuildOne(raw: Record<string, any>, view: string, flags?: {
+        serialize: boolean;
+    }): {
         as(parsed: Record<string, any> | Record<string, any>[]): Promise<void>;
         butFail(error: (...args: any[]) => NesoiError.BaseError): Promise<void>;
     };
-    toBuildMany(raws: Record<string, any>[], view: string): {
+    toBuildMany(raws: Record<string, any>[], view: string, flags?: {
+        serialize: boolean;
+    }): {
         as(parsed: Record<string, any> | Record<string, any>[]): Promise<void>;
         butFail(error: (...args: any[]) => NesoiError.BaseError): Promise<void>;
     };

package/tools/joaquin/bucket.js

@@ -37,12 +37,12 @@ function expectBucket(def, inject = []) {
     });
     let promise;
     const step1 = {
-        toBuildOne(raw, view) {
-            promise = () => app.daemon().then(daemon => daemon.trx('test').run(trx => trx.bucket('test').buildOne(raw, view)));
+        toBuildOne(raw, view, flags) {
+            promise = () => app.daemon().then(daemon => daemon.trx('test').run(trx => trx.bucket('test').buildOne(raw, view, flags)));
             return step2;
         },
-        toBuildMany(raws, view) {
-            promise = () => app.daemon().then(daemon => daemon.trx('test').run(trx => trx.bucket('test').buildMany(raws, view)));
+        toBuildMany(raws, view, flags) {
+            promise = () => app.daemon().then(daemon => daemon.trx('test').run(trx => trx.bucket('test').buildMany(raws, view, flags)));
             return step2;
         }
     };