30315 memory leak weak hashmap keys

dev/com.ibm.websphere.appserver.features/visibility/private/com.ibm.websphere.appserver.anno-1.0.feature

@@ -19,7 +19,7 @@ IBM-Process-Types: server, \
   com.ibm.websphere.appserver.artifact-1.0
 -bundles=com.ibm.ws.anno
 -jars=com.ibm.websphere.appserver.spi.anno; location:=dev/spi/ibm/
--files=dev/spi/ibm/javadoc/com.ibm.websphere.appserver.spi.anno_1.1-javadoc.zip
+-files=dev/spi/ibm/javadoc/com.ibm.websphere.appserver.spi.anno_1.2-javadoc.zip
 kind=ga
 edition=core
 WLP-Activation-Type: parallel

dev/com.ibm.websphere.appserver.spi.anno/bnd.bnd

@@ -11,7 +11,7 @@
 #     IBM Corporation - initial API and implementation
 #*******************************************************************************
 -include= ~../cnf/resources/bnd/bundle.props
-bVersion: 1.1
+bVersion: 1.2
 
 Bundle-Name: WebSphere Annotations SPI
 Bundle-Description: WebSphere Annotations SPI, version ${bVersion}

dev/com.ibm.websphere.appserver.spi.anno/com.ibm.websphere.appserver.spi.anno.pom

@@ -27,5 +27,5 @@
   <artifactId>com.ibm.websphere.appserver.spi.anno</artifactId>
   <version>${bFullVersion}</version>
   <name>WebSphere Annotations SPI</name>
-  <description>WebSphere Annotations SPI, version 1.1</description>
+  <description>WebSphere Annotations SPI, version 1.2</description>
 </project>

dev/com.ibm.ws.anno/src/com/ibm/ws/annocache/classsource/internal/ClassSourceImpl_Aggregate.java

@@ -1,5 +1,5 @@
 /*******************************************************************************
- * Copyright (c) 2011, 2019 IBM Corporation and others.
+ * Copyright (c) 2011, 2024 IBM Corporation and others.
  * All rights reserved. This program and the accompanying materials
  * are made available under the terms of the Eclipse Public License 2.0
  * which accompanies this distribution, and is available at
@@ -16,6 +16,7 @@
 import java.io.BufferedInputStream;
 import java.io.IOException;
 import java.io.InputStream;
+import java.lang.ref.WeakReference;
 import java.text.MessageFormat;
 import java.util.ArrayList;
 import java.util.HashMap;
@@ -25,7 +26,6 @@
 import java.util.Map;
 import java.util.Set;
 import java.util.logging.Level;
-
 import java.util.logging.Logger;
 
 import com.ibm.websphere.ras.Tr;
@@ -34,6 +34,7 @@
 import com.ibm.ws.annocache.service.internal.AnnotationCacheServiceImpl_Logging;
 import com.ibm.wsspi.anno.classsource.ClassSource_ScanCounts;
 import com.ibm.wsspi.anno.classsource.ClassSource_ScanCounts.ResultField;
+import com.ibm.wsspi.anno.service.AppKey;
 import com.ibm.wsspi.anno.classsource.ClassSource_Streamer;
 import com.ibm.wsspi.annocache.classsource.ClassSource;
 import com.ibm.wsspi.annocache.classsource.ClassSource_Aggregate;
@@ -81,11 +82,11 @@ public String toString() {
     //
 
     // Top O' the world
-
+    
     public ClassSourceImpl_Aggregate(
         ClassSourceImpl_Factory factory,
         Util_InternMap internMap,
-        String applicationName, String moduleName, String moduleCategoryName,
+        String applicationName, AppKey appKey, String moduleName, String moduleCategoryName,
         ClassSource_Options options) {
 
         String methodName = "<init>";
@@ -99,6 +100,7 @@ public ClassSourceImpl_Aggregate(
         this.applicationName = applicationName;
         this.moduleName = moduleName;
         this.moduleCategoryName = moduleCategoryName;
+        this.applicationKey = new WeakReference<AppKey>(appKey);
 
         //
 
@@ -180,6 +182,7 @@ protected String internClassName(String className, boolean doForce) {
     protected final String applicationName;
     protected final String moduleName;
     protected final String moduleCategoryName;
+    protected final WeakReference<AppKey> applicationKey;
 
     /**
      * <p>Answer the name of the application of this class source.</p>
@@ -191,6 +194,17 @@ protected String internClassName(String className, boolean doForce) {
     public String getApplicationName() {
         return applicationName;
     }
+
+    /**
+     * <p>Answer the name of the application of this class source.</p>
+     *
+     * @return The name of the application of this class source.
+     */
+    @Override
+    @Trivial
+    public AppKey getApplicationKey() {
+        return applicationKey.get();
+    }
 
     /**
      * <p>Answer the name of the module of this class source.</p>

dev/com.ibm.ws.anno/src/com/ibm/ws/annocache/classsource/internal/ClassSourceImpl_Factory.java

@@ -1,5 +1,5 @@
 /*******************************************************************************
- * Copyright (c) 2017, 2020 IBM Corporation and others.
+ * Copyright (c) 2017, 2024 IBM Corporation and others.
  * All rights reserved. This program and the accompanying materials
  * are made available under the terms of the Eclipse Public License 2.0
  * which accompanies this distribution, and is available at
@@ -13,6 +13,8 @@
 
 package com.ibm.ws.annocache.classsource.internal;
 
+import java.util.HashMap;
+import java.util.Map;
 import java.util.logging.Level;
 import java.util.logging.Logger;
 
@@ -39,14 +41,14 @@
 import com.ibm.wsspi.anno.classsource.ClassSource_MappedDirectory;
 import com.ibm.wsspi.anno.classsource.ClassSource_MappedJar;
 import com.ibm.wsspi.anno.classsource.ClassSource_MappedSimple.SimpleClassProvider;
+import com.ibm.wsspi.anno.service.AppKey;
 import com.ibm.wsspi.annocache.classsource.ClassSource_Aggregate;
 import com.ibm.wsspi.annocache.classsource.ClassSource_Aggregate.ScanPolicy;
 import com.ibm.wsspi.annocache.classsource.ClassSource_ClassLoader;
 import com.ibm.wsspi.annocache.classsource.ClassSource_Exception;
 import com.ibm.wsspi.annocache.classsource.ClassSource_Factory;
 import com.ibm.wsspi.annocache.classsource.ClassSource_MappedSimple;
 import com.ibm.wsspi.annocache.classsource.ClassSource_Options;
-import com.ibm.wsspi.annocache.service.AnnotationCacheService_Service;
 import com.ibm.wsspi.annocache.util.Util_Factory;
 import com.ibm.wsspi.annocache.util.Util_InternMap;
 import com.ibm.wsspi.annocache.util.Util_RelativePath;
@@ -166,13 +168,13 @@ public String getCanonicalName(String classSourceName) {
     @Override
     @Trivial
     public ClassSourceImpl_Aggregate createAggregateClassSource(
-        String appName, String modName, String modCategoryName,
+        String appName, AppKey appKey, String modName, String modCategoryName,
         ClassSource_Options options) throws ClassSource_Exception {
 
         Util_InternMap classInternMap =
             getUtilFactory().createInternMap(Util_InternMap.ValueType.VT_CLASS_NAME, "classes and packages");
 
-        return createAggregateClassSource(classInternMap, appName, modName, modCategoryName, options);
+        return createAggregateClassSource(classInternMap, appName, appKey, modName, modCategoryName, options);
         // throws ClassSource_Exception
     }
 
@@ -283,10 +285,10 @@ public ClassSourceImpl_ClassLoader createClassLoaderClassSource(
     @Override
     public ClassSourceImpl_Aggregate createAggregateClassSource(
         Util_InternMap internMap,
-        String appName, String modName, String modCategoryName,
+        String appName, AppKey appKey, String modName, String modCategoryName,
         ClassSource_Options options) throws ClassSource_Exception {
 
-        return new ClassSourceImpl_Aggregate(this, internMap, appName, modName, modCategoryName, options);
+        return new ClassSourceImpl_Aggregate(this, internMap, appName, appKey, modName, modCategoryName, options);
     }
 
     @Override
@@ -524,4 +526,27 @@ public ClassSource_Specification_Container_EJB newEJBContainerSpecification() {
     public ClassSource_Specification_Container_WAR newWARContainerSpecification() {
         return null;
     }
+
+    //Leaky keys will only be used if someone calls the old deprecated interface that does not take an AppKey as an argument.
+    //No IBM code does so. And if an external SPI user does so, I think it is better to avoid the risk that their code depended 
+    //on the WeakHashMap we uses these app keys for never being cleaned out. Then avoid a memory leak that is relatively minor. 
+    @Deprecated
+    private static final Map<String, AppKey> MEMORY_LEAKY_KEYS = new HashMap<String,AppKey>();
+
+    @Override
+    @Deprecated
+    public ClassSource_Aggregate createAggregateClassSource(String appName, String modName, String modNameCategory, ClassSource_Options options) throws ClassSource_Exception {
+        MEMORY_LEAKY_KEYS.computeIfAbsent(appName, AppKey::new);
+        return createAggregateClassSource(appName, MEMORY_LEAKY_KEYS.get(appName), modName, 
+                                                         modNameCategory, options);
+    }
+
+    @Override
+    @Deprecated
+    public ClassSource_Aggregate createAggregateClassSource(Util_InternMap internMap, String appName, String modName, String modNameCategory,
+                                                            ClassSource_Options options) throws ClassSource_Exception {
+        MEMORY_LEAKY_KEYS.computeIfAbsent(appName, AppKey::new);
+        return  createAggregateClassSource(internMap, appName, MEMORY_LEAKY_KEYS.get(appName), modName,
+                                           modNameCategory, options);
+    }
 }

dev/com.ibm.ws.anno/src/com/ibm/ws/annocache/classsource/specification/internal/ClassSourceImpl_Specification.java

@@ -1,5 +1,5 @@
 /*******************************************************************************
- * Copyright (c) 2017, 2019 IBM Corporation and others.
+ * Copyright (c) 2017, 2024 IBM Corporation and others.
  * All rights reserved. This program and the accompanying materials
  * are made available under the terms of the Eclipse Public License 2.0
  * which accompanies this distribution, and is available at
@@ -12,23 +12,24 @@
  *******************************************************************************/
 package com.ibm.ws.annocache.classsource.specification.internal;
 
+import java.util.HashMap;
+import java.util.Map;
 import java.util.logging.Level;
 import java.util.logging.Logger;
 
 import com.ibm.websphere.ras.annotation.Trivial;
-
-import com.ibm.wsspi.annocache.classsource.ClassSource_Exception;
-import com.ibm.wsspi.annocache.classsource.ClassSource_Options;
-import com.ibm.wsspi.annocache.classsource.ClassSource_Aggregate;
-import com.ibm.wsspi.annocache.classsource.ClassSource_Aggregate.ScanPolicy;
-
 import com.ibm.ws.annocache.classsource.internal.ClassSourceImpl_Aggregate;
 import com.ibm.ws.annocache.classsource.internal.ClassSourceImpl_ClassLoader;
 import com.ibm.ws.annocache.classsource.internal.ClassSourceImpl_Factory;
 import com.ibm.ws.annocache.classsource.internal.ClassSourceImpl_MappedDirectory;
 import com.ibm.ws.annocache.classsource.internal.ClassSourceImpl_MappedJar;
 import com.ibm.ws.annocache.classsource.specification.ClassSource_Specification;
 import com.ibm.ws.annocache.service.internal.AnnotationCacheServiceImpl_Logging;
+import com.ibm.wsspi.anno.service.AppKey;
+import com.ibm.wsspi.annocache.classsource.ClassSource_Aggregate;
+import com.ibm.wsspi.annocache.classsource.ClassSource_Aggregate.ScanPolicy;
+import com.ibm.wsspi.annocache.classsource.ClassSource_Exception;
+import com.ibm.wsspi.annocache.classsource.ClassSource_Options;
 
 
 public abstract class ClassSourceImpl_Specification implements ClassSource_Specification {
@@ -128,13 +129,17 @@ public ClassSourceImpl_Aggregate createRootClassSource(ClassSource_Options class
     }
 
     //
-
+
+    //This is only called from a unit test where a memory leak is no issue but an early GC could cause a test fail
+    private static final Map<String, AppKey> UNIT_TEST_MEMORY_LEAKY_KEYS = new HashMap<String,AppKey>();
+
     @Override
     public ClassSourceImpl_Aggregate createEmptyRootClassSource(ClassSource_Options classSourceOptions)
         throws ClassSource_Exception {
 
-        return getFactory().createAggregateClassSource(
-        	getAppName(), getModName(), getModCategoryName(),
+        UNIT_TEST_MEMORY_LEAKY_KEYS.computeIfAbsent(appName, AppKey::new);
+        return getFactory().createAggregateClassSource(                
+        	getAppName(), UNIT_TEST_MEMORY_LEAKY_KEYS.get(appName), getModName(), getModCategoryName(),
         	classSourceOptions );
     }
 

dev/com.ibm.ws.anno/src/com/ibm/ws/annocache/targets/cache/internal/TargetCacheImpl_DataApps.java

@@ -1,5 +1,5 @@
 /*******************************************************************************
- * Copyright (c) 2017, 2019 IBM Corporation and others.
+ * Copyright (c) 2017, 2024 IBM Corporation and others.
  * All rights reserved. This program and the accompanying materials
  * are made available under the terms of the Eclipse Public License 2.0
  * which accompanies this distribution, and is available at
@@ -16,8 +16,10 @@
 import java.util.WeakHashMap;
 
 import com.ibm.websphere.ras.annotation.Trivial;
+import com.ibm.wsspi.anno.service.AppKey;
 import com.ibm.wsspi.annocache.classsource.ClassSource_Factory;
 import com.ibm.wsspi.annocache.targets.cache.TargetCache_ExternalConstants;
+import com.ibm.wsspi.annocache.targets.cache.TargetCache_Options;
 
 /**
  * Root of annotation caching data.
@@ -74,7 +76,7 @@ public TargetCacheImpl_DataApps(
                new File( factory.getCacheOptions().getDir() ) );
 
         this.appsLock = new AppsLock();
-        this.apps = new WeakHashMap<String, TargetCacheImpl_DataApp>();
+        this.apps = new WeakHashMap<AppKey, TargetCacheImpl_DataApp>();
 
         this.queriesLock = new QueriesLock();
         this.queries = new WeakHashMap<String, TargetCacheImpl_DataQueries>();
@@ -152,7 +154,7 @@ private class AppsLock {
         // EMPTY
     }
     private final AppsLock appsLock;
-    private final WeakHashMap<String, TargetCacheImpl_DataApp> apps;
+    private final WeakHashMap<AppKey, TargetCacheImpl_DataApp> apps;
 
     /**
      * Obtain cache data for an application.
@@ -166,17 +168,17 @@ private class AppsLock {
      *
      * @return Cache data for the application.
      */
-    public TargetCacheImpl_DataApp getAppForcing(String appName) {
+    public TargetCacheImpl_DataApp getAppForcing(String appName, AppKey appKey) {
         // Unnamed applications always create new data.
         if ( appName == ClassSource_Factory.UNNAMED_APP ) {
             return createAppData(appName);
         }
 
         synchronized( appsLock ) {
-            TargetCacheImpl_DataApp app = apps.get(appName);
+            TargetCacheImpl_DataApp app = apps.get(appKey);
             if ( app == null ) {
                 app = createAppData(appName);
-                apps.put(appName, app);
+                apps.put(appKey, app);
             }
             return app;
         }

dev/com.ibm.ws.anno/src/com/ibm/ws/annocache/targets/internal/AnnotationTargetsImpl_Targets.java

@@ -1,5 +1,5 @@
 /*******************************************************************************
- * Copyright (c) 2011, 2020 IBM Corporation and others.
+ * Copyright (c) 2011, 2024 IBM Corporation and others.
  * All rights reserved. This program and the accompanying materials
  * are made available under the terms of the Eclipse Public License 2.0
  * which accompanies this distribution, and is available at
@@ -12,6 +12,7 @@
  *******************************************************************************/
 package com.ibm.ws.annocache.targets.internal;
 
+import java.lang.ref.WeakReference;
 import java.util.ArrayList;
 import java.util.Collection;
 import java.util.Collections;
@@ -39,6 +40,7 @@
 import com.ibm.ws.annocache.util.internal.UtilImpl_NonInternSet;
 import com.ibm.ws.annocache.util.internal.UtilImpl_Utils;
 import com.ibm.wsspi.anno.classsource.ClassSource_Aggregate.ScanPolicy;
+import com.ibm.wsspi.anno.service.AppKey;
 import com.ibm.wsspi.anno.util.Util_InternMap.ValueType;
 import com.ibm.wsspi.annocache.classsource.ClassSource_Aggregate;
 import com.ibm.wsspi.annocache.targets.AnnotationTargets_Exception;
@@ -437,7 +439,7 @@ public void scan(
 
         // The query logger has its own reference to module data.
 
-        TargetCacheImpl_DataApp appData = getAnnoCache().getAppForcing( getAppName() );
+        TargetCacheImpl_DataApp appData = getAnnoCache().getAppForcing( getAppName(), getAppKey() );
 
         putQueriesData(appData);
 
@@ -462,6 +464,7 @@ protected void putSpecificResults(TargetsScannerBaseImpl scanner) {
     protected ClassSource_Aggregate rootClassSource;
 
     protected String appName;
+    protected WeakReference<AppKey> appKey;
     protected String modName;
     protected String modCatName;
     protected String modFullName;
@@ -474,6 +477,7 @@ protected void setRootClassSource(ClassSource_Aggregate rootClassSource) {
 
     protected void setNames(ClassSource_Aggregate useRootClassSource) {
         this.appName = useRootClassSource.getApplicationName();
+        this.appKey = new WeakReference<AppKey>(useRootClassSource.getApplicationKey());
         this.modName = useRootClassSource.getModuleName();
         this.modCatName = useRootClassSource.getModuleCategoryName();
 
@@ -496,6 +500,11 @@ public String getAppName() {
         return appName;
     }
 
+    @Trivial
+    public AppKey getAppKey() {
+        return appKey.get();
+    }
+
     @Trivial
     public String getModName() {
         return modName;
@@ -720,7 +729,7 @@ protected synchronized void ensureInternalResults() {
                 "App [ {0} ] Mod [ {1} ]", new Object[] { useAppName, useModFullName });
         }
 
-        TargetCacheImpl_DataApp appData = getAnnoCache().getAppForcing(useAppName);
+        TargetCacheImpl_DataApp appData = getAnnoCache().getAppForcing(useAppName, getAppKey());
         TargetCacheImpl_DataMod modData = appData.getModForcing(useModFullName, getIsLightweight() );
 
         TargetsScannerOverallImpl useOverallScanner =