chore(playgroud): add a build playground step (#3420)

Author: millotp

.github/workflows/check.yml

@@ -213,6 +213,9 @@ jobs:
       - name: Build clients
         run: ${{ fromJSON(needs.setup.outputs.JAVASCRIPT_DATA).buildCommand }}
 
+      - name: Build the playground
+        run: yarn cli build playground javascript
+
       - name: Run common and requester tests
         run: cd clients/algoliasearch-client-javascript && yarn test ${{ !contains(fromJSON(needs.setup.outputs.JAVASCRIPT_DATA).toRun, 'algoliasearch') && '--ignore algoliasearch' || '' }}
 
@@ -323,6 +326,9 @@ jobs:
       - name: Build clients
         run: ${{ matrix.client.buildCommand }}
 
+      - name: Build the playground
+        run: yarn cli build playground ${{ matrix.client.language }}
+
       - name: Run Java 'algoliasearch' public API validation
         if: ${{ matrix.client.language == 'java' }}
         run: |

playground/csharp/Playground/Playgrounds/Ingestion.cs

@@ -27,7 +27,7 @@ public async Task Run()
     {
       // Get existing JSON source
       Console.WriteLine("--- Get existing JSON source `GetSourcesAsync` ---");
-      var jsonSources = await _client.GetSourcesAsync(type: [SourceType.Json]).ConfigureAwait(false);
+      var jsonSources = await _client.ListSourcesAsync(type: [SourceType.Json]).ConfigureAwait(false);
       Console.WriteLine(jsonSources.Sources.Count == 0
         ? "There is no JSON Source !"
         : $"There is {jsonSources.Sources.Count} JSON source(s)");

playground/csharp/Playground/Playgrounds/Search.cs

@@ -184,20 +184,20 @@ private async Task ApiKey()
       Indexes = [DefaultIndex]
     });
     var createdApiKey = await PlaygroundHelper.Start($"Saving new API Key", async () =>
-      await _client.WaitForApiKeyAsync(ApiKeyOperation.Add, addApiKeyResponse.Key), "New key has been created !");
+      await _client.WaitForApiKeyAsync(addApiKeyResponse.Key, ApiKeyOperation.Add), "New key has been created !");
 
     Console.WriteLine("--- Update api key `UpdateApiKeyAsync` ---");
     var modifiedApiKey = createdApiKey.ToApiKey();
     modifiedApiKey.Description = "Updated description";
 
     var updateApiKey = await _client.UpdateApiKeyAsync(addApiKeyResponse.Key, modifiedApiKey);
     await PlaygroundHelper.Start("Updating API Key`", async () =>
-      await _client.WaitForApiKeyAsync(ApiKeyOperation.Update, updateApiKey.Key, modifiedApiKey), "Key updated !");
+      await _client.WaitForApiKeyAsync(updateApiKey.Key, ApiKeyOperation.Update, modifiedApiKey), "Key updated !");
 
     Console.WriteLine("--- Delete api key `UpdateApiKeyAsync` ---");
     await _client.DeleteApiKeyAsync(addApiKeyResponse.Key);
     await PlaygroundHelper.Start("Deleting API Key", async () =>
-      await _client.WaitForApiKeyAsync(ApiKeyOperation.Delete, updateApiKey.Key), "Key deleted !");
+      await _client.WaitForApiKeyAsync(updateApiKey.Key, ApiKeyOperation.Delete), "Key deleted !");
 
     Console.WriteLine("--- Generate Secured API Keys `GenerateSecuredApiKeys` ---");
     var generateSecuredApiKeys = _client.GenerateSecuredApiKey(_configuration.SearchApiKey,

playground/javascript/node/ingestion.ts

@@ -14,7 +14,7 @@ const client = ingestionClient(appId, apiKey, 'us', {authMode: 'WithinHeaders',
 
 async function testIngestion() {
   try {
-    const res = await client.getAuthentications();
+    const res = await client.listAuthentications();
 
     console.log(`[OK]`, res);
   } catch (e) {

playground/javascript/node/package.json

@@ -12,7 +12,8 @@
     "start:query-suggestions": "tsc && node dist/query-suggestions.js",
     "start:recommend": "tsc && node dist/recommend.js",
     "start:search": "tsc && node dist/search.js",
-    "start:sources": "tsc && node dist/sources.js"
+    "start:sources": "tsc && node dist/sources.js",
+    "build": "tsc"
   },
   "dependencies": {
     "@algolia/client-abtesting": "link:../../../clients/algoliasearch-client-javascript/packages/client-abtesting",

playground/kotlin/src/main/kotlin/com/algolia/playground/Ingestion.kt

@@ -15,7 +15,7 @@ suspend fun main() {
         options = ClientOptions(logLevel = LogLevel.BODY),
     )
 
-    val response = client.getAuthentications()
+    val response = client.listAuthentications()
     println(response)
 
     exitProcess(0)

playground/kotlin/src/main/kotlin/com/algolia/playground/Recommend.kt

@@ -3,8 +3,8 @@ package com.algolia.playground
 import com.algolia.client.api.RecommendClient
 import com.algolia.client.configuration.ClientOptions
 import com.algolia.client.model.recommend.GetRecommendationsParams
-import com.algolia.client.model.recommend.RecommendationModels
-import com.algolia.client.model.recommend.RecommendationsQuery
+import com.algolia.client.model.recommend.FbtModel
+import com.algolia.client.model.recommend.BoughtTogetherQuery
 import io.github.cdimascio.dotenv.Dotenv
 import io.ktor.client.plugins.logging.*
 import kotlin.system.exitProcess
@@ -24,11 +24,11 @@ suspend fun main() {
     val recommendations = client.getRecommendations(
         getRecommendationsParams = GetRecommendationsParams(
             requests = listOf(
-                RecommendationsQuery(
+              BoughtTogetherQuery(
                     indexName = searchIndex,
-                    model = RecommendationModels.BoughtTogether,
+                    model = FbtModel.BoughtTogether,
                     objectID = "6445156",
-                    threshold = 0,
+                    threshold = 0.0,
                 )
             )
         )

playground/scala/src/main/scala/search.scala

@@ -40,8 +40,8 @@ def main(): Unit = {
   val value = Await.result(res, Duration(100, "sec"))
   val response = value.results.head.asInstanceOf[SearchResponse]
   for (hit <- response.hits) {
-    val actor = hit.extract[Actor]
-    println(actor)
+    //val actor = hit.extract[Actor]
+    //println(actor)
   }
 }
 

scripts/.eslintrc.cjs

@@ -44,5 +44,6 @@ module.exports = {
     complexity: 0,
     'no-param-reassign': 0,
     '@typescript-eslint/consistent-type-assertions': 0,
+    curly: ['error', 'all'],
   },
 };

scripts/buildClients.ts

@@ -4,23 +4,29 @@ import { createSpinner } from './spinners.js';
 import type { Generator, Language } from './types.js';
 
 /**
- * Build client for a language at the same time, for those who live in the same folder.
+ * Build code for a specific language.
  */
-async function buildClient(language: Language, gens: Generator[]): Promise<void> {
-  const cwd = getLanguageFolder(language);
-  const spinner = createSpinner(`building '${language}'`);
+async function buildLanguage(
+  language: Language,
+  gens: Generator[],
+  playground: boolean,
+): Promise<void> {
+  const cwd = playground ? `playground/${language}` : getLanguageFolder(language);
+  const spinner = createSpinner(`building ${playground ? 'playground' : 'client'} '${language}'`);
   switch (language) {
     case 'csharp':
       await run('dotnet build --configuration Release', { cwd, language });
       break;
     case 'javascript':
-      // eslint-disable-next-line no-case-declarations
-      const packageNames = gens.map(({ additionalProperties: { packageName } }) =>
-        packageName === 'algoliasearch' ? packageName : `@algolia/${packageName}`,
-      );
-
       await run('YARN_ENABLE_IMMUTABLE_INSTALLS=false yarn install', { cwd });
-      await run(`yarn build:many '{${packageNames.join(',')},}'`, { cwd });
+      if (playground) {
+        await run('cd node && yarn build', { cwd });
+      } else {
+        const packageNames = gens.map(({ additionalProperties: { packageName } }) =>
+          packageName === 'algoliasearch' ? packageName : `@algolia/${packageName}`,
+        );
+        await run(`yarn build:many '{${packageNames.join(',')},}'`, { cwd });
+      }
 
       break;
     case 'java':
@@ -34,7 +40,10 @@ async function buildClient(language: Language, gens: Generator[]): Promise<void>
       await run(`sbt --batch -Dsbt.server.forcestart=true +compile`, { cwd, language });
       break;
     case 'swift':
-      await run(`swift build -Xswiftc -suppress-warnings`, { cwd, language });
+      // make this work in the playground
+      if (!playground) {
+        await run(`swift build -Xswiftc -suppress-warnings`, { cwd, language });
+      }
       break;
     default:
   }
@@ -56,5 +65,9 @@ export async function buildClients(generators: Generator[]): Promise<void> {
     {} as Record<Language, Generator[]>,
   );
 
-  await Promise.all(langs.map((lang) => buildClient(lang, generatorsMap[lang])));
+  await Promise.all(langs.map((lang) => buildLanguage(lang, generatorsMap[lang], false)));
+}
+
+export async function buildPlaygrounds(languages: Language[]): Promise<void> {
+  await Promise.all(languages.map((lang) => buildLanguage(lang, [], true)));
 }