guides: add pushSetup for ingestion API (#4126)

shortcuts · millotp · web-flow · commit e199125e09e2 · 2024-11-19T14:05:54.000+01:00
Co-authored-by: Pierre Millot &lt;pierre.millot@algolia.com&gt;
diff --git a/config/generation.config.mjs b/config/generation.config.mjs
@@ -24,6 +24,8 @@ export const patterns = [
   '!clients/algoliasearch-client-csharp/algoliasearch/Transport/**',
   '!clients/algoliasearch-client-csharp/algoliasearch/Models/Common/**',
 
+  '!docs/guides/csharp/src/program.cs',
+
   'tests/output/csharp/global.json',
 
   // Dart
@@ -49,6 +51,8 @@ export const patterns = [
   '!clients/algoliasearch-client-go/algolia/debug/*',
   '!clients/algoliasearch-client-go/algolia/utils/*',
 
+  '!docs/guides/go/src/main.go',
+
   '!tests/output/go/go.*',
 
   // Java
diff --git a/docs/guides/csharp/src/program.cs b/docs/guides/csharp/src/program.cs
@@ -0,0 +1,4 @@
+public class Program
+{
+  public static void Main() { }
+}
diff --git a/docs/guides/go/src/main.go b/docs/guides/go/src/main.go
@@ -0,0 +1,7 @@
+package main
+
+import "fmt"
+
+func main() {
+	fmt.Println("wow nice")
+}
diff --git a/generators/src/main/java/com/algolia/codegen/cts/AlgoliaCTSGenerator.java b/generators/src/main/java/com/algolia/codegen/cts/AlgoliaCTSGenerator.java
@@ -9,6 +9,7 @@
 import com.algolia.codegen.utils.*;
 import com.google.common.collect.ImmutableMap.Builder;
 import com.samskivert.mustache.Mustache.Lambda;
+import java.io.File;
 import java.util.*;
 import java.util.Map.Entry;
 import java.util.TreeMap;
@@ -159,7 +160,9 @@ public Map<String, Object> postProcessSupportingFileData(Map<String, Object> obj
       bundle.put("isSyncClient", false);
       // special lambda for dynamic templates
       bundle.put("dynamicTemplate", new DynamicTemplateLambda(this));
-      bundle.put("dynamicSnippet", new DynamicSnippetLambda(this, models, operations, language, client));
+      if (new File("tests/CTS/guides/" + client + ".json").exists()) {
+        bundle.put("dynamicSnippet", new DynamicSnippetLambda(this, models, operations, language, client));
+      }
       bundle.put("lambda", lambda);
 
       String languageVersion = ctsManager.getLanguageVersion((String) additionalProperties.getOrDefault("languageVersion", ""));
diff --git a/generators/src/main/java/com/algolia/codegen/cts/lambda/DynamicSnippetLambda.java b/generators/src/main/java/com/algolia/codegen/cts/lambda/DynamicSnippetLambda.java
@@ -43,7 +43,7 @@ public DynamicSnippetLambda(
     this.operations = operations;
     this.paramsType = new ParametersWithDataType(models, language, client, true);
 
-    JsonNode snippetsFile = Helpers.readJsonFile("tests/CTS/guides/search.json");
+    JsonNode snippetsFile = Helpers.readJsonFile("tests/CTS/guides/" + client + ".json");
     this.snippets = Json.mapper().convertValue(snippetsFile, new TypeReference<Map<String, Snippet>>() {});
 
     // we can't access the default template manager, so we have to create our own
diff --git a/playground/csharp/Performances/Performances.csproj b/playground/csharp/Performances/Performances.csproj
@@ -2,7 +2,7 @@
 
     <PropertyGroup>
         <OutputType>Exe</OutputType>
-        <TargetFramework>net8.0</TargetFramework>
+        <TargetFramework>net9.0</TargetFramework>
         <ImplicitUsings>enable</ImplicitUsings>
         <Nullable>enable</Nullable>
         <RootNamespace>Performances</RootNamespace>
diff --git a/playground/csharp/Playground/Playground.csproj b/playground/csharp/Playground/Playground.csproj
@@ -2,7 +2,7 @@
 
   <PropertyGroup>
     <OutputType>Exe</OutputType>
-    <TargetFramework>net8.0</TargetFramework>
+    <TargetFramework>net9.0</TargetFramework>
     <LangVersion>12</LangVersion>
     <ImplicitUsings>enable</ImplicitUsings>
     <Nullable>enable</Nullable>
diff --git a/playground/go/ingestion.go b/playground/go/ingestion.go
@@ -2,7 +2,6 @@ package main
 
 import (
 	"fmt"
-	"time"
 
 	"github.com/algolia/algoliasearch-client-go/v4/algolia/ingestion"
 )
@@ -14,34 +13,14 @@ func testIngestion(appID, apiKey string) int {
 	}
 
 	// another example to generate payload for a request.
-	createAuthenticationResponse, err := ingestionClient.CreateAuthentication(ingestionClient.NewApiCreateAuthenticationRequest(
-		&ingestion.AuthenticationCreate{
-			Type: ingestion.AUTHENTICATION_TYPE_BASIC,
-			Name: fmt.Sprintf("my-authentication-%d", time.Now().Unix()),
-			Input: ingestion.AuthInput{
-				AuthBasic: &ingestion.AuthBasic{
-					Username: "username",
-					Password: "password",
-				},
-			},
-		}))
-
+	_, payload, err := ingestionClient.ListTasksWithHTTPInfo(ingestionClient.NewApiListTasksRequest())
 	if err != nil {
-		fmt.Printf("request error with CreateAuthentication: %v\n", err)
-		return 1
-	}
+		fmt.Printf("request error: %v\n", err)
 
-	printResponse(createAuthenticationResponse)
-
-	listAuthenticationsResponse, err := ingestionClient.ListAuthentications(
-		ingestionClient.NewApiListAuthenticationsRequest().WithItemsPerPage(2),
-	)
-	if err != nil {
-		fmt.Printf("request error with GetAuthentications: %v\n", err)
 		return 1
 	}
 
-	printResponse(listAuthenticationsResponse)
+	fmt.Println(string(payload))
 
 	return 0
 }
diff --git a/playground/kotlin/build.gradle.kts b/playground/kotlin/build.gradle.kts
@@ -1,6 +1,7 @@
 plugins {
     kotlin("jvm") version "2.0.21"
     kotlin("plugin.serialization") version "2.0.21"
+    id("application")
 }
 
 repositories {
@@ -16,4 +17,8 @@ dependencies {
 
 tasks.test {
     useJUnitPlatform()
-}
+}
+
+application {
+  mainClass.set("com.algolia.playground.${property("client")}Kt")
+}
diff --git a/scripts/buildLanguages.ts b/scripts/buildLanguages.ts
@@ -70,8 +70,9 @@ async function buildLanguage(language: Language, gens: Generator[], buildType: B
       break;
     case 'java':
     case 'kotlin':
+      // the playground specify search but it will still build everything
       await run(
-        `./gradle/gradlew -p ${cwd} ${buildType === 'client' || buildType === 'playground' ? 'assemble' : 'build'}`,
+        `./gradle/gradlew -p ${cwd} ${buildType === 'client' || buildType === 'playground' ? 'assemble -Pclient=Search' : 'build'}`,
         { language },
       );
       break;
diff --git a/scripts/formatter.ts b/scripts/formatter.ts
@@ -5,7 +5,7 @@ export async function formatter(language: string, cwd: string): Promise<void> {
   const spinner = createSpinner(`running formatter for '${language}' in '${cwd}'`);
   switch (language) {
     case 'csharp':
-      if (cwd.includes('tests') || cwd.includes('snippets')) {
+      if (cwd.includes('tests') || cwd.includes('snippets') || cwd.includes('guides')) {
         await run('dotnet format --no-restore && dotnet tool restore && dotnet dotnet-csharpier .', {
           cwd,
           language,
diff --git a/scripts/playground.ts b/scripts/playground.ts
@@ -25,13 +25,9 @@ export async function playground({ language, client }: { language: AllLanguage;
       );
       break;
     case 'kotlin':
-      await run(
-        `./gradle/gradlew -p playground/kotlin -PmainClass=com.algolia.playground.${createClientName(
-          client,
-          'kotlin',
-        )}Kt run`,
-        { language },
-      );
+      await run(`./gradle/gradlew -p playground/kotlin run -Pclient=${createClientName(client, 'kotlin')}`, {
+        language,
+      });
       break;
     case 'php':
       await runComposerInstall();
diff --git a/templates/csharp/guides/ingestion/pushSetup.mustache b/templates/csharp/guides/ingestion/pushSetup.mustache
@@ -0,0 +1,31 @@
+using System;
+using System.Text.Json;
+using System.Collections.Generic;
+
+{{> snippets/import}}
+
+using Action = Algolia.Search.Models.Ingestion.Action;
+using static Algolia.Search.Models.Ingestion.PushTaskRecords;
+
+class PushSetup
+{
+    public static async Task Main(string[] args)
+    {
+        string jsonContent = File.ReadAllText("/my-raw-records.json");
+
+        var records = JsonSerializer.Deserialize<List<PushTaskRecords>>(jsonContent);
+
+        // use the region matching your applicationID
+        {{> snippets/init}}
+
+        try
+        {
+            var run = {{#dynamicSnippet}}pushSetup{{/dynamicSnippet}};
+            Console.WriteLine(run.RunID);
+        }
+        catch (Exception e)
+        {
+            Console.WriteLine(e.Message);
+        }
+    }
+}
diff --git a/templates/csharp/guides/search/saveObjectsMovies.mustache b/templates/csharp/guides/search/saveObjectsMovies.mustache
@@ -5,7 +5,7 @@ using System.Collections.Generic;
 
 {{> snippets/import}}
 
-class Program
+class SaveObjectsMovies
 {
     public static async Task Main(string[] args)
     {
diff --git a/templates/csharp/snippets/dotnet-tools.mustache b/templates/csharp/snippets/dotnet-tools.mustache
@@ -3,10 +3,10 @@
   "isRoot": true,
   "tools": {
     "csharpier": {
-      "version": "0.29.2",
+      "version": "0.30.1",
       "commands": [
         "dotnet-csharpier"
       ]
     }
   }
-}
+}
diff --git a/templates/csharp/snippets/src.csproj.mustache b/templates/csharp/snippets/src.csproj.mustache
@@ -2,7 +2,7 @@
 
     <PropertyGroup>
         <OutputType>Exe</OutputType>
-        <TargetFramework>net8.0</TargetFramework>
+        <TargetFramework>net9.0</TargetFramework>
         <ImplicitUsings>enable</ImplicitUsings>
         <Nullable>enable</Nullable>
         <RootNamespace>Algolia</RootNamespace>
diff --git a/templates/go/guides/ingestion/pushSetup.mustache b/templates/go/guides/ingestion/pushSetup.mustache
@@ -0,0 +1,36 @@
+package main
+
+import (
+  "os"
+  "encoding/json"
+  "fmt"
+  "net/http"
+)
+
+
+{{> snippets/import}}
+
+func push() {
+  // use the region matching your applicationID
+  {{> snippets/init}}
+
+  content, err := os.ReadFile("/my-raw-records.json")
+  if err != nil {
+    panic(err)
+  }
+
+  var records []ingestion.PushTaskRecords
+
+  err = json.Unmarshal(content, &records)
+  if err != nil {
+    panic(err)
+  }
+
+  run, err := {{#dynamicSnippet}}pushSetup{{/dynamicSnippet}}
+  if err != nil {
+    panic(err)
+  }
+
+  // use runID in the Observability debugger
+  fmt.Println("run", run.RunID)
+}
diff --git a/templates/go/guides/search/saveObjectsMovies.mustache b/templates/go/guides/search/saveObjectsMovies.mustache
@@ -8,7 +8,7 @@ import (
 
 {{> snippets/import}}
 
-func main() {
+func saveObjectsMovies() {
   // read json file
   url := "https://dashboard.algolia.com/sample_datasets/movie.json"
   response, err := http.Get(url)
diff --git a/templates/go/snippets/.golangci.mustache b/templates/go/snippets/.golangci.mustache
@@ -2,10 +2,11 @@ linters:
   disable:
     - ineffassign
     - staticcheck
+    - unused
 
 issues:
   exclude-generated: disable
 
 run:
   concurrency: 2
-  timeout: 10m
+  timeout: 10m
diff --git a/templates/java/guides/ingestion/pushSetup.mustache b/templates/java/guides/ingestion/pushSetup.mustache
@@ -0,0 +1,23 @@
+import com.fasterxml.jackson.databind.*;
+import java.io.File;
+import java.util.List;
+import java.util.Map;
+
+{{> snippets/import}}
+
+public class pushSetup {
+  public static void main(String[] args) throws Exception {
+    JsonNode content = new ObjectMapper().readTree(new File("/my-raw-records.json"));
+    List<PushTaskRecords> records = new ObjectMapper().readerForListOf(Map.class).readValue(content);
+
+    // use the region matching your applicationID
+    {{> snippets/init}}
+
+    RunResponse run = {{#dynamicSnippet}}pushSetup{{/dynamicSnippet}};
+
+    // use runID in the Observability debugger
+    System.out.println(run.getRunID());
+
+    client.close();
+  }
+}
diff --git a/templates/javascript/guides/ingestion/pushSetup.mustache b/templates/javascript/guides/ingestion/pushSetup.mustache
@@ -0,0 +1,20 @@
+import fs from 'node:fs';
+import type { PushTaskRecords } from 'algoliasearch';
+
+{{> snippets/import}}
+
+// use the region matching your applicationID
+{{> snippets/init}}
+
+try {
+  // read local JSON file containing array of records
+  const records = JSON.parse(fs.readFileSync('/my-raw-records.json', 'utf8')) as PushTaskRecords[];
+
+  // push records to the API
+  const run = {{#dynamicSnippet}}pushSetup{{/dynamicSnippet}}
+
+  // use runID in the Observability debugger
+  console.log(run.runID);
+} catch (err) {
+  console.error(err);
+}
diff --git a/templates/javascript/snippets/package.mustache b/templates/javascript/snippets/package.mustache
@@ -1,6 +1,7 @@
 {
   "name": "javascript-{{mode}}",
   "version": "1.0.0",
+  "type": "module",
   "dependencies": {
     "typescript": "5.6.3",
     "@algolia/client-common": "link:../../../clients/algoliasearch-client-javascript/packages/client-common",
diff --git a/templates/kotlin/guides/ingestion/pushSetup.mustache b/templates/kotlin/guides/ingestion/pushSetup.mustache
@@ -0,0 +1,28 @@
+package org.example
+{{> snippets/import}}
+{{#isSearchClient}}
+import com.algolia.client.extensions.*
+{{/isSearchClient}}
+import com.algolia.client.model.ingestion.*
+
+import kotlinx.serialization.builtins.ListSerializer
+import kotlinx.serialization.json.Json
+import kotlinx.serialization.json.JsonObject
+import java.io.File
+
+suspend fun main() {
+    val json = File("/my-raw-records.json").readText()
+    val records: List<PushTaskRecords> = Json.decodeFromString(ListSerializer(PushTaskRecords.serializer()), json)
+
+    // use the region matching your applicationID
+    {{> snippets/init}}
+
+    try {
+        val run = client.{{#dynamicSnippet}}pushSetup{{/dynamicSnippet}}
+
+        // use runID in the Observability debugger
+        println(run)
+    } catch(e: Exception) {
+        println(e.message)
+    }
+}
diff --git a/templates/php/guides/ingestion/pushSetup.mustache b/templates/php/guides/ingestion/pushSetup.mustache
diff --git a/templates/python/guides/ingestion/pushSetup.mustache b/templates/python/guides/ingestion/pushSetup.mustache
diff --git a/templates/python/guides/search/saveObjectsMovies.mustache b/templates/python/guides/search/saveObjectsMovies.mustache
diff --git a/templates/ruby/guides/ingestion/pushSetup.mustache b/templates/ruby/guides/ingestion/pushSetup.mustache
diff --git a/templates/scala/guides/ingestion/pushSetup.mustache b/templates/scala/guides/ingestion/pushSetup.mustache
diff --git a/templates/scala/guides/search/saveObjectsMovies.mustache b/templates/scala/guides/search/saveObjectsMovies.mustache
diff --git a/templates/swift/guides/Package.mustache b/templates/swift/guides/Package.mustache
diff --git a/templates/swift/guides/ingestion/pushSetup.mustache b/templates/swift/guides/ingestion/pushSetup.mustache
diff --git a/tests/CTS/guides/ingestion.json b/tests/CTS/guides/ingestion.json
diff --git a/tests/output/csharp/.config/dotnet-tools.json b/tests/output/csharp/.config/dotnet-tools.json
diff --git a/tests/output/csharp/src/Algolia.Search.Tests.csproj b/tests/output/csharp/src/Algolia.Search.Tests.csproj

-Original file line number
+Diff line change
@@ @@ -0,0 +1,4 @@ @@
 +public class Program
 +{
 +  public static void Main() { }
 +}