[Xamarin.Android.Build.Tasks] Prevent `$(AndroidUseLatestPlatformSdk)` from using Unstable APIs #1228

dellis1972 · 2018-01-24T15:49:04Z

Currently when a user sets $(AndroidUseLatestPlatformSdk) it will
automatically use the Max ApiLevel. This is not always a stable
ApiLevel. It is highly possible that it will be unstable.
Users will generally want to keep to the Max Stable in this senario.

This commit alters the code so that we use the latest Max Stable
ApiLevel when using $(AndroidUseLatestPlatformSdk).
However we should still allow users to use the unstable ones if
they really want to. This can be achieved in a number of ways

Turn off $(AndroidUseLatestPlatformSdk) and set the
$(TargetFrameworkVersion) directly.
Leave $(AndroidUseLatestPlatformSdk) on and set the
$(TargetFrameworkVersion) directly.

So effectviely, just manually target the unstable Api. But it
is something the user will need to think about and do manaully.
By default we will only use to the latest stable ApiLevel.

dellis1972 · 2018-01-30T14:01:03Z

build

jonpryor · 2018-01-30T22:29:29Z

The macOS+xbuild PR Build is failing:

MESSAGE: Build should have succeeded
  Expected: True
  But was:  False

dellis1972 · 2018-02-05T14:09:33Z

build

jonpryor · 2018-02-14T20:23:49Z

src/Xamarin.Android.Build.Tasks/Tasks/ResolveSdksTask.cs

+					var userSelected = MonoAndroidHelper.SupportedVersions.GetApiLevelFromFrameworkVersion (TargetFrameworkVersion);
+					// overwrite using user version only if it is 
+					// above the maxStableApi and a valid apiLevel.
+					if (userSelected != null && userSelected > maxSupported && userSelected <= maxInstalled) {


None of this make sense. :-(

The use case is this: "soon", Google will presumably release API-P in alpha form, for release as API-28 this fall.

When we provide a binding, it will probably be $(TargetFrameworkVersion)=v8.99.

Assuming the user has v8.99 installed -- how that's done is "elsewhere" -- the user should be able to opt in to using it by setting $(TargetFrameworkVersion)=v8.99.

Thus, !string.IsNullOrWhiteSpace (TargetFrameworkVersion) (line 433) will be true.

userSelected (line 434), meanwhile, will be null, as there is no API level for unstable APIs. Relatedly, MonoAndroidHelper.SupportedVersions.GetIdFromFrameworkVersion("v8.99") will return "P".

Similarly, maxInstalled comes from int.TryParse() comes from GetMaxInstalledApiLevel(), which only looks at values which can be parsed into an int. As such, API-P will not be present or used, meaning -- for our current exercise -- AndroidApiLevel is ~useless. Consequently, maxInstalled is likewise useless.

In short, I don't see how this will do what we want it to do. :-(

jonpryor · 2018-02-14T20:25:40Z

src/Xamarin.Android.Build.Tasks/Tests/Xamarin.Android.Build.Tests/BuildTest.cs

+				new ApiInfo () { Id = 23, Level = 23, Name = "Marshmallow", FrameworkVersion = "v6.0", Stable = true },
+				new ApiInfo () { Id = 26, Level = 26, Name = "Oreo", FrameworkVersion = "v8.0", Stable = true },
+				new ApiInfo () { Id = 27, Level = 27, Name = "Oreo", FrameworkVersion = "v8.1", Stable = false },
+			});


For the test case, we need to add:

new ApiInfo () { Id = "P", Level = 28, Name = "P", FrameworkVersion="v8.99", Stable = false },

(This is why AndroidApiInfo.xml differentiates Id from Level. They're the same for all stable API levels, but for preview API levels they are not.)

jonpryor · 2018-02-14T20:26:55Z

tools/scripts/xabuild

+		if [ -z "$XBUILD_FRAMEWORK_FOLDERS_PATH" ]; then
+			export XBUILD_FRAMEWORK_FOLDERS_PATH="$TARGETS_DIR-frameworks"
+		else 
+			export XBUILD_FRAMEWORK_FOLDERS_PATH="$XBUILD_FRAMEWORK_FOLDERS_PATH"


Why does the environment have $XBUILD_FRAMEWORK_FOLDERS_PATH already exported, and why should we be using it in preference to the computed value?

We need to be able to override it to the Faux location as part of the unit tests. If we don't it will pick up the bin\Debug path which we don't want. Is there a better way of doing it?

No, I can't think of a better way, though this will only work with xbuild, not msbuild.

Perhaps a "better" (or just different?) way would be to define a new environment variable, e.g. $__MSBUILD_FRAMEWORK_FOLDERS_PATH_OVERRIDE, and use that if it's set. We'd also want to update the msbuild-based codepath to follow suit, perhaps via setting $(TargetFrameworkRootPath)?

One problem with the current xabuild script, though: the msbuild-specific logic on line 133 happens after we exec xabuild.exe on line 86, meaning line 133/etc. is superfluous. This should be corrected.

msbuild will use the TargetFrameworkRootPath as a parameter so msbuild support works. xbuild ignores or doesn't use TargetFrameworkRootPath so thats why I needed to use the envvar.

dellis1972 · 2018-02-19T15:00:30Z

if we merge #1321 I can add actual tests for this logic :)

dellis1972 · 2018-02-21T10:41:48Z

@jonpryor Given the following bindings are available can you confirm the correct behaviour (assuming the required java platforms are installed).

v8.0 => API 26
v8.1 => API 27
v8.99 => API 28 (P)

UseLatestPlatformSdk	TargetFrameworkVersion	Result
True	v8.99	v8.99
True	v8.1	v8.1
True	v8.0	v8.1
True	null	v8.1
True	v6.0	v8.1
False	v8.99	v8.99
False	v8.1	v8.1
False	null	v8.1
False	v8.0	v8.0
False	v6.0	XA0001

jonpryor · 2018-02-21T16:46:46Z

@dellis1972: that table mostly looks correct. However, this line seems weird:

UseLatestPlatformSdk	TargetFrameworkVersion	Result
False	null	v8.1

If $(TargetFrameworkVersion) isn't set, and $(UseLatestPlatformSdk) is False, shouldn't this be an XA0001 error, as null is not a valid $(TargetFrameworkVersion) value?

…` from using Unstable APIs Fixes dotnet#1221 Currently when a user sets `$(AndroidUseLatestPlatformSdk)` it will automatically use the Max ApiLevel. This is not always a stable ApiLevel. It is highly possible that it will be unstable. Users will generally want to keep to the Max Stable in this senario. This commit alters the code so that we use the latest Max Stable ApiLevel when using `$(AndroidUseLatestPlatformSdk)`. However we should still allow users to use the unstable ones if they really want to. This can be achieved in a number of ways 1. Turn off `$(AndroidUseLatestPlatformSdk)` and set the `$(TargetFrameworkVersion)` directly. 2. Leave `$(AndroidUseLatestPlatformSdk)` on and set the `$(TargetFrameworkVersion)` directly. So effectviely, just manually target the unstable Api. But it is something the user will need to think about and do manaully. By default we will only use to the latest stable ApiLevel.

dellis1972 · 2018-02-23T10:37:58Z

@jonpryor if you take a look at [1]. In ValidateApiLevels if TargetFrameworkVersion is null or empty, we default to UseLatestAndroidPlatformSdk to true. So in that test case we won't expect an error we will expected the latest stable TargetFrameworkVersion. This behaviour has been in the code base for quite a while. If its wrong we can change it, but I suspect it will break customers if they don't have TargetFrameworkVersion set. After upgrade boom.. :/

[1] https://github.com/xamarin/xamarin-android/blob/master/src/Xamarin.Android.Build.Tasks/Tasks/ResolveSdksTask.cs#L421

…TABLE levels (#1228) Fixes: #1221 Currently when a user sets `$(AndroidUseLatestPlatformSdk)` it will automatically use the maximum known API level. This is not always a stable ApiLevel, e.g. when a preview API level has been bound, and the binding has been installed. Users will generally want to use the maximum *stable* API level when `$(AndroidUseLatestPlatformSdk)` is True. Alters things so that we use the maximum Stable API level when `$(AndroidUseLatestPlatformSdk)` is True. However, allow users to use unstable API levels if desired. This can be achieved by setting `$(TargetFrameworkVersion)` to the desired unstable framework version. (For example, when API-O was in preview, this would be `v7.99`. When API-P is presumably announced, it will be bound as `v8.99`.) This will require a *manual* change to the `.csproj`, as we do not anticipate the IDEs showing unstable API levels (though this could plausibly be done with sufficient warnings...).

Context: #6353 Changes: xamarin/monodroid@07a99d7...9b3a37a * xamarin/monodroid@9b3a37af1: [tools/msbuild] <GetPrimaryCpuAbi/> should not select 32-bit ABIs (#1228) Update `MonoAndroidExportTest.MonoAndroidExportReferencedAppStarts()` under .NET 6 to add `x86_64`, e.g. `$(AndroidSupportedAbis)`=`armeabi-v7a;x86;x86_64`. This is needed because the API-31 emulator only supports x86_64, not x86.

dellis1972 force-pushed the Issue1221 branch from 133767b to 28d8d62 Compare February 1, 2018 16:38

dellis1972 force-pushed the Issue1221 branch 3 times, most recently from 520e940 to 653786b Compare February 13, 2018 15:36

dellis1972 force-pushed the Issue1221 branch from 653786b to 3cea623 Compare February 14, 2018 16:08

jonpryor reviewed Feb 14, 2018

View reviewed changes

dellis1972 added the Area: App+Library Build Issues when building Library projects or Application projects. label Feb 19, 2018

dellis1972 force-pushed the Issue1221 branch 2 times, most recently from e576b14 to 042b1dd Compare February 20, 2018 19:01

dellis1972 added 13 commits February 23, 2018 10:17

Fixed test to run under xbuild

5f71b0a

Allow the logging of build logs

9d098c6

ff

72068b1

ff

0394717

ff

4f04646

ff

2261f32

ff

2422c7a

ff

25a90d6

ff

a595d2c

ff

2cb6d32

ff

9e3bde9

ff

8a3ec62

dellis1972 added 2 commits February 23, 2018 10:17

Added more test cases

d2460d3

Clean up the ResolveSdksTaskTests a bit

35b248f

dellis1972 force-pushed the Issue1221 branch from 7b63603 to 35b248f Compare February 23, 2018 10:40

jonpryor merged commit 0780e27 into dotnet:master Feb 23, 2018

github-actions bot locked and limited conversation to collaborators Feb 4, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Xamarin.Android.Build.Tasks] Prevent `$(AndroidUseLatestPlatformSdk)` from using Unstable APIs #1228

[Xamarin.Android.Build.Tasks] Prevent `$(AndroidUseLatestPlatformSdk)` from using Unstable APIs #1228

dellis1972 commented Jan 24, 2018

dellis1972 commented Jan 30, 2018

jonpryor commented Jan 30, 2018

dellis1972 commented Feb 5, 2018

jonpryor Feb 14, 2018

jonpryor Feb 14, 2018

jonpryor Feb 14, 2018

dellis1972 Feb 19, 2018

jonpryor Feb 19, 2018

dellis1972 Feb 19, 2018

dellis1972 commented Feb 19, 2018

dellis1972 commented Feb 21, 2018 •

edited

Loading

jonpryor commented Feb 21, 2018

dellis1972 commented Feb 23, 2018

[Xamarin.Android.Build.Tasks] Prevent $(AndroidUseLatestPlatformSdk) from using Unstable APIs #1228

[Xamarin.Android.Build.Tasks] Prevent $(AndroidUseLatestPlatformSdk) from using Unstable APIs #1228

Conversation

dellis1972 commented Jan 24, 2018

dellis1972 commented Jan 30, 2018

jonpryor commented Jan 30, 2018

dellis1972 commented Feb 5, 2018

jonpryor Feb 14, 2018

Choose a reason for hiding this comment

jonpryor Feb 14, 2018

Choose a reason for hiding this comment

jonpryor Feb 14, 2018

Choose a reason for hiding this comment

dellis1972 Feb 19, 2018

Choose a reason for hiding this comment

jonpryor Feb 19, 2018

Choose a reason for hiding this comment

dellis1972 Feb 19, 2018

Choose a reason for hiding this comment

dellis1972 commented Feb 19, 2018

dellis1972 commented Feb 21, 2018 • edited Loading

jonpryor commented Feb 21, 2018

dellis1972 commented Feb 23, 2018

[Xamarin.Android.Build.Tasks] Prevent `$(AndroidUseLatestPlatformSdk)` from using Unstable APIs #1228

[Xamarin.Android.Build.Tasks] Prevent `$(AndroidUseLatestPlatformSdk)` from using Unstable APIs #1228

dellis1972 commented Feb 21, 2018 •

edited

Loading