From e296b6946bade657d8818cc39e37b50a78a76bed Mon Sep 17 00:00:00 2001 From: Juan Ferrer Toribio Date: Fri, 2 Jun 2023 12:46:57 +0200 Subject: [PATCH] refs #5563 Customizable model name, code refactor --- lib/model-loader.js | 272 +++++++++++++++++++++++++++++++++++++++++ lib/util.js | 26 ++++ mylogger.js | 291 ++------------------------------------------ package-lock.json | 4 +- package.json | 2 +- 5 files changed, 311 insertions(+), 284 deletions(-) create mode 100644 lib/model-loader.js create mode 100644 lib/util.js diff --git a/lib/model-loader.js b/lib/model-loader.js new file mode 100644 index 0000000..c8d09cc --- /dev/null +++ b/lib/model-loader.js @@ -0,0 +1,272 @@ +const path = require('path'); +const {loadConfig, toUpperCamelCase} = require('./util'); + +module.exports = class ModelLoader { + init(conf) { + const configDir = path.join(__dirname, '..'); + const logsConf = this.logsConf = loadConfig(configDir, 'logs'); + const schemaMap = new Map(); + const logMap = new Map(); + + for (const logName in logsConf.logs) { + const logConf = logsConf.logs[logName]; + const schema = logConf.schema || conf.srcDb.database; + const logInfo = { + name: logName, + conf: logConf, + schema, + table: parseTable(logConf.logTable, schema), + mainTable: parseTable(logConf.mainTable, schema) + }; + logMap.set(logName, logInfo); + + const mainTable = addTable(logConf.mainTable, logInfo); + mainTable.isMain = true; + + if (logConf.tables) + for (const tableConf of logConf.tables){ + const table = addTable(tableConf, logInfo); + if (table !== mainTable) { + Object.assign(table, { + main: mainTable, + isMain: false + }); + } + } + } + + function addTable(tableConf, logInfo) { + if (typeof tableConf == 'string') + tableConf = {name: tableConf}; + const table = parseTable(tableConf.name, logInfo.schema); + + let tableMap = schemaMap.get(table.schema); + if (!tableMap) { + tableMap = new Map(); + schemaMap.set(table.schema, tableMap); + } + + let tableInfo = tableMap.get(table.name); + if (!tableInfo) { + tableInfo = { + conf: tableConf, + log: logInfo + }; + tableMap.set(table.name, tableInfo); + } + + let modelName = tableConf.modelName; + if (!modelName) { + modelName = logsConf.upperCaseTable + ? toUpperCamelCase(table.name) + : table.name; + } + + const { + showField, + relation, + idName + } = tableConf; + + Object.assign(tableInfo, { + conf: tableConf, + exclude: new Set(tableConf.exclude), + modelName, + showField, + relation, + idName, + userField: tableConf.userField || logsConf.userField + }); + + return tableInfo; + } + + return {schemaMap, logMap}; + } + + async loadSchema(schemaMap, db) { + const {logsConf} = this; + + for (const [schema, tableMap] of schemaMap) + for (const [table, tableInfo] of tableMap) { + const tableConf = tableInfo.conf; + + // Fetch columns & types + + Object.assign (tableInfo, { + castTypes: new Map(), + columns: new Map() + }); + + if (tableConf.types) + for (const col in tableConf.types) + tableInfo.castTypes.set(col, tableConf.types[col]); + + const [dbCols] = await db.query( + `SELECT + COLUMN_NAME \`col\`, + DATA_TYPE \`type\`, + COLUMN_DEFAULT \`def\` + FROM information_schema.\`COLUMNS\` + WHERE TABLE_NAME = ? AND TABLE_SCHEMA = ?`, + [table, schema] + ); + + for (const {col, type, def} of dbCols) { + if (!tableInfo.exclude.has(col) && col != tableInfo.userField) + tableInfo.columns.set(col, {type, def}); + + const castType = logsConf.castTypes[type]; + if (castType && !tableInfo.castTypes.has(col)) + tableInfo.castTypes.set(col, castType); + } + + // Fetch primary key + + if (!tableConf.idName) { + const [dbPks] = await db.query( + `SELECT COLUMN_NAME idName + FROM information_schema.KEY_COLUMN_USAGE + WHERE CONSTRAINT_NAME = 'PRIMARY' + AND TABLE_NAME = ? + AND TABLE_SCHEMA = ?`, + [table, schema] + ); + + if (!dbPks.length) + throw new Error(`Primary not found for table: ${schema}.${table}`); + if (dbPks.length > 1) + throw new Error(`Only one column primary is supported: ${schema}.${table}`); + + for (const {idName} of dbPks) + tableInfo.idName = idName; + } + + // Get show field + + if (!tableConf.showField) { + for (const showField of logsConf.showFields) { + if (tableInfo.columns.has(showField)) { + tableInfo.showField = showField; + break; + } + } + } + } + + // Fetch relation to main table + + for (const [schema, tableMap] of schemaMap) + for (const [table, tableInfo] of tableMap) { + + if (!tableInfo.conf.relation && !tableInfo.isMain) { + const mainTable = tableInfo.log.mainTable; + const mainTableInfo = schemaMap + .get(mainTable.schema) + .get(mainTable.name); + + const [mainRelations] = await db.query( + `SELECT COLUMN_NAME relation + FROM information_schema.KEY_COLUMN_USAGE + WHERE TABLE_NAME = ? + AND TABLE_SCHEMA = ? + AND REFERENCED_TABLE_NAME = ? + AND REFERENCED_TABLE_SCHEMA = ? + AND REFERENCED_COLUMN_NAME = ?`, + [ + table, + schema, + mainTable.name, + mainTable.schema, + mainTableInfo.idName + ] + ); + + if (!mainRelations.length) + throw new Error(`No relation to main table found for table: ${schema}.${table}`); + if (mainRelations.length > 1) + throw new Error(`Found more multiple relations to main table: ${schema}.${table}`); + + for (const {relation} of mainRelations) + tableInfo.relation = relation; + } + } + + // Fetch relations and show values of related tables + // TODO: #5563 Not used yet + + const relatedList = []; + const relatedMap = new Map(); + + for (const [schema, tableMap] of schemaMap) + for (const [table, tableInfo] of tableMap) { + const [relations] = await db.query( + `SELECT + COLUMN_NAME \`col\`, + REFERENCED_TABLE_SCHEMA \`schema\`, + REFERENCED_TABLE_NAME \`table\`, + REFERENCED_COLUMN_NAME \`column\` + FROM information_schema.KEY_COLUMN_USAGE + WHERE TABLE_NAME = ? + AND TABLE_SCHEMA = ? + AND REFERENCED_TABLE_NAME IS NOT NULL`, + [table, schema] + ); + + tableInfo.relations = new Map(); + for (const {col, schema, table, column} of relations) { + tableInfo.relations.set(col, {schema, table, column}); + relatedList.push([table, schema]); + + let tables = relatedMap.get(schema); + if (!tables) relatedMap.set(schema, tables = new Set()); + if (!tables.has(table)) { + tables.add(table); + relatedList.push([table, schema]); + } + } + } + + const showFields = logsConf.showFields; + const [result] = await db.query( + `SELECT + TABLE_NAME \`table\`, + TABLE_SCHEMA \`schema\`, + COLUMN_NAME \`col\` + FROM information_schema.\`COLUMNS\` + WHERE (TABLE_NAME, TABLE_SCHEMA) IN (?) + AND COLUMN_NAME IN (?)`, + [relatedList, showFields] + ); + + const showTables = new Map(); + + for (const {table, schema, col} of result) { + let tables = showTables.get(schema); + if (!tables) showTables.set(schema, tables = new Map()) + const showField = tables.get(table); + + let save; + if (showField) { + const newIndex = showFields.indexOf(col); + const oldIndex = showFields.indexOf(showField); + save = newIndex < oldIndex; + } else + save = true; + + if (save) tables.set(table, col); + } + } +} + +function parseTable(tableString, defaultSchema) { + let name, schema; + const split = tableString.split('.'); + if (split.length == 1) { + name = split[0]; + schema = defaultSchema; + } else { + [schema, name] = split; + } + return {name, schema}; +} diff --git a/lib/util.js b/lib/util.js new file mode 100644 index 0000000..1d47d4f --- /dev/null +++ b/lib/util.js @@ -0,0 +1,26 @@ +const fs = require('fs'); +const path = require('path'); + +function loadConfig(dir, configName) { + const configBase = path.join(dir, 'config', configName); + const conf = Object.assign({}, require(`${configBase}.yml`)); + + const localPath = `${configBase}.local.yml`; + if (fs.existsSync(localPath)) { + const localConfig = require(localPath); + Object.assign(conf, localConfig); + } + + return conf; +} + +function toUpperCamelCase(str) { + str = str.replace(/[-_ ][a-z]/g, + match => match.charAt(1).toUpperCase()); + return str.charAt(0).toUpperCase() + str.substr(1); +} + +module.exports = { + loadConfig, + toUpperCamelCase +} diff --git a/mylogger.js b/mylogger.js index 753a5b8..1af5081 100644 --- a/mylogger.js +++ b/mylogger.js @@ -1,9 +1,9 @@ require('require-yaml'); require('colors'); -const fs = require('fs'); -const path = require('path'); const ZongJi = require('./zongji'); const mysql = require('mysql2/promise'); +const {loadConfig} = require('./lib/util'); +const ModelLoader = require('./lib/model-loader'); module.exports = class MyLogger { constructor() { @@ -11,110 +11,16 @@ module.exports = class MyLogger { this.isOk = null; this.binlogName = null; this.binlogPosition = null; - this.schemaMap = new Map(); - this.logMap = new Map(); this.isFlushed = true; this.queue = []; - } - - loadConfig(configName) { - const defaultConfig = require(`./config/${configName}.yml`); - const conf = Object.assign({}, defaultConfig); - const localPath = path.join(__dirname, 'config', `${configName}.local.yml`); - if (fs.existsSync(localPath)) { - const localConfig = require(localPath); - Object.assign(conf, localConfig); - } - return conf; + this.modelLoader = new ModelLoader(); } async start() { - this.conf = this.loadConfig('config'); - this.logsConf = this.loadConfig('logs'); - const {conf, logsConf} = this; + const conf = this.conf = loadConfig(__dirname, 'config'); - function parseTable(tableString, defaultSchema) { - let name, schema; - const split = tableString.split('.'); - if (split.length == 1) { - name = split[0]; - schema = defaultSchema; - } else { - [schema, name] = split; - } - return {name, schema}; - } - - const schemaMap = this.schemaMap; - function addTable(tableConf, logInfo) { - if (typeof tableConf == 'string') - tableConf = {name: tableConf}; - const table = parseTable(tableConf.name, logInfo.schema); - - let tableMap = schemaMap.get(table.schema); - if (!tableMap) { - tableMap = new Map(); - schemaMap.set(table.schema, tableMap); - } - - let tableInfo = tableMap.get(table.name); - if (!tableInfo) { - tableInfo = { - conf: tableConf, - log: logInfo - }; - tableMap.set(table.name, tableInfo); - } - - const modelName = logsConf.upperCaseTable - ? toUpperCamelCase(table.name) - : table.name; - - const { - showField, - relation, - idName - } = tableConf; - - Object.assign(tableInfo, { - conf: tableConf, - exclude: new Set(tableConf.exclude), - modelName, - showField, - relation, - idName, - userField: tableConf.userField || logsConf.userField - }); - - return tableInfo; - } - - for (const logName in logsConf.logs) { - const logConf = logsConf.logs[logName]; - const schema = logConf.schema || conf.srcDb.database; - const logInfo = { - name: logName, - conf: logConf, - schema, - table: parseTable(logConf.logTable, schema), - mainTable: parseTable(logConf.mainTable, schema) - }; - this.logMap.set(logName, logInfo); - - const mainTable = addTable(logConf.mainTable, logInfo); - mainTable.isMain = true; - - if (logConf.tables) - for (const tableConf of logConf.tables){ - const table = addTable(tableConf, logInfo); - if (table !== mainTable) { - Object.assign(table, { - main: mainTable, - isMain: false - }); - } - } - } + const {logMap, schemaMap} = this.modelLoader.init(conf); + Object.assign(this, {logMap, schemaMap}); const includeSchema = {}; for (const [schemaName, tableMap] of this.schemaMap) @@ -147,7 +53,7 @@ module.exports = class MyLogger { } async init() { - const {conf, logsConf} = this; + const {conf} = this; this.debug('MyLogger', 'Initializing.'); this.onErrorListener = err => this.onError(err); @@ -189,176 +95,7 @@ module.exports = class MyLogger { ); } - for (const [schema, tableMap] of this.schemaMap) - for (const [table, tableInfo] of tableMap) { - const tableConf = tableInfo.conf; - - // Fetch columns & types - - Object.assign (tableInfo, { - castTypes: new Map(), - columns: new Map() - }); - - if (tableConf.types) - for (const col in tableConf.types) - tableInfo.castTypes.set(col, tableConf.types[col]); - - const [dbCols] = await db.query( - `SELECT - COLUMN_NAME \`col\`, - DATA_TYPE \`type\`, - COLUMN_DEFAULT \`def\` - FROM information_schema.\`COLUMNS\` - WHERE TABLE_NAME = ? AND TABLE_SCHEMA = ?`, - [table, schema] - ); - - for (const {col, type, def} of dbCols) { - if (!tableInfo.exclude.has(col) && col != tableInfo.userField) - tableInfo.columns.set(col, {type, def}); - - const castType = logsConf.castTypes[type]; - if (castType && !tableInfo.castTypes.has(col)) - tableInfo.castTypes.set(col, castType); - } - - // Fetch primary key - - if (!tableConf.idName) { - const [dbPks] = await db.query( - `SELECT COLUMN_NAME idName - FROM information_schema.KEY_COLUMN_USAGE - WHERE CONSTRAINT_NAME = 'PRIMARY' - AND TABLE_NAME = ? - AND TABLE_SCHEMA = ?`, - [table, schema] - ); - - if (!dbPks.length) - throw new Error(`Primary not found for table: ${schema}.${table}`); - if (dbPks.length > 1) - throw new Error(`Only one column primary is supported: ${schema}.${table}`); - - for (const {idName} of dbPks) - tableInfo.idName = idName; - } - - // Get show field - - if (!tableConf.showField) { - for (const showField of logsConf.showFields) { - if (tableInfo.columns.has(showField)) { - tableInfo.showField = showField; - break; - } - } - } - } - - const showValues = new Map(); - - for (const [schema, tableMap] of this.schemaMap) - for (const [table, tableInfo] of tableMap) { - - // Fetch relation to main table - - if (!tableInfo.conf.relation && !tableInfo.isMain) { - const mainTable = tableInfo.log.mainTable; - const mainTableInfo = this.schemaMap - .get(mainTable.schema) - .get(mainTable.name); - - const [mainRelations] = await db.query( - `SELECT COLUMN_NAME relation - FROM information_schema.KEY_COLUMN_USAGE - WHERE TABLE_NAME = ? - AND TABLE_SCHEMA = ? - AND REFERENCED_TABLE_NAME = ? - AND REFERENCED_TABLE_SCHEMA = ? - AND REFERENCED_COLUMN_NAME = ?`, - [ - table, - schema, - mainTable.name, - mainTable.schema, - mainTableInfo.idName - ] - ); - - if (!mainRelations.length) - throw new Error(`No relation to main table found for table: ${schema}.${table}`); - if (mainRelations.length > 1) - throw new Error(`Found more multiple relations to main table: ${schema}.${table}`); - - for (const {relation} of mainRelations) - tableInfo.relation = relation; - } - - // Fetch relations - // TODO: Use relations to fetch names of related entities - - const [relations] = await db.query( - `SELECT - COLUMN_NAME \`col\`, - REFERENCED_TABLE_SCHEMA \`schema\`, - REFERENCED_TABLE_NAME \`table\`, - REFERENCED_COLUMN_NAME \`column\` - FROM information_schema.KEY_COLUMN_USAGE - WHERE TABLE_NAME = ? - AND TABLE_SCHEMA = ? - AND REFERENCED_TABLE_NAME IS NOT NULL`, - [table, schema] - ); - - tableInfo.relations = new Map(); - for (const {col, schema, table, column} of relations) { - tableInfo.relations.set(col, {schema, table, column}); - - let tables = showValues.get(schema); - if (!tables) { - tables = new Map(); - showValues.set(schema, tables); - } - if (!tables.get(table)) tables.set(table, null); - } - } - - const showTables = []; - const showFields = logsConf.showFields; - - for (const [schema, tableMap] of showValues) - for (const [table] of tableMap) - showTables.push([table, schema]); - - const [result] = await db.query( - `SELECT - TABLE_NAME \`table\`, - TABLE_SCHEMA \`schema\`, - COLUMN_NAME \`col\` - FROM information_schema.\`COLUMNS\` - WHERE (TABLE_NAME, TABLE_SCHEMA) IN (?) - AND COLUMN_NAME IN (?)`, - [showTables, showFields] - ); - - for (const row of result) { - const tables = showValues.get(row.schema); - const showField = tables.get(row.table); - - let save; - if (showField != null) { - const newIndex = showFields.indexOf(row.col); - const oldIndex = showFields.indexOf(showField); - save = newIndex < oldIndex; - } else - save = true; - - if (save) - tables.set(row.table, row.col); - } - - // TODO: End + await this.modelLoader.loadSchema(this.schemaMap, db); // Zongji @@ -569,10 +306,8 @@ module.exports = class MyLogger { onRowEvent(evt, eventName) { const table = evt.tableMap[evt.tableId]; const tableName = table.tableName; - const tableMap = this.schemaMap.get(table.parentSchema); - if (!tableMap) return; - - const tableInfo = tableMap.get(tableName); + const tableInfo = this.schemaMap + .get(table.parentSchema)?.get(tableName); if (!tableInfo) return; const action = actions[eventName]; @@ -863,9 +598,3 @@ const actionColor = { update: 'yellow', delete: 'red' }; - -function toUpperCamelCase(str) { - str = str.replace(/[-_ ][a-z]/g, - match => match.charAt(1).toUpperCase()); - return str.charAt(0).toUpperCase() + str.substr(1); -} diff --git a/package-lock.json b/package-lock.json index 64b6647..7e3c1da 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { "name": "mylogger", - "version": "0.1.19", + "version": "0.1.20", "lockfileVersion": 2, "requires": true, "packages": { "": { "name": "mylogger", - "version": "0.1.19", + "version": "0.1.20", "license": "GPL-3.0", "dependencies": { "colors": "^1.4.0", diff --git a/package.json b/package.json index a503352..d7522e1 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "mylogger", - "version": "0.1.19", + "version": "0.1.20", "author": "Verdnatura Levante SL", "description": "MySQL and MariaDB logger using binary log", "license": "GPL-3.0",