Skip to content

Commit

Permalink
Change Hilt processor to checks the correct "names" property when get…
Browse files Browse the repository at this point in the history
…ting values from Kotlin @Suppress annotations.

This CL also adds regression tests that contain @androidentrypoint classes that use Kotlin @Suppress.

Fixes #2834

RELNOTES=Fix #2834:Hilt processor now checks the correct "names" property when getting values from Kotlin @Suppress annotations.
PiperOrigin-RevId: 400036803
  • Loading branch information
bcorso authored and Dagger Team committed Sep 30, 2021
1 parent 43a7fe1 commit db21d3f
Show file tree
Hide file tree
Showing 2 changed files with 38 additions and 3 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@

import com.google.auto.common.AnnotationMirrors;
import com.google.common.base.Preconditions;
import com.google.common.collect.ImmutableMap;
import com.google.common.collect.ImmutableSet;
import com.squareup.javapoet.AnnotationSpec;
import com.squareup.javapoet.ClassName;
Expand All @@ -39,7 +40,6 @@
import java.util.List;
import java.util.Optional;
import java.util.stream.Collectors;
import java.util.stream.Stream;
import javax.lang.model.element.AnnotationMirror;
import javax.lang.model.element.Element;
import javax.lang.model.element.ExecutableElement;
Expand All @@ -50,6 +50,11 @@

/** Helper class for writing Hilt generators. */
final class Generators {
private static final ImmutableMap<ClassName, String> SUPPRESS_ANNOTATION_PROPERTY_NAME =
ImmutableMap.<ClassName, String>builder()
.put(ClassNames.SUPPRESS_WARNINGS, "value")
.put(ClassNames.KOTLIN_SUPPRESS, "names")
.build();

static void addGeneratedBaseClassJavadoc(TypeSpec.Builder builder, ClassName annotation) {
builder.addJavadoc("A generated base class to be extended by the @$T annotated class. If using"
Expand Down Expand Up @@ -150,12 +155,13 @@ private static MethodSpec copyConstructor(ExecutableElement constructor, CodeBlo
/** Copies SuppressWarnings annotations from the annotated element to the generated element. */
static void copySuppressAnnotations(Element element, TypeSpec.Builder builder) {
ImmutableSet<String> suppressValues =
Stream.of(ClassNames.SUPPRESS_WARNINGS, ClassNames.KOTLIN_SUPPRESS)
SUPPRESS_ANNOTATION_PROPERTY_NAME.keySet().stream()
.filter(annotation -> Processors.hasAnnotation(element, annotation))
.map(
annotation ->
AnnotationMirrors.getAnnotationValue(
Processors.getAnnotationMirror(element, annotation), "value"))
Processors.getAnnotationMirror(element, annotation),
SUPPRESS_ANNOTATION_PROPERTY_NAME.get(annotation)))
.flatMap(value -> Processors.getStringArrayAnnotationValue(value).stream())
.collect(toImmutableSet());

Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
/*
* Copyright (C) 2021 The Dagger Authors.
*
* 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.
*/

package dagger.hilt.android.simpleKotlin

import androidx.fragment.app.FragmentActivity
import dagger.hilt.android.AndroidEntryPoint

// Regression test for https://github.com/google/dagger/issues/2898
// TODO(bcorso):Replace this with a Kotlin compiler test and verify the SuppressWarnings is
// propagated to the generated Hilt class.
class KotlinSuppressClasses {
@Suppress("deprecation")
@AndroidEntryPoint
class MyActivity : FragmentActivity()
}

0 comments on commit db21d3f

Please sign in to comment.