@decaf-ts/core 0.7.2 → 0.7.4

package/lib/persistence/Adapter.cjs

@@ -13,12 +13,12 @@ exports.Adapter = void 0;
 const db_decorators_1 = require("@decaf-ts/db-decorators");
 const decorator_validation_1 = require("@decaf-ts/decorator-validation");
 const constants_1 = require("./constants.cjs");
-const utils_1 = require("./../utils/index.cjs");
-const ObserverHandler_1 = require("./ObserverHandler.cjs");
 const logging_1 = require("@decaf-ts/logging");
-const utils_2 = require("./../identity/utils.cjs");
+const ObserverHandler_1 = require("./ObserverHandler.cjs");
+const logging_2 = require("@decaf-ts/logging");
 const decoration_1 = require("@decaf-ts/decoration");
 const errors_1 = require("./errors.cjs");
+const ContextualLoggedClass_1 = require("./../utils/ContextualLoggedClass.cjs");
 const flavourResolver = decoration_1.Decoration["flavourResolver"].bind(decoration_1.Decoration);
 decoration_1.Decoration["flavourResolver"] = (obj) => {
     try {
@@ -138,7 +138,7 @@ decoration_1.Decoration["flavourResolver"] = (obj) => {
  *   Adapter --|> Observer
  *   Adapter --|> ErrorParser
  */
-class Adapter extends logging_1.LoggedClass {
+class Adapter extends ContextualLoggedClass_1.ContextualLoggedClass {
     static { this._cache = {}; }
     /**
      * @description Gets the native persistence config
@@ -161,7 +161,7 @@ class Adapter extends logging_1.LoggedClass {
      * @description Gets the repository constructor for this adapter
      * @summary Returns the constructor for creating repositories that work with this adapter
      * @template M - The model type
-     * @return {Constructor<Repository<M, QUERY, Adapter<CONF, CONN, QUERY, FLAGS, CONTEXT>, FLAGS, CONTEXT>>} The repository constructor
+     * @return {Constructor<Repository<any, Adapter<CONF, CONN, QUERY, CONTEXT>>>} The repository constructor
      */
     repository() {
         if (!Adapter._baseRepository)
@@ -262,6 +262,15 @@ class Adapter extends logging_1.LoggedClass {
      */
     // eslint-disable-next-line @typescript-eslint/no-unused-vars
     async initialize(...args) { }
+    /**
+     * @description Creates a sequence generator
+     * @summary Factory method that creates a sequence generator for generating sequential values
+     * @param {SequenceOptions} options - Configuration options for the sequence
+     * @return {Promise<Sequence>} A promise that resolves to a new sequence instance
+     */
+    async Sequence(options) {
+        return new Adapter._baseSequence(options, this);
+    }
     /**
      * @description Creates repository flags for an operation
      * @summary Generates a set of flags that describe a database operation, combining default flags with overrides
@@ -276,12 +285,18 @@ class Adapter extends logging_1.LoggedClass {
     async flags(operation, model, flags, 
     // eslint-disable-next-line @typescript-eslint/no-unused-vars
     ...args) {
+        let log = (flags.logger || logging_2.Logging.for(this.toString()));
+        if (flags.correlationId)
+            log = log.for({ correlationId: flags.correlationId });
         return Object.assign({}, db_decorators_1.DefaultRepositoryFlags, flags, {
-            affectedTables: (0, utils_2.getTableName)(model),
+            affectedTables: (Array.isArray(model) ? model : [model]).map(decorator_validation_1.Model.tableName),
             writeOperation: operation !== db_decorators_1.OperationKeys.READ,
             timestamp: new Date(),
             operation: operation,
-            ignoredValidationProperties: decoration_1.Metadata.validationExceptions(model, operation),
+            ignoredValidationProperties: Array.isArray(model)
+                ? []
+                : decoration_1.Metadata.validationExceptions(model, operation),
+            logger: log,
         });
     }
     /**
@@ -297,7 +312,7 @@ class Adapter extends logging_1.LoggedClass {
      */
     async context(operation, overrides, model, ...args) {
         const log = this.log.for(this.context);
-        log.debug(`Creating new context for ${operation} operation on ${model.name} model with flag overrides: ${JSON.stringify(overrides)}`);
+        log.debug(`Creating new context for ${operation} operation on ${Array.isArray(model) ? model.map((m) => m.name) : model.name} model with flag overrides: ${JSON.stringify(overrides)}`);
         const flags = await this.flags(operation, model, overrides, ...args);
         return new this.Context().accumulate(flags);
     }
@@ -305,38 +320,37 @@ class Adapter extends logging_1.LoggedClass {
      * @description Prepares a model for persistence
      * @summary Converts a model instance into a format suitable for database storage,
      * handling column mapping and separating transient properties
+     * handling column mapping and separating transient properties
      * @template M - The model type
      * @param {M} model - The model instance to prepare
-     * @param pk - The primary key property name
      * @param args - optional args for subclassing purposes
      * @return The prepared data
      */
-    prepare(model, pk, 
-    // eslint-disable-next-line @typescript-eslint/no-unused-vars
-    ...args) {
-        const log = this.log.for(this.prepare);
+    prepare(model, ...args) {
+        const { log } = this.logCtx(args, this.prepare);
         const split = model.segregate();
         const result = Object.entries(split.model).reduce((accum, [key, val]) => {
             if (typeof val === "undefined")
                 return accum;
-            const mappedProp = (0, utils_2.getColumnName)(model, key);
+            const mappedProp = decorator_validation_1.Model.columnName(model.constructor, key);
             if (this.isReserved(mappedProp))
                 throw new db_decorators_1.InternalError(`Property name ${mappedProp} is reserved`);
             accum[mappedProp] = val;
             return accum;
         }, {});
         if (model[constants_1.PersistenceKeys.METADATA]) {
+            // TODO movo to couchdb
             log.silly(`Passing along persistence metadata for ${model[constants_1.PersistenceKeys.METADATA]}`);
             Object.defineProperty(result, constants_1.PersistenceKeys.METADATA, {
                 enumerable: false,
-                writable: false,
+                writable: true,
                 configurable: true,
                 value: model[constants_1.PersistenceKeys.METADATA],
             });
         }
         return {
             record: result,
-            id: model[pk],
+            id: model[decorator_validation_1.Model.pk(model.constructor)],
             transient: split.transient,
         };
     }
@@ -346,29 +360,29 @@ class Adapter extends logging_1.LoggedClass {
      * and reattaching transient properties
      * @template M - The model type
      * @param obj - The database record
-     * @param {string|Constructor<M>} clazz - The model class or name
+     * @param {Constructor<M>} clazz - The model class or name
      * @param pk - The primary key property name
      * @param {string|number|bigint} id - The primary key value
      * @param [transient] - Transient properties to reattach
      * @param [args] - options args for subclassing purposes
      * @return {M} The reconstructed model instance
      */
-    revert(obj, clazz, pk, id, transient, 
-    // eslint-disable-next-line @typescript-eslint/no-unused-vars
-    ...args) {
-        const log = this.log.for(this.revert);
+    revert(obj, clazz, id, transient, ...args) {
+        const { log, ctx } = this.logCtx(args, this.revert);
         const ob = {};
+        const pk = decorator_validation_1.Model.pk(clazz);
         ob[pk] = id;
-        const m = (typeof clazz === "string" ? decorator_validation_1.Model.build(ob, clazz) : new clazz(ob));
+        const m = new clazz(ob);
         log.silly(`Rebuilding model ${m.constructor.name} id ${id}`);
-        const metadata = obj[constants_1.PersistenceKeys.METADATA];
+        const metadata = obj[constants_1.PersistenceKeys.METADATA]; // TODO move to couchdb
         const result = Object.keys(m).reduce((accum, key) => {
             if (key === pk)
                 return accum;
-            accum[key] = obj[(0, utils_2.getColumnName)(accum, key)];
+            accum[key] =
+                obj[decorator_validation_1.Model.columnName(clazz, key)];
             return accum;
         }, m);
-        if (transient) {
+        if (ctx.get("rebuildWithTransient") && transient) {
             log.verbose(`re-adding transient properties: ${Object.keys(transient).join(", ")}`);
             Object.entries(transient).forEach(([key, val]) => {
                 if (key in result)
@@ -377,11 +391,12 @@ class Adapter extends logging_1.LoggedClass {
             });
         }
         if (metadata) {
+            // TODO move to couchdb
             log.silly(`Passing along ${this.flavour} persistence metadata for ${m.constructor.name} id ${id}: ${metadata}`);
             Object.defineProperty(result, constants_1.PersistenceKeys.METADATA, {
                 enumerable: false,
-                configurable: false,
-                writable: false,
+                configurable: true,
+                writable: true,
                 value: metadata,
             });
         }
@@ -396,13 +411,13 @@ class Adapter extends logging_1.LoggedClass {
      * @param {...any[]} args - Additional arguments specific to the adapter implementation
      * @return A promise that resolves to an array of created records
      */
-    async createAll(tableName, id, model, ...args) {
+    async createAll(clazz, id, model, ...args) {
         if (id.length !== model.length)
             throw new db_decorators_1.InternalError("Ids and models must have the same length");
-        const log = this.log.for(this.createAll);
-        log.verbose(`Creating ${id.length} entries ${tableName} table`);
-        log.debug(`pks: ${id}`);
-        return Promise.all(id.map((i, count) => this.create(tableName, i, model[count], ...args)));
+        const { log, ctxArgs } = this.logCtx(args, this.createAll);
+        const tableLabel = decorator_validation_1.Model.tableName(clazz);
+        log.debug(`Creating ${id.length} entries ${tableLabel} table`);
+        return Promise.all(id.map((i, count) => this.create(clazz, i, model[count], ...ctxArgs)));
     }
     /**
      * @description Retrieves multiple records from the database
@@ -412,28 +427,28 @@ class Adapter extends logging_1.LoggedClass {
      * @param {...any[]} args - Additional arguments specific to the adapter implementation
      * @return A promise that resolves to an array of retrieved records
      */
-    async readAll(tableName, id, ...args) {
-        const log = this.log.for(this.readAll);
-        log.verbose(`Reading ${id.length} entries ${tableName} table`);
-        log.debug(`pks: ${id}`);
-        return Promise.all(id.map((i) => this.read(tableName, i, ...args)));
+    async readAll(clazz, id, ...args) {
+        const { log, ctxArgs } = this.logCtx(args, this.readAll);
+        const tableName = decorator_validation_1.Model.tableName(clazz);
+        log.debug(`Reading ${id.length} entries ${tableName} table`);
+        return Promise.all(id.map((i) => this.read(clazz, i, ...ctxArgs)));
     }
     /**
      * @description Updates multiple records in the database
      * @summary Modifies multiple existing records with the given IDs in the specified table
-     * @param {string} tableName - The name of the table to update
+     * @param {Constructor<M>} tableName - The name of the table to update
      * @param {string[]|number[]} id - The identifiers of the records to update
      * @param model - The new data for each record
      * @param {...any[]} args - Additional arguments specific to the adapter implementation
      * @return A promise that resolves to an array of updated records
      */
-    async updateAll(tableName, id, model, ...args) {
+    async updateAll(clazz, id, model, ...args) {
         if (id.length !== model.length)
             throw new db_decorators_1.InternalError("Ids and models must have the same length");
-        const log = this.log.for(this.updateAll);
-        log.verbose(`Updating ${id.length} entries ${tableName} table`);
-        log.debug(`pks: ${id}`);
-        return Promise.all(id.map((i, count) => this.update(tableName, i, model[count], ...args)));
+        const { log, ctxArgs } = this.logCtx(args, this.updateAll);
+        const tableLabel = decorator_validation_1.Model.tableName(clazz);
+        log.debug(`Updating ${id.length} entries ${tableLabel} table`);
+        return Promise.all(id.map((i, count) => this.update(clazz, i, model[count], ...ctxArgs)));
     }
     /**
      * @description Deletes multiple records from the database
@@ -444,10 +459,9 @@ class Adapter extends logging_1.LoggedClass {
      * @return A promise that resolves to an array of deleted records
      */
     async deleteAll(tableName, id, ...args) {
-        const log = this.log.for(this.createAll);
-        log.verbose(`Deleting ${id.length} entries ${tableName} table`);
-        log.debug(`pks: ${id}`);
-        return Promise.all(id.map((i) => this.delete(tableName, i, ...args)));
+        const { log, ctxArgs } = Adapter.logCtx(args, this.deleteAll);
+        log.verbose(`Deleting ${id.length} entries from ${tableName} table`);
+        return Promise.all(id.map((i) => this.delete(tableName, i, ...ctxArgs)));
     }
     /**
      * @description Registers an observer for database events
@@ -464,11 +478,10 @@ class Adapter extends logging_1.LoggedClass {
                 writable: false,
             });
         this.observerHandler.observe(observer, filter);
-        this.log
-            .for(this.observe)
-            .verbose(`Registering new observer ${observer.toString()}`);
+        const log = this.log.for(this.observe);
+        log.verbose(`Registering new observer ${observer.toString()}`);
         if (!this.dispatch) {
-            this.log.for(this.observe).info(`Creating dispatch for ${this.alias}`);
+            log.info(`Creating dispatch for ${this.alias}`);
             this.dispatch = this.Dispatch();
             this.dispatch.observe(this);
         }
@@ -500,9 +513,9 @@ class Adapter extends logging_1.LoggedClass {
     async updateObservers(table, event, id, ...args) {
         if (!this.observerHandler)
             throw new db_decorators_1.InternalError("ObserverHandler not initialized. Did you register any observables?");
-        const log = this.log.for(this.updateObservers);
-        log.verbose(`Updating ${this.observerHandler.count()} observers for adapter ${this.alias}`);
-        await this.observerHandler.updateObservers(this.log, table, event, id, ...args);
+        const { log, ctxArgs } = Adapter.logCtx(args, this.updateObservers);
+        log.verbose(`Updating ${this.observerHandler.count()} observers for adapter ${this.alias}: Event: `);
+        await this.observerHandler.updateObservers(table, event, id, ...ctxArgs);
     }
     /**
      * @description Refreshes data based on a database event
@@ -522,7 +535,7 @@ class Adapter extends logging_1.LoggedClass {
      * @return {string} A string representation of the adapter
      */
     toString() {
-        return `${this.flavour} persistence Adapter`;
+        return `${this.flavour} adapter`;
     }
     /**
      * @description Gets the adapter flavor associated with a model
@@ -553,10 +566,9 @@ class Adapter extends logging_1.LoggedClass {
      * @template CONF - The database driver config
      * @template CONN - The database driver instance
      * @template QUERY - The query type
-     * @template CCONTEXT - The context type
-     * @template FLAGS - The repository flags type
+     * @template CONTEXT - The context type
      * @param {string} flavour - The flavor name of the adapter to retrieve
-     * @return {Adapter<CONF, CONN, QUERY, CONTEXT, FLAGS> | undefined} The adapter instance or undefined if not found
+     * @return {Adapter<CONF, CONN, QUERY, CONTEXT> | undefined} The adapter instance or undefined if not found
      */
     static get(flavour) {
         if (!flavour)
@@ -590,6 +602,9 @@ class Adapter extends logging_1.LoggedClass {
         }
     }
     static decoration() { }
+    static logCtx(args, method) {
+        return super.logCtx(args, method);
+    }
     get client() {
         if (!this._client) {
             this._client = this.getClient();
@@ -629,12 +644,21 @@ class Adapter extends logging_1.LoggedClass {
     migrations() {
         return decoration_1.Metadata.migrationsFor(this);
     }
-    async migrate(migrations = this.migrations()) {
+    async getQueryRunner() {
+        return this;
+    }
+    async migrate(migrations = this.migrations(), ...args) {
+        if (migrations instanceof db_decorators_1.Context) {
+            args = [migrations];
+            migrations = this.migrations();
+        }
+        const { ctx } = Adapter.logCtx(args, this.migrate);
+        const qr = await this.getQueryRunner();
         for (const migration of migrations) {
             try {
                 const m = new migration();
-                await m.up(this, this, this.log);
-                await m.down(this, this, this.log);
+                await m.up(qr, this, ctx);
+                await m.down(qr, this, ctx);
             }
             catch (e) {
                 throw new errors_1.MigrationError(e);
@@ -644,31 +668,31 @@ class Adapter extends logging_1.LoggedClass {
 }
 exports.Adapter = Adapter;
 __decorate([
-    (0, utils_1.final)(),
+    (0, logging_1.final)(),
     __metadata("design:type", Function),
     __metadata("design:paramtypes", [String]),
     __metadata("design:returntype", Promise)
 ], Adapter.prototype, "shutdownProxies", null);
 __decorate([
-    (0, utils_1.final)(),
+    (0, logging_1.final)(),
     __metadata("design:type", Function),
     __metadata("design:paramtypes", [String, Object, Object, Object]),
     __metadata("design:returntype", Promise)
 ], Adapter.prototype, "context", null);
 __decorate([
-    (0, utils_1.final)(),
+    (0, logging_1.final)(),
     __metadata("design:type", Function),
     __metadata("design:paramtypes", [Object, Function]),
     __metadata("design:returntype", void 0)
 ], Adapter.prototype, "observe", null);
 __decorate([
-    (0, utils_1.final)(),
+    (0, logging_1.final)(),
     __metadata("design:type", Function),
     __metadata("design:paramtypes", [Object]),
     __metadata("design:returntype", void 0)
 ], Adapter.prototype, "unObserve", null);
 __decorate([
-    (0, utils_1.final)(),
+    (0, logging_1.final)(),
     __metadata("design:type", Object),
     __metadata("design:paramtypes", [])
 ], Adapter.prototype, "client", null);