feat(apollo): deprecate config value "shouldPrefetchOnServer"

And put its successor `allowServerSideDataFetching` into place.
xing · Oct 28, 2019 · 2758f43 · 2758f43
1 parent 2fc424e
commit 2758f43
Show file tree

Hide file tree

Showing 5 changed files with 28 additions and 8 deletions.
diff --git a/README.md b/README.md
@@ -704,7 +704,8 @@ _Reminder: These settings go into your `package.json` or [Hops configuration fil
 | `graphqlUri` | `String` | `''` | _yes_ | URI to your GraphQL endpoint or mock server |
 | `graphqlSchemaFile` | `String` | `''` | _no_ | Path to your GraphQL schema file |
 | `graphqlMockSchemaFile` | `String` | `''` | _no_ | Path to your GraphQL Schema mocks |
-| `shouldPrefetchOnServer` | `Boolean` | `true` | _no_ | Whether Hops should execute GraphQL queries during server-side rendering |
+| `shouldPrefetchOnServer` | `Boolean` | `true` | _no_ | Whether Hops should execute GraphQL queries during server-side rendering **[deprecated]** |
+| `allowServerSideDataFetching` | `Boolean` | `true` | _no_ | Whether Hops is allowed to execute GraphQL queries during server-side rendering |
 
 ##### Options
 

diff --git a/packages/apollo/README.md b/packages/apollo/README.md
@@ -55,7 +55,8 @@ Check out this [integration test](https://github.com/xing/hops/tree/master/packa
 | `fragmentsFile` | `String` | `<rootDir>/fragmentTypes.json` | _no_ | Where to store the generated fragment types file |
 | `graphqlUri` | `String` | `''` | _yes_ | Url to your GraphQL endpoint or mock server |
 | `graphqlSchemaFile` | `String` | `''` | _no_ | Path to your GraphQL schema file |
-| `shouldPrefetchOnServer` | `Boolean` | `true` | _no_ | Whether Hops should execute GraphQL queries during server-side rendering |
+| `shouldPrefetchOnServer` | `Boolean` | `true` | _no_ | Whether Hops should execute GraphQL queries during server-side rendering **[deprecated]** |
+| `allowServerSideDataFetching` | `Boolean` | `true` | _no_ | Whether Hops is allowed to execute GraphQL queries during server-side rendering |
 
 ##### `fragmentsFile`
 
@@ -91,7 +92,7 @@ In case your GraphQL server (configured via [`graphqlUri`](#graphqluri)) does no
 }
 ```
 
-##### `shouldPrefetchOnServer`
+##### `shouldPrefetchOnServer` **[deprecated]**
 
 Whether you want "full server-side rendering" or just "app shell" rendering.
 
@@ -103,6 +104,12 @@ This option controls whether you want Hops to execute GraphQL queries during ser
 }
 ```
 
+##### `allowServerSideDataFetching`
+
+If you don't want Hops to do full server-side rendering, set this value to `false`.
+
+Bear in mind, that setting this value to `true` on the other hand has no mandatory character. This means that there's no way to force Hops to execute server-side requests. As soon as there's a single Hops preset in place, that either sets the `allowServerSideDataFetching`-value to `false` or implements the [`canPrefetchOnServer`](https://github.com/xing/hops/tree/master/packages/graphql#canprefetchonserver-boolean-sequence-server)-hook to return `false`, there won't be any server-side requests.
+
 #### Render Options
 
 This preset has only a single runtime option which can be passed to the `render()` options inside the `styled` key (see example above).
@@ -167,6 +174,6 @@ Allows to get the [fragment matcher](https://www.apollographql.com/docs/react/ad
 
 This is a hook that can be used to customize the behavior of when Hops can prefetch data during server-side rendering. E.g. execute GraphQL queries during initial render. If any function of this sequence returns false it prevents server fetching for this request.
 
-By default it returns whatever is configured in the [`shouldPrefetchOnServer` preset option](#shouldPrefetchOnServer).
+By default it returns whatever is configured in the [`allowServerSideDataFetching` preset option](#allowServerSideDataFetching).
 
 In case you need more control over the server-side rendering you can implement this method and provide your own implementation that decides if data should be prefetched during server-side rendering.
diff --git a/packages/apollo/mixin.server.js b/packages/apollo/mixin.server.js
@@ -7,6 +7,7 @@ const {
     sync: { override, callable, sequence },
   },
 } = require('hops-mixin');
+const deprecate = require('depd')('hops-graphql');
 
 const { ApolloProvider, getMarkupFromTree } = require('react-apollo');
 const { default: ApolloClient } = require('apollo-client');
@@ -116,9 +117,19 @@ class GraphQLMixin extends Mixin {
   }
 
   canPrefetchOnServer() {
-    const { shouldPrefetchOnServer } = this.config;
+    const { shouldPrefetchOnServer, allowServerSideDataFetching } = this.config;
+
+    if (typeof shouldPrefetchOnServer === 'boolean') {
+      deprecate(
+        '[DEP0003] The config property "shouldPrefetchOnServer" is deprecated and will' +
+          ' be removed in favor of the property "allowServerSideDataFetching" in the next' +
+          ' major release of Hops.'
+      );
+    }
 
-    return shouldPrefetchOnServer !== false;
+    return (
+      shouldPrefetchOnServer !== false && allowServerSideDataFetching !== false
+    );
   }
 
   getTemplateData(data) {

diff --git a/packages/apollo/package.json b/packages/apollo/package.json
@@ -25,6 +25,7 @@
     "apollo-client": "^2.6.4",
     "apollo-link-http": "^1.5.16",
     "cross-fetch": "^3.0.4",
+    "depd": "^2.0.0",
     "graphql": "^14.5.8",
     "graphql-tools": "^4.0.5",
     "hops-config": "^12.0.0-alpha.3",

diff --git a/packages/apollo/preset.js b/packages/apollo/preset.js
@@ -1,7 +1,7 @@
 module.exports = {
   mixins: [__dirname],
   fragmentsFile: '<rootDir>/fragmentTypes.json',
-  shouldPrefetchOnServer: true,
+  allowServerSideDataFetching: true,
   browserWhitelist: {
     graphqlUri: true,
   },
@@ -18,7 +18,7 @@ module.exports = {
       type: 'string',
       absolutePath: true,
     },
-    shouldPrefetchOnServer: {
+    allowServerSideDataFetching: {
       type: 'boolean',
     },
   },