index.js

var path = require('path');
var crypto = require('crypto');
var semver = require('semver');
var async = require('async');
var exec = require('child_process').exec;
var _ = require('@sailshq/lodash');
var jsBeautify = require('js-beautify');
var walk = require('walk');
var figlet = require('figlet');
var chalk = require('chalk');

var includeAll = require('include-all');
var Prompts = require('machinepack-prompts');
var Filesystem = require('machinepack-fs');
var sailsGen = require('sails-generate');

var INVALID_VALIDATIONS = require('./invalid-validations');

module.exports = (function() {

  // Get the project directory.
  var projectDir = process.cwd();

  return {
    before: function before(scope, done) {

      // Don't say "Created a new migrate-app!" at the end of all this.
      scope.suppressFinalLog = true;

      scope.force = true;

      // Declare a var to hold all the tasks we want to run.
      var tasks = [];

      // Load up the project's package.json file.
      var projectPackageJson = (function() {
        try {
          return require(path.resolve(projectDir, 'package.json'));
        } catch (e) {
          return done(new Error('Could not find a package.json in the current folder.  Are you sure this is a Sails app?'));
        }
      })();

      if (!projectPackageJson.dependencies || !projectPackageJson.dependencies.sails) {
        return done(new Error('This project does not include sails as a dependency.  Are you sure this is a Sails app?'));
      }

      // Load up the existing `config/globals.js` file, if any.
      var globalsConfig = (function() {
        try {
          return require(path.resolve(projectDir, 'config', 'globals')).globals;
        } catch (e) {
          return {};
        }
      })();

      // Load up the existing `config/models.js` file, if any.
      var modelsConfig = (function() {
        try {
          return require(path.resolve(projectDir, 'config', 'models')).models;
        } catch (e) {
          return {};
        }
      })();

      // Load up the existing `config/connections.js` file, if any.
      var connectionsConfig = (function() {
        try {
          return require(path.resolve(projectDir, 'config', 'connections-old.js.txt')).connections;
        } catch (e) {
          try {
            return require(path.resolve(projectDir, 'config', 'connections')).connections;
          } catch (e2) {
            return {};
          }
        }
      })();

      //  ██████╗ ██╗   ██╗██╗██╗     ██████╗     ████████╗ █████╗ ███████╗██╗  ██╗███████╗
      //  ██╔══██╗██║   ██║██║██║     ██╔══██╗    ╚══██╔══╝██╔══██╗██╔════╝██║ ██╔╝██╔════╝
      //  ██████╔╝██║   ██║██║██║     ██║  ██║       ██║   ███████║███████╗█████╔╝ ███████╗
      //  ██╔══██╗██║   ██║██║██║     ██║  ██║       ██║   ██╔══██║╚════██║██╔═██╗ ╚════██║
      //  ██████╔╝╚██████╔╝██║███████╗██████╔╝       ██║   ██║  ██║███████║██║  ██╗███████║
      //  ╚═════╝  ╚═════╝ ╚═╝╚══════╝╚═════╝        ╚═╝   ╚═╝  ╚═╝╚══════╝╚═╝  ╚═╝╚══════╝

      //  ┬┌┐┌┌─┐┌┬┐┌─┐┬  ┬    ┌─┐┌─┐┬┬  ┌─┐
      //  ││││└─┐ │ ├─┤│  │    └─┐├─┤││  └─┐
      //  ┴┘└┘└─┘ ┴ ┴ ┴┴─┘┴─┘  └─┘┴ ┴┴┴─┘└─┘

      if (!semver.satisfies(projectPackageJson.dependencies['sails'].replace(/^\D+/,''), '^1.0.0-0')) {

        tasks.push(function(done) {

          if (scope.reportOnly) {return done();}

          console.log('--------------------------------------------------------------------------------------------------------');
          console.log('BEFORE PROCEEDING, it\'s a good idea to double-check that your app lifts using the currently-installed');
          console.log('version of Sails, and fix any pre-existing problems before attempting to upgrade.');
          console.log('--------------------------------------------------------------------------------------------------------');
          console.log();

          Prompts.confirm({
            message: 'First things first -- looks like we need to install Sails 1.0.\n\n'+
                      'Is that okay?'
          }).exec({
            no: function() {
              console.log('Okay, exiting for now.  Run `sails generate migrate-app` again when you\'re ready to migrate to Sails 1.0!\n');
              process.exit(0);
            },
            success: function() {
              console.log('Okay -- installing now (please wait)!\n');
              exec('npm install sails@^1.0.0-0 --save', {cwd: projectDir}, done);
            },
            error: done
          });
        });

      }

      //  ┬┌┐┌┌─┐┌┬┐┌─┐┬  ┬    ┌─┐┌─┐┌─┐┬┌─┌─┐┌─┐┌─┐┌─┐
      //  ││││└─┐ │ ├─┤│  │    ├─┘├─┤│  ├┴┐├─┤│ ┬├┤ └─┐
      //  ┴┘└┘└─┘ ┴ ┴ ┴┴─┘┴─┘  ┴  ┴ ┴└─┘┴ ┴┴ ┴└─┘└─┘└─┘

      // Declare a var to hold the dictionary of packages we need to install.
      var packagesToInstall = {};

      if (!projectPackageJson.dependencies['sails-hook-orm'] || !semver.satisfies(projectPackageJson.dependencies['sails-hook-orm'].replace(/^\D+/,''), '^2.0.0-0')) {
        packagesToInstall['sails-hook-orm'] = '^2.0.0-0';
      }

      if (!projectPackageJson.dependencies['sails-hook-grunt']) {
        packagesToInstall['sails-hook-grunt'] = '^1.0.0-0';
      }

      if (!projectPackageJson.dependencies['sails-hook-sockets'] || !semver.satisfies(projectPackageJson.dependencies['sails-hook-sockets'].replace(/^\D+/,''), '^1.0.0-0')) {
        packagesToInstall['sails-hook-sockets'] = '^1.0.0-0';
      }

      if (projectPackageJson.dependencies['sails-postgresql'] && !semver.satisfies(projectPackageJson.dependencies['sails-postgresql'].replace(/^\D+/,''), '^1.0.0-0')) {
        packagesToInstall['sails-postgresql'] = '^1.0.0-0';
      }

      if (projectPackageJson.dependencies['sails-mysql'] && !semver.satisfies(projectPackageJson.dependencies['sails-mysql'].replace(/^\D+/,''), '^1.0.0-0')) {
        packagesToInstall['sails-mysql'] = '^1.0.0-0';
      }

      if (projectPackageJson.dependencies['sails-mongo'] && !semver.satisfies(projectPackageJson.dependencies['sails-mongo'].replace(/^\D+/,''), '^1.0.0-0')) {
        packagesToInstall['sails-mongo'] = '^1.0.0-0';
      }

      if (projectPackageJson.dependencies['socket.io-redis'] && !semver.satisfies(projectPackageJson.dependencies['socket.io-redis'].replace(/^\D+/,''), '^5.2.0')) {
        packagesToInstall['socket.io-redis'] = '5.2.0';
      }

      if (globalsConfig._ !== false && !projectPackageJson.dependencies['lodash']) {
        packagesToInstall['lodash'] = '3.10.1';
      }

      if (globalsConfig.async !== false && !projectPackageJson.dependencies['async']) {
        packagesToInstall['async'] = '2.1.4';
      }

      // If we have stuff to install, confirm with the user, and then do it.
      if (_.keys(packagesToInstall).length) {

        tasks.push(function(done) {
          var packageList = _.map(packagesToInstall, function(ver, package) {
            return package + '@' + ver.replace(/-0$/,'');
          }).join('\n');
          Prompts.confirm({
            message: 'Looks like we need to install the following packages: \n\n' +
                      packageList + '\n\n' +
                      'Is that okay?'
          }).exec({
            no: function() {
              console.log('Okay, but your app may not lift without them!\n');
              return done();
            },
            success: function() {
              console.log('Okay -- installing now!\n');
              async.eachSeries(_.keys(packagesToInstall), function(package, cb) {
                var version = packagesToInstall[package];
                console.log('Installing ' + package + '@' + version.replace(/-0$/,'') + '...');
                exec('npm install ' + package + '@' + version + ' --save' + (version[0] !== '^' ? ' --save-exact' : ''), {cwd: projectDir}, cb);
              }, done);
            },
            error: done
          });

        });

      }

      //  ┬─┐┌─┐┌┬┐┌─┐┬  ┬┌─┐  ┌─┐┌─┐┌─┐┬┌─┌─┐┌─┐┌─┐┌─┐
      //  ├┬┘├┤ ││││ │└┐┌┘├┤   ├─┘├─┤│  ├┴┐├─┤│ ┬├┤ └─┐
      //  ┴└─└─┘┴ ┴└─┘ └┘ └─┘  ┴  ┴ ┴└─┘┴ ┴┴ ┴└─┘└─┘└─┘

      // Get an array of packages we can remove.
      // var packagesToRemove = _.intersection(_.keys(projectPackageJson.dependencies), [
      //   // 'ejs',
      //   'grunt-contrib-clean',
      //   'grunt-contrib-coffee',
      //   'grunt-contrib-concat',
      //   'grunt-contrib-copy',
      //   'grunt-contrib-cssmin',
      //   'grunt-contrib-jst',
      //   'grunt-contrib-less',
      //   'grunt-contrib-uglify',
      //   'grunt-contrib-watch',
      //   'grunt-sails-linker',
      //   'grunt-sync',
      //   'sails-disk'
      // ]);

      // // If we have stuff to install, confirm with the user, and then do it.
      // if (packagesToRemove.length) {

      //   tasks.push(function(done) {
      //     Prompts.confirm({
      //       message: 'Looks like we can remove the following packages: \n\n' +
      //                 packagesToRemove.join('\n') + '\n\n' +
      //                 'These packages are now built-in to Sails.  Removing is strictly optional, but will reduce your app\'s file size.\n\nOkay to remove the packages?'
      //     }).exec({
      //       no: function() {
      //         console.log('Okay, no problem -- we\'ll leave those packages in place!\n');
      //         return done();
      //       },
      //       success: function() {
      //         console.log('Okay -- removing now!\n');
      //         async.eachSeries(packagesToRemove, function(package, cb) {
      //           console.log('Removing ' + package + '...');
      //           exec('npm uninstall ' + package + ' --save', {cwd: projectDir}, cb);
      //         }, done);
      //       },
      //       error: done
      //     });

      //   });

      // }

      //  ┌─┐┬  ┌─┐┌┐ ┌─┐┬    ┌─┐┌─┐┌┐┌┌─┐┬┌─┐
      //  │ ┬│  │ │├┴┐├─┤│    │  │ ││││├┤ ││ ┬
      //  └─┘┴─┘└─┘└─┘┴ ┴┴─┘  └─┘└─┘┘└┘└  ┴└─┘

      // Unless everything in the current global config is turned off, offer to replace the globals.js file.
      if (globalsConfig !== false && (globalsConfig._ !== false || globalsConfig.async !== false || globalsConfig.models !== false || globalsConfig.sails !== false)) {

        tasks.push(function(done) {

          if (scope.reportOnly) {return done();}

          Prompts.confirm({
            message: 'In order for your app to lift, your `config/globals.js` file needs to be updated.\n' +
                     'We can update it for you (and back up your original file).\n'+
                     'See http://bit.ly/sails_migration_checklist for more info.\n\n'+
                     'Update `config/globals.js` file now?'
          }).exec({
            no: function() {
              console.log('Okay, but your app may not lift without it!\n');
              return done();
            },
            success: function() {
              console.log('Okay -- updating now!\n');

              // Back up original file
              Filesystem.mv({
                source: path.resolve(projectDir, 'config', 'globals.js'),
                destination: path.resolve(projectDir, 'config', 'globals-old.js.txt')
              }).exec(function(err) {
                if (err) {
                  if (err.code === 'EEXIST') {
                    console.log('Detected an existing backed-up globals file, so keeping that one...');
                  }
                  else if (err.exit === 'doesNotExist') {
                    /* no-op */
                  }
                  else {
                    return done(err);
                  }
                }


                // Get the template for the new globals config file.
                var globalsTemplate = Filesystem.readSync({source: path.resolve(__dirname, 'templates', 'config-globals-1.0.js.template')}).execSync();

                // Fill out the template with the appropriate values based on the project's existing global config.
                var newGlobalsConfig = _.template(globalsTemplate)({
                  lodashVal: globalsConfig._ === false ? false : 'require(\'lodash\')',
                  asyncVal: globalsConfig.async === false ? false : 'require(\'async\')',
                  modelsVal: globalsConfig.models === false ? false : true,
                  sailsVal: globalsConfig.sails === false ? false : true
                });

                try {
                  Filesystem.writeSync({
                    string: newGlobalsConfig,
                    destination: path.resolve(projectDir, 'config', 'globals.js'),
                    force: true
                  }).execSync();
                } catch (e) {
                  return done(e);
                }
                return done();

              });
            },
            error: done
          });

        });

      }

      //  ┌┬┐┌─┐┌┬┐┌─┐┬  ┌─┐  ┌─┐┌─┐┌┐┌┌─┐┬┌─┐
      //  ││││ │ ││├┤ │  └─┐  │  │ ││││├┤ ││ ┬
      //  ┴ ┴└─┘─┴┘└─┘┴─┘└─┘  └─┘└─┘┘└┘└  ┴└─┘

      tasks.push(function(done) {

        if (scope.reportOnly) {return done();}

        Prompts.confirm({
          message: 'If your app uses models, you will likely need to update your `config/models.js`\n'+
                   'before lifting with Sails 1.0.  We can add a new `config/models_1_0.js` file for now\n'+
                   'which should allow your app to lift, and then when you\'re ready you merge that\n'+
                   'file with your existing `config/models.js`.\n\n'+
                   'See http://bit.ly/sails_migration_model_config for more info.\n\n'+
                   'Create a new `config/models_1_0.js file now?'
        }).exec({
          no: function() {
            console.log('Okay, but your app may not lift without it!\n');
            return done();
          },
          success: function() {
            console.log('Okay -- creating now!\n');

            // Get the template for the new globals config file.
            var modelsConfigTemplate = Filesystem.readSync({source: path.resolve(__dirname, 'templates', 'config-models-1.0.js.template')}).execSync();

            // Get the default datastore config.
            var defaultDatastoreConfig = modelsConfig.connection && connectionsConfig[modelsConfig.connection];

            // Fill out the template with the appropriate values based on the project's existing global config.
            var newModelsConfig = _.template(modelsConfigTemplate)({
              datastore: modelsConfig.connection || 'default',
              pkConfig: defaultDatastoreConfig && defaultDatastoreConfig.adapter === 'sails-mongo' ? '{ type: \'string\', columnName: \'_id\' }' : '{ type: \'number\', autoIncrement: true, }',
              defaultDEK: crypto.randomBytes(32).toString('base64')
            });

            try {
              Filesystem.writeSync({
                string: newModelsConfig,
                destination: path.resolve(projectDir, 'config', 'models_1_0.js'),
                force: true
              }).execSync();
            } catch (e) {
              return done(e);
            }
            return done();
          },
          error: done
        });

      });

      // Declare a var to hold the model definitions.
      var models;

      // Get all the model definitions into `models`
      tasks.push(function(done) {

        // Load all model files, so we know what we're dealing with.
        includeAll.optional({
          dirname: path.resolve(projectDir, 'api', 'models'),
          filter: /^([^.]+)\.(?:(?!md|txt).)+$/,
          replaceExpr : /^.*\//,
        }, function(err, _models) {
          if (err) { return done(err); }
          models = _models;
          return done();
        });

      });

      //  ┌┬┐┌─┐┌┬┐┌─┐┌─┐┌┬┐┌─┐┬─┐┌─┐┌─┐  ┌─┐┌─┐┌┐┌┌─┐┬┌─┐
      //   ││├─┤ │ ├─┤└─┐ │ │ │├┬┘├┤ └─┐  │  │ ││││├┤ ││ ┬
      //  ─┴┘┴ ┴ ┴ ┴ ┴└─┘ ┴ └─┘┴└─└─┘└─┘  └─┘└─┘┘└┘└  ┴└─┘

      if (_.keys(connectionsConfig).length) {
        tasks.push(function(done) {

          if (scope.reportOnly) {return done();}

          Prompts.confirm({
            message: 'The `connections` configuration has been changed to `datastores` in Sails 1.0.\n'+
                     'In addition, _all_ configured datastores will now always be loaded, even if no models\n'+
                     'are actually using them.  We can migrate your existing `config/connections.js` file over\n'+
                     'to `config/datastores.js` for you (and back up the original file).\n\n'+
                     'See http://bit.ly/sails_migration_datastore_config for more info.\n\n'+
                     'Update `config/connections.js` to `config/datastores.js now?'
          }).exec({
            no: function() {
              console.log('Okay, but your app may not lift without it!\n');
              return done();
            },
            success: function() {
              console.log('Okay -- updating now!\n');

              // Build up a list of datastores that are actually in use.
              var datastoresInUse = [];
              if (modelsConfig.connection && modelsConfig.connection !== 'localDiskDb') {
                datastoresInUse.push(modelsConfig.connection);
              }
              _.each(models, function(model) {
                if (model.connection) {
                  datastoresInUse.push(model.connection);
                }
              });

              // Build up a datastores dictionary
              var datastoresStr = _.reduce(datastoresInUse, function(memo, datastoreInUse) {
                if (connectionsConfig[datastoreInUse]) {
                  memo.push('\'' + datastoreInUse + '\': ' + require('util').inspect(connectionsConfig[datastoreInUse], {depth: null}));
                }
                return memo;
              }, []).join(',\n');

              // Get the template for the new globals config file.
              var datastoresConfigTemplate = Filesystem.readSync({source: path.resolve(__dirname, 'templates', 'config-datastores-1.0.js.template')}).execSync();

              // Fill out the template with the appropriate values based on the project's existing global config.
              var newDatastoresConfig = _.template(datastoresConfigTemplate)({
                datastores: jsBeautify('  ' + datastoresStr, {indent_level: 2, indent_size: 2})// eslint-disable-line camelcase
              });

              try {
                Filesystem.writeSync({
                  string: newDatastoresConfig,
                  destination: path.resolve(projectDir, 'config', 'datastores.js'),
                  force: true
                }).execSync();
                Filesystem.mv({
                  source: path.resolve(projectDir, 'config', 'connections.js'),
                  destination: path.resolve(projectDir, 'config', 'connections-old.js.txt')
                }).exec(function(err) {
                  if (err) {
                    if (err.code === 'EEXIST') {
                      console.log('Detected an existing backed-up connections file, so keeping that one...');
                    }
                    else if (err.exit === 'doesNotExist') {
                      return done();
                    }
                    else {
                      return done(err);
                    }
                  }

                  return done();
                });
              } catch (e) {
                return done(e);
              }
            },
            error: done
          });


        });

      }


      //  ┌─┐┌─┐┬┬  ┌─┐ ┬┌─┐  ┬┌─┐
      //  └─┐├─┤││  └─┐ ││ │  │└─┐
      //  └─┘┴ ┴┴┴─┘└─┘o┴└─┘o└┘└─┘

      tasks.push(function(done) {

        if (scope.reportOnly) {return done();}

        Prompts.confirm({
          message: 'If your app uses (or plans to use) websockets, you should update your `sails.io.js`\n'+
                   'file to the latest version.  We can do that for you.\n\n'+
                   'Update your `sails.io.js` file now?'
        }).exec({
          no: function() {
            console.log('Okay, no problem.  You may need to update the `transports` setting in');
            console.log('your config/sockets.js file.  See http://bit.ly/sails_migration_websockets');
            console.log('for more info.\n');
            return done();
          },
          success: function() {
            console.log('Okay -- updating now!\n');
            var scope = {
              rootPath: process.cwd(),
              generatorType: 'sails.io.js',
              modules: {
                'sails.io.js': require('sails-generate/lib/core-generators/sails.io.js')
              }
            };
            try {
              return sailsGen(scope, done);
            } catch (e) {
              console.log(chalk.yellow.bold('We were unable to determine the current location of your `sails.io.js` file.'));
              console.log(chalk.yellow('If you have one, you should replace it yourself later by running:'));
              console.log(chalk.yellow('sails generate sails.io.js <path-to-your-sails.io.js>'));
              console.log();
              return done();
            }
          },
          error: done
        });

      });

      //  ┌─┐┬ ┬┌─┐┌─┐┌─┐┌─┐┌┬┐┬┌─┐┌┐┌┌─┐
      //  └─┐│ ││ ┬│ ┬├┤ └─┐ │ ││ ││││└─┐
      //  └─┘└─┘└─┘└─┘└─┘└─┘ ┴ ┴└─┘┘└┘└─┘

      tasks.push(function(done) {

        if (scope.reportOnly) {
          return runReport();
        }

        Prompts.confirm({
          message: 'Okay, that\'s about all we can do automatically.\n\n' +
                   'In the next step, we\'ll do a scan of your code and create a report\n'+
                   'of things that may need to be manually updated for Sails 1.0.\n'+
                   'This could take a few moments depending on the size of your app.\n\n'+
                   'Go ahead and scan your app?'
        }).exec({
          error: done,
          no: function() {
            console.log('Okay, no problem.  In that case we\'re done!');
            return done();
          },
          success: runReport
        });

        function runReport() {

          // Declare a var to hold the report.
          var report = [];

          /***************************************************************************
          *                                                                          *
          * Check for blueprint `actions` config setting.                            *
          *                                                                          *
          ***************************************************************************/

          // Let's take a look at the blueprints config.
          var blueprintsConfig = (function() {
            try {
              return require(path.resolve(projectDir, 'config', 'blueprints')).blueprints;
            } catch (e) {
              return {};
            }
          })();

          // If they don't have an `actions` value set, warn that the default has flipped.
          if (blueprintsConfig && _.isUndefined(blueprintsConfig.actions)) {
            report.push(figlet.textSync('blueprints config', {font: 'Calvin S'}));
            report.push('In Sails 1.0, the `actions` blueprint routes are turned _off_ by default.\n'+
                        'This is a change from v0.12.x, so if you\'re relying on Sails to create\n'+
                        'a route for each of your custom controller actions automatically, be sure\n'+
                        'to set `actions` to `true` in your config/blueprints.js file.');
          }

          /***************************************************************************
          *                                                                          *
          * Check for toJSON and other model instance methods.                       *
          *                                                                          *
          ***************************************************************************/

          // Do any models have toJSON or other instance methods on them?
          var modelsWithToJSON = [];
          var modelsWithInstanceMethods = _.reduce(models, function(memo, model) {
            if (model.attributes && _.any(model.attributes, function(attribute, attributeName) {
              if (attributeName === 'toJSON') {
                modelsWithToJSON.push(model.globalId);
                return;
              }
              return _.isFunction(attribute);
            })) {
              memo.push(model.globalId);
            }
            return memo;
          }, []);

          // If so, add something to the report.
          if (modelsWithToJSON.length) {
            report.push(figlet.textSync('toJSON attributes', {font: 'Calvin S'}));
            report.push('In Sails 1.0, the toJSON attribute is no longer supported.\n'+
                        'You can replace it with a `customToJSON` method on the model class.\n'+
                        'See http://sailsjs.com/docs/concepts/models-and-orm/model-settings for more info.\n\n'+
                        'You\'ll need to remove toJSON attributes from the following models:\n\n'+
                        _.map(modelsWithToJSON, function(modelName) { return '* "' + modelName + '" in api/models/'+modelName+'.js'; }).join('\n'));
          }

          if (modelsWithInstanceMethods.length) {
            report.push(figlet.textSync('instance methods', {font: 'Calvin S'}));
            report.push('In Sails 1.0, models may no longer have instance methods\n'+
                        '(i.e. attributes defined as functions).\n'+
                        'You\'ll need to remove instance methods from the following models:\n\n'+
                        _.map(modelsWithInstanceMethods, function(modelName) { return '* "' + modelName + '" in api/models/'+modelName+'.js'; }).join('\n'));
          }

          /***************************************************************************
          *                                                                          *
          * Check for non-EJS view engines.                                          *
          *                                                                          *
          ***************************************************************************/

          // Alright, let's take a look at the views config.
          var viewsConfig = (function() {
            try {
              return require(path.resolve(projectDir, 'config', 'views')).views;
            } catch (e) {
              return {};
            }
          })();

          // If it has an `engine` other than `ejs`, add it to the report.
          if (viewsConfig.engine && viewsConfig.engine !== 'ejs') {
            report.push(figlet.textSync('view engines', {font: 'Calvin S'}));
            report.push('It looks like you\'re using the `' + viewsConfig.engine + '` view engine.\n'+
                        'Configuration for view engines has changed in Sails 1.0, so you\'ll want to\n'+
                        'update your `config/views.js` file accordingly.\n\n'+
                        'See http://bit.ly/sails_migration_views for more info.');
          }

          /***************************************************************************
          *                                                                          *
          * Now walk through the code files looking for trouble.                     *
          *                                                                          *
          * This checks for `.add()`, `.remove()` and `.save()` calls, as well as    *
          * `sails.config.connections` references, references to the `/csrfToken`    *
          * route, deprecated/removed model attribute validations, and calls to      *
          * removed PubSub methods like `.publishAdd()`.                             *
          *                                                                          *
          ***************************************************************************/

          // Declare a var to hold a list of `collection` attributes in models
          // so we can look for `.add` and `.remove` calls.
          var collectionAttributes = [];
          // Declare a var to hold a report of model attributes with outdated validations.
          var outdatedValidationsReport = {};

          // Loop over the models and look for trouble.
          _.each(models, function(model) {

            // Loop over each model attribute
            _.each(model.attributes, function(attribute, name) {
              // If the attribute is a collection, add it to the `collectionAttributes` list.
              if (attribute.collection) {collectionAttributes.push(name);}
              // If the attribute has any out-of-date validations, record them.
              var outdatedValidations = _.intersection(_.keys(INVALID_VALIDATIONS), _.keys(attribute));
              if (outdatedValidations.length) {
                outdatedValidationsReport[model.globalId] = outdatedValidationsReport[model.globalId] || {};
                outdatedValidationsReport[model.globalId][name] = outdatedValidations;
              }
            });

          });

          collectionAttributes = _.uniq(collectionAttributes);

          var addRegex = new RegExp('\\.(' + collectionAttributes.join('|') + ')\\.add\\(');
          var removeRegex = new RegExp('\\.(' + collectionAttributes.join('|') + ')\\.remove\\(');
          var pubSubRegex = new RegExp('(' + _.pluck(models, 'globalId').join('|') + ')\\.(publishAdd|publishCreate|publishDestroy|publishRemove|publishUpdate|watch|unwatch|message)');
          var connectionsRegex = new RegExp('\\Wconnections:');
          var connectionRegex = new RegExp('\\Wconnection:');

          // Set up various subreports
          var addRemoveSaveCalls = [];
          var pubSubCalls = [];
          var csrfTokenPathRefs = false;
          var configFilesWithConnections = [];
          var configFilesWithConnection = [];

          // Start walking the codez
          var walker = walk.walk(projectDir, { filters: ['node_modules', '.tmp'] });

          // For each file...
          walker.on('file', function (root, stats, next) {
            var relativeRoot = root.replace(projectDir, '').replace(new RegExp('^' + _.escapeRegExp(path.sep)), '');

            // If it's not a Javascript or EJS file, skip it.
            if (!stats.name.match(/\.(js|ejs)$/)) {
              return next();
            }

            // Read the file in.
            var file;
            try {
              file = Filesystem.readSync({source: path.join(root, stats.name)}).execSync().split('\n');
            }
            catch (e) {
              return next();
            }

            // Loop through each line of the file
            _.each(file, function(line, lineNum) {

              // If it's not an asset file, look for `.add` or `.remove` calls.
              if (!root.match(path.join(projectDir, 'assets')) && !stats.name.match('\.ejs$')) {
                if (line.match(addRegex)) {
                  addRemoveSaveCalls.push('.add() in ' + path.join(relativeRoot, stats.name) + ':' + (lineNum + 1));
                }
                if (!root.match(path.join(projectDir, 'config'))) {
                  if (line.match(removeRegex)) {
                    addRemoveSaveCalls.push('.remove() in ' + path.join(relativeRoot, stats.name) + ':' + (lineNum + 1));
                  }
                  if (line.match('\\.save\\(')) {
                    addRemoveSaveCalls.push('.save() in ' + path.join(relativeRoot, stats.name) + ':' + (lineNum + 1));
                  }
                  if (line.match(pubSubRegex)) {
                    (function() {
                      var match = line.match(pubSubRegex);
                      var method = match[2];
                      pubSubCalls.push('.' + method + '() in ' + path.join(relativeRoot, stats.name) + ':' + (lineNum + 1));
                    })();
                  }
                }
              }

              // Look for `connections:` and `connection:` in config files.
              if (root.match(path.join(projectDir, 'config')) || root.match(path.join(projectDir, 'api', 'models'))) {
                if (line.match(connectionsRegex) && !line.match(/\s*\/\//)) {
                  configFilesWithConnections.push(path.join(relativeRoot, stats.name) + ':' + (lineNum + 1));
                }
                if (line.match(connectionRegex) && !line.match(/\s*\/\//) && !line.match('connection: null')) {
                  // If this is the config/models.js file, and we created a models_1_0 file with connection: null, ignore it.
                  if (path.join(relativeRoot, stats.name) === 'config/models.js') {
                    try {
                      var newModelsConfig = require(path.resolve(projectDir, 'config', 'models_1_0'));
                      if (newModelsConfig.models && newModelsConfig.models.connection === null) {
                        return;
                      }
                    }
                    catch (e) {
                      // do nothing.
                    }
                  }
                  configFilesWithConnection.push(path.join(relativeRoot, stats.name) + ':' + (lineNum + 1));
                }
              }

              // Look for references to `/csrfToken` (that aren't commented out)
              if (line.match('/csrfToken') && !line.match(/^\s*\/\//) && !line.match(/^\s*\*/)) {
                csrfTokenPathRefs = true;
              }

            });


            return next();

          });

          walker.on('end', function() {
            if (configFilesWithConnections.length || configFilesWithConnection.length) {
              report.push(figlet.textSync('database config', {font: 'Calvin S'}));
              report.push('In Sails 1.0, the `connections` config has been replaced with `datastores`,\n' +
                          'and the `models.connection` config has been replaced with `models.datastore`.\n' +
                          'It looks like there are still some config files that need to be changed:');
              _.each(configFilesWithConnections, function(instance) {
                report.push('* In ' + instance + ', change `connections:` to `datastores:`');
              });
              _.each(configFilesWithConnection, function(instance) {
                report.push('* In ' + instance + ', change `connection:` to `datastore:`');
              });
            }

            if (csrfTokenPathRefs === true) {
              report.push(figlet.textSync('csrfToken route', {font: 'Calvin S'}));
              report.push('In Sails 1.0, the /csrfToken route is no longer added automatically.\n' +
                          'It looks like you\'re using that route in one or more places, so be sure to add it\n' +
                          'to your `config/routes.js` file as:\n\n'+
                          '\'GET /csrfToken\': { action: \'security/grant-csrf-token\' }');
            }

            if (_.keys(outdatedValidationsReport).length > 0) {
              report.push(figlet.textSync('validations', {font: 'Calvin S'}));
              report.push('The following model attributes contain validations that are no longer supported in Sails 1.0.\n' +
                          'It\'s recommended that you replace them with a `custom` (or if possible, `regex`) validation.\n' +
                          'See http://sailsjs.com/docs/concepts/models-and-orm/validations for the current list of\n'+
                          'supported validations and info on how to use `custom` and `regex`.\n');
              _.each(outdatedValidationsReport, function(attributes, model) {
                report.push('* In model `' + model + '` (api/models/' + model + '.js):');
                _.each(attributes, function(validations, attribute) {
                  report.push('   + `'  + attribute + '` attribute (' + validations.join(', ') + ')');
                });

              });
            }

            if (addRemoveSaveCalls.length) {
              report.push(figlet.textSync('add, remove and save methods', {font: 'Calvin S'}));
              report.push('In Sails 1.0, records no longer support .add() and .remove() for adding and removing\n'+
                          'child records in a collection attribute.  Records also don\'t support the .save() method.\n'+
                          'Instead, use the model class methods\n'+
                          '`.update()`, `.addToCollection()`, `.removeFromCollection()` and `.replaceCollection()`.\n\n'+
                          'Found the following possible references to `.add()`, `.remove() and `.save()`:\n\n'+
                          _.map(addRemoveSaveCalls, function(reference) { return '* ' + reference; }).join('\n') + '\n\n' +
                          'See the reference docs for more info:\n'+
                          '.update(): https://sailsjs.com/docs/reference/waterline/models/update\n'+
                          '.addToCollection(): https://sailsjs.com/docs/reference/waterline/models/addToCollection\n'+
                          '.removeFromCollection(): https://sailsjs.com/docs/reference/waterline/models/removeFromCollection\n'+
                          '.replaceCollection(): https://sailsjs.com/docs/reference/waterline/models/replaceCollection'
                          );
            }

            if (pubSubCalls.length) {
              report.push(figlet.textSync('PubSub methods', {font: 'Calvin S'}));
              report.push('In Sails 1.0, many Resourceful PubSub methods have been removed, and replaced by `.publish()`.\n' +
                          'In addition, the `.watch()` and `.unwatch()` methods have been removed (use `autoWatch` instead).\n' +
                          'Found the following references to unsupported RPS methods:\n\n' +
                          _.map(pubSubCalls, function(reference) { return '* ' + reference; }).join('\n') + '\n\n' +
                          'See the following for more info:\n' +
                          'http://sailsjs.com/docs/upgrading/to-v-1-0#?resourceful-pubsub\n' +
                          'http://sailsjs.com/config/blueprints#?actionrelated-settings'
                         );
            }

            // Check for async/await support.
            var RX_NODE_MAJOR_DOT_MINOR = /^v([^.]+\.?[^.]+)\./;
            var isCurrentNodeVersionCapableOfAwait = process.version.match(RX_NODE_MAJOR_DOT_MINOR) && ( +(process.version.match(RX_NODE_MAJOR_DOT_MINOR)[1]) >= 7.9);
            if(!isCurrentNodeVersionCapableOfAwait) {
              report.push(figlet.textSync('node version', {font: 'Calvin S'}));
              report.push('It looks like your current version of Node.js is '+process.version+'.\n' +
                          '(or it was at the time this report was generated)\n\n' +
                          'Sails works with all officially-supported versions of Node.js.\n' +
                          'But it works *especially* well with Node versions 7.9 and up.\n\n' +
                          'As of Sails v1.0, your app can now take advantage of the new `await` keyword,\n' +
                          'instead of relying on callbacks or promise chaining (`.exec()`, `.then()`, etc.)\n' +
                          'This new feature of Sails/Node.js/JavaScript makes your team more productive,\n' +
                          'and it usually leads to more stable code with fewer bugs.\n\n' +
                          'If you choose *not* to upgrade Node.js, you\'ll still be able to use Sails (of course!)\n' +
                          'But we really recommend taking a moment to look into this.  It\'s fast and easy, and \n' +
                          'we think you\'ll find it helps you build higher quality apps, faster than ever before.\n\n' +
                          ' [?] If you\'re unsure or want advice, swing by https://sailsjs.com/support'
                         );
            }

            if (report.length) {

              report.unshift(
                figlet.textSync('Report', {font: 'ANSI Shadow'}) +
                '\n'+
                '==================================================\n\n'+
                'This report highlights various issues that may need to be addressed before your app will work with Sails 1.0.\n' +
                'After implementing these suggestions, some good next steps are:\n' +
                '* Address the issues in this report, and run the updater again with --reportOnly to regenerate the report.\n  Repeat until there are no more issues!\n' +
                '* Review the full migration guide at: https://github.com/balderdashy/sails-docs/blob/1.0/upgrading/To1.0.md\n' +
                '* Attempt to lift and run your app with Sails 1.0.\n' +
                '* See http://sailsjs.com/support for support options!\n'
              );

              // Save the report to disk.
              Filesystem.writeSync({
                string: report.join('\n\n'),
                destination: path.resolve(projectDir, 'sails_1.0_migration_report.txt'),
                force: true
              }).execSync();


              // Output the report to the console.
              console.log(report.join('\n\n'));
              console.log();
              console.log('--------------------------------------------------------------------------------------------------------');
              console.log('Saved this migration report to ' + path.resolve(projectDir, 'sails_1.0_migration_report.txt'));
              console.log('--------------------------------------------------------------------------------------------------------');
            }
            else {
              console.log('The scanner didn\'t have anything to report -- you\'re in good shape!');
            }

            if (!scope.reportOnly) {
              console.log('\nThe migration utility has completed!\n');
              console.log('Next steps:');
              console.log('* Review the full migration guide at: https://github.com/balderdashy/sails-docs/blob/1.0/upgrading/To1.0.md');
              console.log('* Attempt to lift and run your app with Sails 1.0.');
              console.log('* See http://sailsjs.com/support for support options!\n');
            }
            return done();
          });



        }


      });

      //  ██████╗ ██╗   ██╗███╗   ██╗    ████████╗ █████╗ ███████╗██╗  ██╗███████╗
      //  ██╔══██╗██║   ██║████╗  ██║    ╚══██╔══╝██╔══██╗██╔════╝██║ ██╔╝██╔════╝
      //  ██████╔╝██║   ██║██╔██╗ ██║       ██║   ███████║███████╗█████╔╝ ███████╗
      //  ██╔══██╗██║   ██║██║╚██╗██║       ██║   ██╔══██║╚════██║██╔═██╗ ╚════██║
      //  ██║  ██║╚██████╔╝██║ ╚████║       ██║   ██║  ██║███████║██║  ██╗███████║
      //  ╚═╝  ╚═╝ ╚═════╝ ╚═╝  ╚═══╝       ╚═╝   ╚═╝  ╚═╝╚══════╝╚═╝  ╚═╝╚══════╝
      //
      async.series(tasks, done);

    },

    templatesDirectory: __dirname,

    targets: {}

  };

})();