Include any available fields in response if throwOnMissingField is …

…false.
apollographql · Jul 6, 2016 · 5ae2fd1 · 5ae2fd1
1 parent 2366ba6
commit 5ae2fd1
Show file tree

Hide file tree

Showing 3 changed files with 68 additions and 4 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -4,6 +4,8 @@ Expect active development and potentially significant breaking changes in the `0
 
 ### vNEXT
 
+- Made sure `diffSelectionSetAgainstStore` will return any available data from the local cache if `throwOnMissingField` is `false`, even if some fields in the query are missing. This also means that the `returnPartialData` option of `watchQuery` will return partial data if some fields are missing in the cache, rather than an empty object. [Issue #359](https://github.com/apollostack/apollo-client/issues/359) and [PR #360](https://github.com/apollostack/apollo-client/pull/360).
+
 ### v0.3.27
 
 - Removed dependency on `graphql` npm package, which was causing compilation errors in the React Native bundler. Issues [#261](https://github.com/apollostack/apollo-client/issues/261) [#163](https://github.com/apollostack/apollo-client/issues/163), [PR #357](https://github.com/apollostack/apollo-client/pull/357)

diff --git a/src/data/diffAgainstStore.ts b/src/data/diffAgainstStore.ts
@@ -147,14 +147,14 @@ export function diffSelectionSetAgainstStore({
           included: includeField,
         });
 
+      const resultFieldKey = resultKeyNameFromField(selection);
       if (fieldIsMissing) {
         // even if the field is not included, we want to keep it in the
         // query that is sent to the server. So, we push it into the set of
         // fields that is missing.
         pushMissingField(selection);
-      } else if (includeField) {
-        const resultFieldKey = resultKeyNameFromField(selection);
-
+      }
+      if (includeField && fieldResult !== undefined) {
         result[resultFieldKey] = fieldResult;
       }
     } else if (isInlineFragment(selection)) {

diff --git a/test/diffAgainstStore.ts b/test/diffAgainstStore.ts
@@ -1,8 +1,13 @@
 import { assert } from 'chai';
 
-import { diffQueryAgainstStore } from '../src/data/diffAgainstStore';
+import {
+  diffQueryAgainstStore,
+  diffSelectionSetAgainstStore,
+} from '../src/data/diffAgainstStore';
 import { writeQueryToStore } from '../src/data/writeToStore';
 import { printQueryForMissingData } from '../src/queryPrinting';
+import { getQueryDefinition } from '../src/queries/getFromAST';
+
 
 import {
   getIdField,
@@ -279,4 +284,61 @@ describe('diffing queries against the store', () => {
 `);
     assert.deepEqual(store['1'], result.people_one);
   });
+
+  it('returns available fields if throwOnMissingField is false', () => {
+    const firstQuery = gql`
+      {
+        people_one(id: "1") {
+          __typename
+          id
+          name
+        }
+      }
+    `;
+
+    const firstResult = {
+      people_one: {
+        __typename: 'Person',
+        id: 'lukeId',
+        name: 'Luke Skywalker',
+      },
+    };
+
+    const store = writeQueryToStore({
+      result: firstResult,
+      query: firstQuery,
+    });
+
+    const queryWithMissingField = gql`
+      {
+        people_one(id: "1") {
+          name
+          age
+        }
+      }
+    `;
+
+    const { result } = diffSelectionSetAgainstStore({
+      store,
+      rootId: 'ROOT_QUERY',
+      selectionSet: getQueryDefinition(queryWithMissingField).selectionSet,
+      variables: null,
+      throwOnMissingField: false,
+    });
+
+    assert.deepEqual(result, {
+      people_one: {
+        name: 'Luke Skywalker',
+      },
+    });
+    assert.throws(function() {
+      diffSelectionSetAgainstStore({
+        store,
+        rootId: 'ROOT_QUERY',
+        selectionSet: getQueryDefinition(queryWithMissingField).selectionSet,
+        variables: null,
+        throwOnMissingField: true,
+      });
+    });
+  });
 });