apollo-link-http - npm Package Compare versions

Comparing version 1.1.0 to 1.2.0

CHANGELOG.md

@@ -5,2 +5,6 @@ # Change log
 
+### 1.2.0
+- moved to better rollup build
+- support for persisted queries by opting out of sending the query
+
 ### v1.1.0
@@ -7,0 +11,0 @@ - support dynamic endpoints using `uri` on the context

lib/bundle.umd.js

 (function (global, factory) {
 	typeof exports === 'object' && typeof module !== 'undefined' ? factory(exports, require('apollo-link'), require('graphql/language/printer')) :
 	typeof define === 'function' && define.amd ? define(['exports', 'apollo-link', 'graphql/language/printer'], factory) :
-	(factory((global.httpLink = {}),global.apolloLink,global.graphql_language_printer));
-}(this, (function (exports,apolloLink,graphql_language_printer) { 'use strict';
+	(factory((global.apolloLink = global.apolloLink || {}, global.apolloLink.http = {}),global.apolloLink.core,global.printer));
+}(this, (function (exports,apolloLink,printer) { 'use strict';
 
@@ -76,2 +76,6 @@ var __extends = (undefined && undefined.__extends) || (function () {
 };
+var defaultHttpOptions = {
+    includeQuery: true,
+    includeExtensions: false,
+};
 var createHttpLink = function (_a) {
@@ -89,11 +93,10 @@ if (_a === void 0) { _a = {}; }
         return new apolloLink.Observable(function (observer) {
-            var _a = operation.getContext(), headers = _a.headers, credentials = _a.credentials, _b = _a.fetchOptions, fetchOptions = _b === void 0 ? {} : _b, contextURI = _a.uri;
+            var _a = operation.getContext(), headers = _a.headers, credentials = _a.credentials, _b = _a.fetchOptions, fetchOptions = _b === void 0 ? {} : _b, contextURI = _a.uri, _c = _a.http, httpOptions = _c === void 0 ? {} : _c;
             var operationName = operation.operationName, extensions = operation.extensions, variables = operation.variables, query = operation.query;
-            var body = {
-                operationName: operationName,
-                variables: variables,
-                query: graphql_language_printer.print(query),
-            };
-            if (includeExtensions)
+            var http = __assign({}, defaultHttpOptions, httpOptions);
+            var body = { operationName: operationName, variables: variables };
+            if (includeExtensions || http.includeExtensions)
                 body.extensions = extensions;
+            if (http.includeQuery)
+                body.query = printer.print(query);
             var serializedBody;
@@ -123,3 +126,3 @@ try {
                 fetcherOptions.headers = __assign({}, fetcherOptions.headers, headers);
-            var _c = createSignalIfSupported(), controller = _c.controller, signal = _c.signal;
+            var _d = createSignalIfSupported(), controller = _d.controller, signal = _d.signal;
             if (controller)
@@ -153,9 +156,4 @@ fetcherOptions.signal = signal;
     function HttpLink(opts) {
-        var _this = _super.call(this) || this;
-        _this.requester = createHttpLink(opts).request;
-        return _this;
+        return _super.call(this, createHttpLink(opts).request) || this;
     }
-    HttpLink.prototype.request = function (op) {
-        return this.requester(op);
-    };
     return HttpLink;
@@ -162,0 +160,0 @@ }(apolloLink.ApolloLink));

lib/httpLink.d.ts

@@ -1,4 +0,2 @@
-/// <reference types="zen-observable" />
-import { ApolloLink, Observable, RequestHandler } from 'apollo-link';
-import { ExecutionResult } from 'graphql';
+import { ApolloLink, RequestHandler } from 'apollo-link';
 export interface FetchOptions {
@@ -16,3 +14,2 @@ uri?: string;
     constructor(opts: FetchOptions);
-    request(op: any): Observable<ExecutionResult> | null;
 }

lib/httpLink.js

@@ -72,2 +72,6 @@ var __extends = (this && this.__extends) || (function () {
 };
+var defaultHttpOptions = {
+    includeQuery: true,
+    includeExtensions: false,
+};
 export var createHttpLink = function (_a) {
@@ -85,11 +89,10 @@ if (_a === void 0) { _a = {}; }
         return new Observable(function (observer) {
-            var _a = operation.getContext(), headers = _a.headers, credentials = _a.credentials, _b = _a.fetchOptions, fetchOptions = _b === void 0 ? {} : _b, contextURI = _a.uri;
+            var _a = operation.getContext(), headers = _a.headers, credentials = _a.credentials, _b = _a.fetchOptions, fetchOptions = _b === void 0 ? {} : _b, contextURI = _a.uri, _c = _a.http, httpOptions = _c === void 0 ? {} : _c;
             var operationName = operation.operationName, extensions = operation.extensions, variables = operation.variables, query = operation.query;
-            var body = {
-                operationName: operationName,
-                variables: variables,
-                query: print(query),
-            };
-            if (includeExtensions)
+            var http = __assign({}, defaultHttpOptions, httpOptions);
+            var body = { operationName: operationName, variables: variables };
+            if (includeExtensions || http.includeExtensions)
                 body.extensions = extensions;
+            if (http.includeQuery)
+                body.query = print(query);
             var serializedBody;
@@ -119,3 +122,3 @@ try {
                 fetcherOptions.headers = __assign({}, fetcherOptions.headers, headers);
-            var _c = createSignalIfSupported(), controller = _c.controller, signal = _c.signal;
+            var _d = createSignalIfSupported(), controller = _d.controller, signal = _d.signal;
             if (controller)
@@ -149,9 +152,4 @@ fetcherOptions.signal = signal;
     function HttpLink(opts) {
-        var _this = _super.call(this) || this;
-        _this.requester = createHttpLink(opts).request;
-        return _this;
+        return _super.call(this, createHttpLink(opts).request) || this;
     }
-    HttpLink.prototype.request = function (op) {
-        return this.requester(op);
-    };
     return HttpLink;
@@ -158,0 +156,0 @@ }(ApolloLink));

package.json

 {
   "name": "apollo-link-http",
-  "version": "1.1.0",
+  "version": "1.2.0",
   "description": "HTTP transport layer for GraphQL",
@@ -14,5 +14,5 @@ "author": "Evans Hauser <[e-mail]>",
   "main": "./lib/bundle.umd.js",
-  "module": "./lib/httpLink.js",
-  "jsnext:main": "./lib/httpLink.js",
-  "typings": "./lib/httpLink.d.ts",
+  "module": "./lib/index.js",
+  "jsnext:main": "./lib/index.js",
+  "typings": "./lib/index.d.ts",
   "repository": {
@@ -44,10 +44,10 @@ "type": "git",
   "peerDependencies": {
-    "apollo-link": "^1.0.0",
+    "apollo-link": "^1.0.3",
     "graphql": "^0.11.0"
   },
   "devDependencies": {
-    "@types/graphql": "0.11.5",
-    "@types/jest": "21.1.5",
+    "@types/graphql": "0.11.6",
+    "@types/jest": "21.1.6",
     "apollo-fetch": "0.6.0",
-    "apollo-link": "^1.0.0",
+    "apollo-link": "^1.0.3",
     "browserify": "14.5.0",
@@ -59,7 +59,7 @@ "fetch-mock": "5.13.1",
     "rimraf": "2.6.1",
-    "rollup": "0.45.2",
-    "ts-jest": "21.1.4",
+    "rollup": "0.51.5",
+    "ts-jest": "21.2.2",
     "tslint": "5.8.0",
     "typescript": "2.6.1",
-    "uglify-js": "3.1.6"
+    "uglify-js": "3.1.9"
   },
@@ -66,0 +66,0 @@ "jest": {

README.md

@@ -48,4 +48,21 @@ ---
 - `response`: this is the raw response from the fetch request after it is made.
+- `http`: this is an object to control fine grained aspects of the http link itself (see below)
 
+**http options**
+The http link supports an advanced GraphQL feature (and maybe more in the future) called persisted queries. This allows you to not send the stringified query over the wire, but instead send some kind of identifier of the query. To support this you need to attach the id somewhere to the extensions field and pass the following options to the context:
 
+```
+operation.setContext({
+  http: {
+    includeExtensions: true,
+    includeQuery: false,
+  }
+})
+```
+
+the `http` object on context currently supports two keys:
+- `includeExtensions`: allowing you to send the extensions object per request
+- `includeQuery`: allowing you to not send a query as part of the request
+
+
 ```js
@@ -52,0 +69,0 @@ import HttpLink from "apollo-link-http";

rollup.config.js

@@ -1,17 +0,3 @@
-export default {
-  entry: 'lib/httpLink.js',
-  dest: 'lib/bundle.umd.js',
-  format: 'umd',
-  sourceMap: true,
-  moduleName: 'httpLink',
-  exports: 'named',
-  onwarn,
-};
+import build from '../../rollup.config';
 
-function onwarn(message) {
-  const suppressed = ['UNRESOLVED_IMPORT', 'THIS_IS_UNDEFINED'];
-
-  if (!suppressed.find(code => message.code === code)) {
-    return console.warn(message.message);
-  }
-}
+export default build('http');

src/__tests__/httpLink.ts

@@ -481,2 +481,23 @@ import { Observable, ApolloLink, execute } from 'apollo-link';
   });
+  it('allows for not sending the query with the request', done => {
+    const variables = { params: 'stub' };
+    const middleware = new ApolloLink((operation, forward) => {
+      operation.setContext({
+        http: {
+          includeQuery: false,
+          includeExtensions: true,
+        },
+      });
+      operation.extensions.persistedQuery = { hash: '1234' };
+      return forward(operation);
+    });
+    const link = middleware.concat(createHttpLink({ uri: 'data' }));
+
+    execute(link, { query: sampleQuery, variables }).subscribe(result => {
+      const body = JSON.parse(fetchMock.lastCall()[1].body);
+      expect(body.query).not.toBeDefined();
+      expect(body.extensions).toEqual({ persistedQuery: { hash: '1234' } });
+      done();
+    });
+  });
 });
@@ -522,2 +543,37 @@
   });
+  beforeEach(() => {
+    fetch.mockReset();
+  });
+  it('makes it easy to do stuff on a 401', done => {
+    const middleware = new ApolloLink((operation, forward) => {
+      return new Observable(ob => {
+        fetch.mockReturnValueOnce(Promise.resolve({ status: 401, json }));
+        const op = forward(operation);
+        const sub = op.subscribe({
+          next: ob.next.bind(ob),
+          error: e => {
+            expect(e.parseError.message).toMatch(/Received status code 401/);
+            expect(e.statusCode).toEqual(401);
+            ob.error(e);
+            done();
+          },
+          complete: ob.complete.bind(ob),
+        });
+
+        return () => {
+          sub.unsubscribe();
+        };
+      });
+    });
+
+    const link = middleware.concat(createHttpLink({ uri: 'data', fetch }));
+
+    execute(link, { query: sampleQuery }).subscribe(
+      result => {
+        done.fail('error should have been thrown from the network');
+      },
+      () => {},
+    );
+  });
+
   it('throws an error if response code is > 300', done => {
@@ -555,34 +611,3 @@ fetch.mockReturnValueOnce(Promise.resolve({ status: 400, json }));
   });
-  it('makes it easy to do stuff on a 401', done => {
-    fetch.mockReturnValueOnce(Promise.resolve({ status: 401, json }));
 
-    const middleware = new ApolloLink((operation, forward) => {
-      return new Observable(ob => {
-        const op = forward(operation);
-        const sub = op.subscribe({
-          next: ob.next.bind(ob),
-          error: e => {
-            expect(e.parseError.message).toMatch(/Received status code 401/);
-            expect(e.statusCode).toEqual(401);
-            ob.error(e);
-            done();
-          },
-          complete: ob.complete.bind(ob),
-        });
-
-        return () => {
-          sub.unsubscribe();
-        };
-      });
-    });
-
-    const link = middleware.concat(createHttpLink({ uri: 'data', fetch }));
-
-    execute(link, { query: sampleQuery }).subscribe(
-      result => {
-        done.fail('error should have been thrown from the network');
-      },
-      () => {},
-    );
-  });
   it("throws if the body can't be stringified", done => {
@@ -589,0 +614,0 @@ fetch.mockReturnValueOnce(Promise.resolve({ data: {}, json }));

src/httpLink.ts

@@ -5,3 +5,2 @@ import { ApolloLink, Observable, RequestHandler } from 'apollo-link';
 // types
-import { ExecutionResult } from 'graphql';
 import { ApolloFetch } from 'apollo-fetch';
@@ -35,3 +34,5 @@
       const httpError = new Error(
-        `Network request failed with status ${response.status} - "${response.statusText}"`,
+        `Network request failed with status ${response.status} - "${
+          response.statusText
+        }"`,
       ) as ResponseError;
@@ -97,2 +98,8 @@ httpError.response = response;
 }
+
+const defaultHttpOptions = {
+  includeQuery: true,
+  includeExtensions: false,
+};
+
 export const createHttpLink = (
@@ -122,12 +129,14 @@ {
           uri: contextURI,
+          http: httpOptions = {},
         } = operation.getContext();
         const { operationName, extensions, variables, query } = operation;
+        const http = { ...defaultHttpOptions, ...httpOptions };
+        const body = { operationName, variables };
 
-        const body = {
-          operationName,
-          variables,
-          query: print(query),
-        };
-        if (includeExtensions) (body as any).extensions = extensions;
+        if (includeExtensions || http.includeExtensions)
+          (body as any).extensions = extensions;
 
+        // not sending the query (i.e persisted queries)
+        if (http.includeQuery) (body as any).query = print(query);
+
         let serializedBody;
@@ -204,9 +213,4 @@ try {
   constructor(opts: FetchOptions) {
-    super();
-    this.requester = createHttpLink(opts).request;
+    super(createHttpLink(opts).request);
   }
-
-  public request(op): Observable<ExecutionResult> | null {
-    return this.requester(op);
-  }
 }

No alert changes

Improved metrics

Total package byte prevSize

70496

3.12%

Number of package files

16

33.33%

Lines of code

1141

0.71%

Number of lines in readme file

206

8.99%

No dependency changes