@nyteshade/lattice-legacy/dist/ModuleParser.js

OO Underpinnings for ease of GraphQL Implementation

'use strict';

Object.defineProperty(exports, "__esModule", {
  value: true
});
exports.ModuleParser = undefined;

var _toStringTag = require('babel-runtime/core-js/symbol/to-string-tag');

var _toStringTag2 = _interopRequireDefault(_toStringTag);

var _from = require('babel-runtime/core-js/array/from');

var _from2 = _interopRequireDefault(_from);

var _asyncToGenerator2 = require('babel-runtime/helpers/asyncToGenerator');

var _asyncToGenerator3 = _interopRequireDefault(_asyncToGenerator2);

var _set = require('babel-runtime/core-js/set');

var _set2 = _interopRequireDefault(_set);

var _map = require('babel-runtime/core-js/map');

var _map2 = _interopRequireDefault(_map);

var _fs = require('fs');

var _fs2 = _interopRequireDefault(_fs);

var _path = require('path');

var _path2 = _interopRequireDefault(_path);

var _neTypes = require('ne-types');

var types = _interopRequireWildcard(_neTypes);

var _GQLBase = require('./GQLBase');

var _GQLJSON = require('./types/GQLJSON');

var _lodash = require('lodash');

var _utils = require('./utils');

function _interopRequireWildcard(obj) { if (obj && obj.__esModule) { return obj; } else { var newObj = {}; if (obj != null) { for (var key in obj) { if (Object.prototype.hasOwnProperty.call(obj, key)) newObj[key] = obj[key]; } } newObj.default = obj; return newObj; } }

function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }

// Promisify some bits
const readdirAsync = (0, _utils.promisify)(_fs2.default.readdir);

const statAsync = (0, _utils.promisify)(_fs2.default.stat);

// Fetch some type checking bits from 'types'
const {
  typeOf,
  isString,
  isOfType,
  isPrimitive,
  isArray,
  isObject,
  extendsFrom
} = types;

/**
 * The ModuleParser is a utility class designed to loop through and iterate
 * on a directory and pull out of each .js file found, any classes or exports
 * that extend from GQLBase or a child of GQLBase.
 *
 * @class ModuleParser
 * @since 2.7.0
 */
let ModuleParser = exports.ModuleParser = class ModuleParser {

  /**
   * The constructor
   *
   * @constructor
   * @method ⎆⠀constructor
   * @memberof ModuleParser
   * @inner
   *
   * @param {string} directory a string path to a directory containing the
   * various GQLBase extended classes that should be gathered.
   */


  /**
   * A boolean value denoting whether or not the `ModuleParser` instance is
   * valid; i.e. the directory it points to actually exists and is a directory
   *
   * @type {boolean}
   */


  /**
   * A map of skipped items on the last pass and the associated error that
   * accompanies it.
   */

  /**
   * An internal array of `GQLBase` extended classes found during either a
   * `parse()` or `parseSync()` call.
   *
   * @memberof ModuleParser
   * @type {Array<GQLBase>}
   */
  constructor(directory, options = { addLatticeTypes: true }) {
    Object.defineProperty(this, 'looseGraphQL', {
      enumerable: true,
      writable: true,
      value: []
    });
    Object.defineProperty(this, 'options', {
      enumerable: true,
      writable: true,
      value: {}
    });

    this.directory = _path2.default.resolve(directory);
    this.classes = [];
    this.skipped = new _map2.default();

    (0, _lodash.merge)(this.options, options);

    try {
      this.valid = _fs2.default.statSync(directory).isDirectory();
    } catch (error) {
      this.valid = false;
    }
  }

  /**
   * Given a file path, this method will attempt to import/require the
   * file in question and return the object it exported; whatever that
   * may be.
   *
   * @method ModuleParser#⌾⠀importClass
   * @since 2.7.0
   *
   * @param {string} filePath a path to pass to `require()`
   *
   * @return {Object} the object, or undefined, that was returned when
   * it was `require()`'ed.
   */


  /**
   * An object, optionally added during construction, that specifies some
   * configuration about the ModuleParser and how it should do its job.
   *
   * Initially, the
   *
   * @type {Object}
   */


  /**
   * A string denoting the directory on disk where `ModuleParser` should be
   * searching for its classes.
   *
   * @memberof ModuleParser
   * @type {string}
   */


  /**
   * An array of strings holding loose GraphQL schema documents.
   *
   * @memberof ModuleParser
   * @type {Array<string>}
   */
  importClass(filePath) {
    let moduleContents = {};
    let yellow = '\x1b[33m';
    let clear = '\x1b[0m';

    try {
      moduleContents = require(filePath);
    } catch (ignore) {
      if (/\.graphql/i.test(_path2.default.extname(filePath))) {
        _utils.LatticeLogs.log(`Ingesting .graphql file ${filePath}`);
        let buffer = _fs2.default.readFileSync(filePath);
        this.looseGraphQL.push(_fs2.default.readFileSync(filePath).toString());
      } else {
        _utils.LatticeLogs.log(`${yellow}Skipping${clear} ${filePath}`);
        _utils.LatticeLogs.trace(ignore);
        this.skipped.set(filePath, ignore);
      }
    }

    return moduleContents;
  }

  /**
   * Given an object, typically the result of a `require()` or `import`
   * command, iterate over its contents and find any `GQLBase` derived
   * exports. Continually, and recursively, build this list of classes out
   * so that we can add them to a `GQLExpressMiddleware`.
   *
   * @method ModuleParser#⌾⠀findGQLBaseClasses
   * @since 2.7.0
   *
   * @param {Object} contents the object to parse for properties extending
   * from `GQLBase`
   * @param {Array<GQLBase>} gqlDefinitions the results, allowed as a second
   * parameter during recursion as a means to save state between calls
   * @return {Set<mixed>} a unique set of values that are currently being
   * iterated over. Passed in as a third parameter to save state between calls
   * during recursion.
   */
  findGQLBaseClasses(contents, gqlDefinitions = [], stack = new _set2.default()) {
    // In order to prevent infinite object recursion, we should add the
    // object being iterated over to our Set. At each new recursive level
    // add the item being iterated over to the set and only recurse into
    // if the item does not already exist in the stack itself.
    stack.add(contents);

    for (let key in contents) {
      let value = contents[key];

      if (isPrimitive(value)) {
        continue;
      }

      if (extendsFrom(value, _GQLBase.GQLBase)) {
        gqlDefinitions.push(value);
      }

      if ((isObject(value) || isArray(value)) && !stack.has(value)) {
        gqlDefinitions = this.findGQLBaseClasses(value, gqlDefinitions, stack);
      }
    }

    // We remove the current iterable from our set as we leave this current
    // recursive iteration.
    stack.delete(contents);

    return gqlDefinitions;
  }

  /**
   * This method takes a instance of ModuleParser, initialized with a directory,
   * and walks its contents, importing files as they are found, and sorting
   * any exports that extend from GQLBase into an array of such classes
   * in a resolved promise.
   *
   * @method ModuleParser#⌾⠀parse
   * @async
   * @since 2.7.0
   *
   * @return {Promise<Array<GQLBase>>} an array GQLBase classes, or an empty
   * array if none could be identified.
   */
  parse() {
    var _this = this;

    return (0, _asyncToGenerator3.default)(function* () {
      let modules;
      let files;
      let set = new _set2.default();
      let opts = (0, _utils.getLatticePrefs)();

      if (!_this.valid) {
        throw new Error(`
        ModuleParser instance is invalid for use with ${_this.directory}.
        The path is either a non-existent path or it does not represent a
        directory.
      `);
      }

      _this.skipped.clear();

      // @ComputedType
      files = yield _this.constructor.walk(_this.directory);
      modules = files.map(function (file) {
        return _this.importClass(file);
      })

      // @ComputedType
      (modules.map(function (mod) {
        return _this.findGQLBaseClasses(mod);
      }).reduce(function (last, cur) {
        return (last || []).concat(cur || []);
      }, []).forEach(function (Class) {
        return set.add(Class);
      }));

      // Convert the set back into an array
      _this.classes = (0, _from2.default)(set);

      // We can ignore equality since we came from a set; @ComputedType
      _this.classes.sort(function (l, r) {
        return l.name < r.name ? -1 : 1;
      });

      // Add in any GraphQL Lattice types requested
      if (_this.options.addLatticeTypes) {
        _this.classes.push(_GQLJSON.GQLJSON);
      }

      // Stop flow and throw an error if some files failed to load and settings
      // declare we should do so. After Lattice 3.x we should expect this to be
      // the new default
      if (opts.ModuleParser.failOnError && _this.skipped.size) {
        _this.printSkipped();
        throw new Error('Some files skipped due to errors');
      }

      return _this.classes;
    })();
  }

  /**
   * This method takes a instance of ModuleParser, initialized with a directory,
   * and walks its contents, importing files as they are found, and sorting
   * any exports that extend from GQLBase into an array of such classes
   *
   * @method ModuleParser#⌾⠀parseSync
   * @async
   * @since 2.7.0
   *
   * @return {Array<GQLBase>} an array GQLBase classes, or an empty
   * array if none could be identified.
   */
  parseSync() {
    let modules;
    let files;
    let set = new _set2.default();
    let opts = (0, _utils.getLatticePrefs)();

    if (!this.valid) {
      throw new Error(`
        ModuleParser instance is invalid for use with ${this.directory}.
        The path is either a non-existent path or it does not represent a
        directory.
      `);
    }

    this.skipped.clear();

    files = this.constructor.walkSync(this.directory);
    modules = files.map(file => {
      return this.importClass(file);
    });

    modules.map(mod => this.findGQLBaseClasses(mod)).reduce((last, cur) => (last || []).concat(cur || []), []).forEach(Class => set.add(Class));

    // Convert the set back into an array
    this.classes = (0, _from2.default)(set);

    // We can ignore equality since we came from a set; @ComputedType
    this.classes.sort((l, r) => l.name < r.name ? -1 : 1);

    // Add in any GraphQL Lattice types requested
    if (this.options.addLatticeTypes) {
      this.classes.push(_GQLJSON.GQLJSON);
    }

    // Stop flow and throw an error if some files failed to load and settings
    // declare we should do so. After Lattice 3.x we should expect this to be
    // the new default
    if (opts.ModuleParser.failOnError && this.skipped.size) {
      this.printSkipped();
      throw new Error('Some files skipped due to errors');
    }

    return this.classes;
  }

  /**
   * Prints the list of skipped files, their stack traces, and the errors
   * denoting the reasons the files were skipped.
   */
  printSkipped() {
    if (this.skipped.size) {
      _utils.LatticeLogs.outWrite('\x1b[1;91m');
      _utils.LatticeLogs.outWrite('Skipped\x1b[0;31m the following files\n');

      for (let [key, value] of this.skipped) {
        _utils.LatticeLogs.log(`${_path2.default.basename(key)}: ${value.message}`);
        if (value.stack) _utils.LatticeLogs.log(value.stack.replace(/(^)/m, '$1  '));
      }

      _utils.LatticeLogs.outWrite('\x1b[0m');
    } else {
      _utils.LatticeLogs.log('\x1b[1;32mNo files skipped\x1b[0m');
    }
  }

  /**
   * Returns the `constructor` name. If invoked as the context, or `this`,
   * object of the `toString` method of `Object`'s `prototype`, the resulting
   * value will be `[object MyClass]`, given an instance of `MyClass`
   *
   * @method ⌾⠀[Symbol.toStringTag]
   * @memberof ModuleParser
   *
   * @return {string} the name of the class this is an instance of
   * @ComputedType
   */
  get [_toStringTag2.default]() {
    return this.constructor.name;
  }

  /**
   * Applies the same logic as {@link #[Symbol.toStringTag]} but on a static
   * scale. So, if you perform `Object.prototype.toString.call(MyClass)`
   * the result would be `[object MyClass]`.
   *
   * @method ⌾⠀[Symbol.toStringTag]
   * @memberof ModuleParser
   * @static
   *
   * @return {string} the name of this class
   * @ComputedType
   */
  static get [_toStringTag2.default]() {
    return this.name;
  }

  /**
   * Recursively walks a directory and returns an array of asbolute file paths
   * to the files under the specified directory.
   *
   * @method ModuleParser~⌾⠀walk
   * @async
   * @since 2.7.0
   *
   * @param {string} dir string path to the top level directory to parse
   * @param {Array<string>} filelist an array of existing absolute file paths,
   * or if not parameter is supplied a default empty array will be used.
   * @return {Promise<Array<string>>} an array of existing absolute file paths
   * found under the supplied `dir` directory.
   */
  static walk(dir, filelist = [], extensions = ['.js', '.jsx', '.ts', '.tsx']) {
    var _this2 = this;

    return (0, _asyncToGenerator3.default)(function* () {
      let files = yield readdirAsync(dir);
      let exts = ModuleParser.checkForPackageExtensions() || extensions;
      let pattern = ModuleParser.arrayToPattern(exts);
      let stats;

      files = files.map(function (file) {
        return _path2.default.resolve(_path2.default.join(dir, file));
      });

      for (let file of files) {
        stats = yield statAsync(file);
        if (stats.isDirectory()) {
          filelist = yield _this2.walk(file, filelist);
        } else {
          if (pattern.test(_path2.default.extname(file))) filelist = filelist.concat(file);
        }
      }

      return filelist;
    })();
  }

  /**
   * Recursively walks a directory and returns an array of asbolute file paths
   * to the files under the specified directory. This version does this in a
   * synchronous fashion.
   *
   * @method ModuleParser~⌾⠀walkSync
   * @async
   * @since 2.7.0
   *
   * @param {string} dir string path to the top level directory to parse
   * @param {Array<string>} filelist an array of existing absolute file paths,
   * or if not parameter is supplied a default empty array will be used.
   * @return {Array<string>} an array of existing absolute file paths found
   * under the supplied `dir` directory.
   */
  static walkSync(dir, filelist = [], extensions = ['.js', '.jsx', '.ts', '.tsx']) {
    let files = (0, _fs.readdirSync)(dir);
    let exts = ModuleParser.checkForPackageExtensions() || extensions;
    let pattern = ModuleParser.arrayToPattern(exts);
    let stats;

    files = files.map(file => _path2.default.resolve(_path2.default.join(dir, file)));

    for (let file of files) {
      stats = (0, _fs.statSync)(file);
      if (stats.isDirectory()) {
        filelist = this.walkSync(file, filelist);
      } else {
        if (pattern.test(_path2.default.extname(file))) filelist = filelist.concat(file);
      }
    }

    return filelist;
  }

  /**
   * The ModuleParser should only parse files that match the default or
   * supplied file extensions. The default list contains .js, .jsx, .ts
   * and .tsx; so JavaScript or TypeScript files and their JSX React
   * counterparts
   *
   * Since the list is customizable for a usage, however, it makes sense
   * to have a function that will match what is supplied rather than
   * creating a constant expression to use instead.
   *
   * @static
   * @memberof ModuleParser
   * @function ⌾⠀arrayToPattern
   * @since 2.13.0
   *
   * @param {Array<string>} extensions an array of extensions to
   * convert to a regular expression that would pass for each
   * @param {string} flags the value passed to a new RegExp denoting the
   * flags used in the pattern; defaults to 'i' for case insensitivity
   * @return {RegExp} a regular expression object matching the contents
   * of the array of extensions or the default extensions and that will
   * also match those values in a case insensitive manner
   */
  static arrayToPattern(extensions = ['.js', '.jsx', '.ts', '.tsx'], flags = 'i') {
    return new RegExp(extensions.join('|').replace(/\./g, '\\.').replace(/([\|$])/g, '\\b$1'), flags);
  }

  /**
   * Using the module `read-pkg-up`, finds the nearest package.json file
   * and checks to see if it has a `.lattice.moduleParser.extensions'
   * preference. If so, if the value is an array, that value is used,
   * otherwise the value is wrapped in an array. If the optional parameter
   * `toString` is `true` then `.toString()` will be invoked on any non
   * Array values found; this behavior is the default
   *
   * @static
   * @memberof ModuleParser
   * @method ⌾⠀checkForPackageExtensions
   * @since 2.13.0
   *
   * @param {boolean} toString true if any non-array values should have
   * their `.toString()` method invoked before being wrapped in an Array;
   * defaults to true
   * @return {?Array<string>} null if no value is set for the property
   * `lattice.ModuleParser.extensions` in `package.json` or the value
   * of the setting if it is an array. Finally if the value is set but is
   * not an array, the specified value wrapped in an array is returned
   */
  static checkForPackageExtensions(toString = true) {
    let pkg = (0, _utils.getLatticePrefs)();
    let extensions = null;

    if (pkg.ModuleParser && pkg.ModuleParser.extensions) {
      let packageExts = pkg.ModuleParser.extensions;

      if (Array.isArray(packageExts)) {
        extensions = packageExts;
      } else {
        extensions = [toString ? packageExts.toString() : packageExts];
      }
    }

    return extensions;
  }
};
exports.default = ModuleParser;
//# sourceMappingURL=ModuleParser.js.map