[Xamarin.Android.Build.Tasks] Insert newlines between types (#790) #825
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Fixes: https://bugzilla.xamarin.com/show_bug.cgi?id=59036 When building a project with `$(AndroidEnableMultiDex)`=True, an `obj/$(Configuration)/multidex.keep` file is generated, which is a list of Java classes, one per line, which should be placed into the "main" `.dex` file for the application. Unfortunately, commit 6829b7d results in a `multidex.keep` file which places all types onto a single line, instead of one class per line. This results in *breaking* multidex, as when this happens, nothing ensures that the required types are in the main `.dex` file, which could prevent the app from launching on the target device. Fix the `<CreateMultiDexMainDexClassList/>` task by always appending a newline after every type which should be preserved.
jonpryor
pushed a commit
that referenced
this pull request
Apr 22, 2021
Context: dotnet/java-interop@ebd7d76 Context: dotnet/java-interop@f9faaab Changes: dotnet/java-interop@a3de91e...f9faaab * dotnet/java-interop@f9faaaba: [jcw-gen] Skip interface types (#825) * dotnet/java-interop@64399900: [Java.Interop.Tools.JavaCallableWrappers] Fix typo. * dotnet/java-interop@ebd7d761: [Java.Interop.Tools.JavaCallableWrappers] Include interfaces in type maps (#824) * dotnet/java-interop@002dea4a: Bump to xamarin/xamarin-android-tools/main@d92fc3e3 (#823) Fix a runtime assertion failure within a `Java.Interop.JniPeerMembers` constructor when `JniRuntime.JniTypeManager.GetTypeSignature()` is used with a bound interface type: var type = typeof(global::Java.Lang.Iterable); var sig = JniEnvironment.Runtime.TypeManager.GetTypeSignature(type); var jniType = sig.JniTypeName; The expectation is that `jniType` should be `java/lang/Iterable`. In actuality, `jniType` was the empty string `""`. When `JniTypeSignature.JniTypeName` didn't match the expected value, an assertion failed, causing the app to crash: ---- DEBUG ASSERTION FAILED ---- ---- Assert Short Message ---- ManagedPeerType <=> JniTypeName Mismatch! javaVM.GetJniTypeInfoForType(typeof(Java.Lang.IIterable)).JniTypeName="" != "java/lang/Iterable" ---- Assert Long Message ---- at System.Diagnostics.DebugProvider.Fail(String message, String detailMessage) at System.Diagnostics.Debug.Fail(String message, String detailMessage) at System.Diagnostics.Debug.Assert(Boolean condition, String message, String detailMessage) at System.Diagnostics.Debug.Assert(Boolean condition, String message) at Java.Interop.JniPeerMembers..ctor(String jniPeerTypeName, Type managedPeerType, Boolean checkManagedPeerType, Boolean isInterface) Process terminated due to "ManagedPeerType <=> JniTypeName Mismatch! javaVM.GetJniTypeInfoForType(typeof(Java.Lang.IIterable)).JniTypeName="" != "java/lang/Iterable" … The "cause" of the crash is that type map files did not contain interfaces. There was no actual "need" to store typemap data for interfaces, as the most common use of `JniPeerMembers` was for bound types, and our interface bindings (mostly) didn't use `JniPeerMembers`, so the lack of typemap data for interfaces wasn't a problem. This "lack of need" changed with dotnet/java-interop@29f97075, when Java default interface methods were bound as C# Interface Default Members. *Now*, interface bindings *can* use `JniPeerMembers`: public partial interface IIterable : IJavaObject, IJavaPeerable { private static readonly JniPeerMembers _members = new XAPeerMembers ("java/lang/Iterable", typeof (IIterable), isInterface: true); virtual unsafe void ForEach(Java.Util.Functions.IConsumer action) => … } *However*, the assertion is only reached if a default interface method is executed, as that's what causes e.g. `IIterable._members` to be constructed, triggering the assertion. Related question: why didn't we see this back in Fall 2020? Two reasons: 1. Most important, this was a `Debug.Assert()` assertion, which in turn requires that the assembly be built with `DEBUG` defined. This is *never* the case for assemblies shipped to customers; those are built in the Release configuration. Thus, this could only happen to developers/maintainers of Xamarin.Android. 2. When *Mono* is used, `Debug.Assert()` prints out a message, and continues execution. The process does not crash. This changes with .NET 6: `Debug.Assert()` failures will abort the process! Thus, the only "reasonable" way to trigger this assert was to: 1. Be a maintainer of xamarin-android, and have Debug builds of the product. 2. Be running on .NET 6. 3. "Just happen" to be running an app that makes use of interface default members. In this particular case, the [HelloMaui][0] sample. The fix is twofold: 1. Start including interfaces within typemaps. 2. Update Java Callable Wrapper generation to *ignore* interfaces. This is necessary because our Java Callable Wrapper infrastructure doesn't support "exporting" C# interfaces to Java, and will thus throw an exception if we attempt to do so. This allows `HelloMaui` to launch on .NET 6 with Debug builds of Xamarin.Android without triggering the assertion. [0]: https://github.com/dotnet/net6-mobile-samples/tree/46129f85d78b55589280e5bb0ea399bb1dd72167/HelloMaui
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes: https://bugzilla.xamarin.com/show_bug.cgi?id=59036
When building a project with
$(AndroidEnableMultiDex)=True, anobj/$(Configuration)/multidex.keepfile is generated, which is alist of Java classes, one per line, which should be placed into the
"main"
.dexfile for the application.Unfortunately, commit 6829b7d results in a
multidex.keepfile whichplaces all types onto a single line, instead of one class per line.
This results in breaking multidex, as when this happens, nothing
ensures that the required types are in the main
.dexfile, whichcould prevent the app from launching on the target device.
Fix the
<CreateMultiDexMainDexClassList/>task by always appending anewline after every type which should be preserved.