Add Android Record Module

android-record/README.md

@@ -0,0 +1,31 @@
+Module that allows deserialization into records on Android, 
+where java records are supported through desugaring, 
+and Jackson's built-in support for records doesn't work, 
+since the desugared classes have a non-standard super class, 
+and record component-related reflection methods are missing.
+
+See [Android Developers Blog article](https://android-developers.googleblog.com/2023/06/records-in-android-studio-flamingo.html)
+
+Note: this module is a no-op when no Android-desugared records are being deserialized,
+so it is safe to use in code shared between Android and non-Android platforms.
+
+## Usage
+
+Functionality can be used by registering the module and then just deserializing things
+using regular API:
+
+```java
+ObjectMapper mapper = JsonMapper.builder() // or mapper for other dataformats
+  .addModule(new AndroidRecordModule())
+    // add other modules, configure, etc
+    .build();
+```
+
+Maven information for jar is:
+
+* Group id: `com.fasterxml.jackson.module`
+* Artifact id: `jackson-module-android-record`
+
+## Other
+
+For Javadocs, Download, see: [Wiki](../../wiki).

android-record/pom.xml

@@ -0,0 +1,79 @@
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+    <!-- This module was also published with a richer model, Gradle metadata,  -->
+    <!-- which should be used instead. Do not delete the following line which  -->
+    <!-- is to indicate to Gradle or any Gradle module metadata file consumer  -->
+    <!-- that they should prefer consuming it instead. -->
+    <!-- do_not_remove: published-with-gradle-metadata -->
+    <parent>
+        <groupId>com.fasterxml.jackson.module</groupId>
+        <artifactId>jackson-modules-base</artifactId>
+        <version>2.16.0-SNAPSHOT</version>
+    </parent>
+    <modelVersion>4.0.0</modelVersion>
+
+    <artifactId>jackson-module-android-record</artifactId>
+    <name>Jackson module: Android Record Support</name>
+    <packaging>bundle</packaging>
+
+    <description>Support deserialization into records on Android</description>
+    <url>https://github.com/FasterXML/jackson-modules-base</url>
+
+    <licenses>
+        <license>
+            <name>The Apache Software License, Version 2.0</name>
+            <url>https://www.apache.org/licenses/LICENSE-2.0.txt</url>
+            <distribution>repo</distribution>
+        </license>
+    </licenses>
+
+    <properties>
+        <!-- Generate PackageVersion.java into this directory. -->
+        <packageVersion.dir>com/fasterxml/jackson/module/androidrecord</packageVersion.dir>
+        <packageVersion.package>com.fasterxml.jackson.module.androidrecord</packageVersion.package>
+    </properties>
+
+    <dependencies>
+        <dependency>
+            <groupId>com.fasterxml.jackson.core</groupId>
+            <artifactId>jackson-core</artifactId>
+        </dependency>
+        <dependency>
+            <groupId>com.fasterxml.jackson.core</groupId>
+            <artifactId>jackson-databind</artifactId>
+        </dependency>
+    </dependencies>
+
+    <build>
+        <plugins>
+            <plugin>
+                <!-- Inherited from oss-base. Generate PackageVersion.java.-->
+                <groupId>com.google.code.maven-replacer-plugin</groupId>
+                <artifactId>replacer</artifactId>
+                <executions>
+                    <execution>
+                        <id>process-packageVersion</id>
+                        <phase>generate-sources</phase>
+                    </execution>
+                </executions>
+            </plugin>
+
+            <plugin>
+                <groupId>org.moditect</groupId>
+                <artifactId>moditect-maven-plugin</artifactId>
+            </plugin>
+
+            <plugin>
+              <groupId>org.codehaus.mojo</groupId>
+              <artifactId>animal-sniffer-maven-plugin</artifactId>
+              <version>${version.plugin.animal-sniffer}</version>
+              <configuration>
+                <signature>
+                  <groupId>com.toasttab.android</groupId>
+                  <artifactId>gummy-bears-api-${version.android.sdk}</artifactId>
+                  <version>${version.android.sdk.signature}</version>
+                </signature>
+              </configuration>
+            </plugin>
+        </plugins>
+    </build>
+</project>

android-record/src/main/java/com/fasterxml/jackson/module/androidrecord/AndroidRecordModule.java

@@ -0,0 +1,95 @@
+package com.fasterxml.jackson.module.androidrecord;
+
+import com.fasterxml.jackson.databind.BeanDescription;
+import com.fasterxml.jackson.databind.DeserializationConfig;
+import com.fasterxml.jackson.databind.PropertyName;
+import com.fasterxml.jackson.databind.deser.CreatorProperty;
+import com.fasterxml.jackson.databind.deser.SettableBeanProperty;
+import com.fasterxml.jackson.databind.deser.ValueInstantiator;
+import com.fasterxml.jackson.databind.deser.std.StdValueInstantiator;
+import com.fasterxml.jackson.databind.introspect.AnnotatedConstructor;
+import com.fasterxml.jackson.databind.module.SimpleModule;
+
+import java.lang.reflect.Constructor;
+import java.lang.reflect.Field;
+import java.lang.reflect.Modifier;
+import java.lang.reflect.Parameter;
+import java.lang.reflect.Type;
+import java.util.Arrays;
+import java.util.HashMap;
+import java.util.Map;
+import java.util.stream.Stream;
+
+
+/**
+ * Module that allows deserialization into records
+ * using the canonical constructor on Android,
+ * where java records are supported through desugaring,
+ * and Jackson's built-in support for records doesn't work,
+ * since the desugared classes have a non-standard super class,
+ * and record component-related reflection methods are missing.
+ *
+ * <p>
+ * See <a href="https://android-developers.googleblog.com/2023/06/records-in-android-studio-flamingo.html">
+ *   Android Developers Blog article</a>
+ *
+ * <p>
+ * Note: this module is a no-op when no Android-desugared records are being deserialized,
+ * so it is safe to use in code shared between Android and non-Android platforms.
+ *
+ * <p>
+ * Note: The canonical record constructor is found
+ * through matching of parameter types with field types.
+ * Therefore, this module doesn't allow a deserialized desugared record class to have a custom
+ * constructor with a signature that's any permutation of the canonical one's.
+ *
+ * @author Eran Leshem
+ **/
+public class AndroidRecordModule extends SimpleModule {
+  @Override
+  public void setupModule(SetupContext context) {
+    super.setupModule(context);
+    context.addValueInstantiators(AndroidRecordModule::findValueInstantiator);
+  }
+
+  private static ValueInstantiator findValueInstantiator(DeserializationConfig config, BeanDescription beanDesc,
+                                                         ValueInstantiator defaultInstantiator) {
+    Class<?> raw = beanDesc.getType().getRawClass();
+    if (defaultInstantiator instanceof StdValueInstantiator && raw.getSuperclass() != null
+            && raw.getSuperclass().getName().equals("com.android.tools.r8.RecordTag")) {
+      Map<Type, Integer> componentTypes = typeMap(Arrays.stream(raw.getDeclaredFields())
+              .filter(field -> !Modifier.isStatic(field.getModifiers())).map(Field::getGenericType));
+      boolean found = false;
+      for (Constructor<?> constructor: raw.getDeclaredConstructors()) {
+        Parameter[] parameters = constructor.getParameters();
+        Map<Type, Integer> parameterTypes = typeMap(Arrays.stream(parameters).map(Parameter::getParameterizedType));
+        if (! parameterTypes.equals(componentTypes)) {
+          continue;
+        }
+
+        if (found) {
+          throw new IllegalArgumentException(String.format(
+                          "Multiple constructors match set of components for record %s", raw.getName()));
+        }
+
+        SettableBeanProperty[] properties = new SettableBeanProperty[parameters.length];
+        for (int i = 0; i < parameters.length; i++) {
+          Parameter parameter = parameters[i];
+          properties[i] = CreatorProperty.construct(PropertyName.construct(parameter.getName()), config.getTypeFactory()
+                          .constructType(parameter.getParameterizedType()), null, null, null, null, i, null, null);
+        }
+
+        ((StdValueInstantiator) defaultInstantiator).configureFromObjectSettings(null, null, null, null,
+                           new AnnotatedConstructor(null, constructor, null, null), properties);
+        constructor.setAccessible(true);
+        found = true;
+      }
+    }
+
+    return defaultInstantiator;
+  }
+
+  private static Map<Type, Integer> typeMap(Stream<? extends Type> typeStream) {
+    return typeStream.collect(HashMap::new, (map, type) -> map.merge(type, 1, Integer::sum), Map::putAll);
+  }
+}

android-record/src/main/java/com/fasterxml/jackson/module/androidrecord/PackageVersion.java.in

@@ -0,0 +1,20 @@
+package @package@;
+
+import com.fasterxml.jackson.core.Version;
+import com.fasterxml.jackson.core.Versioned;
+import com.fasterxml.jackson.core.util.VersionUtil;
+
+/**
+ * Automatically generated from PackageVersion.java.in during
+ * packageVersion-generate execution of maven-replacer-plugin in
+ * pom.xml.
+ */
+public final class PackageVersion implements Versioned {
+    public final static Version VERSION = VersionUtil.parseVersion(
+        "@projectversion@", "@projectgroupid@", "@projectartifactid@");
+
+    @Override
+    public Version version() {
+        return VERSION;
+    }
+}

android-record/src/main/resources/META-INF/LICENSE

@@ -0,0 +1,8 @@
+This copy of Jackson JSON processor `jackson-module-android-record` module is licensed under the
+Apache (Software) License, version 2.0 ("the License").
+See the License for details about distribution rights, and the
+specific rights regarding derivative works.
+
+You may obtain a copy of the License at:
+
+http://www.apache.org/licenses/LICENSE-2.0

android-record/src/main/resources/META-INF/NOTICE

@@ -0,0 +1,20 @@
+# Jackson JSON processor
+
+Jackson is a high-performance, Free/Open Source JSON processing library.
+It was originally written by Tatu Saloranta (tatu.saloranta@iki.fi), and has
+been in development since 2007.
+It is currently developed by a community of developers, as well as supported
+commercially by FasterXML.com.
+
+## Licensing
+
+Jackson core and extension components may licensed under different licenses.
+To find the details that apply to this artifact see the accompanying LICENSE file.
+For more information, including possible other licensing options, contact
+FasterXML.com (http://fasterxml.com).
+
+## Credits
+
+A list of contributors may be found from CREDITS file, which is included
+in some artifacts (usually source distributions); but is always available
+from the source code management (SCM) system project uses.

android-record/src/main/resources/META-INF/services/com.fasterxml.jackson.databind.Module

@@ -0,0 +1 @@
+com.fasterxml.jackson.module.androidrecord.AndroidRecordModule

android-record/src/moditect/module-info.java

@@ -0,0 +1,9 @@
+module com.fasterxml.jackson.module.androidrecord {
+
+    requires com.fasterxml.jackson.databind;
+
+    exports com.fasterxml.jackson.module.androidrecord;
+
+    provides com.fasterxml.jackson.databind.Module with
+        com.fasterxml.jackson.module.androidrecord.AndroidRecordModule;
+}

android-record/src/test/java/com/android/tools/r8/RecordTag.java

@@ -0,0 +1,9 @@
+package com.android.tools.r8;
+
+/**
+ * Simulates the super class of Android-desugared records.
+ *
+ * @author Eran Leshem
+ **/
+public class RecordTag {
+}