@automattic/vip 2.22.0 → 2.24.0

package/dist/lib/validations/sql.js

@@ -4,23 +4,14 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.validate = exports.staticSqlValidations = exports.getTableNames = void 0;
-
 var _chalk = _interopRequireDefault(require("chalk"));
-
 var _singleLineLog = require("single-line-log");
-
 var exit = _interopRequireWildcard(require("../cli/exit"));
-
 var _tracker = require("../tracker");
-
 var _lineByLine = require("./line-by-line");
-
 function _getRequireWildcardCache(nodeInterop) { if (typeof WeakMap !== "function") return null; var cacheBabelInterop = new WeakMap(); var cacheNodeInterop = new WeakMap(); return (_getRequireWildcardCache = function (nodeInterop) { return nodeInterop ? cacheNodeInterop : cacheBabelInterop; })(nodeInterop); }
-
 function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj && obj.__esModule) { return obj; } if (obj === null || typeof obj !== "object" && typeof obj !== "function") { return { default: obj }; } var cache = _getRequireWildcardCache(nodeInterop); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (key !== "default" && Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj.default = obj; if (cache) { cache.set(obj, newObj); } return newObj; }
-
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
 /**
  * 
  * @format
@@ -33,35 +24,29 @@ function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { de
 /**
  * Internal dependencies
  */
+
 let problemsFound = 0;
 let lineNum = 1;
 const tableNames = [];
-
 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 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),
@@ -77,17 +62,14 @@ const generalCheckFormatter = check => {
   } 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);
@@ -98,20 +80,16 @@ const lineNumberCheckFormatter = check => {
   } else {
     infos.push(`✅ ${check.message} was found 0 times.`);
   }
-
   return {
     errors,
     infos
   };
 };
-
 const requiredCheckFormatter = (check, type, isImport) => {
   const errors = [];
   const infos = [];
-
   if (check.results.length > 0) {
     infos.push(`✅ ${check.message} was found ${check.results.length} times.`);
-
     if (type === 'createTable') {
       if (!isImport) {
         checkTablePrefixes(check.results, errors, infos);
@@ -124,13 +102,11 @@ const requiredCheckFormatter = (check, type, isImport) => {
       recommendation: formatRecommendation(check.recommendation)
     });
   }
-
   return {
     errors,
     infos
   };
 };
-
 const infoCheckFormatter = check => {
   const infos = [];
   check.results.forEach(item => {
@@ -141,14 +117,12 @@ const infoCheckFormatter = check => {
     infos
   };
 };
-
 function checkTablePrefixes(results, errors, infos) {
   const wpTables = [],
-        notWPTables = [],
-        wpMultisiteTables = [];
+    notWPTables = [],
+    wpMultisiteTables = [];
   results.forEach(result => {
     const tableName = result.text || '';
-
     if (tableName.match(/^wp_(\d+_)/)) {
       wpMultisiteTables.push(tableName);
     } else if (tableName.match(/^wp_/)) {
@@ -157,11 +131,9 @@ function checkTablePrefixes(results, errors, infos) {
       notWPTables.push(tableName);
     }
   });
-
   if (wpTables.length > 0) {
     infos.push(` - wp_ prefix tables found: ${wpTables.length} `);
   }
-
   if (notWPTables.length > 0) {
     problemsFound += 1;
     errors.push({
@@ -169,12 +141,10 @@ function checkTablePrefixes(results, errors, infos) {
       recommendation: formatRecommendation('Please make sure all table names are prefixed with `wp_`')
     });
   }
-
   if (wpMultisiteTables.length > 0) {
     infos.push(` - wp_n_ prefix tables found: ${wpMultisiteTables.length} `);
   }
 }
-
 const checks = {
   binaryLogging: {
     matcher: /SET @@SESSION.sql_log_bin/i,
@@ -291,19 +261,16 @@ const checks = {
     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,
@@ -329,26 +296,21 @@ const checks = {
   }
 };
 const DEV_ENV_SPECIFIC_CHECKS = ['useStatement', 'siteHomeUrlLando'];
-
 const postValidation = async options => {
   await (0, _tracker.trackEvent)('import_validate_sql_command_execute', {
     is_import: options.isImport
   });
-
   if (!options.isImport) {
     (0, _singleLineLog.stdout)(`Finished processing ${lineNum} lines.`);
     console.log('\n');
   }
-
   const errorSummary = {};
   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, options.isImport);
-
     for (const error of formattedOutput.errors) {
       if (error.warning) {
         formattedWarnings.push(error);
@@ -356,19 +318,15 @@ const postValidation = async options => {
         formattedErrors.push(error);
       }
     }
-
     formattedInfos = formattedInfos.concat(formattedOutput.infos);
     errorSummary[type] = check.results.length;
-  } // eslint-disable-next-line camelcase
-
-
+  }
+  // eslint-disable-next-line camelcase
   errorSummary.problems_found = problemsFound;
   const tableNamesSet = new Set(tableNames);
-
   if (tableNames.length > tableNamesSet.size) {
     // there was a duplciate table
     problemsFound++;
-
     function findDuplicates(arr) {
       const filtered = arr.filter(item => {
         if (tableNamesSet.has(item)) {
@@ -379,7 +337,6 @@ const postValidation = async options => {
       });
       return [...new Set(filtered)];
     }
-
     const duplicates = findDuplicates(tableNames);
     const errorObject = {
       error: formatError('Duplicate table names were found: ' + duplicates.join(',')),
@@ -387,22 +344,18 @@ const postValidation = async options => {
     };
     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: options.isImport,
@@ -411,75 +364,58 @@ const postValidation = async options => {
     const errorOutput = [];
     formattedErrors.forEach(error => {
       errorOutput.push(error.error);
-
       if (error.recommendation) {
         errorOutput.push(error.recommendation);
       }
-
       errorOutput.push('');
     });
     errorOutput.push(_chalk.default.bold.red(`SQL validation failed due to ${problemsFound} error(s)`));
-
     if (options.isImport) {
       throw new Error(errorOutput.join('\n'));
     }
-
     exit.withError(errorOutput.join('\n'));
   }
-
   if (!options.isImport) {
     console.log(formattedInfos.join('\n'));
     console.log('');
   }
-
   await (0, _tracker.trackEvent)('import_validate_sql_command_success', {
     is_import: options.isImport
   });
 };
-
 const getTableNames = () => {
   return tableNames;
 };
-
 exports.getTableNames = getTableNames;
-
 const checkForTableName = line => {
   const matches = line.match(/(?<=^CREATE\sTABLE\s)`?(?:(wp_[\d+_]?\w+))`?/);
-
   if (matches) {
-    const tableName = matches[1]; // we should only have one match if we have any since we're looking at the start of the string
-
+    const tableName = matches[1];
+    // we should only have one match if we have any since we're looking at the start of the string
     tableNames.push(tableName);
   }
 };
-
 const DEFAULT_VALIDATION_OPTIONS = {
   isImport: true,
   skipChecks: DEV_ENV_SPECIFIC_CHECKS,
   extraCheckParams: {}
 };
-
 const perLineValidations = (line, options = DEFAULT_VALIDATION_OPTIONS) => {
   if (lineNum % 500 === 0) {
     options.isImport ? '' : (0, _singleLineLog.stdout)(`Reading line ${lineNum} `);
   }
-
   checkForTableName(line);
   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, extraCheckParams));
     }
   }
-
   lineNum += 1;
 };
-
 const postLineExecutionProcessing = async ({
   isImport,
   skipChecks
@@ -490,21 +426,21 @@ const postLineExecutionProcessing = async ({
     extraCheckParams: {}
   });
 };
-
 const staticSqlValidations = {
   execute: perLineValidations,
   postLineExecutionProcessing
-}; // For standalone SQL validations
+};
 
+// For standalone SQL validations
 exports.staticSqlValidations = staticSqlValidations;
-
 const validate = async (filename, options = DEFAULT_VALIDATION_OPTIONS) => {
   const readInterface = await (0, _lineByLine.getReadInterface)(filename);
   options.isImport = false;
   readInterface.on('line', line => {
     perLineValidations(line, options);
-  }); // Block until the processing completes
+  });
 
+  // Block until the processing completes
   await new Promise(resolve => readInterface.on('close', resolve));
   readInterface.close();
   await postLineExecutionProcessing({
@@ -512,5 +448,4 @@ const validate = async (filename, options = DEFAULT_VALIDATION_OPTIONS) => {
     skipChecks: options.skipChecks
   });
 };
-
 exports.validate = validate;

package/dist/lib/validations/utils.js

@@ -4,7 +4,6 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.getMultilineStatement = getMultilineStatement;
-
 /**
  * Get SQL statements matching a supplied pattern from a file stream
  *
@@ -15,31 +14,27 @@ function getMultilineStatement(statementRegex) {
   const matchingStatements = [];
   let isCapturing = false;
   let index = 0;
+
   /**
    * Processes each line of the file stream and builds an array of statements which start with the supplied pattern
    *
    * @param {string} line A line from the file stream
    * @returns {array} An array of matching statements where each statement is presented as an array of lines
    */
-
   return line => {
     const shouldStartCapture = statementRegex.test(line);
     const shouldEndCapture = (shouldStartCapture || isCapturing) && /;$/.test(line);
-
     if (shouldStartCapture) {
       isCapturing = true;
       matchingStatements[index] = [];
     }
-
     if (isCapturing) {
       matchingStatements[index].push(line);
     }
-
     if (shouldEndCapture) {
       isCapturing = false;
       index++;
     }
-
     return matchingStatements;
   };
 }