@acodeninja/persist 3.0.0-next.21 → 3.0.0-next.23

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@acodeninja/persist",
-  "version": "3.0.0-next.21",
+  "version": "3.0.0-next.23",
   "description": "A JSON based data modelling and persistence module with alternate storage mechanisms.",
   "type": "module",
   "scripts": {

package/src/Connection.js

@@ -7,24 +7,6 @@ import Model from './data/Model.js';
 import SearchIndex from './data/SearchIndex.js';
 import _ from 'lodash';
 
-/**
- * Represents a transactional operation to be executed, typically queued and later committed.
- *
- * Stores the method to invoke, the arguments to apply, and tracks the result or error state
- * of the transaction once it's processed.
- *
- * @class Transaction
- */
-export class Transaction {
-    constructor(method, ...args) {
-        this.method = method;
-        this.args = args;
-        this.original = undefined;
-        this.error = undefined;
-        this.committed = false;
-    }
-}
-
 /**
  * @class Connection
  */
@@ -189,11 +171,12 @@ export default class Connection {
 
             if (modelToProcessHasChanged) modelsToPut.push(modelToProcess);
 
+            const modelToProcessConstructor = this.#getModelConstructorFromId(modelToProcess.id).name;
+
             if (
                 Boolean(modelToProcess.constructor.indexedProperties().length) &&
                 (!currentModel || !_.isEqual(currentModel.toIndexData(), modelToProcess.toIndexData()))
             ) {
-                const modelToProcessConstructor = this.#getModelConstructorFromId(modelToProcess.id).name;
                 modelsToReindex[modelToProcessConstructor] = modelsToReindex[modelToProcessConstructor] || [];
                 modelsToReindex[modelToProcessConstructor].push(modelToProcess);
             }
@@ -202,7 +185,6 @@ export default class Connection {
                 Boolean(modelToProcess.constructor.searchProperties().length) &&
                 (!currentModel || !_.isEqual(currentModel.toSearchData(), modelToProcess.toSearchData()))
             ) {
-                const modelToProcessConstructor = this.#getModelConstructorFromId(modelToProcess.id).name;
                 modelsToReindexSearch[modelToProcessConstructor] = modelsToReindexSearch[modelToProcessConstructor] || [];
                 modelsToReindexSearch[modelToProcessConstructor].push(modelToProcess);
             }
@@ -223,7 +205,7 @@ export default class Connection {
                 const index = await this.#storage.getIndex(modelConstructor);
 
                 await this.#storage.putIndex(modelConstructor, {
-                    ...index || {},
+                    ...index,
                     ...Object.fromEntries(models.map(m => [m.id, m.toIndexData()])),
                 });
             })),
@@ -232,7 +214,7 @@ export default class Connection {
                 const index = await this.#storage.getSearchIndex(modelConstructor);
 
                 await this.#storage.putSearchIndex(modelConstructor, {
-                    ...index || {},
+                    ...index,
                     ...Object.fromEntries(models.map(m => [m.id, m.toSearchData()])),
                 });
             })),
@@ -277,7 +259,8 @@ export default class Connection {
 
             if (!modelsToDelete.includes(currentModel.id)) modelsToDelete.push(currentModel.id);
 
-            const modelToProcessConstructor = this.#getModelConstructorFromId(modelToProcess.id);
+            const modelToProcessConstructor = this.#getModelConstructorFromId(modelToProcess.id).name;
+
             indexActions[modelToProcessConstructor] = indexActions[modelToProcessConstructor] ?? [];
             searchIndexActions[modelToProcessConstructor] = searchIndexActions[modelToProcessConstructor] ?? [];
 
@@ -433,42 +416,55 @@ export default class Connection {
      * @return {Connection}
      */
     transaction() {
-        const transactions = [];
+        const operations = [];
 
-        const engine = CreateTransactionalStorageEngine(transactions, this.#storage);
+        const engine = CreateTransactionalStorageEngine(operations, this.#storage);
 
-        const connection = new this.constructor(engine, this.#cache, Object.values(this.#models));
+        const transaction = new this.constructor(engine, this.#cache, Object.values(this.#models));
 
-        connection.commit = async () => {
+        transaction.commit = async () => {
             try {
-                for (const [index, transaction] of transactions.entries()) {
+                for (const [index, operation] of operations.entries()) {
                     try {
-                        if (transaction.method === 'putModel')
-                            transactions[index].original = await this.#storage.getModel(transaction.args[0].id).catch(() => undefined);
+                        if (operation.method === 'putModel')
+                            operations[index].original = await this.#storage.getModel(operation.args[0].id).catch(() => undefined);
 
-                        if (transaction.method === 'deleteModel')
-                            transactions[index].original = await this.#storage.getModel(transaction.args[0]);
+                        if (operation.method === 'deleteModel')
+                            operations[index].original = await this.#storage.getModel(operation.args[0]);
 
-                        await this.#storage[transaction.method](...transaction.args);
+                        if (operation.method === 'putIndex')
+                            operations[index].original = await this.#storage.getIndex(operation.args[0]);
 
-                        transactions[index].committed = true;
+                        if (operation.method === 'putSearchIndex')
+                            operations[index].original = await this.#storage.getSearchIndex(operation.args[0]);
+
+                        await this.#storage[operation.method](...operation.args);
+
+                        operations[index].committed = true;
                     } catch (error) {
-                        transactions[index].error = error;
+                        operations[index].error = error;
                         throw error;
                     }
                 }
             } catch (error) {
-                await Promise.all(
-                    transactions
-                        .filter(t => t.committed && t.original)
-                        .map(t => this.#storage.putModel(t.original)),
-                );
+                for (const operation of operations) {
+                    if (operation.committed && operation.original) {
+                        if (['putModel', 'deleteModel'].includes(operation.method))
+                            await this.#storage.putModel(operation.original);
+
+                        if (operation.method === 'putIndex')
+                            await this.#storage.putIndex(operation.args[0], operation.original);
+
+                        if (operation.method === 'putSearchIndex')
+                            await this.#storage.putSearchIndex(operation.args[0], operation.original);
+                    }
+                }
 
-                throw new CommitFailedTransactionError(transactions, error);
+                throw new CommitFailedTransactionError(operations, error);
             }
         };
 
-        return connection;
+        return transaction;
     }
 
     /**
@@ -525,13 +521,11 @@ export default class Connection {
                     })),
             )
             .flat()
-            .reduce((accumulator, {containingModel, propertyName, propertyProperty}) => ({
-                ...accumulator,
-                [containingModel]: {
-                    ...accumulator[containingModel] || {},
-                    [propertyName]: propertyProperty,
-                },
-            }), {});
+            .reduce((accumulator, {containingModel, propertyName, propertyProperty}) => {
+                accumulator[containingModel] = accumulator[containingModel] ?? {};
+                accumulator[containingModel][propertyName] = propertyProperty;
+                return accumulator;
+            }, {});
     }
 
     /**
@@ -620,11 +614,11 @@ class TransactionError extends Error {
 export class CommitFailedTransactionError extends TransactionError {
     /**
      *
-     * @param {Array<Transaction>} transactions
+     * @param {Array<Operation>} transactions
      * @param {Error} error
      */
     constructor(transactions, error) {
-        super('Transaction failed to commit.');
+        super('Operation failed to commit.');
         this.transactions = transactions;
         this.error = error;
     }

package/src/engine/storage/HTTPStorageEngine.js

@@ -29,7 +29,7 @@ export default class HTTPStorageEngine extends StorageEngine {
      * Get a model
      * @param {string} id
      * @throws ModelNotFoundStorageEngineError
-     * @return Promise<Model>
+     * @return Promise<Object>
      */
     getModel(id) {
         return this.#processFetch(this.#generateURL([id]), this.#getReadOptions())
@@ -43,7 +43,7 @@ export default class HTTPStorageEngine extends StorageEngine {
 
     /**
      * Update a model
-     * @param {object} model
+     * @param {Object} model
      * @throws HTTPRequestFailedError
      * @return Promise<void>
      */
@@ -75,7 +75,7 @@ export default class HTTPStorageEngine extends StorageEngine {
     /**
      * Get a model's index data
      * @param {Model.constructor} modelConstructor
-     * @return Promise<void>
+     * @return Promise<Record<String, Object>>
      */
     getIndex(modelConstructor) {
         return this.#processFetch(
@@ -88,7 +88,7 @@ export default class HTTPStorageEngine extends StorageEngine {
     /**
      * Put a model's index data
      * @param {Model.constructor} modelConstructor
-     * @param {object} index
+     * @param {Record<String, Object>} index
      * @throws MethodNotImplementedStorageEngineError
      * @return Promise<void>
      */
@@ -103,7 +103,7 @@ export default class HTTPStorageEngine extends StorageEngine {
      * Get a model's raw search index data
      * @param {Model.constructor} modelConstructor
      * @throws MethodNotImplementedStorageEngineError
-     * @return Promise<object>
+     * @return Promise<Record<String, Object>>
      */
     getSearchIndex(modelConstructor) {
         return this.#processFetch(

package/src/engine/storage/S3StorageEngine.js

@@ -48,7 +48,7 @@ class S3StorageEngine extends StorageEngine {
 
     /**
      * Upload an object to S3
-     * @param {object} model - The model object to upload.
+     * @param {Object} model - The model object to upload.
      * @returns {Promise<void>}
      */
     async putModel(model) {
@@ -87,7 +87,7 @@ class S3StorageEngine extends StorageEngine {
      * Get a model's index data
      * @param {Model.constructor} modelConstructor
      * @throws MethodNotImplementedStorageEngineError
-     * @return Promise<object>
+     * @return Promise<Record<String, Object>>
      */
     async getIndex(modelConstructor) {
         const Key = this.#generatePath([modelConstructor.name, '_index.json']);
@@ -106,7 +106,7 @@ class S3StorageEngine extends StorageEngine {
     /**
      * Put a model's index data
      * @param {Model.constructor} modelConstructor
-     * @param {object} index
+     * @param {Record<String, Object>} index
      * @throws MethodNotImplementedStorageEngineError
      * @return Promise<void>
      */

package/src/engine/storage/StorageEngine.js

@@ -1,5 +1,3 @@
-import {Transaction} from '../../Connection.js';
-
 export default class StorageEngine {
     /**
      * @param {Object} configuration
@@ -13,7 +11,7 @@ export default class StorageEngine {
      * @param {string} _id
      * @throws MethodNotImplementedStorageEngineError
      * @throws ModelNotFoundStorageEngineError
-     * @return Promise<Model>
+     * @return Promise<Object>
      */
     getModel(_id) {
         return Promise.reject(new MethodNotImplementedStorageEngineError('getModel', this));
@@ -21,7 +19,7 @@ export default class StorageEngine {
 
     /**
      * Update a model
-     * @param {object} _model
+     * @param {Object} _model
      * @throws MethodNotImplementedStorageEngineError
      * @return Promise<void>
      */
@@ -44,7 +42,7 @@ export default class StorageEngine {
      * Get a model's index data
      * @param {Model.constructor} _modelConstructor
      * @throws MethodNotImplementedStorageEngineError
-     * @return Promise<void>
+     * @return Promise<Record<String, Object>>
      */
     getIndex(_modelConstructor) {
         return Promise.reject(new MethodNotImplementedStorageEngineError('getIndex', this));
@@ -53,7 +51,7 @@ export default class StorageEngine {
     /**
      * Put a model's index data
      * @param {Model.constructor} _modelConstructor
-     * @param {object} _data
+     * @param {Record<String, Object>} _data
      * @throws MethodNotImplementedStorageEngineError
      * @return Promise<void>
      */
@@ -65,7 +63,7 @@ export default class StorageEngine {
      * Get a model's raw search index data
      * @param {Model.constructor} _modelConstructor
      * @throws MethodNotImplementedStorageEngineError
-     * @return Promise<object>
+     * @return Promise<Record<String, Object>>
      */
     getSearchIndex(_modelConstructor) {
         return Promise.reject(new MethodNotImplementedStorageEngineError('getSearchIndex', this));
@@ -76,7 +74,7 @@ export default class StorageEngine {
      * @param {Model.constructor} _constructor
      * @param {Record<string, object>} _index
      * @throws MethodNotImplementedStorageEngineError
-     * @return Promise<void>
+     * @return Promise<Record<String, Object>>
      */
     putSearchIndex(_constructor, _index) {
         return Promise.reject(new MethodNotImplementedStorageEngineError('putSearchIndex', this));
@@ -142,32 +140,50 @@ export class DeleteHasUnintendedConsequencesStorageEngineError extends StorageEn
     }
 }
 
+/**
+ * Represents a transactional operation to be executed, typically queued and later committed.
+ *
+ * Stores the method to invoke, the arguments to apply, and tracks the result or error state
+ * of the transaction once it's processed.
+ *
+ * @class Operation
+ */
+export class Operation {
+    constructor(method, ...args) {
+        this.method = method;
+        this.args = args;
+        this.original = undefined;
+        this.error = undefined;
+        this.committed = false;
+    }
+}
+
 /**
  *
- * @param {Array<Transaction>} transactions
+ * @param {Array<Operation>} transactions
  * @param {StorageEngine} engine
  * @return {StorageEngine}
  */
-export function CreateTransactionalStorageEngine(transactions, engine) {
+export function CreateTransactionalStorageEngine(operations, engine) {
     const transactionalEngine = Object.create(engine);
 
     transactionalEngine.putModel = (...args) => {
-        transactions.push(new Transaction('putModel', ...args));
+        operations.push(new Operation('putModel', ...args));
         return Promise.resolve();
     };
 
     transactionalEngine.deleteModel = (...args) => {
-        transactions.push(new Transaction('deleteModel', ...args));
+        operations.push(new Operation('deleteModel', ...args));
         return Promise.resolve();
     };
 
     transactionalEngine.putIndex = (...args) => {
-        transactions.push(new Transaction('putIndex', ...args));
+        operations.push(new Operation('putIndex', ...args));
         return Promise.resolve();
     };
 
     transactionalEngine.putSearchIndex = (...args) => {
-        transactions.push(new Transaction('putSearchIndex', ...args));
+        operations.push(new Operation('putSearchIndex', ...args));
         return Promise.resolve();
     };