Splits Adapter loading from AdaptableController

- Adds dynamic prototype conformance check upon setting adapter
- Throws when adapter is undefined, invalid in controller

Author: flovilmart

spec/AdaptableController.spec.js

@@ -1,70 +1,44 @@
 
 var AdaptableController = require("../src/Controllers/AdaptableController").AdaptableController;
 var FilesAdapter = require("../src/Adapters/Files/FilesAdapter").default;
+var FilesController = require("../src/Controllers/FilesController").FilesController;
+
+var MockController = function(options) {
+  AdaptableController.call(this, options);
+}
+MockController.prototype = Object.create(AdaptableController.prototype);
+MockController.prototype.constructor = AdaptableController;
 
 describe("AdaptableController", ()=>{
-    
-  it("should instantiate an adapter from string in object", (done) => {
-    var adapterPath = require('path').resolve("./spec/MockAdapter");
-    var controller = new AdaptableController({
-      adapter: adapterPath,
-      key: "value", 
-      foo: "bar"
-    });
-    
-    expect(controller.adapter instanceof Object).toBe(true);
-    expect(controller.options.key).toBe("value");
-    expect(controller.options.foo).toBe("bar");
-    expect(controller.adapter.options.key).toBe("value");
-    expect(controller.adapter.options.foo).toBe("bar");
-    done();
-  });
-  
-  it("should instantiate an adapter from string", (done) => {
-    var adapterPath = require('path').resolve("./spec/MockAdapter");
-    var controller = new AdaptableController(adapterPath);
-    
-    expect(controller.adapter instanceof Object).toBe(true);
-    done();
-  });
-  
-  it("should instantiate an adapter from string that is module", (done) => {
-    var adapterPath = require('path').resolve("./src/Adapters/Files/FilesAdapter");
-    var controller = new AdaptableController({
-      adapter: adapterPath
-    });
-    
-    expect(controller.adapter instanceof FilesAdapter).toBe(true);
-    done();
-  });
 
-  it("should instantiate an adapter from function/Class", (done) => {
-    var controller = new AdaptableController({
-      adapter: FilesAdapter
-    });
-    expect(controller.adapter instanceof FilesAdapter).toBe(true);
+  it("should use the provided adapter", (done) => {
+    var adapter = new FilesAdapter();
+    var controller = new FilesController(adapter);
+    expect(controller.adapter).toBe(adapter);
     done();
   });
 
-  it("should instantiate the default adapter from Class", (done) => {
-    AdaptableController.setDefaultAdapter(FilesAdapter);
-    var controller = new AdaptableController();
-    expect(controller.adapter instanceof FilesAdapter).toBe(true);
+  it("should throw when creating a new mock controller", (done) => {
+    var adapter = new FilesAdapter();
+    expect(() => {
+      new MockController(adapter);
+    }).toThrow();
     done();
   });
 
-  it("should use the default adapter", (done) => {
-    var adapter = new FilesAdapter();
-    AdaptableController.setDefaultAdapter(adapter);
-    var controller = new AdaptableController();
-    expect(controller.adapter).toBe(adapter);
+  it("should fail to instantiate a controller with wrong adapter", (done) => {
+    function WrongAdapter() {};
+    var adapter = new WrongAdapter();
+    expect(() => {
+      new FilesController(adapter);
+    }).toThrow();
     done();
   });
 
-  it("should use the provided adapter", (done) => {
-    var adapter = new FilesAdapter();
-    var controller = new AdaptableController(adapter);
-    expect(controller.adapter).toBe(adapter);
+  it("should fail to instantiate a controller without an adapter", (done) => {
+    expect(() => {
+      new FilesController();
+    }).toThrow();
     done();
   });
 });

spec/AdapterLoader.spec.js

@@ -0,0 +1,68 @@
+
+var AdapterLoader = require("../src/Adapters/AdapterLoader").AdapterLoader;
+var FilesAdapter = require("../src/Adapters/Files/FilesAdapter").default;
+
+describe("AdaptableController", ()=>{
+    
+  it("should instantiate an adapter from string in object", (done) => {
+    var adapterPath = require('path').resolve("./spec/MockAdapter");
+
+    var adapter = AdapterLoader.load({
+      adapter: adapterPath,
+      key: "value", 
+      foo: "bar"
+    });
+    
+    expect(adapter instanceof Object).toBe(true);
+    expect(adapter.options.key).toBe("value");
+    expect(adapter.options.foo).toBe("bar");
+    done();
+  });
+  
+  it("should instantiate an adapter from string", (done) => {
+    var adapterPath = require('path').resolve("./spec/MockAdapter");
+    var adapter = AdapterLoader.load(adapterPath);
+    
+    expect(adapter instanceof Object).toBe(true);
+    expect(adapter.options).toBe(adapterPath);
+    done();
+  });
+  
+  it("should instantiate an adapter from string that is module", (done) => {
+    var adapterPath = require('path').resolve("./src/Adapters/Files/FilesAdapter");
+    var adapter = AdapterLoader.load({
+      adapter: adapterPath
+    });
+    
+    expect(adapter instanceof FilesAdapter).toBe(true);
+    done();
+  });
+  
+  it("should instantiate an adapter from function/Class", (done) => {
+    var adapter = AdapterLoader.load({
+      adapter: FilesAdapter
+    });
+    expect(adapter instanceof FilesAdapter).toBe(true);
+    done();
+  });
+  
+  it("should instantiate the default adapter from Class", (done) => {
+    var adapter = AdapterLoader.load(null, FilesAdapter);
+    expect(adapter instanceof FilesAdapter).toBe(true);
+    done();
+  });
+  
+  it("should use the default adapter", (done) => {
+    var defaultAdapter = new FilesAdapter();
+    var adapter = AdapterLoader.load(null, defaultAdapter);
+    expect(adapter instanceof FilesAdapter).toBe(true);
+    done();
+  });
+  
+  it("should use the provided adapter", (done) => {
+    var originalAdapter = new FilesAdapter();
+    var adapter = AdapterLoader.load(originalAdapter);
+    expect(adapter).toBe(originalAdapter);
+    done();
+  });
+});

spec/FilesController.spec.js

@@ -1,12 +1,14 @@
 var FilesController = require('../src/Controllers/FilesController').FilesController;
+var GridStoreAdapter = require("../src/Adapters/Files/GridStoreAdapter").GridStoreAdapter;
 var Config = require("../src/Config");
 
 // Small additional tests to improve overall coverage
 describe("FilesController",()=>{
 
   it("should properly expand objects", (done) => {
     var config = new Config(Parse.applicationId);
-    var filesController = new FilesController();
+    var adapter = new GridStoreAdapter();
+    var filesController = new FilesController(adapter);
     var result = filesController.expandFilesInObject(config, function(){});
 
     expect(result).toBeUndefined();

spec/LoggerController.spec.js

@@ -76,13 +76,11 @@ describe('LoggerController', () => {
   });
 
   it('should throw without an adapter', (done) => {
-    LoggerController.setDefaultAdapter(undefined);
-    var loggerController = new LoggerController();
+    
 
     expect(() => {
-      loggerController.getLogs();
+      var loggerController = new LoggerController();
     }).toThrow();
-    LoggerController.setDefaultAdapter(FileLoggerAdapter);
     done();
   });
 });

src/Adapters/AdapterLoader.js

@@ -0,0 +1,39 @@
+
+export class AdapterLoader {
+  static load(options, defaultAdapter) {
+    let adapter;
+
+    // We have options and options have adapter key
+    if (options) {
+      // Pass an adapter as a module name, a function or an instance
+      if (typeof options == "string" || typeof options == "function" || options.constructor != Object) {
+        adapter = options;
+      }
+      if (options.adapter) {
+        adapter = options.adapter;
+      }
+    }
+    
+    if (!adapter) {
+      adapter = defaultAdapter;
+    }
+
+    // This is a string, require the module
+    if (typeof adapter === "string") {
+      adapter = require(adapter);
+      // If it's define as a module, get the default
+      if (adapter.default) {
+        adapter = adapter.default;
+      }
+    }
+    // From there it's either a function or an object
+    // if it's an function, instanciate and pass the options 
+    if (typeof adapter === "function") {
+      var Adapter = adapter;
+      adapter = new Adapter(options);
+    }
+    return adapter;
+  }
+}
+
+export default AdapterLoader;

src/Controllers/AdaptableController.js

@@ -8,8 +8,6 @@ based on the parameters passed
 
  */
 
-const DefaultAdapters = {};
-
 export class AdaptableController {
    /**
    * Check whether the api call has master key or not.
@@ -22,51 +20,49 @@ export class AdaptableController {
    * - object: a plain javascript object (options.constructor === Object), if options.adapter is set, we'll try to load it with the same mechanics.
    * - function: we'll create a new instance from that function, and pass the options object
    */ 
-  constructor(options) {
- 
-    let adapter;
-
-    // We have options and options have adapter key
-    if (options) {
-      // Pass an adapter as a module name, a function or an instance
-      if (typeof options == "string" || typeof options == "function" || options.constructor != Object) {
-        adapter = options;
-      }
-      if (options.adapter) {
-        adapter = options.adapter;
-      }
-    }
-    
-    if (!adapter) {
-      adapter = this.defaultAdapter();
-    }
-
-    // This is a string, require the module
-    if (typeof adapter === "string") {
-      adapter = require(adapter);
-      // If it's define as a module, get the default
-      if (adapter.default) {
-        adapter = adapter.default;
-      }
-    }
-    // From there it's either a function or an object
-    // if it's an function, instanciate and pass the options 
-    if (typeof adapter === "function") {
-      var Adapter = adapter;
-      adapter = new Adapter(options);
-    }
-
+  constructor(adapter, options) {
+    this.setAdapter(adapter, options);
+  }
+  
+  setAdapter(adapter, options) {
+    this.validateAdapter(adapter);
     this.adapter = adapter;
     this.options = options;
   }
 
-  defaultAdapter() {
-     return DefaultAdapters[this.constructor.name];
+  expectedAdapterType() {
+    throw new Error("Subclasses should implement expectedAdapterType()");
   }
 
-  // Sets the default adapter for that Class
-  static setDefaultAdapter(defaultAdapter) {
-    DefaultAdapters[this.name] = defaultAdapter;
+  validateAdapter(adapter) {
+    
+    if (!adapter) {
+      throw new Error(this.constructor.name+" requires an adapter");
+    }
+    
+    let Type = this.expectedAdapterType();
+    // Allow skipping for testing
+    if (!Type) { 
+      return;
+    }
+    
+    // Makes sure the prototype matches
+    let mismatches = Object.getOwnPropertyNames(Type.prototype).reduce( (obj, key) => {
+       const adapterType = typeof adapter[key];
+       const expectedType = typeof Type.prototype[key];
+       if (adapterType !== expectedType) {
+         obj[key] = {
+           expected: expectedType,
+           actual: adapterType
+         }
+       }
+       return obj;
+    }, {});
+   
+    if (Object.keys(mismatches).length > 0) {
+      console.error(adapter, mismatches);
+      throw new Error("Adapter prototype don't match expected prototype");
+    }
   }
 }
 

src/Controllers/FilesController.js

@@ -2,6 +2,7 @@
 import { Parse } from 'parse/node';
 import { randomHexString } from '../cryptoUtils';
 import AdaptableController from './AdaptableController';
+import { FilesAdapter } from '../Adapters/Files/FilesAdapter';
 
 export class FilesController extends AdaptableController {
 
@@ -29,7 +30,7 @@ export class FilesController extends AdaptableController {
    * with the current mount point and app id.
    * Object may be a single object or list of REST-format objects.
    */
-  expandFilesInObject(config, object) {
+   expandFilesInObject(config, object) {
     if (object instanceof Array) {
       object.map((obj) => this.expandFilesInObject(config, obj));
       return;
@@ -52,6 +53,10 @@ export class FilesController extends AdaptableController {
       }
     }
   }
+  
+  expectedAdapterType() {
+    return FilesAdapter;
+  }
 }
 
 export default FilesController;

src/Controllers/LoggerController.js

@@ -1,6 +1,7 @@
 import { Parse } from 'parse/node';
 import PromiseRouter from '../PromiseRouter';
 import AdaptableController from './AdaptableController';
+import { LoggerAdapter } from '../Adapters/Logger/LoggerAdapter';
 
 const Promise = Parse.Promise;
 const MILLISECONDS_IN_A_DAY = 24 * 60 * 60 * 1000;
@@ -70,6 +71,10 @@ export class LoggerController extends AdaptableController {
     });
     return promise;
   }
+  
+  expectedAdapterType() {
+    return LoggerAdapter;
+  }
 }
 
 export default LoggerController;