Merge branch '2.19' into tatu/2.18/avro-1.11.4

Author: cowtowncoder

.github/workflows/dep_build_v2.yml

@@ -19,9 +19,9 @@ jobs:
     env:
       JAVA_OPTS: "-XX:+TieredCompilation -XX:TieredStopAtLevel=1"
     steps:
-    - uses: actions/checkout@a5ac7e51b41094c92402da3b24376905380afc29 # v4.1.6
+    - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
     - name: Set up JDK
-      uses: actions/setup-java@99b8673ff64fbf99d8d325f52d9a5bdedb8483e9 # v4.2.1
+      uses: actions/setup-java@7a6d8a8234af8eb26422e24e3006232cccaa061b # v4.6.0
       with:
         distribution: 'temurin'
         java-version: ${{ matrix.java_version }}

.github/workflows/dep_build_v3.yml

@@ -15,15 +15,15 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        java_version: ['8', '17', '21']
+        java_version: ['17', '21']
     env:
       JAVA_OPTS: "-XX:+TieredCompilation -XX:TieredStopAtLevel=1"
     steps:
-    - uses: actions/checkout@a5ac7e51b41094c92402da3b24376905380afc29 # v4.1.6
+    - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
       with:
         ref: master
     - name: Set up JDK
-      uses: actions/setup-java@99b8673ff64fbf99d8d325f52d9a5bdedb8483e9 # v4.2.1
+      uses: actions/setup-java@7a6d8a8234af8eb26422e24e3006232cccaa061b # v4.6.0
       with:
         distribution: 'temurin'
         java-version: ${{ matrix.java_version }}

.github/workflows/main.yml

@@ -4,15 +4,15 @@ on:
     branches:
     - master
     - "3.0"
-    - "2.18"
+    - "2.19"
     paths-ignore:
     - "README.md"
     - "release-notes/*"
   pull_request:
     branches:
     - master
     - "3.0"
-    - "2.18"
+    - "2.19"
     paths-ignore:
     - "README.md"
     - "release-notes/*"
@@ -21,18 +21,20 @@ permissions:
 
 jobs:
   build:
-    runs-on: ${{ matrix.os }}
+    runs-on: 'ubuntu-22.04'
     strategy:
       fail-fast: false
       matrix:
         java_version: ['8', '11', '17', '21']
-        os: ['ubuntu-20.04']
+        include:
+          - java_version: '8'
+            release_build: 'R'
     env:
       JAVA_OPTS: "-XX:+TieredCompilation -XX:TieredStopAtLevel=1"
     steps:
-    - uses: actions/checkout@v4
+    - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
     - name: Set up JDK
-      uses: actions/setup-java@v4
+      uses: actions/setup-java@7a6d8a8234af8eb26422e24e3006232cccaa061b # v4.6.0
       with:
         distribution: 'temurin'
         java-version: ${{ matrix.java_version }}
@@ -49,18 +51,18 @@ jobs:
       id: projectVersion
       run: echo "version=$(./mvnw org.apache.maven.plugins:maven-help-plugin:3.3.0:evaluate -DforceStdout -Dexpression=project.version -q)" >> $GITHUB_OUTPUT
     - name: Deploy snapshot
-      if: github.event_name != 'pull_request' && matrix.java_version == '8' && endsWith(steps.projectVersion.outputs.version, '-SNAPSHOT')
+      if: ${{ matrix.release_build && github.event_name != 'pull_request' && endsWith(steps.projectVersion.outputs.version, '-SNAPSHOT') }}
       env:
         CI_DEPLOY_USERNAME: ${{ secrets.CI_DEPLOY_USERNAME }}
         CI_DEPLOY_PASSWORD: ${{ secrets.CI_DEPLOY_PASSWORD }}
         # MAVEN_GPG_PASSPHRASE: ${{ secrets.MAVEN_GPG_PASSPHRASE }}
       run: ./mvnw -B -q -ff -DskipTests -ntp source:jar deploy
     - name: Generate code coverage
-      if: github.event_name != 'pull_request' && matrix.java_version == '8'
+      if: ${{ matrix.release_build && github.event_name != 'pull_request' }}
       run: ./mvnw -B -q -ff -ntp test
     - name: Publish code coverage
-      if: github.event_name != 'pull_request' && matrix.java_version == '8'
-      uses: codecov/codecov-action@v4
+      if: ${{ matrix.release_build && github.event_name != 'pull_request' }}
+      uses: codecov/codecov-action@1e68e06f1dbfde0e4cefc87efeba9e4643565303 # v5.1.2
       with:
         token: ${{ secrets.CODECOV_TOKEN }}
         file: ./target/site/jacoco/jacoco.xml

.mvn/wrapper/maven-wrapper.properties

@@ -14,5 +14,5 @@
 # KIND, either express or implied.  See the License for the
 # specific language governing permissions and limitations
 # under the License.
-distributionUrl=https://repo.maven.apache.org/maven2/org/apache/maven/apache-maven/3.9.3/apache-maven-3.9.3-bin.zip
-wrapperUrl=https://repo.maven.apache.org/maven2/org/apache/maven/wrapper/maven-wrapper/3.2.0/maven-wrapper-3.2.0.jar
+distributionUrl=https://repo.maven.apache.org/maven2/org/apache/maven/apache-maven/3.9.6/apache-maven-3.9.6-bin.zip
+wrapperUrl=https://repo.maven.apache.org/maven2/org/apache/maven/wrapper/maven-wrapper/3.3.1/maven-wrapper-3.3.1.jar

README.md

@@ -40,9 +40,9 @@ To use these format backends Maven-based projects, use following dependency:
 
 ```xml
 <dependency>
-  <groupId>com.fasterxml.jackson.dataformat</groupId>
-  <artifactId>jackson-dataformat-[FORMAT]</artifactId>
-  <version>2.13.0</version>
+    <groupId>com.fasterxml.jackson.dataformat</groupId>
+    <artifactId>jackson-dataformat-[FORMAT]</artifactId>
+    <version>2.18.1</version>
 </dependency>
 ```
 
@@ -66,8 +66,8 @@ responses.
 `master` branch is for developing the next major Jackson version -- 3.0 -- but there
 are active maintenance branches in which much of development happens:
 
-* `2.14` is for developing the next 2.x version
-* `2.13` and `2.12` are for backported fixes for 2.13/2.12 versions (respectively)
+* `2.19` is for developing the next 2.x version
+* `2.18` and `2.17` are for backported fixes for 2.18/2.17 versions (respectively)
 
 Older branches are usually not changed but are available for historic reasons.
 All released versions have matching git tags (`jackson-dataformats-binary-2.10.3`).

avro/README.md

@@ -114,32 +114,34 @@ and that's about it, for now.
 
 ## Avro Logical Types
 
-Following is an extract from [Logical Types](http://avro.apache.org/docs/current/specification/_print/#logical-types) paragraph in 
-Avro schema specification:
+The following is an excerpt from the [Logical Types](https://avro.apache.org/docs/1.11.1/specification/#logical-types) section of
+the Avro schema specification:
+
 > A logical type is an Avro primitive or complex type with extra attributes to represent a derived type. The attribute 
-> `logicalType` is always be present for a logical type, and is a string with the name of one of the logical types 
-> defined by Avro specification.
+> `logicalType` must always be present for a logical type, and is a string with the name of one of the logical types 
+> listed later in this section. Other attributes may be defined for particular logical types.
+
+Logical types are supported for a limited set of `java.time` classes and for 'java.util.UUID'. See the table below for more details.
 
-Generation of logical types for limited set of `java.time` classes is supported at the moment. See a table bellow. 
+### Mapping to Logical Types
 
-### Mapping to Logical Type
+Mapping to Avro type and logical type involves these steps:
 
-Mapping to Avro type and logical type works in few steps: 
-1. Serializer for particular Java type (or class) determines a Jackson type  where the Java type will be serialized into.
-2. `AvroSchemaGenerator` determines corresponding Avro type for that Jackson type.
-2. If logical type generation is enabled, then `logicalType` is determined for the above combination of Java type and 
-   Avro type. 
+1. The serializer for a Java type identifies the Jackson type it will serialize into.
+2. The `AvroSchemaGenerator` maps that Jackson type to the corresponding Avro type.
+3. `logicalType` value is combination of Java type and Jackson type.
 
 #### Java type to Avro Logical Type mapping
 
-| Java type                     | Serialization type | Generated Avro schema with Avro type and logical type
-| ----------------------------- | ------------------ | -----------------------------------------------------
-| `java.time.OffsetDateTime`    | NumberType.LONG    | `{"type": "long", "logicalType": "timestamp-millis"}`
-| `java.time.ZonedDateTime`     | NumberType.LONG    | `{"type": "long", "logicalType": "timestamp-millis"}`
-| `java.time.Instant`           | NumberType.LONG    | `{"type": "long", "logicalType": "timestamp-millis"}`
-| `java.time.LocalDate`         | NumberType.INT     | `{"type": "int",  "logicalType": "date"}`
-| `java.time.LocalTime`         | NumberType.INT     | `{"type": "int",  "logicalType": "time-millis"}`
-| `java.time.LocalDateTime`     | NumberType.LONG    | `{"type": "long", "logicalType": "local-timestamp-millis"}`
+| Java type                  | Jackson type    | Generated Avro schema with logical type                                                           |
+|----------------------------|-----------------|---------------------------------------------------------------------------------------------------|
+| `java.time.OffsetDateTime` | NumberType.LONG | `{"type": "long", "logicalType": "timestamp-millis"}`                                             |
+| `java.time.ZonedDateTime`  | NumberType.LONG | `{"type": "long", "logicalType": "timestamp-millis"}`                                             |
+| `java.time.Instant`        | NumberType.LONG | `{"type": "long", "logicalType": "timestamp-millis"}`                                             |
+| `java.time.LocalDate`      | NumberType.INT  | `{"type": "int",  "logicalType": "date"}`                                                         |
+| `java.time.LocalTime`      | NumberType.INT  | `{"type": "int",  "logicalType": "time-millis"}`                                                  |
+| `java.time.LocalDateTime`  | NumberType.LONG | `{"type": "long", "logicalType": "local-timestamp-millis"}`                                       |
+| `java.util.UUID`  (2.19+) |                 | `{"type": "fixed", "name": "UUID", "namespace": "java.util", "size": 16, "logicalType" : "uuid"}` |
 
 _Provided Avro logical type generation is enabled._
 

avro/src/main/java/com/fasterxml/jackson/dataformat/avro/schema/AvroSchemaHelper.java

@@ -286,7 +286,7 @@ public static Schema createEnumSchema(BeanDescription bean, List<String> values)
      * @since 2.11
      */
     public static Schema createUUIDSchema() {
-        return Schema.createFixed("UUID", "", "java.util", 16);
+        return Schema.createFixed("UUID", null, "java.util", 16);
     }
 
     /**

avro/src/main/java/com/fasterxml/jackson/dataformat/avro/schema/StringVisitor.java

@@ -10,7 +10,6 @@
 import com.fasterxml.jackson.databind.SerializerProvider;
 import com.fasterxml.jackson.databind.jsonFormatVisitors.JsonStringFormatVisitor;
 import com.fasterxml.jackson.databind.jsonFormatVisitors.JsonValueFormat;
-import com.fasterxml.jackson.databind.type.TypeFactory;
 
 public class StringVisitor extends JsonStringFormatVisitor.Base
     implements SchemaBuilder
@@ -37,13 +36,10 @@ public void enumTypes(Set<String> enums) {
     public Schema builtAvroSchema() {
         // Unlike Jackson, Avro treats characters as an int with the java.lang.Character class type.
         if (_type.hasRawClass(char.class) || _type.hasRawClass(Character.class)) {
-            return AvroSchemaHelper.numericAvroSchema(NumberType.INT, TypeFactory.defaultInstance().constructType(Character.class));
-        }
-        // [dataformats-binary#179]: need special help with UUIDs, to coerce into Binary
-        //   (could actually be
-        if (_type.hasRawClass(java.util.UUID.class)) {
-            return AvroSchemaHelper.createUUIDSchema();
+            // should we construct JavaType for `Character.class` in case of primitive or... ?
+            return AvroSchemaHelper.numericAvroSchema(NumberType.INT, _type);
         }
+
         BeanDescription bean = _provider.getConfig().introspectClassAnnotations(_type);
         Schema schema = Schema.create(Schema.Type.STRING);
         // Stringable classes need to include the type

avro/src/main/java/com/fasterxml/jackson/dataformat/avro/schema/UUIDVisitor.java

@@ -0,0 +1,43 @@
+package com.fasterxml.jackson.dataformat.avro.schema;
+
+import java.util.Set;
+
+import com.fasterxml.jackson.databind.jsonFormatVisitors.JsonStringFormatVisitor;
+import com.fasterxml.jackson.databind.jsonFormatVisitors.JsonValueFormat;
+
+import org.apache.avro.LogicalTypes;
+import org.apache.avro.Schema;
+
+/**
+ * Visitor for {@link java.util.UUID} type. When it is created with logicalTypesEnabled enabled,
+ * Avro schema is created with logical type uuid.
+ *
+ * @since 2.19
+ */
+public class UUIDVisitor extends JsonStringFormatVisitor.Base
+        implements SchemaBuilder {
+    protected boolean _logicalTypesEnabled = false;
+
+
+    public UUIDVisitor(boolean logicalTypesEnabled) {
+        _logicalTypesEnabled = logicalTypesEnabled;
+    }
+
+    @Override
+    public void format(JsonValueFormat format) {
+        // Ideally, we'd recognize UUIDs, Dates etc if need be, here...
+    }
+
+    @Override
+    public void enumTypes(Set<String> enums) {
+        // Do nothing
+    }
+
+    @Override
+    public Schema builtAvroSchema() {
+        // [dataformats-binary#179]: need special help with UUIDs, to coerce into Binary
+        //   (could actually be
+        Schema schema = AvroSchemaHelper.createUUIDSchema();
+        return this._logicalTypesEnabled ? LogicalTypes.uuid().addToSchema(schema) : schema;
+    }
+}

avro/src/main/java/com/fasterxml/jackson/dataformat/avro/schema/VisitorFormatWrapperImpl.java

@@ -214,6 +214,12 @@ public JsonStringFormatVisitor expectStringFormat(JavaType type)
             return v;
         }
 
+        if (type.hasRawClass(java.util.UUID.class)) {
+            UUIDVisitor v = new UUIDVisitor(this._logicalTypesEnabled);
+            _builder = v;
+            return v;
+        }
+
         StringVisitor v = new StringVisitor(_provider, type);
         _builder = v;
         return v;