@reldens/storage 0.90.0 → 0.91.0

package/index.js

@@ -20,6 +20,7 @@ const { PrismaDriver } = require('./lib/prisma/prisma-driver');
 const { PrismaDataServer } = require('./lib/prisma/prisma-data-server');
 const { PrismaSchemaGenerator } = require('./lib/prisma/prisma-schema-generator');
 const { PrismaClientLoader } = require('./lib/prisma/prisma-client-loader');
+const { RELATION_PREFIX } = require('./lib/relation-key');
 
 module.exports = {
     // base:
@@ -52,5 +53,7 @@ module.exports = {
     EntitiesGenerator,
     EntityProperties,
     TypeMapper,
-    MySQLTablesProvider
+    MySQLTablesProvider,
+    // relation key:
+    RELATION_PREFIX
 };

package/lib/generators/entities-generation.js

@@ -8,6 +8,7 @@ const { FileHandler } = require('@reldens/server-utils');
 const { Logger, sc } = require('@reldens/utils');
 const { TypeMapper } = require('../type-mapper');
 const { BaseGenerator } = require('./base-generator');
+const { RELATION_PREFIX } = require('../relation-key');
 
 class EntitiesGeneration extends BaseGenerator
 {
@@ -18,6 +19,7 @@ class EntitiesGeneration extends BaseGenerator
         this.entitiesFolder = sc.get(props, 'entitiesFolder', '');
         this.templatePath = sc.get(props, 'templatePath', '');
         this.generatedEntities = {};
+        this.removeIdFromMultipleRelations = sc.get(props, 'removeIdFromMultipleRelations', true);
     }
 
     async generateEntityFile(tableName, tableData)
@@ -152,20 +154,49 @@ class EntitiesGeneration extends BaseGenerator
         return false;
     }
 
+    countReferencesPerTable(columns)
+    {
+        let counts = {};
+        for(let columnName of Object.keys(columns)){
+            let column = columns[columnName];
+            if(!sc.hasOwn(column, 'referencedTable')){
+                continue;
+            }
+            if(!counts[column.referencedTable]){
+                counts[column.referencedTable] = 0;
+            }
+            counts[column.referencedTable]++;
+        }
+        return counts;
+    }
+
+    generateForwardRelationKey(referencedTable, columnName, referenceCounts)
+    {
+        if(1 === referenceCounts[referencedTable]){
+            return RELATION_PREFIX+referencedTable;
+        }
+        let columnSuffix = columnName;
+        if(this.removeIdFromMultipleRelations){
+            columnSuffix = columnName.replace(/_id$/i, '');
+        }
+        return RELATION_PREFIX+referencedTable+'_'+columnSuffix;
+    }
+
     generatePropertiesConfig(columns, titleProperty, primaryKeyColumn)
     {
+        let referenceCounts = this.countReferencesPerTable(columns);
         let propertiesConfig = [];
         for(let columnName of Object.keys(columns)){
             let column = columns[columnName];
             let propertyKey = titleProperty && titleProperty === columnName ? '[titleProperty]' : columnName;
             let isPrimaryKey = primaryKeyColumn && primaryKeyColumn === columnName;
             if(isPrimaryKey){
-                let props = this.getPropertyAttributes(column);
+                let props = this.getPropertyAttributes(column, columnName, referenceCounts);
                 props.unshift('isId: true');
                 propertiesConfig.push(propertyKey+': {\n                '+props.join(',\n                ')+ '\n            }');
                 continue;
             }
-            let props = this.getPropertyAttributes(column);
+            let props = this.getPropertyAttributes(column, columnName, referenceCounts);
             if(0 === props.length){
                 let dbType = column.type.toLowerCase();
                 propertiesConfig.push(propertyKey+': {\n                dbType: \''+dbType+'\'\n            }');
@@ -178,21 +209,24 @@ class EntitiesGeneration extends BaseGenerator
         return propertiesConfig.join(',\n            ');
     }
 
-    getPropertyAttributes(column)
+    getPropertyAttributes(column, columnName, referenceCounts)
     {
         let props = [];
         let type = column.type.toLowerCase();
-        this.addTypeAttribute(props, column, type);
+        this.addTypeAttribute(props, column, type, columnName, referenceCounts);
         this.addRequiredAttribute(props, column);
         props.push('dbType: \''+type+'\'');
         return props;
     }
 
-    addTypeAttribute(props, column, type)
+    addTypeAttribute(props, column, type, columnName, referenceCounts)
     {
         if(column.referencedTable){
             props.push('type: \'reference\'');
-            props.push('reference: \''+this.getReferenceTable(column)+'\'');
+            let referenceTable = this.getReferenceTable(column);
+            props.push('reference: \''+referenceTable+'\'');
+            let alias = this.generateForwardRelationKey(referenceTable, columnName, referenceCounts);
+            props.push('alias: \''+alias+'\'');
             return;
         }
         if('date' === type || 'datetime' === type || 'timestamp' === type){

package/lib/generators/models-generation.js

@@ -8,6 +8,7 @@ const { FileHandler } = require('@reldens/server-utils');
 const { Logger, sc } = require('@reldens/utils');
 const { TypeMapper } = require('../type-mapper');
 const { BaseGenerator } = require('./base-generator');
+const { RELATION_PREFIX } = require('../relation-key');
 
 class ModelsGeneration extends BaseGenerator
 {
@@ -249,13 +250,13 @@ class ModelsGeneration extends BaseGenerator
     generatePrismaReverseRelationKey(relatedTable, prismaName, tableName, referenceCount)
     {
         if(1 === referenceCount){
-            return 'related_'+relatedTable;
+            return RELATION_PREFIX+relatedTable;
         }
         let columnHint = this.extractColumnHintFromPrismaName(prismaName, relatedTable, tableName);
         if(columnHint){
-            return 'related_'+relatedTable+'_'+columnHint;
+            return RELATION_PREFIX+relatedTable+'_'+columnHint;
         }
-        return 'related_'+relatedTable;
+        return RELATION_PREFIX+relatedTable;
     }
 
     extractColumnHintFromPrismaName(prismaName, relatedTable, tableName)
@@ -420,25 +421,25 @@ class ModelsGeneration extends BaseGenerator
     generateForwardRelationKey(referencedTable, columnName, referenceCounts)
     {
         if(1 === referenceCounts[referencedTable]){
-            return 'related_'+referencedTable;
+            return RELATION_PREFIX+referencedTable;
         }
         let columnSuffix = columnName;
         if(this.removeIdFromMultipleRelations){
             columnSuffix = columnName.replace(/_id$/i, '');
         }
-        return 'related_'+referencedTable+'_'+columnSuffix;
+        return RELATION_PREFIX+referencedTable+'_'+columnSuffix;
     }
 
     generateReverseRelationKey(referencingTable, columnName, referenceCount)
     {
         if(1 === referenceCount){
-            return 'related_'+referencingTable;
+            return RELATION_PREFIX+referencingTable;
         }
         let columnSuffix = columnName;
         if(this.removeIdFromMultipleRelations){
             columnSuffix = columnName.replace(/_id$/i, '');
         }
-        return 'related_'+referencingTable+'_'+columnSuffix;
+        return RELATION_PREFIX+referencingTable+'_'+columnSuffix;
     }
 
     determineForwardRelationType(tableName, columnName, column)
@@ -578,7 +579,7 @@ class ModelsGeneration extends BaseGenerator
     findMappedByKey(currentTable, referencingTable, reverseRelation)
     {
         if(!this.allTablesData[referencingTable]){
-            return 'related_'+currentTable;
+            return RELATION_PREFIX+currentTable;
         }
         let referencingTableData = this.allTablesData[referencingTable];
         let forwardRelations = this.detectObjectionJsRelations(referencingTable, referencingTableData);
@@ -588,7 +589,7 @@ class ModelsGeneration extends BaseGenerator
                 return forwardKey;
             }
         }
-        return 'related_'+currentTable;
+        return RELATION_PREFIX+currentTable;
     }
 
     generateFkMappings(tableName, tableData, driverKey)

package/lib/objection-js/objection-js-data-server.js

@@ -9,7 +9,7 @@ const { ObjectionJsDriver } = require('./objection-js-driver');
 const { MySQLTablesProvider } = require('../mysql-tables-provider');
 const { Model } = require('objection');
 const Knex = require('knex');
-const { Logger } = require('@reldens/utils');
+const { Logger, sc } = require('@reldens/utils');
 
 class ObjectionJsDataServer extends BaseDataServer
 {
@@ -21,6 +21,16 @@ class ObjectionJsDataServer extends BaseDataServer
         if(!this.rawModel){
             this.rawModel = Model;
         }
+        this.validMySQL2Options = [
+            'authPlugins', 'authSwitchHandler', 'bigNumberStrings', 'charset', 'charsetNumber', 'compress',
+            'connectAttributes', 'connectTimeout', 'database', 'dateStrings', 'debug', 'decimalNumbers',
+            'enableKeepAlive', 'flags', 'host', 'insecureAuth', 'infileStreamFactory', 'isServer',
+            'keepAliveInitialDelay', 'localAddress', 'maxPreparedStatements', 'multipleStatements',
+            'namedPlaceholders', 'nestTables', 'password', 'password1', 'password2', 'password3', 'passwordSha1',
+            'pool', 'port', 'queryFormat', 'rowsAsArray', 'socketPath', 'ssl', 'stream', 'stringifyObjects',
+            'supportBigNumbers', 'timezone', 'trace', 'typeCast', 'uri', 'user', 'disableEval', 'connectionLimit',
+            'maxIdle', 'idleTimeout', 'Promise', 'queueLimit', 'waitForConnections', 'jsonStrings', 'gracefulEnd'
+        ];
     }
 
     async connect()
@@ -28,9 +38,10 @@ class ObjectionJsDataServer extends BaseDataServer
         if(this.initialized){
             return this.initialized;
         }
+        let connectionConfig = this.sanitizeConnectionConfig(this.config);
         this.knex = await Knex({
             client: this.client,
-            connection: this.config,
+            connection: connectionConfig,
             pool: this.poolConfig,
             debug: this.debug,
             multipleStatements: this.multipleStatements
@@ -47,6 +58,20 @@ class ObjectionJsDataServer extends BaseDataServer
         return this.initialized;
     }
 
+    sanitizeConnectionConfig(config)
+    {
+        if('mysql2' !== this.client){
+            return config;
+        }
+        let cleanConfig = {};
+        for(let prop of this.validMySQL2Options){
+            if(sc.hasOwn(config, prop)){
+                cleanConfig[prop] = config[prop];
+            }
+        }
+        return cleanConfig;
+    }
+
     async disconnect()
     {
         if(!this.knex){

package/lib/relation-key.js

@@ -0,0 +1,9 @@
+/**
+ *
+ * Reldens - Relation Key
+ *
+ */
+
+module.exports = {
+    RELATION_PREFIX: process.env.RELDENS_RELATION_PREFIX || 'related_'
+};

package/package.json

@@ -1,7 +1,7 @@
 {
     "name": "@reldens/storage",
     "scope": "@reldens",
-    "version": "0.90.0",
+    "version": "0.91.0",
     "description": "Reldens - Storage",
     "author": "Damian A. Pastorini",
     "license": "MIT",
@@ -59,7 +59,7 @@
         "@reldens/utils": "^0.54.0",
         "knex": "3.1.0",
         "mysql": "2.18.1",
-        "mysql2": "3.16.2",
+        "mysql2": "3.16.3",
         "objection": "3.1.5",
         "prisma": "6.19.2"
     }

package/tests/fixtures/expected-entities/entities/test-products-entity.js

@@ -23,6 +23,7 @@ class TestProductsEntity extends EntityProperties
             category_id: {
                 type: 'reference',
                 reference: 'test_categories',
+                alias: 'related_test_categories',
                 isRequired: true,
                 dbType: 'int'
             },

package/tests/fixtures/expected-entities/entities/test-reviews-entity.js

@@ -23,6 +23,7 @@ class TestReviewsEntity extends EntityProperties
             product_id: {
                 type: 'reference',
                 reference: 'test_products',
+                alias: 'related_test_products',
                 isRequired: true,
                 dbType: 'int'
             },

package/tests/utils/test-helpers.js

@@ -284,7 +284,7 @@ class TestHelpers
             {name: '@prisma/client', version: '6.19.2'},
             {name: 'knex', version: '3.1.0'},
             {name: 'mysql', version: '2.18.1'},
-            {name: 'mysql2', version: '3.16.2'},
+            {name: 'mysql2', version: '3.16.3'},
             {name: 'objection', version: '3.1.5'},
             {name: 'prisma', version: '6.19.2'}
         ];