ee-core 1.2.8 → 1.2.9

package/core/lib/loader/mixin/config.js

@@ -1,138 +1,138 @@
-'use strict';
-
-const debug = require('debug')('ee-core:config');
-const path = require('path');
-const extend = require('extend2');
-const assert = require('assert');
-const { Console } = require('console');
-
-module.exports = {
-
-  /**
-   * Load config/config.js
-   *
-   * Will merge config.default.js 和 config.${env}.js
-   *
-   * @function EggLoader#loadConfig
-   * @since 1.0.0
-   */
-  loadConfig() {
-    this.timing.start('Load Config');
-    this.configMeta = {};
-
-    const target = {};
-
-    // Load Application config first
-    const appConfig = this._preloadAppConfig();
-    //console.log('----------------------- appConfig:', appConfig);
-
-    //   plugin config.default
-    //     framework config.default
-    //       app config.default
-    //         plugin config.{env}
-    //           framework config.{env}
-    //             app config.{env}
-    for (const filename of this.getTypeFiles('config')) {
-      for (const unit of this.getLoadUnits()) {
-        const isApp = unit.type === 'app';
-        const config = this._loadConfig(unit.path, filename, isApp ? undefined : appConfig, unit.type);
-
-        if (!config) {
-          continue;
-        }
-
-        debug('Loaded config %s, %s, %j', unit.path, filename, config);
-        extend(true, target, config);
-      }
-    }
-
-    // load env from process.env.EE_APP_CONFIG
-    const envConfig = this._loadConfigFromEnv();
-    debug('Loaded config from private env, %j', envConfig);
-    extend(true, target, envConfig);
-
-    // You can manipulate the order of app.config.coreMiddleware and app.config.appMiddleware in app.js
-    target.coreMiddleware = target.coreMiddlewares = target.coreMiddleware || [];
-    target.appMiddleware = target.appMiddlewares = target.middleware || [];
-
-    this.config = target;
-    this.timing.end('Load Config');
-  },
-
-  _preloadAppConfig() {
-    const names = [
-      'config.default',
-      `config.${this.serverEnv}`,
-    ];
-    const target = {};
-    for (const filename of names) {
-      const config = this._loadConfig(this.options.baseDir, filename, undefined, 'app');
-      extend(true, target, config);
-    }
-    return target;
-  },
-
-  _loadConfig(dirpath, filename, extraInject, type) {
-    const isPlugin = type === 'plugin';
-    const isApp = type === 'app';
-
-    let filepath = this.resolveModule(path.join(dirpath, 'config', filename));
-
-    //console.log("_loadConfig filepath:", filepath);
-
-    // let config.js compatible
-    if (filename === 'config.default' && !filepath) {
-      filepath = this.resolveModule(path.join(dirpath, 'config/config'));
-    }
-  
-    const config = this.loadFile(filepath, this.appInfo, extraInject);
-
-    if (!config) return null;
-
-    if (isPlugin || isApp) {
-      assert(!config.coreMiddleware, 'Can not define coreMiddleware in app or plugin');
-    }
-    if (!isApp) {
-      assert(!config.middleware, 'Can not define middleware in ' + filepath);
-    }
-
-    // store config meta, check where is the property of config come from.
-    this._setConfigMeta(config, filepath);
-
-    return config;
-  },
-
-  _loadConfigFromEnv() {
-    const envConfigStr = process.env.EE_APP_CONFIG;
-    if (!envConfigStr) return;
-    try {
-      const envConfig = JSON.parse(envConfigStr);
-      this._setConfigMeta(envConfig, '<process.env.EE_APP_CONFIG>');
-      return envConfig;
-    } catch (err) {
-      this.options.logger.warn('[egg-loader] process.env.EE_APP_CONFIG is not invalid JSON: %s', envConfigStr);
-    }
-  },
-
-  _setConfigMeta(config, filepath) {
-    config = extend(true, {}, config);
-    setConfig(config, filepath);
-    extend(true, this.configMeta, config);
-  },
-};
-
-function setConfig(obj, filepath) {
-  for (const key of Object.keys(obj)) {
-    const val = obj[key];
-    // ignore console
-    if (key === 'console' && val && typeof val.Console === 'function' && val.Console === Console) {
-      obj[key] = filepath;
-      continue;
-    }
-    if (val && Object.getPrototypeOf(val) === Object.prototype && Object.keys(val).length > 0) {
-      setConfig(val, filepath);
-      continue;
-    }
-    obj[key] = filepath;
-  }
-}
+'use strict';
+
+const debug = require('debug')('ee-core:config');
+const path = require('path');
+const extend = require('extend2');
+const assert = require('assert');
+const { Console } = require('console');
+
+module.exports = {
+
+  /**
+   * Load config/config.js
+   *
+   * Will merge config.default.js 和 config.${env}.js
+   *
+   * @function EggLoader#loadConfig
+   * @since 1.0.0
+   */
+  loadConfig() {
+    this.timing.start('Load Config');
+    this.configMeta = {};
+
+    const target = {};
+
+    // Load Application config first
+    const appConfig = this._preloadAppConfig();
+    //console.log('----------------------- appConfig:', appConfig);
+
+    //   plugin config.default
+    //     framework config.default
+    //       app config.default
+    //         plugin config.{env}
+    //           framework config.{env}
+    //             app config.{env}
+    for (const filename of this.getTypeFiles('config')) {
+      for (const unit of this.getLoadUnits()) {
+        const isApp = unit.type === 'app';
+        const config = this._loadConfig(unit.path, filename, isApp ? undefined : appConfig, unit.type);
+
+        if (!config) {
+          continue;
+        }
+
+        debug('Loaded config %s, %s, %j', unit.path, filename, config);
+        extend(true, target, config);
+      }
+    }
+
+    // load env from process.env.EE_APP_CONFIG
+    const envConfig = this._loadConfigFromEnv();
+    debug('Loaded config from private env, %j', envConfig);
+    extend(true, target, envConfig);
+
+    // You can manipulate the order of app.config.coreMiddleware and app.config.appMiddleware in app.js
+    target.coreMiddleware = target.coreMiddlewares = target.coreMiddleware || [];
+    target.appMiddleware = target.appMiddlewares = target.middleware || [];
+
+    this.config = target;
+    this.timing.end('Load Config');
+  },
+
+  _preloadAppConfig() {
+    const names = [
+      'config.default',
+      `config.${this.serverEnv}`,
+    ];
+    const target = {};
+    for (const filename of names) {
+      const config = this._loadConfig(this.options.baseDir, filename, undefined, 'app');
+      extend(true, target, config);
+    }
+    return target;
+  },
+
+  _loadConfig(dirpath, filename, extraInject, type) {
+    const isPlugin = type === 'plugin';
+    const isApp = type === 'app';
+
+    let filepath = this.resolveModule(path.join(dirpath, 'config', filename));
+
+    //console.log("_loadConfig filepath:", filepath);
+
+    // let config.js compatible
+    if (filename === 'config.default' && !filepath) {
+      filepath = this.resolveModule(path.join(dirpath, 'config/config'));
+    }
+  
+    const config = this.loadFile(filepath, this.appInfo, extraInject);
+
+    if (!config) return null;
+
+    if (isPlugin || isApp) {
+      assert(!config.coreMiddleware, 'Can not define coreMiddleware in app or plugin');
+    }
+    if (!isApp) {
+      assert(!config.middleware, 'Can not define middleware in ' + filepath);
+    }
+
+    // store config meta, check where is the property of config come from.
+    this._setConfigMeta(config, filepath);
+
+    return config;
+  },
+
+  _loadConfigFromEnv() {
+    const envConfigStr = process.env.EE_APP_CONFIG;
+    if (!envConfigStr) return;
+    try {
+      const envConfig = JSON.parse(envConfigStr);
+      this._setConfigMeta(envConfig, '<process.env.EE_APP_CONFIG>');
+      return envConfig;
+    } catch (err) {
+      this.options.logger.warn('[egg-loader] process.env.EE_APP_CONFIG is not invalid JSON: %s', envConfigStr);
+    }
+  },
+
+  _setConfigMeta(config, filepath) {
+    config = extend(true, {}, config);
+    setConfig(config, filepath);
+    extend(true, this.configMeta, config);
+  },
+};
+
+function setConfig(obj, filepath) {
+  for (const key of Object.keys(obj)) {
+    const val = obj[key];
+    // ignore console
+    if (key === 'console' && val && typeof val.Console === 'function' && val.Console === Console) {
+      obj[key] = filepath;
+      continue;
+    }
+    if (val && Object.getPrototypeOf(val) === Object.prototype && Object.keys(val).length > 0) {
+      setConfig(val, filepath);
+      continue;
+    }
+    obj[key] = filepath;
+  }
+}

package/core/lib/loader/mixin/controller.js

@@ -1,123 +1,123 @@
-'use strict';
-
-const path = require('path');
-const is = require('is-type-of');
-const utility = require('utility');
-const utils = require('../../utils');
-const FULLPATH = require('../file_loader').FULLPATH;
-
-
-module.exports = {
-
-  /**
-   * Load app/controller
-   * @param {Object} opt - LoaderOptions
-   * @since 1.0.0
-   */
-  loadController(opt) {
-    this.timing.start('Load Controller');
-    opt = Object.assign({
-      caseStyle: 'lower',
-      directory: path.join(this.options.baseDir, 'controller'),
-      initializer: (obj, opt) => {
-        // return class if it exports a function
-        // ```js
-        // module.exports = app => {
-        //   return class HomeController extends app.Controller {};
-        // }
-        // ```
-        if (is.function(obj) && !is.generatorFunction(obj) && !is.class(obj) && !is.asyncFunction(obj)) {
-          obj = obj(this.app);
-        }
-        if (is.class(obj)) {
-          obj.prototype.pathName = opt.pathName;
-          obj.prototype.fullPath = opt.path;
-          return wrapClass(obj);
-        }
-        if (is.object(obj)) {
-          return wrapObject(obj, opt.path);
-        }
-        // support generatorFunction for forward compatbility
-        if (is.generatorFunction(obj) || is.asyncFunction(obj)) {
-          return wrapObject({ 'module.exports': obj }, opt.path)['module.exports'];
-        }
-        return obj;
-      },
-    }, opt);
-    const controllerBase = opt.directory;
-
-    this.loadToApp(controllerBase, 'controller', opt);
-    this.options.logger.info('[egg:loader] Controller loaded: %s', controllerBase);
-    this.timing.end('Load Controller');
-  },
-
-};
-
-// wrap the class, yield a object with middlewares
-function wrapClass(Controller) {
-  let proto = Controller.prototype;
-  const ret = {};
-  // tracing the prototype chain
-  while (proto !== Object.prototype) {
-    const keys = Object.getOwnPropertyNames(proto);
-    for (const key of keys) {
-      // getOwnPropertyNames will return constructor
-      // that should be ignored
-      if (key === 'constructor') {
-        continue;
-      }
-      // skip getter, setter & non-function properties
-      const d = Object.getOwnPropertyDescriptor(proto, key);
-      // prevent to override sub method
-      if (is.function(d.value) && !ret.hasOwnProperty(key)) {
-        ret[key] = methodToMiddleware(Controller, key);
-        ret[key][FULLPATH] = Controller.prototype.fullPath + '#' + Controller.name + '.' + key + '()';
-      }
-    }
-    proto = Object.getPrototypeOf(proto);
-  }
-  return ret;
-
-  function methodToMiddleware(Controller, key) {
-    return function classControllerMiddleware(...args) {
-      const controller = new Controller(this);
-      // if (!this.app.config.controller || !this.app.config.controller.supportParams) {
-      //   args = [ this ];
-      // }
-      //args = [ this ];
-      return utils.callFn(controller[key], args, controller);
-    };
-  }
-}
-
-// wrap the method of the object, method can receive ctx as it's first argument
-function wrapObject(obj, path, prefix) {
-  const keys = Object.keys(obj);
-  const ret = {};
-  for (const key of keys) {
-    if (is.function(obj[key])) {
-      const names = utility.getParamNames(obj[key]);
-      if (names[0] === 'next') {
-        throw new Error(`controller \`${prefix || ''}${key}\` should not use next as argument from file ${path}`);
-      }
-      ret[key] = functionToMiddleware(obj[key]);
-      ret[key][FULLPATH] = `${path}#${prefix || ''}${key}()`;
-    } else if (is.object(obj[key])) {
-      ret[key] = wrapObject(obj[key], path, `${prefix || ''}${key}.`);
-    }
-  }
-  return ret;
-
-  function functionToMiddleware(func) {
-    const objectControllerMiddleware = async function(...args) {
-      // if (!this.app.config.controller || !this.app.config.controller.supportParams) {
-      //   args = [ this ];
-      // }
-      return await utils.callFn(func, args, this);
-    };
-    for (const key in func) {
-      objectControllerMiddleware[key] = func[key];
-    }
-    return objectControllerMiddleware;
-  }
-}
+'use strict';
+
+const path = require('path');
+const is = require('is-type-of');
+const utility = require('utility');
+const utils = require('../../utils');
+const FULLPATH = require('../file_loader').FULLPATH;
+
+
+module.exports = {
+
+  /**
+   * Load app/controller
+   * @param {Object} opt - LoaderOptions
+   * @since 1.0.0
+   */
+  loadController(opt) {
+    this.timing.start('Load Controller');
+    opt = Object.assign({
+      caseStyle: 'lower',
+      directory: path.join(this.options.baseDir, 'controller'),
+      initializer: (obj, opt) => {
+        // return class if it exports a function
+        // ```js
+        // module.exports = app => {
+        //   return class HomeController extends app.Controller {};
+        // }
+        // ```
+        if (is.function(obj) && !is.generatorFunction(obj) && !is.class(obj) && !is.asyncFunction(obj)) {
+          obj = obj(this.app);
+        }
+        if (is.class(obj)) {
+          obj.prototype.pathName = opt.pathName;
+          obj.prototype.fullPath = opt.path;
+          return wrapClass(obj);
+        }
+        if (is.object(obj)) {
+          return wrapObject(obj, opt.path);
+        }
+        // support generatorFunction for forward compatbility
+        if (is.generatorFunction(obj) || is.asyncFunction(obj)) {
+          return wrapObject({ 'module.exports': obj }, opt.path)['module.exports'];
+        }
+        return obj;
+      },
+    }, opt);
+    const controllerBase = opt.directory;
+
+    this.loadToApp(controllerBase, 'controller', opt);
+    this.options.logger.info('[egg:loader] Controller loaded: %s', controllerBase);
+    this.timing.end('Load Controller');
+  },
+
+};
+
+// wrap the class, yield a object with middlewares
+function wrapClass(Controller) {
+  let proto = Controller.prototype;
+  const ret = {};
+  // tracing the prototype chain
+  while (proto !== Object.prototype) {
+    const keys = Object.getOwnPropertyNames(proto);
+    for (const key of keys) {
+      // getOwnPropertyNames will return constructor
+      // that should be ignored
+      if (key === 'constructor') {
+        continue;
+      }
+      // skip getter, setter & non-function properties
+      const d = Object.getOwnPropertyDescriptor(proto, key);
+      // prevent to override sub method
+      if (is.function(d.value) && !ret.hasOwnProperty(key)) {
+        ret[key] = methodToMiddleware(Controller, key);
+        ret[key][FULLPATH] = Controller.prototype.fullPath + '#' + Controller.name + '.' + key + '()';
+      }
+    }
+    proto = Object.getPrototypeOf(proto);
+  }
+  return ret;
+
+  function methodToMiddleware(Controller, key) {
+    return function classControllerMiddleware(...args) {
+      const controller = new Controller(this);
+      // if (!this.app.config.controller || !this.app.config.controller.supportParams) {
+      //   args = [ this ];
+      // }
+      //args = [ this ];
+      return utils.callFn(controller[key], args, controller);
+    };
+  }
+}
+
+// wrap the method of the object, method can receive ctx as it's first argument
+function wrapObject(obj, path, prefix) {
+  const keys = Object.keys(obj);
+  const ret = {};
+  for (const key of keys) {
+    if (is.function(obj[key])) {
+      const names = utility.getParamNames(obj[key]);
+      if (names[0] === 'next') {
+        throw new Error(`controller \`${prefix || ''}${key}\` should not use next as argument from file ${path}`);
+      }
+      ret[key] = functionToMiddleware(obj[key]);
+      ret[key][FULLPATH] = `${path}#${prefix || ''}${key}()`;
+    } else if (is.object(obj[key])) {
+      ret[key] = wrapObject(obj[key], path, `${prefix || ''}${key}.`);
+    }
+  }
+  return ret;
+
+  function functionToMiddleware(func) {
+    const objectControllerMiddleware = async function(...args) {
+      // if (!this.app.config.controller || !this.app.config.controller.supportParams) {
+      //   args = [ this ];
+      // }
+      return await utils.callFn(func, args, this);
+    };
+    for (const key in func) {
+      objectControllerMiddleware[key] = func[key];
+    }
+    return objectControllerMiddleware;
+  }
+}

package/core/lib/loader/mixin/service.js

@@ -1,29 +1,29 @@
-'use strict';
-
-const path = require('path');
-
-
-module.exports = {
-
-  /**
-   * Load app/service
-   * @function EeLoader#loadService
-   * @param {Object} opt - LoaderOptions
-   * @since 1.0.0
-   */
-  loadService(opt) {
-    this.timing.start('Load Service');
-    // 载入到 app.serviceClasses
-    opt = Object.assign({
-      call: true,
-      caseStyle: 'lower',
-      fieldClass: 'serviceClasses',
-      directory: this.getLoadUnits().map(unit => path.join(unit.path, 'service')), // this.getLoadUnits().map(unit => path.join(unit.path, 'app/service'))
-    }, opt);
-
-    const servicePaths = opt.directory;
-    this.loadToContext(servicePaths, 'service', opt);
-    this.timing.end('Load Service');
-  },
-
-};
+'use strict';
+
+const path = require('path');
+
+
+module.exports = {
+
+  /**
+   * Load app/service
+   * @function EeLoader#loadService
+   * @param {Object} opt - LoaderOptions
+   * @since 1.0.0
+   */
+  loadService(opt) {
+    this.timing.start('Load Service');
+    // 载入到 app.serviceClasses
+    opt = Object.assign({
+      call: true,
+      caseStyle: 'lower',
+      fieldClass: 'serviceClasses',
+      directory: this.getLoadUnits().map(unit => path.join(unit.path, 'service')), // this.getLoadUnits().map(unit => path.join(unit.path, 'app/service'))
+    }, opt);
+
+    const servicePaths = opt.directory;
+    this.loadToContext(servicePaths, 'service', opt);
+    this.timing.end('Load Service');
+  },
+
+};

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;