Merge pull request #150 from solrudev/develop

0.18.5

Author: solrudev

.github/ci-gradle.properties

@@ -5,7 +5,9 @@ org.gradle.parallel=true
 org.gradle.configuration-cache=true
 org.gradle.configuration-cache.parallel=true
 org.gradle.configureondemand=true
+# org.gradle.unsafe.isolated-projects=true
 android.useAndroidX=true
 kotlin.code.style=official
 android.r8.maxWorkers=2
-android.lint.useK2Uast=true
+android.lint.useK2Uast=true
+ksp.project.isolation.enabled=true

.github/workflows/ci.yml

@@ -28,7 +28,7 @@ jobs:
 
       - name: Validate binary compatibility
         run: |
-          ./gradlew apiCheck || { exit_code=$?; printf "*** This PR changes Ackpine's public API. If this is intentional, run './gradlew apiDump' and commit the new API dumps. ***"; exit $exit_code; }
+          ./gradlew :checkAckpineAbi || { exit_code=$?; printf "*** This PR changes Ackpine's public ABI. If this is intentional, run './gradlew :updateAckpineAbi' and commit the new ABI dumps. ***"; exit $exit_code; }
 
       - name: Build
         run: |

README.md

@@ -37,7 +37,7 @@ Ackpine depends on Jetpack libraries, so it's also necessary to add the `google(
 
 ```toml
 [versions]
-ackpine = "0.18.4"
+ackpine = "0.18.5"
 
 [libraries]
 ackpine-core = { module = "ru.solrudev.ackpine:ackpine-core", version.ref = "ackpine" }
@@ -78,7 +78,7 @@ ackpine = [
 
 ```kotlin
 dependencies {
-    val ackpineVersion = "0.18.4"
+    val ackpineVersion = "0.18.5"
     implementation("ru.solrudev.ackpine:ackpine-core:$ackpineVersion")
 
     // optional - Kotlin extensions and Coroutines support

ackpine-core/src/main/kotlin/ru/solrudev/ackpine/impl/installer/PackageInstallerImpl.kt

@@ -259,6 +259,7 @@ internal class PackageInstallerImpl internal constructor(
 				ackpineServiceProviders,
 				InstallSessionFactoryImpl(
 					applicationContext,
+					@SuppressLint("NewApi")
 					PackageInstallerWrapper.default(applicationContext),
 					ackpineServiceProviders,
 					database.lastUpdateTimestampDao(),

ackpine-core/src/main/kotlin/ru/solrudev/ackpine/impl/installer/session/IntentBasedInstallSession.kt

@@ -16,12 +16,15 @@
 
 package ru.solrudev.ackpine.impl.installer.session
 
+import android.Manifest.permission.WRITE_EXTERNAL_STORAGE
 import android.content.Context
+import android.content.pm.PackageManager.PERMISSION_DENIED
 import android.net.Uri
 import android.os.Build
 import android.os.Environment
 import android.os.Handler
 import androidx.annotation.RestrictTo
+import androidx.core.content.ContextCompat
 import androidx.core.content.FileProvider
 import androidx.core.net.toUri
 import ru.solrudev.ackpine.AckpineFileProvider
@@ -78,19 +81,9 @@ internal class IntentBasedInstallSession internal constructor(
 ) {
 
 	private val apkFile by lazy(LazyThreadSafetyMode.NONE) {
-		File(context.externalDir, "ackpine/sessions/$id/0.apk")
+		File(getRootApkDir(), "ackpine/sessions/$id/0.apk")
 	}
 
-	private val Context.externalDir: File
-		get() {
-			val externalFilesDir = getExternalFilesDir(null)
-			return if (Environment.getExternalStorageState() == Environment.MEDIA_MOUNTED && externalFilesDir != null) {
-				externalFilesDir
-			} else {
-				filesDir
-			}
-		}
-
 	override fun prepare() {
 		createApkCopy()
 		val apkPackageName = context.packageManager
@@ -134,6 +127,23 @@ internal class IntentBasedInstallSession internal constructor(
 		return true
 	}
 
+	private fun getRootApkDir(): File {
+		if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.N) {
+			return context.filesDir
+		}
+		val externalFilesDir = context.getExternalFilesDir(null)
+		if (Environment.getExternalStorageState() == Environment.MEDIA_MOUNTED && externalFilesDir != null) {
+			return externalFilesDir
+		}
+		val cause = if (ContextCompat.checkSelfPermission(context, WRITE_EXTERNAL_STORAGE) == PERMISSION_DENIED) {
+			" WRITE_EXTERNAL_STORAGE permission denied."
+		} else {
+			""
+		}
+		completeExceptionally(IllegalStateException("External storage is not available.$cause"))
+		return File("")
+	}
+
 	private fun getApkUri(): Uri {
 		if (Build.VERSION.SDK_INT < Build.VERSION_CODES.N) {
 			return apkFile.toUri()

ackpine-core/src/main/kotlin/ru/solrudev/ackpine/impl/uninstaller/session/IntentBasedUninstallSession.kt

@@ -26,7 +26,7 @@ import ru.solrudev.ackpine.impl.helpers.concurrent.BinarySemaphore
 import ru.solrudev.ackpine.impl.helpers.launchConfirmation
 import ru.solrudev.ackpine.impl.session.AbstractSession
 import ru.solrudev.ackpine.impl.uninstaller.UninstallStatusReceiver
-import ru.solrudev.ackpine.impl.uninstaller.activity.UninstallActivity
+import ru.solrudev.ackpine.impl.uninstaller.activity.IntentBasedUninstallActivity
 import ru.solrudev.ackpine.session.Session
 import ru.solrudev.ackpine.session.parameters.Confirmation
 import ru.solrudev.ackpine.session.parameters.NotificationData
@@ -64,7 +64,7 @@ internal class IntentBasedUninstallSession internal constructor(
 	}
 
 	override fun launchConfirmation() {
-		context.launchConfirmation<UninstallActivity>(
+		context.launchConfirmation<IntentBasedUninstallActivity>(
 			confirmation, notificationData,
 			sessionId = id,
 			notificationId,

build-logic/build.gradle.kts

@@ -69,6 +69,5 @@ dependencies {
 	implementation(libs.plugin.kotlin)
 	implementation(libs.plugin.gradleMavenPublish)
 	implementation(libs.plugin.dokka)
-	implementation(libs.plugin.bcv)
 	implementation(kotlinx.serialization.json)
 }

build-logic/src/main/kotlin/ru/solrudev/ackpine/gradle/AbiValidationAttribute.kt

@@ -0,0 +1,33 @@
+/*
+ * Copyright (C) 2025 Ilya Fomichev
+ *
+ * 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 ru.solrudev.ackpine.gradle
+
+import org.gradle.api.Named
+import org.gradle.api.attributes.Attribute
+
+internal interface AbiValidationAttribute : Named {
+	companion object {
+		val ABI_VALIDATION_UPDATE_ATTRIBUTE = Attribute.of(
+			"ru.solrudev.ackpine.gradle.abi-validation.update",
+			AbiValidationAttribute::class.java
+		)
+		val ABI_VALIDATION_CHECK_ATTRIBUTE = Attribute.of(
+			"ru.solrudev.ackpine.gradle.abi-validation.check",
+			AbiValidationAttribute::class.java
+		)
+	}
+}

build-logic/src/main/kotlin/ru/solrudev/ackpine/gradle/AckpineLibraryBasePlugin.kt

@@ -20,7 +20,6 @@ import com.android.build.api.artifact.SingleArtifact
 import com.android.build.api.dsl.LibraryExtension
 import com.android.build.api.variant.LibraryAndroidComponentsExtension
 import com.android.build.gradle.LibraryPlugin
-import kotlinx.validation.ApiValidationExtension
 import org.gradle.api.JavaVersion
 import org.gradle.api.Plugin
 import org.gradle.api.Project
@@ -32,11 +31,14 @@ import org.gradle.kotlin.dsl.configure
 import org.gradle.kotlin.dsl.findByType
 import org.gradle.kotlin.dsl.named
 import org.gradle.kotlin.dsl.the
+import org.jetbrains.kotlin.gradle.dsl.KotlinBaseExtension
+import ru.solrudev.ackpine.gradle.AbiValidationAttribute.Companion.ABI_VALIDATION_CHECK_ATTRIBUTE
+import ru.solrudev.ackpine.gradle.AbiValidationAttribute.Companion.ABI_VALIDATION_UPDATE_ATTRIBUTE
+import ru.solrudev.ackpine.gradle.helpers.abiValidation
 import ru.solrudev.ackpine.gradle.helpers.addOutgoingArtifact
 import ru.solrudev.ackpine.gradle.helpers.libraryElements
 import ru.solrudev.ackpine.gradle.helpers.withReleaseBuildType
 import ru.solrudev.ackpine.gradle.versioning.ackpineVersion
-import java.util.Optional
 
 public class AckpineLibraryBasePlugin : Plugin<Project> {
 
@@ -48,17 +50,16 @@ public class AckpineLibraryBasePlugin : Plugin<Project> {
 		}
 		configureJava()
 		val libraryExtension = the<LibraryExtension>()
-		val apiValidationExtension = extensions.findByType<ApiValidationExtension>()?.apply {
-			nonPublicMarkers += "androidx.annotation.RestrictTo"
-		}
+		val abiValidationExtension = lazy { extensions.findByType<KotlinBaseExtension>()?.abiValidation }
 		extensions.create(
 			"ackpine",
 			AckpineLibraryExtension::class.java,
 			libraryExtension,
-			Optional.ofNullable(apiValidationExtension)
+			abiValidationExtension
 		)
 		configureAndroid()
 		registerConsumableLibraryConfiguration()
+		registerAbiValidationConfigurations()
 	}
 
 	private fun Project.configureJava() = extensions.configure<JavaPluginExtension> {
@@ -97,8 +98,25 @@ public class AckpineLibraryBasePlugin : Plugin<Project> {
 		}
 	}
 
+	private fun Project.registerAbiValidationConfigurations() {
+		configurations.consumable(ABI_UPDATE_CONFIGURATION) {
+			attributes {
+				attribute(ABI_VALIDATION_UPDATE_ATTRIBUTE, objects.named(ABI_UPDATE))
+			}
+		}
+		configurations.consumable(ABI_CHECK_CONFIGURATION) {
+			attributes {
+				attribute(ABI_VALIDATION_CHECK_ATTRIBUTE, objects.named(ABI_CHECK))
+			}
+		}
+	}
+
 	internal companion object {
 		internal const val LIBRARY_ELEMENTS = "aar"
 		internal const val PLUGIN_ID = "ru.solrudev.ackpine.library.base"
+		internal const val ABI_UPDATE_CONFIGURATION = "abiValidationUpdateElements"
+		internal const val ABI_CHECK_CONFIGURATION = "abiValidationCheckElements"
+		internal const val ABI_UPDATE = "update"
+		internal const val ABI_CHECK = "check"
 	}
 }

build-logic/src/main/kotlin/ru/solrudev/ackpine/gradle/AckpineLibraryExtension.kt

@@ -17,15 +17,14 @@
 package ru.solrudev.ackpine.gradle
 
 import com.android.build.api.dsl.LibraryExtension
-import kotlinx.validation.ApiValidationExtension
 import org.gradle.api.model.ObjectFactory
 import org.gradle.api.plugins.ExtensionAware
 import org.gradle.api.provider.Provider
 import org.gradle.kotlin.dsl.assign
 import org.gradle.kotlin.dsl.setProperty
-import java.util.Optional
+import org.jetbrains.kotlin.gradle.dsl.abi.AbiValidationExtension
+import org.jetbrains.kotlin.gradle.dsl.abi.ExperimentalAbiValidation
 import javax.inject.Inject
-import kotlin.jvm.optionals.getOrNull
 
 private val PACKAGE_NAME_REGEX = Regex("^[a-z.]+$")
 
@@ -34,7 +33,7 @@ private val PACKAGE_NAME_REGEX = Regex("^[a-z.]+$")
  */
 public abstract class AckpineLibraryExtension @Inject constructor(
 	libraryExtension: LibraryExtension,
-	private val apiValidationExtension: Optional<ApiValidationExtension>,
+	private val abiValidationExtension: Lazy<AbiValidationExtension?>,
 	objectFactory: ObjectFactory
 ) : AckpineCommonExtension(libraryExtension, Constants.PACKAGE_NAME), ExtensionAware {
 
@@ -49,11 +48,14 @@ public abstract class AckpineLibraryExtension @Inject constructor(
 	/**
 	 * Adds [packageNames] to ignored packages. They will not appear in resulting public API dumps and documentation.
 	 */
+	@OptIn(ExperimentalAbiValidation::class)
 	public fun internalPackages(vararg packageNames: String) {
 		for (packageName in packageNames) {
 			require(packageName.matches(PACKAGE_NAME_REGEX)) { "Illegal package name: $packageName" }
 		}
 		_internalPackages = packageNames.toSet()
-		apiValidationExtension.getOrNull()?.ignoredPackages += packageNames
+		abiValidationExtension.value?.run {
+			filters.excluded.byNames.addAll(packageNames.map { "$it.**" })
+		}
 	}
 }