JERSEY-2969: Client#close() not shutting down Async Executor

Change-Id: Ic49977db09f393509befcb8bf7c10c994c2f1911

Author: Petr Janouch

core-client/src/main/java/org/glassfish/jersey/client/ClientBinder.java

@@ -148,6 +148,9 @@ protected void configure() {
         // Default async request executors support
         int asyncThreadPoolSize = ClientProperties.getValue(clientRuntimeProperties, ClientProperties.ASYNC_THREADPOOL_SIZE, 0);
         asyncThreadPoolSize = (asyncThreadPoolSize < 0) ? 0 : asyncThreadPoolSize;
-        bind(new DefaultClientAsyncExecutorProvider(asyncThreadPoolSize)).to(ExecutorServiceProvider.class);
+        // a constructor parameter injected into DefaultClientAsyncExecutorProvider
+        bind(asyncThreadPoolSize).named("ClientAsyncThreadPoolSize");
+        // DefaultClientAsyncExecutorProvider must be singleton scoped, so that @PreDestroy, which closes the executor, is called
+        bind(DefaultClientAsyncExecutorProvider.class).to(ExecutorServiceProvider.class).in(Singleton.class);
     }
 }

core-client/src/main/java/org/glassfish/jersey/client/DefaultClientAsyncExecutorProvider.java

@@ -42,6 +42,9 @@
 
 import java.util.logging.Logger;
 
+import javax.inject.Inject;
+import javax.inject.Named;
+
 import org.glassfish.jersey.client.internal.LocalizationMessages;
 import org.glassfish.jersey.internal.util.collection.LazyValue;
 import org.glassfish.jersey.internal.util.collection.Value;
@@ -66,7 +69,8 @@ class DefaultClientAsyncExecutorProvider extends ThreadPoolExecutorProvider {
      * @param poolSize size of the default executor thread pool (if used). Zero or negative values are ignored.
      *                 See also {@link org.glassfish.jersey.client.ClientProperties#ASYNC_THREADPOOL_SIZE}.
      */
-    public DefaultClientAsyncExecutorProvider(final int poolSize) {
+    @Inject
+    public DefaultClientAsyncExecutorProvider(@Named("ClientAsyncThreadPoolSize") final int poolSize) {
         super("jersey-client-async-executor");
 
         this.asyncThreadPoolSize = Values.lazy(new Value<Integer>() {

tests/e2e/src/test/java/org/glassfish/jersey/tests/e2e/client/ClientExecutorCloseTest.java

@@ -0,0 +1,90 @@
+/*
+ * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
+ *
+ * Copyright (c) 2015 Oracle and/or its affiliates. All rights reserved.
+ *
+ * The contents of this file are subject to the terms of either the GNU
+ * General Public License Version 2 only ("GPL") or the Common Development
+ * and Distribution License("CDDL") (collectively, the "License").  You
+ * may not use this file except in compliance with the License.  You can
+ * obtain a copy of the License at
+ * http://glassfish.java.net/public/CDDL+GPL_1_1.html
+ * or packager/legal/LICENSE.txt.  See the License for the specific
+ * language governing permissions and limitations under the License.
+ *
+ * When distributing the software, include this License Header Notice in each
+ * file and include the License file at packager/legal/LICENSE.txt.
+ *
+ * GPL Classpath Exception:
+ * Oracle designates this particular file as subject to the "Classpath"
+ * exception as provided by Oracle in the GPL Version 2 section of the License
+ * file that accompanied this code.
+ *
+ * Modifications:
+ * If applicable, add the following below the License Header, with the fields
+ * enclosed by brackets [] replaced by your own identifying information:
+ * "Portions Copyright [year] [name of copyright owner]"
+ *
+ * Contributor(s):
+ * If you wish your version of this file to be governed by only the CDDL or
+ * only the GPL Version 2, indicate your decision by adding "[Contributor]
+ * elects to include this software in this distribution under the [CDDL or GPL
+ * Version 2] license."  If you don't indicate a single choice of license, a
+ * recipient has the option to distribute your version of this file under
+ * either the CDDL, the GPL Version 2 or to extend the choice of license to
+ * its licensees as provided above.  However, if you add GPL Version 2 code
+ * and therefore, elected the GPL Version 2 license, then the option applies
+ * only if the new code is made subject to such option by the copyright
+ * holder.
+ */
+package org.glassfish.jersey.tests.e2e.client;
+
+import java.util.Set;
+
+import javax.ws.rs.GET;
+import javax.ws.rs.Path;
+import javax.ws.rs.core.Application;
+
+import org.glassfish.jersey.server.ResourceConfig;
+import org.glassfish.jersey.test.JerseyTest;
+
+import org.junit.Test;
+import static org.junit.Assert.assertFalse;
+import static org.junit.Assert.assertTrue;
+
+/**
+ * @author Petr Janouch (petr.janouch at oracle.com)
+ */
+public class ClientExecutorCloseTest extends JerseyTest {
+
+    /**
+     * Tests that closing a client shuts down a corresponding client async executor service.
+     */
+    @Test
+    public void testCloseAsyncExecutor() {
+        assertFalse(clientExecutorThreadPresent());
+        target("resource").request().async().get();
+        assertTrue(clientExecutorThreadPresent());
+        client().close();
+        assertFalse(clientExecutorThreadPresent());
+    }
+
+    private boolean clientExecutorThreadPresent() {
+        Set<Thread> threads = Thread.getAllStackTraces().keySet();
+        return threads.stream().map(Thread::getName).anyMatch(name -> name.contains("jersey-client-async-executor"));
+    }
+
+    @Override
+    protected Application configure() {
+        return new ResourceConfig(Resource.class);
+    }
+
+    @Path("resource")
+    public static class Resource {
+
+        @GET
+        public String getHello() {
+            return "Hello";
+        }
+    }
+}