OWLS-19790: Too many open files on server startup

 - Fix + tests.

Updated Surefire plugin to 2.18.1 (2.17 -> 2.18.1)
Updated JMockit to 1.17 (1.14 -> 1.17)

Change-Id: Ic32a160167a91b25fa9272e802b560736fa4f40f
Signed-off-by: Michal Gajdos <[email protected]>

Author: Michal Gajdos

containers/jersey-servlet-core/src/main/java/org/glassfish/jersey/servlet/WebAppResourcesScanner.java

@@ -51,23 +51,23 @@
 import org.glassfish.jersey.server.internal.AbstractResourceFinderAdapter;
 import org.glassfish.jersey.server.internal.scanning.JarFileScanner;
 import org.glassfish.jersey.server.internal.scanning.ResourceFinderException;
-import org.glassfish.jersey.server.internal.scanning.ResourceFinderStack;
+import org.glassfish.jersey.server.internal.scanning.CompositeResourceFinder;
 
 /**
  * A scanner that recursively scans resources within a Web application.
  *
  * @author Paul Sandoz
  */
-class WebAppResourcesScanner extends AbstractResourceFinderAdapter {
+final class WebAppResourcesScanner extends AbstractResourceFinderAdapter {
+
+    private static final String[] paths = new String[] {"/WEB-INF/lib/", "/WEB-INF/classes/"};
 
-//    private final String[] paths;
     private final ServletContext sc;
-    private ResourceFinderStack resourceFinderStack = new ResourceFinderStack();
-    private static String[] paths = new String[]{"/WEB-INF/lib/", "/WEB-INF/classes/"};
+    private CompositeResourceFinder compositeResourceFinder = new CompositeResourceFinder();
 
     /**
      * Scan from a set of web resource paths.
-     * <p>
+     * <p/>
      *
      * @param sc {@link ServletContext}.
      */
@@ -77,26 +77,27 @@ class WebAppResourcesScanner extends AbstractResourceFinderAdapter {
         processPaths(paths);
     }
 
-    private void processPaths(String... paths) {
+    private void processPaths(final String... paths) {
         for (final String path : paths) {
 
             final Set<String> resourcePaths = sc.getResourcePaths(path);
             if (resourcePaths == null) {
                 break;
             }
 
-            resourceFinderStack.push(new AbstractResourceFinderAdapter() {
+            compositeResourceFinder.push(new AbstractResourceFinderAdapter() {
 
-                private Deque<String> resourcePathsStack = new LinkedList<String>() {
+                private final Deque<String> resourcePathsStack = new LinkedList<String>() {
 
                     private static final long serialVersionUID = 3109256773218160485L;
 
                     {
-                        for (String resourcePath : resourcePaths) {
+                        for (final String resourcePath : resourcePaths) {
                             push(resourcePath);
                         }
                     }
                 };
+
                 private String current;
                 private String next;
 
@@ -110,8 +111,8 @@ public boolean hasNext() {
                             next = null;
                         } else if (next.endsWith(".jar")) {
                             try {
-                                resourceFinderStack.push(new JarFileScanner(sc.getResourceAsStream(next), "", true));
-                            } catch (IOException ioe) {
+                                compositeResourceFinder.push(new JarFileScanner(sc.getResourceAsStream(next), "", true));
+                            } catch (final IOException ioe) {
                                 throw new ResourceFinderException(ioe);
                             }
                             next = null;
@@ -148,22 +149,27 @@ public void reset() {
 
     @Override
     public boolean hasNext() {
-        return resourceFinderStack.hasNext();
+        return compositeResourceFinder.hasNext();
     }
 
     @Override
     public String next() {
-        return resourceFinderStack.next();
+        return compositeResourceFinder.next();
     }
 
     @Override
     public InputStream open() {
-        return resourceFinderStack.open();
+        return compositeResourceFinder.open();
+    }
+
+    @Override
+    public void close() {
+        compositeResourceFinder.close();
     }
 
     @Override
     public void reset() {
-        resourceFinderStack = new ResourceFinderStack();
+        compositeResourceFinder = new CompositeResourceFinder();
         processPaths(paths);
     }
 }

core-server/pom.xml

@@ -155,9 +155,11 @@
                 <configuration>
                     <argLine>${surefire.security.argline}</argLine>
                     <!-- Execute test classes in parallel - 1 thread per CPU core. -->
-                    <parallel>classesAndMethods</parallel>
+                    <parallel>classes</parallel>
                     <perCoreThreadCount>true</perCoreThreadCount>
                     <threadCount>1</threadCount>
+                    <forkCount>1C</forkCount>
+                    <reuseForks>true</reuseForks>
                 </configuration>
             </plugin>
          </plugins>
@@ -222,6 +224,11 @@
             <scope>provided</scope>
         </dependency>
 
+        <dependency>
+            <groupId>org.jmockit</groupId>
+            <artifactId>jmockit</artifactId>
+            <scope>test</scope>
+        </dependency>
         <dependency>
             <groupId>junit</groupId>
             <artifactId>junit</artifactId>

core-server/src/main/java/org/glassfish/jersey/server/ResourceConfig.java

@@ -95,6 +95,8 @@ public class ResourceConfig extends Application implements Configurable<Resource
     private transient Set<Object> cachedSingletons = null;
     private transient Set<Object> cachedSingletonsView = null;
 
+    private transient boolean resetFinders = false;
+
     private volatile State state;
 
     private static class State extends CommonConfig implements ServerConfig {
@@ -609,6 +611,7 @@ public final ResourceConfig registerFinder(final ResourceFinder resourceFinder)
         if (resourceFinder == null) {
             return this;
         }
+        invalidateCache();
 
         this.state.registerFinder(resourceFinder);
         return this;
@@ -708,8 +711,11 @@ final void invalidateCache() {
         this.cachedSingletonsView = null;
 
         // Reset ResourceFinders to make sure the next package scanning is successful.
-        for (final ResourceFinder finder : this.state.resourceFinders) {
-            finder.reset();
+        if (resetFinders) {
+            for (final ResourceFinder finder : this.state.resourceFinders) {
+                finder.reset();
+            }
+            resetFinders = false;
         }
     }
 
@@ -864,6 +870,9 @@ private Set<Class<?>> scanClasses() {
         final ResourceConfig.State _state = state;
         final Set<ResourceFinder> rfs = Sets.newHashSet(_state.getResourceFinders());
 
+        // In case new entity is registered the available finders should be reset.
+        resetFinders = true;
+
         // classes registered via configuration property
         final String[] classNames = parsePropertyValue(ServerProperties.PROVIDER_CLASSNAMES);
         if (classNames != null) {

core-server/src/main/java/org/glassfish/jersey/server/ResourceFinder.java

@@ -1,7 +1,7 @@
 /*
  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
  *
- * Copyright (c) 2012 Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2012-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
@@ -44,31 +44,45 @@
 
 /**
  * An interface used for finding and opening (loading) new resources.
- *
+ * <p/>
  * {@link ResourceConfig} will use all registered finders to obtain classes
  * to be used as resource classes and/or providers. Method {@link #open()} doesn't
  * need to be called on all returned resource names, {@link ResourceConfig} can ignore
  * some of them.
- *
+ * <p/>
  * Currently, all resource names ending with ".class" will be accepted and processed (opened).
+ * <p/>
+ * Extends {@link AutoCloseable} since version 2.19. The {@link #close()} method is used to release
+ * allocated/opened resources (such as streams). When a resource finder is closed no other method should be
+ * invoked on it.
  *
  * @author Pavel Bucek (pavel.bucek at oracle.com)
  */
-public interface ResourceFinder extends Iterator<String> {
+public interface ResourceFinder extends Iterator<String>, AutoCloseable {
 
     /**
      * Open current resource.
      *
      * @return input stream from which current resource can be loaded.
      */
-    InputStream open();
+    public InputStream open();
+
+    /**
+     * {@inheritDoc}
+     * <p/>
+     * Release allocated/opened resources (such as streams). When the resource finder is closed
+     * no other method should be invoked on it.
+     *
+     * @since 2.19
+     */
+    public void close();
 
     /**
      * Reset the {@link ResourceFinder} instance.
      * <p/>
      * Upon calling this method the implementing class MUST reset its internal state to the initial state.
      */
-    void reset();
+    public void reset();
 
     /**
      * {@inheritDoc}
@@ -77,5 +91,5 @@ public interface ResourceFinder extends Iterator<String> {
      * when invoked.
      */
     @Override
-    void remove();
+    public void remove();
 }

core-server/src/main/java/org/glassfish/jersey/server/internal/AbstractResourceFinderAdapter.java

@@ -50,10 +50,18 @@
 public abstract class AbstractResourceFinderAdapter implements ResourceFinder {
 
     /**
-     * Default implementation of {@link #remove()} which complies with the defined contract.
+     * Default implementation of {@code #remove()} which complies with the defined contract.
      */
     @Override
     public void remove() {
         throw new UnsupportedOperationException();
     }
+
+    /**
+     * Default implementation of {@code #close()} which does nothing.
+     */
+    @Override
+    public void close() {
+        // NO-OP.
+    }
 }

core-server/src/main/java/org/glassfish/jersey/server/internal/scanning/BundleSchemeResourceFinderFactory.java

@@ -42,8 +42,7 @@
 import java.io.IOException;
 import java.io.InputStream;
 import java.net.URI;
-import java.util.Arrays;
-import java.util.HashSet;
+import java.util.Collections;
 import java.util.NoSuchElementException;
 import java.util.Set;
 
@@ -54,11 +53,13 @@
  *
  * @author Jakub Podlesak (jakub.podlesak at oracle.com)
  */
-class BundleSchemeResourceFinderFactory implements UriSchemeResourceFinderFactory {
+final class BundleSchemeResourceFinderFactory implements UriSchemeResourceFinderFactory {
+
+    private static final Set<String> SCHEMES = Collections.singleton("bundle");
 
     @Override
     public Set<String> getSchemes() {
-        return new HashSet<>(Arrays.asList("bundle"));
+        return SCHEMES;
     }
 
     /**
@@ -68,17 +69,17 @@ public Set<String> getSchemes() {
     }
 
     @Override
-    public BundleSchemeScanner create(URI uri, boolean recursive) {
+    public BundleSchemeScanner create(final URI uri, final boolean recursive) {
         return new BundleSchemeScanner(uri);
     }
 
     private class BundleSchemeScanner extends AbstractResourceFinderAdapter {
 
-        private BundleSchemeScanner(URI uri) {
+        private BundleSchemeScanner(final URI uri) {
             this.uri = uri;
         }
 
-        private URI uri;
+        private final URI uri;
 
         /**
          * Marks this iterator as iterated after execution of {@link #open()} method.
@@ -113,7 +114,7 @@ public InputStream open() {
                 try {
                     accessed = true;
                     return uri.toURL().openStream();
-                } catch (IOException e) {
+                } catch (final IOException e) {
                     throw new ResourceFinderException(e);
                 }
             }

core-server/src/main/java/org/glassfish/jersey/server/internal/scanning/ResourceFinderStack.java renamed to core-server/src/main/java/org/glassfish/jersey/server/internal/scanning/CompositeResourceFinder.java

@@ -44,20 +44,25 @@
 import java.util.LinkedList;
 import java.util.NoSuchElementException;
 import java.util.Stack;
+import java.util.logging.Level;
+import java.util.logging.Logger;
 
-import org.glassfish.jersey.server.internal.AbstractResourceFinderAdapter;
 import org.glassfish.jersey.server.ResourceFinder;
+import org.glassfish.jersey.server.internal.AbstractResourceFinderAdapter;
+import org.glassfish.jersey.server.internal.LocalizationMessages;
 
 /**
  * {@link Stack} of {@link ResourceFinder} instances.
- *
+ * <p/>
  * Used to combine various finders into one instance.
  *
  * @author Pavel Bucek (pavel.bucek at oracle.com)
  */
-public class ResourceFinderStack extends AbstractResourceFinderAdapter {
+public final class CompositeResourceFinder extends AbstractResourceFinderAdapter {
 
-    private final Deque<ResourceFinder> stack = new LinkedList<ResourceFinder>();
+    private static final Logger LOGGER = Logger.getLogger(CompositeResourceFinder.class.getName());
+
+    private final Deque<ResourceFinder> stack = new LinkedList<>();
     private ResourceFinder current = null;
 
     @Override
@@ -96,12 +101,29 @@ public InputStream open() {
         return current.open();
     }
 
-    public void push(ResourceFinder iterator) {
-        stack.push(iterator);
+    @Override
+    public void close() {
+        if (current != null) {
+            // Insert the currently processed resource finder at the top of the stack.
+            stack.addFirst(current);
+            current = null;
+        }
+        for (final ResourceFinder finder : stack) {
+            try {
+                finder.close();
+            } catch (final RuntimeException e) {
+                LOGGER.log(Level.CONFIG, LocalizationMessages.ERROR_CLOSING_FINDER(finder.getClass()), e);
+            }
+        }
+        stack.clear();
     }
 
     @Override
     public void reset() {
         throw new UnsupportedOperationException();
     }
+
+    public void push(final ResourceFinder iterator) {
+        stack.push(iterator);
+    }
 }