Refactor channel pool

2 files changed, 130 insertions, 128 deletions

diff --git a/src/objective-c/tests/ChannelTests/ChannelPoolTest.m b/src/objective-c/tests/ChannelTests/ChannelPoolTest.m
index 5c3f0edba0..d684db545e 100644
--- a/src/objective-c/tests/ChannelTests/ChannelPoolTest.m
+++ b/src/objective-c/tests/ChannelTests/ChannelPoolTest.m
@@ -20,6 +20,7 @@
 
 #import "../../GRPCClient/private/GRPCChannel.h"
 #import "../../GRPCClient/private/GRPCChannelPool.h"
+#import "../../GRPCClient/private/GRPCCompletionQueue.h"
 
 #define TEST_TIMEOUT 32
 
@@ -35,92 +36,104 @@ NSString *kDummyHost = @"dummy.host";
   grpc_init();
 }
 
-- (void)testCreateChannel {
+- (void)testChannelPooling {
   NSString *kDummyHost = @"dummy.host";
+  NSString *kDummyHost2 = @"dummy.host2";
+
   GRPCMutableCallOptions *options1 = [[GRPCMutableCallOptions alloc] init];
-  options1.transportType = GRPCTransportTypeInsecure;
   GRPCCallOptions *options2 = [options1 copy];
-  GRPCChannelConfiguration *config1 =
-      [[GRPCChannelConfiguration alloc] initWithHost:kDummyHost callOptions:options1];
-  GRPCChannelConfiguration *config2 =
-      [[GRPCChannelConfiguration alloc] initWithHost:kDummyHost callOptions:options2];
-  GRPCChannelPool *pool = [[GRPCChannelPool alloc] init];
-
-  GRPCChannel *channel1 = [pool channelWithConfiguration:config1];
-  GRPCChannel *channel2 = [pool channelWithConfiguration:config2];
+  GRPCMutableCallOptions *options3 = [options2 mutableCopy];
+  options3.transportType = GRPCTransportTypeInsecure;
+
+  GRPCChannelPool *pool = [GRPCChannelPool sharedInstance];
+
+  GRPCChannel *channel1 = [pool channelWithHost:kDummyHost
+                                    callOptions:options1];
+  GRPCChannel *channel2 = [pool channelWithHost:kDummyHost
+                                    callOptions:options2];
+  GRPCChannel *channel3 = [pool channelWithHost:kDummyHost2
+                                    callOptions:options1];
+  GRPCChannel *channel4 = [pool channelWithHost:kDummyHost
+                                    callOptions:options3];
   XCTAssertEqual(channel1, channel2);
+  XCTAssertNotEqual(channel1, channel3);
+  XCTAssertNotEqual(channel1, channel4);
+  XCTAssertNotEqual(channel3, channel4);
 }
 
-- (void)testChannelRemove {
-  GRPCMutableCallOptions *options1 = [[GRPCMutableCallOptions alloc] init];
-  options1.transportType = GRPCTransportTypeInsecure;
-  GRPCChannelConfiguration *config1 =
-      [[GRPCChannelConfiguration alloc] initWithHost:kDummyHost callOptions:options1];
-  GRPCChannelPool *pool = [[GRPCChannelPool alloc] init];
-  GRPCChannel *channel1 = [pool channelWithConfiguration:config1];
-  [pool removeChannel:channel1];
-  GRPCChannel *channel2 = [pool channelWithConfiguration:config1];
-  XCTAssertNotEqual(channel1, channel2);
-}
-
-extern NSTimeInterval kChannelDestroyDelay;
+- (void)testDestroyAllChannels {
+  NSString *kDummyHost = @"dummy.host";
 
-- (void)testChannelTimeoutCancel {
-  NSTimeInterval kOriginalInterval = kChannelDestroyDelay;
-  kChannelDestroyDelay = 3.0;
-  GRPCMutableCallOptions *options1 = [[GRPCMutableCallOptions alloc] init];
-  options1.transportType = GRPCTransportTypeInsecure;
-  GRPCChannelConfiguration *config1 =
-      [[GRPCChannelConfiguration alloc] initWithHost:kDummyHost callOptions:options1];
-  GRPCChannelPool *pool = [[GRPCChannelPool alloc] init];
-  GRPCChannel *channel1 = [pool channelWithConfiguration:config1];
-  [channel1 unref];
-  sleep(1);
-  GRPCChannel *channel2 = [pool channelWithConfiguration:config1];
-  XCTAssertEqual(channel1, channel2);
-  sleep((int)kChannelDestroyDelay + 2);
-  GRPCChannel *channel3 = [pool channelWithConfiguration:config1];
-  XCTAssertEqual(channel1, channel3);
-  kChannelDestroyDelay = kOriginalInterval;
+  GRPCMutableCallOptions *options = [[GRPCMutableCallOptions alloc] init];
+  GRPCChannelPool *pool = [GRPCChannelPool sharedInstance];
+  GRPCChannel *channel = [pool channelWithHost:kDummyHost
+                                   callOptions:options];
+  grpc_call *call = [channel unmanagedCallWithPath:@"dummy.path"
+                                   completionQueue:[GRPCCompletionQueue completionQueue]
+                                       callOptions:options
+                                      disconnected:nil];
+  [pool destroyAllChannels];
+  XCTAssertTrue(channel.disconnected);
+  GRPCChannel *channel2 = [pool channelWithHost:kDummyHost
+                                    callOptions:options];
+  XCTAssertNotEqual(channel, channel2);
+  grpc_call_unref(call);
 }
 
-- (void)testChannelDisconnect {
+- (void)testGetChannelBeforeChannelTimedDisconnection {
   NSString *kDummyHost = @"dummy.host";
-  GRPCMutableCallOptions *options1 = [[GRPCMutableCallOptions alloc] init];
-  options1.transportType = GRPCTransportTypeInsecure;
-  GRPCCallOptions *options2 = [options1 copy];
-  GRPCChannelConfiguration *config1 =
-      [[GRPCChannelConfiguration alloc] initWithHost:kDummyHost callOptions:options1];
-  GRPCChannelConfiguration *config2 =
-      [[GRPCChannelConfiguration alloc] initWithHost:kDummyHost callOptions:options2];
-  GRPCChannelPool *pool = [[GRPCChannelPool alloc] init];
-
-  GRPCChannel *channel1 = [pool channelWithConfiguration:config1];
-  [pool removeAndCloseAllChannels];
-  GRPCChannel *channel2 = [pool channelWithConfiguration:config2];
-  XCTAssertNotEqual(channel1, channel2);
+  const NSTimeInterval kDestroyDelay = 1;
+
+  GRPCMutableCallOptions *options = [[GRPCMutableCallOptions alloc] init];
+  GRPCChannelPool *pool = [GRPCChannelPool sharedInstance];
+  GRPCChannel *channel = [pool channelWithHost:kDummyHost
+                                   callOptions:options
+                                  destroyDelay:kDestroyDelay];
+  grpc_call *call = [channel unmanagedCallWithPath:@"dummy.path"
+                                   completionQueue:[GRPCCompletionQueue completionQueue]
+                                       callOptions:options
+                                      disconnected:nil];
+  grpc_call_unref(call);
+  [channel unref];
+
+  // Test that we can still get the channel at this time
+  GRPCChannel *channel2 = [pool channelWithHost:kDummyHost
+                                    callOptions:options
+                                   destroyDelay:kDestroyDelay];
+  XCTAssertEqual(channel, channel2);
+  call = [channel2 unmanagedCallWithPath:@"dummy.path"
+                         completionQueue:[GRPCCompletionQueue completionQueue]
+                             callOptions:options
+                            disconnected:nil];
+
+  // Test that after the destroy delay, the channel is still alive
+  sleep(kDestroyDelay + 1);
+  XCTAssertFalse(channel.disconnected);
 }
 
-- (void)testClearChannels {
-  GRPCMutableCallOptions *options1 = [[GRPCMutableCallOptions alloc] init];
-  options1.transportType = GRPCTransportTypeInsecure;
-  GRPCMutableCallOptions *options2 = [[GRPCMutableCallOptions alloc] init];
-  options2.transportType = GRPCTransportTypeChttp2BoringSSL;
-  GRPCChannelConfiguration *config1 =
-      [[GRPCChannelConfiguration alloc] initWithHost:kDummyHost callOptions:options1];
-  GRPCChannelConfiguration *config2 =
-      [[GRPCChannelConfiguration alloc] initWithHost:kDummyHost callOptions:options2];
-  GRPCChannelPool *pool = [[GRPCChannelPool alloc] init];
-
-  GRPCChannel *channel1 = [pool channelWithConfiguration:config1];
-  GRPCChannel *channel2 = [pool channelWithConfiguration:config2];
-  XCTAssertNotEqual(channel1, channel2);
-
-  [pool removeAndCloseAllChannels];
-  GRPCChannel *channel3 = [pool channelWithConfiguration:config1];
-  GRPCChannel *channel4 = [pool channelWithConfiguration:config2];
-  XCTAssertNotEqual(channel1, channel3);
-  XCTAssertNotEqual(channel2, channel4);
+- (void)testGetChannelAfterChannelTimedDisconnection {
+  NSString *kDummyHost = @"dummy.host";
+  const NSTimeInterval kDestroyDelay = 1;
+
+  GRPCMutableCallOptions *options = [[GRPCMutableCallOptions alloc] init];
+  GRPCChannelPool *pool = [GRPCChannelPool sharedInstance];
+  GRPCChannel *channel = [pool channelWithHost:kDummyHost
+                                   callOptions:options
+                                  destroyDelay:kDestroyDelay];
+  grpc_call *call = [channel unmanagedCallWithPath:@"dummy.path"
+                                   completionQueue:[GRPCCompletionQueue completionQueue]
+                                       callOptions:options
+                                      disconnected:nil];
+  grpc_call_unref(call);
+  [channel unref];
+
+  sleep(kDestroyDelay + 1);
+
+  // Test that we get new channel to the same host and with the same callOptions
+  GRPCChannel *channel2 = [pool channelWithHost:kDummyHost
+                                    callOptions:options
+                                   destroyDelay:kDestroyDelay];
+  XCTAssertNotEqual(channel, channel2);
 }
 
 @end
diff --git a/src/objective-c/tests/ChannelTests/ChannelTests.m b/src/objective-c/tests/ChannelTests/ChannelTests.m
index 64c3356b13..27e76d4179 100644
--- a/src/objective-c/tests/ChannelTests/ChannelTests.m
+++ b/src/objective-c/tests/ChannelTests/ChannelTests.m
@@ -20,6 +20,7 @@
 
 #import "../../GRPCClient/GRPCCallOptions.h"
 #import "../../GRPCClient/private/GRPCChannel.h"
+#import "../../GRPCClient/private/GRPCCompletionQueue.h"
 
 @interface ChannelTests : XCTestCase
 
@@ -31,63 +32,51 @@
   grpc_init();
 }
 
-- (void)testSameConfiguration {
-  NSString *host = @"grpc-test.sandbox.googleapis.com";
-  GRPCMutableCallOptions *options = [[GRPCMutableCallOptions alloc] init];
-  options.userAgentPrefix = @"TestUAPrefix";
-  NSMutableDictionary *args = [NSMutableDictionary new];
-  args[@"abc"] = @"xyz";
-  options.additionalChannelArgs = [args copy];
-  GRPCChannel *channel1 = [GRPCChannel channelWithHost:host callOptions:options];
-  GRPCChannel *channel2 = [GRPCChannel channelWithHost:host callOptions:options];
-  XCTAssertEqual(channel1, channel2);
-  GRPCMutableCallOptions *options2 = [options mutableCopy];
-  options2.additionalChannelArgs = [args copy];
-  GRPCChannel *channel3 = [GRPCChannel channelWithHost:host callOptions:options2];
-  XCTAssertEqual(channel1, channel3);
-}
+- (void)testTimedDisconnection {
+  NSString * const kHost = @"grpc-test.sandbox.googleapis.com";
+  const NSTimeInterval kDestroyDelay = 1;
+  GRPCCallOptions *options = [[GRPCCallOptions alloc] init];
+  GRPCChannelConfiguration *configuration = [[GRPCChannelConfiguration alloc] initWithHost:kHost callOptions:options];
+  GRPCChannel *channel = [[GRPCChannel alloc] initWithChannelConfiguration:configuration
+                                                              destroyDelay:kDestroyDelay];
+  BOOL disconnected;
+  grpc_call *call = [channel unmanagedCallWithPath:@"dummy.path"
+                                   completionQueue:[GRPCCompletionQueue completionQueue]
+                                       callOptions:options
+                                      disconnected:&disconnected];
+  XCTAssertFalse(disconnected);
+  grpc_call_unref(call);
+  [channel unref];
+  XCTAssertFalse(channel.disconnected, @"Channel is pre-maturely disconnected.");
+  sleep(kDestroyDelay + 1);
+  XCTAssertTrue(channel.disconnected, @"Channel is not disconnected after delay.");
 
-- (void)testDifferentHost {
-  NSString *host1 = @"grpc-test.sandbox.googleapis.com";
-  NSString *host2 = @"grpc-test2.sandbox.googleapis.com";
-  NSString *host3 = @"http://grpc-test.sandbox.googleapis.com";
-  NSString *host4 = @"dns://grpc-test.sandbox.googleapis.com";
-  NSString *host5 = @"grpc-test.sandbox.googleapis.com:80";
-  GRPCMutableCallOptions *options = [[GRPCMutableCallOptions alloc] init];
-  options.userAgentPrefix = @"TestUAPrefix";
-  NSMutableDictionary *args = [NSMutableDictionary new];
-  args[@"abc"] = @"xyz";
-  options.additionalChannelArgs = [args copy];
-  GRPCChannel *channel1 = [GRPCChannel channelWithHost:host1 callOptions:options];
-  GRPCChannel *channel2 = [GRPCChannel channelWithHost:host2 callOptions:options];
-  GRPCChannel *channel3 = [GRPCChannel channelWithHost:host3 callOptions:options];
-  GRPCChannel *channel4 = [GRPCChannel channelWithHost:host4 callOptions:options];
-  GRPCChannel *channel5 = [GRPCChannel channelWithHost:host5 callOptions:options];
-  XCTAssertNotEqual(channel1, channel2);
-  XCTAssertNotEqual(channel1, channel3);
-  XCTAssertNotEqual(channel1, channel4);
-  XCTAssertNotEqual(channel1, channel5);
+  // Check another call creation returns null and indicates disconnected.
+  call = [channel unmanagedCallWithPath:@"dummy.path"
+                        completionQueue:[GRPCCompletionQueue completionQueue]
+                            callOptions:options
+                           disconnected:&disconnected];
+  XCTAssert(call == NULL);
+  XCTAssertTrue(disconnected);
 }
 
-- (void)testDifferentChannelParameters {
-  NSString *host = @"grpc-test.sandbox.googleapis.com";
-  GRPCMutableCallOptions *options1 = [[GRPCMutableCallOptions alloc] init];
-  options1.transportType = GRPCTransportTypeChttp2BoringSSL;
-  NSMutableDictionary *args = [NSMutableDictionary new];
-  args[@"abc"] = @"xyz";
-  options1.additionalChannelArgs = [args copy];
-  GRPCMutableCallOptions *options2 = [[GRPCMutableCallOptions alloc] init];
-  options2.transportType = GRPCTransportTypeInsecure;
-  options2.additionalChannelArgs = [args copy];
-  GRPCMutableCallOptions *options3 = [[GRPCMutableCallOptions alloc] init];
-  options3.transportType = GRPCTransportTypeChttp2BoringSSL;
-  args[@"def"] = @"uvw";
-  options3.additionalChannelArgs = [args copy];
-  GRPCChannel *channel1 = [GRPCChannel channelWithHost:host callOptions:options1];
-  GRPCChannel *channel2 = [GRPCChannel channelWithHost:host callOptions:options2];
-  GRPCChannel *channel3 = [GRPCChannel channelWithHost:host callOptions:options3];
-  XCTAssertNotEqual(channel1, channel2);
-  XCTAssertNotEqual(channel1, channel3);
+- (void)testForceDisconnection {
+  NSString * const kHost = @"grpc-test.sandbox.googleapis.com";
+  const NSTimeInterval kDestroyDelay = 1;
+  GRPCCallOptions *options = [[GRPCCallOptions alloc] init];
+  GRPCChannelConfiguration *configuration = [[GRPCChannelConfiguration alloc] initWithHost:kHost callOptions:options];
+  GRPCChannel *channel = [[GRPCChannel alloc] initWithChannelConfiguration:configuration
+                                                              destroyDelay:kDestroyDelay];
+  grpc_call *call = [channel unmanagedCallWithPath:@"dummy.path"
+                                   completionQueue:[GRPCCompletionQueue completionQueue]
+                                       callOptions:options
+                                      disconnected:nil];
+  grpc_call_unref(call);
+  [channel disconnect];
+  XCTAssertTrue(channel.disconnected, @"Channel is not disconnected.");
+
+  // Test calling another unref here will not crash
+  [channel unref];
 }
 
 @end