diff --git a/.changes/android-consumer-proguard-keepattributes.md b/.changes/android-consumer-proguard-keepattributes.md new file mode 100644 index 000000000000..1a1fbf9f50f9 --- /dev/null +++ b/.changes/android-consumer-proguard-keepattributes.md @@ -0,0 +1,5 @@ +--- +tauri: patch:bug +--- + +On Android, keep `RuntimeVisibleAnnotations` and `AnnotationDefault` in the `tauri-android` consumer ProGuard/R8 rules. Without them, R8 could strip the annotation metadata that reflective plugin discovery relies on (`TauriPlugin.permissions`, `@Command`/`@ActivityCallback`/`@PermissionCallback` method lookup) in a minified release build, even though the class and method `-keep` rules on their own left the plugin's classes and methods in place. Added `examples/android-r8-plugin-discovery`, an instrumented-test module that builds a minified "release" app depending only on the shipped consumer rules and asserts plugin discovery still works. diff --git a/.changes/android-consumer-proguard.md b/.changes/android-consumer-proguard.md new file mode 100644 index 000000000000..fd9a7c16055b --- /dev/null +++ b/.changes/android-consumer-proguard.md @@ -0,0 +1,23 @@ +--- +tauri: minor:deps +tauri-cli: minor:deps +"tauri-apps/cli": minor:deps +--- + +On Android, fix missing `consumer-rules.pro` file in the template. + +**IMPORTANT**: For plugin authors, update your `build.gradle.kts` file to remove the + +```kotlin + buildTypes { + release { + isMinifyEnabled = false + proguardFiles( + getDefaultProguardFile("proguard-android-optimize.txt"), + "proguard-rules.pro" + ) + } + } +``` + +section and rename your `proguard-rules.pro` to `consumer-rules.pro` to match the `consumerProguardFiles("consumer-rules.pro")` in the template. diff --git a/.changes/android-gradle-9.md b/.changes/android-gradle-9.md new file mode 100644 index 000000000000..037c33a7814e --- /dev/null +++ b/.changes/android-gradle-9.md @@ -0,0 +1,8 @@ +--- +tauri: minor:deps +tauri-build: minor:deps +tauri-cli: minor:deps +"tauri-apps/cli": minor:deps +--- + +On Android, updated the template to use Gradle v9.6.1 (`com.android.tools.build:gradle` v9.3.1) and Kotlin v2.2. Use `tauri android init` to apply the change. diff --git a/.changes/menu-command-panic-on-wrong-input.md b/.changes/menu-command-panic-on-wrong-input.md new file mode 100644 index 000000000000..9ed90161a4f7 --- /dev/null +++ b/.changes/menu-command-panic-on-wrong-input.md @@ -0,0 +1,9 @@ +--- +tauri: minor:bug +tauri-macros: minor:bug +--- + +Fix menu-related commands can panic if called with invalid menu types through `invoke` directly. + +- The internal `do_menu_item!` macro now returns `Err(crate::Error::UnexpectedMenuKind)` instead of `unreachable!()` +- Added a new error type `tauri::Error::UnexpectedMenuKind` diff --git a/.github/workflows/test-android-r8-plugin-discovery.yml b/.github/workflows/test-android-r8-plugin-discovery.yml new file mode 100644 index 000000000000..bf37482594b4 --- /dev/null +++ b/.github/workflows/test-android-r8-plugin-discovery.yml @@ -0,0 +1,115 @@ +# Copyright 2019-2024 Tauri Programme within The Commons Conservancy +# SPDX-License-Identifier: Apache-2.0 +# SPDX-License-Identifier: MIT + +# Regression test for crates/tauri/mobile/android/consumer-rules.pro: proves a +# minified ("release", isMinifyEnabled = true) app that only depends on the +# tauri-android library's own consumer ProGuard rules can still reflectively +# discover and invoke a @TauriPlugin's @Command / @ActivityCallback / +# @PermissionCallback methods and read TauriPlugin.permissions. See +# examples/android-r8-plugin-discovery/README.md. +# +# This must run on a real device/emulator: `testBuildType = "release"` means +# the instrumented test below installs and runs the actual R8-minified APK, +# which is the only way to observe R8 stripping RuntimeVisibleAnnotations / +# AnnotationDefault -- a JVM unit test never sees R8 output at all. +name: test android r8 plugin discovery + +permissions: + contents: read + +on: + pull_request: + paths: + - '.github/workflows/test-android-r8-plugin-discovery.yml' + - 'crates/tauri/mobile/android/consumer-rules.pro' + - 'crates/tauri/mobile/android/src/main/java/app/tauri/annotation/**' + - 'crates/tauri/mobile/android/src/main/java/app/tauri/plugin/**' + - 'crates/tauri/mobile/android/build.gradle.kts' + - 'examples/android-r8-plugin-discovery/**' + workflow_dispatch: + +concurrency: + group: ${{ github.workflow }}-${{ github.ref }} + cancel-in-progress: true + +jobs: + test: + # KVM-backed runner required by the emulator action. + runs-on: ubuntu-latest + # Bounds a hung/deadlocked instrumented test run (e.g. connectedReleaseAndroidTest + # never returning) to a fast failure instead of GitHub's 360-minute default. + timeout-minutes: 15 + + steps: + - uses: actions/checkout@v7 + with: + persist-credentials: false + + - uses: actions/setup-java@v5 + with: + distribution: temurin + java-version: 25 + cache: gradle + + - name: setup Android SDK + uses: android-actions/setup-android@v3 + + - name: enable KVM + run: | + echo 'KERNEL=="kvm", GROUP="kvm", MODE="0666", OPTIONS+="static_node=kvm"' | sudo tee /etc/udev/rules.d/99-kvm4all.rules + sudo udevadm control --reload-rules + sudo udevadm trigger --name-match=kvm + + - name: run minified-release plugin discovery test + # Leaves headroom inside the job's 15-minute budget for the always() + # diagnostics upload below to run after this step is cancelled. + timeout-minutes: 12 + uses: reactivecircus/android-emulator-runner@v2 + with: + working-directory: examples/android-r8-plugin-discovery + api-level: 34 + target: google_apis + arch: x86_64 + disable-animations: true + # connectedAndroidTest prints nothing to the Gradle console between + # task start and completion by default, which previously made a + # hang indistinguishable from a slow run. --info surfaces adb + # install/instrumentation progress, and the background logcat + # capture records what the device/app were doing if it hangs again. + script: | + "$ANDROID_HOME/platform-tools/adb" logcat -c + "$ANDROID_HOME/platform-tools/adb" logcat -v threadtime > "$GITHUB_WORKSPACE/r8-plugin-discovery-logcat.txt" & + logcat_pid=$! + trap 'kill "$logcat_pid" 2>/dev/null; wait "$logcat_pid" 2>/dev/null || true' EXIT + ./gradlew :app:connectedReleaseAndroidTest --stacktrace --info + + # Artifact downloads require reaching Azure Blob Storage, which some CI + # log viewers can't do -- print the diagnostics into the job log itself + # (app-relevant logcat lines + any XML test results) so they're always + # readable from the run's own log output, even after a cancellation. + - name: print diagnostics + if: always() + run: | + echo "::group::logcat (com.example.r8plugindiscovery / runtime / instrumentation lines)" + grep -E 'com\.example\.r8plugindiscovery|AndroidRuntime|FATAL EXCEPTION|ActivityManager|TestRunner|ANR |Instrumentation' \ + r8-plugin-discovery-logcat.txt 2>/dev/null | tail -n 400 || echo "(no logcat file captured)" + echo "::endgroup::" + echo "::group::androidTest XML results" + for d in examples/android-r8-plugin-discovery/app/build/outputs/androidTest-results \ + examples/android-r8-plugin-discovery/app/build/reports/androidTests; do + [ -d "$d" ] && find "$d" -type f -exec sh -c 'echo "--- $1 ---"; cat "$1"' sh {} \; + done + echo "::endgroup::" + + - name: upload diagnostics + if: always() + uses: actions/upload-artifact@v4 + with: + name: r8-plugin-discovery-diagnostics + if-no-files-found: ignore + retention-days: 5 + path: | + r8-plugin-discovery-logcat.txt + examples/android-r8-plugin-discovery/app/build/reports/androidTests/connected/** + examples/android-r8-plugin-discovery/app/build/outputs/androidTest-results/connected/** diff --git a/.github/workflows/test-android.yml b/.github/workflows/test-android.yml index ceb5d8103d90..1f193de111bc 100644 --- a/.github/workflows/test-android.yml +++ b/.github/workflows/test-android.yml @@ -57,14 +57,14 @@ jobs: - uses: actions/setup-java@v5 with: distribution: temurin - java-version: 17 - cache: 'gradle' + java-version: 25 + cache: gradle - name: Setup NDK uses: nttld/setup-ndk@v1 id: setup-ndk with: - ndk-version: r25b + ndk-version: r29 local-cache: true # TODO check after https://github.com/nttld/setup-ndk/issues/518 is fixed @@ -88,16 +88,8 @@ jobs: - uses: Swatinem/rust-cache@v2 - - name: build CLI - run: cargo build --manifest-path ./crates/tauri-cli/Cargo.toml - - - name: move CLI to cargo bin dir - if: matrix.platform != 'windows-latest' - run: mv ./target/debug/cargo-tauri $HOME/.cargo/bin - - - name: move CLI to cargo bin dir - if: matrix.platform == 'windows-latest' - run: mv ./target/debug/cargo-tauri.exe $HOME/.cargo/bin + - name: build and install CLI + run: cargo install tauri-cli --path ./crates/tauri-cli/ --locked --debug - run: pnpm i --frozen-lockfile diff --git a/Cargo.lock b/Cargo.lock index 92b6ec238cea..4f1865e26fe7 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -8682,9 +8682,9 @@ dependencies = [ [[package]] name = "spin" -version = "0.9.8" +version = "0.9.9" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "6980e8d7511241f8acf4aebddbb1ff938df5eebe98691418c4468d0b72a96a67" +checksum = "3763264f6b73151db08c50ff20d7d8a0b8796e021cdea7ceedad07b80155fa0e" [[package]] name = "spki" diff --git a/crates/tauri-build/src/mobile.rs b/crates/tauri-build/src/mobile.rs index 80f0613db8e4..4539fdbadd5e 100644 --- a/crates/tauri-build/src/mobile.rs +++ b/crates/tauri-build/src/mobile.rs @@ -151,7 +151,7 @@ pub fn generate_gradle_files(project_dir: PathBuf) -> Result<()> { let mut gradle_settings = "// THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.\n".to_string(); let mut app_build_gradle = "// THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY. -val implementation by configurations +val implementation = configurations.getByName(\"implementation\") dependencies { implementation(\"androidx.lifecycle:lifecycle-process:2.10.0\")" .to_string(); diff --git a/crates/tauri-cli/templates/mobile/android/app/build.gradle.kts b/crates/tauri-cli/templates/mobile/android/app/build.gradle.kts index 944e218eefe4..f63b3f16f039 100644 --- a/crates/tauri-cli/templates/mobile/android/app/build.gradle.kts +++ b/crates/tauri-cli/templates/mobile/android/app/build.gradle.kts @@ -1,5 +1,5 @@ -import org.jetbrains.kotlin.gradle.dsl.JvmTarget import java.util.Properties +import org.jetbrains.kotlin.gradle.dsl.JvmTarget plugins { id("com.android.application") @@ -37,17 +37,20 @@ android { isJniDebuggable = true isMinifyEnabled = false packaging { - {{~#each abi-list}} + {{#each abi-list}} jniLibs.keepDebugSymbols.add("*/{{this}}/*.so") {{/each}} } } getByName("release") { - isMinifyEnabled = true + optimization { + enable = true + } proguardFiles( - *fileTree(".") { include("**/*.pro") } - .plus(getDefaultProguardFile("proguard-android-optimize.txt")) - .toList().toTypedArray() + *fileTree(".") { + include("**/*.pro") + exclude("build/**") + }.files.toTypedArray() ) } } @@ -85,4 +88,4 @@ dependencies { androidTestImplementation("androidx.test.espresso:espresso-core:3.5.0") } -apply(from = "tauri.build.gradle.kts") +apply(from = file("tauri.build.gradle.kts")) diff --git a/crates/tauri-cli/templates/mobile/android/build.gradle.kts b/crates/tauri-cli/templates/mobile/android/build.gradle.kts index 9246cef49a47..50b46b650a44 100644 --- a/crates/tauri-cli/templates/mobile/android/build.gradle.kts +++ b/crates/tauri-cli/templates/mobile/android/build.gradle.kts @@ -4,8 +4,8 @@ buildscript { mavenCentral() } dependencies { - classpath("com.android.tools.build:gradle:8.11.0") - classpath("org.jetbrains.kotlin:kotlin-gradle-plugin:1.9.25") + classpath("com.android.tools.build:gradle:9.3.1") + classpath("org.jetbrains.kotlin:kotlin-gradle-plugin:2.2.10") {{~#each android-project-dependencies}} classpath("{{this}}"){{/each}} } diff --git a/crates/tauri-cli/templates/mobile/android/buildSrc/build.gradle.kts b/crates/tauri-cli/templates/mobile/android/buildSrc/build.gradle.kts index 5c55bba71cb5..cc18ea88c463 100644 --- a/crates/tauri-cli/templates/mobile/android/buildSrc/build.gradle.kts +++ b/crates/tauri-cli/templates/mobile/android/buildSrc/build.gradle.kts @@ -18,6 +18,6 @@ repositories { dependencies { compileOnly(gradleApi()) - implementation("com.android.tools.build:gradle:8.11.0") + implementation("com.android.tools.build:gradle:9.3.1") } diff --git a/crates/tauri-cli/templates/mobile/android/buildSrc/src/main/kotlin/BuildTask.kt b/crates/tauri-cli/templates/mobile/android/buildSrc/src/main/kotlin/BuildTask.kt index a0b4a1205a22..023d96eeed12 100644 --- a/crates/tauri-cli/templates/mobile/android/buildSrc/src/main/kotlin/BuildTask.kt +++ b/crates/tauri-cli/templates/mobile/android/buildSrc/src/main/kotlin/BuildTask.kt @@ -5,11 +5,18 @@ import org.gradle.api.GradleException import org.gradle.api.logging.LogLevel import org.gradle.api.tasks.Input import org.gradle.api.tasks.TaskAction +import javax.inject.Inject +import org.gradle.process.ExecOperations + +abstract class BuildTask : DefaultTask() { + @get:Inject + abstract val execOperations: ExecOperations -open class BuildTask : DefaultTask() { @Input var rootDirRel: String? = null @Input + var projectDir: String? = null + @Input var target: String? = null @Input var release: Boolean? = null @@ -27,7 +34,7 @@ open class BuildTask : DefaultTask() { "$executable.cmd", "$executable.bat", ) - + var lastException: Exception = e for (fallback in fallbacks) { try { @@ -50,13 +57,13 @@ open class BuildTask : DefaultTask() { val release = release ?: throw GradleException("release cannot be null") val args = listOf({{quote-and-join tauri-binary-args}}); - project.exec { - workingDir(File(project.projectDir, rootDirRel)) + execOperations.exec { + workingDir(File(projectDir, rootDirRel)) executable(executable) args(args) - if (project.logger.isEnabled(LogLevel.DEBUG)) { + if (logger.isEnabled(LogLevel.DEBUG)) { args("-vv") - } else if (project.logger.isEnabled(LogLevel.INFO)) { + } else if (logger.isEnabled(LogLevel.INFO)) { args("-v") } if (release) { diff --git a/crates/tauri-cli/templates/mobile/android/buildSrc/src/main/kotlin/RustPlugin.kt b/crates/tauri-cli/templates/mobile/android/buildSrc/src/main/kotlin/RustPlugin.kt index a13834927fb0..34aba819eddc 100644 --- a/crates/tauri-cli/templates/mobile/android/buildSrc/src/main/kotlin/RustPlugin.kt +++ b/crates/tauri-cli/templates/mobile/android/buildSrc/src/main/kotlin/RustPlugin.kt @@ -63,13 +63,14 @@ open class RustPlugin : Plugin { val targetName = targetPair.value val targetArch = archList[targetPair.index] val targetArchCapitalized = targetArch.replaceFirstChar { it.uppercase() } - val targetBuildTask = project.tasks.maybeCreate( + val targetBuildTask = project.tasks.register( "rustBuild$targetArchCapitalized$profileCapitalized", BuildTask::class.java - ).apply { + ) { group = TASK_GROUP description = "Build dynamic library in $profile mode for $targetArch" rootDirRel = config.rootDirRel + projectDir = project.projectDir.path target = targetName release = profile == "release" } diff --git a/crates/tauri-cli/templates/mobile/android/gradle.properties b/crates/tauri-cli/templates/mobile/android/gradle.properties index 2a7ec6959df9..9e6e7b95e80e 100644 --- a/crates/tauri-cli/templates/mobile/android/gradle.properties +++ b/crates/tauri-cli/templates/mobile/android/gradle.properties @@ -7,18 +7,20 @@ # Specifies the JVM arguments used for the daemon process. # The setting is particularly useful for tweaking memory settings. org.gradle.jvmargs=-Xmx2048m -Dfile.encoding=UTF-8 +org.gradle.configuration-cache=true # When configured, Gradle will run in incubating parallel mode. # This option should only be used with decoupled projects. More details, visit # http://www.gradle.org/docs/current/userguide/multi_project_builds.html#sec:decoupled_projects # org.gradle.parallel=true -# AndroidX package structure to make it clearer which packages are bundled with the -# Android operating system, and which are packaged with your app"s APK -# https://developer.android.com/topic/libraries/support-library/androidx-rn -android.useAndroidX=true # Kotlin code style for this project: "official" or "obsolete": kotlin.code.style=official -# Enables namespacing of each library's R class so that its R class includes only the -# resources declared in the library itself and none from the library's dependencies, -# thereby reducing the size of the R class for that library -android.nonTransitiveRClass=true -android.nonFinalResIds=false \ No newline at end of file + +# Our old plugin template had a bug that caused missing `consumer-rules.pro` files +# so we have to disable it for now. +# See https://github.com/tauri-apps/tauri/pull/15828#issuecomment-5199937796 +android.proguard.failOnMissingFiles=false + +# Keeping Gradle 9 compatible with current plugins +# TODO: Remove this in v3 +android.builtInKotlin=false +android.newDsl=false diff --git a/crates/tauri-cli/templates/mobile/android/gradle/wrapper/gradle-wrapper.jar b/crates/tauri-cli/templates/mobile/android/gradle/wrapper/gradle-wrapper.jar index e708b1c023ec..b1b8ef56b44f 100644 Binary files a/crates/tauri-cli/templates/mobile/android/gradle/wrapper/gradle-wrapper.jar and b/crates/tauri-cli/templates/mobile/android/gradle/wrapper/gradle-wrapper.jar differ diff --git a/crates/tauri-cli/templates/mobile/android/gradle/wrapper/gradle-wrapper.properties b/crates/tauri-cli/templates/mobile/android/gradle/wrapper/gradle-wrapper.properties index c5f9a53c27c1..b2ee479e2366 100644 --- a/crates/tauri-cli/templates/mobile/android/gradle/wrapper/gradle-wrapper.properties +++ b/crates/tauri-cli/templates/mobile/android/gradle/wrapper/gradle-wrapper.properties @@ -1,6 +1,6 @@ #Tue May 10 19:22:52 CST 2022 distributionBase=GRADLE_USER_HOME -distributionUrl=https\://services.gradle.org/distributions/gradle-8.14.3-bin.zip +distributionUrl=https\://services.gradle.org/distributions/gradle-9.6.1-bin.zip distributionPath=wrapper/dists zipStorePath=wrapper/dists zipStoreBase=GRADLE_USER_HOME diff --git a/crates/tauri-cli/templates/mobile/android/gradlew b/crates/tauri-cli/templates/mobile/android/gradlew index 4f906e0c811f..f282d03af3a0 100644 --- a/crates/tauri-cli/templates/mobile/android/gradlew +++ b/crates/tauri-cli/templates/mobile/android/gradlew @@ -1,7 +1,7 @@ -#!/usr/bin/env sh +#!/bin/sh # -# Copyright 2015 the original author or authors. +# Copyright © 2015 the original authors. # # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. @@ -15,81 +15,114 @@ # See the License for the specific language governing permissions and # limitations under the License. # +# SPDX-License-Identifier: Apache-2.0 +# ############################################################################## -## -## Gradle start up script for UN*X -## +# +# gradlew start up script for POSIX generated by Gradle. +# +# Important for running: +# +# (1) You need a POSIX-compliant shell to run this script. If your /bin/sh is +# noncompliant, but you have some other compliant shell such as ksh or +# bash, then to run this script, type that shell name before the whole +# command line, like: +# +# ksh gradlew +# +# Busybox and similar reduced shells will NOT work, because this script +# requires all of these POSIX shell features: +# * functions; +# * expansions «$var», «${var}», «${var:-default}», «${var+SET}», +# «${var#prefix}», «${var%suffix}», and «$( cmd )»; +# * compound commands having a testable exit status, especially «case»; +# * various built-in commands including «command», «set», and «ulimit». +# +# Important for patching: +# +# (2) This script targets any POSIX shell, so it avoids extensions provided +# by Bash, Ksh, etc; in particular arrays are avoided. +# +# The "traditional" practice of packing multiple parameters into a +# space-separated string is a well documented source of bugs and security +# problems, so this is (mostly) avoided, by progressively accumulating +# options in "$@", and eventually passing that to Java. +# +# Where the inherited environment variables (DEFAULT_JVM_OPTS, JAVA_OPTS, +# and GRADLE_OPTS) rely on word-splitting, this is performed explicitly; +# see the in-line comments for details. +# +# There are tweaks for specific operating systems such as AIX, CygWin, +# Darwin, MinGW, and NonStop. +# +# (3) This script is generated from the Groovy template +# https://github.com/gradle/gradle/blob/3d91ce3b8caaf77ad09f381f43615b715b53f72c/platforms/jvm/plugins-application/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt +# within the Gradle project. +# +# You can find Gradle at https://github.com/gradle/gradle/. +# ############################################################################## # 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 +app_path=$0 + +# Need this for daisy-chained symlinks. +while + APP_HOME=${app_path%"${app_path##*/}"} # leaves a trailing /; empty if no leading path + [ -h "$app_path" ] +do + ls=$( ls -ld "$app_path" ) + link=${ls#*' -> '} + case $link in #( + /*) app_path=$link ;; #( + *) app_path=$APP_HOME$link ;; + esac 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"' +# This is normally unused +# shellcheck disable=SC2034 +APP_BASE_NAME=${0##*/} +# Discard cd standard output in case $CDPATH is set (https://github.com/gradle/gradle/issues/25036) +APP_HOME=$( cd -P "${APP_HOME:-./}" > /dev/null && printf '%s\n' "$PWD" ) || exit # Use the maximum available, or set MAX_FD != -1 to use that value. -MAX_FD="maximum" +MAX_FD=maximum warn () { echo "$*" -} +} >&2 die () { echo echo "$*" echo exit 1 -} +} >&2 # 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 - ;; +case "$( uname )" in #( + CYGWIN* ) cygwin=true ;; #( + Darwin* ) darwin=true ;; #( + MSYS* | 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" + JAVACMD=$JAVA_HOME/jre/sh/java else - JAVACMD="$JAVA_HOME/bin/java" + JAVACMD=$JAVA_HOME/bin/java fi if [ ! -x "$JAVACMD" ] ; then die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME @@ -98,88 +131,118 @@ 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. + JAVACMD=java + if ! command -v java >/dev/null 2>&1 + then + 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 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 +if ! "$cygwin" && ! "$darwin" && ! "$nonstop" ; then + case $MAX_FD in #( + max*) + # In POSIX sh, ulimit -H is undefined. That's why the result is checked to see if it worked. + # shellcheck disable=SC2039,SC3045 + MAX_FD=$( ulimit -H -n ) || + warn "Could not query maximum file descriptor limit" + esac + case $MAX_FD in #( + '' | soft) :;; #( + *) + # In POSIX sh, ulimit -n is undefined. That's why the result is checked to see if it worked. + # shellcheck disable=SC2039,SC3045 + ulimit -n "$MAX_FD" || + warn "Could not set maximum file descriptor limit to $MAX_FD" + esac 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 +# Collect all arguments for the java command, stacking in reverse order: +# * args from the command line +# * the main class name +# * -classpath +# * -D...appname settings +# * --module-path (only if needed) +# * DEFAULT_JVM_OPTS, JAVA_OPTS, and GRADLE_OPTS environment variables. # For Cygwin or MSYS, switch paths to Windows format before running java -if [ "$cygwin" = "true" -o "$msys" = "true" ] ; 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 +if "$cygwin" || "$msys" ; then + APP_HOME=$( cygpath --path --mixed "$APP_HOME" ) + + JAVACMD=$( cygpath --unix "$JAVACMD" ) + # 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\"" + for arg do + if + case $arg in #( + -*) false ;; # don't mess with options #( + /?*) t=${arg#/} t=/${t%%/*} # looks like a POSIX filepath + [ -e "$t" ] ;; #( + *) false ;; + esac + then + arg=$( cygpath --path --ignore --mixed "$arg" ) fi - i=`expr $i + 1` + # Roll the args list around exactly as many times as the number of + # args, so each arg winds up back in the position where it started, but + # possibly modified. + # + # NB: a `for` loop captures its iteration list before it begins, so + # changing the positional parameters here affects neither the number of + # iterations, nor the values presented in `arg`. + shift # remove old arg + set -- "$@" "$arg" # push replacement arg 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" +# 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" "-Dfile.encoding=UTF-8"' + +# Collect all arguments for the java command: +# * DEFAULT_JVM_OPTS, JAVA_OPTS, and optsEnvironmentVar are not allowed to contain shell fragments, +# and any embedded shellness will be escaped. +# * For example: A user cannot expect ${Hostname} to be expanded, as it is an environment variable and will be +# treated as '${Hostname}' itself on the command line. + +set -- \ + "-Dorg.gradle.appname=$APP_BASE_NAME" \ + -jar "$APP_HOME/gradle/wrapper/gradle-wrapper.jar" \ + "$@" + +# Stop when "xargs" is not available. +if ! command -v xargs >/dev/null 2>&1 +then + die "xargs is not available" +fi + +# Use "xargs" to parse quoted args. +# +# With -n1 it outputs one arg per line, with the quotes and backslashes removed. +# +# In Bash we could simply go: +# +# readarray ARGS < <( xargs -n1 <<<"$var" ) && +# set -- "${ARGS[@]}" "$@" +# +# but POSIX shell has neither arrays nor command substitution, so instead we +# post-process each arg (as a line of input to sed) to backslash-escape any +# character that might be a shell metacharacter, then use eval to reverse +# that process (while maintaining the separation between arguments), and wrap +# the whole thing up as a single "set" statement. +# +# This will of course break if any of these variables contains a newline or +# an unmatched quote. +# + +eval "set -- $( + printf '%s\n' "$DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS" | + xargs -n1 | + sed ' s~[^-[:alnum:]+,./:=@_]~\\&~g; ' | + tr '\n' ' ' + )" '"$@"' exec "$JAVACMD" "$@" diff --git a/crates/tauri-cli/templates/mobile/android/gradlew.bat b/crates/tauri-cli/templates/mobile/android/gradlew.bat index 107acd32c4e6..1dd887c1a9aa 100644 --- a/crates/tauri-cli/templates/mobile/android/gradlew.bat +++ b/crates/tauri-cli/templates/mobile/android/gradlew.bat @@ -13,19 +13,22 @@ @rem See the License for the specific language governing permissions and @rem limitations under the License. @rem +@rem SPDX-License-Identifier: Apache-2.0 +@rem -@if "%DEBUG%" == "" @echo off +@if "%DEBUG%"=="" @echo off @rem ########################################################################## @rem -@rem Gradle startup script for Windows +@rem gradlew startup script for Windows @rem @rem ########################################################################## -@rem Set local scope for the variables with windows NT shell -if "%OS%"=="Windows_NT" setlocal +@rem Set local scope for the variables, and ensure extensions are enabled +setlocal EnableExtensions set DIRNAME=%~dp0 -if "%DIRNAME%" == "" set DIRNAME=. +if "%DIRNAME%"=="" set DIRNAME=. +@rem This is normally unused set APP_BASE_NAME=%~n0 set APP_HOME=%DIRNAME% @@ -33,22 +36,22 @@ set APP_HOME=%DIRNAME% for %%i in ("%APP_HOME%") do set APP_HOME=%%~fi @rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. -set DEFAULT_JVM_OPTS="-Xmx64m" "-Xms64m" +set DEFAULT_JVM_OPTS="-Xmx64m" "-Xms64m" "-Dfile.encoding=UTF-8" @rem Find java.exe if defined JAVA_HOME goto findJavaFromJavaHome set JAVA_EXE=java.exe %JAVA_EXE% -version >NUL 2>&1 -if "%ERRORLEVEL%" == "0" goto execute +if %ERRORLEVEL% equ 0 goto execute -echo. -echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. -echo. -echo Please set the JAVA_HOME variable in your environment to match the -echo location of your Java installation. +echo. 1>&2 +echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 1>&2 +echo. 1>&2 +echo Please set the JAVA_HOME variable in your environment to match the 1>&2 +echo location of your Java installation. 1>&2 -goto fail +"%COMSPEC%" /c exit 1 :findJavaFromJavaHome set JAVA_HOME=%JAVA_HOME:"=% @@ -56,34 +59,24 @@ set JAVA_EXE=%JAVA_HOME%/bin/java.exe if exist "%JAVA_EXE%" goto execute -echo. -echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% -echo. -echo Please set the JAVA_HOME variable in your environment to match the -echo location of your Java installation. +echo. 1>&2 +echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% 1>&2 +echo. 1>&2 +echo Please set the JAVA_HOME variable in your environment to match the 1>&2 +echo location of your Java installation. 1>&2 -goto fail +"%COMSPEC%" /c exit 1 :execute @rem Setup the command line -set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar - - -@rem Execute Gradle -"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %* - -:end -@rem End local scope for the variables with windows NT shell -if "%ERRORLEVEL%"=="0" goto mainEnd -:fail -rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of -rem the _cmd.exe /c_ return code! -if not "" == "%GRADLE_EXIT_CONSOLE%" exit 1 -exit /b 1 -:mainEnd -if "%OS%"=="Windows_NT" endlocal +@rem Execute gradlew +@rem endlocal doesn't take effect until after the line is parsed and variables are expanded +@rem which allows us to clear the local environment before executing the java command +endlocal & "%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -jar "%APP_HOME%\gradle\wrapper\gradle-wrapper.jar" %* & call :exitWithErrorLevel -:omega +:exitWithErrorLevel +@rem Use "%COMSPEC%" /c exit to allow operators to work properly in scripts +"%COMSPEC%" /c exit %ERRORLEVEL% diff --git a/crates/tauri-cli/templates/plugin/android/build.gradle.kts b/crates/tauri-cli/templates/plugin/android/build.gradle.kts index b999d6b65e3d..43f4fc1fb15b 100644 --- a/crates/tauri-cli/templates/plugin/android/build.gradle.kts +++ b/crates/tauri-cli/templates/plugin/android/build.gradle.kts @@ -16,15 +16,6 @@ android { consumerProguardFiles("consumer-rules.pro") } - buildTypes { - release { - isMinifyEnabled = false - proguardFiles( - getDefaultProguardFile("proguard-android-optimize.txt"), - "proguard-rules.pro" - ) - } - } compileOptions { sourceCompatibility = JavaVersion.VERSION_1_8 targetCompatibility = JavaVersion.VERSION_1_8 diff --git a/crates/tauri-cli/templates/plugin/android/proguard-rules.pro b/crates/tauri-cli/templates/plugin/android/consumer-rules.pro similarity index 93% rename from crates/tauri-cli/templates/plugin/android/proguard-rules.pro rename to crates/tauri-cli/templates/plugin/android/consumer-rules.pro index 481bb4348141..895c7b83ca9a 100644 --- a/crates/tauri-cli/templates/plugin/android/proguard-rules.pro +++ b/crates/tauri-cli/templates/plugin/android/consumer-rules.pro @@ -1,6 +1,6 @@ # Add project specific ProGuard rules here. # You can control the set of applied configuration files using the -# proguardFiles setting in build.gradle. +# consumerProguardFiles setting in build.gradle. # # For more details, see # http://developer.android.com/guide/developing/tools/proguard.html diff --git a/crates/tauri-macros/src/lib.rs b/crates/tauri-macros/src/lib.rs index 034f991447ab..7b2328edbcd4 100644 --- a/crates/tauri-macros/src/lib.rs +++ b/crates/tauri-macros/src/lib.rs @@ -3,6 +3,8 @@ // SPDX-License-Identifier: MIT //! Create macros for `tauri::Context`, invoke handler and commands leveraging the `tauri-codegen` crate. +//! +//! Don't depend on this crate directly, use the re-exported types from tauri instead. #![doc( html_logo_url = "https://github.com/tauri-apps/tauri/raw/dev/.github/icon.png", @@ -117,7 +119,7 @@ pub fn default_runtime(attributes: TokenStream, input: TokenStream) -> TokenStre /// do_menu_item!(resources_table, rid, kind, |i| i.set_text(text), !Check | Submenu); /// ``` /// -/// #### Example +/// ## Examples /// /// ```ignore /// let rid = 23; @@ -151,9 +153,10 @@ pub fn default_runtime(attributes: TokenStream, input: TokenStream) -> TokenStre /// let i = resources_table.get::>(rid)?; /// i.set_text(text) /// } -/// _ => unreachable!(), +/// _ => return Err(crate::Error::UnexpectedMenuKind), /// } /// ``` +#[doc(hidden)] #[proc_macro] pub fn do_menu_item(input: TokenStream) -> TokenStream { let tokens = parse_macro_input!(input as menu::DoMenuItemInput); diff --git a/crates/tauri-macros/src/menu.rs b/crates/tauri-macros/src/menu.rs index 1e230d152324..8ab2b9b92723 100644 --- a/crates/tauri-macros/src/menu.rs +++ b/crates/tauri-macros/src/menu.rs @@ -130,7 +130,7 @@ pub fn do_menu_item(input: DoMenuItemInput) -> TokenStream { #expr } )* - _ => unreachable!(), + _ => return Err(crate::Error::UnexpectedMenuKind), } } } diff --git a/crates/tauri/mobile/android/build.gradle.kts b/crates/tauri/mobile/android/build.gradle.kts index e633a072f429..8333f90d8ba3 100644 --- a/crates/tauri/mobile/android/build.gradle.kts +++ b/crates/tauri/mobile/android/build.gradle.kts @@ -13,18 +13,9 @@ android { minSdk = 21 testInstrumentationRunner = "androidx.test.runner.AndroidJUnitRunner" - consumerProguardFiles("proguard-rules.pro") + consumerProguardFiles("consumer-rules.pro") } - buildTypes { - release { - isMinifyEnabled = false - proguardFiles( - getDefaultProguardFile("proguard-android-optimize.txt"), - "proguard-rules.pro" - ) - } - } compileOptions { sourceCompatibility = JavaVersion.VERSION_1_8 targetCompatibility = JavaVersion.VERSION_1_8 diff --git a/crates/tauri/mobile/android/consumer-rules.pro b/crates/tauri/mobile/android/consumer-rules.pro new file mode 100644 index 000000000000..fc9eaec9b7ae --- /dev/null +++ b/crates/tauri/mobile/android/consumer-rules.pro @@ -0,0 +1,62 @@ +-keep class app.tauri.** { + @app.tauri.JniMethod public ; + native ; +} + +# R8 strips RuntimeVisibleAnnotations and AnnotationDefault from class files by +# default. Plugin discovery is entirely reflection-based (TauriPlugin.permissions, +# Command/ActivityCallback/PermissionCallback method lookup via getAnnotation()/ +# isAnnotationPresent() in PluginHandle.indexMethods()), so losing these attributes +# silently breaks every plugin in a minified release build even though the -keep +# rules below still preserve the classes and methods themselves. +-keepattributes RuntimeVisibleAnnotations,AnnotationDefault + +-keep class app.tauri.plugin.JSArray { + public (...); +} + +-keepclassmembers class org.json.JSONArray { + public put(...); +} + +-keep class app.tauri.plugin.JSObject { + public (...); + public put(...); +} + +# Invoke is constructed directly (not via reflection) by any code that calls +# into a plugin's Command/ActivityCallback/PermissionCallback methods, which +# can live outside this library's own compilation unit (a plugin author's +# module, a test module, ...). Without an explicit keep, R8 can determine the +# constructor has no caller *it* can see and shrink/inline it away, and +# ObjectMapper is a real parameter type of that constructor -- both produce a +# NoSuchMethodError at the external call site even though the source matches. +-keep class app.tauri.plugin.Invoke { + public (...); +} + +-keep class com.fasterxml.jackson.databind.ObjectMapper { *; } + +-keep @app.tauri.annotation.TauriPlugin public class * { + @app.tauri.annotation.Command public ; + @app.tauri.annotation.PermissionCallback ; + @app.tauri.annotation.ActivityCallback ; + @app.tauri.annotation.Permission ; + public (...); +} + +-keep @app.tauri.annotation.InvokeArg public class * { + *; +} + +-keep @com.fasterxml.jackson.databind.annotation.JsonDeserialize public class * { + *; +} + +-keep @com.fasterxml.jackson.databind.annotation.JsonSerialize public class * { + *; +} + +-keep class * extends com.fasterxml.jackson.databind.JsonDeserializer { *; } + +-keep class * extends com.fasterxml.jackson.databind.JsonSerializer { *; } diff --git a/crates/tauri/mobile/android/proguard-rules.pro b/crates/tauri/mobile/android/proguard-rules.pro deleted file mode 100644 index e21b5beb4693..000000000000 --- a/crates/tauri/mobile/android/proguard-rules.pro +++ /dev/null @@ -1,41 +0,0 @@ --keep class app.tauri.** { - @app.tauri.JniMethod public ; - native ; -} - --keep class app.tauri.plugin.JSArray { - public (...); -} - --keepclassmembers class org.json.JSONArray { - public put(...); -} - --keep class app.tauri.plugin.JSObject { - public (...); - public put(...); -} - --keep @app.tauri.annotation.TauriPlugin public class * { - @app.tauri.annotation.Command public ; - @app.tauri.annotation.PermissionCallback ; - @app.tauri.annotation.ActivityCallback ; - @app.tauri.annotation.Permission ; - public (...); -} - --keep @app.tauri.annotation.InvokeArg public class * { - *; -} - --keep @com.fasterxml.jackson.databind.annotation.JsonDeserialize public class * { - *; -} - --keep @com.fasterxml.jackson.databind.annotation.JsonSerialize public class * { - *; -} - --keep class * extends com.fasterxml.jackson.databind.JsonDeserializer { *; } - --keep class * extends com.fasterxml.jackson.databind.JsonSerializer { *; } diff --git a/crates/tauri/src/error.rs b/crates/tauri/src/error.rs index 405a9b48dd1e..2f86acc1ffd5 100644 --- a/crates/tauri/src/error.rs +++ b/crates/tauri/src/error.rs @@ -166,6 +166,9 @@ pub enum Error { /// tokio oneshot channel failed to receive message #[error(transparent)] TokioOneshotRecv(#[from] tokio::sync::oneshot::error::RecvError), + /// Unexpected menu kind passed to menu/tray plugin command + #[error("Unexpected menu kind")] + UnexpectedMenuKind, } impl From for Error { diff --git a/crates/tauri/src/menu/plugin.rs b/crates/tauri/src/menu/plugin.rs index 7fa3a3f277be..63a74374869f 100644 --- a/crates/tauri/src/menu/plugin.rs +++ b/crates/tauri/src/menu/plugin.rs @@ -499,7 +499,7 @@ fn append( item.with_item(&webview, &resources_table, |i| submenu.append(i))?; } } - _ => return Err(anyhow::anyhow!("unexpected menu item kind").into()), + _ => return Err(crate::Error::UnexpectedMenuKind), }; Ok(()) @@ -526,7 +526,7 @@ fn prepend( item.with_item(&webview, &resources_table, |i| submenu.prepend(i))?; } } - _ => return Err(anyhow::anyhow!("unexpected menu item kind").into()), + _ => return Err(crate::Error::UnexpectedMenuKind), }; Ok(()) @@ -556,7 +556,7 @@ fn insert( position += 1 } } - _ => return Err(anyhow::anyhow!("unexpected menu item kind").into()), + _ => return Err(crate::Error::UnexpectedMenuKind), }; Ok(()) @@ -581,7 +581,7 @@ fn remove( do_menu_item!(resources_table, item_rid, item_kind, |i| submenu .remove(&*i))?; } - _ => return Err(anyhow::anyhow!("unexpected menu item kind").into()), + _ => return Err(crate::Error::UnexpectedMenuKind), }; Ok(()) @@ -622,7 +622,7 @@ fn remove_at( return Ok(Some(make_item_resource!(resources_table, item))); } } - _ => return Err(anyhow::anyhow!("unexpected menu item kind").into()), + _ => return Err(crate::Error::UnexpectedMenuKind), }; Ok(None) @@ -638,7 +638,7 @@ fn items( let items = match kind { ItemKind::Menu => resources_table.get::>(rid)?.items()?, ItemKind::Submenu => resources_table.get::>(rid)?.items()?, - _ => return Err(anyhow::anyhow!("unexpected menu item kind").into()), + _ => return Err(crate::Error::UnexpectedMenuKind), }; Ok( @@ -670,7 +670,7 @@ fn get( return Ok(Some(make_item_resource!(resources_table, item))); } } - _ => return Err(anyhow::anyhow!("unexpected menu item kind").into()), + _ => return Err(crate::Error::UnexpectedMenuKind), }; Ok(None) @@ -700,7 +700,7 @@ async fn popup( let submenu = resources_table.get::>(rid)?; submenu.popup_inner(window, at)?; } - _ => return Err(anyhow::anyhow!("unexpected menu item kind").into()), + _ => return Err(crate::Error::UnexpectedMenuKind), }; } diff --git a/crates/tauri/src/tray/plugin.rs b/crates/tauri/src/tray/plugin.rs index f2d74ca5adda..25ecc4501046 100644 --- a/crates/tauri/src/tray/plugin.rs +++ b/crates/tauri/src/tray/plugin.rs @@ -62,7 +62,7 @@ fn new( let submenu = resources_table.get::>(rid)?; builder = builder.menu(&*submenu); } - _ => return Err(anyhow::anyhow!("unexpected menu item kind").into()), + _ => return Err(crate::Error::UnexpectedMenuKind), }; } if let Some(icon) = options.icon { @@ -144,7 +144,7 @@ fn set_menu( let submenu = webview_resources_table.get::>(rid)?; tray.set_menu(Some((*submenu).clone()))?; } - _ => return Err(anyhow::anyhow!("unexpected menu item kind").into()), + _ => return Err(crate::Error::UnexpectedMenuKind), }; } else { tray.set_menu(None::>)?; diff --git a/examples/android-r8-plugin-discovery/.gitignore b/examples/android-r8-plugin-discovery/.gitignore new file mode 100644 index 000000000000..48504a8150ed --- /dev/null +++ b/examples/android-r8-plugin-discovery/.gitignore @@ -0,0 +1,4 @@ +/build +/app/build +/.gradle +local.properties diff --git a/examples/android-r8-plugin-discovery/README.md b/examples/android-r8-plugin-discovery/README.md new file mode 100644 index 000000000000..61e212173ab0 --- /dev/null +++ b/examples/android-r8-plugin-discovery/README.md @@ -0,0 +1,84 @@ +# android-r8-plugin-discovery + +Regression test for `crates/tauri/mobile/android/consumer-rules.pro`. + +## What this is testing + +Tauri's Android plugin dispatch (`app.tauri.plugin.PluginHandle`) is entirely +reflection-based: it reads the `@TauriPlugin` annotation (including its +`permissions` array) off a plugin instance's class, and finds `@Command` / +`@ActivityCallback` / `@PermissionCallback` methods via +`Method.isAnnotationPresent` / `getAnnotation`. R8, by default, strips the +`RuntimeVisibleAnnotations` and `AnnotationDefault` class-file attributes that +this depends on, even when `-keep` rules elsewhere preserve the classes and +methods themselves untouched and unrenamed. The result is a plugin that looks +intact after minification but silently fails to be discovered or dispatches +to the wrong (or no) method at runtime. + +`crates/tauri/mobile/android/consumer-rules.pro` ships +`-keepattributes RuntimeVisibleAnnotations,AnnotationDefault` specifically to +prevent this. This module proves that rule is present and sufficient, using a +real R8-minified build rather than a source-level assertion. + +## Why this is a separate Gradle project + +This is a standalone Gradle project, not something scaffolded by +`cargo tauri android init` — it doesn't need the Rust/NDK toolchain at all, +only the Android SDK. `settings.gradle.kts` includes `:tauri-android` by +pointing directly at `../../crates/tauri/mobile/android`, the same way +`crates/tauri-build/src/mobile.rs::generate_gradle_files` wires a real Tauri +app's `tauri.settings.gradle` — so the `:app` module receives +`consumer-rules.pro` exactly the way a real consuming app would (via +`consumerProguardFiles`), not a copy of it. + +## Why this must run on a device/emulator, not as a unit test + +`app/build.gradle.kts` sets `isMinifyEnabled = true` and +`testBuildType = "release"` for the `release` build type (signed with the +debug key purely so the test APK can be installed — this app is never +distributed). The test in `app/src/androidTest/.../ReflectivePluginDiscoveryTest.kt` +is an instrumented test, deliberately _not_ a JVM unit test under +`app/src/test`: AGP unit tests compile and run straight from Kotlin sources +and never pass through R8, so a unit test making the same assertions would +pass identically whether or not `consumer-rules.pro` had the keep rule at +all, proving nothing. Only `connectedReleaseAndroidTest` installs and +exercises the actual minified APK. + +`app/proguard-rules.pro`, the app module's own (non-consumer) ProGuard file, +deliberately adds no keep rule of its own for the sample plugin. If it needed +one for the test to pass, that would mean the library's consumer rule is not +actually sufficient on its own — the exact regression this module exists to +catch. + +The app and sample plugin live under `com.example.r8plugindiscovery`, not +`app.tauri.*`. `consumer-rules.pro`'s first rule +(`-keep class app.tauri.** { ... }`) keeps every class under that package +unrenamed regardless of the `AnnotationDefault`/`RuntimeVisibleAnnotations` +fix, so putting the test app under `app.tauri.*` would have made it +ambiguous whether a passing test was actually exercising the keep rule under +test or just riding along on that unrelated wildcard. + +## Running locally + +Requires an Android SDK and a running device or emulator (`adb devices` shows +at least one). + +```sh +./gradlew :app:connectedReleaseAndroidTest +``` + +## CI + +`.github/workflows/test-android-r8-plugin-discovery.yml` runs this on a +GitHub-hosted emulator via `reactivecircus/android-emulator-runner`, gated on +changes to `consumer-rules.pro`, the plugin annotation/dispatch sources, and +this directory. + +> **Note (authoring provenance):** this module was authored and reviewed for +> correctness against `PluginHandle`'s actual reflection calls, but has not +> been executed locally — the environment it was written in had no Android +> SDK, Gradle, or JDK 17+ available. The CI workflow above is the first real +> execution of this build. If it fails, the most likely culprits are Gradle +> module wiring (`settings.gradle.kts` / `build.gradle.kts`) rather than the +> underlying `consumer-rules.pro` fix, which mirrors documented R8/ProGuard +> behavior. diff --git a/examples/android-r8-plugin-discovery/app/build.gradle.kts b/examples/android-r8-plugin-discovery/app/build.gradle.kts new file mode 100644 index 000000000000..b4d3a184d182 --- /dev/null +++ b/examples/android-r8-plugin-discovery/app/build.gradle.kts @@ -0,0 +1,80 @@ +// Copyright 2019-2024 Tauri Programme within The Commons Conservancy +// SPDX-License-Identifier: Apache-2.0 +// SPDX-License-Identifier: MIT + +import org.jetbrains.kotlin.gradle.dsl.JvmTarget + +plugins { + id("com.android.application") + id("org.jetbrains.kotlin.android") +} + +android { + // Deliberately outside the app.tauri.* namespace: consumer-rules.pro's + // first rule (`-keep class app.tauri.** { ... }`) would otherwise + // partially protect this module's own classes and muddy what the test is + // actually proving. See README.md. + namespace = "com.example.r8plugindiscovery" + compileSdk = 36 + + defaultConfig { + applicationId = "com.example.r8plugindiscovery" + minSdk = 21 + targetSdk = 36 + versionCode = 1 + versionName = "1.0" + + testInstrumentationRunner = "androidx.test.runner.AndroidJUnitRunner" + // testBuildType = "release" below means this module's androidTest APK + // is minified too, using its own R8 pass separate from the app APK's + // proguardFiles -- it needs the same rules. + testProguardFiles("proguard-rules.pro") + } + + buildTypes { + getByName("release") { + isMinifyEnabled = true + isShrinkResources = false + proguardFiles( + getDefaultProguardFile("proguard-android-optimize.txt"), + "proguard-rules.pro" + ) + // This module is never distributed -- it only exists to exercise R8 + // output. Signing "release" with the debug key lets `connectedCheck` + // install this build type on a device/emulator without a real + // signing config. + signingConfig = signingConfigs.getByName("debug") + } + getByName("debug") { + isMinifyEnabled = false + } + } + + // The androidTest below must run against the minified build to mean + // anything: it is the regression test for + // crates/tauri/mobile/android/consumer-rules.pro (see app/README.md). + testBuildType = "release" + + compileOptions { + sourceCompatibility = JavaVersion.VERSION_1_8 + targetCompatibility = JavaVersion.VERSION_1_8 + } +} + +kotlin { + compilerOptions { + jvmTarget = JvmTarget.JVM_1_8 + } +} + +dependencies { + // The real library, not a copy or a stub -- see ../settings.gradle.kts. + implementation(project(":tauri-android")) + + implementation("androidx.appcompat:appcompat:1.7.1") + + androidTestImplementation("androidx.test.ext:junit:1.1.5") + androidTestImplementation("androidx.test:runner:1.5.2") + androidTestImplementation("androidx.test:core:1.5.0") + androidTestImplementation("com.fasterxml.jackson.core:jackson-databind:2.15.3") +} diff --git a/examples/android-r8-plugin-discovery/app/proguard-rules.pro b/examples/android-r8-plugin-discovery/app/proguard-rules.pro new file mode 100644 index 000000000000..f673fc2eaa38 --- /dev/null +++ b/examples/android-r8-plugin-discovery/app/proguard-rules.pro @@ -0,0 +1,33 @@ +# Deliberately near-empty. +# +# This app exists to prove that crates/tauri/mobile/android/consumer-rules.pro, +# applied transitively from the :tauri-android dependency, is by itself +# sufficient to keep reflective Tauri plugin discovery working under R8 +# minification (see README.md). It must NOT add its own -keep rules for +# DiscoveryTestPlugin, its annotations, or its callback methods -- if this file +# needed one to make ReflectivePluginDiscoveryTest pass, that would mean the +# shipped consumer-rules.pro is not actually sufficient for a real consuming +# app, which is exactly the class of bug this module is here to catch. +-keepattributes SourceFile,LineNumberTable + +# Unrelated to the thing under test: androidx.test's tracing code references +# a compile-only errorprone annotation that isn't on the runtime classpath. +-dontwarn com.google.errorprone.annotations.** + +# Unrelated to the thing under test: AndroidJUnitRunner.onCreate() calls into +# androidx.tracing.Trace directly, but nothing else in this app references +# it, so R8 strips it as unused. Without this the instrumentation process +# crashes with NoClassDefFoundError before the test runner can even attach, +# which `am instrument` reports as a hang rather than a clean failure. +-keep class androidx.tracing.Trace { *; } + +# Unrelated to the thing under test: androidx.test's own IO helpers +# (FileTestStorage, OutputDirCalculator, ...) are Kotlin-compiled and use +# stdlib features (lambdas, `by lazy`, etc.) that resolve to various +# kotlin.* / kotlin.jvm.internal.* classes at runtime. Nothing else in this +# app is Kotlin-compiled androidx.test code, so R8 strips whichever of these +# aren't directly referenced elsewhere as unused, crashing the process one +# missing class at a time (androidx.tracing.Trace, then kotlin.jvm.internal +# .Lambda, then kotlin.LazyKt, ...). Keep the whole runtime support package +# rather than chasing each one individually. +-keep class kotlin.** { *; } diff --git a/examples/android-r8-plugin-discovery/app/src/androidTest/java/com/example/r8plugindiscovery/ReflectivePluginDiscoveryTest.kt b/examples/android-r8-plugin-discovery/app/src/androidTest/java/com/example/r8plugindiscovery/ReflectivePluginDiscoveryTest.kt new file mode 100644 index 000000000000..154bfcc1b998 --- /dev/null +++ b/examples/android-r8-plugin-discovery/app/src/androidTest/java/com/example/r8plugindiscovery/ReflectivePluginDiscoveryTest.kt @@ -0,0 +1,195 @@ +// Copyright 2019-2024 Tauri Programme within The Commons Conservancy +// SPDX-License-Identifier: Apache-2.0 +// SPDX-License-Identifier: MIT + +package com.example.r8plugindiscovery + +import androidx.activity.result.ActivityResult +import androidx.test.core.app.ActivityScenario +import androidx.test.ext.junit.runners.AndroidJUnit4 +import app.tauri.annotation.ActivityCallback +import app.tauri.annotation.Command +import app.tauri.annotation.PermissionCallback +import app.tauri.annotation.TauriPlugin +import app.tauri.plugin.Invoke +import app.tauri.plugin.Plugin +import com.example.r8plugindiscovery.plugin.ACTIVITY_CALLBACK_RESULT +import com.example.r8plugindiscovery.plugin.DiscoveryDefaultsPlugin +import com.example.r8plugindiscovery.plugin.DiscoveryTestPlugin +import com.example.r8plugindiscovery.plugin.LOCATION_PERMISSION +import com.example.r8plugindiscovery.plugin.PERMISSION_CALLBACK_RESULT +import com.example.r8plugindiscovery.plugin.PING_RESULT +import com.fasterxml.jackson.databind.ObjectMapper +import org.json.JSONObject +import org.junit.Assert.assertEquals +import org.junit.Assert.assertNotNull +import org.junit.Assert.assertTrue +import org.junit.Test +import org.junit.runner.RunWith +import java.lang.reflect.Method + +/** + * Regression test for crates/tauri/mobile/android/consumer-rules.pro + * (CodeRabbit finding on PR #17: R8 can strip `RuntimeVisibleAnnotations` and + * `AnnotationDefault`, which breaks reflective plugin discovery even though + * the classes/methods themselves survive the `-keep` rules). + * + * This is an `androidTest`, not a JVM unit test, and the module's + * `testBuildType` is pinned to `"release"` (app/build.gradle.kts): unit tests + * run straight from compiled Kotlin and never see R8 output, so they would + * pass identically whether or not the keep rule exists. Only an instrumented + * test that installs and runs the actual minified "release" APK exercises the + * bug this guards against. + * + * Every reflective call below is copy-matched to + * `app.tauri.plugin.PluginHandle` (`init` / `indexMethods()` / `invoke()`) so + * this test fails exactly when real plugin loading would fail, not on some + * looser approximation of it. + */ +@RunWith(AndroidJUnit4::class) +class ReflectivePluginDiscoveryTest { + + @Test + fun tauriPluginAnnotationAndPermissionsSurviveMinification() { + val scenario = ActivityScenario.launch(MainActivity::class.java) + scenario.onActivity { activity -> + val instance = DiscoveryTestPlugin(activity) + + // Mirrors PluginHandle.init: `instance.javaClass.getAnnotation(TauriPlugin::class.java)` + val annotation = instance.javaClass.getAnnotation(TauriPlugin::class.java) + assertNotNull( + "@TauriPlugin annotation was stripped by R8 -- RuntimeVisibleAnnotations was not kept", + annotation + ) + + val permissions = annotation!!.permissions + assertEquals(1, permissions.size) + assertEquals(LOCATION_PERMISSION, permissions[0].strings[0]) + // `alias` was never set on this @Permission -- reading it exercises + // AnnotationDefault for a nested annotation member. + assertEquals( + "Permission.alias default value was lost -- AnnotationDefault was not kept", + "", + permissions[0].alias + ) + } + scenario.close() + } + + @Test + fun omittedTauriPluginPermissionsDefaultSurvivesMinification() { + val scenario = ActivityScenario.launch(MainActivity::class.java) + scenario.onActivity { activity -> + val instance = DiscoveryDefaultsPlugin(activity) + val annotation = instance.javaClass.getAnnotation(TauriPlugin::class.java) + assertNotNull(annotation) + + // `@TauriPlugin` was used with no `permissions = [...]` at all, so this + // reads the annotation *interface's* AnnotationDefault attribute for + // `permissions`, not a value baked into the call site. Without + // AnnotationDefault this throws IncompleteAnnotationException instead + // of returning the declared default ([]). + val permissions = annotation!!.permissions + assertTrue( + "TauriPlugin.permissions default value was lost -- AnnotationDefault was not kept", + permissions.isEmpty() + ) + } + scenario.close() + } + + @Test + fun commandMethodIsDiscoverableAndInvokable() { + val scenario = ActivityScenario.launch(MainActivity::class.java) + scenario.onActivity { activity -> + val instance = DiscoveryTestPlugin(activity) + + val method = findMethodOrFail(instance, Command::class.java) + val response = invokeAndCapture(instance, method, argsJson = "{}") + + assertEquals(PING_RESULT, JSONObject(response).getString("value")) + } + scenario.close() + } + + @Test + fun permissionCallbackMethodIsDiscoverableAndInvokable() { + val scenario = ActivityScenario.launch(MainActivity::class.java) + scenario.onActivity { activity -> + val instance = DiscoveryTestPlugin(activity) + + val method = findMethodOrFail(instance, PermissionCallback::class.java) + val response = invokeAndCapture(instance, method, argsJson = "{}") + + assertEquals(PERMISSION_CALLBACK_RESULT, JSONObject(response).getString("value")) + } + scenario.close() + } + + @Test + fun activityCallbackMethodIsDiscoverableAndInvokable() { + val scenario = ActivityScenario.launch(MainActivity::class.java) + scenario.onActivity { activity -> + val instance = DiscoveryTestPlugin(activity) + + val method = findMethodOrFail(instance, ActivityCallback::class.java) + + var captured: String? = null + val invoke = newInvoke("{}") { captured = it } + method.isAccessible = true + // ActivityCallback methods take (Invoke, ActivityResult) -- see + // PluginHandle.startActivityForResult. + method.invoke(instance, invoke, ActivityResult(7, null)) + + assertEquals(ACTIVITY_CALLBACK_RESULT, JSONObject(captured!!).getString("value")) + assertEquals(7, JSONObject(captured!!).getInt("resultCode")) + } + scenario.close() + } + + /** + * Mirrors `PluginHandle.indexMethods()`: walk `declaredMethods` and select + * by `isAnnotationPresent`. Fails the test (not silently returns null) if + * the annotation attribute was stripped, since that's the actual failure + * mode a real app hits. + */ + private fun findMethodOrFail( + instance: Plugin, + annotationClass: Class + ): Method { + val found = instance.javaClass.declaredMethods.firstOrNull { + it.isAnnotationPresent(annotationClass) + } + assertNotNull( + "No method annotated @${annotationClass.simpleName} was discoverable on " + + "${instance.javaClass.name} -- RuntimeVisibleAnnotations was not kept", + found + ) + return found!! + } + + /** Mirrors `PluginHandle.invoke()`: `method.isAccessible = true; method(instance, invoke)`. */ + private fun invokeAndCapture(instance: Plugin, method: Method, argsJson: String): String { + var captured: String? = null + val invoke = newInvoke(argsJson) { captured = it } + method.isAccessible = true + method.invoke(instance, invoke) + assertNotNull("Method ${method.name} did not resolve/reject the Invoke", captured) + return captured!! + } + + private fun newInvoke(argsJson: String, onResponse: (String) -> Unit): Invoke { + val resolveCallbackId = 1L + return Invoke( + id = 0L, + command = "test", + callback = resolveCallbackId, + error = 2L, + sendResponse = { callbackId, data -> + if (callbackId == resolveCallbackId) onResponse(data) + }, + argsJson = argsJson, + jsonMapper = ObjectMapper() + ) + } +} diff --git a/examples/android-r8-plugin-discovery/app/src/main/AndroidManifest.xml b/examples/android-r8-plugin-discovery/app/src/main/AndroidManifest.xml new file mode 100644 index 000000000000..629554874b89 --- /dev/null +++ b/examples/android-r8-plugin-discovery/app/src/main/AndroidManifest.xml @@ -0,0 +1,20 @@ + + + + + + + + + + + + + + + diff --git a/examples/android-r8-plugin-discovery/app/src/main/java/com/example/r8plugindiscovery/MainActivity.kt b/examples/android-r8-plugin-discovery/app/src/main/java/com/example/r8plugindiscovery/MainActivity.kt new file mode 100644 index 000000000000..eadf38ed3e3c --- /dev/null +++ b/examples/android-r8-plugin-discovery/app/src/main/java/com/example/r8plugindiscovery/MainActivity.kt @@ -0,0 +1,19 @@ +// Copyright 2019-2024 Tauri Programme within The Commons Conservancy +// SPDX-License-Identifier: Apache-2.0 +// SPDX-License-Identifier: MIT + +package com.example.r8plugindiscovery + +import android.os.Bundle +import androidx.appcompat.app.AppCompatActivity + +/** + * A live [android.app.Activity] for the androidTest to instantiate + * [com.example.r8plugindiscovery.plugin.DiscoveryTestPlugin] against, + * mirroring how a real Tauri plugin is constructed with `Plugin(activity)`. + */ +class MainActivity : AppCompatActivity() { + override fun onCreate(savedInstanceState: Bundle?) { + super.onCreate(savedInstanceState) + } +} diff --git a/examples/android-r8-plugin-discovery/app/src/main/java/com/example/r8plugindiscovery/plugin/DiscoveryTestPlugin.kt b/examples/android-r8-plugin-discovery/app/src/main/java/com/example/r8plugindiscovery/plugin/DiscoveryTestPlugin.kt new file mode 100644 index 000000000000..573eca0e3f03 --- /dev/null +++ b/examples/android-r8-plugin-discovery/app/src/main/java/com/example/r8plugindiscovery/plugin/DiscoveryTestPlugin.kt @@ -0,0 +1,86 @@ +// Copyright 2019-2024 Tauri Programme within The Commons Conservancy +// SPDX-License-Identifier: Apache-2.0 +// SPDX-License-Identifier: MIT + +package com.example.r8plugindiscovery.plugin + +import android.app.Activity +import androidx.activity.result.ActivityResult +import app.tauri.annotation.ActivityCallback +import app.tauri.annotation.Command +import app.tauri.annotation.Permission +import app.tauri.annotation.PermissionCallback +import app.tauri.annotation.TauriPlugin +import app.tauri.plugin.Invoke +import app.tauri.plugin.JSObject +import app.tauri.plugin.Plugin + +// Markers the androidTest asserts on. If these constants disappeared from the +// resolved output (renamed, inlined wrong, etc.) the test would fail loudly +// rather than silently pass on a no-op. +const val PING_RESULT = "pong-from-r8-minified-plugin" +const val ACTIVITY_CALLBACK_RESULT = "activity-callback-ran" +const val PERMISSION_CALLBACK_RESULT = "permission-callback-ran" +const val LOCATION_PERMISSION = "android.permission.ACCESS_COARSE_LOCATION" + +/** + * Exercises every reflective-discovery surface `consumer-rules.pro` keeps for + * a Tauri plugin: + * - `@TauriPlugin` with an explicit `permissions` array (nested `@Permission` + * annotations), read via `instance.javaClass.getAnnotation(TauriPlugin::class.java)` + * exactly like `PluginHandle.init`. + * - `@Command`, `@ActivityCallback`, `@PermissionCallback` methods, discovered + * via `Method.isAnnotationPresent` / `getAnnotation` exactly like + * `PluginHandle.indexMethods()`, and then invoked via `Method.invoke` + * exactly like `PluginHandle.invoke()`. + * + * One `@Permission` below omits `alias`, deliberately relying on its default + * value (`""`) so the test also covers `AnnotationDefault`, not just + * `RuntimeVisibleAnnotations`. + */ +@TauriPlugin( + permissions = [ + Permission(strings = [LOCATION_PERMISSION]) + ] +) +class DiscoveryTestPlugin(activity: Activity) : Plugin(activity) { + + @Command + fun ping(invoke: Invoke) { + val ret = JSObject() + ret.put("value", PING_RESULT) + invoke.resolve(ret) + } + + @ActivityCallback + fun onPickResult(invoke: Invoke, result: ActivityResult) { + val ret = JSObject() + ret.put("value", ACTIVITY_CALLBACK_RESULT) + ret.put("resultCode", result.resultCode) + invoke.resolve(ret) + } + + @PermissionCallback + fun locationPermissionCallback(invoke: Invoke) { + val ret = JSObject() + ret.put("value", PERMISSION_CALLBACK_RESULT) + invoke.resolve(ret) + } +} + +/** + * A second plugin that declares no `permissions` at all, so reading + * `TauriPlugin.permissions` on it exercises the *default* value (`[]`) of the + * annotation member itself -- the other half of what `AnnotationDefault` + * covers, distinct from the nested `@Permission.alias` default above. + * Without `-keepattributes ...,AnnotationDefault`, accessing an omitted + * annotation member throws `IncompleteAnnotationException` at runtime instead + * of returning the default. + */ +@TauriPlugin +class DiscoveryDefaultsPlugin(activity: Activity) : Plugin(activity) { + @Command + fun ping(invoke: Invoke) { + invoke.resolve(JSObject()) + } +} diff --git a/examples/android-r8-plugin-discovery/build.gradle.kts b/examples/android-r8-plugin-discovery/build.gradle.kts new file mode 100644 index 000000000000..7f997dc2953d --- /dev/null +++ b/examples/android-r8-plugin-discovery/build.gradle.kts @@ -0,0 +1,20 @@ +// Copyright 2019-2024 Tauri Programme within The Commons Conservancy +// SPDX-License-Identifier: Apache-2.0 +// SPDX-License-Identifier: MIT + +// Versions kept in lockstep with crates/tauri-cli/templates/mobile/android/build.gradle.kts +// and crates/tauri/mobile/android/build.gradle.kts. +buildscript { + repositories { + google() + mavenCentral() + } + dependencies { + classpath("com.android.tools.build:gradle:9.3.1") + classpath("org.jetbrains.kotlin:kotlin-gradle-plugin:2.2.10") + } +} + +tasks.register("clean") { + delete(rootProject.layout.buildDirectory) +} diff --git a/examples/android-r8-plugin-discovery/gradle.properties b/examples/android-r8-plugin-discovery/gradle.properties new file mode 100644 index 000000000000..71e0c07eef9e --- /dev/null +++ b/examples/android-r8-plugin-discovery/gradle.properties @@ -0,0 +1,9 @@ +org.gradle.jvmargs=-Xmx2048m +android.useAndroidX=true +kotlin.code.style=official + +# Keeping Gradle 9 compatible with current plugins -- matches +# crates/tauri-cli/templates/mobile/android/gradle.properties. +# TODO: Remove this in v3 +android.builtInKotlin=false +android.newDsl=false diff --git a/examples/android-r8-plugin-discovery/gradle/wrapper/gradle-wrapper.jar b/examples/android-r8-plugin-discovery/gradle/wrapper/gradle-wrapper.jar new file mode 100644 index 000000000000..b1b8ef56b44f Binary files /dev/null and b/examples/android-r8-plugin-discovery/gradle/wrapper/gradle-wrapper.jar differ diff --git a/examples/android-r8-plugin-discovery/gradle/wrapper/gradle-wrapper.properties b/examples/android-r8-plugin-discovery/gradle/wrapper/gradle-wrapper.properties new file mode 100644 index 000000000000..b2ee479e2366 --- /dev/null +++ b/examples/android-r8-plugin-discovery/gradle/wrapper/gradle-wrapper.properties @@ -0,0 +1,6 @@ +#Tue May 10 19:22:52 CST 2022 +distributionBase=GRADLE_USER_HOME +distributionUrl=https\://services.gradle.org/distributions/gradle-9.6.1-bin.zip +distributionPath=wrapper/dists +zipStorePath=wrapper/dists +zipStoreBase=GRADLE_USER_HOME diff --git a/examples/android-r8-plugin-discovery/gradlew b/examples/android-r8-plugin-discovery/gradlew new file mode 100755 index 000000000000..249efbb032ce --- /dev/null +++ b/examples/android-r8-plugin-discovery/gradlew @@ -0,0 +1,248 @@ +#!/bin/sh + +# +# Copyright © 2015 the original 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 +# +# https://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. +# +# SPDX-License-Identifier: Apache-2.0 +# + +############################################################################## +# +# gradlew start up script for POSIX generated by Gradle. +# +# Important for running: +# +# (1) You need a POSIX-compliant shell to run this script. If your /bin/sh is +# noncompliant, but you have some other compliant shell such as ksh or +# bash, then to run this script, type that shell name before the whole +# command line, like: +# +# ksh gradlew +# +# Busybox and similar reduced shells will NOT work, because this script +# requires all of these POSIX shell features: +# * functions; +# * expansions «$var», «${var}», «${var:-default}», «${var+SET}», +# «${var#prefix}», «${var%suffix}», and «$( cmd )»; +# * compound commands having a testable exit status, especially «case»; +# * various built-in commands including «command», «set», and «ulimit». +# +# Important for patching: +# +# (2) This script targets any POSIX shell, so it avoids extensions provided +# by Bash, Ksh, etc; in particular arrays are avoided. +# +# The "traditional" practice of packing multiple parameters into a +# space-separated string is a well documented source of bugs and security +# problems, so this is (mostly) avoided, by progressively accumulating +# options in "$@", and eventually passing that to Java. +# +# Where the inherited environment variables (DEFAULT_JVM_OPTS, JAVA_OPTS, +# and GRADLE_OPTS) rely on word-splitting, this is performed explicitly; +# see the in-line comments for details. +# +# There are tweaks for specific operating systems such as AIX, CygWin, +# Darwin, MinGW, and NonStop. +# +# (3) This script is generated from the Groovy template +# https://github.com/gradle/gradle/blob/3d91ce3b8caaf77ad09f381f43615b715b53f72c/platforms/jvm/plugins-application/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt +# within the Gradle project. +# +# You can find Gradle at https://github.com/gradle/gradle/. +# +############################################################################## + +# Attempt to set APP_HOME + +# Resolve links: $0 may be a link +app_path=$0 + +# Need this for daisy-chained symlinks. +while + APP_HOME=${app_path%"${app_path##*/}"} # leaves a trailing /; empty if no leading path + [ -h "$app_path" ] +do + ls=$( ls -ld "$app_path" ) + link=${ls#*' -> '} + case $link in #( + /*) app_path=$link ;; #( + *) app_path=$APP_HOME$link ;; + esac +done + +# This is normally unused +# shellcheck disable=SC2034 +APP_BASE_NAME=${0##*/} +# Discard cd standard output in case $CDPATH is set (https://github.com/gradle/gradle/issues/25036) +APP_HOME=$( cd -P "${APP_HOME:-./}" > /dev/null && printf '%s\n' "$PWD" ) || exit + +# Use the maximum available, or set MAX_FD != -1 to use that value. +MAX_FD=maximum + +warn () { + echo "$*" +} >&2 + +die () { + echo + echo "$*" + echo + exit 1 +} >&2 + +# 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 ;; #( + MSYS* | MINGW* ) msys=true ;; #( + NONSTOP* ) nonstop=true ;; +esac + + + +# 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 + if ! command -v java >/dev/null 2>&1 + then + 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 +fi + +# Increase the maximum file descriptors if we can. +if ! "$cygwin" && ! "$darwin" && ! "$nonstop" ; then + case $MAX_FD in #( + max*) + # In POSIX sh, ulimit -H is undefined. That's why the result is checked to see if it worked. + # shellcheck disable=SC2039,SC3045 + MAX_FD=$( ulimit -H -n ) || + warn "Could not query maximum file descriptor limit" + esac + case $MAX_FD in #( + '' | soft) :;; #( + *) + # In POSIX sh, ulimit -n is undefined. That's why the result is checked to see if it worked. + # shellcheck disable=SC2039,SC3045 + ulimit -n "$MAX_FD" || + warn "Could not set maximum file descriptor limit to $MAX_FD" + esac +fi + +# Collect all arguments for the java command, stacking in reverse order: +# * args from the command line +# * the main class name +# * -classpath +# * -D...appname settings +# * --module-path (only if needed) +# * DEFAULT_JVM_OPTS, JAVA_OPTS, and GRADLE_OPTS environment variables. + +# For Cygwin or MSYS, switch paths to Windows format before running java +if "$cygwin" || "$msys" ; then + APP_HOME=$( cygpath --path --mixed "$APP_HOME" ) + + JAVACMD=$( cygpath --unix "$JAVACMD" ) + + # Now convert the arguments - kludge to limit ourselves to /bin/sh + for arg do + if + case $arg in #( + -*) false ;; # don't mess with options #( + /?*) t=${arg#/} t=/${t%%/*} # looks like a POSIX filepath + [ -e "$t" ] ;; #( + *) false ;; + esac + then + arg=$( cygpath --path --ignore --mixed "$arg" ) + fi + # Roll the args list around exactly as many times as the number of + # args, so each arg winds up back in the position where it started, but + # possibly modified. + # + # NB: a `for` loop captures its iteration list before it begins, so + # changing the positional parameters here affects neither the number of + # iterations, nor the values presented in `arg`. + shift # remove old arg + set -- "$@" "$arg" # push replacement arg + done +fi + + +# 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"' + +# Collect all arguments for the java command: +# * DEFAULT_JVM_OPTS, JAVA_OPTS, and optsEnvironmentVar are not allowed to contain shell fragments, +# and any embedded shellness will be escaped. +# * For example: A user cannot expect ${Hostname} to be expanded, as it is an environment variable and will be +# treated as '${Hostname}' itself on the command line. + +set -- \ + "-Dorg.gradle.appname=$APP_BASE_NAME" \ + -jar "$APP_HOME/gradle/wrapper/gradle-wrapper.jar" \ + "$@" + +# Stop when "xargs" is not available. +if ! command -v xargs >/dev/null 2>&1 +then + die "xargs is not available" +fi + +# Use "xargs" to parse quoted args. +# +# With -n1 it outputs one arg per line, with the quotes and backslashes removed. +# +# In Bash we could simply go: +# +# readarray ARGS < <( xargs -n1 <<<"$var" ) && +# set -- "${ARGS[@]}" "$@" +# +# but POSIX shell has neither arrays nor command substitution, so instead we +# post-process each arg (as a line of input to sed) to backslash-escape any +# character that might be a shell metacharacter, then use eval to reverse +# that process (while maintaining the separation between arguments), and wrap +# the whole thing up as a single "set" statement. +# +# This will of course break if any of these variables contains a newline or +# an unmatched quote. +# + +eval "set -- $( + printf '%s\n' "$DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS" | + xargs -n1 | + sed ' s~[^-[:alnum:]+,./:=@_]~\\&~g; ' | + tr '\n' ' ' + )" '"$@"' + +exec "$JAVACMD" "$@" diff --git a/examples/android-r8-plugin-discovery/gradlew.bat b/examples/android-r8-plugin-discovery/gradlew.bat new file mode 100644 index 000000000000..a51ec4f5886d --- /dev/null +++ b/examples/android-r8-plugin-discovery/gradlew.bat @@ -0,0 +1,82 @@ +@rem +@rem Copyright 2015 the original author or authors. +@rem +@rem Licensed under the Apache License, Version 2.0 (the "License"); +@rem you may not use this file except in compliance with the License. +@rem You may obtain a copy of the License at +@rem +@rem https://www.apache.org/licenses/LICENSE-2.0 +@rem +@rem Unless required by applicable law or agreed to in writing, software +@rem distributed under the License is distributed on an "AS IS" BASIS, +@rem WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +@rem See the License for the specific language governing permissions and +@rem limitations under the License. +@rem +@rem SPDX-License-Identifier: Apache-2.0 +@rem + +@if "%DEBUG%"=="" @echo off +@rem ########################################################################## +@rem +@rem gradlew startup script for Windows +@rem +@rem ########################################################################## + +@rem Set local scope for the variables, and ensure extensions are enabled +setlocal EnableExtensions + +set DIRNAME=%~dp0 +if "%DIRNAME%"=="" set DIRNAME=. +@rem This is normally unused +set APP_BASE_NAME=%~n0 +set APP_HOME=%DIRNAME% + +@rem Resolve any "." and ".." in APP_HOME to make it shorter. +for %%i in ("%APP_HOME%") do set APP_HOME=%%~fi + +@rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +set DEFAULT_JVM_OPTS="-Xmx64m" "-Xms64m" + +@rem Find java.exe +if defined JAVA_HOME goto findJavaFromJavaHome + +set JAVA_EXE=java.exe +%JAVA_EXE% -version >NUL 2>&1 +if %ERRORLEVEL% equ 0 goto execute + +echo. 1>&2 +echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 1>&2 +echo. 1>&2 +echo Please set the JAVA_HOME variable in your environment to match the 1>&2 +echo location of your Java installation. 1>&2 + +"%COMSPEC%" /c exit 1 + +:findJavaFromJavaHome +set JAVA_HOME=%JAVA_HOME:"=% +set JAVA_EXE=%JAVA_HOME%/bin/java.exe + +if exist "%JAVA_EXE%" goto execute + +echo. 1>&2 +echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% 1>&2 +echo. 1>&2 +echo Please set the JAVA_HOME variable in your environment to match the 1>&2 +echo location of your Java installation. 1>&2 + +"%COMSPEC%" /c exit 1 + +:execute +@rem Setup the command line + + + +@rem Execute gradlew +@rem endlocal doesn't take effect until after the line is parsed and variables are expanded +@rem which allows us to clear the local environment before executing the java command +endlocal & "%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -jar "%APP_HOME%\gradle\wrapper\gradle-wrapper.jar" %* & call :exitWithErrorLevel + +:exitWithErrorLevel +@rem Use "%COMSPEC%" /c exit to allow operators to work properly in scripts +"%COMSPEC%" /c exit %ERRORLEVEL% diff --git a/examples/android-r8-plugin-discovery/settings.gradle.kts b/examples/android-r8-plugin-discovery/settings.gradle.kts new file mode 100644 index 000000000000..43d5a04b5bab --- /dev/null +++ b/examples/android-r8-plugin-discovery/settings.gradle.kts @@ -0,0 +1,38 @@ +// Copyright 2019-2024 Tauri Programme within The Commons Conservancy +// SPDX-License-Identifier: Apache-2.0 +// SPDX-License-Identifier: MIT + +// This is a standalone Gradle project (not generated by `cargo tauri android +// init`). It exists to regression-test one thing: that +// `crates/tauri/mobile/android/consumer-rules.pro`, applied exactly as a real +// consuming app would receive it (via `implementation(project(":tauri-android"))` +// -> consumerProguardFiles), is sufficient on its own to keep reflective Tauri +// plugin discovery working after R8 minification. See app/README.md. + +pluginManagement { + repositories { + google() + mavenCentral() + gradlePluginPortal() + } +} + +dependencyResolutionManagement { + repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS) + repositories { + google() + mavenCentral() + } +} + +rootProject.name = "android-r8-plugin-discovery" + +include(":app") + +// Reference the real library sources directly -- the same thing +// crates/tauri-build/src/mobile.rs does for real Tauri apps (it writes +// `project(':tauri-android').projectDir = new File()` +// into the generated tauri.settings.gradle). Pointing at a copy or a stub here +// would defeat the purpose of the test. +include(":tauri-android") +project(":tauri-android").projectDir = file("../../crates/tauri/mobile/android") diff --git a/examples/api/src-tauri/tauri-plugin-sample/android/build.gradle.kts b/examples/api/src-tauri/tauri-plugin-sample/android/build.gradle.kts index 1d34a2e4b3ad..697344a233e9 100644 --- a/examples/api/src-tauri/tauri-plugin-sample/android/build.gradle.kts +++ b/examples/api/src-tauri/tauri-plugin-sample/android/build.gradle.kts @@ -16,15 +16,6 @@ android { consumerProguardFiles("consumer-rules.pro") } - buildTypes { - release { - isMinifyEnabled = false - proguardFiles( - getDefaultProguardFile("proguard-android-optimize.txt"), - "proguard-rules.pro" - ) - } - } compileOptions { sourceCompatibility = JavaVersion.VERSION_1_8 targetCompatibility = JavaVersion.VERSION_1_8 diff --git a/examples/api/src-tauri/tauri-plugin-sample/android/proguard-rules.pro b/examples/api/src-tauri/tauri-plugin-sample/android/consumer-rules.pro similarity index 93% rename from examples/api/src-tauri/tauri-plugin-sample/android/proguard-rules.pro rename to examples/api/src-tauri/tauri-plugin-sample/android/consumer-rules.pro index 481bb4348141..895c7b83ca9a 100644 --- a/examples/api/src-tauri/tauri-plugin-sample/android/proguard-rules.pro +++ b/examples/api/src-tauri/tauri-plugin-sample/android/consumer-rules.pro @@ -1,6 +1,6 @@ # Add project specific ProGuard rules here. # You can control the set of applied configuration files using the -# proguardFiles setting in build.gradle. +# consumerProguardFiles setting in build.gradle. # # For more details, see # http://developer.android.com/guide/developing/tools/proguard.html diff --git a/package.json b/package.json index e64c63a2d553..f6332512f485 100644 --- a/package.json +++ b/package.json @@ -28,5 +28,5 @@ "prettier": "^3.8.1" }, "minimumReleaseAge": 4320, - "packageManager": "pnpm@11.13.0" + "packageManager": "pnpm@11.21.0" }