@verdnatura/myt 1.5.22 → 1.5.24

package/README.md

@@ -64,7 +64,7 @@ Each command can have its own specific commandline options.
 
 ## Basic information
 
-First of all you have to initalize the workspace.
+First of all you have to initialize the workspace.
 
 ```text
 $ myt init
@@ -72,7 +72,7 @@ $ myt init
 
 Now you can configure Myt using *myt.config.yml* file, located at the root of
 your workspace. This file should include the project codename and schemas/tables
-wich are exported when you use *pull* or *dump* commands.
+which are exported when you use *pull* or *dump* commands.
 
 Don't forget to initialize git (if it isn't initialized yet).
 
@@ -143,6 +143,38 @@ Don't place your PL/SQL objects here, use the routines folder!
      `- 00-sameNumbers.sql
 ```
 
+### Environment-Specific Versioning with Realms
+
+#### Overview
+
+We have introduced a new feature that allows users to apply version-specific changes based on their configured environment, or "realm". This ensures that certain changes are only applied when the user is operating within a specific realm, providing an additional layer of customization and control.
+
+#### Configuration
+
+To make use of this feature, you need to configure your realm in the `versionConfig` table. Set your realm by inserting or updating a record in this table. The `realm` field should contain the identifier of your environment.
+
+#### File Naming Convention
+
+To designate a file as realm-specific, include a `.your_realm.` segment before the file extension. For example, if your realm is set to 'ab', the file should be named like this: `filename.ab.sql`.
+
+#### How It Works
+
+1. **Set your Realm**: Configure your realm in the `versionConfig` table.
+  
+2. **Add Files**: Place your realm-specific files in the `versions` folder. Make sure to follow the naming convention.
+
+3. **Version Order**: Files are applied in the existing version order. In addition to that, the realm is validated.
+
+4. **Apply Changes**: Run the usual versioning commands. The realm-specific files will only be applied if your configured realm matches the realm in the file name.
+
+#### Important Notes
+
+- If no realm is configured, realm-specific files will be ignored.
+  
+- If you have a realm configured but the realm-specific files belong to a different realm, those files will also be ignored.
+
+This feature allows for greater flexibility when working in different environments, making it easier to manage realm-specific changes in a shared repository.
+
 ### Local server
 
 The local server is created as a MariaDB Docker container using the base dump 
@@ -169,6 +201,7 @@ Initializes an empty workspace.
 $ myt init
 ```
 
+
 ### pull
 
 Incorporates database routine changes into workspace.
@@ -263,14 +296,14 @@ $ myt start
 
 ## Why
 
-The main reason for starting this project it's because there are no fully free 
+The main reason for starting this project is because there are no fully free 
 and open source migration tools available that allow versioning database 
-routines with an standard CVS system as if they were normal application code.
+routines with a standard CVS system as if they were normal application code.
 
 Also, the existing tools are too complex and require too much knowledge to 
-start a small project.
+initiate a small project.
 
-## ToDo
+## To-Do
 
 * Undo changes when there is an error applying a version using "undo" files.
 * Console logging via events.
@@ -280,6 +313,6 @@ start a small project.
 ## Built With
 
 * [Git](https://git-scm.com/)
-* [nodejs](https://nodejs.org/)
+* [Node.js](https://nodejs.org/)
 * [NodeGit](https://www.nodegit.org/)
-* [docker](https://www.docker.com/)
+* [Docker](https://www.docker.com/)

package/assets/structure.sql

@@ -22,3 +22,8 @@ CREATE TABLE `versionLog` (
 
 ALTER TABLE `versionLog`
     ADD PRIMARY KEY (`code`,`number`,`file`);
+
+CREATE TABLE `util`.`versionConfig` (
+    `id` INT UNSIGNED AUTO_INCREMENT PRIMARY KEY,
+    `realm` VARCHAR(16) NULL DEFAULT NULL COMMENT 'Data set on which the project runs'
+) ENGINE=InnoDB;

package/myt-clean.js

@@ -19,16 +19,19 @@ class Clean extends Command {
 
     async run(myt, opts) {
         await myt.dbConnect();
-        const version = await myt.fetchDbVersion() || {};
-        const number = version.number;
+        const dbVersion = await myt.fetchDbVersion() || {};
+        const number = parseInt(dbVersion.number);
 
         const oldVersions = [];
         const versionDirs = await fs.readdir(opts.versionsDir);
         for (const versionDir of versionDirs) {
-            const dirVersion = myt.parseVersionDir(versionDir);
-            if (!dirVersion) continue;
+            const version = await myt.loadVersion(versionDir);
+            const shouldArchive = version
+                && version.matchRegex
+                && !version.apply
+                && parseInt(version.number) < number;
 
-            if (parseInt(dirVersion.number) < parseInt(number))
+            if (shouldArchive)
                 oldVersions.push(versionDir);
         }
 
@@ -46,9 +49,9 @@ class Clean extends Command {
                     path.join(archiveDir, oldVersion)
                 );
 
-            console.log(`Old versions deleted: ${oldVersions.length}`);
+            console.log(`Old versions archived: ${oldVersions.length}`);
         } else
-            console.log(`No versions to delete.`);
+            console.log(`No versions to archive.`);
     }
 }
 

package/myt-push.js

@@ -90,17 +90,17 @@ class Push extends Command {
 
         // Get database version
 
-        const version = await myt.fetchDbVersion() || {};
+        const dbVersion = await myt.fetchDbVersion() || {};
 
         console.log(
             `Database information:`
-            + `\n -> Version: ${version.number}`
-            + `\n -> Commit: ${version.gitCommit}`
+            + `\n -> Version: ${dbVersion.number}`
+            + `\n -> Commit: ${dbVersion.gitCommit}`
         );
 
-        if (!version.number)
-            version.number = String('0').padStart(opts.versionDigits, '0');
-        if (!/^[0-9]*$/.test(version.number))
+        if (!dbVersion.number)
+            dbVersion.number = String('0').padStart(opts.versionDigits, '0');
+        if (!/^[0-9]*$/.test(dbVersion.number))
             throw new Error('Wrong database version');
 
         // Prevent push to production by mistake
@@ -142,15 +142,24 @@ class Push extends Command {
         let silent = true;
         const versionsDir = opts.versionsDir;
 
-        function logVersion(version, name, error) {
-            console.log('', version.bold, name);
+        function logVersion(version, name, action, error) {
+            let actionMsg;
+            switch(action) {
+                case 'apply':
+                    actionMsg = '[A]'.green;
+                    break;
+                case 'ignore':
+                    actionMsg = '[I]'.blue;
+                    break;
+                default:
+                    actionMsg = '[W]'.yellow;
+            }
+
+            console.log('', (actionMsg + version).bold, name);
         }
         function logScript(type, message, error) {
             console.log(' ', type.bold, message);
         }
-        function isUndoScript(script) {
-            return /\.undo\.sql$/.test(script);
-        }
 
         const skipFiles = new Set([
             'README.md',
@@ -159,78 +168,49 @@ class Push extends Command {
 
         if (await fs.pathExists(versionsDir)) {
             const versionDirs = await fs.readdir(versionsDir);
-
             for (const versionDir of versionDirs) {
                 if (skipFiles.has(versionDir)) continue;
+                const version = await myt.loadVersion(versionDir);
 
-                const dirVersion = myt.parseVersionDir(versionDir);
-                if (!dirVersion) {
-                    logVersion('[?????]'.yellow, versionDir,
+                if (!version) {
+                    logVersion('[?????]'.yellow, versionDir, 'warn',
                         `Wrong directory name.`
                     );
                     continue;
                 }
-
-                const versionNumber = dirVersion.number;
-                const versionName = dirVersion.name;
-
-                if (versionNumber.length != version.number.length) {
-                    logVersion('[*****]'.gray, versionDir,
-                        `Bad version length, should have ${version.number.length} characters.`
+                if (version.number.length != dbVersion.number.length) {
+                    logVersion('[*****]'.gray, versionDir, 'warn'
+                        `Bad version length, should have ${dbVersion.number.length} characters.`
                     );
                     continue;
                 }
 
-                const scriptsDir = `${versionsDir}/${versionDir}`;
-                const scripts = await fs.readdir(scriptsDir);
-
-                const [versionLog] = await conn.query(
-                    `SELECT file FROM versionLog
-                        WHERE code = ?
-                            AND number = ?
-                            AND errorNumber IS NULL`,
-                    [opts.code, versionNumber]
-                );
-
-                for (const script of scripts)
-                if (!isUndoScript(script)
-                && versionLog.findIndex(x => x.file == script) === -1) {
-                    silent = false;
-                    break;
-                }
-
+                const {apply} = version;
+                if (apply) silent = false;
                 if (silent) continue;
-                logVersion(`[${versionNumber}]`.cyan, versionName);
 
-                for (const script of scripts) {
-                    if (!/^[0-9]{2}-[a-zA-Z0-9_]+(.undo)?\.sql$/.test(script)) {
-                        logScript('[W]'.yellow, script, `Wrong file name.`);
+                const action = apply ? 'apply' : 'ignore';
+                logVersion(`[${version.number}]`.cyan, version.name, action);
+
+                if (!apply) continue;
+
+                for (const script of version.scripts) {
+                    const scriptFile = script.file;
+                    
+                    if (!script.matchRegex) {
+                        logScript('[W]'.yellow, scriptFile, `Wrong file name.`);
                         continue;
                     }
-                    if (isUndoScript(script))
-                        continue;
 
-                    const [[row]] = await conn.query(
-                        `SELECT errorNumber FROM versionLog
-                            WHERE code = ?
-                                AND number = ?
-                                AND file = ?`,
-                        [
-                            opts.code,
-                            versionNumber,
-                            script
-                        ]
-                    );
-                    const apply = !row || row.errorNumber;
-                    const actionMsg = apply ? '[+]'.green : '[I]'.blue;
-                    
-                    logScript(actionMsg, script);
-                    if (!apply) continue;
+                    const actionMsg = script.apply ? '[+]'.green : '[I]'.blue;
+                    logScript(actionMsg, scriptFile);
+    
+                    if (!script.apply) continue;
 
                     let err;
                     try {
                         await connExt.queryFromFile(pushConn,
-                            `${scriptsDir}/${script}`);
+                            `${versionsDir}/${versionDir}/${scriptFile}`);
                     } catch (e) {
                         err = e;
                     }
@@ -251,8 +231,8 @@ class Push extends Command {
                                 errorMessage = VALUES(errorMessage)`,
                         [
                             opts.code,
-                            versionNumber,
-                            script,
+                            version.number,
+                            scriptFile,
                             err && err.errno,
                             err && err.message
                         ]
@@ -262,7 +242,7 @@ class Push extends Command {
                     nChanges++;
                 }
 
-                await this.updateVersion('number', versionNumber);
+                await this.updateVersion('number', version.number);
             }
         }
 
@@ -273,7 +253,7 @@ class Push extends Command {
         const gitExists = await fs.pathExists(`${opts.workspace}/.git`);
 
         let nRoutines = 0;
-        const changes = await this.changedRoutines(version.gitCommit);
+        const changes = await this.changedRoutines(dbVersion.gitCommit);
 
         const routines = [];
         for (const change of changes)
@@ -350,7 +330,7 @@ class Push extends Command {
 
             const typeMsg = `[${change.type.abbr}]`[change.type.color];
             console.log('',
-                (statusMsg + actionMsg).bold,
+                (actionMsg + statusMsg).bold,
                 typeMsg.bold,
                 change.fullName
             );
@@ -410,7 +390,7 @@ class Push extends Command {
             const repo = await nodegit.Repository.open(this.opts.workspace);
             const head = await repo.getHeadCommit();
 
-            if (head && version.gitCommit !== head.sha())
+            if (head && dbVersion.gitCommit !== head.sha())
                 await this.updateVersion('gitCommit', head.sha());
         }
 

package/myt-run.js

@@ -140,7 +140,7 @@ class Run extends Command {
         const hasTriggers = await fs.exists(`${dumpDataDir}/triggers.sql`);
 
         Object.assign(opts, {
-            triggers: hasTriggers,
+            triggers: !hasTriggers,
             commit: true,
             dbConfig
         });

package/myt-version.js

@@ -74,9 +74,9 @@ class Version extends Command {
             const versionNames = new Set();
             const versionDirs = await fs.readdir(opts.versionsDir);
             for (const versionDir of versionDirs) {
-                const dirVersion = myt.parseVersionDir(versionDir);
-                if (!dirVersion) continue;
-                versionNames.add(dirVersion.name);
+                const version = myt.parseVersionDir(versionDir);
+                if (!version) continue;
+                versionNames.add(version.name);
             }
 
             if (!versionName) {

package/myt.js

@@ -11,6 +11,8 @@ const mysql = require('mysql2/promise');
 const nodegit = require('nodegit');
 const camelToSnake = require('./lib/util').camelToSnake;
 
+const scriptRegex = /^[0-9]{2}-[a-zA-Z0-9_]+(?:\.(?!undo)([a-zA-Z0-9_]+))?(\.undo)?\.sql$/;
+
 class Myt {
     static usage = {
         description: 'Utility for database versioning',
@@ -172,7 +174,7 @@ class Myt {
 
         const defaultConfig = require(`${__dirname}/assets/myt.default.yml`);
         const config = Object.assign({}, defaultConfig);
-        
+
         const configFile = 'myt.config.yml';
         const configPath = path.join(opts.workspace, configFile);
 
@@ -205,7 +207,7 @@ class Myt {
         opts.dumpDir = path.join(opts.mytDir, 'dump');
 
         // Database configuration
-        
+
         let iniDir = path.join(__dirname, 'assets');
         let iniFile = 'db.ini';
 
@@ -214,10 +216,10 @@ class Myt {
             iniFile = `${opts.remote}.ini`;
         }
         const iniPath = path.join(iniDir, iniFile);
-        
+
         if (!await fs.pathExists(iniPath))
             throw new Error(`Database config file not found: ${iniPath}`);
-        
+
         let dbConfig;
         try {
             const iniData = ini.parse(await fs.readFile(iniPath, 'utf8')).client;
@@ -299,12 +301,17 @@ class Myt {
                         AND TABLE_NAME = 'version'`,
                 [opts.versionSchema]
             );
-    
+
             if (!res.tableExists) {
                 const structure = await fs.readFile(
                     `${__dirname}/assets/structure.sql`, 'utf8');
                 await conn.query(structure);
             }
+
+            const [[realm]] = await conn.query(
+                `SELECT realm FROM versionConfig`
+            );
+            this.realm = realm;
         }
 
         return this.conn;
@@ -332,6 +339,58 @@ class Myt {
         };
     }
 
+    async loadVersion(versionDir) {
+        const {opts} = this;
+
+        const info = this.parseVersionDir(versionDir);
+        if (!info) return null;
+
+        const versionsDir = opts.versionsDir;
+        const scriptsDir = `${versionsDir}/${versionDir}`;
+        const scriptList = await fs.readdir(scriptsDir);
+
+        const [res] = await this.conn.query(
+            `SELECT file, errorNumber IS NOT NULL hasError
+                FROM versionLog
+                WHERE code = ?
+                    AND number = ?`,
+            [opts.code, info.number]
+        );
+        const versionLog = new Map();
+        res.map(x => versionLog.set(x.file, x));
+
+        let applyVersion = false;
+        const scripts = [];
+
+        for (const file of scriptList) {
+            const match = file.match(scriptRegex);
+            if (match) {
+                const scriptRealm = match[1];
+                const isUndo = !!match[2];
+
+                if ((scriptRealm && scriptRealm !== this.realm) || isUndo)
+                    continue;
+            }
+
+            const logInfo = versionLog.get(file);
+            const apply = !logInfo || logInfo.hasError;
+            if (apply) applyVersion = true;
+
+            scripts.push({
+                file,
+                matchRegex: !!match,
+                apply
+            });
+        }
+
+        return {
+            number: info.number,
+            name: info.name,
+            scripts,
+            apply: applyVersion
+        };
+    }
+
     async openRepo() {
         const {opts} = this;
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@verdnatura/myt",
-  "version": "1.5.22",
+  "version": "1.5.24",
   "author": "Verdnatura Levante SL",
   "description": "MySQL version control",
   "license": "GPL-3.0",