feat: add loader.loadToContext, it can load files that bind ctx

popomore · popomore · commit e30d33a9bca4 · 2016-08-03T22:10:55.000+08:00
move proxy/service to mixin
diff --git a/lib/context_loader.js b/lib/context_loader.js
@@ -0,0 +1,74 @@
+'use strict';
+
+const assert = require('assert');
+const is = require('is-type-of');
+const Loader = require('./Loader');
+const classLoader = Symbol('classLoader');
+const END = Loader.END;
+
+class ClassLoader {
+
+  constructor(options) {
+    assert(options.ctx, 'options.ctx is required');
+    const properties = options.properties;
+    this._cache = new Map();
+    this._ctx = options.ctx;
+
+    for (const property in properties) {
+      this.defineProperty(property, properties[property]);
+    }
+  }
+
+  defineProperty(property, values) {
+    Object.defineProperty(this, property, {
+      get() {
+        if (!this._cache.has(property)) {
+          this._cache.set(property, getInstance(values, this._ctx));
+        }
+        return this._cache.get(property);
+      },
+    });
+  }
+}
+
+class ContextLoader extends Loader {
+
+  constructor(options) {
+    assert(options.field, 'options.field is required');
+    assert(options.inject, 'options.inject is required');
+    const target = options.target = {};
+    if (options.fieldClass) {
+      options.inject[options.fieldClass] = target;
+    }
+    super(options);
+
+    const app = this.options.inject;
+
+    Object.defineProperty(app.context, options.field, {
+      get() {
+        if (!this[classLoader]) {
+          this[classLoader] = getInstance(target, this);
+        }
+        return this[classLoader];
+      },
+    });
+  }
+}
+
+module.exports = ContextLoader;
+
+
+function getInstance(values, ctx) {
+  const Class = values[END] ? values : null;
+  let instance;
+  if (Class) {
+    if (is.class(Class)) {
+      instance = new Class(ctx);
+    } else {
+      instance = Class;
+    }
+  } else {
+    instance = new ClassLoader({ ctx, properties: values });
+  }
+  return instance;
+}
diff --git a/lib/egg_loader.js b/lib/egg_loader.js
@@ -6,6 +6,7 @@ const assert = require('assert');
 const isFunction = require('is-type-of').function;
 const debug = require('debug')('egg-loader');
 const Loader = require('./loader');
+const ContextLoader = require('./context_loader');
 const loadFile = require('./utils').loadFile;
 const getHomedir = require('./utils').getHomedir;
 const Emitter = require('events').EventEmitter;
@@ -235,7 +236,8 @@ class EggLoader {
     return dirs;
   }
 
-  loadTo(directory, target, opt) {
+  loadToApp(directory, field, opt) {
+    const target = this.app[field] = {};
     opt = Object.assign({}, {
       directory,
       target,
@@ -244,9 +246,13 @@ class EggLoader {
     new Loader(opt).load();
   }
 
-  loadToApp(directory, field, opt) {
-    const target = this.app[field] = {};
-    this.loadTo(directory, target, opt);
+  loadToContext(directory, field, opt) {
+    opt = Object.assign({}, {
+      directory,
+      field,
+      inject: this.app,
+    }, opt);
+    new ContextLoader(opt).load();
   }
 
 }
@@ -261,8 +267,8 @@ const loaders = [
   require('./mixin/config'),
   require('./mixin/extend'),
   require('./mixin/custom'),
-  require('./proxy_loader'),
-  require('./service_loader'),
+  require('./mixin/proxy'),
+  require('./mixin/service'),
   require('./mixin/middleware'),
   require('./mixin/controller'),
 ];
diff --git a/lib/loader.js b/lib/loader.js
@@ -8,6 +8,7 @@ const globby = require('globby');
 const is = require('is-type-of');
 const loadFile = require('./utils').loadFile;
 const FULLPATH = Symbol('EGG_LOADER_ITEM_FULLPATH');
+const END = Symbol('EGG_LOADER_ITEM_END');
 
 const defaults = {
   directory: null,
@@ -33,6 +34,8 @@ class Loader {
     const target = this.options.target;
     for (const item of items) {
       debug('loading item %j', item);
+      // item { properties: [ 'a', 'b', 'c'], exports }
+      // => target.a.b.c = exports
       item.properties.reduce((target, property, index) => {
         let obj;
         const properties = item.properties.slice(0, index + 1).join('.');
@@ -41,7 +44,10 @@ class Loader {
             if (!this.options.override) throw new Error(`can't overwrite property '${properties}' from ${target[property][FULLPATH]} by ${item.fullpath}`);
           }
           obj = item.exports;
-          if (obj) obj[FULLPATH] = item.fullpath;
+          if (obj) {
+            obj[FULLPATH] = item.fullpath;
+            obj[END] = true;
+          }
         } else {
           obj = target[property] || {};
         }
@@ -87,6 +93,7 @@ class Loader {
 }
 
 module.exports = Loader;
+module.exports.END = END;
 
 // a/b/c.js => ['a', 'b', 'c']
 function getProperties(filepath, lowercaseFirst) {
@@ -105,23 +112,37 @@ function getProperties(filepath, lowercaseFirst) {
   });
 }
 
+// Get exports from filepath
+// If exports is null/undefined, it will be ignored
 function getExports(fullpath, initializer, isCall, inject) {
   let exports = loadFile(fullpath);
 
+  // process exports as you like
   if (initializer) {
     exports = initializer(exports);
   }
 
+  // return exports when it's a class or generator
+  //
+  // module.exports = class Service {};
+  // or
+  // module.exports = function*() {}
   if (is.class(exports) || is.generatorFunction(exports)) {
     return exports;
   }
 
+  // return exports after call when it's a function
+  //
+  // module.exports = function(app) {
+  //   return {};
+  // }
   if (isCall && is.function(exports)) {
     exports = exports(inject);
     if (exports != null) {
       return exports;
     }
   }
 
+  // return exports what is
   return exports;
 }
diff --git a/lib/mixin/proxy.js b/lib/mixin/proxy.js
@@ -0,0 +1,30 @@
+'use strict';
+
+const join = require('path').join;
+
+module.exports = {
+
+  /**
+   * 加载 app/proxy 目录下的文件
+   *
+   * 1. 加载应用 app/proxy
+   * 2. 加载插件 app/proxy
+   *
+   * @method EggLoader#loadProxy
+   * @param {Object} opt - loading 参数
+   */
+  loadProxy(opt) {
+    const app = this.app;
+    const arr = this.getLoadUnits().map(unit => join(unit.path, 'app/proxy'));
+
+    opt = Object.assign({
+      call: true,
+      lowercaseFirst: true,
+      fieldClass: 'proxyClasses',
+    }, opt);
+    this.loadToContext(arr, 'proxy', opt);
+
+    app.coreLogger.info('[egg:loader] Proxy loaded from %j', arr);
+  },
+
+};
diff --git a/lib/mixin/service.js b/lib/mixin/service.js
@@ -0,0 +1,30 @@
+'use strict';
+
+const path = require('path');
+
+module.exports = {
+
+  /**
+   * 加载 app/service 目录下的文件
+   *
+   * 1. 加载应用 app/service
+   * 2. 加载插件 app/service
+   *
+   * @method EggLoader#loadService
+   * @param {Object} opt - loading 参数
+   */
+  loadService(opt) {
+    const servicePaths = this.getLoadUnits().map(unit => {
+      return path.join(unit.path, 'app/service');
+    });
+
+    // 载入到 app.serviceClasses
+    opt = Object.assign({
+      call: true,
+      lowercaseFirst: true,
+      fieldClass: 'serviceClasses',
+    }, opt);
+    this.loadToContext(servicePaths, 'service', opt);
+  },
+
+};
diff --git a/lib/proxy_loader.js b/lib/proxy_loader.js
diff --git a/lib/service_loader.js b/lib/service_loader.js
diff --git a/test/fixtures/subdir-proxy/app/router.js b/test/fixtures/subdir-proxy/app/router.js
@@ -13,4 +13,4 @@ module.exports = function (app) {
       oldStyle: yield this.proxy.oldStyle.url(this),
     };
   });
-}
+}
diff --git a/test/fixtures/subdir-services/app/controller/home.js b/test/fixtures/subdir-services/app/controller/home.js
@@ -5,7 +5,7 @@ module.exports = function* () {
     bar1: yield this.service.foo.bar.get('bar1name'),
     bar2: yield this.service.foo.subdir.bar.get('bar2name'),
     'foo.subdir2.sub2': yield this.service.foo.subdir2.sub2.get('bar3name'),
-    subdir11bar: !!this.service.foo.subdir1,
+    subdir11bar: yield this.service.foo.subdir1.subdir11.bar.get(),
     ok: yield this.service.ok.get(),
     cmd: yield this.service.certifyPersonal.mobileHi.doCertify.exec('hihi'),
     serviceIsSame: this.service.certifyPersonal === this.service.certifyPersonal,
diff --git a/test/load_proxy.test.js b/test/load_proxy.test.js
@@ -58,7 +58,7 @@ describe('test/load_proxy.test.js', function() {
           name: 'bar3name',
           bar: 'bar3',
         },
-        subdir11bar: false,
+        subdir11bar: true,
         ok: {
           ok: true,
         },
diff --git a/test/load_service.test.js b/test/load_service.test.js

-Original file line number
+Diff line change
       oldStyle: yield this.proxy.oldStyle.url(this),
     };
   });
 -}
 +}
-Original file line number
+Diff line change
   it('should load from application and plugin', function(done) {
     const app = utils.createApp('plugin');
 -    console.log(app.serviceClasses);
     should.exists(app.serviceClasses.foo);
     should.exists(app.serviceClasses.foo2);
     should.not.exists(app.serviceClasses.bar1);
           name: 'bar3name',
           bar: 'bar3',
         },
 -        subdir11bar: false,
 +        subdir11bar: {
 +          bar: 'bar111',
 +        },
         ok: {
           ok: true,
         },