Merge pull request #423 from bertdeblock/add-the-ability-to-globally-override-the-query-manager-service

Add support for a `defaultQueryManagerService` environment option

Author: josemarluedke

README.md

@@ -41,9 +41,13 @@ let ENV = {
   ...
   apollo: {
     apiURL: 'https://test.example/graphql',
+    
     // Optionally, set the credentials property of the Fetch Request interface
     // to control when a cookie is sent:
     // requestCredentials: 'same-origin', // other choices: 'include', 'omit'
+    
+    // Optionally, define which service a query manager should use by default:
+    // defaultQueryManagerService: 'my-custom-apollo-service',
   },
   ...
 }

addon/-private/apollo/query-manager.js

@@ -25,16 +25,20 @@ function isElementDescriptor(args) {
 }
 
 export function queryManager(...theArgs) {
-  let serviceName = 'apollo';
-  let [options] = theArgs;
-  if (typeof options === 'object' && options.service) {
-    serviceName = options.service;
-  }
-
   let setupQueryManager = computed(function () {
-    const service = getOwner(this).lookup(`service:${serviceName}`);
+    const [options] = theArgs;
+    const owner = getOwner(this);
+    const config = owner.resolveRegistration('config:environment');
+
+    const serviceOption = options?.service;
+    const serviceDefaultOption = config.apollo?.defaultQueryManagerService;
+    const serviceName = serviceOption || serviceDefaultOption || 'apollo';
+
+    const service = owner.lookup(`service:${serviceName}`);
     const queryManager = new QueryManager(service);
+
     setupHooks(queryManager, this);
+
     return queryManager;
   });
 

tests/unit/-private/query-manager-hooks-component-test.js

@@ -95,7 +95,7 @@ module(
     if (gte('3.10.0')) {
       test('it works using decorator syntax', function (assert) {
         assert.expect(5);
-        TestObject = class MyTestClassOjbect extends EmberComponent {
+        TestObject = class MyTestClassObject extends EmberComponent {
           @queryManager({ service: 'overridden-apollo' }) apollo;
 
           willDestroyElement() {

tests/unit/-private/query-manager-hooks-object-test.js

@@ -93,7 +93,7 @@ module('Unit | queryManager | Setup Hooks in EmberOject', function (hooks) {
   if (gte('3.10.0')) {
     test('it works using decorator syntax', function (assert) {
       assert.expect(6);
-      TestObject = class MyTestClassOjbect extends EmberObject {
+      TestObject = class MyTestClassObject extends EmberObject {
         @queryManager({ service: 'overridden-apollo' }) apollo;
 
         willDestroy() {

tests/unit/-private/query-manager-macro-decorator-test.js

@@ -40,7 +40,7 @@ module('Unit | queryManager | macro - decorator', function (hooks) {
 
   if (gte('3.10.0')) {
     test('it works using decorator syntax without options', function (assert) {
-      TestObject = class MyTestClassOjbect extends EmberObject {
+      TestObject = class MyTestClassObject extends EmberObject {
         @queryManager apollo;
       };
 
@@ -57,7 +57,7 @@ module('Unit | queryManager | macro - decorator', function (hooks) {
     });
 
     test('it works using decorator syntax with options', function (assert) {
-      TestObject = class MyTestClassOjbect extends EmberObject {
+      TestObject = class MyTestClassObject extends EmberObject {
         @queryManager({ service: 'overridden-apollo' }) apollo;
       };
 
@@ -72,5 +72,31 @@ module('Unit | queryManager | macro - decorator', function (hooks) {
         'the apollo service should be an instance of the overridden apollo service'
       );
     });
+
+    test('it works using the `defaultQueryManagerService` environment option', function (assert) {
+      const config = this.owner.resolveRegistration('config:environment');
+
+      config.apollo.defaultQueryManagerService = 'overridden-apollo';
+
+      TestObject = class MyTestClassObject extends EmberObject {
+        @queryManager apollo;
+      };
+
+      let subject = this.subject();
+
+      assert.ok(subject.apollo, 'should create an apollo property');
+
+      assert.true(
+        subject.apollo instanceof QueryManager,
+        'it should be an instance of the query manager'
+      );
+
+      assert.true(
+        subject.apollo.apollo instanceof OverriddenApollo,
+        'the apollo service should be an instance of the overridden apollo service'
+      );
+
+      delete config.apollo.defaultQueryManagerService;
+    });
   }
 });