Skip to content
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions Documentation/docs-mobile/building-apps/build-items.md
Original file line number Diff line number Diff line change
Expand Up @@ -465,6 +465,11 @@ included from the final package. The default values are as follows
</ItemGroup>
```

Build-time Java archive entries such as nested `.jar` files, Kotlin Multiplatform
compiler metadata, `R.txt`, `proguard.txt`, and embedded AAR or shrinker metadata
are excluded from application packages. Use `AndroidPackagingOptionsInclude` to
package one of these entries intentionally.

Items can use file blob characters for wildcards such as `*` and `?`.
However these Items MUST use URL encoding or '$([MSBuild]::Escape(''))'.
This is so MSBuild does not try to interpret them as actual file wildcards.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,8 @@ namespace Xamarin.Android.Tasks;
/// </summary>
public class CollectJarContentFilesForArchive : AndroidTask
{
const string KotlinProjectStructureMetadata = "META-INF/kotlin-project-structure-metadata.json";
Comment thread
simonrozsival marked this conversation as resolved.
Resolved

public override string TaskPrefix => "CJC";

public string AndroidPackageFormat { get; set; } = "";
Expand Down Expand Up @@ -72,6 +74,7 @@ public override bool RunTask ()
foreach (var jarFile in jarFilePaths) {
using (var stream = File.OpenRead (jarFile))
using (var jar = ZipArchive.Open (stream)) {
bool isKotlinMultiplatformMetadataArchive = jar.ContainsEntry (KotlinProjectStructureMetadata);
foreach (var jarItem in jar) {
if (jarItem.IsDirectory)
continue;
Expand All @@ -93,6 +96,11 @@ public override bool RunTask ()
}

if (!forceInclude) {
if (IsBuildTimeOnlyEntry (name, isKotlinMultiplatformMetadataArchive)) {
Log.LogDebugMessage ($"Ignoring build-time jar entry '{name}' from '{Path.GetFileName (jarFile)}'.");
continue;
}

foreach (var pattern in excludePatterns) {
if (pattern.IsMatch (path)) {
Log.LogDebugMessage ($"Ignoring jar entry '{name}' from '{Path.GetFileName (jarFile)}'. Filename matched the exclude pattern '{pattern}'.");
Expand Down Expand Up @@ -121,6 +129,33 @@ public override bool RunTask ()
return !Log.HasLoggedErrors;
}

static bool IsBuildTimeOnlyEntry (string name, bool isKotlinMultiplatformMetadataArchive)
{
var normalizedName = name.Replace ('\\', '/');

if (isKotlinMultiplatformMetadataArchive &&
(normalizedName.Equals (KotlinProjectStructureMetadata, StringComparison.OrdinalIgnoreCase) ||
!normalizedName.StartsWith ("META-INF/", StringComparison.OrdinalIgnoreCase))) {
return true;
}

var extension = Path.GetExtension (normalizedName);
if (extension.Equals (".jar", StringComparison.OrdinalIgnoreCase) ||
extension.Equals (".knm", StringComparison.OrdinalIgnoreCase)) {
return true;
}

if (normalizedName.Equals ("R.txt", StringComparison.OrdinalIgnoreCase) ||
normalizedName.Equals ("proguard.txt", StringComparison.OrdinalIgnoreCase)) {
return true;
}

return normalizedName.Equals ("META-INF/com/android/build/gradle/aar-metadata.properties", StringComparison.OrdinalIgnoreCase) ||
normalizedName.StartsWith ("META-INF/proguard/", StringComparison.OrdinalIgnoreCase) ||
normalizedName.StartsWith ("META-INF/com.android.tools/proguard/", StringComparison.OrdinalIgnoreCase) ||
normalizedName.StartsWith ("META-INF/com.android.tools/r8", StringComparison.OrdinalIgnoreCase);
}

static Regex FileGlobToRegEx (string fileGlob, RegexOptions options)
{
StringBuilder sb = new StringBuilder ();
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,107 @@
#nullable enable
using System;
using System.IO;
using System.Linq;
using System.Text;
using Microsoft.Android.Build.Tasks;
using Microsoft.Build.Utilities;
using NUnit.Framework;
using Xamarin.Android.Tasks;
using Xamarin.Tools.Zip;

namespace Xamarin.Android.Build.Tests;

[TestFixture]
public class CollectJarContentFilesForArchiveTests
{
string? tempDirectory;

string TempDirectory => tempDirectory ?? throw new InvalidOperationException ("Setup has not run.");

[SetUp]
public void Setup ()
{
tempDirectory = Path.Combine (Path.GetTempPath (), Path.GetRandomFileName ());
Directory.CreateDirectory (tempDirectory);
}

[TearDown]
public void TearDown ()
{
if (!tempDirectory.IsNullOrEmpty () && Directory.Exists (tempDirectory))
Directory.Delete (tempDirectory, recursive: true);
}

[Test]
public void BuildTimeJavaResourcesAreNotPackaged ()
Comment thread
simonrozsival marked this conversation as resolved.
Resolved
{
var metadataJar = CreateArchive (
"metadata.jar",
("META-INF/kotlin-project-structure-metadata.json", "{}"),
("commonMain/default/manifest", "manifest"),
("commonMain/default/linkdata/module", "module"),
("commonMain/default/linkdata/package_example/0_example.knm", "metadata"),
("classes.jar", "nested jar"),
("META-INF/kotlinx_metadata.version", "1.0"));
var runtimeJar = CreateArchive (
"runtime.jar",
("META-INF/services/example.Service", "example.ServiceImpl"),
("kotlin/kotlin.kotlin_builtins", "builtins"),
("META-INF/androidx.collection_collection.version", "1.0"),
("META-INF/androidx/collection/collection/LICENSE.txt", "license"),
("META-INF/maven/example/library/pom.xml", "pom"),
("nested.jar", "nested jar"),
("metadata/example.knm", "metadata"),
("R.txt", "resources"),
("proguard.txt", "rules"),
("META-INF/proguard/library.pro", "rules"),
("META-INF/com.android.tools/proguard/library.pro", "rules"),
("META-INF/com.android.tools/r8/library.pro", "rules"),
("META-INF/com.android.tools/r8-from-1.6.0/library.pro", "rules"),
("META-INF/com/android/build/gradle/aar-metadata.properties", "metadata"));

var task = new CollectJarContentFilesForArchive {
BuildEngine = new MockBuildEngine (TestContext.Out),
JavaLibraries = [new TaskItem (metadataJar), new TaskItem (runtimeJar)],
};

Assert.IsTrue (task.RunTask (), "Task should succeed.");

var archivePaths = task.FilesToAddToArchive.Select (item => item.GetMetadata ("ArchivePath")).ToArray ();
string [] expected = [
"META-INF/kotlinx_metadata.version",
"META-INF/androidx.collection_collection.version",
"META-INF/services/example.Service",
"kotlin/kotlin.kotlin_builtins",
"META-INF/androidx/collection/collection/LICENSE.txt",
"META-INF/maven/example/library/pom.xml",
];
CollectionAssert.AreEquivalent (expected, archivePaths);
}

[Test]
public void IncludePatternCanRestoreBuildTimeJavaResource ()
{
var jar = CreateArchive ("library.jar", ("classes.jar", "nested jar"));
var task = new CollectJarContentFilesForArchive {
BuildEngine = new MockBuildEngine (TestContext.Out),
IncludeFiles = ["classes.jar"],
JavaLibraries = [new TaskItem (jar)],
};

Assert.IsTrue (task.RunTask (), "Task should succeed.");
Assert.AreEqual ("classes.jar", task.FilesToAddToArchive.Single ().GetMetadata ("ArchivePath"));
}

string CreateArchive (string fileName, params (string Path, string Contents) [] entries)
{
var path = Path.Combine (TempDirectory, fileName);
using (var stream = File.Create (path))
using (var archive = ZipArchive.Create (stream)) {
foreach (var entry in entries) {
archive.AddEntry (entry.Path, entry.Contents, encoding: Encoding.UTF8);
}
}
return path;
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -5,19 +5,19 @@
"Size": 3036
},
"classes.dex": {
"Size": 382236
"Size": 382188
},
"lib/arm64-v8a/libassembly-store.so": {
"Size": 2529368
"Size": 2533048
},
"lib/arm64-v8a/libclrjit.so": {
"Size": 2818032
"Size": 2818048
},
"lib/arm64-v8a/libcoreclr.so": {
"Size": 4844000
"Size": 4843824
},
"lib/arm64-v8a/libmonodroid.so": {
"Size": 203592
"Size": 196760
},
"lib/arm64-v8a/libSystem.Globalization.Native.so": {
"Size": 72432
Expand All @@ -32,7 +32,7 @@
"Size": 171584
},
"lib/arm64-v8a/libxamarin-app.so": {
"Size": 20432
"Size": 20440
},
"res/drawable-hdpi-v4/icon.png": {
"Size": 2178
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,19 +5,19 @@
"Size": 3036
},
"classes.dex": {
"Size": 405040
"Size": 404988
},
"lib/arm64-v8a/libassembly-store.so": {
"Size": 2529336
"Size": 2533048
},
"lib/arm64-v8a/libclrjit.so": {
"Size": 2818032
"Size": 2818048
},
"lib/arm64-v8a/libcoreclr.so": {
"Size": 4844000
"Size": 4843824
},
"lib/arm64-v8a/libmonodroid.so": {
"Size": 203592
"Size": 196760
},
"lib/arm64-v8a/libSystem.Globalization.Native.so": {
"Size": 72432
Expand All @@ -32,7 +32,7 @@
"Size": 171584
},
"lib/arm64-v8a/libxamarin-app.so": {
"Size": 20432
"Size": 20440
},
"res/drawable-hdpi-v4/icon.png": {
"Size": 2178
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
"Size": 6652
},
"classes.dex": {
"Size": 2794604
"Size": 2794592
},
"kotlin/annotation/annotation.kotlin_builtins": {
"Size": 928
Expand All @@ -29,7 +29,7 @@
"Size": 2396
},
"lib/arm64-v8a/libassembly-store.so": {
"Size": 9458208
"Size": 9457248
},
"lib/arm64-v8a/libclrjit.so": {
"Size": 2818048
Expand All @@ -38,7 +38,7 @@
"Size": 4843824
},
"lib/arm64-v8a/libmonodroid.so": {
"Size": 204872
"Size": 196760
},
"lib/arm64-v8a/libSystem.Globalization.Native.so": {
"Size": 72432
Expand All @@ -53,7 +53,7 @@
"Size": 171584
},
"lib/arm64-v8a/libxamarin-app.so": {
"Size": 119776
"Size": 119784
},
"META-INF/androidx.activity_activity.version": {
"Size": 6
Expand Down Expand Up @@ -205,24 +205,9 @@
"META-INF/androidx.viewpager2_viewpager2.version": {
"Size": 6
},
"META-INF/com.android.tools/proguard/coroutines.pro": {
"Size": 1345
},
"META-INF/com.android.tools/r8-from-1.6.0/coroutines.pro": {
"Size": 899
},
"META-INF/com.android.tools/r8-upto-3.0.0/coroutines.pro": {
"Size": 558
},
"META-INF/com.android.tools/r8/coroutines.pro": {
"Size": 1190
},
"META-INF/com.google.android.material_material.version": {
"Size": 6
},
"META-INF/kotlin-project-structure-metadata.json": {
"Size": 552
},
"META-INF/kotlinx_coroutines_android.version": {
"Size": 5
},
Expand All @@ -235,12 +220,6 @@
"META-INF/maven/com.google.guava/listenablefuture/pom.xml": {
"Size": 2226
},
"META-INF/proguard/androidx-annotations.pro": {
"Size": 433
},
"META-INF/proguard/coroutines.pro": {
"Size": 1363
},
"META-INF/services/kotlinx.coroutines.CoroutineExceptionHandler": {
"Size": 54
},
Expand Down Expand Up @@ -2231,5 +2210,5 @@
"Size": 794696
}
},
"PackageSize": 15830547
"PackageSize": 15821708
}
Loading
Loading