guides: support verbatim variables

Author: millotp

generators/src/main/java/com/algolia/codegen/cts/tests/ParametersWithDataType.java

@@ -95,12 +95,16 @@ public void enhanceParameters(Map<String, Object> parameters, Map<String, Object
     }
 
     // Give the stringified version to mustache, for js
-    bundle.put("parameters", Json.mapper().writeValueAsString(parameters));
+    bundle.put("parameters", toJSONWithVar(parameters));
     bundle.put("parametersWithDataType", parametersWithDataType);
     // Also provide a map version for those who know which keys to look for
     bundle.put("parametersWithDataTypeMap", parametersWithDataTypeMap);
   }
 
+  private String toJSONWithVar(Map<String, Object> parameters) throws JsonProcessingException {
+    return Json.mapper().writeValueAsString(parameters).replaceAll("\"\\$var: (.*?)\"", "$1");
+  }
+
   private Map<String, Object> traverseParams(
     String paramName,
     Object param,
@@ -154,6 +158,10 @@ private Map<String, Object> traverseParams(
 
     if (param == null) {
       handleNull(spec, testOutput);
+    } else if (param instanceof String && ((String) param).startsWith("$var: ")) {
+      // bypass for verbatim variables used in the guides, we don't need to do any validation
+      testOutput.put("isVerbatim", true);
+      testOutput.put("value", ((String) param).substring(6));
     } else if (spec.getIsArray()) {
       handleArray(paramName, param, testOutput, spec, depth);
     } else if (spec.getIsEnum()) {
@@ -196,6 +204,10 @@ private Map<String, Object> traverseParamsWithoutSpec(String paramName, Object p
 
     if (param == null) {
       handleNull(null, testOutput);
+    } else if (param instanceof String && ((String) param).startsWith("$var: ")) {
+      // bypass for verbatim variables used in the guides, we don't need to do any validation
+      testOutput.put("isVerbatim", true);
+      testOutput.put("value", ((String) param).substring(6));
     } else if (param instanceof List) {
       handleArray(paramName, param, testOutput, null, depth);
     } else if (param instanceof Map) {

templates/java/guides/search/saveObjectsMovies.mustache

@@ -0,0 +1,28 @@
+import java.io.InputStream;
+import java.net.URI;
+import java.net.URL;
+import java.util.List;
+
+{{> snippets/import}}
+
+import com.fasterxml.jackson.core.type.TypeReference;
+import com.fasterxml.jackson.databind.JsonNode;
+import com.fasterxml.jackson.databind.ObjectMapper;
+
+public class Main {
+  public static void main(String[] args) throws Exception {
+    // Fetch sample dataset
+    URL url = new URI("https://dashboard.algolia.com/sample_datasets/movie.json").toURL();
+    InputStream stream = url.openStream();
+    ObjectMapper mapper = new ObjectMapper();
+    List<JsonNode> result = mapper.readValue(stream, new TypeReference<List<JsonNode>>() {});
+    stream.close();
+
+    // Connect and authenticate with your Algolia app
+    {{> snippets/init}}
+
+    // Save records in Algolia index
+    {{#dynamicSnippet}}saveObjectsMovies{{/dynamicSnippet}}
+    client.close();
+  }
+}

tests/CTS/guides/search.json

@@ -4,11 +4,7 @@
     "ignoreResponse": true,
     "parameters": {
       "indexName": "movies_index",
-      "objects": [
-        {
-          "$var": "objects"
-        }
-      ]
+      "objects": "$var: objects"
     }
   }
 }

yarn.lock

@@ -121,12 +121,6 @@ __metadata:
   languageName: node
   linkType: soft
 
-"@algolia/client-abtesting@link:../../clients/algoliasearch-client-javascript/packages/client-abtesting::locator=javascript-snippets%40workspace%3Asnippets%2Fjavascript":
-  version: 0.0.0-use.local
-  resolution: "@algolia/client-abtesting@link:../../clients/algoliasearch-client-javascript/packages/client-abtesting::locator=javascript-snippets%40workspace%3Asnippets%2Fjavascript"
-  languageName: node
-  linkType: soft
-
 "@algolia/client-analytics@link:../../../clients/algoliasearch-client-javascript/packages/client-analytics::locator=javascript-playground%40workspace%3Aplayground%2Fjavascript%2Fnode":
   version: 0.0.0-use.local
   resolution: "@algolia/client-analytics@link:../../../clients/algoliasearch-client-javascript/packages/client-analytics::locator=javascript-playground%40workspace%3Aplayground%2Fjavascript%2Fnode"
@@ -139,12 +133,6 @@ __metadata:
   languageName: node
   linkType: soft
 
-"@algolia/client-analytics@link:../../clients/algoliasearch-client-javascript/packages/client-analytics::locator=javascript-snippets%40workspace%3Asnippets%2Fjavascript":
-  version: 0.0.0-use.local
-  resolution: "@algolia/client-analytics@link:../../clients/algoliasearch-client-javascript/packages/client-analytics::locator=javascript-snippets%40workspace%3Asnippets%2Fjavascript"
-  languageName: node
-  linkType: soft
-
 "@algolia/client-common@link:../../../clients/algoliasearch-client-javascript/packages/client-common::locator=javascript-playground%40workspace%3Aplayground%2Fjavascript%2Fnode":
   version: 0.0.0-use.local
   resolution: "@algolia/client-common@link:../../../clients/algoliasearch-client-javascript/packages/client-common::locator=javascript-playground%40workspace%3Aplayground%2Fjavascript%2Fnode"
@@ -157,12 +145,6 @@ __metadata:
   languageName: node
   linkType: soft
 
-"@algolia/client-common@link:../../clients/algoliasearch-client-javascript/packages/client-common::locator=javascript-snippets%40workspace%3Asnippets%2Fjavascript":
-  version: 0.0.0-use.local
-  resolution: "@algolia/client-common@link:../../clients/algoliasearch-client-javascript/packages/client-common::locator=javascript-snippets%40workspace%3Asnippets%2Fjavascript"
-  languageName: node
-  linkType: soft
-
 "@algolia/client-insights@link:../../../clients/algoliasearch-client-javascript/packages/client-insights::locator=javascript-playground%40workspace%3Aplayground%2Fjavascript%2Fnode":
   version: 0.0.0-use.local
   resolution: "@algolia/client-insights@link:../../../clients/algoliasearch-client-javascript/packages/client-insights::locator=javascript-playground%40workspace%3Aplayground%2Fjavascript%2Fnode"
@@ -175,12 +157,6 @@ __metadata:
   languageName: node
   linkType: soft
 
-"@algolia/client-insights@link:../../clients/algoliasearch-client-javascript/packages/client-insights::locator=javascript-snippets%40workspace%3Asnippets%2Fjavascript":
-  version: 0.0.0-use.local
-  resolution: "@algolia/client-insights@link:../../clients/algoliasearch-client-javascript/packages/client-insights::locator=javascript-snippets%40workspace%3Asnippets%2Fjavascript"
-  languageName: node
-  linkType: soft
-
 "@algolia/client-personalization@link:../../../clients/algoliasearch-client-javascript/packages/client-personalization::locator=javascript-playground%40workspace%3Aplayground%2Fjavascript%2Fnode":
   version: 0.0.0-use.local
   resolution: "@algolia/client-personalization@link:../../../clients/algoliasearch-client-javascript/packages/client-personalization::locator=javascript-playground%40workspace%3Aplayground%2Fjavascript%2Fnode"
@@ -193,12 +169,6 @@ __metadata:
   languageName: node
   linkType: soft
 
-"@algolia/client-personalization@link:../../clients/algoliasearch-client-javascript/packages/client-personalization::locator=javascript-snippets%40workspace%3Asnippets%2Fjavascript":
-  version: 0.0.0-use.local
-  resolution: "@algolia/client-personalization@link:../../clients/algoliasearch-client-javascript/packages/client-personalization::locator=javascript-snippets%40workspace%3Asnippets%2Fjavascript"
-  languageName: node
-  linkType: soft
-
 "@algolia/client-query-suggestions@link:../../../clients/algoliasearch-client-javascript/packages/client-query-suggestions::locator=javascript-playground%40workspace%3Aplayground%2Fjavascript%2Fnode":
   version: 0.0.0-use.local
   resolution: "@algolia/client-query-suggestions@link:../../../clients/algoliasearch-client-javascript/packages/client-query-suggestions::locator=javascript-playground%40workspace%3Aplayground%2Fjavascript%2Fnode"
@@ -211,12 +181,6 @@ __metadata:
   languageName: node
   linkType: soft
 
-"@algolia/client-query-suggestions@link:../../clients/algoliasearch-client-javascript/packages/client-query-suggestions::locator=javascript-snippets%40workspace%3Asnippets%2Fjavascript":
-  version: 0.0.0-use.local
-  resolution: "@algolia/client-query-suggestions@link:../../clients/algoliasearch-client-javascript/packages/client-query-suggestions::locator=javascript-snippets%40workspace%3Asnippets%2Fjavascript"
-  languageName: node
-  linkType: soft
-
 "@algolia/client-search@link:../../../clients/algoliasearch-client-javascript/packages/client-search::locator=javascript-playground%40workspace%3Aplayground%2Fjavascript%2Fnode":
   version: 0.0.0-use.local
   resolution: "@algolia/client-search@link:../../../clients/algoliasearch-client-javascript/packages/client-search::locator=javascript-playground%40workspace%3Aplayground%2Fjavascript%2Fnode"
@@ -229,12 +193,6 @@ __metadata:
   languageName: node
   linkType: soft
 
-"@algolia/client-search@link:../../clients/algoliasearch-client-javascript/packages/client-search::locator=javascript-snippets%40workspace%3Asnippets%2Fjavascript":
-  version: 0.0.0-use.local
-  resolution: "@algolia/client-search@link:../../clients/algoliasearch-client-javascript/packages/client-search::locator=javascript-snippets%40workspace%3Asnippets%2Fjavascript"
-  languageName: node
-  linkType: soft
-
 "@algolia/ingestion@link:../../../clients/algoliasearch-client-javascript/packages/ingestion::locator=javascript-playground%40workspace%3Aplayground%2Fjavascript%2Fnode":
   version: 0.0.0-use.local
   resolution: "@algolia/ingestion@link:../../../clients/algoliasearch-client-javascript/packages/ingestion::locator=javascript-playground%40workspace%3Aplayground%2Fjavascript%2Fnode"
@@ -247,24 +205,12 @@ __metadata:
   languageName: node
   linkType: soft
 
-"@algolia/ingestion@link:../../clients/algoliasearch-client-javascript/packages/ingestion::locator=javascript-snippets%40workspace%3Asnippets%2Fjavascript":
-  version: 0.0.0-use.local
-  resolution: "@algolia/ingestion@link:../../clients/algoliasearch-client-javascript/packages/ingestion::locator=javascript-snippets%40workspace%3Asnippets%2Fjavascript"
-  languageName: node
-  linkType: soft
-
 "@algolia/monitoring@link:../../clients/algoliasearch-client-javascript/packages/monitoring::locator=javascript-guides%40workspace%3Aguides%2Fjavascript":
   version: 0.0.0-use.local
   resolution: "@algolia/monitoring@link:../../clients/algoliasearch-client-javascript/packages/monitoring::locator=javascript-guides%40workspace%3Aguides%2Fjavascript"
   languageName: node
   linkType: soft
 
-"@algolia/monitoring@link:../../clients/algoliasearch-client-javascript/packages/monitoring::locator=javascript-snippets%40workspace%3Asnippets%2Fjavascript":
-  version: 0.0.0-use.local
-  resolution: "@algolia/monitoring@link:../../clients/algoliasearch-client-javascript/packages/monitoring::locator=javascript-snippets%40workspace%3Asnippets%2Fjavascript"
-  languageName: node
-  linkType: soft
-
 "@algolia/recommend@link:../../../clients/algoliasearch-client-javascript/packages/recommend::locator=javascript-playground%40workspace%3Aplayground%2Fjavascript%2Fnode":
   version: 0.0.0-use.local
   resolution: "@algolia/recommend@link:../../../clients/algoliasearch-client-javascript/packages/recommend::locator=javascript-playground%40workspace%3Aplayground%2Fjavascript%2Fnode"
@@ -277,12 +223,6 @@ __metadata:
   languageName: node
   linkType: soft
 
-"@algolia/recommend@link:../../clients/algoliasearch-client-javascript/packages/recommend::locator=javascript-snippets%40workspace%3Asnippets%2Fjavascript":
-  version: 0.0.0-use.local
-  resolution: "@algolia/recommend@link:../../clients/algoliasearch-client-javascript/packages/recommend::locator=javascript-snippets%40workspace%3Asnippets%2Fjavascript"
-  languageName: node
-  linkType: soft
-
 "@algolia/requester-node-http@link:../../../clients/algoliasearch-client-javascript/packages/requester-node-http::locator=javascript-playground%40workspace%3Aplayground%2Fjavascript%2Fnode":
   version: 0.0.0-use.local
   resolution: "@algolia/requester-node-http@link:../../../clients/algoliasearch-client-javascript/packages/requester-node-http::locator=javascript-playground%40workspace%3Aplayground%2Fjavascript%2Fnode"
@@ -295,12 +235,6 @@ __metadata:
   languageName: node
   linkType: soft
 
-"@algolia/requester-node-http@link:../../clients/algoliasearch-client-javascript/packages/requester-node-http::locator=javascript-snippets%40workspace%3Asnippets%2Fjavascript":
-  version: 0.0.0-use.local
-  resolution: "@algolia/requester-node-http@link:../../clients/algoliasearch-client-javascript/packages/requester-node-http::locator=javascript-snippets%40workspace%3Asnippets%2Fjavascript"
-  languageName: node
-  linkType: soft
-
 "@ampproject/remapping@npm:^2.2.0":
   version: 2.3.0
   resolution: "@ampproject/remapping@npm:2.3.0"
@@ -2658,12 +2592,6 @@ __metadata:
   languageName: node
   linkType: soft
 
-"algoliasearch@link:../../clients/algoliasearch-client-javascript/packages/algoliasearch::locator=javascript-snippets%40workspace%3Asnippets%2Fjavascript":
-  version: 0.0.0-use.local
-  resolution: "algoliasearch@link:../../clients/algoliasearch-client-javascript/packages/algoliasearch::locator=javascript-snippets%40workspace%3Asnippets%2Fjavascript"
-  languageName: node
-  linkType: soft
-
 "ansi-escapes@npm:^4.2.1":
   version: 4.3.2
   resolution: "ansi-escapes@npm:4.3.2"
@@ -6000,26 +5928,6 @@ __metadata:
   languageName: unknown
   linkType: soft
 
-"javascript-snippets@workspace:snippets/javascript":
-  version: 0.0.0-use.local
-  resolution: "javascript-snippets@workspace:snippets/javascript"
-  dependencies:
-    "@algolia/client-abtesting": "link:../../clients/algoliasearch-client-javascript/packages/client-abtesting"
-    "@algolia/client-analytics": "link:../../clients/algoliasearch-client-javascript/packages/client-analytics"
-    "@algolia/client-common": "link:../../clients/algoliasearch-client-javascript/packages/client-common"
-    "@algolia/client-insights": "link:../../clients/algoliasearch-client-javascript/packages/client-insights"
-    "@algolia/client-personalization": "link:../../clients/algoliasearch-client-javascript/packages/client-personalization"
-    "@algolia/client-query-suggestions": "link:../../clients/algoliasearch-client-javascript/packages/client-query-suggestions"
-    "@algolia/client-search": "link:../../clients/algoliasearch-client-javascript/packages/client-search"
-    "@algolia/ingestion": "link:../../clients/algoliasearch-client-javascript/packages/ingestion"
-    "@algolia/monitoring": "link:../../clients/algoliasearch-client-javascript/packages/monitoring"
-    "@algolia/recommend": "link:../../clients/algoliasearch-client-javascript/packages/recommend"
-    "@algolia/requester-node-http": "link:../../clients/algoliasearch-client-javascript/packages/requester-node-http"
-    algoliasearch: "link:../../clients/algoliasearch-client-javascript/packages/algoliasearch"
-    typescript: "npm:5.6.2"
-  languageName: unknown
-  linkType: soft
-
 "jiti@npm:^1.21.6":
   version: 1.21.6
   resolution: "jiti@npm:1.21.6"