.NET Android Release Build( AAB) does not honor AndroidBundleConfigurationFile #10097

cgrant78 · 2025-05-01T18:34:34Z

Android framework version

net8.0-android

Affected platform version

VS 2022

Description

When setting the .NET MSBuild property 'AndroidBundleConfigurationFile' to a custom BundConfig.json file, the build process does not use the custom file. Inspection of the build log shows the bundletool using a temp file ( assuming some default build generated file) for the --config options instead of the file specified via the AndroidBundleConfigurationFile property.
Initially I thought this issue was caused by Uno SDK build configuration, but I create a simple .NET MAUI app using the default template and the behavior is the same. The side-effect of this is that the app binaries are not getting extracted. I've seen a few Issues that claim to have this resolved, but I don't see how. Using the system loader to load the shared object will always work, using any other means, ex fopen etc will fail.

Steps to Reproduce

MauiApp1.zip

Extract the attached zip file content, build and deploy the Android Release configuration to an emulator or device. Observe the Deploy target does not use the custom BundleConfig.json.

Did you find any workaround?

No.

Relevant log output

Skipping target "_ManifestMerger" because all output files are up-to-date with respect to the input files.
Skipping target "_ConvertCustomView" because all output files are up-to-date with respect to the input files.
Skipping target "_AddStaticResources" because all output files are up-to-date with respect to the input files.
Skipping target "_GeneratePackageManagerJava" because all output files are up-to-date with respect to the input files.
Skipping target "_GenerateAndroidAssetsDir" because all output files are up-to-date with respect to the input files.
Touching "E:\dev\camtastik\Camtastik\_build\Camtastik\Release\net8.0-android\android\bin\packaged_resources".
Skipping target "_CompileJava" because all output files are up-to-date with respect to the input files.
Skipping target "_CompileNativeAssemblySources" because all output files are up-to-date with respect to the input files.
Skipping target "_CreateApplicationSharedLibraries" because all output files are up-to-date with respect to the input files.
Skipping target "_CompileToDalvik" because all output files are up-to-date with respect to the input files.
C:\Program Files (x86)\Android\openjdk\jdk-17.0.12\bin\java.exe -Xmx1G -jar "C:\Program Files\dotnet\packs\Microsoft.Android.Sdk.Windows\34.0.147\tools\bundletool.jar" build-bundle --modules E:\dev\camtastik\Camtastik\_build\Camtastik\Release\net8.0-android\android\bin\base.zip --output E:\dev\camtastik\Camtastik\_build\Camtastik\Release\net8.0-android\android\bin\com.atlasmultimedia.Camtastik.aab --config C:\Users\cgrant1\AppData\Local\Temp\tmpCE12.tmp --metadata-file=com.android.tools.build.obfuscation/proguard.map:E:\dev\camtastik\Camtastik\_build\Release\net8.0-android\mapping.txt

jonathanpeppers · 2025-05-01T18:50:03Z

The code merges the file you pass in with some required settings:

android/src/Xamarin.Android.Build.Tasks/Xamarin.Android.Common.targets

Lines 2382 to 2396 in 6a27915

    
           <BuildAppBundle 
        
               Condition=" '$(AndroidPackageFormat)' == 'aab' " 
        
               ToolPath="$(JavaToolPath)" 
        
               JavaMaximumHeapSize="$(JavaMaximumHeapSize)" 
        
               JavaOptions="$(JavaOptions)" 
        
               JarPath="$(AndroidBundleToolJarPath)" 
        
               BaseZip="$(_BaseZipIntermediate)" 
        
               Modules="@(AndroidAppBundleModules)" 
        
               Output="$(_AppBundleIntermediate)" 
        
               UncompressedFileExtensions="$(AndroidStoreUncompressedFileExtensions)" 
        
               CustomBuildConfigFile="$(AndroidBundleConfigurationFile)" 
        
               MetaDataFiles="@(AndroidAppBundleMetaDataFile)" 
        
               IntermediateOutputPath="$(IntermediateOutputPath)" 
        
               AssemblyIdentityMapFile="$(_AndroidLibrayProjectAssemblyMapFile)" 
        
           />

android/src/Xamarin.Android.Build.Tasks/Tasks/BuildAppBundle.cs

Lines 93 to 108 in 6a27915

    
           JsonNode json = JsonNode.Parse ("{}")!; 
        
           if (!string.IsNullOrEmpty (CustomBuildConfigFile) && File.Exists (CustomBuildConfigFile)) { 
        
           	using Stream fs = File.OpenRead (CustomBuildConfigFile); 
        
           	using JsonDocument doc = JsonDocument.Parse (fs, new JsonDocumentOptions { AllowTrailingCommas = true }); 
        
           	json = doc.RootElement.ToNode (); 
        
           } 
        
           var jsonAddition = new { 
        
           	compression = new { 
        
           		uncompressedGlob = uncompressed, 
        
           	} 
        
           }; 
        
           var jsonAdditionDoc = JsonSerializer.SerializeToNode (jsonAddition); 
        
           var mergedJson = json.Merge (jsonAdditionDoc); 
        
           var output = mergedJson.ToJsonString (new JsonSerializerOptions { WriteIndented = true });

Can you share a .binlog of this not working? https://aka.ms/binlog

There is a test checking it generally works:

android/tests/MSBuildDeviceIntegration/Tests/BundleToolNoAbiSplitTests.cs

Line 108 in 6a27915

app.SetProperty ("AndroidBundleConfigurationFile", "buildConfig.config");

android/tests/MSBuildDeviceIntegration/Tests/BundleToolNoAbiSplitTests.cs

Line 127 in 6a27915

    
           Assert.AreEqual (app_config.ignore_split_configs, true, $"App config should indicate that split configs must be ignored");

cgrant78 · 2025-05-01T20:41:47Z

Hi @@cgrant78. We have added the "need-info" label to this issue, which indicates that we have an open question for you before we can take further action. This issue will be closed automatically in 7 days if we do not hear back from you by then - please feel free to re-open it if you come back to this issue after that time.

Good to know that the fine contents is being merged in with some defaults. My assumption is base on the fact that with the attached BundleConfig.json , I am still not seeing my shared libraries getting extracted to where they should be.

I've attached a binlog ( the last timestamped one in the output directory) as well as the BuildConfig.json used.

CentralNode_devenv_PID=4144_x64_BuildManager_Default.zip

BundleConfig.json

jonathanpeppers · 2025-05-01T20:44:48Z

I am still not seeing my shared libraries getting extracted to where they should be.

Are you trying to control the behavior of android:extractNativeLibs="true"?

I'm not sure if that actually is possible or not. I thought that bundletool forces extractNativeLibs="false", as a way to improve on-disk size.

If you make some other option in your BundleConfig.json, is that working? Like this one, for example:

android/tests/MSBuildDeviceIntegration/Tests/BundleToolNoAbiSplitTests.cs

Lines 23 to 36 in 6a27915

    
           		// Disable split by ABI 
        
           		const string BuildConfig = @"{ 
        
             ""compression"": { }, 
        
               ""optimizations"": { 
        
                 ""splitsConfig"": { 
        
                   ""splitDimension"": [ 
        
                     { 
        
                       ""value"": ""ABI"", 
        
                       ""negate"": true 
        
                     } 
        
                   ], 
        
                 } 
        
               } 
        
           }";

jonathanpeppers · 2025-05-01T20:46:21Z

CentralNode_devenv_PID=4144_x64_BuildManager_Default.zip

This .binlog doesn't contain the <BuildAppBundle/> task running. Can you record one at the command-line? dotnet build -c Release -bl

cgrant78 · 2025-05-01T21:08:03Z

Are you trying to control the behavior of android:extractNativeLibs="true"?

That is correct.

I'm not sure if that actually is possible or not. I thought that bundletool forces extractNativeLibs="false", as a way to improve on-disk size.

So therein lies my confusion, as I've seen using a custom bundle configuration file propose at the solution to this problem is a few issues for this repro.

Making changes to the bundle configuration file doesn't reflect, as I set it not to split along ABI, and I still see the split.

Working on getting you a valid binlog

cgrant78 · 2025-05-01T21:21:19Z

Disregards that last binlog as, it was from a more complex app and not the one I initially attached. Here is the binlog for the attached app, building just the net8.0-android framework.

msbuild.zip

jonathanpeppers · 2025-05-05T17:58:01Z

The .binlog prints the log message:

BundleConfig.json: {
  "optimizations": {
    "splits_config": {
      "split_dimension": [
        {
          "value": "ABI",
          "negate": false
        }
      ]
    },
    "uncompress_native_libraries": {
      "enabled": false
    }
  },
  "compression": {
    "uncompressedGlob": [
      "typemap.mj",
      "typemap.jm",
      "assemblies/**",
      "**/*.3g2",
      "**/*.3gp",
      "**/*.3gpp",
      "**/*.3gpp2",
      "**/*.aac",
      "**/*.amr",
      "**/*.awb",
      "**/*.gif",
      "**/*.imy",
      "**/*.jet",
      "**/*.jpeg",
      "**/*.jpg",
      "**/*.m4a",
      "**/*.m4v",
      "**/*.mid",
      "**/*.midi",
      "**/*.mkv",
      "**/*.mp2",
      "**/*.mp3",
      "**/*.mp4",
      "**/*.mpeg",
      "**/*.mpg",
      "**/*.ogg",
      "**/*.png",
      "**/*.rtttl",
      "**/*.smf",
      "**/*.wav",
      "**/*.webm",
      "**/*.wma",
      "**/*.wmv",
      "**/*.xmf",
      "**/*.blob"
    ]
  }
}

This looks to be a merged combination of .NET for Android's defaults, and your input file:

{
  "optimizations": {
    "splits_config": {
      "split_dimension": [{
        "value": "ABI",
        "negate": false
      }]
    },
	"uncompress_native_libraries": {
	  "enabled": false
	}
  }
}

If you are asking about bundletool behavior, do we need to file an issue here instead?

https://github.com/google/bundletool/issues

cgrant78 · 2025-05-05T18:02:18Z

That would seem to be direction based on your finding. Thanks for looking into the issue.

cgrant78 added Area: App+Library Build Issues when building Library projects or Application projects. needs-triage Issues that need to be assigned. labels May 1, 2025

cgrant78 assigned jonathanpeppers May 1, 2025

jonathanpeppers added need-info Issues that need more information from the author. and removed needs-triage Issues that need to be assigned. labels May 1, 2025

jonathanpeppers added this to the Under Consideration milestone May 1, 2025

dotnet-policy-service bot added need-attention A xamarin-android contributor needs to review and removed need-info Issues that need more information from the author. labels May 1, 2025

jonathanpeppers added need-info Issues that need more information from the author. and removed need-attention A xamarin-android contributor needs to review labels May 5, 2025

dotnet-policy-service bot added need-attention A xamarin-android contributor needs to review and removed need-info Issues that need more information from the author. labels May 5, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

.NET Android Release Build( AAB) does not honor AndroidBundleConfigurationFile #10097

.NET Android Release Build( AAB) does not honor AndroidBundleConfigurationFile #10097

cgrant78 commented May 1, 2025

jonathanpeppers commented May 1, 2025

cgrant78 commented May 1, 2025

jonathanpeppers commented May 1, 2025 •

edited

Loading

jonathanpeppers commented May 1, 2025

cgrant78 commented May 1, 2025 •

edited

Loading

cgrant78 commented May 1, 2025

jonathanpeppers commented May 5, 2025 •

edited

Loading

cgrant78 commented May 5, 2025

.NET Android Release Build( AAB) does not honor AndroidBundleConfigurationFile #10097

.NET Android Release Build( AAB) does not honor AndroidBundleConfigurationFile #10097

Comments

cgrant78 commented May 1, 2025

Android framework version

Affected platform version

Description

Steps to Reproduce

Did you find any workaround?

Relevant log output

jonathanpeppers commented May 1, 2025

cgrant78 commented May 1, 2025

jonathanpeppers commented May 1, 2025 • edited Loading

jonathanpeppers commented May 1, 2025

cgrant78 commented May 1, 2025 • edited Loading

cgrant78 commented May 1, 2025

jonathanpeppers commented May 5, 2025 • edited Loading

cgrant78 commented May 5, 2025

jonathanpeppers commented May 1, 2025 •

edited

Loading

cgrant78 commented May 1, 2025 •

edited

Loading

jonathanpeppers commented May 5, 2025 •

edited

Loading