feat(authentication-service): automigration and commit prompt for mig…

…ration changes (#158)

* feat(authentication-service): automigration and commit prompt for migration changes

MIGRATION CHANGE:
migration-20210318100600- Base migration for authentication service

gh-124

* docs(authentication-service): added migration docs

gh-124

* refactor(authentication-service): fixed sonar code smells

gh-124

* refactor(authentication-service): fixed repeated code in migration file

MIGRATION CHANGE:
migration-20210318100600- fixed repeated code

gh-124

* refactor(authentication-service): fixed sonar code smell in index of custom-sf-changelog

gh-124

* fix(authentication-service): fixed sonar code smell

gh-124

* fix(authentication-service): fixed issues from review

gh-124

* fix(authentication-service): fixed minor issues in migration.js

* fix(authentication-service): fixed migrations

MIGRATION CHANGE:
migration-20210318100600- Changed ids to uuids, changed timestamps

BREAKING CHANGE:
Automigration Added - will need to add SKIP env variable in existing project, read docs for help

gh-124

.czferc.js

@@ -0,0 +1,163 @@
+
+const types = [
+    { value: 'feat', name: 'feat:     A new feature' },
+    { value: 'fix', name: 'fix:      A bug fix' },
+    { value: 'docs', name: 'docs:     Documentation only changes' },
+    {
+        value: 'style',
+        name:
+            'style:    Changes that do not affect the meaning of the code\n            (white-space, formatting, missing semi-colons, etc)',
+    },
+    {
+        value: 'refactor',
+        name:
+            'refactor: A code change that neither fixes a bug nor adds a feature',
+    },
+    {
+        value: 'perf',
+        name: 'perf:     A code change that improves performance',
+    },
+    { value: 'test', name: 'test:     Adding missing tests' },
+    {
+        value: 'chore',
+        name:
+            'chore:    Changes to the build process or auxiliary tools\n            and libraries such as documentation generation',
+    },
+    { value: 'revert', name: 'revert:   Revert to a commit' },
+    { value: 'WIP', name: 'WIP:      Work in progress' },
+];
+
+const scopes = [
+    { name: 'core' },
+    { name: 'authentication-service' },
+    { name: 'in-mail-service' },
+    { name: 'notification-service' },
+    { name: 'scheduler-service' },
+    { name: 'video-conferencing-service' },
+    { name: 'audit-service' },
+    { name: 'sandbox' },
+]
+
+/**
+ * @typedef {{type: string; scope: string; subject: string; body: string; isBreaking: boolean; breakingBody: string; breaking: string; isIssueAffected: boolean; issuesBody: string; issues: string;}} Answers
+ */
+
+/** @type import('cz-format-extension').Config<Answers> */
+module.exports = {
+    questions({ inquirer, gitInfo }) {
+        let migrationQuestions = getMigrationChanges(gitInfo.staged);
+        return [
+            {
+                type: "list",
+                name: "type",
+                message: "Select type",
+                choices: types
+            },
+            {
+                type: 'list',
+                name: 'scope',
+                message: 'Denote the SCOPE of this change (optional):\n',
+                choices: scopes
+            },
+            {
+                type: 'input',
+                name: 'subject',
+                message: "Write a SHORT, IMPERATIVE tense description of the change:\n",
+                validate: (subject) => subject.length === 0 ? 'subject is required' : true
+            },
+            ...migrationQuestions,
+            {
+                type: 'input',
+                name: 'body',
+                message: 'Provide a LONGER description of the change (optional). Use "|" to break new line:\n',
+            },
+            {
+                type: 'input',
+                name: 'breaking',
+                message: 'List any BREAKING CHANGES (optional):\n',
+            },
+            {
+                type: 'input',
+                name: 'issues',
+                message: 'List any ISSUES CLOSED by this change (optional). E.g.: #31, #34:\n',
+                filter: (input, answers) => {
+                    return input.replace(/^\#/g, 'gh-');
+                }
+            },
+            {
+                type: 'expand',
+                name: 'confirmCommit',
+                choices: [
+                    { key: 'y', name: 'Yes', value: 'yes' },
+                    { key: 'n', name: 'Abort commit', value: 'no' }
+                ],
+                default: 0,
+                message(answers) {
+                    const SEP = '###--------------------------------------------------------###';
+                    console.log(`\n${SEP}\n${buildCommit({ answers, gitInfo })}\n${SEP}\n`);
+                    return 'Are you sure you want to proceed with the commit above?';
+                },
+            },
+        ]
+    },
+    commitMessage({ answers, gitInfo }) {
+        if(answers.confirmCommit === 'yes'){
+            return buildCommit({ answers, gitInfo });
+        }
+        else{
+            throw Error('Commit cancelled.');
+        }
+    }
+}
+
+function buildCommit({ answers, gitInfo }) {
+    const migrationKeys = Object.keys(answers).filter(q => q.includes('migration-'));
+    const migrationAnswers = migrationKeys.map(key => `${key}- ${answers[key]}`).join('\n');
+    const migrations = migrationAnswers && migrationAnswers.length > 0 ? `MIGRATION CHANGE:\n${migrationAnswers}` : false;
+    const scope = answers.scope ? `(${answers.scope})` : false;
+    const head = `${answers.type}${scope}: ${answers.subject}`;
+    const body = answers.body ? answers.body : false;
+    const breaking = answers.breaking ? `BREAKING CHANGE:\n${answers.breaking}` : false;
+    const issues = answers.issues ? answers.issues
+        .split(', ')
+        .join('\n')
+        .valueOf()
+        : false;
+
+    return escapeSpecialChars([head, body, migrations, breaking, issues].filter(p => p).join('\n\n'))
+}
+
+function getMigrationChanges(staged) {
+    let migrationPaths = staged.map(filePath => filePath.includes('migrations/') && filePath.split(/\//).pop()).filter(f => f && f.length > 0);
+    let timestamps = {};
+    for (let item of migrationPaths) {
+        let match = item.match(/[0-9]{14}/g);
+        if (match && match[0]) {
+            timestamps[match[0]] = [...(timestamps[match[0]] || []), item];
+        }
+    }
+    let questions = [];
+    Object.keys(timestamps).forEach(timestamp => {
+        questions.push({
+            type: 'input',
+            name: `migration-${timestamp}`,
+            message: `Write a description of the changes in migrations for timestamp - ${timestamp}:\n`,
+            validate: (description) => description.length === 0 ? 'description is required' : true
+        })
+    })
+    return questions;
+}
+
+const escapeSpecialChars = result => {
+    // eslint-disable-next-line no-useless-escape
+    const specialChars = ['`'];
+
+    let newResult = result;
+    // eslint-disable-next-line array-callback-return
+    specialChars.map(item => {
+        // If user types "feat: `string`", the commit preview should show "feat: `\string\`".
+        // Don't worry. The git log will be "feat: `string`"
+        newResult = result.replace(new RegExp(item, 'g'), '\\`');
+    });
+    return newResult;
+};

commitlint.config.js

@@ -8,7 +8,7 @@ module.exports = {
   },
   parserPreset: {
     parserOpts: {
-      issuePrefixes: ['SFO-', '#', 'RD-', 'RPMS-', 'RFIT-'],
+      issuePrefixes: ['SFO-', '#', 'RD-', 'RPMS-', 'RFIT-', 'GH'],
     },
   },
 };

lerna.json

@@ -30,6 +30,7 @@
       "yes": true
     }
   },
+  "changelogPreset": "custom-sf-changelog",
   "ignoreChanges": ["**/__fixtures__/**", "**/__tests__/**", "**/*.md"],
   "version": "independent"
 }