Skip to content

Commit

Permalink
Fixes Dagger's shading to properly handle kotlin metadata
Browse files Browse the repository at this point in the history
The issue was due to incorrect handling of shading in jarjar for kotlin metadata. In particular, jarjar does not replace UTF8 usages in the classfile, so the Strings in the kotlin metadata do not get replaced. This breaks when the class is compiled with kotlinc which uses the kotlin metadata during compilation.

To fix this, I've switched from jarjar to using Gradle's shadowJar to do the shading (https://imperceptiblethoughts.com/shadow/).

Also, I've added a kotlin regression test in gradle.

Closes #2765

RELNOTES=Fix #2765: Fixes Dagger's shading to properly handle kotlin metadata.
PiperOrigin-RevId: 387123329
  • Loading branch information
bcorso authored and Dagger Team committed Jul 27, 2021
1 parent 09087db commit ef7e7a1
Show file tree
Hide file tree
Showing 22 changed files with 774 additions and 31 deletions.
4 changes: 3 additions & 1 deletion java/dagger/hilt/android/processor/BUILD
Original file line number Diff line number Diff line change
Expand Up @@ -97,8 +97,10 @@ gen_maven_artifact(
javadoc_srcs = [
"//java/dagger/hilt:hilt_processing_filegroup",
],
# The shaded deps are added using jarjar, but they won't be shaded until later
# due to: https://github.com/google/dagger/issues/2765. For the shaded rules see
# util/deploy-hilt.sh
shaded_deps = ["@com_google_auto_auto_common//jar"],
shaded_rules = ["rule com.google.auto.common.** dagger.hilt.android.shaded.auto.common.@1"],
)

filegroup(
Expand Down
4 changes: 3 additions & 1 deletion java/dagger/hilt/processor/BUILD
Original file line number Diff line number Diff line change
Expand Up @@ -119,8 +119,10 @@ gen_maven_artifact(
javadoc_srcs = [
"//java/dagger/hilt:hilt_processing_filegroup",
],
# The shaded deps are added using jarjar, but they won't be shaded until later
# due to: https://github.com/google/dagger/issues/2765. For the shaded rules see
# util/deploy-hilt.sh
shaded_deps = ["@com_google_auto_auto_common//jar"],
shaded_rules = ["rule com.google.auto.common.** dagger.hilt.android.shaded.auto.common.@1"],
)

filegroup(
Expand Down
7 changes: 3 additions & 4 deletions java/dagger/internal/codegen/BUILD
Original file line number Diff line number Diff line change
Expand Up @@ -113,14 +113,13 @@ gen_maven_artifact(
# The javadocs should only include ComponentProcessor.java, since that is the only class used
# externally. Specifically, ComponentProcessor.forTesting() is required for testing SPI plugins.
javadoc_srcs = ["ComponentProcessor.java"],
# The shaded deps are added using jarjar, but they won't be shaded until later
# due to: https://github.com/google/dagger/issues/2765. For the shaded rules see
# util/deploy-dagger.sh
shaded_deps = [
"@com_google_auto_auto_common//jar",
"//java/dagger/internal/codegen/xprocessing",
],
shaded_rules = [
"rule androidx.room.compiler.processing.** dagger.shaded.androidx.room.compiler.processing.@1",
"rule com.google.auto.common.** dagger.shaded.auto.common.@1",
],
)

java_plugin(
Expand Down
4 changes: 3 additions & 1 deletion java/dagger/spi/BUILD
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,8 @@ gen_maven_artifact(
"dagger.spi",
],
javadoc_srcs = [":spi-srcs"],
# The shaded deps are added using jarjar, but they won't be shaded until later
# due to: https://github.com/google/dagger/issues/2765. For the shaded rules see
# util/deploy-dagger.sh
shaded_deps = ["@com_google_auto_auto_common//jar"],
shaded_rules = ["rule com.google.auto.common.** dagger.spi.shaded.auto.common.@1"],
)
Original file line number Diff line number Diff line change
Expand Up @@ -44,5 +44,8 @@ interface SimpleComponent {

public static void main(String[] args) {
Foo foo = DaggerSimpleApplication_SimpleComponent.create().foo();

// Execute other classes
AssistedInjects.main(args);
}
}
53 changes: 53 additions & 0 deletions javatests/artifacts/dagger/simpleKotlin/build.gradle
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
/*
* Copyright (C) 2020 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.
*/

buildscript {
ext.kotlin_version = "1.5.0"
}

plugins {
id 'application'
id 'org.jetbrains.kotlin.jvm' version "$kotlin_version"
id 'org.jetbrains.kotlin.kapt' version "$kotlin_version"
}

repositories {
google()
mavenCentral()
mavenLocal()
}

java {
// Make sure the generated source is compatible with Java 7.
sourceCompatibility = JavaVersion.VERSION_1_8
}

dependencies {
implementation "org.jetbrains.kotlin:kotlin-stdlib:$kotlin_version"
implementation 'com.google.dagger:dagger:LOCAL-SNAPSHOT'
kapt 'com.google.dagger:dagger-compiler:LOCAL-SNAPSHOT'

// This is testImplementation rather than kaptTest because we're actually
// testing the reference to ComponentProcessor.
// See https://github.com/google/dagger/issues/2765
testImplementation 'com.google.dagger:dagger-compiler:LOCAL-SNAPSHOT'
testImplementation 'com.google.truth:truth:1.0.1'
testImplementation 'junit:junit:4.13'
}

application {
mainClass = 'dagger.simple.SimpleApplicationKt'
}
Binary file not shown.
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
distributionBase=GRADLE_USER_HOME
distributionPath=wrapper/dists
distributionUrl=https\://services.gradle.org/distributions/gradle-7.0.2-bin.zip
zipStoreBase=GRADLE_USER_HOME
zipStorePath=wrapper/dists
188 changes: 188 additions & 0 deletions javatests/artifacts/dagger/simpleKotlin/gradlew
Original file line number Diff line number Diff line change
@@ -0,0 +1,188 @@
#!/usr/bin/env sh

#
# Copyright 2015 the original author or 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.
#

##############################################################################
##
## Gradle start up script for UN*X
##
##############################################################################

# Attempt to set APP_HOME
# Resolve links: $0 may be a link
PRG="$0"
# Need this for relative symlinks.
while [ -h "$PRG" ] ; do
ls=`ls -ld "$PRG"`
link=`expr "$ls" : '.*-> \(.*\)$'`
if expr "$link" : '/.*' > /dev/null; then
PRG="$link"
else
PRG=`dirname "$PRG"`"/$link"
fi
done
SAVED="`pwd`"
cd "`dirname \"$PRG\"`/" >/dev/null
APP_HOME="`pwd -P`"
cd "$SAVED" >/dev/null

APP_NAME="Gradle"
APP_BASE_NAME=`basename "$0"`

# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"'

# Use the maximum available, or set MAX_FD != -1 to use that value.
MAX_FD="maximum"

warn () {
echo "$*"
}

die () {
echo
echo "$*"
echo
exit 1
}

# OS specific support (must be 'true' or 'false').
cygwin=false
msys=false
darwin=false
nonstop=false
case "`uname`" in
CYGWIN* )
cygwin=true
;;
Darwin* )
darwin=true
;;
MINGW* )
msys=true
;;
NONSTOP* )
nonstop=true
;;
esac

CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar

# Determine the Java command to use to start the JVM.
if [ -n "$JAVA_HOME" ] ; then
if [ -x "$JAVA_HOME/jre/sh/java" ] ; then
# IBM's JDK on AIX uses strange locations for the executables
JAVACMD="$JAVA_HOME/jre/sh/java"
else
JAVACMD="$JAVA_HOME/bin/java"
fi
if [ ! -x "$JAVACMD" ] ; then
die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME
Please set the JAVA_HOME variable in your environment to match the
location of your Java installation."
fi
else
JAVACMD="java"
which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
Please set the JAVA_HOME variable in your environment to match the
location of your Java installation."
fi

# Increase the maximum file descriptors if we can.
if [ "$cygwin" = "false" -a "$darwin" = "false" -a "$nonstop" = "false" ] ; then
MAX_FD_LIMIT=`ulimit -H -n`
if [ $? -eq 0 ] ; then
if [ "$MAX_FD" = "maximum" -o "$MAX_FD" = "max" ] ; then
MAX_FD="$MAX_FD_LIMIT"
fi
ulimit -n $MAX_FD
if [ $? -ne 0 ] ; then
warn "Could not set maximum file descriptor limit: $MAX_FD"
fi
else
warn "Could not query maximum file descriptor limit: $MAX_FD_LIMIT"
fi
fi

# For Darwin, add options to specify how the application appears in the dock
if $darwin; then
GRADLE_OPTS="$GRADLE_OPTS \"-Xdock:name=$APP_NAME\" \"-Xdock:icon=$APP_HOME/media/gradle.icns\""
fi

# For Cygwin, switch paths to Windows format before running java
if $cygwin ; then
APP_HOME=`cygpath --path --mixed "$APP_HOME"`
CLASSPATH=`cygpath --path --mixed "$CLASSPATH"`
JAVACMD=`cygpath --unix "$JAVACMD"`

# We build the pattern for arguments to be converted via cygpath
ROOTDIRSRAW=`find -L / -maxdepth 1 -mindepth 1 -type d 2>/dev/null`
SEP=""
for dir in $ROOTDIRSRAW ; do
ROOTDIRS="$ROOTDIRS$SEP$dir"
SEP="|"
done
OURCYGPATTERN="(^($ROOTDIRS))"
# Add a user-defined pattern to the cygpath arguments
if [ "$GRADLE_CYGPATTERN" != "" ] ; then
OURCYGPATTERN="$OURCYGPATTERN|($GRADLE_CYGPATTERN)"
fi
# Now convert the arguments - kludge to limit ourselves to /bin/sh
i=0
for arg in "$@" ; do
CHECK=`echo "$arg"|egrep -c "$OURCYGPATTERN" -`
CHECK2=`echo "$arg"|egrep -c "^-"` ### Determine if an option

if [ $CHECK -ne 0 ] && [ $CHECK2 -eq 0 ] ; then ### Added a condition
eval `echo args$i`=`cygpath --path --ignore --mixed "$arg"`
else
eval `echo args$i`="\"$arg\""
fi
i=$((i+1))
done
case $i in
(0) set -- ;;
(1) set -- "$args0" ;;
(2) set -- "$args0" "$args1" ;;
(3) set -- "$args0" "$args1" "$args2" ;;
(4) set -- "$args0" "$args1" "$args2" "$args3" ;;
(5) set -- "$args0" "$args1" "$args2" "$args3" "$args4" ;;
(6) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" ;;
(7) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" ;;
(8) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" ;;
(9) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" "$args8" ;;
esac
fi

# Escape application args
save () {
for i do printf %s\\n "$i" | sed "s/'/'\\\\''/g;1s/^/'/;\$s/\$/' \\\\/" ; done
echo " "
}
APP_ARGS=$(save "$@")

# Collect all arguments for the java command, following the shell quoting and substitution rules
eval set -- $DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS "\"-Dorg.gradle.appname=$APP_BASE_NAME\"" -classpath "\"$CLASSPATH\"" org.gradle.wrapper.GradleWrapperMain "$APP_ARGS"

# by default we should be in the correct project dir, but when run from Finder on Mac, the cwd is wrong
if [ "$(uname)" = "Darwin" ] && [ "$HOME" = "$PWD" ]; then
cd "$(dirname "$0")"
fi

exec "$JAVACMD" "$@"
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
/*
* 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.simpleKotlin

import dagger.Component
import dagger.assisted.Assisted
import dagger.assisted.AssistedFactory
import dagger.assisted.AssistedInject
import javax.inject.Inject

// This is a regression test for https://github.com/google/dagger/issues/2309
/** A simple, skeletal application that defines an assisted inject binding. */
class AssistedInjects {
@Component
interface MyComponent {
fun fooFactory(): FooFactory

fun parameterizedFooFactory(): ParameterizedFooFactory<Bar, String>
}

class Bar @Inject constructor()

class Foo @AssistedInject constructor(val bar: Bar, @Assisted val str: String)

@AssistedFactory
interface FooFactory {
fun create(str: String): Foo
}

class ParameterizedFoo<T1, T2> @AssistedInject constructor(val t1: T1, @Assisted val t2: T2)

@AssistedFactory
interface ParameterizedFooFactory<T1, T2> {
fun create(t2: T2): ParameterizedFoo<T1, T2>
}

companion object {
// Called from SimpleApplication.main()
fun main() {
val foo: Foo = DaggerAssistedInjects_MyComponent.create().fooFactory().create("")

val parameterizedFoo: ParameterizedFoo<Bar, String> =
DaggerAssistedInjects_MyComponent.create().parameterizedFooFactory().create("")
}
}
}
Loading

0 comments on commit ef7e7a1

Please sign in to comment.