Skip to content

Commit

Permalink
Fix issue with Dagger generating mismatching parameter name for injec…
Browse files Browse the repository at this point in the history
…t functions.

Fixes #3476

Also adds a regression test for the issue.

RELNOTES=Fixes #3476: Fix issue with Dagger generating mismatching parameter name for inject functions.
PiperOrigin-RevId: 462738504
  • Loading branch information
bcorso authored and Dagger Team committed Jul 23, 2022
1 parent 9f656bc commit 90300d9
Show file tree
Hide file tree
Showing 3 changed files with 126 additions and 11 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -17,12 +17,12 @@
package dagger.internal.codegen.writing;

import static com.google.common.collect.Iterables.getOnlyElement;
import static dagger.internal.codegen.xprocessing.JavaPoetExt.getParameterSpec;
import static dagger.internal.codegen.xprocessing.XElements.getSimpleName;

import androidx.room.compiler.processing.XExecutableParameterElement;
import androidx.room.compiler.processing.XMethodElement;
import com.squareup.javapoet.ClassName;
import com.squareup.javapoet.CodeBlock;
import com.squareup.javapoet.ParameterSpec;
import dagger.assisted.Assisted;
import dagger.assisted.AssistedFactory;
import dagger.assisted.AssistedInject;
Expand Down Expand Up @@ -54,9 +54,9 @@ Expression getDependencyExpression(ClassName requestingClass) {
protected Expression getDependencyExpressionForComponentMethod(
ComponentMethodDescriptor componentMethod, ComponentImplementation component) {
XMethodElement methodElement = componentMethod.methodElement();
ParameterSpec parameter = getParameterSpec(getOnlyElement(methodElement.getParameters()));
XExecutableParameterElement parameter = getOnlyElement(methodElement.getParameters());
return membersInjectionMethods.getInjectExpression(
binding.key(), CodeBlock.of("$N", parameter), component.name());
binding.key(), CodeBlock.of("$L", getSimpleName(parameter)), component.name());
}

// TODO(bcorso): Consider making this a method on all RequestRepresentations.
Expand Down
7 changes: 0 additions & 7 deletions java/dagger/internal/codegen/xprocessing/JavaPoetExt.java
Original file line number Diff line number Diff line change
Expand Up @@ -16,22 +16,15 @@

package dagger.internal.codegen.xprocessing;

import static androidx.room.compiler.processing.compat.XConverters.toJavac;
import static dagger.internal.codegen.xprocessing.XElements.getSimpleName;

import androidx.room.compiler.processing.XExecutableParameterElement;
import androidx.room.compiler.processing.XType;
import androidx.room.compiler.processing.XTypeElement;
import com.squareup.javapoet.ParameterSpec;
import com.squareup.javapoet.TypeSpec;

// TODO(bcorso): Consider moving these methods into XProcessing library.
/** A utility class for JavaPoet types to interface with XProcessing types. */
public final class JavaPoetExt {
/** Returns the {@link ParameterSpec} for the given parameter. */
public static ParameterSpec getParameterSpec(XExecutableParameterElement parameter) {
return ParameterSpec.get(toJavac(parameter));
}

/**
* Configures the given {@link TypeSpec.Builder} so that it fully qualifies all classes nested in
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,122 @@
/*
* Copyright (C) 2022 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 buildtests;

import static com.google.common.truth.Truth.assertThat;
import static org.gradle.testkit.runner.TaskOutcome.SUCCESS;

import java.io.File;
import java.io.IOException;
import org.gradle.testkit.runner.BuildResult;
import org.gradle.testkit.runner.GradleRunner;
import org.junit.Rule;
import org.junit.Test;
import org.junit.rules.TemporaryFolder;
import org.junit.runner.RunWith;
import org.junit.runners.JUnit4;

// This is a regression test for https://github.com/google/dagger/issues/3476
@RunWith(JUnit4.class)
public class TransitiveInjectMethodTest {
@Rule public TemporaryFolder folder = new TemporaryFolder();

@Test
public void testBuild() throws IOException {
BuildResult result = setupRunner().build();
assertThat(result.task(":app:assemble").getOutcome()).isEqualTo(SUCCESS);
}

private GradleRunner setupRunner() throws IOException {
File projectDir = folder.getRoot();
GradleModule.create(projectDir)
.addSettingsFile(
"include 'app'",
"include 'library1'")
.addBuildFile(
"buildscript {",
" ext {",
String.format("dagger_version = \"%s\"", System.getProperty("dagger_version")),
String.format("kotlin_version = \"%s\"", System.getProperty("kotlin_version")),
" }",
"}",
"",
"allprojects {",
" repositories {",
" mavenCentral()",
" mavenLocal()",
" }",
"}");

GradleModule.create(projectDir, "app")
.addBuildFile(
"plugins {",
" id 'java'",
" id 'application'",
"}",
"dependencies {",
" implementation project(':library1')",
" implementation \"com.google.dagger:dagger:$dagger_version\"",
" annotationProcessor \"com.google.dagger:dagger-compiler:$dagger_version\"",
"}")
.addSrcFile(
"MyComponent.java",
"package app;",
"",
"import dagger.BindsInstance;",
"import dagger.Component;",
"import library1.FooInjector;",
"",
"@Component",
"interface MyComponent extends FooInjector {",
" @Component.Factory",
" interface Factory {",
" MyComponent create(@BindsInstance String str);",
" }",
"}");

GradleModule.create(projectDir, "library1")
.addBuildFile(
"plugins {",
" id 'org.jetbrains.kotlin.jvm' version \"$kotlin_version\"",
" id 'org.jetbrains.kotlin.kapt' version \"$kotlin_version\"",
"}",
"dependencies {",
" implementation \"com.google.dagger:dagger:$dagger_version\"",
" annotationProcessor \"com.google.dagger:dagger-compiler:$dagger_version\"",
"}")
.addSrcFile(
"Foo.kt",
"package library1",
"",
"import javax.inject.Inject",
"",
"class Foo {",
" @Inject lateinit var str: String",
"}")
.addSrcFile(
"FooInjector.kt",
"package library1",
"",
"interface FooInjector {",
" fun inject(foo: Foo)",
"}");

return GradleRunner.create()
.withArguments("--stacktrace", "build")
.withProjectDir(projectDir);
}
}

0 comments on commit 90300d9

Please sign in to comment.