warn when user try to use apollo-boost as an apollo-client

apollographql · Jun 6, 2018 · f7c380a · f7c380a
1 parent ffea402
commit f7c380a
Show file tree

Hide file tree

Showing 3 changed files with 72 additions and 18 deletions.
diff --git a/packages/apollo-boost/src/__tests__/__snapshots__/config.ts.snap b/packages/apollo-boost/src/__tests__/__snapshots__/config.ts.snap
@@ -0,0 +1,10 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`config warns about unsupported parameter 1`] = `
+Array [
+  Array [
+    "ApolloBoot client was initialized with unsupported options: link
+https://github.com/apollographql/apollo-client/tree/master/packages/apollo-boost#apollo-boost-options",
+  ],
+]
+`;
diff --git a/packages/apollo-boost/src/__tests__/config.ts b/packages/apollo-boost/src/__tests__/config.ts
@@ -22,6 +22,16 @@ describe('config', () => {
     },
   };
 
+  it('warns about unsupported parameter', () => {
+    jest.spyOn(global.console, 'warn');
+
+    const client = new ApolloClient({
+      link: [],
+    });
+
+    expect(global.console.warn.mock.calls).toMatchSnapshot();
+  });
+
   it('allows you to pass in a request handler', () => {
     let requestCalled;
 

diff --git a/packages/apollo-boost/src/index.ts b/packages/apollo-boost/src/index.ts
@@ -25,8 +25,41 @@ export interface PresetConfig {
   cacheRedirects?: CacheResolverMap;
 }
 
+// infer this list from the above interface
+// using a typescript transform at compilation time.
+const PRESET_CONFIG_KEYS = [
+  'request',
+  'uri',
+  'credentials',
+  'headers',
+  'fetchOptions',
+  'clientState',
+  'onError',
+  'cacheRedirects',
+];
+
+function include<T>(b: T, a: Array<T>): boolean {
+  return a.indexOf(b) >= 0;
+}
+
+function difference<T>(a: Array<T>, b: Array<T>): Array<T> {
+  return a.filter(x => !include(x, b));
+}
+
 export default class DefaultClient<TCache> extends ApolloClient<TCache> {
   constructor(config: PresetConfig) {
+    if (config) {
+      const diff = difference(Object.keys(config), PRESET_CONFIG_KEYS);
+
+      if (diff.length > 0) {
+        // prettier-ignore
+        console.warn(
+          `ApolloBoot client was initialized with unsupported options: ${diff.join(' ')}\n` +
+          `https://github.com/apollographql/apollo-client/tree/master/packages/apollo-boost#apollo-boost-options`,
+        );
+      }
+    }
+
     const cache =
       config && config.cacheRedirects
         ? new InMemoryCache({ cacheRedirects: config.cacheRedirects })
@@ -52,24 +85,25 @@ export default class DefaultClient<TCache> extends ApolloClient<TCache> {
 
     const requestHandler =
       config && config.request
-        ? new ApolloLink((operation, forward) =>
-            new Observable(observer => {
-              let handle: any;
-              Promise.resolve(operation)
-                .then(oper => config.request(oper))
-                .then(() => {
-                  handle = forward(operation).subscribe({
-                    next: observer.next.bind(observer),
-                    error: observer.error.bind(observer),
-                    complete: observer.complete.bind(observer),
-                  });
-                })
-                .catch(observer.error.bind(observer));
-
-              return () => {
-                if (handle) handle.unsubscribe;
-              };
-            })
+        ? new ApolloLink(
+            (operation, forward) =>
+              new Observable(observer => {
+                let handle: any;
+                Promise.resolve(operation)
+                  .then(oper => config.request(oper))
+                  .then(() => {
+                    handle = forward(operation).subscribe({
+                      next: observer.next.bind(observer),
+                      error: observer.error.bind(observer),
+                      complete: observer.complete.bind(observer),
+                    });
+                  })
+                  .catch(observer.error.bind(observer));
+
+                return () => {
+                  if (handle) handle.unsubscribe;
+                };
+              }),
           )
         : false;