ee-core 1.5.2-beta.1 → 2.0.0-beta.1

package/core/lib/utils/base_context_class.js

@@ -1,34 +1,34 @@
-'use strict';
-
-/**
- * BaseContextClass is a base class that can be extended,
- * it's instantiated in context level,
- * {@link Helper}, {@link Service} is extending it.
- */
-class BaseContextClass {
-
-  /**
-   * @class
-   * @param {Context} ctx - context instance
-   * @since 1.0.0
-   */
-  constructor(ctx) {
-    /**
-     * @member {Application} BaseContextClass#app
-     * @since 1.0.0
-     */
-    this.app = ctx;
-    /**
-     * @member {Config} BaseContextClass#config
-     * @since 1.0.0
-     */
-    this.config = ctx.config;
-    /**
-     * @member {Service} BaseContextClass#service
-     * @since 1.0.0
-     */
-    this.service = ctx.service;
-  }
-}
-
-module.exports = BaseContextClass;
+'use strict';
+
+/**
+ * BaseContextClass is a base class that can be extended,
+ * it's instantiated in context level,
+ * {@link Helper}, {@link Service} is extending it.
+ */
+class BaseContextClass {
+
+  /**
+   * @class
+   * @param {Context} ctx - context instance
+   * @since 1.0.0
+   */
+  constructor(ctx) {
+    /**
+     * @member {Application} BaseContextClass#app
+     * @since 1.0.0
+     */
+    this.app = ctx;
+    /**
+     * @member {Config} BaseContextClass#config
+     * @since 1.0.0
+     */
+    this.config = ctx.config;
+    /**
+     * @member {Service} BaseContextClass#service
+     * @since 1.0.0
+     */
+    this.service = ctx.service;
+  }
+}
+
+module.exports = BaseContextClass;

package/core/lib/utils/function.js

@@ -0,0 +1,30 @@
+const assert = require('assert');
+
+/**
+ * A empty function.
+ *
+ * @return {Function}
+ * @public
+ */
+exports.noop = function noop() {};
+
+/**
+ * Get a function parameter's names.
+ *
+ * @param {Function} func
+ * @param {Boolean} [useCache], default is true
+ * @return {Array} names
+ */
+exports.getParamNames = function getParamNames(func, cache) {
+  var type = typeof func;
+  assert(type === 'function', 'The "func" must be a function. Received type "' + type + '"');
+
+  cache = cache !== false;
+  if (cache && func.__cache_names) {
+    return func.__cache_names;
+  }
+  var str = func.toString();
+  var names = str.slice(str.indexOf('(') + 1, str.indexOf(')')).match(/([^\s,]+)/g) || [];
+  func.__cache_names = names;
+  return names;
+};

package/core/lib/utils/index.js

@@ -1,127 +1,127 @@
-'use strict';
-
-require('bytenode');
-const convert = require('koa-convert');
-const is = require('is-type-of');
-const path = require('path');
-const fs = require('fs');
-const co = require('co');
-const BuiltinModule = require('module');
-
-// Guard against poorly mocked module constructors.
-const Module = module.constructor.length > 1
-  ? module.constructor
-  /* istanbul ignore next */
-  : BuiltinModule;
-
-module.exports = {
-  extensions: Module._extensions,
-
-  loadFile(filepath) {
-    try {
-      // if not js module, just return content buffer
-      const extname = path.extname(filepath);
-      if (extname && !Module._extensions[extname]) {
-        return fs.readFileSync(filepath);
-      }
-
-      // require js module
-      const obj = require(filepath);
-      if (!obj) return obj;
-      // it's es module
-      if (obj.__esModule) return 'default' in obj ? obj.default : obj;
-      return obj;
-    } catch (err) {
-      err.message = `[ee-core] load file: ${filepath}, error: ${err.message}`;
-      throw err;
-    }
-  },
-
-  methods: [ 'head', 'options', 'get', 'put', 'patch', 'post', 'delete' ],
-
-  async callFn(fn, args, ctx) {
-    args = args || [];
-    if (!is.function(fn)) return;
-    if (is.generatorFunction(fn)) fn = co.wrap(fn);
-    return ctx ? fn.call(ctx, ...args) : fn(...args);
-  },
-
-  middleware(fn) {
-    return is.generatorFunction(fn) ? convert(fn) : fn;
-  },
-
-  getCalleeFromStack(withLine, stackIndex) {
-    stackIndex = stackIndex === undefined ? 2 : stackIndex;
-    const limit = Error.stackTraceLimit;
-    const prep = Error.prepareStackTrace;
-
-    Error.prepareStackTrace = prepareObjectStackTrace;
-    Error.stackTraceLimit = 5;
-
-    // capture the stack
-    const obj = {};
-    Error.captureStackTrace(obj);
-    let callSite = obj.stack[stackIndex];
-    let fileName;
-    /* istanbul ignore else */
-    if (callSite) {
-      fileName = callSite.getFileName();
-      /* istanbul ignore if */
-      if (fileName && fileName.endsWith('egg-mock/lib/app.js')) {
-        // TODO: add test
-        callSite = obj.stack[stackIndex + 1];
-        fileName = callSite.getFileName();
-      }
-    }
-
-    Error.prepareStackTrace = prep;
-    Error.stackTraceLimit = limit;
-
-    /* istanbul ignore if */
-    if (!callSite || !fileName) return '<anonymous>';
-    if (!withLine) return fileName;
-    return `${fileName}:${callSite.getLineNumber()}:${callSite.getColumnNumber()}`;
-  },
-
-  getResolvedFilename(filepath, baseDir) {
-    const reg = /[/\\]/g;
-    return filepath.replace(baseDir + path.sep, '').replace(reg, '/');
-  },
-
-  /**
-   * 字节码类
-   */
-  isBytecodeClass (exports) {
-    let isClass = false;
-
-    // 标识
-    if (exports.toString().indexOf('[class') != -1) {
-      isClass = true;
-    }
-    // TODO 更严谨的判断，应该加上文件名和路径
-    
-    return isClass;
-  },
-
-  /**
-   * 文件类型
-   */
-  filePatterns () {
-    const files = (process.env.EE_TYPESCRIPT === 'true' && Module._extensions['.ts'])
-    ? [ '**/*.(js|ts)', '!**/*.d.ts' ]
-    : [ '**/*.js','**/*.jsc' ];
-
-    return files;
-  }
-
-};
-
-
-/**
- * Capture call site stack from v8.
- * https://github.com/v8/v8/wiki/Stack-Trace-API
- */
-
-function prepareObjectStackTrace(obj, stack) {
-  return stack;
-}
+'use strict';
+
+require('bytenode');
+const convert = require('koa-convert');
+const is = require('is-type-of');
+const path = require('path');
+const fs = require('fs');
+const co = require('co');
+const BuiltinModule = require('module');
+
+// Guard against poorly mocked module constructors.
+const Module = module.constructor.length > 1
+  ? module.constructor
+  /* istanbul ignore next */
+  : BuiltinModule;
+
+module.exports = {
+  extensions: Module._extensions,
+
+  loadFile(filepath) {
+    try {
+      // if not js module, just return content buffer
+      const extname = path.extname(filepath);
+      if (extname && !Module._extensions[extname]) {
+        return fs.readFileSync(filepath);
+      }
+
+      // require js module
+      const obj = require(filepath);
+      if (!obj) return obj;
+      // it's es module
+      if (obj.__esModule) return 'default' in obj ? obj.default : obj;
+      return obj;
+    } catch (err) {
+      err.message = `[ee-core] load file: ${filepath}, error: ${err.message}`;
+      throw err;
+    }
+  },
+
+  methods: [ 'head', 'options', 'get', 'put', 'patch', 'post', 'delete' ],
+
+  async callFn(fn, args, ctx) {
+    args = args || [];
+    if (!is.function(fn)) return;
+    if (is.generatorFunction(fn)) fn = co.wrap(fn);
+    return ctx ? fn.call(ctx, ...args) : fn(...args);
+  },
+
+  middleware(fn) {
+    return is.generatorFunction(fn) ? convert(fn) : fn;
+  },
+
+  getCalleeFromStack(withLine, stackIndex) {
+    stackIndex = stackIndex === undefined ? 2 : stackIndex;
+    const limit = Error.stackTraceLimit;
+    const prep = Error.prepareStackTrace;
+
+    Error.prepareStackTrace = prepareObjectStackTrace;
+    Error.stackTraceLimit = 5;
+
+    // capture the stack
+    const obj = {};
+    Error.captureStackTrace(obj);
+    let callSite = obj.stack[stackIndex];
+    let fileName;
+    /* istanbul ignore else */
+    if (callSite) {
+      fileName = callSite.getFileName();
+      /* istanbul ignore if */
+      if (fileName && fileName.endsWith('egg-mock/lib/app.js')) {
+        // TODO: add test
+        callSite = obj.stack[stackIndex + 1];
+        fileName = callSite.getFileName();
+      }
+    }
+
+    Error.prepareStackTrace = prep;
+    Error.stackTraceLimit = limit;
+
+    /* istanbul ignore if */
+    if (!callSite || !fileName) return '<anonymous>';
+    if (!withLine) return fileName;
+    return `${fileName}:${callSite.getLineNumber()}:${callSite.getColumnNumber()}`;
+  },
+
+  getResolvedFilename(filepath, baseDir) {
+    const reg = /[/\\]/g;
+    return filepath.replace(baseDir + path.sep, '').replace(reg, '/');
+  },
+
+  /**
+   * 字节码类
+   */
+  isBytecodeClass (exports) {
+    let isClass = false;
+
+    // 标识
+    if (exports.toString().indexOf('[class') != -1) {
+      isClass = true;
+    }
+    // TODO 更严谨的判断，应该加上文件名和路径
+    
+    return isClass;
+  },
+
+  /**
+   * 文件类型
+   */
+  filePatterns () {
+    const files = (process.env.EE_TYPESCRIPT === 'true' && Module._extensions['.ts'])
+    ? [ '**/*.(js|ts)', '!**/*.d.ts' ]
+    : [ '**/*.js','**/*.jsc' ];
+
+    return files;
+  }
+
+};
+
+
+/**
+ * Capture call site stack from v8.
+ * https://github.com/v8/v8/wiki/Stack-Trace-API
+ */
+
+function prepareObjectStackTrace(obj, stack) {
+  return stack;
+}

package/core/lib/utils/sequencify.js

@@ -1,59 +1,59 @@
-'use strict';
-
-const debug = require('debug')('ee-core#sequencify');
-
-function sequence(tasks, names, results, missing, recursive, nest, optional, parent) {
-  names.forEach(function(name) {
-    if (results.requires[name]) return;
-
-    const node = tasks[name];
-
-    if (!node) {
-      if (optional === true) return;
-      missing.push(name);
-    } else if (nest.includes(name)) {
-      nest.push(name);
-      recursive.push(nest.slice(0));
-      nest.pop(name);
-    } else if (node.dependencies.length || node.optionalDependencies.length) {
-      nest.push(name);
-      if (node.dependencies.length) {
-        sequence(tasks, node.dependencies, results, missing, recursive, nest, optional, name);
-      }
-      if (node.optionalDependencies.length) {
-        sequence(tasks, node.optionalDependencies, results, missing, recursive, nest, true, name);
-      }
-      nest.pop(name);
-    }
-    if (!optional) {
-      results.requires[name] = true;
-      debug('task: %s is enabled by %s', name, parent);
-    }
-    if (!results.sequence.includes(name)) {
-      results.sequence.push(name);
-    }
-  });
-}
-
-// tasks: object with keys as task names
-// names: array of task names
-module.exports = function(tasks, names) {
-  const results = {
-    sequence: [],
-    requires: {},
-  }; // the final sequence
-  const missing = []; // missing tasks
-  const recursive = []; // recursive task dependencies
-
-  sequence(tasks, names, results, missing, recursive, [], false, 'app');
-
-  if (missing.length || recursive.length) {
-    results.sequence = []; // results are incomplete at best, completely wrong at worst, remove them to avoid confusion
-  }
-
-  return {
-    sequence: results.sequence.filter(item => results.requires[item]),
-    missingTasks: missing,
-    recursiveDependencies: recursive,
-  };
-};
+'use strict';
+
+const debug = require('debug')('ee-core#sequencify');
+
+function sequence(tasks, names, results, missing, recursive, nest, optional, parent) {
+  names.forEach(function(name) {
+    if (results.requires[name]) return;
+
+    const node = tasks[name];
+
+    if (!node) {
+      if (optional === true) return;
+      missing.push(name);
+    } else if (nest.includes(name)) {
+      nest.push(name);
+      recursive.push(nest.slice(0));
+      nest.pop(name);
+    } else if (node.dependencies.length || node.optionalDependencies.length) {
+      nest.push(name);
+      if (node.dependencies.length) {
+        sequence(tasks, node.dependencies, results, missing, recursive, nest, optional, name);
+      }
+      if (node.optionalDependencies.length) {
+        sequence(tasks, node.optionalDependencies, results, missing, recursive, nest, true, name);
+      }
+      nest.pop(name);
+    }
+    if (!optional) {
+      results.requires[name] = true;
+      debug('task: %s is enabled by %s', name, parent);
+    }
+    if (!results.sequence.includes(name)) {
+      results.sequence.push(name);
+    }
+  });
+}
+
+// tasks: object with keys as task names
+// names: array of task names
+module.exports = function(tasks, names) {
+  const results = {
+    sequence: [],
+    requires: {},
+  }; // the final sequence
+  const missing = []; // missing tasks
+  const recursive = []; // recursive task dependencies
+
+  sequence(tasks, names, results, missing, recursive, [], false, 'app');
+
+  if (missing.length || recursive.length) {
+    results.sequence = []; // results are incomplete at best, completely wrong at worst, remove them to avoid confusion
+  }
+
+  return {
+    sequence: results.sequence.filter(item => results.requires[item]),
+    missingTasks: missing,
+    recursiveDependencies: recursive,
+  };
+};

package/core/lib/utils/timing.js

@@ -1,77 +1,77 @@
-'use strict';
-
-const assert = require('assert');
-const MAP = Symbol('Timing#map');
-const LIST = Symbol('Timing#list');
-
-
-class Timing {
-
-  constructor() {
-    this._enable = true;
-    this[MAP] = new Map();
-    this[LIST] = [];
-
-    this.init();
-  }
-
-  init() {
-    // process start time
-    this.start('Process Start', Date.now() - Math.floor((process.uptime() * 1000)));
-    this.end('Process Start');
-
-    if (typeof process.scriptStartTime === 'number') {
-      // js script start execute time
-      this.start('Script Start', process.scriptStartTime);
-      this.end('Script Start');
-    }
-  }
-
-  start(name, start) {
-    if (!name || !this._enable) return;
-
-    if (this[MAP].has(name)) this.end(name);
-
-    start = start || Date.now();
-    const item = {
-      name,
-      start,
-      end: undefined,
-      duration: undefined,
-      pid: process.pid,
-      index: this[LIST].length,
-    };
-    this[MAP].set(name, item);
-    this[LIST].push(item);
-    return item;
-  }
-
-  end(name) {
-    if (!name || !this._enable) return;
-    assert(this[MAP].has(name), `should run timing.start('${name}') first`);
-
-    const item = this[MAP].get(name);
-    item.end = Date.now();
-    item.duration = item.end - item.start;
-    return item;
-  }
-
-  enable() {
-    this._enable = true;
-  }
-
-  disable() {
-    this._enable = false;
-  }
-
-  clear() {
-    this[MAP].clear();
-    this[LIST] = [];
-  }
-
-  toJSON() {
-    return this[LIST];
-  }
-}
-
-module.exports = Timing;
+'use strict';
+
+const assert = require('assert');
+const MAP = Symbol('Timing#map');
+const LIST = Symbol('Timing#list');
+
+
+class Timing {
+
+  constructor() {
+    this._enable = true;
+    this[MAP] = new Map();
+    this[LIST] = [];
+
+    this.init();
+  }
+
+  init() {
+    // process start time
+    this.start('Process Start', Date.now() - Math.floor((process.uptime() * 1000)));
+    this.end('Process Start');
+
+    if (typeof process.scriptStartTime === 'number') {
+      // js script start execute time
+      this.start('Script Start', process.scriptStartTime);
+      this.end('Script Start');
+    }
+  }
+
+  start(name, start) {
+    if (!name || !this._enable) return;
+
+    if (this[MAP].has(name)) this.end(name);
+
+    start = start || Date.now();
+    const item = {
+      name,
+      start,
+      end: undefined,
+      duration: undefined,
+      pid: process.pid,
+      index: this[LIST].length,
+    };
+    this[MAP].set(name, item);
+    this[LIST].push(item);
+    return item;
+  }
+
+  end(name) {
+    if (!name || !this._enable) return;
+    assert(this[MAP].has(name), `should run timing.start('${name}') first`);
+
+    const item = this[MAP].get(name);
+    item.end = Date.now();
+    item.duration = item.end - item.start;
+    return item;
+  }
+
+  enable() {
+    this._enable = true;
+  }
+
+  disable() {
+    this._enable = false;
+  }
+
+  clear() {
+    this[MAP].clear();
+    this[LIST] = [];
+  }
+
+  toJSON() {
+    return this[LIST];
+  }
+}
+
+module.exports = Timing;