@twin.org/entity-storage-connector-scylladb 0.0.1 → 0.0.2-next.10

package/README.md

@@ -13,7 +13,7 @@ npm install @twin.org/entity-storage-connector-scylladb
 The tests developed are functional tests and need an instance of ScyllaDB up and running. To run ScyllaDB locally:
 
 ```shell
-docker run -p 9042:9042 --name twin-entity-storage-scylla --hostname scylla -d scylladb/scylla:5.4.9 --smp 1
+docker run -p 9500:9042 --name twin-entity-storage-scylladb --hostname scylla -d scylladb/scylla:5.4.9 --smp 1
 ```
 
 Afterwards you can run the tests as follows:

package/dist/cjs/index.cjs

@@ -2,7 +2,6 @@
 
 var core = require('@twin.org/core');
 var entity = require('@twin.org/entity');
-var loggingModels = require('@twin.org/logging-models');
 var cassandraDriver = require('cassandra-driver');
 
 // Copyright 2024 IOTA Stiftung.
@@ -12,15 +11,14 @@ var cassandraDriver = require('cassandra-driver');
  */
 class AbstractScyllaDBConnector {
     /**
-     * Limit the number of entities when finding.
-     * @internal
+     * Runtime name for the class.
      */
-    static PAGE_SIZE = 40;
+    static CLASS_NAME = "AbstractScyllaDBConnector";
     /**
-     * Runtime name for the class.
+     * Limit the number of entities when finding.
      * @internal
      */
-    CLASS_NAME;
+    static _DEFAULT_LIMIT = 40;
     /**
      * The name of the database table.
      * @internal
@@ -32,7 +30,7 @@ class AbstractScyllaDBConnector {
      */
     _config;
     /**
-     * The logging connector.
+     * The logging component.
      * @internal
      */
     _logging;
@@ -49,22 +47,18 @@ class AbstractScyllaDBConnector {
     /**
      * Create a new instance of AbstractScyllaDBConnector.
      * @param options The options for the connector.
-     * @param options.loggingConnectorType The type of logging connector to use, defaults to no logging.
+     * @param options.loggingComponentType The type of logging component to use, defaults to no logging.
      * @param options.entitySchema The name of the entity schema.
      * @param options.config The configuration for the connector.
-     * @param className The name of the derived class.
-     */
-    constructor(options, className) {
-        this.CLASS_NAME = className;
-        core.Guards.object(this.CLASS_NAME, "options", options);
-        core.Guards.stringValue(this.CLASS_NAME, "options.entitySchema", options.entitySchema);
-        core.Guards.object(this.CLASS_NAME, "options.config", options.config);
-        core.Guards.arrayValue(this.CLASS_NAME, "options.config.hosts", options.config.hosts);
-        core.Guards.stringValue(this.CLASS_NAME, "options.config.localDataCenter", options.config.localDataCenter);
-        core.Guards.stringValue(this.CLASS_NAME, "options.config.keyspace", options.config.keyspace);
-        if (core.Is.stringValue(options.loggingConnectorType)) {
-            this._logging = loggingModels.LoggingConnectorFactory.get(options.loggingConnectorType);
-        }
+     */
+    constructor(options) {
+        core.Guards.object(AbstractScyllaDBConnector.CLASS_NAME, "options", options);
+        core.Guards.stringValue(AbstractScyllaDBConnector.CLASS_NAME, "options.entitySchema", options.entitySchema);
+        core.Guards.object(AbstractScyllaDBConnector.CLASS_NAME, "options.config", options.config);
+        core.Guards.arrayValue(AbstractScyllaDBConnector.CLASS_NAME, "options.config.hosts", options.config.hosts);
+        core.Guards.stringValue(AbstractScyllaDBConnector.CLASS_NAME, "options.config.localDataCenter", options.config.localDataCenter);
+        core.Guards.stringValue(AbstractScyllaDBConnector.CLASS_NAME, "options.config.keyspace", options.config.keyspace);
+        this._logging = core.ComponentFactory.getIfExists(options.loggingComponentType ?? "logging");
         this._entitySchema = entity.EntitySchemaFactory.get(options.entitySchema);
         this._primaryKey = entity.EntitySchemaHelper.getPrimaryKey(this._entitySchema);
         this._config = options.config;
@@ -85,7 +79,7 @@ class AbstractScyllaDBConnector {
      * @returns The object if it can be found or undefined.
      */
     async get(id, secondaryIndex, conditions) {
-        core.Guards.stringValue(this.CLASS_NAME, "id", id);
+        core.Guards.stringValue(AbstractScyllaDBConnector.CLASS_NAME, "id", id);
         let connection;
         try {
             const indexField = secondaryIndex ?? this._primaryKey?.property;
@@ -95,7 +89,7 @@ class AbstractScyllaDBConnector {
             }
             await this._logging?.log({
                 level: "info",
-                source: this.CLASS_NAME,
+                source: AbstractScyllaDBConnector.CLASS_NAME,
                 ts: Date.now(),
                 message: "sql",
                 data: { sql }
@@ -107,7 +101,7 @@ class AbstractScyllaDBConnector {
             }
         }
         catch (error) {
-            throw new core.GeneralError(this.CLASS_NAME, "getFailed", {
+            throw new core.GeneralError(AbstractScyllaDBConnector.CLASS_NAME, "getFailed", {
                 id
             }, error);
         }
@@ -120,15 +114,15 @@ class AbstractScyllaDBConnector {
      * @param conditions The conditions to match for the entities.
      * @param sortProperties The optional sort order.
      * @param properties The optional properties to return, defaults to all.
-     * @param cursor The cursor to request the next page of entities.
-     * @param pageSize The suggested number of entities to return in each chunk, in some scenarios can return a different amount.
+     * @param cursor The cursor to request the next chunk of entities.
+     * @param limit The suggested number of entities to return in each chunk, in some scenarios can return a different amount.
      * @returns All the entities for the storage matching the conditions,
      * and a cursor which can be used to request more entities.
      */
-    async query(conditions, sortProperties, properties, cursor, pageSize) {
+    async query(conditions, sortProperties, properties, cursor, limit) {
         let connection;
         try {
-            let returnSize = pageSize ?? AbstractScyllaDBConnector.PAGE_SIZE;
+            let returnSize = limit ?? AbstractScyllaDBConnector._DEFAULT_LIMIT;
             let sql = `SELECT * FROM "${this._fullTableName}"`;
             if (core.Is.array(properties)) {
                 const fields = [];
@@ -220,7 +214,7 @@ class AbstractScyllaDBConnector {
             }
             await this._logging?.log({
                 level: "info",
-                source: this.CLASS_NAME,
+                source: AbstractScyllaDBConnector.CLASS_NAME,
                 ts: Date.now(),
                 message: "sql",
                 data: { sql }
@@ -236,7 +230,7 @@ class AbstractScyllaDBConnector {
             };
         }
         catch (error) {
-            throw new core.GeneralError(this.CLASS_NAME, "findFailed", { table: this._fullTableName }, error);
+            throw new core.GeneralError(AbstractScyllaDBConnector.CLASS_NAME, "findFailed", { table: this._fullTableName }, error);
         }
         finally {
             await this.closeConnection(connection);
@@ -253,7 +247,10 @@ class AbstractScyllaDBConnector {
         const client = new cassandraDriver.Client({
             contactPoints: this._config.hosts,
             localDataCenter: this._config.localDataCenter,
-            keyspace: skipKeySpace ? undefined : this._config.keyspace
+            keyspace: skipKeySpace ? undefined : this._config.keyspace,
+            protocolOptions: {
+                port: this._config.port
+            }
         });
         await client.connect();
         return client;
@@ -278,13 +275,13 @@ class AbstractScyllaDBConnector {
      * @returns The rows.
      * @internal
      */
-    async queryDB(connection, sql, params, pageState, pageSize) {
+    async queryDB(connection, sql, params, pageState, limit) {
         return new Promise((resolve, reject) => {
             const rows = [];
             connection.eachRow(sql, params, {
                 prepare: true,
                 autoPage: false,
-                fetchSize: pageSize ?? AbstractScyllaDBConnector.PAGE_SIZE,
+                fetchSize: limit ?? AbstractScyllaDBConnector._DEFAULT_LIMIT,
                 pageState
             }, (n, row) => {
                 rows.push(row);
@@ -339,7 +336,7 @@ class AbstractScyllaDBConnector {
                 return JSON.parse(value);
             }
             catch {
-                throw new core.GeneralError(this.CLASS_NAME, "parseJSONFailed", {
+                throw new core.GeneralError(AbstractScyllaDBConnector.CLASS_NAME, "parseJSONFailed", {
                     name: fieldDescriptor.property,
                     value
                 });
@@ -359,7 +356,6 @@ class AbstractScyllaDBConnector {
      */
     propertyToDbValue(value, fieldDescriptor) {
         if (fieldDescriptor) {
-            // eslint-disable-next-line no-constant-condition
             if (fieldDescriptor.type === "string" && fieldDescriptor.format === "json") {
                 return core.Is.empty(value) ? "null" : this.jsonWrap(value);
             }
@@ -408,7 +404,6 @@ class AbstractScyllaDBConnector {
      */
     jsonWrap(value) {
         let json = JSON.stringify(value);
-        // eslint-disable-next-line no-control-regex
         json = json.replace(/[\b\0\t\n\r\u001A\\]/g, s => {
             switch (s) {
                 case "\0":
@@ -440,24 +435,25 @@ class ScyllaDBTableConnector extends AbstractScyllaDBConnector {
     /**
      * Runtime name for the class.
      */
-    CLASS_NAME = "ScyllaDBTableConnector";
+    static CLASS_NAME = "ScyllaDBTableConnector";
     /**
      * Create a new instance of ScyllaDBTableConnector.
      * @param options The options for the connector.
      */
+    // eslint-disable-next-line @typescript-eslint/no-useless-constructor
     constructor(options) {
-        super(options, "ScyllaDBTableConnector");
+        super(options);
     }
     /**
      * Bootstrap the component by creating and initializing any resources it needs.
-     * @param nodeLoggingConnectorType The node logging connector type, defaults to "node-logging".
+     * @param nodeLoggingComponentType The node logging component type.
      * @returns True if the bootstrapping process was successful.
      */
-    async bootstrap(nodeLoggingConnectorType) {
-        const nodeLogging = loggingModels.LoggingConnectorFactory.getIfExists(nodeLoggingConnectorType ?? "node-logging");
+    async bootstrap(nodeLoggingComponentType) {
+        const nodeLogging = core.ComponentFactory.getIfExists(nodeLoggingComponentType);
         nodeLogging?.log({
             level: "info",
-            source: this.CLASS_NAME,
+            source: ScyllaDBTableConnector.CLASS_NAME,
             ts: Date.now(),
             message: "tableCreating",
             data: { table: this._fullTableName }
@@ -485,7 +481,7 @@ class ScyllaDBTableConnector extends AbstractScyllaDBConnector {
 																		"${subTypeSchemaRef}" (${typeFields.join(",")})`;
                         await nodeLogging?.log({
                             level: "info",
-                            source: this.CLASS_NAME,
+                            source: ScyllaDBTableConnector.CLASS_NAME,
                             ts: Date.now(),
                             message: "sql",
                             data: { sql }
@@ -493,7 +489,7 @@ class ScyllaDBTableConnector extends AbstractScyllaDBConnector {
                         await this.execute(dbConnection, sql);
                         await nodeLogging?.log({
                             level: "info",
-                            source: this.CLASS_NAME,
+                            source: ScyllaDBTableConnector.CLASS_NAME,
                             ts: Date.now(),
                             message: "typeCreated",
                             data: { typeName: subTypeSchemaRef }
@@ -523,7 +519,7 @@ class ScyllaDBTableConnector extends AbstractScyllaDBConnector {
             const sql = `CREATE TABLE IF NOT EXISTS "${this._fullTableName}" (${fields.join(", ")})`;
             await nodeLogging?.log({
                 level: "info",
-                source: this.CLASS_NAME,
+                source: ScyllaDBTableConnector.CLASS_NAME,
                 ts: Date.now(),
                 message: "sql",
                 data: { sql }
@@ -531,7 +527,7 @@ class ScyllaDBTableConnector extends AbstractScyllaDBConnector {
             await this.execute(dbConnection, sql);
             await nodeLogging?.log({
                 level: "info",
-                source: this.CLASS_NAME,
+                source: ScyllaDBTableConnector.CLASS_NAME,
                 ts: Date.now(),
                 message: "tableCreated",
                 data: { table: this._fullTableName }
@@ -541,7 +537,7 @@ class ScyllaDBTableConnector extends AbstractScyllaDBConnector {
             if (core.BaseError.isErrorCode(err, "ResourceInUseException")) {
                 await nodeLogging?.log({
                     level: "info",
-                    source: this.CLASS_NAME,
+                    source: ScyllaDBTableConnector.CLASS_NAME,
                     ts: Date.now(),
                     message: "tableExists",
                     data: { table: this._fullTableName }
@@ -550,7 +546,7 @@ class ScyllaDBTableConnector extends AbstractScyllaDBConnector {
             else {
                 await nodeLogging?.log({
                     level: "error",
-                    source: this.CLASS_NAME,
+                    source: ScyllaDBTableConnector.CLASS_NAME,
                     ts: Date.now(),
                     message: "tableCreateFailed",
                     error: err,
@@ -567,7 +563,7 @@ class ScyllaDBTableConnector extends AbstractScyllaDBConnector {
      * @param conditions The optional conditions to match for the entities.
      */
     async set(entity$1, conditions) {
-        core.Guards.object(this.CLASS_NAME, "entity", entity$1);
+        core.Guards.object(ScyllaDBTableConnector.CLASS_NAME, "entity", entity$1);
         entity.EntitySchemaHelper.validateEntity(entity$1, this.getSchema());
         let connection;
         const id = entity$1[this._primaryKey?.property];
@@ -596,7 +592,7 @@ class ScyllaDBTableConnector extends AbstractScyllaDBConnector {
             const sql = `UPDATE "${this._fullTableName}" SET ${updateValues.join(",")}${conditionString}`;
             await this._logging?.log({
                 level: "info",
-                source: this.CLASS_NAME,
+                source: ScyllaDBTableConnector.CLASS_NAME,
                 ts: Date.now(),
                 message: "sql",
                 data: { sql }
@@ -605,7 +601,7 @@ class ScyllaDBTableConnector extends AbstractScyllaDBConnector {
             await this.execute(connection, sql, propValues);
         }
         catch (error) {
-            throw new core.GeneralError(this.CLASS_NAME, "entityStorage.setFailed", {
+            throw new core.GeneralError(ScyllaDBTableConnector.CLASS_NAME, "setFailed", {
                 id
             }, error);
         }
@@ -619,7 +615,7 @@ class ScyllaDBTableConnector extends AbstractScyllaDBConnector {
      * @param conditions The optional conditions to match for the entities.
      */
     async remove(id, conditions) {
-        core.Guards.stringValue(this.CLASS_NAME, "id", id);
+        core.Guards.stringValue(ScyllaDBTableConnector.CLASS_NAME, "id", id);
         let connection;
         try {
             conditions ??= [];
@@ -628,16 +624,16 @@ class ScyllaDBTableConnector extends AbstractScyllaDBConnector {
             const sql = `DELETE FROM "${this._fullTableName}" WHERE ${sqlCondition}`;
             await this._logging?.log({
                 level: "info",
-                source: this.CLASS_NAME,
+                source: ScyllaDBTableConnector.CLASS_NAME,
                 ts: Date.now(),
-                message: "entityStorage.sqlRemove",
+                message: "sql",
                 data: { sql }
             });
             connection = await this.openConnection();
             await this.execute(connection, sql, conditionValues);
         }
         catch (error) {
-            throw new core.GeneralError(this.CLASS_NAME, "removeFailed", {
+            throw new core.GeneralError(ScyllaDBTableConnector.CLASS_NAME, "removeFailed", {
                 id
             }, error);
         }
@@ -655,7 +651,7 @@ class ScyllaDBTableConnector extends AbstractScyllaDBConnector {
             await connection.execute(`DROP TABLE IF EXISTS "${this._fullTableName}"`);
         }
         catch (error) {
-            throw new core.GeneralError(this.CLASS_NAME, "dropTableFailed", { table: this._fullTableName }, error);
+            throw new core.GeneralError(ScyllaDBTableConnector.CLASS_NAME, "dropTableFailed", { table: this._fullTableName }, error);
         }
         finally {
             await this.closeConnection(connection);
@@ -671,7 +667,7 @@ class ScyllaDBTableConnector extends AbstractScyllaDBConnector {
             await connection.execute(`TRUNCATE TABLE "${this._fullTableName}"`);
         }
         catch (error) {
-            throw new core.GeneralError(this.CLASS_NAME, "truncateTableFailed", { table: this._fullTableName }, error);
+            throw new core.GeneralError(ScyllaDBTableConnector.CLASS_NAME, "truncateTableFailed", { table: this._fullTableName }, error);
         }
         finally {
             await this.closeConnection(connection);
@@ -736,7 +732,7 @@ class ScyllaDBTableConnector extends AbstractScyllaDBConnector {
                 break;
             case "object":
                 if (!logicalField.itemTypeRef) {
-                    throw new core.GeneralError(this.CLASS_NAME, "itemTypeNotDefined", {
+                    throw new core.GeneralError(ScyllaDBTableConnector.CLASS_NAME, "itemTypeNotDefined", {
                         type: logicalField.type,
                         table: this._fullTableName
                     });
@@ -745,7 +741,7 @@ class ScyllaDBTableConnector extends AbstractScyllaDBConnector {
                 break;
             case "array":
                 if (!logicalField.itemType && !logicalField.itemTypeRef) {
-                    throw new core.GeneralError(this.CLASS_NAME, "itemTypeNotDefined", {
+                    throw new core.GeneralError(ScyllaDBTableConnector.CLASS_NAME, "itemTypeNotDefined", {
                         type: logicalField.type,
                         table: this._fullTableName
                     });
@@ -791,7 +787,7 @@ class ScyllaDBViewConnector extends AbstractScyllaDBConnector {
     /**
      * Runtime name for the class.
      */
-    CLASS_NAME = "ScyllaDBViewConnector";
+    static CLASS_NAME = "ScyllaDBViewConnector";
     /**
      * The view descriptor.
      * @internal
@@ -809,10 +805,10 @@ class ScyllaDBViewConnector extends AbstractScyllaDBConnector {
     constructor(options) {
         // We need this conversion so that types can match in the superclass and reuse the get method
         super({
-            loggingConnectorType: options.loggingConnectorType,
+            loggingComponentType: options.loggingComponentType,
             entitySchema: options.viewSchema,
             config: options.config
-        }, "ScyllaDBViewConnector");
+        });
         this._viewSchema = entity.EntitySchemaHelper.getSchema(options.viewSchema);
         // We need the underlying class to use the view name for lookups
         // so substitute the view name for the entity name
@@ -822,14 +818,14 @@ class ScyllaDBViewConnector extends AbstractScyllaDBConnector {
     }
     /**
      * Bootstrap the component by creating and initializing any resources it needs.
-     * @param nodeLoggingConnectorType The node logging connector type, defaults to "node-logging".
+     * @param nodeLoggingComponentType The node logging component type.
      * @returns True if the bootstrapping process was successful.
      */
-    async bootstrap(nodeLoggingConnectorType) {
-        const nodeLogging = loggingModels.LoggingConnectorFactory.getIfExists(nodeLoggingConnectorType ?? "node-logging");
+    async bootstrap(nodeLoggingComponentType) {
+        const nodeLogging = core.ComponentFactory.getIfExists(nodeLoggingComponentType);
         nodeLogging?.log({
             level: "info",
-            source: this.CLASS_NAME,
+            source: ScyllaDBViewConnector.CLASS_NAME,
             ts: Date.now(),
             message: "viewCreating",
             data: { view: this._fullTableName }
@@ -852,7 +848,7 @@ class ScyllaDBViewConnector extends AbstractScyllaDBConnector {
             await this.execute(dbConnection, sql);
             nodeLogging?.log({
                 level: "info",
-                source: this.CLASS_NAME,
+                source: ScyllaDBViewConnector.CLASS_NAME,
                 ts: Date.now(),
                 message: "viewCreated",
                 data: { view: this._fullTableName }
@@ -862,7 +858,7 @@ class ScyllaDBViewConnector extends AbstractScyllaDBConnector {
             if (core.BaseError.isErrorCode(err, "ResourceInUseException")) {
                 nodeLogging?.log({
                     level: "info",
-                    source: this.CLASS_NAME,
+                    source: ScyllaDBViewConnector.CLASS_NAME,
                     ts: Date.now(),
                     message: "viewExists",
                     data: { view: this._fullTableName }
@@ -871,7 +867,7 @@ class ScyllaDBViewConnector extends AbstractScyllaDBConnector {
             else {
                 nodeLogging?.log({
                     level: "error",
-                    source: this.CLASS_NAME,
+                    source: ScyllaDBViewConnector.CLASS_NAME,
                     ts: Date.now(),
                     message: "viewCreateFailed",
                     error: err,
@@ -887,14 +883,18 @@ class ScyllaDBViewConnector extends AbstractScyllaDBConnector {
      * @param entity The entity to set.
      */
     async set(entity) {
-        throw new core.NotSupportedError(this.CLASS_NAME, "set", {});
+        throw new core.NotSupportedError(ScyllaDBViewConnector.CLASS_NAME, "notSupported", {
+            methodName: "set"
+        });
     }
     /**
      * Delete the entity.
      * @param id The id of the entity to remove.
      */
     async remove(id) {
-        throw new core.NotSupportedError(this.CLASS_NAME, "remove", {});
+        throw new core.NotSupportedError(ScyllaDBViewConnector.CLASS_NAME, "notSupported", {
+            methodName: "remove"
+        });
     }
 }