Skip to content

Commit

Permalink
Merge branch 'main' into dev/grendel/xxhash3
Browse files Browse the repository at this point in the history
* main:
  LEGO: Merge pull request 8818
  Bump to dotnet/installer@b40c44502d 9.0.100-preview.3.24165.20 (#8817)
  Bump com.android.tools:r8 from 8.2.47 to 8.3.37 (#8816)
  [Mono.Android] Prevent NullPointerException in TranslateStackTrace (#8795)
  Localized file check-in by OneLocBuild Task (#8815)
  [Xamarin.Android.Build.Tasks] Make all assemblies RID-specific (#8478)
  Localized file check-in by OneLocBuild Task (#8813)
  [Xamarin.Android.Build.Tasks] %(AndroidAsset.AssetPack) Support (#8631)
  • Loading branch information
grendello committed Mar 20, 2024
2 parents 7c03882 + 9f548d5 commit 4e2d8d3
Show file tree
Hide file tree
Showing 189 changed files with 6,977 additions and 3,137 deletions.
2 changes: 1 addition & 1 deletion Directory.Build.props
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@
<NuGetApiPackageVersion>5.4.0</NuGetApiPackageVersion>
<LZ4PackageVersion>1.1.11</LZ4PackageVersion>
<MonoOptionsVersion>6.12.0.148</MonoOptionsVersion>
<SystemCollectionsImmutableVersion>6.0.0</SystemCollectionsImmutableVersion>
<SystemCollectionsImmutableVersion>8.0.0</SystemCollectionsImmutableVersion>
<SystemRuntimeCompilerServicesUnsafeVersion>6.0.0</SystemRuntimeCompilerServicesUnsafeVersion>
<ELFSharpVersion>2.13.1</ELFSharpVersion>
<HumanizerVersion>2.14.1</HumanizerVersion>
Expand Down
235 changes: 235 additions & 0 deletions Documentation/guides/AndroidAssetPacks.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,235 @@
# Android Asset Packs

Google Android began supporting splitting up the app package into multiple
packs with the introduction of the `aab` package format. This format allows
the developer to split the app up into multiple `packs`. Each `pack` can be
downloaded to the device either at install time or on demand. This allows
application developers to save space and install time by only installing
the required parts of the app initially, then installing other `packs`
as required.

There are two types of `pack`: Feature packs and Asset packs.
*Feature* pack contains *non-native* Java code and other resources.
Code in these types of `pack` can be launched via the `Context.StartActivity()`
API call. At this time due to various constraints .NET Android cannot support
Feature packs.

*Asset* packs contain *only*
[`@(AndroidAsset)`](~/android/deploy-test/building-apps/build-items.md#androidasset) items.
It *cannot* contain any code or other resources. This type of `pack` can be
installed at install-time, fast-follow or ondemand. It is most useful for apps
which contain a lot of Assets, such as Games or Multi Media applications.
See the [Android Asset Delivery documentation](https://developer.android.com/guide/playcore/asset-delivery)
for details on how this all works.

## Asset Pack Specification

We want to provide our users the ability to use `Asset` packs without relying
on [Alternative Methods](#alternativemethods)

Add support for new `%(AndroidAsset.AssetPack)` item metadata, which
allows the build system to split up the assets into packs automatically:

```xml
<ItemGroup>
<AndroidAsset Include="Asset/data.xml" />
<AndroidAsset Include="Asset/movie.mp4" AssetPack="assets1" />
<AndroidAsset Include="Asset/movie2.mp4" AssetPack="assets1" />
</ItemGroup>
```

The default value for `%(AndroidAsset.AssetPack)` is `base`, which will
cause the asset to be included in the main application package.

As auto import of items is now common, we need a way for a user to add
this additional attribute to auto included items. This can be done by
using `Update`:

```xml
<ItemGroup>
<AndroidAsset Update="Asset/movie.mp4" AssetPack="assets1" />
<AndroidAsset Update="Asset/movie2.mp4" AssetPack="assets1" />
<AndroidAsset Update="Asset/movie3.mp4" AssetPack="assets2" />
</ItemGroup>
```

`%(AndroidAsset.DeliveryType)` item metadata can be specified to control what
*type* of asset pack is produced. Valid values are:

* `InstallTime`: Asset pack will be delivered when the app is installed.
This is the default value for assets not in the base package.
* `FastFollow`: Asset pack will be downloaded automatically as soon as the app is installed.
* `OnDemand`: Asset pack will be downloaded while the app is running.

The `DeliveryType` for a given asset pack is based on the *first*
`@(AndroidAsset.DeliveryType)` value encountered for a `%(AssetPack)` name.

Consider the following example, in which `Asset/movie2.mp4` and `Asset/movie3.mp4`
are both in the `assets1` pack, which will have a `%(DeliveryType)` of `InstallTime`
(the first encountered value "wins"). `Asset/movie1.mp4` will be in the base package,
while `Asset/movie4.mp4` will be in the "asset2" asset pack.

```xml
<ItemGroup>
<AndroidAsset Update="Asset/movie1.mp4" />
<AndroidAsset Update="Asset/movie2.mp4" AssetPack="assets1" DeliveryType="InstallTime" />
<AndroidAsset Update="Asset/movie3.mp4" AssetPack="assets1" DeliveryType="FastFollow" />
<AndroidAsset Update="Asset/movie4.mp4" AssetPack="assets2" />
</ItemGroup>
```

See Google's [documentation](https://developer.android.com/guide/playcore/asset-delivery#asset-updates) for details on what each of the `DeliveryType` values do.

If however you have a large number of assets it might be cleaner in the
`.csproj` to make use of the `base` value for the `%(AssetPack)` attribute.
In this scenario you update *all* assets to be in a single asset pack then use
`AssetPack="base"` metadata to declare which specific assets end up in the base
aab file. With this you can use wildcards to move most assets into the asset pack:

```xml
<ItemGroup>
<AndroidAsset Update="Assets/*" AssetPack="assets1" />
<AndroidAsset Update="Assets/movie.mp4" AssetPack="base" />
<AndroidAsset Update="Assets/some.png" AssetPack="base" />
</ItemGroup>
```

In this example, `movie.mp4` and `some.png` will end up in the `base` aab file,
but *all the other assets* will end up in the `assets1` asset pack.

At this time the `@(AndroidAsset)` build action does not support `%(AssetPack)`
or `%(DeliveryType)` Metadata in Library Projects.

NOTE: `AssetPacks` are only used when the
[`$(AndroidPackageFormat)`](~/android/deploy-test/building-apps/build-properties.md#debugsymbols)
property is set to `aab` (the default for Release).
When using the `apk` setting the assets will be placed inside the `apk`.

## Release Configuration

In order for the application to function correctly we need to inform the `R8`
linker which Java classes we need to keep. To do this we need to add the
following lines to a `ProGuard.cfg` file which is in the root of our project folder:

```
-keep com.google.android.play.*
```

Alternatively you can create a file called `ProGuard.cfg` and use the
[@(ProguardConfiguration)](~/android/deploy-test/building-apps/build-items.md#proguardconfiguration)
build action. Adding these lines will ensure that all the required Java components are not linked
away during the Release build.

## Testing and Debugging

In order to test your asset packs in the `Debug` configuration, you will need to
make some changes to your `.csproj`. Firstly we need to change the
`$(AndroidPackageFormat)` to `aab`. It will be `aab` by default for `Release` builds,
but will default to `apk` for `Debug` builds. Setting the `AndroidPackageFormat` to `aab`
will disable fast deployment, so it is advised that you only do this when you need to test
your `AssetPacks`.

To test your asset packs add the following to the first `<PropertyGroup/>` in your `.csproj`.

```xml
<AndroidPackageFormat>aab</AndroidPackageFormat>
<AndroidBundleToolExtraArgs Condition=" '$(Configuration)' == 'Debug' ">--local-testing $(AndroidBundleToolExtraArgs)</AndroidBundleToolExtraArgs>
```

The `--local-testing` argument tells the `bundletool` application to install all the asset packs
in a local cache on the device. `InstallTime` packs will be installed during the app installation process.

`FastFollow` packs behave like `OnDemand` packs. They will not automatically installed when the app
is sideloaded. You will need to request them manually when the game starts.

For more details see [https://developer.android.com/guide/playcore/asset-delivery/test](https://developer.android.com/guide/playcore/asset-delivery/test).

## Implementation Details

There are a few changes we need to make in order to support this feature.
One of the issues we will hit is the build times when dealing with large assets.
Current the assets which are to be included in the `aab` are ***copied***
into the `$(IntermediateOutputPath)assets` directory. This folder is
then passed to `aapt2` for the build process.

The new system adds a new directory `$(IntermediateOutputPath)assetpacks`.
This directory would contain a subdirectory for each `pack` that the
user wants to include.

```dotnetcli
assetpacks/
assets1/
assets/
movie2.mp4
assets2/
assets/
movie3.mp4
```

All the building of the `pack` zip file would take place in these subfolders.
The name of the pack will be based on the main "packagename" with the asset pack
name appended to the end. e.g `com.microsoft.assetpacksample.assets1`.

During the build process we identify all the `AndroidAsset` items which
have an `AssetPack` attribute. These files are then copied to the
new `$(IntermediateOutputPath)assetpacks` directory rather than the
existing `$(IntermediateOutputPath)assets` directory. This allows us to
continue to support the normal `AndroidAsset` behavior while adding the
new system.

Once we have collected and copied all the assets we then use the new
`<GetAssetPacks/>` Task to figure out which asset packs we need to create.
We then call the `<CreateDynamicFeatureManifest/>` task to create a required
`AndroidManifest.xml` file for the asset pack. This file will end
up in the same `$(IntermediateOutputPath)assetpacks` directory.
We call this Task `<CreateDynamicFeatureManifest/>` because it can be used
to create any feature pack if and when we get to implement full feature
packs.

```dotnetcli
assetpacks/
assets1/
AndroidManifest.xml
assets/
movie2.mp4
assets2/
AndroidManifest.xml
assets/
movie3.mp4
```

We can then call `aapt2` to build these packs into `.zip` files. A new
task `<Aapt2LinkAssetPack/>` task takes care of this. This is a special version
of `Aapt2Link` which implements linking for asset packs only.
It also takes care of a few problems which `aapt2` introduces. For some
reason the zip file that is created has the `AndroidManifest.xml` file
in the wrong place. It creates it in the root of the zip file, but the
`bundletool` expects it to be in a `manifest` directory.
`bundletool` will error out if its not in the right place.
So `<Aapt2LinkAssetPack/>` takes care of this for us. It also removes a
`resources.pb` which gets added. Again, `bundletool` will error if this
file is in the zip file.

Once the zip files have been created they are then added to the
`@(AndroidAppBundleModules)` ItemGroup. This will ensure that when the
final `.aab` file is generated they are included as asset packs.

## Alternative Methods

An alternative method is available on [github](https://github.com/infinitespace-studios/MauiAndroidAssetPackExample).
This method allows developers to place additional assets in a special
[NoTargets](https://github.com/microsoft/MSBuildSdks/blob/main/src/NoTargets/README.md) project.
This project is built just after the final `aab` is produced. It builds a zip
file which is then added to the `@(Modules)` ItemGroup in the main application.
This zip is then included into the
final app as an additional feature.

Using a separate project like in the hack is one way to go. It does have some
issues though.

1. It is a `special` type of project. It requires a `global.json` which imports
the `NoTargets` sdk.
2. There is no IDE support for building this type of project.

Having the user go through a number of hoops to implement this for
.NET Android or .NET MAUI is not ideal.
31 changes: 31 additions & 0 deletions Documentation/guides/building-apps/build-items.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,37 @@ or library project is built.
Supports [Android Assets](https://developer.android.com/guide/topics/resources/providing-resources#OriginalFiles),
files that would be included in the `assets` folder in a Java Android project.

Starting with .NET 9 the `@(AndroidAsset)` build action also supports additional metadata for generating [Asset Packs](https://developer.android.com/guide/playcore/asset-delivery). The `%(AndroidAsset.AssetPack)` metadata can be used to automatically generate an asset pack of that name. This feature is only supported when the [`$(AndroidPackageFormat)`](#androidpackageformat) is set to `.aab`. The following example will place `movie2.mp4` and `movie3.mp4` in separate asset packs.

```xml
<ItemGroup>
<AndroidAsset Update="Asset/movie.mp4" />
<AndroidAsset Update="Asset/movie2.mp4" AssetPack="assets1" />
<AndroidAsset Update="Asset/movie3.mp4" AssetPack="assets2" />
</ItemGroup>
```

This feature can be used to include large files in your application which would normally exceed the max
package size limits of Google Play.

If you have a large number of assets it might be more efficient to make use of the `base` asset pack.
In this scenario you update ALL assets to be in a single asset pack then use the `AssetPack="base"` metadata
to declare which specific assets end up in the base aab file. With this you can use wildcards to move most
assets into the asset pack.

```xml
<ItemGroup>
<AndroidAsset Update="Assets/*" AssetPack="assets1" />
<AndroidAsset Update="Assets/movie.mp4" AssetPack="base" />
<AndroidAsset Update="Assets/some.png" AssetPack="base" />
</ItemGroup>
```

In this example, `movie.mp4` and `some.png` will end up in the `base` aab file, while all the other assets
will end up in the `assets1` asset pack.

The additional metadata is only supported on .NET Android 9 and above.

## AndroidAarLibrary

The Build action of `AndroidAarLibrary` should be used to directly
Expand Down
1 change: 1 addition & 0 deletions Documentation/guides/building-apps/build-process.md
Original file line number Diff line number Diff line change
Expand Up @@ -195,6 +195,7 @@ Extension points include:
- [`$(AfterGenerateAndroidManifest)](~/android/deploy-test/building-apps/build-properties.md#aftergenerateandroidmanifest)
- [`$(BeforeGenerateAndroidManifest)](~/android/deploy-test/building-apps/build-properties.md#beforegenerateandroidmanifest)
- [`$(BeforeBuildAndroidAssetPacks)`](~/android/deploy-test/building-apps/build-properties.md#beforebuildandroidassetpacks)
A word of caution about extending the build process: If not
written correctly, build extensions can affect your build
Expand Down
19 changes: 19 additions & 0 deletions Documentation/guides/building-apps/build-properties.md
Original file line number Diff line number Diff line change
Expand Up @@ -832,6 +832,18 @@ APK root directory. The format of the path is `lib\ARCH\wrap.sh` where
+ `x86_64`
+ `x86`

## AndroidIncludeAssetPacksInPackage

This property controls if an Asset Packs build automatically are auto
included in the final `.aab` file. It will default to `true`.

In certain cases the user might want to release an interim release. In
these cases the user does not need to update the asset pack. Especially
if the contents of the asset pack have not changed. This property allows
the user to skip the asset packs if they are not required.

Added in .NET 9

## AndroidInstallJavaDependencies

The default value is `true` for command line builds. When set to `true`, enables
Expand Down Expand Up @@ -1674,6 +1686,13 @@ as support for `$(AotAssemblies)` will be removed in a future release.

Extra options to pass to `aprofutil`.

## BeforeBuildAndroidAssetPacks

MSBuild Targets listed in this
property will run directly before the `AssetPack` items are built.

Added in .NET 9

## BeforeGenerateAndroidManifest

MSBuild Targets listed in this
Expand Down
3 changes: 3 additions & 0 deletions Documentation/guides/messages/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -100,6 +100,9 @@ package from all the users on device and try again. If that does not work you ca
Fast Deployment is not currently supported on this device.
Please file an issue with the exact error message using the 'Help->Send Feedback->Report a Problem' menu item in Visual Studio
or 'Help->Report a Problem' in Visual Studio for Mac.
+ [XA0138](xa0138.md): %(AndroidAsset.AssetPack) and %(AndroidAsset.AssetPack) item metadata are only supported when `$(AndroidApplication)` is `true`.
+ [XA0139](xa0139.md): `@(AndroidAsset)` `{0}` has invalid `DeliveryType` metadata of `{1}`. Supported values are `installtime`, `ondemand` or `fastfollow`
+ [XA0140](xa0140.md):

## XA1xxx: Project related

Expand Down
13 changes: 13 additions & 0 deletions Documentation/guides/messages/xa0138.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
title: Xamarin.Android error XA0138
description: XA0138 error code
ms.date: 02/05/2024
---
# Xamarin.Android error XA0138

## Issue

%(AndroidAsset.AssetPack) and %(AndroidAsset.AssetPack) item metadata are only supported when `$(AndroidApplication)` is `true`.

## Solution

Remove the 'AssetPack' or 'DeliveryType' Metadata from your `AndroidAsset` build Items in the project the error was raised for.
13 changes: 13 additions & 0 deletions Documentation/guides/messages/xa0139.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
title: Xamarin.Android error XA0138
description: XA0138 error code
ms.date: 02/05/2024
---
# Xamarin.Android error XA0138

## Issue

`@(AndroidAsset)` `{0}` has an invalid `DeliveryType` metadata of `{1}`. Supported values are `installtime`, `ondemand` or `fastfollow`.

## Solution

Make sure that all `DeliveryType` attributes are one of the following valid values, `installtime`, `ondemand` or `fastfollow`.
13 changes: 13 additions & 0 deletions Documentation/guides/messages/xa0140.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
title: Xamarin.Android error XA0138
description: XA0140 error code
ms.date: 02/05/2024
---
# Xamarin.Android error XA0140

## Issue

The AssetPack value defined for `{0}` has invalid characters. `{1}` should only contain A-z, a-z, 0-9 or an underscore.

## Solution

Make sure that all `AssetPack` attributes only contain valid characters.
Original file line number Diff line number Diff line change
Expand Up @@ -29,10 +29,13 @@
</Item>
<Item ItemId=";name" ItemType="0" PsrId="306" Leaf="true">
<Str Cat="Text">
<Val><![CDATA[Android Activity template]]></Val>
<Val><![CDATA[Android Activity]]></Val>
<Tgt Cat="Text" Stat="Loc" Orig="New">
<Val><![CDATA[Šablona aktivity Androidu]]></Val>
<Val><![CDATA[Aktivita na Androidu]]></Val>
</Tgt>
<Prev Cat="Text">
<Val><![CDATA[Android Activity template]]></Val>
</Prev>
</Str>
<Disp Icon="Str" />
</Item>
Expand Down
Loading

0 comments on commit 4e2d8d3

Please sign in to comment.