Support for desugaring Java 17 Records.

There are three dex flows:

* mobile-install: This uses the dex archive format of the globals
* optimized: this uses the class JAR formate of the globals
* non-optimized: this passes the plain globals directly to the dexmerger

One input to the command to generate the globals file is the min SDK version. For now we have a global value. This means we can define the targets using genrules. If the min SDK version becomes dynamic based on a configuration value the targets will have to be ported to custom rules.

The open source flow doesn't work currently but most of the components are there.

PiperOrigin-RevId: 688746011
Change-Id: I9abfdb209580598f02fd03b884301b3d2f1e7c05

Author: ajsinclair

mobile_install/BUILD

@@ -31,16 +31,14 @@ bzl_library(
         ],
     ),
     deps = [
-        ":constants",
-        ":launcher_direct",
         ":providers",
-        ":resources",
         ":transform",
         ":utils",
         "//mobile_install/adapters:bzl",
-        "//rules:bzl",
         "//rules:min_sdk_version_bzl",
+        "//rules:utils_bzl",
         "//rules:visibility_bzl",
+        "//rules/flags:bzl",
         "@rules_java//java/common",
     ],
 )

mobile_install/mi.bzl

@@ -14,7 +14,7 @@
 """Aspect for mobile-install."""
 
 load("//rules:min_sdk_version.bzl", "min_sdk_version")
-load("//rules:utils.bzl", "ANDROID_SDK_TOOLCHAIN_TYPE")
+load("//rules:utils.bzl", "ANDROID_SDK_TOOLCHAIN_TYPE", "ANDROID_TOOLCHAIN_TYPE")
 load("//rules:visibility.bzl", "PROJECT_VISIBILITY")
 load("//rules/flags:flags.bzl", "flags")
 load("@rules_java//java/common:java_info.bzl", "JavaInfo")
@@ -85,6 +85,7 @@ def make_aspect(
         implementation = aspect_impl,
         toolchains = [
             ANDROID_SDK_TOOLCHAIN_TYPE,
+            ANDROID_TOOLCHAIN_TYPE,
         ],
         **opt_kwargs
     )

mobile_install/process.bzl

@@ -13,6 +13,7 @@
 # limitations under the License.
 """Processes the target or collected data."""
 
+load("//rules:utils.bzl", "get_android_toolchain", "utils")
 load("//rules:visibility.bzl", "PROJECT_VISIBILITY")
 load(":apks.bzl", "make_split_apks")
 load(":native_libs.bzl", "make_native_zip", "make_swigdeps_file")
@@ -81,6 +82,9 @@ def process(
         sibling,
     )
 
+    if hasattr(get_android_toolchain(ctx), "desugar_globals_dex_archive"):
+        merged_dex_shards.append(utils.only(get_android_toolchain(ctx).desugar_globals_dex_archive.files.to_list()))
+
     # Creates the custom R.
     r_dex = make_r(
         ctx,

rules/acls/record_desugaring.bzl

@@ -13,10 +13,6 @@
 # limitations under the License.
 """Allowlist to enable Java 17 Record desugaring."""
 
-load("//rules:visibility.bzl", "PROJECT_VISIBILITY")
-
-visibility(PROJECT_VISIBILITY)
-
 # keep sorted
 RECORD_DESUGARING_ROLLOUT = [
 ]

rules/android_binary/impl.bzl

@@ -466,6 +466,8 @@ def _process_deploy_jar(ctx, validation_ctx, stamp_ctx, packaged_resources_ctx,
     dex_archives = info.dex_archives_dict.get("".join(incremental_dexopts), depset()).to_list()
     if ctx.fragments.android.desugar_java8:
         desugared_jars = []
+        if acls.in_record_desugaring_rollout(str(ctx.label)):
+            desugared_jars.append(utils.only(get_android_toolchain(ctx).desugar_globals_jar.files.to_list()))
         desugar_dict = {d.jar: d.desugared_jar for d in dex_archives if d.desugared_jar}
 
         for jar in binary_runtime_jars:

rules/dex.bzl

@@ -189,15 +189,22 @@ def _process_incremental_dexing(
             toolchain_type = toolchain_type,
         )
 
-        # TODO(b/130571505): Implement this after SpawnActionTemplate is supported in Starlark
-        android_common.create_dex_merger_actions(
-            ctx,
+        # TODO(asinclair): Remove this once the rollout is complete.
+        dex_merger_actions_args = dict(
             output = dexes,
             input = shards,
             dexopts = dexopts,
             dexmerger = dexmerger,
             min_sdk_version = min_sdk_version,
         )
+        if acls.in_record_desugaring_rollout(str(ctx.label)):
+            dex_merger_actions_args["desugar_globals"] = utils.only(get_android_toolchain(ctx).desugar_globals.files.to_list())
+
+        # TODO(b/130571505): Implement this after SpawnActionTemplate is supported in Starlark
+        android_common.create_dex_merger_actions(
+            ctx,
+            **dex_merger_actions_args
+        )
         _java.singlejar(
             ctx,
             output = output,

src/java/com/example/sampleapp/AndroidManifest.xml

@@ -3,7 +3,7 @@
   package="com.example.sampleapp"
       android:versionCode="1"
       android:versionName="1.0">
-    <uses-sdk android:minSdkVersion="21" />
+    <uses-sdk android:minSdkVersion="21" android:targetSdkVersion="34"/>
     <application android:label="@string/app_name"
                  android:debuggable="true">
         <activity android:name=".SampleApp"

src/java/com/example/sampleapp/SampleApp.java

@@ -28,7 +28,11 @@ public class SampleApp extends Activity {
   public void onCreate(Bundle state) {
     super.onCreate(state);
 
+    SampleRecord record = new SampleRecord("name", 1);
+
     setContentView(R.layout.basic_activity);
+    TextView tv = findViewById(R.id.record_text);
+    tv.setText(record.toString());
   }
 
   public native String getString();

src/java/com/example/sampleapp/SampleRecord.java

@@ -0,0 +1,18 @@
+/*
+ * Copyright 2024 The Bazel Authors. All rights reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package com.example.sampleapp;
+
+public record SampleRecord(String name, int value) {}

src/java/com/example/sampleapp/res/layout/basic_activity.xml

@@ -9,4 +9,10 @@
         android:layout_width="wrap_content"
         android:layout_height="wrap_content" />
 
+        <TextView
+        android:id="@+id/record_text"
+        android:text="@string/hello_world"
+        android:layout_width="wrap_content"
+        android:layout_height="wrap_content" />
+
 </LinearLayout>