fix(clients): add generation banner to generated files (#816)

shortcuts · web-flow · commit 4b5573808cbd · 2022-07-12T17:11:02.000+02:00
diff --git a/generators/src/main/java/com/algolia/codegen/AlgoliaJavaGenerator.java b/generators/src/main/java/com/algolia/codegen/AlgoliaJavaGenerator.java
@@ -30,6 +30,9 @@ public void processOpts() {
 
     super.processOpts();
 
+    // Generation notice, added on every generated files
+    Utils.setGenerationBanner(additionalProperties);
+
     // Prevent all useless file to generate
     apiTestTemplateFiles.clear();
     modelTestTemplateFiles.clear();
diff --git a/generators/src/main/java/com/algolia/codegen/AlgoliaJavaScriptGenerator.java b/generators/src/main/java/com/algolia/codegen/AlgoliaJavaScriptGenerator.java
@@ -32,6 +32,9 @@ public void processOpts() {
     setModelPropertyNaming("original");
     setApiPackage("src");
 
+    // Generation notice, added on every generated files
+    Utils.setGenerationBanner(additionalProperties);
+
     languageSpecificPrimitives.add("Record");
     instantiationTypes.put("map", "Record");
     // clear all supported files to avoid unwanted ones
diff --git a/generators/src/main/java/com/algolia/codegen/AlgoliaPhpGenerator.java b/generators/src/main/java/com/algolia/codegen/AlgoliaPhpGenerator.java
@@ -31,6 +31,9 @@ public void processOpts() {
 
     super.processOpts();
 
+    // Generation notice, added on every generated files
+    Utils.setGenerationBanner(additionalProperties);
+
     // Remove base template as we want to change its path
     supportingFiles.removeIf(file -> file.getTemplateFile().equals("Configuration.mustache"));
 
diff --git a/generators/src/main/java/com/algolia/codegen/Utils.java b/generators/src/main/java/com/algolia/codegen/Utils.java
@@ -179,4 +179,15 @@ public static JsonNode readJsonFile(String filePath) throws ConfigException {
   public static boolean shouldUseExplicitOneOfName(Collection<String> oneOf) {
     return oneOf.stream().filter(type -> type != null && type.startsWith("List")).count() >= 2;
   }
+
+  /**
+   * Sets a `generationBanner` variable on the mustache templates, to display the generation banner
+   * on generated files.
+   */
+  public static void setGenerationBanner(Map<String, Object> additionalProperties) {
+    additionalProperties.put(
+      "generationBanner",
+      "This file is generated, manual changes will be lost - read more on" + " https://github.com/algolia/api-clients-automation."
+    );
+  }
 }
diff --git a/templates/java/api.mustache b/templates/java/api.mustache
@@ -1,3 +1,5 @@
+// {{{generationBanner}}}
+
 package {{package}};
 
 import {{invokerPackage}}.ApiClient;
diff --git a/templates/java/model.mustache b/templates/java/model.mustache
@@ -1,3 +1,5 @@
+// {{{generationBanner}}}
+
 package {{package}};
 
 import java.util.Objects;
diff --git a/templates/javascript/clients/algoliasearch/builds/browser.mustache b/templates/javascript/clients/algoliasearch/builds/browser.mustache
@@ -1,3 +1,5 @@
+// {{{generationBanner}}}
+
 import {
   createMemoryCache,
   createFallbackableCache,
diff --git a/templates/javascript/clients/algoliasearch/builds/models.mustache b/templates/javascript/clients/algoliasearch/builds/models.mustache
@@ -1,3 +1,5 @@
+// {{{generationBanner}}}
+
 import type {
   Host,
   Requester,
diff --git a/templates/javascript/clients/algoliasearch/builds/node.mustache b/templates/javascript/clients/algoliasearch/builds/node.mustache
@@ -1,3 +1,5 @@
+// {{{generationBanner}}}
+
 import {
   DEFAULT_CONNECT_TIMEOUT_NODE,
   DEFAULT_READ_TIMEOUT_NODE,
diff --git a/templates/javascript/clients/api-single.mustache b/templates/javascript/clients/api-single.mustache
@@ -1,3 +1,5 @@
+// {{{generationBanner}}}
+
 {{> client/api/imports}}
 
 export const apiClientVersion = '{{packageVersion}}';
diff --git a/templates/javascript/clients/client/builds/browser.mustache b/templates/javascript/clients/client/builds/browser.mustache
@@ -1,3 +1,5 @@
+// {{{generationBanner}}}
+
 import { createXhrRequester } from '{{{npmNamespace}}}/requester-browser-xhr';
 import { DEFAULT_CONNECT_TIMEOUT_BROWSER, DEFAULT_READ_TIMEOUT_BROWSER, DEFAULT_WRITE_TIMEOUT_BROWSER } from '{{{npmNamespace}}}/client-common';
 {{> client/builds/imports}}
diff --git a/templates/javascript/clients/client/builds/node.mustache b/templates/javascript/clients/client/builds/node.mustache
@@ -1,3 +1,5 @@
+// {{{generationBanner}}}
+
 import { createHttpRequester } from '{{{npmNamespace}}}/requester-node-http';
 import { DEFAULT_CONNECT_TIMEOUT_NODE, DEFAULT_READ_TIMEOUT_NODE, DEFAULT_WRITE_TIMEOUT_NODE } from '{{{npmNamespace}}}/client-common';
 {{> client/builds/imports}}
diff --git a/templates/javascript/clients/client/model/clientMethodProps.mustache b/templates/javascript/clients/client/model/clientMethodProps.mustache
@@ -1,3 +1,5 @@
+// {{{generationBanner}}}
+
 {{#apiInfo.apis.0}}
 
 {{#imports}}
diff --git a/templates/javascript/clients/client/model/modelBarrel.mustache b/templates/javascript/clients/client/model/modelBarrel.mustache
@@ -1,3 +1,5 @@
+// {{{generationBanner}}}
+
 {{#models}}
 {{#model}}
 export * from '{{{ classFilename }}}';
diff --git a/templates/javascript/clients/model.mustache b/templates/javascript/clients/model.mustache
@@ -1,3 +1,5 @@
+// {{{generationBanner}}}
+
 {{#models}}{{#model}}
 {{#tsImports}}
 import { {{classname}} } from '{{filename}}';
diff --git a/templates/php/ApiException.mustache b/templates/php/ApiException.mustache
@@ -1,3 +1,4 @@
+// {{{generationBanner}}}
 <?php
 
 namespace {{invokerPackage}};
diff --git a/templates/php/ConfigWithRegion.mustache b/templates/php/ConfigWithRegion.mustache
@@ -1,4 +1,5 @@
 <?php
+// {{{generationBanner}}}
 
 namespace {{invokerPackage}}\Configuration;
 
diff --git a/templates/php/Configuration.mustache b/templates/php/Configuration.mustache
@@ -1,4 +1,5 @@
 <?php
+// {{{generationBanner}}}
 
 namespace {{invokerPackage}}\Configuration;
 
diff --git a/templates/php/ModelInterface.mustache b/templates/php/ModelInterface.mustache
@@ -1,4 +1,5 @@
 <?php
+// {{{generationBanner}}}
 
 namespace {{modelPackage}};
 
diff --git a/templates/php/ObjectSerializer.mustache b/templates/php/ObjectSerializer.mustache
@@ -1,4 +1,5 @@
 <?php
+// {{{generationBanner}}}
 
 namespace {{invokerPackage}};
 
diff --git a/templates/php/api.mustache b/templates/php/api.mustache
@@ -1,4 +1,5 @@
 <?php
+// {{{generationBanner}}}
 
 namespace {{apiPackage}};
 
diff --git a/templates/php/client_config.mustache b/templates/php/client_config.mustache
@@ -1,4 +1,5 @@
 <?php
+// {{{generationBanner}}}
 
 namespace {{invokerPackage}}\Configuration;
 
diff --git a/templates/php/model.mustache b/templates/php/model.mustache
@@ -1,4 +1,6 @@
 <?php
+// {{{generationBanner}}}
+
 {{#models}}
 {{#model}}
 
diff --git a/website/docs/contributing/add-new-language.md b/website/docs/contributing/add-new-language.md
@@ -93,12 +93,12 @@ The resulting User Agent is the concatenation of `base`, then `client` and all t
 
 For example, if we have:
 
- - base: `Algolia for Java (4.0.0)`
- - client: `; Search (4.0.0)`
- - segment: 
-    - `; JVM (11.0.14)`
-    - `; experimental`
-    - `; test (8.0.0-beta)`
+- base: `Algolia for Java (4.0.0)`
+- client: `; Search (4.0.0)`
+- segment:
+  - `; JVM (11.0.14)`
+  - `; experimental`
+  - `; test (8.0.0-beta)`
 
 Then the resulting User Agent is (the order is arbitrary):
 
@@ -109,6 +109,7 @@ Algolia for Java (4.0.0); JVM (11.0.14); Search (4.0.0); experimental ; test (8.
 You can take a look at the Java implementation [here](https://github.com/algolia/api-clients-automation/pull/347).
 
 The `User-Agent` MUST match the following regular expression:
+
 ```regex
 ^Algolia for <LANGUAGE> \\(\\d+\\.\\d+\\.\\d+(-.*)?\\)(; [a-zA-Z. ]+ (\\(\\d+((\\.\\d+)?\\.\\d+)?(-.*)?\\))?)*(; <CLIENT> (\\(\\d+\\.\\d+\\.\\d+(-.*)?\\)))(; [a-zA-Z. ]+ (\\(\\d+((\\.\\d+)?\\.\\d+)?(-.*)?\\))?)*$
 ```
@@ -140,13 +141,19 @@ You can take a look at the implementation over all clients, [in this pull reques
 
 Every methods of every clients provide a parameter that does not exist in the REST API, called `requestOptions`.
 
-This parameter **must** be the last parameter of a method, and allow a user to override/merge additional `query parameters` or `headers` with the transporter ones.
+This parameter MUST be the last parameter of a method, and allow a user to override/merge additional `query parameters` or `headers` with the transporter ones.
 
 ### Requesters
 
-The requester needs to be configurable and capable to be overwriten to use a user defined requester.
+The requester needs to be configurable and capable to be overwritten to use a user defined requester.
 The default requester must be the classic HTTP requester, and it's possible to provide other alternatives like an [Echo Requester](https://github.com/algolia/api-clients-automation/blob/main/clients/algoliasearch-client-javascript/packages/client-common/src/createEchoRequester.ts) that just send the request back.
 
 ### Logger
 
-> TODO: informations
+> TODO: information
+
+### Generated file banner
+
+The banner SHOULD be added at the very top of every generated files, to avoid confusion for our users, but also redirect them to the `api-clients-automation` monorepo, where the contribution happens.
+
+To do so, a `generationBanner` variable is available on every `mustache` templates, see [the initial implementation](https://github.com/algolia/api-clients-automation/pull/816) for more context.

Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+// {{{generationBanner}}}`
	`2`	`+`
`1`	`3`	`package {{package}};`
`2`	`4`
`3`	`5`	`import {{invokerPackage}}.ApiClient;`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+// {{{generationBanner}}}`
	`2`	`+`
`1`	`3`	`import {`
`2`	`4`	`createMemoryCache,`
`3`	`5`	`createFallbackableCache,`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+// {{{generationBanner}}}`
	`2`	`+`
`1`	`3`	`import type {`
`2`	`4`	`Host,`
`3`	`5`	`Requester,`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+// {{{generationBanner}}}`
	`2`	`+`
`1`	`3`	`{{> client/api/imports}}`
`2`	`4`
`3`	`5`	`export const apiClientVersion = '{{packageVersion}}';`