@automattic/vip 2.12.0 → 2.14.0

package/dist/lib/validations/sql.js

@@ -3,7 +3,7 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.validate = exports.staticSqlValidations = exports.getTableNames = exports.postValidation = void 0;
+exports.validate = exports.staticSqlValidations = exports.getTableNames = void 0;
 
 var _chalk = _interopRequireDefault(require("chalk"));
 
@@ -41,22 +41,62 @@ function formatError(message) {
   return `${_chalk.default.red('SQL Error:')} ${message}`;
 }
 
+function formatWarning(message) {
+  return `${_chalk.default.yellow('Warning:')} ${message}`;
+}
+
 function formatRecommendation(message) {
   return `${_chalk.default.yellow('Recommendation:')} ${message}`;
 }
 
-const errorCheckFormatter = check => {
+const generalCheckFormatter = check => {
+  const errors = [];
+  const infos = [];
+  const validProblems = check.results.filter(result => !result.falsePositive);
+
+  if (validProblems.length > 0) {
+    if (validProblems.some(result => !result.warning)) {
+      problemsFound += 1;
+    }
+
+    for (const problem of validProblems) {
+      const text = `${problem.text || check.message} on line ${problem.lineNumber || ''}.`;
+
+      if (problem.warning) {
+        errors.push({
+          warning: formatWarning(text),
+          recommendation: formatRecommendation(problem.recomendation || check.recommendation)
+        });
+      } else {
+        errors.push({
+          error: formatError(text),
+          recommendation: formatRecommendation(problem.recomendation || check.recommendation)
+        });
+      }
+    }
+  } else {
+    infos.push(`✅ ${check.message} was found 0 times.`);
+  }
+
+  return {
+    errors,
+    infos
+  };
+};
+
+const lineNumberCheckFormatter = check => {
   const errors = [];
   const infos = [];
 
   if (check.results.length > 0) {
     problemsFound += 1;
+    const lineNumbers = check.results.map(result => result.lineNumber);
     errors.push({
-      error: formatError(`${check.message} on line(s) ${check.results.join(', ')}.`),
+      error: formatError(`${check.message} on line(s) ${lineNumbers.join(', ')}.`),
       recommendation: formatRecommendation(check.recommendation)
     });
   } else {
-    infos.push(`✅ ${check.message} was found ${check.results.length} times.`);
+    infos.push(`✅ ${check.message} was found 0 times.`);
   }
 
   return {
@@ -94,7 +134,7 @@ const requiredCheckFormatter = (check, type, isImport) => {
 const infoCheckFormatter = check => {
   const infos = [];
   check.results.forEach(item => {
-    infos.push(item);
+    infos.push(item.text);
   });
   return {
     errors: [],
@@ -102,11 +142,13 @@ const infoCheckFormatter = check => {
   };
 };
 
-function checkTablePrefixes(tables, errors, infos) {
+function checkTablePrefixes(results, errors, infos) {
   const wpTables = [],
         notWPTables = [],
         wpMultisiteTables = [];
-  tables.forEach(tableName => {
+  results.forEach(result => {
+    const tableName = result.text || '';
+
     if (tableName.match(/^wp_(\d+_)/)) {
       wpMultisiteTables.push(tableName);
     } else if (tableName.match(/^wp_/)) {
@@ -136,8 +178,10 @@ function checkTablePrefixes(tables, errors, infos) {
 const checks = {
   binaryLogging: {
     matcher: /SET @@SESSION.sql_log_bin/i,
-    matchHandler: lineNumber => lineNumber,
-    outputFormatter: errorCheckFormatter,
+    matchHandler: lineNumber => ({
+      lineNumber
+    }),
+    outputFormatter: lineNumberCheckFormatter,
     results: [],
     message: 'SET @@SESSION.sql_log_bin statement',
     excerpt: "'SET @@SESSION.sql_log_bin' statement should not be present (case-insensitive)",
@@ -146,8 +190,10 @@ const checks = {
   trigger: {
     // Match `CREATE (DEFINER=`root`@`host`) TRIGGER`
     matcher: /^CREATE (\(?DEFINER=`?(\w*)(`@`)?(\w*\.*%?)*`?\)?)?(| )TRIGGER/i,
-    matchHandler: lineNumber => lineNumber,
-    outputFormatter: errorCheckFormatter,
+    matchHandler: lineNumber => ({
+      lineNumber
+    }),
+    outputFormatter: lineNumberCheckFormatter,
     results: [],
     message: 'TRIGGER statement',
     excerpt: "'TRIGGER' statement should not be present (case-sensitive)",
@@ -155,8 +201,10 @@ const checks = {
   },
   dropDB: {
     matcher: /^DROP DATABASE/i,
-    matchHandler: lineNumber => lineNumber,
-    outputFormatter: errorCheckFormatter,
+    matchHandler: lineNumber => ({
+      lineNumber
+    }),
+    outputFormatter: lineNumberCheckFormatter,
     results: [],
     message: 'DROP DATABASE statement',
     excerpt: "'DROP DATABASE' should not be present (case-insensitive)",
@@ -164,8 +212,10 @@ const checks = {
   },
   useStatement: {
     matcher: /^USE /i,
-    matchHandler: lineNumber => lineNumber,
-    outputFormatter: errorCheckFormatter,
+    matchHandler: lineNumber => ({
+      lineNumber
+    }),
+    outputFormatter: lineNumberCheckFormatter,
     results: [],
     message: 'USE <DATABASE_NAME> statement',
     excerpt: "'USE <DATABASE_NAME>' should not be present (case-insensitive)",
@@ -173,8 +223,10 @@ const checks = {
   },
   alterUser: {
     matcher: /^(ALTER USER|SET PASSWORD)/i,
-    matchHandler: lineNumber => lineNumber,
-    outputFormatter: errorCheckFormatter,
+    matchHandler: lineNumber => ({
+      lineNumber
+    }),
+    outputFormatter: lineNumberCheckFormatter,
     results: [],
     message: 'ALTER USER statement',
     excerpt: "'ALTER USER' should not be present (case-insensitive)",
@@ -182,7 +234,9 @@ const checks = {
   },
   dropTable: {
     matcher: /^DROP TABLE IF EXISTS `?([a-z0-9_]*)/i,
-    matchHandler: (lineNumber, results) => results[1],
+    matchHandler: (lineNumber, results) => ({
+      text: results[1]
+    }),
     outputFormatter: requiredCheckFormatter,
     results: [],
     message: 'DROP TABLE',
@@ -191,7 +245,9 @@ const checks = {
   },
   createTable: {
     matcher: /^CREATE TABLE (?:IF NOT EXISTS )?`?([a-z0-9_]*)/i,
-    matchHandler: (lineNumber, results) => results[1],
+    matchHandler: (lineNumber, results) => ({
+      text: results[1]
+    }),
     outputFormatter: requiredCheckFormatter,
     results: [],
     message: 'CREATE TABLE',
@@ -200,42 +256,85 @@ const checks = {
   },
   siteHomeUrl: {
     matcher: "'(siteurl|home)',\\s?'(.*?)'",
-    matchHandler: (lineNumber, results) => results[0],
+    matchHandler: (lineNumber, results) => ({
+      text: results[1]
+    }),
     outputFormatter: infoCheckFormatter,
     results: [],
     message: 'Siteurl/home matches',
     excerpt: 'Siteurl/home options',
     recommendation: ''
   },
+  siteHomeUrlLando: {
+    matcher: "'(siteurl|home)',\\s?'(.*?)'",
+    matchHandler: (lineNumber, results, expectedDomain) => {
+      const foundDomain = results[2].replace(/https?:\/\//, '');
+
+      if (!foundDomain.trim()) {
+        return {
+          falsePositive: true
+        };
+      }
+
+      if (foundDomain.includes(expectedDomain)) {
+        return {
+          falsePositive: true
+        };
+      }
+
+      return {
+        warning: true,
+        lineNumber,
+        recomendation: `Use '--search-replace="${foundDomain},${expectedDomain}"' switch to replace the domain`
+      };
+    },
+    outputFormatter: generalCheckFormatter,
+    results: [],
+    message: 'Siteurl/home options not pointing to lando domain',
+    excerpt: 'Siteurl/home options not pointing to lando domain',
+    recommendation: 'Use search-replace to change environment\'s domain'
+  },
   engineInnoDB: {
     matcher: / ENGINE=(?!(InnoDB))/i,
-    matchHandler: lineNumber => lineNumber,
-    outputFormatter: errorCheckFormatter,
+    matchHandler: lineNumber => ({
+      lineNumber
+    }),
+    outputFormatter: lineNumberCheckFormatter,
     results: [],
     message: 'ENGINE != InnoDB',
     excerpt: "'ENGINE=InnoDB' should be present (case-insensitive) for all tables",
     recommendation: "Ensure your application works with InnoDB and update your SQL dump to include only 'ENGINE=InnoDB' engine definitions in 'CREATE TABLE' statements. " + "We suggest you search for all 'ENGINE=X' entries and replace them with 'ENGINE=InnoDB'!"
   }
 };
+const DEV_ENV_SPECIFIC_CHECKS = ['useStatement', 'siteHomeUrlLando'];
 
-const postValidation = async (filename, isImport = false) => {
+const postValidation = async options => {
   await (0, _tracker.trackEvent)('import_validate_sql_command_execute', {
-    is_import: isImport
+    is_import: options.isImport
   });
 
-  if (!isImport) {
+  if (!options.isImport) {
     (0, _singleLineLog.stdout)(`Finished processing ${lineNum} lines.`);
     console.log('\n');
   }
 
   const errorSummary = {};
-  const checkEntries = Object.entries(checks);
+  const checkEntries = Object.entries(checks).filter(([type]) => !options.skipChecks.includes(type));
+  const formattedWarnings = [];
   let formattedErrors = [];
   let formattedInfos = [];
 
   for (const [type, check] of checkEntries) {
-    const formattedOutput = check.outputFormatter(check, type, isImport);
-    formattedErrors = formattedErrors.concat(formattedOutput.errors);
+    const formattedOutput = check.outputFormatter(check, type, options.isImport);
+
+    for (const error of formattedOutput.errors) {
+      if (error.warning) {
+        formattedWarnings.push(error);
+      } else {
+        formattedErrors.push(error);
+      }
+    }
+
     formattedInfos = formattedInfos.concat(formattedOutput.infos);
     errorSummary[type] = check.results.length;
   } // eslint-disable-next-line camelcase
@@ -267,9 +366,24 @@ const postValidation = async (filename, isImport = false) => {
     formattedErrors = formattedErrors.concat(errorObject);
   }
 
+  if (formattedWarnings.length) {
+    const warningOutput = [];
+    formattedWarnings.forEach(warning => {
+      warningOutput.push(warning.warning);
+
+      if (warning.recommendation) {
+        warningOutput.push(warning.recommendation);
+      }
+
+      warningOutput.push('');
+    });
+    console.log(warningOutput.join('\n'));
+    console.log('');
+  }
+
   if (problemsFound > 0) {
     await (0, _tracker.trackEvent)('import_validate_sql_command_failure', {
-      is_import: isImport,
+      is_import: options.isImport,
       error: errorSummary
     });
     const errorOutput = [`SQL validation failed due to ${_chalk.default.red(problemsFound)} error(s)`, ''];
@@ -283,25 +397,23 @@ const postValidation = async (filename, isImport = false) => {
       errorOutput.push('');
     });
 
-    if (isImport) {
+    if (options.isImport) {
       throw new Error(errorOutput.join('\n'));
     }
 
     exit.withError(errorOutput.join('\n'));
   }
 
-  if (!isImport) {
+  if (!options.isImport) {
     console.log(formattedInfos.join('\n'));
     console.log('');
   }
 
   await (0, _tracker.trackEvent)('import_validate_sql_command_success', {
-    is_import: isImport
+    is_import: options.isImport
   });
 };
 
-exports.postValidation = postValidation;
-
 const getTableNames = () => {
   return tableNames;
 };
@@ -318,53 +430,63 @@ const checkForTableName = line => {
   }
 };
 
-const perLineValidations = (line, runAsImport, skipChecks) => {
+const DEFAULT_VALIDATION_OPTIONS = {
+  isImport: true,
+  skipChecks: DEV_ENV_SPECIFIC_CHECKS,
+  extraCheckParams: {}
+};
+
+const perLineValidations = (line, options = DEFAULT_VALIDATION_OPTIONS) => {
   if (lineNum % 500 === 0) {
-    runAsImport ? '' : (0, _singleLineLog.stdout)(`Reading line ${lineNum} `);
+    options.isImport ? '' : (0, _singleLineLog.stdout)(`Reading line ${lineNum} `);
   }
 
   checkForTableName(line);
-  const checkKeys = Object.keys(checks).filter(checkItem => !skipChecks.includes(checkItem));
-  const checkValues = checkKeys.map(checkKey => checks[checkKey]);
-  checkValues.forEach(check => {
+  const checkKeys = Object.keys(checks).filter(checkItem => !options.skipChecks.includes(checkItem));
+
+  for (const checkKey of checkKeys) {
+    const check = checks[checkKey];
     const results = line.match(check.matcher);
+    const extraCheckParams = options.extraCheckParams[checkKey];
 
     if (results) {
-      check.results.push(check.matchHandler(lineNum, results));
+      check.results.push(check.matchHandler(lineNum, results, extraCheckParams));
     }
-  });
-  lineNum += 1;
-};
+  }
 
-const execute = (line, isImport = true, skipChecks = ['useStatement']) => {
-  perLineValidations(line, isImport, skipChecks);
+  lineNum += 1;
 };
 
 const postLineExecutionProcessing = async ({
-  fileName,
-  isImport
+  isImport,
+  skipChecks
 }) => {
-  await postValidation(fileName, isImport);
+  await postValidation({
+    isImport: isImport || false,
+    skipChecks: skipChecks || DEV_ENV_SPECIFIC_CHECKS,
+    extraCheckParams: {}
+  });
 };
 
 const staticSqlValidations = {
-  execute,
+  execute: perLineValidations,
   postLineExecutionProcessing
 }; // For standalone SQL validations
 
 exports.staticSqlValidations = staticSqlValidations;
 
-const validate = async (filename, skipChecks = ['useStatement']) => {
+const validate = async (filename, options = DEFAULT_VALIDATION_OPTIONS) => {
   const readInterface = await (0, _lineByLine.getReadInterface)(filename);
+  options.isImport = false;
   readInterface.on('line', line => {
-    execute(line, false, skipChecks);
+    perLineValidations(line, options);
   }); // Block until the processing completes
 
   await new Promise(resolve => readInterface.on('close', resolve));
   readInterface.close();
   await postLineExecutionProcessing({
-    filename,
-    isImport: false
+    isImport: options.isImport,
+    skipChecks: options.skipChecks
   });
 };