Skip to content

Skip the remaining callbacks on connectivity state change #2419

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 2 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions packages/grpc-js/src/subchannel.ts
Original file line number Diff line number Diff line change
Expand Up @@ -264,6 +264,11 @@ export class Subchannel {
/* We use a shallow copy of the stateListeners array in case a listener
* is removed during this iteration */
for (const listener of [...this.stateListeners]) {
if (this.connectivityState !== newState) {
logging.log(LogVerbosity.ERROR, 'Subchannel connectivity state was changed before a listener called!');
return true;
}

listener(this, previousState, newState, this.keepaliveTime);
}
return true;
Expand Down
139 changes: 139 additions & 0 deletions packages/grpc-js/test/test-global-subchannel-pool.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,139 @@
/*
* Copyright 2023 gRPC authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
*/

import * as assert from 'assert';
import * as path from 'path';

import * as grpc from '../src';
import {sendUnaryData, Server, ServerCredentials, ServerUnaryCall, ServiceClientConstructor, ServiceError} from '../src';

import {loadProtoFile} from './common';

const protoFile = path.join(__dirname, 'fixtures', 'echo_service.proto');
const echoService =
loadProtoFile(protoFile).EchoService as ServiceClientConstructor;

describe('Global subchannel pool', () => {
let server: Server;
let serverPort: number;

let client1: InstanceType<grpc.ServiceClientConstructor>;
let client2: InstanceType<grpc.ServiceClientConstructor>;

let promises: Promise<any>[];

before(done => {
server = new Server();
server.addService(echoService.service, {
echo(call: ServerUnaryCall<any, any>, callback: sendUnaryData<any>) {
callback(null, call.request);
},
});

server.bindAsync(
'localhost:0', ServerCredentials.createInsecure(), (err, port) => {
assert.ifError(err);
serverPort = port;
server.start();
done();
});
});

beforeEach(() => {
promises = [];
})

after(done => {
server.tryShutdown(done);
});

function callService(client: InstanceType<grpc.ServiceClientConstructor>) {
return new Promise<void>((resolve, reject) => {
const request = {value: 'test value', value2: 3};

client.echo(request, (error: ServiceError, response: any) => {
try {
assert.ifError(error);
assert.deepStrictEqual(response, request);
resolve();
} catch (e) {
reject(e);
}
});
})
}

function connect() {
const grpcOptions = {
'grpc.use_local_subchannel_pool': 0,
}

client1 = new echoService(
`127.0.0.1:${serverPort}`, grpc.credentials.createInsecure(),
grpcOptions);

client2 = new echoService(
`127.0.0.1:${serverPort}`, grpc.credentials.createInsecure(),
grpcOptions);
}

it('client.close inside waitForReady callback should be called only once',
done => {
connect();

promises.push(new Promise<void>((resolve, reject) => {
client1.waitForReady(Date.now() + 50, (error) => {
try {
assert.ifError(error);
client1.close();
resolve();
} catch (e) {
reject(e);
}
});
}))

promises.push(new Promise<void>((resolve, reject) => {
client2.waitForReady(Date.now() + 50, (error) => {
try {
assert.notEqual(
error, undefined,
'Expected function to return an error, but no error was returned')
resolve();
} catch (e) {
reject(e);
}
});
}))

Promise.all(promises).then(() => done()).catch(reason => done(reason));
})

it('Call the service', done => {
promises.push(callService(client2));

Promise.all(promises).then(() => done()).catch(reason => done(reason));
})

it('Should complete the client lifecycle without error', done => {
setTimeout(() => {
client1.close();
client2.close();
done()
}, 500);
});
});