-
Notifications
You must be signed in to change notification settings - Fork 292
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Resolve regression for type annotations directly on inner types. (#706)
This resolves #705 by broadening our slightly overzealous filtering from #702. We still want to filter type use annotations out when they happen on wildcards or type parameters. However, we can handle annotations on inner types (i.e. `Foo.@nullable Bar`). More importantly, these inner types appear implicitly in natural code involving inner classes, such as: ``` class Bar { @nullable Foo foo; // <- this is, implicitly Bar.@nullable Foo !! class Foo { } } ``` Not handling this case leads to confusing an unintuitive errors where a `@Nullable` annotation with a type use location will seemingly stop working for certain fields at random, if those fields are of an inner type. Additionally, as part of this fix, we restore the handling of type use annotations at the start of an array type as meaning the array object itself is `@Nullable` (i.e. `@Nullable Foo[] arr`, in addition to the correct type use form `Foo @nullable[] arr`). This is technically incorrect, but prohibiting it would break backwards compatibility with older versions of NullAway and surprise users, specially those switching from declaration annotations to type use annotations. See #708 for a full discussion of the tradeoffs and the path forward towards the proper semantics for type use annotations. Co-authored-by: Manu Sridharan <msridhar@gmail.com>
- Loading branch information
1 parent
d6d2978
commit c5e1a79
Showing
3 changed files
with
254 additions
and
31 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
221 changes: 221 additions & 0 deletions
221
nullaway/src/test/java/com/uber/nullaway/NullAwayTypeUseAnnotationsTests.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,221 @@ | ||
| /* | ||
| * Copyright (c) 2023 Uber Technologies, Inc. | ||
| * | ||
| * Permission is hereby granted, free of charge, to any person obtaining a copy | ||
| * of this software and associated documentation files (the "Software"), to deal | ||
| * in the Software without restriction, including without limitation the rights | ||
| * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
| * copies of the Software, and to permit persons to whom the Software is | ||
| * furnished to do so, subject to the following conditions: | ||
| * | ||
| * The above copyright notice and this permission notice shall be included in | ||
| * all copies or substantial portions of the Software. | ||
| * | ||
| * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
| * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
| * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
| * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
| * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
| * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN | ||
| * THE SOFTWARE. | ||
| */ | ||
|
|
||
| package com.uber.nullaway; | ||
|
|
||
| import org.junit.Test; | ||
| import org.junit.runner.RunWith; | ||
| import org.junit.runners.JUnit4; | ||
|
|
||
| @RunWith(JUnit4.class) | ||
| public class NullAwayTypeUseAnnotationsTests extends NullAwayTestsBase { | ||
|
|
||
| @Test | ||
| public void annotationAppliedToTypeParameter() { | ||
| defaultCompilationHelper | ||
| .addSourceLines( | ||
| "Test.java", | ||
| "package com.uber;", | ||
| "import java.util.List;", | ||
| "import java.util.ArrayList;", | ||
| "import org.checkerframework.checker.nullness.qual.Nullable;", | ||
| "class TypeArgumentAnnotation {", | ||
| " List<@Nullable String> fSafe = new ArrayList<>();", | ||
| " @Nullable List<String> fUnsafe = new ArrayList<>();", | ||
| " void useParamSafe(List<@Nullable String> list) {", | ||
| " list.hashCode();", | ||
| " }", | ||
| " void useParamUnsafe(@Nullable List<String> list) {", | ||
| " // BUG: Diagnostic contains: dereferenced", | ||
| " list.hashCode();", | ||
| " }", | ||
| " void useFieldSafe() {", | ||
| " fSafe.hashCode();", | ||
| " }", | ||
| " void useFieldUnsafe() {", | ||
| " // BUG: Diagnostic contains: dereferenced", | ||
| " fUnsafe.hashCode();", | ||
| " }", | ||
| "}") | ||
| .doTest(); | ||
| } | ||
|
|
||
| @Test | ||
| public void annotationAppliedToInnerTypeImplicitly() { | ||
| defaultCompilationHelper | ||
| .addSourceLines( | ||
| "Test.java", | ||
| "package com.uber;", | ||
| "import org.checkerframework.checker.nullness.qual.Nullable;", | ||
| "class Test {", | ||
| " @Nullable Foo f;", // i.e. Test.@Nullable Foo | ||
| " class Foo { }", | ||
| " public void test() {", | ||
| " // BUG: Diagnostic contains: dereferenced", | ||
| " f.hashCode();", | ||
| " }", | ||
| "}") | ||
| .doTest(); | ||
| } | ||
|
|
||
| @Test | ||
| public void annotationAppliedToInnerTypeImplicitlyWithTypeArgs() { | ||
| defaultCompilationHelper | ||
| .addSourceLines( | ||
| "Test.java", | ||
| "package com.uber;", | ||
| "import org.checkerframework.checker.nullness.qual.Nullable;", | ||
| "class Test {", | ||
| " @Nullable Foo<String> f1 = null;", // i.e. Test.@Nullable Foo (location [INNER]) | ||
| " // BUG: Diagnostic contains: assigning @Nullable expression to @NonNull field", | ||
| " Foo<@Nullable String> f2 = null;", // (location [INNER, TYPE_ARG(0)]) | ||
| " @Nullable Foo<@Nullable String> f3 = null;", // two annotations, each with the | ||
| // locations above | ||
| " class Foo<T> { }", | ||
| " public void test() {", | ||
| " // BUG: Diagnostic contains: dereferenced", | ||
| " f1.hashCode();", | ||
| " // safe, because nonnull", | ||
| " f2.hashCode();", | ||
| " // BUG: Diagnostic contains: dereferenced", | ||
| " f3.hashCode();", | ||
| " }", | ||
| "}") | ||
| .doTest(); | ||
| } | ||
|
|
||
| @Test | ||
| public void annotationAppliedToInnerTypeExplicitly() { | ||
| defaultCompilationHelper | ||
| .addSourceLines( | ||
| "Test.java", | ||
| "package com.uber;", | ||
| "import org.checkerframework.checker.nullness.qual.Nullable;", | ||
| "class Test {", | ||
| " Test.@Nullable Foo f1;", | ||
| " @Nullable Test.Foo f2;", | ||
| " class Foo { }", | ||
| " public void test() {", | ||
| " // BUG: Diagnostic contains: dereferenced", | ||
| " f1.hashCode();", | ||
| " // BUG: Diagnostic contains: dereferenced", | ||
| " f2.hashCode();", | ||
| " }", | ||
| "}") | ||
| .doTest(); | ||
| } | ||
|
|
||
| @Test | ||
| public void annotationAppliedToInnerTypeExplicitly2() { | ||
| defaultCompilationHelper | ||
| .addSourceLines( | ||
| "Bar.java", | ||
| "package com.uber;", | ||
| "import org.checkerframework.checker.nullness.qual.Nullable;", | ||
| "class Bar {", | ||
| " public class Foo { }", | ||
| "}") | ||
| .addSourceLines( | ||
| "Test.java", | ||
| "package com.uber;", | ||
| "import org.checkerframework.checker.nullness.qual.Nullable;", | ||
| "class Test {", | ||
| " Bar.@Nullable Foo f1;", | ||
| " @Nullable Bar.Foo f2;", | ||
| " public void test() {", | ||
| " // BUG: Diagnostic contains: dereferenced", | ||
| " f1.hashCode();", | ||
| " // BUG: Diagnostic contains: dereferenced", | ||
| " f2.hashCode();", | ||
| " }", | ||
| "}") | ||
| .doTest(); | ||
| } | ||
|
|
||
| @Test | ||
| public void annotationAppliedToInnerTypeOfTypeArgument() { | ||
| defaultCompilationHelper | ||
| .addSourceLines( | ||
| "Test.java", | ||
| "package com.uber;", | ||
| "import java.util.Set;", | ||
| "import org.checkerframework.checker.nullness.qual.Nullable;", | ||
| "class Test {", | ||
| " // BUG: Diagnostic contains: @NonNull field s not initialized", | ||
| " Set<@Nullable Foo> s;", // i.e. Set<Test.@Nullable Foo> | ||
| " class Foo { }", | ||
| " public void test() {", | ||
| " // safe because field is @NonNull", | ||
| " s.hashCode();", | ||
| " }", | ||
| "}") | ||
| .doTest(); | ||
| } | ||
|
|
||
| @Test | ||
| public void typeUseAnnotationOnArray() { | ||
| defaultCompilationHelper | ||
| .addSourceLines( | ||
| "Test.java", | ||
| "package com.uber;", | ||
| "import org.checkerframework.checker.nullness.qual.Nullable;", | ||
| "class Test {", | ||
| " // ok only for backwards compat", | ||
| " @Nullable Object[] foo1 = null;", | ||
| " // ok according to spec", | ||
| " Object @Nullable[] foo2 = null;", | ||
| " // ok only for backwards compat", | ||
| " @Nullable Object [][] foo3 = null;", | ||
| " // ok according to spec", | ||
| " Object @Nullable [][] foo4 = null;", | ||
| " // NOT ok; @Nullable applies to first array dimension not the elements or the array ref", | ||
| " // TODO: Fix this as part of https://github.com/uber/NullAway/issues/708", | ||
| " Object [] @Nullable [] foo5 = null;", | ||
| "}") | ||
| .doTest(); | ||
| } | ||
|
|
||
| @Test | ||
| public void typeUseAnnotationOnInnerMultiLevel() { | ||
| defaultCompilationHelper | ||
| .addSourceLines( | ||
| "Test.java", | ||
| "package com.uber;", | ||
| "import java.util.Set;", | ||
| "import org.checkerframework.checker.nullness.qual.Nullable;", | ||
| "class A { class B { class C {} } }", | ||
| "class Test {", | ||
| " // At some point, we should not treat foo1 or foo2 as @Nullable.", | ||
| " // For now we do, for ease of compatibility.", | ||
| " // TODO: Fix this as part of https://github.com/uber/NullAway/issues/708", | ||
| " @Nullable A.B.C foo1 = null;", | ||
| " A.@Nullable B.C foo2 = null;", | ||
| " A.B.@Nullable C foo3 = null;", | ||
| " // No good reason to support the case below, though!", | ||
| " // It neither matches were a correct type use annotation for marking foo4 as @Nullable would be,", | ||
| " // nor the natural position of a declaration annotation at the start of the type!", | ||
| " // BUG: Diagnostic contains: assigning @Nullable expression to @NonNull field", | ||
| " A.B.@Nullable C [][] foo4 = null;", | ||
| "}") | ||
| .doTest(); | ||
| } | ||
| } |