From a7c25dc0aff99eb58bc4846ef70905d8e30ac779 Mon Sep 17 00:00:00 2001 From: Jiaxiang Chen Date: Wed, 21 Sep 2022 23:26:36 -0700 Subject: [PATCH] respect nullability annotations on Java type references. * for referenced java types, compiler already handles nullability annotations. * fixes #167 --- .../impl/java/KSTypeReferenceJavaImpl.kt | 17 +++- .../ksp/test/KSPCompilerPluginTest.kt | 6 ++ .../devtools/ksp/impl/test/KSPAATest.kt | 7 ++ .../ksp/processor/JavaNonNullProcessor.kt | 47 +++++++++++ test-utils/testData/api/javaNonNullTypes.kt | 78 +++++++++++++++++++ 5 files changed, 154 insertions(+), 1 deletion(-) create mode 100644 test-utils/src/main/kotlin/com/google/devtools/ksp/processor/JavaNonNullProcessor.kt create mode 100644 test-utils/testData/api/javaNonNullTypes.kt diff --git a/compiler-plugin/src/main/kotlin/com/google/devtools/ksp/symbol/impl/java/KSTypeReferenceJavaImpl.kt b/compiler-plugin/src/main/kotlin/com/google/devtools/ksp/symbol/impl/java/KSTypeReferenceJavaImpl.kt index d12c540b20..6b0352441d 100644 --- a/compiler-plugin/src/main/kotlin/com/google/devtools/ksp/symbol/impl/java/KSTypeReferenceJavaImpl.kt +++ b/compiler-plugin/src/main/kotlin/com/google/devtools/ksp/symbol/impl/java/KSTypeReferenceJavaImpl.kt @@ -21,6 +21,7 @@ import com.google.devtools.ksp.ExceptionMessage import com.google.devtools.ksp.KSObjectCache import com.google.devtools.ksp.memoized import com.google.devtools.ksp.processing.impl.ResolverImpl +import com.google.devtools.ksp.symbol.KSAnnotated import com.google.devtools.ksp.symbol.KSAnnotation import com.google.devtools.ksp.symbol.KSNode import com.google.devtools.ksp.symbol.KSReferenceElement @@ -43,6 +44,9 @@ import com.intellij.psi.PsiType import com.intellij.psi.PsiWildcardType import com.intellij.psi.impl.source.PsiClassReferenceType import org.jetbrains.kotlin.descriptors.NotFoundClasses +import org.jetbrains.kotlin.load.java.NOT_NULL_ANNOTATIONS +import org.jetbrains.kotlin.load.java.NULLABLE_ANNOTATIONS +import org.jetbrains.kotlin.resolve.descriptorUtil.fqNameSafe import org.jetbrains.kotlin.types.KotlinType import org.jetbrains.kotlin.types.Variance import org.jetbrains.kotlin.types.typeUtil.makeNullable @@ -116,11 +120,22 @@ class KSTypeReferenceJavaImpl private constructor(val psi: PsiType, override val override fun resolve(): KSType { val resolvedType = ResolverImpl.instance!!.resolveUserType(this) - return if ((resolvedType.declaration as? KSClassDeclarationDescriptorImpl) + val relatedAnnotations = (annotations + ((parent as? KSAnnotated)?.annotations ?: emptySequence())) + .mapNotNull { + (it.annotationType.resolve() as? KSTypeImpl)?.kotlinType?.constructor?.declarationDescriptor?.fqNameSafe + } + val resolved = if ((resolvedType.declaration as? KSClassDeclarationDescriptorImpl) ?.descriptor is NotFoundClasses.MockClassDescriptor ) { KSErrorType } else resolvedType + val hasNotNull = relatedAnnotations.any { it in NOT_NULL_ANNOTATIONS } + val hasNullable = relatedAnnotations.any { it in NULLABLE_ANNOTATIONS } + return if (hasNullable && !hasNotNull) { + resolved.makeNullable() + } else if (!hasNullable && hasNotNull) { + resolved.makeNotNullable() + } else resolved } override fun accept(visitor: KSVisitor, data: D): R { diff --git a/compiler-plugin/src/test/kotlin/com/google/devtools/ksp/test/KSPCompilerPluginTest.kt b/compiler-plugin/src/test/kotlin/com/google/devtools/ksp/test/KSPCompilerPluginTest.kt index 377005e7d5..d32aa586a5 100644 --- a/compiler-plugin/src/test/kotlin/com/google/devtools/ksp/test/KSPCompilerPluginTest.kt +++ b/compiler-plugin/src/test/kotlin/com/google/devtools/ksp/test/KSPCompilerPluginTest.kt @@ -297,6 +297,12 @@ class KSPCompilerPluginTest : AbstractKSPCompilerPluginTest() { runTest("../test-utils/testData/api/javaModifiers.kt") } + @TestMetadata("javaNonNullTypes.kt") + @Test + fun testJavaNonNullTypes() { + runTest("../test-utils/testData/api/javaNonNullTypes.kt") + } + @TestMetadata("javaSubtype.kt") @Test fun testJavaSubtype() { diff --git a/kotlin-analysis-api/src/test/kotlin/com/google/devtools/ksp/impl/test/KSPAATest.kt b/kotlin-analysis-api/src/test/kotlin/com/google/devtools/ksp/impl/test/KSPAATest.kt index 528975f4d7..d95909c1f0 100644 --- a/kotlin-analysis-api/src/test/kotlin/com/google/devtools/ksp/impl/test/KSPAATest.kt +++ b/kotlin-analysis-api/src/test/kotlin/com/google/devtools/ksp/impl/test/KSPAATest.kt @@ -328,6 +328,13 @@ class KSPAATest : AbstractKSPAATest() { runTest("../test-utils/testData/api/javaModifiers.kt") } + @Disabled + @TestMetadata("javaNonNullTypes.kt") + @Test + fun testJavaNonNullTypes() { + runTest("../test-utils/testData/api/javaNonNullTypes.kt") + } + @Disabled @TestMetadata("javaSubtype.kt") @Test diff --git a/test-utils/src/main/kotlin/com/google/devtools/ksp/processor/JavaNonNullProcessor.kt b/test-utils/src/main/kotlin/com/google/devtools/ksp/processor/JavaNonNullProcessor.kt new file mode 100644 index 0000000000..2b006dfa77 --- /dev/null +++ b/test-utils/src/main/kotlin/com/google/devtools/ksp/processor/JavaNonNullProcessor.kt @@ -0,0 +1,47 @@ +package com.google.devtools.ksp.processor + +import com.google.devtools.ksp.isConstructor +import com.google.devtools.ksp.processing.Resolver +import com.google.devtools.ksp.symbol.KSAnnotated +import com.google.devtools.ksp.symbol.KSFunctionDeclaration +import com.google.devtools.ksp.symbol.KSNode +import com.google.devtools.ksp.symbol.KSPropertyDeclaration +import com.google.devtools.ksp.symbol.KSValueParameter +import com.google.devtools.ksp.visitor.KSTopDownVisitor + +class JavaNonNullProcessor : AbstractTestProcessor() { + val results = mutableListOf() + + override fun toResult(): List { + return results + } + + override fun process(resolver: Resolver): List { + resolver.getNewFiles().forEach { + it.accept( + object : KSTopDownVisitor() { + override fun defaultHandler(node: KSNode, data: Unit) { + } + + override fun visitFunctionDeclaration(function: KSFunctionDeclaration, data: Unit) { + if (function.isConstructor()) { + return + } + results.add("${function.simpleName.asString()}: ${function.returnType?.resolve()?.nullability}") + super.visitFunctionDeclaration(function, data) + } + + override fun visitPropertyDeclaration(property: KSPropertyDeclaration, data: Unit) { + results.add("${property.simpleName.asString()}: ${property.type.resolve().nullability}") + } + + override fun visitValueParameter(valueParameter: KSValueParameter, data: Unit) { + results.add("${valueParameter.name?.asString()}: ${valueParameter.type.resolve().nullability}") + } + }, + Unit + ) + } + return emptyList() + } +} diff --git a/test-utils/testData/api/javaNonNullTypes.kt b/test-utils/testData/api/javaNonNullTypes.kt new file mode 100644 index 0000000000..7a383bf747 --- /dev/null +++ b/test-utils/testData/api/javaNonNullTypes.kt @@ -0,0 +1,78 @@ +/* + * Copyright 2022 Google LLC + * Copyright 2010-2022 JetBrains s.r.o. and Kotlin Programming Language contributors. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +// WITH_RUNTIME +// TEST PROCESSOR: JavaNonNullProcessor +// EXPECTED: +// javaNotNullFieldRef: NOT_NULL +// javaNullableFieldRef: NULLABLE +// javaBothFieldRef: PLATFORM +// javaNoneFieldRef: NULLABLE +// bothField: PLATFORM +// nullableField: NULLABLE +// notNullField: NOT_NULL +// noneField: PLATFORM +// notNullFun: NOT_NULL +// nullableParam: NULLABLE +// END +// MODULE: lib +// FILE: dummy.kt +class dummy + +// FILE: org/jetbrains/annotations/NotNull.java +package org.jetbrains.annotations; + +public @interface NotNull { + +} + +// FILE: org/jetbrains/annotations/Nullable.java +package org.jetbrains.annotations; + +public @interface Nullable { + +} + +// MODULE: main(lib) +// FILE: a.kt +val javaNotNullFieldRef = JavaNonNull().notNullField +val javaNullableFieldRef = JavaNonNull().nullableField +val javaBothFieldRef = JavaNonNull().bothField +val javaNoneFieldRef = JavaNonNull().nonField + + +// FILE: JavaNonNull.java +import org.jetbrains.annotations.NotNull; +import org.jetbrains.annotations.Nullable; + + +public class JavaNonNull { + @Nullable + @NotNull + public String bothField; + + @Nullable + public String nullableField; + + @NotNull + public String notNullField; + + public String noneField; + + @NotNull + public String notNullFun(@Nullable String nullableParam) {} +}