[WIP] Updating openapi-generator for Java V2 SDK to 7.12.0 (#477)

Co-authored-by: Monica Auriemma <reta@dropbox.com>
Co-authored-by: Juan Treminio <juantreminio@dropbox.com>

Author: 3 people

sdks/java-v2/README.md

@@ -56,7 +56,7 @@ Add this dependency to your project's POM:
 <dependency>
   <groupId>com.dropbox.sign</groupId>
   <artifactId>dropbox-sign</artifactId>
-  <version>2.4-dev</version>
+  <version>2.4.1-dev</version>
   <scope>compile</scope>
 </dependency>
 ```
@@ -72,7 +72,7 @@ Add this dependency to your project's build file:
   }
 
   dependencies {
-     implementation "com.dropbox.sign:dropbox-sign:2.4-dev"
+     implementation "com.dropbox.sign:dropbox-sign:2.4.1-dev"
   }
 ```
 
@@ -86,7 +86,7 @@ mvn clean package
 
 Then manually install the following JARs:
 
-- `target/dropbox-sign-2.4-dev.jar`
+- `target/dropbox-sign-2.4.1-dev.jar`
 - `target/lib/*.jar`
 
 ## Getting Started
@@ -452,7 +452,7 @@ apisupport@hellosign.com
 This Java package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
 
 - API version: `3.0.0`
-    - Package version: `2.4-dev`
+    - Package version: `2.4.1-dev`
 - Build package: `org.openapitools.codegen.languages.JavaClientCodegen`
 
 

sdks/java-v2/VERSION

@@ -1 +1 @@
-2.4-dev
+2.4.1-dev

sdks/java-v2/bin/copy-constants.php

@@ -0,0 +1,64 @@
+#!/usr/bin/env php
+<?php
+
+require_once __DIR__ . '/../vendor/autoload.php';
+
+ini_set('display_errors', 1);
+ini_set('display_startup_errors', 1);
+error_reporting(E_ALL);
+
+set_error_handler(function ($level, $msg) {
+    echo "Error: {$msg}";
+    exit(1);
+});
+
+/**
+ * Between openapi-generator v7.8.0 and v7.12.0 a change was made to the way
+ * a few generators create constant names from values. The original way was
+ * actually broken. For example "change-field-visibility" would generate a
+ * constant name of "TYPE_FIELD_VISIBILITY", dropping the "change" part.
+ *
+ * The fix now generates the correct name, "TYPE_CHANGE_FIELD_VISIBILITY".
+ * However, the fix also gets rid of the previous (incorrect) constant names,
+ * making the fix a BC break.
+ *
+ * This simple script just adds the old constant names back, alongside the new
+ * ones.
+ */
+class CopyConstants
+{
+    public function run(): void
+    {
+        $file = __DIR__ . '/../src/main/java/com/dropbox/sign/model/SubFormFieldRuleAction.java';
+        $contents = file_get_contents($file);
+
+        $constant_1 = '    CHANGE_FIELD_VISIBILITY(String.valueOf("change-field-visibility")),';
+        $replace_1 = implode("\n", [
+            $constant_1,
+            '    FIELD_VISIBILITY(String.valueOf("change-field-visibility")),',
+        ]);
+
+        $constant_2 = '    CHANGE_GROUP_VISIBILITY(String.valueOf("change-group-visibility"));';
+        $replace_2 = implode("\n", [
+            '    CHANGE_GROUP_VISIBILITY(String.valueOf("change-group-visibility")),',
+            '    GROUP_VISIBILITY(String.valueOf("change-group-visibility"));',
+        ]);
+
+        $contents = str_replace(
+            $constant_1,
+            $replace_1,
+            $contents,
+        );
+
+        $contents = str_replace(
+            $constant_2,
+            $replace_2,
+            $contents,
+        );
+
+        file_put_contents($file, $contents);
+    }
+}
+
+$copier = new CopyConstants();
+$copier->run();

sdks/java-v2/build.gradle

@@ -21,7 +21,7 @@ apply plugin: 'signing'
 
 group = 'com.dropbox.sign'
 archivesBaseName = 'dropbox-sign'
-version = '2.4-dev'
+version = '2.4.1-dev'
 sourceCompatibility = JavaVersion.VERSION_1_8
 targetCompatibility = JavaVersion.VERSION_1_8
 

sdks/java-v2/build.sbt

@@ -2,7 +2,7 @@ lazy val root = (project in file(".")).
   settings(
     organization := "com.dropbox.sign",
     name := "dropbox-sign",
-    version := "2.4-dev",
+    version := "2.4.1-dev",
     scalaVersion := "2.11.4",
     scalacOptions ++= Seq("-feature"),
     Compile / javacOptions ++= Seq("-Xlint:deprecation"),

sdks/java-v2/docs/SubFormFieldRuleAction.md

@@ -19,8 +19,8 @@
 
 | Name | Value |
 ---- | -----
-| FIELD_VISIBILITY | "change-field-visibility" |
-| GROUP_VISIBILITY | "change-group-visibility" |
+| CHANGE_FIELD_VISIBILITY | "change-field-visibility" |
+| CHANGE_GROUP_VISIBILITY | "change-group-visibility" |
 
 
 

sdks/java-v2/gradle.properties

@@ -6,7 +6,7 @@
 #target = android
 GROUP=com.dropbox.sign
 POM_ARTIFACT_ID=dropbox-sign
-VERSION_NAME=2.4-dev
+VERSION_NAME=2.4.1-dev
 
 POM_NAME=Dropbox Sign Java SDK
 POM_DESCRIPTION=Use the Dropbox Sign Java SDK to connect your Java app to the service of Dropbox Sign in microseconds!

sdks/java-v2/openapi-config.yaml

@@ -18,7 +18,7 @@ additionalProperties:
   groupId: com.dropbox.sign
   artifactId: dropbox-sign
   artifactName: Dropbox Sign Java SDK
-  artifactVersion: "2.4-dev"
+  artifactVersion: "2.4.1-dev"
   artifactUrl: https://github.com/hellosign/dropbox-sign-java
   artifactDescription: Use the Dropbox Sign Java SDK to connect your Java app to the service of Dropbox Sign in microseconds!
   scmConnection: scm:git:git://github.com/hellosign/dropbox-sign-java.git

sdks/java-v2/pom.xml

@@ -5,7 +5,7 @@
     <artifactId>dropbox-sign</artifactId>
     <packaging>jar</packaging>
     <name>dropbox-sign</name>
-    <version>2.4-dev</version>
+    <version>2.4.1-dev</version>
     <url>https://github.com/hellosign/dropbox-sign-java</url>
     <description>Use the Dropbox Sign Java SDK to connect your Java app to the service of Dropbox Sign in microseconds!</description>
     <scm>
@@ -334,6 +334,7 @@
             <artifactId>jersey-apache-connector</artifactId>
             <version>${jersey-version}</version>
         </dependency>
+
         <!-- test dependencies -->
         <dependency>
             <groupId>org.junit.jupiter</groupId>
@@ -355,6 +356,7 @@
         <jackson-databind-version>2.17.1</jackson-databind-version>
         <jackson-databind-nullable-version>0.2.6</jackson-databind-nullable-version>
         <jakarta-annotation-version>2.1.1</jakarta-annotation-version>
+        <beanvalidation-version>3.0.2</beanvalidation-version>
         <junit-version>5.10.0</junit-version>
         <spotless.version>2.21.0</spotless.version>
         <mockito.version>3.12.4</mockito.version>

sdks/java-v2/run-build

@@ -18,7 +18,7 @@ rm -f "${DIR}/src/main/java/com/dropbox/sign/model/"*.java
 
 docker run --rm \
   -v "${DIR}/:/local" \
-  openapitools/openapi-generator-cli:v7.8.0 generate \
+  openapitools/openapi-generator-cli:v7.12.0 generate \
     -i "/local/openapi-sdk.yaml" \
     -c "/local/openapi-config.yaml" \
     -t "/local/templates" \
@@ -47,6 +47,9 @@ docker run --rm \
   -w "${WORKING_DIR}" \
   perl bash ./bin/scan_for
 
+printf "Adding old-style constant names ...\n"
+bash "${DIR}/bin/php" ./bin/copy-constants.php
+
 # avoid docker messing with permissions
 if [[ -z "$GITHUB_ACTIONS" ]]; then
   chmod 644 "${DIR}/README.md"