chore(all): factor the version into clients.config.json (#496)

algolia · May 12, 2022 · 446d533 · 446d533
1 parent 3e91d84
commit 446d533
Show file tree

Hide file tree

Showing 27 changed files with 156 additions and 110 deletions.
diff --git a/...t-java-2/algoliasearch-core/src/main/java/com/algolia/exceptions/AlgoliaApiException.java b/...t-java-2/algoliasearch-core/src/main/java/com/algolia/exceptions/AlgoliaApiException.java
@@ -3,7 +3,7 @@
 /** Exception thrown in case of API failure such as 4XX, 5XX error. */
 public class AlgoliaApiException extends AlgoliaRuntimeException {
 
-  public static final long serialVersionUID = -1L;
+  public static final long serialVersionUID = 1L;
 
   public int getHttpErrorCode() {
     return httpErrorCode;

diff --git a/...java-2/algoliasearch-core/src/main/java/com/algolia/exceptions/AlgoliaRetryException.java b/...java-2/algoliasearch-core/src/main/java/com/algolia/exceptions/AlgoliaRetryException.java
@@ -6,7 +6,7 @@
  */
 public class AlgoliaRetryException extends AlgoliaRuntimeException {
 
-  public static final long serialVersionUID = -1L;
+  public static final long serialVersionUID = 1L;
 
   public AlgoliaRetryException(String message, Throwable cause) {
     super(message, cause);

diff --git a/...va-2/algoliasearch-core/src/main/java/com/algolia/exceptions/AlgoliaRuntimeException.java b/...va-2/algoliasearch-core/src/main/java/com/algolia/exceptions/AlgoliaRuntimeException.java
@@ -3,7 +3,7 @@
 /** Exception thrown when an error occurs during the Serialization/Deserialization process */
 public class AlgoliaRuntimeException extends RuntimeException {
 
-  public static final long serialVersionUID = -1L;
+  public static final long serialVersionUID = 1L;
 
   public AlgoliaRuntimeException(String message, Throwable cause) {
     super(message, cause);

diff --git a/config/clients.config.json b/config/clients.config.json
@@ -1,7 +1,7 @@
 {
   "java": {
     "folder": "clients/algoliasearch-client-java-2",
-    "mainPackage": "java-search",
+    "packageVersion": "0.0.1",
     "modelFolder": "algoliasearch-core/src/main/java/com/algolia/model",
     "apiFolder": "algoliasearch-core/src/main/java/com/algolia/api",
     "customGenerator": "algolia-java",
@@ -12,7 +12,6 @@
   },
   "javascript": {
     "folder": "clients/algoliasearch-client-javascript",
-    "mainPackage": "javascript-search",
     "modelFolder": "model",
     "apiFolder": "src",
     "customGenerator": "algolia-javascript",
@@ -23,7 +22,7 @@
   },
   "php": {
     "folder": "clients/algoliasearch-client-php",
-    "mainPackage": "php-search",
+    "packageVersion": "0.0.1",
     "modelFolder": "lib/Model",
     "customGenerator": "algolia-php",
     "apiFolder": "lib/Api",

diff --git a/config/openapitools.json b/config/openapitools.json
@@ -143,8 +143,7 @@
         "library": "okhttp-gson",
         "gitRepoId": "algoliasearch-client-java-2",
         "additionalProperties": {
-          "packageName": "algoliasearch-client-java-2",
-          "packageVersion": "0.0.1"
+          "packageName": "algoliasearch-client-java-2"
         }
       },
       "java-recommend": {
@@ -157,8 +156,7 @@
         "library": "okhttp-gson",
         "gitRepoId": "algoliasearch-client-java-2",
         "additionalProperties": {
-          "packageName": "algoliasearch-client-java-2",
-          "packageVersion": "0.0.1"
+          "packageName": "algoliasearch-client-java-2"
         }
       },
       "java-personalization": {
@@ -172,7 +170,6 @@
         "gitRepoId": "algoliasearch-client-java-2",
         "additionalProperties": {
           "packageName": "algoliasearch-client-java-2",
-          "packageVersion": "0.0.1",
           "hasRegionalHost": true
         }
       },
@@ -187,7 +184,6 @@
         "gitRepoId": "algoliasearch-client-java-2",
         "additionalProperties": {
           "packageName": "algoliasearch-client-java-2",
-          "packageVersion": "0.0.1",
           "hasRegionalHost": true
         }
       },
@@ -202,7 +198,6 @@
         "gitRepoId": "algoliasearch-client-java-2",
         "additionalProperties": {
           "packageName": "algoliasearch-client-java-2",
-          "packageVersion": "0.0.1",
           "hasRegionalHost": true
         }
       },
@@ -217,7 +212,6 @@
         "gitRepoId": "algoliasearch-client-java-2",
         "additionalProperties": {
           "packageName": "algoliasearch-client-java-2",
-          "packageVersion": "0.0.1",
           "hasRegionalHost": true
         }
       },
@@ -232,7 +226,6 @@
         "gitRepoId": "algoliasearch-client-java-2",
         "additionalProperties": {
           "packageName": "algoliasearch-client-java-2",
-          "packageVersion": "0.0.1",
           "hasRegionalHost": true
         }
       },
@@ -246,8 +239,7 @@
         "library": "okhttp-gson",
         "gitRepoId": "algoliasearch-client-java-2",
         "additionalProperties": {
-          "packageName": "algoliasearch-client-java-2",
-          "packageVersion": "0.0.1"
+          "packageName": "algoliasearch-client-java-2"
         }
       },
       "php-search": {
@@ -256,8 +248,7 @@
         "invokerPackage": "Algolia\\AlgoliaSearch",
         "modelPackage": "Model\\Search",
         "additionalProperties": {
-          "packageName": "algoliasearch-client-php",
-          "packageVersion": "0.0.1"
+          "packageName": "algoliasearch-client-php"
         }
       },
       "php-recommend": {
@@ -266,8 +257,7 @@
         "invokerPackage": "Algolia\\AlgoliaSearch",
         "modelPackage": "Model\\Recommend",
         "additionalProperties": {
-          "packageName": "algoliasearch-client-php",
-          "packageVersion": "0.0.1"
+          "packageName": "algoliasearch-client-php"
         }
       },
       "php-personalization": {
@@ -277,7 +267,6 @@
         "modelPackage": "Model\\Personalization",
         "additionalProperties": {
           "packageName": "algoliasearch-client-php",
-          "packageVersion": "0.0.1",
           "hasRegionalHost": true
         }
       },
@@ -288,7 +277,6 @@
         "modelPackage": "Model\\Analytics",
         "additionalProperties": {
           "packageName": "algoliasearch-client-php",
-          "packageVersion": "0.0.1",
           "hasRegionalHost": true
         }
       },
@@ -299,7 +287,6 @@
         "modelPackage": "Model\\Insights",
         "additionalProperties": {
           "packageName": "algoliasearch-client-php",
-          "packageVersion": "0.0.1",
           "hasRegionalHost": true
         }
       },
@@ -310,7 +297,6 @@
         "modelPackage": "Model\\Abtesting",
         "additionalProperties": {
           "packageName": "algoliasearch-client-php",
-          "packageVersion": "0.0.1",
           "hasRegionalHost": true
         }
       },
@@ -326,8 +312,7 @@
         "invokerPackage": "Algolia\\AlgoliaSearch",
         "modelPackage": "Model\\QuerySuggestions",
         "additionalProperties": {
-          "packageName": "algoliasearch-client-php",
-          "packageVersion": "0.0.1"
+          "packageName": "algoliasearch-client-php"
         }
       }
     }

diff --git a/generators/src/main/java/com/algolia/codegen/AlgoliaJavaGenerator.java b/generators/src/main/java/com/algolia/codegen/AlgoliaJavaGenerator.java
@@ -45,10 +45,19 @@ public Map<String, Object> postProcessOperationsWithModels(
       allModels
     );
 
-    Utils.generateServer(
-      Utils.getClientNameKebabCase(results),
-      additionalProperties
-    );
+    try {
+      Utils.generateServer(
+        Utils.getClientNameKebabCase(results),
+        additionalProperties
+      );
+      additionalProperties.put(
+        "packageVersion",
+        Utils.getPackageVersion("java")
+      );
+    } catch (GenerationException e) {
+      e.printStackTrace();
+      System.exit(1);
+    }
 
     return results;
   }

diff --git a/generators/src/main/java/com/algolia/codegen/AlgoliaJavascriptGenerator.java b/generators/src/main/java/com/algolia/codegen/AlgoliaJavascriptGenerator.java
@@ -76,10 +76,15 @@ public Map<String, Object> postProcessOperationsWithModels(
     CLIENT = Utils.getClientNameCamelCase(results);
 
     setDefaultGeneratorOptions();
-    Utils.generateServer(
-      Utils.getClientNameKebabCase(results),
-      additionalProperties
-    );
+    try {
+      Utils.generateServer(
+        Utils.getClientNameKebabCase(results),
+        additionalProperties
+      );
+    } catch (GenerationException e) {
+      e.printStackTrace();
+      System.exit(1);
+    }
 
     List<CodegenOperation> operations =
       ((Map<String, List<CodegenOperation>>) results.get("operations")).get(

diff --git a/generators/src/main/java/com/algolia/codegen/AlgoliaPhpGenerator.java b/generators/src/main/java/com/algolia/codegen/AlgoliaPhpGenerator.java
@@ -53,7 +53,16 @@ public Map<String, Object> postProcessOperationsWithModels(
     String client = Utils.getClientNameKebabCase(results);
 
     setDefaultGeneratorOptions(client);
-    Utils.generateServer(client, additionalProperties);
+    try {
+      Utils.generateServer(client, additionalProperties);
+      additionalProperties.put(
+        "packageVersion",
+        Utils.getPackageVersion("php")
+      );
+    } catch (GenerationException e) {
+      e.printStackTrace();
+      System.exit(1);
+    }
 
     return results;
   }

diff --git a/generators/src/main/java/com/algolia/codegen/GenerationException.java b/generators/src/main/java/com/algolia/codegen/GenerationException.java
@@ -5,4 +5,8 @@ public class GenerationException extends Exception {
   public GenerationException(String message) {
     super(message);
   }
+
+  public GenerationException(String message, Throwable cause) {
+    super(message, cause);
+  }
 }
diff --git a/generators/src/main/java/com/algolia/codegen/Utils.java b/generators/src/main/java/com/algolia/codegen/Utils.java
@@ -1,7 +1,11 @@
 package com.algolia.codegen;
 
+import com.fasterxml.jackson.databind.JsonNode;
 import com.google.common.collect.Sets;
+import io.swagger.v3.core.util.Json;
+import java.io.File;
 import java.io.FileInputStream;
+import java.io.IOException;
 import java.net.URL;
 import java.util.*;
 import org.openapitools.codegen.CodegenOperation;
@@ -72,7 +76,7 @@ public static String getClientNameCamelCase(Map<String, Object> data) {
   public static void generateServer(
     String clientKebab,
     Map<String, Object> additionalProperties
-  ) {
+  ) throws GenerationException {
     Yaml yaml = new Yaml();
     try {
       Map<String, Object> spec = yaml.load(
@@ -145,8 +149,29 @@ public static void generateServer(
         allowedRegions.toArray(new String[0])
       );
     } catch (Exception e) {
-      e.printStackTrace();
-      System.exit(1);
+      throw new GenerationException("Couldn't generate servers", e);
+    }
+  }
+
+  // Get the package version from clients.config.json (doesn't work for JavaScript)
+  public static String getPackageVersion(String language)
+    throws GenerationException {
+    if (language.equals("javascript")) {
+      throw new GenerationException(
+        "Cannot use getPackageVersion with language=\"javascript\", " +
+        "read openapitools.json instead"
+      );
+    }
+    try {
+      JsonNode config = Json
+        .mapper()
+        .readTree(new File("config/clients.config.json"));
+      return config.get(language).get("packageVersion").asText();
+    } catch (IOException e) {
+      throw new GenerationException(
+        "Couldn't read packageVersion from clients.config.json",
+        e
+      );
     }
   }
 }
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@algolia/api-client-automation",
-  "version": "0.0.0",
+  "version": "0.0.1",
   "private": true,
   "workspaces": [
     "clients/algoliasearch-client-javascript/",

diff --git a/scripts/common.ts b/scripts/common.ts
@@ -5,10 +5,10 @@ import execa from 'execa'; // https://github.com/sindresorhus/execa/tree/v5.1.1
 import { hashElement } from 'folder-hash';
 import { remove } from 'fs-extra';
 
-import clientsConfig from '../config/clients.config.json';
 import openapiConfig from '../config/openapitools.json';
 import releaseConfig from '../config/release.config.json';
 
+import { getPackageVersionDefault } from './config';
 import { createSpinner } from './oraLog';
 import type {
   CheckForCache,
@@ -41,10 +41,7 @@ export const GENERATORS: Record<string, Generator> = {
     additionalProperties: {
       buildFile: 'algoliasearch',
       packageName: '@experimental-api-clients-automation/algoliasearch',
-      packageVersion:
-        openapiConfig['generator-cli'].generators[
-          clientsConfig.javascript.mainPackage
-        ].additionalProperties.packageVersion,
+      packageVersion: getPackageVersionDefault('javascript'),
     },
   },
 };
@@ -60,10 +57,6 @@ Object.entries(openapiConfig['generator-cli'].generators).forEach(
   }
 );
 
-export function getPackageVersion(generator: string): string {
-  return GENERATORS[generator].additionalProperties.packageVersion;
-}
-
 export const LANGUAGES = [
   ...new Set(Object.values(GENERATORS).map((gen) => gen.language)),
 ];

diff --git a/scripts/config.ts b/scripts/config.ts
@@ -1,4 +1,5 @@
 import clientsConfig from '../config/clients.config.json';
+import openapiConfig from '../config/openapitools.json';
 
 import type { Language } from './types';
 
@@ -25,3 +26,12 @@ export function getTestOutputFolder(language: Language): string {
 export function getCustomGenerator(language: Language): string {
   return clientsConfig[language].customGenerator;
 }
+
+// Returns the version of the package from clients.config.json, except for JavaScript where it returns the version of javascript-search
+export function getPackageVersionDefault(language: Language): string {
+  if (language === 'javascript') {
+    return openapiConfig['generator-cli'].generators['javascript-search']
+      .additionalProperties.packageVersion;
+  }
+  return clientsConfig[language].packageVersion;
+}
diff --git a/scripts/release/common.ts b/scripts/release/common.ts
@@ -2,21 +2,11 @@ import path from 'path';
 
 import { Octokit } from '@octokit/rest';
 
-import clientsConfig from '../../config/clients.config.json';
 import config from '../../config/release.config.json';
 import { getGitHubUrl, run } from '../common';
 
 export const RELEASED_TAG = config.releasedTag;
 export const TEAM_SLUG = config.teamSlug;
-export const MAIN_PACKAGE = Object.keys(clientsConfig).reduce(
-  (mainPackage: { [lang: string]: string }, lang: string) => {
-    return {
-      ...mainPackage,
-      [lang]: clientsConfig[lang].mainPackage,
-    };
-  },
-  {}
-);
 
 export function getOctokit(githubToken: string): Octokit {
   return new Octokit({