myt/myvc.js

436 lines
13 KiB
JavaScript
Raw Normal View History

2020-11-14 01:38:56 +00:00
#!/usr/bin/env node
2020-12-04 16:30:26 +00:00
require('require-yaml');
require('colors');
const getopts = require('getopts');
const packageJson = require('./package.json');
const fs = require('fs-extra');
const ini = require('ini');
const path = require('path');
const mysql = require('mysql2/promise');
const nodegit = require('nodegit');
const camelToSnake = require('./lib').camelToSnake;
2020-12-04 16:30:26 +00:00
class MyVC {
async run(command) {
console.log(
'MyVC (MySQL Version Control)'.green,
`v${packageJson.version}`.magenta
);
const usage = {
description: 'Utility for database versioning',
params: {
remote: 'Name of remote to use',
workspace: 'The base directory of the project',
socket: 'Wether to connect to database via socket',
debug: 'Wether to enable debug mode',
version: 'Display the version number and exit',
help: 'Display this help message'
}
};
const baseOpts = {
2020-12-04 16:30:26 +00:00
alias: {
remote: 'r',
workspace: 'w',
socket: 'k',
2020-12-04 16:30:26 +00:00
debug: 'd',
version: 'v',
help: 'h'
},
boolean: [
2022-04-04 18:53:18 +00:00
'debug',
'version',
'help'
],
2020-12-04 16:30:26 +00:00
default: {
workspace: process.cwd()
}
};
const opts = this.getopts(baseOpts);
2020-12-04 16:30:26 +00:00
2022-02-07 11:46:14 +00:00
if (opts.version)
process.exit(0);
2020-12-04 16:30:26 +00:00
try {
const commandName = opts._[0];
if (!command && commandName) {
2020-12-04 16:30:26 +00:00
const commands = [
'init',
'pull',
'push',
'version',
2020-12-04 16:30:26 +00:00
'dump',
'start',
'run'
];
if (commands.indexOf(commandName) == -1)
throw new Error (`Unknown command '${commandName}'`);
const Klass = require(`./myvc-${commandName}`);
command = new Klass();
}
if (!command) {
this.showHelp(baseOpts, usage);
process.exit(0);
}
2022-04-04 18:53:18 +00:00
const allOpts = Object.assign({}, baseOpts);
2022-04-04 19:14:04 +00:00
if (command.localOpts)
2022-04-04 18:53:18 +00:00
for (const key in command.localOpts) {
const baseValue = baseOpts[key];
const cmdValue = command.localOpts[key];
if (Array.isArray(baseValue))
allOpts[key] = baseValue.concat(cmdValue);
else if (typeof baseValue == 'object')
allOpts[key] = Object.assign({}, baseValue, cmdValue);
else
allOpts[key] = cmdValue;
}
const commandOpts = this.getopts(allOpts);
Object.assign(opts, commandOpts);
const operandToOpt = command.usage.operand;
if (opts._.length >= 2 && operandToOpt)
opts[operandToOpt] = opts._[1];
if (opts.help) {
this.showHelp(command.localOpts, command.usage, commandName);
process.exit(0);
}
// Check version
let depVersion;
const versionRegex = /^[^~]?([0-9]+)\.([0-9]+).([0-9]+)$/;
const wsPackageFile = path.join(opts.workspace, 'package.json');
if (await fs.pathExists(wsPackageFile)) {
const wsPackageJson = require(wsPackageFile);
try {
depVersion = wsPackageJson
.dependencies
.myvc.match(versionRegex);
} catch (e) {}
}
if (depVersion) {
const myVersion = packageJson.version.match(versionRegex);
const isSameVersion =
depVersion[1] === myVersion[1] &&
depVersion[2] === myVersion[2];
if (!isSameVersion)
throw new Error(`This version of MyVC differs from your package.json`);
const isSameMinor = depVersion[3] === myVersion[3];
if (!isSameMinor)
console.warn(`Warning! Minor version of MyVC differs from your package.json`.yellow);
}
// Load method
2020-12-04 16:30:26 +00:00
parameter('Workspace:', opts.workspace);
parameter('Remote:', opts.remote || 'local');
await this.load(opts);
command.opts = opts;
await command.run(this, opts);
await this.unload();
} catch (err) {
2021-10-23 17:14:09 +00:00
if (err.name == 'Error' && !opts.debug) {
2020-12-04 16:30:26 +00:00
console.error('Error:'.gray, err.message.red);
2021-10-23 17:14:09 +00:00
process.exit(1);
} else
2020-12-04 16:30:26 +00:00
throw err;
}
function parameter(parameter, value) {
console.log(parameter.gray, (value || 'null').blue);
}
process.exit();
}
async load(opts) {
// Configuration file
const config = require(`${__dirname}/myvc.default.yml`);
const configFile = 'myvc.config.yml';
const configPath = path.join(opts.workspace, configFile);
if (await fs.pathExists(configPath))
Object.assign(config, require(configPath));
Object.assign(opts, config);
opts.configFile = configFile;
if (!opts.myvcDir)
opts.myvcDir = path.join(opts.workspace, opts.subdir || '');
2020-12-04 16:30:26 +00:00
// Database configuration
let iniDir = __dirname;
let iniFile = 'db.ini';
2020-12-04 16:30:26 +00:00
if (opts.remote) {
iniDir = `${opts.myvcDir}/remotes`;
iniFile = `${opts.remote}.ini`;
2020-12-04 16:30:26 +00:00
}
const iniPath = path.join(iniDir, iniFile);
if (!await fs.pathExists(iniPath))
throw new Error(`Database config file not found: ${iniPath}`);
2020-12-04 16:30:26 +00:00
const iniConfig = ini.parse(await fs.readFile(iniPath, 'utf8')).client;
const dbConfig = {
host: iniConfig.host,
port: iniConfig.port,
user: iniConfig.user,
password: iniConfig.password,
2020-12-05 21:50:45 +00:00
multipleStatements: true,
2020-12-04 16:30:26 +00:00
authPlugins: {
mysql_clear_password() {
return () => iniConfig.password + '\0';
}
}
};
if (iniConfig.ssl_ca) {
dbConfig.ssl = {
ca: await fs.readFile(`${opts.myvcDir}/${iniConfig.ssl_ca}`),
2020-12-04 16:30:26 +00:00
rejectUnauthorized: iniConfig.ssl_verify_server_cert != undefined
}
}
if (opts.socket)
dbConfig.socketPath = '/var/run/mysqld/mysqld.sock';
Object.assign(opts, {
iniFile,
dbConfig
});
this.opts = opts;
}
async unload() {
if (this.conn)
await this.conn.end();
}
getopts(opts) {
const argv = process.argv.slice(2);
const values = getopts(argv, opts);
const cleanValues = {};
for (const opt in values)
if (opt.length > 1 || opt == '_')
cleanValues[opt] = values[opt];
return cleanValues;
}
2020-12-04 16:30:26 +00:00
async dbConnect() {
const {opts} = this;
if (!this.conn) {
const conn = this.conn = await this.createConnection();
const [[schema]] = await conn.query(
`SHOW DATABASES LIKE ?`, [opts.versionSchema]
);
if (!schema)
await conn.query(`CREATE DATABASE ??`, [opts.versionSchema]);
2022-04-04 18:53:18 +00:00
await conn.query(`USE ??`, [opts.versionSchema]);
const [[res]] = await conn.query(
`SELECT COUNT(*) > 0 tableExists
FROM information_schema.tables
WHERE TABLE_SCHEMA = ?
AND TABLE_NAME = 'version'`,
[opts.versionSchema]
);
if (!res.tableExists) {
const structure = await fs.readFile(`${__dirname}/structure.sql`, 'utf8');
await conn.query(structure);
}
}
2020-12-04 16:30:26 +00:00
return this.conn;
}
async createConnection() {
return await mysql.createConnection(this.opts.dbConfig);
}
async fetchDbVersion() {
const [[version]] = await this.conn.query(
`SELECT number, gitCommit
FROM version WHERE code = ?`,
[this.opts.code]
2020-12-04 16:30:26 +00:00
);
return version;
}
parseVersionDir(versionDir) {
const match = versionDir.match(/^([0-9]+)-([a-zA-Z0-9]+)?$/);
if (!match) return null;
return {
number: match[1],
name: match[2]
};
}
2020-12-05 21:50:45 +00:00
async changedRoutines(commitSha) {
const repo = await this.openRepo();
2020-12-04 16:30:26 +00:00
const changes = [];
2020-12-18 23:53:21 +00:00
const changesMap = new Map();
2020-12-05 21:50:45 +00:00
2020-12-18 23:53:21 +00:00
async function pushChanges(diff) {
if (!diff) return;
2020-12-05 21:50:45 +00:00
const patches = await diff.patches();
for (const patch of patches) {
const path = patch.newFile().path();
const match = path.match(/^routines\/(.+)\.sql$/);
if (!match) continue;
2020-12-18 23:53:21 +00:00
let change = changesMap.get(match[1]);
if (!change) {
change = {path: match[1]};
changes.push(change);
changesMap.set(match[1], change);
}
change.mark = patch.isDeleted() ? '-' : '+';
2020-12-05 21:50:45 +00:00
}
2020-12-04 16:30:26 +00:00
}
2020-12-18 23:53:21 +00:00
const head = await repo.getHeadCommit();
2020-12-18 23:53:21 +00:00
if (head && commitSha) {
let commit;
try {
await repo.fetchAll();
} catch(err) {
console.warn(err.message.yellow);
}
try {
commit = await repo.getCommit(commitSha);
} catch (err) {
if (err.errorFunction == 'Commit.lookup')
throw new Error(`Commit id (${commitSha}) not found, you may have to run 'git fetch' first`);
else
throw err;
}
2020-12-18 23:53:21 +00:00
const commitTree = await commit.getTree();
const headTree = await head.getTree();
const diff = await headTree.diff(commitTree);
await pushChanges(diff);
}
await pushChanges(await this.getUnstaged(repo));
await pushChanges(await this.getStaged(repo));
return changes.sort((a, b) => {
if (b.mark != a.mark)
return b.mark == '-' ? 1 : -1;
return a.path.localeCompare(b.path);
2020-12-18 23:53:21 +00:00
});
}
async openRepo() {
const {opts} = this;
2020-12-18 23:53:21 +00:00
if (!await fs.pathExists(`${opts.workspace}/.git`))
throw new Error ('Git not initialized');
return await nodegit.Repository.open(opts.workspace);
}
async getStaged(repo) {
const head = await repo.getHeadCommit();
2020-12-18 23:53:21 +00:00
try {
const emptyTree = '4b825dc642cb6eb9a060e54bf8d69288fbee4904';
const headTree = await (head
? head.getTree()
: nodegit.Tree.lookup(repo, emptyTree)
);
return await nodegit.Diff.treeToIndex(repo, headTree, null);
2020-12-18 23:53:21 +00:00
} catch (err) {
console.warn('Cannot fetch staged changes:', err.message);
}
}
async getUnstaged(repo) {
return await nodegit.Diff.indexToWorkdir(repo, null, {
flags: nodegit.Diff.OPTION.SHOW_UNTRACKED_CONTENT
| nodegit.Diff.OPTION.RECURSE_UNTRACKED_DIRS
});
2020-12-04 16:30:26 +00:00
}
async cachedChanges() {
const dumpDir = `${this.opts.myvcDir}/dump`;
2020-12-04 16:30:26 +00:00
const dumpChanges = `${dumpDir}/.changes`;
if (!await fs.pathExists(dumpChanges))
return null;
const readline = require('readline');
const rl = readline.createInterface({
input: fs.createReadStream(dumpChanges),
//output: process.stdout,
console: false
});
2020-12-05 21:50:45 +00:00
const changes = [];
2020-12-04 16:30:26 +00:00
for await (const line of rl) {
changes.push({
mark: line.charAt(0),
path: line.substr(1)
});
}
return changes;
}
showHelp(opts, usage, command) {
const prefix = `${'Usage:'.gray} [npx] myvc`;
if (command) {
let log = [prefix, command.blue];
if (usage.operand) log.push(`[<${usage.operand}>]`);
if (opts) log.push('[<options>]');
console.log(log.join(' '))
} else
console.log(`${prefix} [<options>] ${'<command>'.blue} [<args>]`);
if (usage.description)
console.log(`${'Description:'.gray} ${usage.description}`);
2022-04-04 19:14:04 +00:00
if (opts && opts.alias) {
const alias = opts.alias;
const boolean = opts.boolean || [];
2022-04-04 19:14:04 +00:00
console.log('Options:'.gray);
for (const opt in alias) {
const paramDescription = usage.params[opt] || '';
let longOpt = opt;
if (boolean.indexOf(longOpt) === -1)
longOpt += ` <string>`;
longOpt = camelToSnake(longOpt).padEnd(22, ' ')
console.log(` -${alias[opt]}, --${longOpt} ${paramDescription}`);
}
}
}
2020-12-04 16:30:26 +00:00
}
module.exports = MyVC;
if (require.main === module)
new MyVC().run();