feat(java): Allow overrides of package prefixes (#5374)

* feat(java): Allow overrides of package prefixes * Make package prefix abstract in ICustomConfig * Begin adding test * add test config * Add test output * update test * update all test * Add changelog entry * chore: update changelog * update ete tests * Reset snapshot to match main --------- Co-authored-by: Alberto <alberto@buildwithfern.com> Co-authored-by: ajgateno <ajgateno@users.noreply.github.com>
fern-api · Dec 10, 2024 · 04d1b5c · 04d1b5c
1 parent 7d877b6
commit 04d1b5c
Show file tree

Hide file tree

Showing 51 changed files with 2,639 additions and 12 deletions.
diff --git a/fern/pages/changelogs/java-sdk/2024-12-10.mdx b/fern/pages/changelogs/java-sdk/2024-12-10.mdx
@@ -0,0 +1,5 @@
+## 2.4.0
+**`(feat):`** We now support overriding sdk package prefixes by adding a "package-prefix" key under the java-sdk generator 
+configuration.
+
+
diff --git a/generators/java/generator-utils/src/main/java/com/fern/java/ICustomConfig.java b/generators/java/generator-utils/src/main/java/com/fern/java/ICustomConfig.java
@@ -18,6 +18,7 @@
 
 import com.fasterxml.jackson.annotation.JsonProperty;
 import com.fasterxml.jackson.annotation.JsonValue;
+import java.util.Optional;
 import org.immutables.value.Value;
 
 public interface ICustomConfig {
@@ -58,6 +59,9 @@ default Boolean disableRequiredPropertyBuilderChecks() {
         return false;
     }
 
+    @JsonProperty("package-prefix")
+    Optional<String> packagePrefix();
+
     enum JsonInclude {
         NON_EMPTY("non-empty"),
         NON_ABSENT("non-absent");

diff --git a/generators/java/sdk/src/main/java/com/fern/java/client/Cli.java b/generators/java/sdk/src/main/java/com/fern/java/client/Cli.java
@@ -119,8 +119,12 @@ public void runInGithubModeHook(
             IntermediateRepresentation ir,
             JavaSdkCustomConfig customConfig,
             GithubOutputMode githubOutputMode) {
-        ClientPoetClassNameFactory clientPoetClassNameFactory = new ClientPoetClassNameFactory(
-                AbstractPoetClassNameFactory.getPackagePrefixWithOrgAndApiName(ir, generatorConfig.getOrganization()));
+        List<String> packagePrefixTokens = customConfig
+                .packagePrefix()
+                .map(List::of)
+                .orElseGet(() -> AbstractPoetClassNameFactory.getPackagePrefixWithOrgAndApiName(
+                        ir, generatorConfig.getOrganization()));
+        ClientPoetClassNameFactory clientPoetClassNameFactory = new ClientPoetClassNameFactory(packagePrefixTokens);
         List<AuthScheme> resolvedAuthSchemes =
                 new FeatureResolver(ir, generatorConfig, generatorExecClient).getResolvedAuthSchemes();
         ClientGeneratorContext context = new ClientGeneratorContext(
@@ -152,8 +156,12 @@ public void runInPublishModeHook(
             IntermediateRepresentation ir,
             JavaSdkCustomConfig customConfig,
             GeneratorPublishConfig publishOutputMode) {
-        ClientPoetClassNameFactory clientPoetClassNameFactory = new ClientPoetClassNameFactory(
-                AbstractPoetClassNameFactory.getPackagePrefixWithOrgAndApiName(ir, generatorConfig.getOrganization()));
+        List<String> packagePrefixTokens = customConfig
+                .packagePrefix()
+                .map(List::of)
+                .orElseGet(() -> AbstractPoetClassNameFactory.getPackagePrefixWithOrgAndApiName(
+                        ir, generatorConfig.getOrganization()));
+        ClientPoetClassNameFactory clientPoetClassNameFactory = new ClientPoetClassNameFactory(packagePrefixTokens);
         List<AuthScheme> resolvedAuthSchemes =
                 new FeatureResolver(ir, generatorConfig, generatorExecClient).getResolvedAuthSchemes();
         ClientGeneratorContext context = new ClientGeneratorContext(

diff --git a/generators/java/sdk/versions.yml b/generators/java/sdk/versions.yml
@@ -1,3 +1,12 @@
+- changelogEntry:
+    - summary: |
+        We now support overriding sdk package prefixes by adding a "package-prefix" key under the java-sdk generator 
+        configuration.
+      type: feat
+  createdAt: '2024-12-10'
+  irVersion: 46
+  version: 2.4.0
+
 - changelogEntry:
     - summary: |
         The rootProject.name is now set in settings.gradle and ci.yml uses ./gradlew sonatypeCentralUpload for publishing.

diff --git a/packages/cli/ete-tests/src/tests/update-api-v2/__snapshots__/update-api.test.ts.snap b/packages/cli/ete-tests/src/tests/update-api-v2/__snapshots__/update-api.test.ts.snap
@@ -25,13 +25,13 @@ exports[`fern api update unioned > fern api update unioned 1`] = `
   },
   "servers": [
     {
-      "url": "https://api.example.com",
-      "description": "Production",
+      "url": "https://try.microcks.io/rest/Train+Travel+API/1.0.0",
+      "description": "Mock Server",
       "x-internal": false
     },
     {
-      "url": "https://try.microcks.io/rest/Train+Travel+API/1.0.0",
-      "description": "Mock Server",
+      "url": "https://api.example.com",
+      "description": "Production",
       "x-internal": false
     }
   ],

diff --git a/packages/cli/ete-tests/src/tests/update-api/__snapshots__/update-api.test.ts.snap b/packages/cli/ete-tests/src/tests/update-api/__snapshots__/update-api.test.ts.snap
@@ -25,13 +25,13 @@ exports[`fern api update > fern api update 1`] = `
   },
   "servers": [
     {
-      "url": "https://api.example.com",
-      "description": "Production",
+      "url": "https://try.microcks.io/rest/Train+Travel+API/1.0.0",
+      "description": "Mock Server",
       "x-internal": false
     },
     {
-      "url": "https://try.microcks.io/rest/Train+Travel+API/1.0.0",
-      "description": "Mock Server",
+      "url": "https://api.example.com",
+      "description": "Production",
       "x-internal": false
     }
   ],

diff --git a/...a/src/__test__/__snapshots__/java-custom-package-prefix/type_imdb_CreateMovieRequest.json b/...a/src/__test__/__snapshots__/java-custom-package-prefix/type_imdb_CreateMovieRequest.json
@@ -0,0 +1,17 @@
+{
+  "type": "object",
+  "properties": {
+    "title": {
+      "type": "string"
+    },
+    "rating": {
+      "type": "number"
+    }
+  },
+  "required": [
+    "title",
+    "rating"
+  ],
+  "additionalProperties": false,
+  "definitions": {}
+}
diff --git a/...-to-jsonschema/src/__test__/__snapshots__/java-custom-package-prefix/type_imdb_Movie.json b/...-to-jsonschema/src/__test__/__snapshots__/java-custom-package-prefix/type_imdb_Movie.json
@@ -0,0 +1,25 @@
+{
+  "type": "object",
+  "properties": {
+    "id": {
+      "$ref": "#/definitions/imdb.MovieId"
+    },
+    "title": {
+      "type": "string"
+    },
+    "rating": {
+      "type": "number"
+    }
+  },
+  "required": [
+    "id",
+    "title",
+    "rating"
+  ],
+  "additionalProperties": false,
+  "definitions": {
+    "imdb.MovieId": {
+      "type": "string"
+    }
+  }
+}
diff --git a/...o-jsonschema/src/__test__/__snapshots__/java-custom-package-prefix/type_imdb_MovieId.json b/...o-jsonschema/src/__test__/__snapshots__/java-custom-package-prefix/type_imdb_MovieId.json
@@ -0,0 +1,4 @@
+{
+  "type": "string",
+  "definitions": {}
+}