Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Bug fixes for array subtyping at returns / parameter passing #980

Merged
merged 9 commits into from
Jun 19, 2024
Merged

Bug fixes for array subtyping at returns / parameter passing #980

Show file tree
Hide file tree
Changes from 7 commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
44429bb
WIP
msridhar Jun 16, 2024
b150dd3
WIP
msridhar Jun 16, 2024
51ee25f
one more test
msridhar Jun 16, 2024
d3b7d72
remove comment
msridhar Jun 16, 2024
854b630
fix NullAway report
msridhar Jun 16, 2024
22758c8
Merge branch 'master' into jspecify-array-returns-bug
msridhar Jun 17, 2024
dfa9945
Merge branch 'master' into jspecify-array-returns-bug
msridhar Jun 19, 2024
4aa9da7
add comments for varargs test
msridhar Jun 19, 2024
26b1eaf
couple more varargs tests
msridhar Jun 19, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 16 additions & 23 deletions nullaway/src/main/java/com/uber/nullaway/generics/GenericsChecks.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
package com.uber.nullaway.generics;

import static com.google.common.base.Verify.verify;
import static com.uber.nullaway.NullabilityUtil.castToNonNull;

import com.google.errorprone.VisitorState;
import com.google.errorprone.suppliers.Supplier;
Expand All @@ -11,6 +12,7 @@
import com.sun.source.tree.AssignmentTree;
import com.sun.source.tree.ConditionalExpressionTree;
import com.sun.source.tree.ExpressionTree;
import com.sun.source.tree.IdentifierTree;
import com.sun.source.tree.MemberSelectTree;
import com.sun.source.tree.MethodInvocationTree;
import com.sun.source.tree.MethodTree;
Expand Down Expand Up @@ -270,11 +272,10 @@ private static Type getTreeType(Tree tree, VisitorState state) {
return typeWithPreservedAnnotations(tree, state);
} else {
Type result;
if (tree instanceof VariableTree) {
if (tree instanceof VariableTree || tree instanceof IdentifierTree) {
// type on the tree itself can be missing nested annotations for arrays; get the type from
// the symbol for the declared variable instead
VariableTree varTree = (VariableTree) tree;
result = ASTHelpers.getSymbol(varTree).type;
// the symbol for the variable instead
result = castToNonNull(ASTHelpers.getSymbol(tree)).type;
} else if (tree instanceof AssignmentTree) {
// type on the tree itself can be missing nested annotations for arrays; get the type from
// the symbol for the assigned location instead, if available
Expand Down Expand Up @@ -355,10 +356,6 @@ public static void checkTypeParameterNullnessForFunctionReturnType(
}

Type formalReturnType = methodSymbol.getReturnType();
// check nullability of parameters only for generics
if (formalReturnType.getTypeArguments().isEmpty()) {
return;
}
Type returnExpressionType = getTreeType(retExpr, state);
if (formalReturnType != null && returnExpressionType != null) {
boolean isReturnTypeValid =
Expand Down Expand Up @@ -514,28 +511,24 @@ public static void compareGenericTypeParameterNullabilityForCall(
}
for (int i = 0; i < n; i++) {
Type formalParameter = formalParams.get(i).type;
if (!formalParameter.getTypeArguments().isEmpty()) {
Type actualParameter = getTreeType(actualParams.get(i), state);
if (actualParameter != null) {
if (!subtypeParameterNullability(formalParameter, actualParameter, state)) {
reportInvalidParametersNullabilityError(
formalParameter, actualParameter, actualParams.get(i), state, analysis);
}
Type actualParameter = getTreeType(actualParams.get(i), state);
if (actualParameter != null) {
if (!subtypeParameterNullability(formalParameter, actualParameter, state)) {
reportInvalidParametersNullabilityError(
formalParameter, actualParameter, actualParams.get(i), state, analysis);
}
}
}
if (isVarArgs && !formalParams.isEmpty()) {
Type.ArrayType varargsArrayType =
(Type.ArrayType) formalParams.get(formalParams.size() - 1).type;
Type varargsElementType = varargsArrayType.elemtype;
if (!varargsElementType.getTypeArguments().isEmpty()) {
for (int i = formalParams.size() - 1; i < actualParams.size(); i++) {
Type actualParameter = getTreeType(actualParams.get(i), state);
if (actualParameter != null) {
if (!subtypeParameterNullability(varargsElementType, actualParameter, state)) {
reportInvalidParametersNullabilityError(
varargsElementType, actualParameter, actualParams.get(i), state, analysis);
}
for (int i = formalParams.size() - 1; i < actualParams.size(); i++) {
Type actualParameter = getTreeType(actualParams.get(i), state);
if (actualParameter != null) {
if (!subtypeParameterNullability(varargsElementType, actualParameter, state)) {
reportInvalidParametersNullabilityError(
varargsElementType, actualParameter, actualParams.get(i), state, analysis);
}
}
}
Expand Down
45 changes: 45 additions & 0 deletions nullaway/src/test/java/com/uber/nullaway/jspecify/ArrayTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -278,6 +278,51 @@ public void arraysAndGenerics() {
.doTest();
}

@Test
public void genericArraysReturnedAndPassed() {
makeHelper()
.addSourceLines(
"Test.java",
"package com.uber;",
"import org.jspecify.annotations.Nullable;",
"class Test {",
" static class Foo<T> {}",
" static class Bar<T> {",
" Foo<T>[] getFoosPositive() {",
" @Nullable Foo<T>[] result = new Foo[0];",
" // BUG: Diagnostic contains: Cannot return expression of type @Nullable Foo<T>[] from method",
" return result;",
" }",
" Foo<T>[] getFoosNegative() {",
" Foo<T>[] result = new Foo[0];",
" return result;",
" }",
" void takeFoos(Foo<T>[] foos) {}",
" void callTakeFoosPositive(@Nullable Foo<T>[] p) {",
" // BUG: Diagnostic contains: Cannot pass parameter of type @Nullable Foo<T>[]",
" takeFoos(p);",
" }",
" void callTakeFoosNegative(Foo<T>[] p) {",
" takeFoos(p);",
" }",
" void takeFoosVarargs(Foo<T>[]... foos) {}",
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

To be clear, the type of foos here ends up being Foo<T>[][] right? With a single element array passed in 311 that gets converted to the type @Nullable Foo<T>[][] (meaning a two dimensional array of nullable Foos), correct?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, that's right; added a comment in 4aa9da7. Note that we don't have support for multidim arrays yet in JSpecify mode, so we can't yet test passing in a @Nullable Foo<T>[][] array directly.

" void callTakeFoosVarargsPositive(@Nullable Foo<T>[] p) {",
" // BUG: Diagnostic contains: Cannot pass parameter of type @Nullable Foo<T>[]",
" takeFoosVarargs(p);",
" }",
" void callTakeFoosVarargsNegative(Foo<T>[] p) {",
" takeFoosVarargs(p);",
" }",
" void takeNullableFoosVarargs(@Nullable Foo<T>[]... foos) {}",
" void callTakeNullableFoosVarargsNegative(@Nullable Foo<T>[] p1, Foo<T>[] p2) {",
" takeNullableFoosVarargs(p1);",
" takeNullableFoosVarargs(p2);",
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What about: takeNullableFoosVarargs(p1, p2)? (also worth having the case for takeFoosVarargs(p2, p1), I guess)

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good idea, added in 26b1eaf

" }",
" }",
"}")
.doTest();
}

@Test
public void overridesReturnType() {
makeHelper()
Expand Down