-
Notifications
You must be signed in to change notification settings - Fork 92
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: add AbortController for node-fetch (#569)
- Loading branch information
1 parent
a1e6570
commit 92b7590
Showing
3 changed files
with
237 additions
and
5 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,220 @@ | ||
| /** | ||
| * Copyright 2019 Google LLC | ||
| * All rights reserved. | ||
| * | ||
| * Redistribution and use in source and binary forms, with or without | ||
| * modification, are permitted provided that the following conditions are | ||
| * met: | ||
| * | ||
| * * Redistributions of source code must retain the above copyright | ||
| * notice, this list of conditions and the following disclaimer. | ||
| * Redistributions in binary form must reproduce the above | ||
| * copyright notice, this list of conditions and the following disclaimer | ||
| * in the documentation and/or other materials provided with the | ||
| * distribution. | ||
| * * Neither the name of Google Inc. nor the names of its | ||
| * contributors may be used to endorse or promote products derived from | ||
| * this software without specific prior written permission. | ||
| * | ||
| * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS | ||
| * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT | ||
| * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR | ||
| * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT | ||
| * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, | ||
| * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT | ||
| * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, | ||
| * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY | ||
| * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT | ||
| * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE | ||
| * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. | ||
| */ | ||
|
|
||
| import * as assert from 'assert'; | ||
| import * as nodeFetch from 'node-fetch'; | ||
| import * as abortController from 'abort-controller'; | ||
| import * as protobuf from 'protobufjs'; | ||
| import * as sinon from 'sinon'; | ||
| import {echoProtoJson} from '../browser-test/echoProtoJson'; | ||
| import {expect} from 'chai'; | ||
| import {GrpcClient} from '../src/browser'; | ||
|
|
||
| const authClient = { | ||
| getRequestHeaders() { | ||
| return {Authorization: 'Bearer SOME_TOKEN'}; | ||
| }, | ||
| }; | ||
|
|
||
| const authStub = { | ||
| getClient() { | ||
| return Promise.resolve(authClient); | ||
| }, | ||
| }; | ||
|
|
||
| const opts = { | ||
| auth: authStub, | ||
| }; | ||
|
|
||
| describe('loadProto', () => { | ||
| it('should create a root object', () => { | ||
| // @ts-ignore incomplete options | ||
| const gaxGrpc = new GrpcClient(opts); | ||
| const protos = gaxGrpc.loadProto(echoProtoJson); | ||
|
|
||
| assert(protos instanceof protobuf.Root); | ||
| assert(protos.lookupService('Echo') instanceof protobuf.Service); | ||
| assert(protos.lookupType('EchoRequest') instanceof protobuf.Type); | ||
| }); | ||
|
|
||
| it('should be able to load no files', () => { | ||
| // @ts-ignore incomplete options | ||
| const gaxGrpc = new GrpcClient(opts); | ||
| const protos = gaxGrpc.loadProto({}); | ||
| assert(protos instanceof protobuf.Root); | ||
|
|
||
| assert(protos.nested === undefined); | ||
| assert.strictEqual(protos.nested, undefined); | ||
| }); | ||
| }); | ||
|
|
||
| describe('createStub', () => { | ||
| let gaxGrpc, protos, echoService, stubOptions, stubExtraOptions; | ||
|
|
||
| beforeEach(() => { | ||
| // @ts-ignore incomplete options | ||
| gaxGrpc = new GrpcClient(opts); | ||
| protos = gaxGrpc.loadProto(echoProtoJson); | ||
| echoService = protos.lookupService('Echo'); | ||
| stubOptions = { | ||
| servicePath: 'foo.example.com', | ||
| port: 443, | ||
| }; | ||
| stubExtraOptions = { | ||
| servicePath: 'foo.example.com', | ||
| port: 443, | ||
| other_dummy_options: 'test', | ||
| }; | ||
| }); | ||
|
|
||
| it('should create a stub', async () => { | ||
| // tslint:disable-next-line no-any | ||
| const echoStub: any = await gaxGrpc.createStub(echoService, stubOptions); | ||
|
|
||
| assert(echoStub instanceof protobuf.rpc.Service); | ||
|
|
||
| // The stub should consist of service methods | ||
| expect(echoStub.echo).to.be.a('Function'); | ||
| expect(echoStub.pagedExpand).to.be.a('Function'); | ||
| expect(echoStub.wait).to.be.a('Function'); | ||
|
|
||
| // There should be 6 methods for the echo service (and 4 other methods in the object) | ||
| assert.strictEqual(Object.keys(echoStub).length, 10); | ||
|
|
||
| // Each of the service methods should take 4 arguments (so that it works with createApiCall) | ||
| assert.strictEqual(echoStub.echo.length, 4); | ||
| }); | ||
|
|
||
| it('should support optional parameters', async () => { | ||
| // tslint:disable-next-line no-any | ||
| const echoStub: any = await gaxGrpc.createStub( | ||
| echoService, | ||
| stubExtraOptions | ||
| ); | ||
|
|
||
| assert(echoStub instanceof protobuf.rpc.Service); | ||
|
|
||
| // The stub should consist of methods | ||
| expect(echoStub.echo).to.be.a('Function'); | ||
| expect(echoStub.collect).to.be.a('Function'); | ||
| expect(echoStub.chat).to.be.a('Function'); | ||
|
|
||
| // There should be 6 methods for the echo service (and 4 other members in the object) | ||
| assert.strictEqual(Object.keys(echoStub).length, 10); | ||
|
|
||
| // Each of the service methods should take 4 arguments (so that it works with createApiCall) | ||
| assert.strictEqual(echoStub.echo.length, 4); | ||
| }); | ||
| }); | ||
|
|
||
| describe('grpc-fallback', () => { | ||
| let gaxGrpc, protos, echoService, stubOptions; | ||
| const createdAbortControllers = []; | ||
| // @ts-ignore | ||
| const savedAbortController = abortController.AbortController; | ||
|
|
||
| before(() => { | ||
| stubOptions = { | ||
| servicePath: 'foo.example.com', | ||
| port: 443, | ||
| }; | ||
|
|
||
| // @ts-ignore incomplete options | ||
| gaxGrpc = new GrpcClient(opts); | ||
| protos = gaxGrpc.loadProto(echoProtoJson); | ||
| echoService = protos.lookupService('Echo'); | ||
| stubOptions = { | ||
| servicePath: 'foo.example.com', | ||
| port: 443, | ||
| }; | ||
|
|
||
| //tslint:disable-next-line variable-name | ||
| const AbortController = function() { | ||
| // @ts-ignore | ||
| this.abort = function() { | ||
| // @ts-ignore | ||
| this.abortCalled = true; | ||
| }; | ||
| // @ts-ignore | ||
| createdAbortControllers.push(this); | ||
| }; | ||
|
|
||
| // @ts-ignore | ||
| abortController.AbortController = AbortController; | ||
| }); | ||
|
|
||
| beforeEach(() => { | ||
| createdAbortControllers.splice(0); | ||
| }); | ||
|
|
||
| afterEach(() => { | ||
| sinon.restore(); | ||
| }); | ||
|
|
||
| after(() => { | ||
| // @ts-ignore | ||
| abortController.AbortController = savedAbortController; | ||
| }); | ||
|
|
||
| it('should make a request', done => { | ||
| const requestObject = {content: 'test-content'}; | ||
| const responseType = protos.lookupType('EchoResponse'); | ||
| const response = responseType.create(requestObject); // request === response for EchoService | ||
|
|
||
| sinon.stub(nodeFetch, 'Promise').returns( | ||
| Promise.resolve({ | ||
| arrayBuffer: () => { | ||
| return Promise.resolve(responseType.encode(response).finish()); | ||
| }, | ||
| }) | ||
| ); | ||
|
|
||
| gaxGrpc.createStub(echoService, stubOptions).then(echoStub => { | ||
| echoStub.echo(requestObject, {}, {}, (err, result) => { | ||
| assert.strictEqual(requestObject.content, result.content); | ||
| done(); | ||
| }); | ||
| }); | ||
| }); | ||
|
|
||
| it('should be able to cancel an API call using AbortController', async () => { | ||
| sinon.stub(nodeFetch, 'Promise').returns(Promise.resolve({})); | ||
|
|
||
| const echoStub = await gaxGrpc.createStub(echoService, stubOptions); | ||
| const request = {content: 'content' + new Date().toString()}; | ||
| const call = echoStub.echo(request, {}, {}, () => {}); | ||
|
|
||
| call.cancel(); | ||
|
|
||
| // @ts-ignore | ||
| assert.strictEqual(createdAbortControllers[0].abortCalled, true); | ||
| }); | ||
| }); |