External Library Models: Adding support for Nullable upper bounds of Generic Type parameters #949

akulk022 · 2024-04-13T14:48:41Z

With these changes we are able to read and create library models for Nullable upper bounds of generic type parameters from externally annotated source code as shown in the below example.

Externally annotated source code example:

public static class GenericExample<T extends @Nullable Object> {
        public T getNull() {
            return null;
        }
 }

public static class GenericExample<T> {
    public T getNull() {
      return null;
    }
}
static GenericExample<@Nullable Object> genericExample = new GenericExample<@Nullable Object>();
static void test(Object value){}
// BUG: Diagnostic contains: passing @Nullable parameter 'genericExample.getNull()'
test(genericExample.getNull());

…ernal library models

codecov · 2024-04-13T15:12:08Z

Codecov Report

Attention: Patch coverage is 72.72727% with 30 lines in your changes are missing coverage. Please review.

Project coverage is 85.98%. Comparing base (09db47a) to head (d351cc9).

Files	Patch %	Lines
.../uber/nullaway/libmodel/LibraryModelGenerator.java	0.00%	15 Missing ⚠️
...ava/com/uber/nullaway/handlers/StubxCacheUtil.java	78.12%	9 Missing and 5 partials ⚠️
...er/nullaway/handlers/InferredJARModelsHandler.java	66.66%	1 Missing ⚠️

Additional details and impacted files

@@             Coverage Diff              @@
##             master     #949      +/-   ##
============================================
- Coverage     86.08%   85.98%   -0.11%     
- Complexity     2018     2023       +5     
============================================
  Files            79       80       +1     
  Lines          6612     6663      +51     
  Branches       1280     1288       +8     
============================================
+ Hits           5692     5729      +37     
- Misses          510      524      +14     
  Partials        410      410

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

msridhar

I have a few initial comments. I got lost reviewing the changes under nullaway/src/main/java/com/uber/nullaway/handlers. Can you describe the purpose of the new StubxCacheUtil class and how the refactored code works, for both old JarInfer stubs and newly generated ones?

msridhar · 2024-04-16T23:30:22Z

...or/src/main/resources/sample_annotated/src/com/uber/nullaway/libmodel/AnnotationExample.java

@@ -45,4 +45,11 @@ public String returnNull() {
            return null;
        }
    }
+
+    public static class GenericExample<T extends @Nullable Object> {


Let's call this UpperBoundExample

msridhar · 2024-04-16T23:34:06Z

...r-integration-test/src/test/java/com/uber/nullaway/libmodel/LibraryModelIntegrationTest.java

+            "package com.uber;",
+            "import org.jspecify.annotations.Nullable;",
+            "import com.uber.nullaway.libmodel.AnnotationExample;",
+            "class Test {",


I would suggest we also update the libraryModelWithoutJarInferEnabledTest test. But I think we will get errors there even without the modeling due to #872

msridhar · 2024-04-16T23:40:48Z

.../library-model-generator/src/main/java/com/uber/nullaway/libmodel/LibraryModelGenerator.java

+        methodRecords.put(
+            parentName + ":" + GENERIC_TYPE_IDENTIFIER,
+            MethodAnnotationsRecord.create(ImmutableSet.of(), genericParamAnnotationsMap));


At first glance this seems rather hacky. Why are we reusing the methodRecords map and the MethodAnnotationsRecord class when the upper bound is on a type variable? At least for this case, the type variable is declared on a class, not a method. I'd prefer we just create a separate data structure for class or type variable records

I agree, it is very hacky. I will use a separate data structure and work on a way to integrate it within the cache.

msridhar · 2024-04-16T23:41:23Z

.../library-model-generator/src/main/java/com/uber/nullaway/libmodel/LibraryModelGenerator.java

+       We insert a specialized MethodAnnotationsRecord object to store the generic type parameter nullability
+       information for the class by using an identifier that can never be an actual method name.
+      */
+      if (this.isNullMarked && !genericParamAnnotationsMap.isEmpty()) {


Should we be checking if the class is null marked before getting the upper bounds at line 204, for efficiency?

msridhar · 2024-04-16T23:42:55Z

.../library-model-generator/src/main/java/com/uber/nullaway/libmodel/LibraryModelGenerator.java

+     * @param cid ClassOrInterfaceDeclaration instance.
+     * @return Map of annotations for generic type parameters with Nullable upper bounds.
+     */
+    private ImmutableMap<Integer, ImmutableSet<String>> getGenericTypeParameterNullableUpperBounds(


Returning a map seems overly complex. If we are only looking for @Nullable upper bounds why not just return an ImmutableSet<Integer> containing those type variable indices with such a bound?

msridhar · 2024-04-16T23:43:56Z

nullaway/src/main/java/com/uber/nullaway/handlers/StubxCacheUtil.java

+import java.util.ServiceLoader;
+import java.util.Set;
+
+public class StubxCacheUtil {


What is the purpose of this class? Please add Javadoc

I created it to reuse the logic for caching the annotation information from the stubx file from InferredJARModelsHandler

msridhar · 2024-04-16T23:44:33Z

nullaway/src/main/java/com/uber/nullaway/handlers/StubxCacheUtil.java

+  private static final int RETURN = -1;
+  private final Map<String, Map<String, Map<Integer, Set<String>>>> argAnnotCache;
+
+  public StubxCacheUtil(String logCaller) {


Add Javadoc, including the purpose of the parameter

adding generic type parameter nullability upper bound support for ext…

628683b

…ernal library models

akulk022 marked this pull request as draft April 13, 2024 14:55

fix

0c4d694

akulk022 added 2 commits April 14, 2024 12:43

comment

ddaa68a

comment

d351cc9

msridhar mentioned this pull request Apr 16, 2024

Tracking issue: making jspecify/jdk library models available to NullAway users #950

Open

5 tasks

msridhar reviewed Apr 16, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

External Library Models: Adding support for Nullable upper bounds of Generic Type parameters #949

External Library Models: Adding support for Nullable upper bounds of Generic Type parameters #949

akulk022 commented Apr 13, 2024 •

edited

codecov bot commented Apr 13, 2024 •

edited

msridhar left a comment

msridhar Apr 16, 2024

msridhar Apr 16, 2024

msridhar Apr 16, 2024

akulk022 Apr 17, 2024

msridhar Apr 16, 2024

msridhar Apr 16, 2024

msridhar Apr 16, 2024

akulk022 Apr 17, 2024

msridhar Apr 16, 2024

External Library Models: Adding support for Nullable upper bounds of Generic Type parameters #949

Are you sure you want to change the base?

External Library Models: Adding support for Nullable upper bounds of Generic Type parameters #949

Conversation

akulk022 commented Apr 13, 2024 • edited

codecov bot commented Apr 13, 2024 • edited

Codecov Report

msridhar left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

akulk022 commented Apr 13, 2024 •

edited

codecov bot commented Apr 13, 2024 •

edited