Merge pull request #13526 from dgeb/engine-parent-dependencies

Clone shared dependencies between an engine instance and its parent.

Author: rwjblue

packages/ember-application/lib/system/engine-instance.js

@@ -8,6 +8,7 @@ import EmberError from 'ember-metal/error';
 import Registry from 'container/registry';
 import ContainerProxy from 'ember-runtime/mixins/container_proxy';
 import RegistryProxy from 'ember-runtime/mixins/registry_proxy';
+import { privatize as P } from 'container/registry';
 import { getEngineParent, setEngineParent } from 'ember-application/system/engine-parent';
 import { assert } from 'ember-metal/debug';
 import run from 'ember-metal/run_loop';
@@ -97,6 +98,10 @@ const EngineInstance = EmberObject.extend(RegistryProxy, ContainerProxy, {
 
     assert('An engine instance\'s parent must be set via `setEngineParent(engine, parent)` prior to calling `engine.boot()`.', getEngineParent(this));
 
+    if (isEnabled('ember-application-engines')) {
+      this.cloneParentDependencies();
+    }
+
     this.base.runInstanceInitializers(this);
 
     this._booted = true;
@@ -154,6 +159,32 @@ if (isEnabled('ember-application-engines')) {
       setEngineParent(engineInstance, this);
 
       return engineInstance;
+    },
+
+    /**
+      Clone dependencies shared between an engine instance and its parent.
+
+      @private
+      @method cloneParentDependencies
+    */
+    cloneParentDependencies() {
+      let parent = getEngineParent(this);
+
+      [
+        'route:basic',
+        'event_dispatcher:main',
+        P`-bucket-cache:main`,
+        'service:-routing'
+      ].forEach((key) => {
+        this.register(key, parent.resolveRegistration(key));
+      });
+
+      [
+        'router:main',
+        '-view-registry:main'
+      ].forEach((key) => {
+        this.register(key, parent.lookup(key), { instantiate: false });
+      });
     }
   });
 }

packages/ember-application/tests/system/application_instance_test.js

@@ -1,8 +1,11 @@
+import Engine from 'ember-application/system/engine';
 import Application from 'ember-application/system/application';
 import ApplicationInstance from 'ember-application/system/application-instance';
 import run from 'ember-metal/run_loop';
 import jQuery from 'ember-views/system/jquery';
 import factory from 'container/tests/test-helpers/factory';
+import isEnabled from 'ember-metal/features';
+import { privatize as P } from 'container/registry';
 
 let app, appInstance;
 
@@ -148,3 +151,46 @@ QUnit.test('unregistering a factory clears all cached instances of that factory'
 
   assert.notStrictEqual(postController1, postController2, 'lookup creates a brand new instance, because the previous one was reset');
 });
+
+if (isEnabled('ember-application-engines')) {
+  QUnit.test('can build and boot a registered engine', function(assert) {
+    assert.expect(7);
+
+    let ChatEngine = Engine.extend();
+    let chatEngineInstance;
+
+    app.register('engine:chat', ChatEngine);
+
+    run(function() {
+      appInstance = ApplicationInstance.create({ application: app });
+      chatEngineInstance = appInstance.buildChildEngineInstance('chat');
+    });
+
+    return chatEngineInstance.boot()
+      .then(() => {
+        assert.ok(true, 'boot successful');
+
+        [
+          'route:basic',
+          'event_dispatcher:main',
+          P`-bucket-cache:main`,
+          'service:-routing'
+        ].forEach((key) => {
+          assert.strictEqual(
+            chatEngineInstance.resolveRegistration(key),
+            appInstance.resolveRegistration(key),
+            `Engine and parent app share registrations for '${key}'`);
+        });
+
+        [
+          'router:main',
+          '-view-registry:main'
+        ].forEach((key) => {
+          assert.strictEqual(
+            chatEngineInstance.lookup(key),
+            appInstance.lookup(key),
+            `Engine and parent app share singleton '${key}'`);
+        });
+      });
+  });
+}

packages/ember-application/tests/system/engine_instance_initializers_test.js

@@ -9,7 +9,10 @@ let MyEngine,
 
 function buildEngineInstance(EngineClass) {
   let engineInstance = EngineClass.buildInstance();
-  setEngineParent(engineInstance, {});
+  setEngineParent(engineInstance, {
+    lookup() { return {}; },
+    resolveRegistration() { return {}; }
+  });
   return engineInstance;
 }
 

packages/ember-application/tests/system/engine_instance_test.js

@@ -57,23 +57,31 @@ QUnit.test('unregistering a factory clears all cached instances of that factory'
   assert.notStrictEqual(postComponent1, postComponent2, 'lookup creates a brand new instance because previous one was reset');
 });
 
-QUnit.test('can be booted when its parent has been set', function(assert) {
-  run(function() {
-    engineInstance = EngineInstance.create({ base: engine });
-  });
+if (isEnabled('ember-application-engines')) {
+  QUnit.test('can be booted when its parent has been set', function(assert) {
+    assert.expect(3);
+
+    run(function() {
+      engineInstance = EngineInstance.create({ base: engine });
+    });
+
+    expectAssertion(function() {
+      engineInstance._bootSync();
+    }, 'An engine instance\'s parent must be set via `setEngineParent(engine, parent)` prior to calling `engine.boot()`.');
 
-  expectAssertion(function() {
-    engineInstance._bootSync();
-  }, 'An engine instance\'s parent must be set via `setEngineParent(engine, parent)` prior to calling `engine.boot()`.');
+    setEngineParent(engineInstance, {});
 
-  setEngineParent(engineInstance, {});
+    // Stub `cloneParentDependencies`, the internals of which are tested along
+    // with application instances.
+    engineInstance.cloneParentDependencies = function() {
+      assert.ok(true, 'parent dependencies are cloned');
+    };
 
-  return engineInstance.boot().then(() => {
-    assert.ok(true, 'boot successful');
+    return engineInstance.boot().then(() => {
+      assert.ok(true, 'boot successful');
+    });
   });
-});
 
-if (isEnabled('ember-application-engines')) {
   QUnit.test('can build a child instance of a registered engine', function(assert) {
     let ChatEngine = Engine.extend();
     let chatEngineInstance;