feat(php): add bridge to transformation on search

playground/php/loadEnv.php

@@ -1,4 +1,5 @@
 <?php
+
 require '../../../clients/algoliasearch-client-php/vendor/autoload.php';
 
 // Gets the vars from local environment

playground/php/src/abtesting.php

@@ -1,6 +1,6 @@
 <?php
 
-$env = require_once('../loadEnv.php');
+$env = require_once '../loadEnv.php';
 
 use Algolia\AlgoliaSearch\Api\AbtestingClient;
 

playground/php/src/analytics.php

@@ -1,6 +1,6 @@
 <?php
 
-$env = require_once('../loadEnv.php');
+$env = require_once '../loadEnv.php';
 
 use Algolia\AlgoliaSearch\Api\AnalyticsClient;
 

playground/php/src/insights.php

@@ -1,6 +1,6 @@
 <?php
 
-$env = require_once('../loadEnv.php');
+$env = require_once '../loadEnv.php';
 
 use Algolia\AlgoliaSearch\Api\InsightsClient;
 

playground/php/src/personalization.php

@@ -1,6 +1,6 @@
 <?php
 
-$env = require_once('../loadEnv.php');
+$env = require_once '../loadEnv.php';
 
 use Algolia\AlgoliaSearch\Api\PersonalizationClient;
 

playground/php/src/query-suggestions.php

@@ -1,6 +1,6 @@
 <?php
 
-$env = require_once('../loadEnv.php');
+$env = require_once '../loadEnv.php';
 
 use Algolia\AlgoliaSearch\Api\QuerySuggestionsClient;
 

playground/php/src/recommend.php

@@ -1,6 +1,6 @@
 <?php
 
-$env = require_once('../loadEnv.php');
+$env = require_once '../loadEnv.php';
 
 use Algolia\AlgoliaSearch\Api\RecommendClient;
 
@@ -15,8 +15,8 @@
                 'indexName' => $indexName,
                 'model' => 'bought-together',
                 'objectID' => $query,
-                'threshold' => 0
-            ]
-        ]
+                'threshold' => 0,
+            ],
+        ],
     ]
 ));

playground/php/src/search.php

@@ -1,63 +1,63 @@
 <?php
 
-$env = require_once('../loadEnv.php');
+$env = require_once '../loadEnv.php';
 
 use Algolia\AlgoliaSearch\Api\SearchClient;
 use Algolia\AlgoliaSearch\Configuration\SearchConfig;
 
-//$client = SearchClient::create(
+// $client = SearchClient::create(
 //    $env['ALGOLIA_APPLICATION_ID'],
 //    $env['ALGOLIA_ADMIN_KEY']
-//);
+// );
 
 $config = SearchConfig::create(
     $env['ALGOLIA_APPLICATION_ID'],
     $env['ALGOLIA_ADMIN_KEY']
 );
 
-$config->setMaxRetries(200);
-var_dump($config->getDefaultMaxRetries());
+// $config->setMaxRetries(200);
+// var_dump($config->getDefaultMaxRetries());
 
-//$config->setFullHosts(
+// $config->setFullHosts(
 //    [
 //       'http://localhost:6677',
 //       'http://localhost:6678',
 //    ]
-//);
+// );
 
-$client = SearchClient::createWithConfig($config);
-$indexName = $env['SEARCH_INDEX'];
-
-
-$response = $client->saveObject(
-    $indexName,
-    ['objectID' => "1", 'name' => 'Michel'],
-);
-
-$client->waitForTask($indexName, $response['taskID']);
+// $client = SearchClient::createWithConfig($config);
+// $indexName = $env['SEARCH_INDEX'];
+//
+//
+// $response = $client->saveObject(
+//     $indexName,
+//     ['objectID' => "1", 'name' => 'Michel'],
+// );
+//
+// $client->waitForTask($indexName, $response['taskID']);
 
-//$response = $client->saveObject(
+// $response = $client->saveObject(
 //    $indexName,
 //    ['objectID' => "2", 'name' => 'Raymond'],
-//);
+// );
 //
-//$client->waitForTask($indexName, $response['taskID']);
+// $client->waitForTask($indexName, $response['taskID']);
 
-$newGuys = [
-  ['objectID' => "3", 'name' => 'Hubert'],
-  ['objectID' => "4", 'name' => 'Bob'],
-  ['objectID' => "5", 'name' => $env['SEARCH_QUERY']],
-];
+// $newGuys = [
+//   ['objectID' => "3", 'name' => 'Hubert'],
+//   ['objectID' => "4", 'name' => 'Bob'],
+//   ['objectID' => "5", 'name' => $env['SEARCH_QUERY']],
+// ];
 
-$response = $client->replaceAllObjects($indexName, $newGuys, 2);
+// $response = $client->replaceAllObjects($indexName, $newGuys, 2);
 
-//var_dump(
+// var_dump(
 //    $client->search([
 //        'requests' => [
 //            ['indexName' => $indexName, 'query' => $env['SEARCH_QUERY']],
 //        ],
 //    ])
-//);
+// );
 
 // $apiKey = SearchClient::generateSecuredApiKey($env['ALGOLIA_APPLICATION_ID'], ['edit','browse','listIndices']);
 // var_dump($apiKey);
@@ -88,3 +88,9 @@
 //     $rules[] = $rule;
 // }
 // var_dump($rules);
+
+$configForIngestion = $config->setFullHosts(['http://localhost:6689'])->setTransformationRegion('eu');
+
+$clientWithTransformation = SearchClient::createWithConfig($configForIngestion);
+
+var_dump($clientWithTransformation->saveObjectsWithTransformation('boyd', [['objectID' => '1', 'name' => 'Michel']], true));

scripts/cts/runCts.ts

@@ -158,7 +158,7 @@ export async function runCts(
     assertValidReplaceAllObjectsFailed(languages.length - skip('dart'));
     assertValidReplaceAllObjectsScopes(languages.length - skip('dart'));
     assertValidWaitForApiKey(languages.length - skip('dart'));
-    assertPushMockValid(only('javascript') + only('go') + only('python') + only('java'));
+    assertPushMockValid(only('javascript') + only('go') + only('python') + only('java') + only('php'));
   }
   if (withBenchmarkServer) {
     printBenchmarkReport();

specs/search/helpers/partialUpdateObjectsWithTransformation.yml

@@ -2,10 +2,11 @@ method:
   post:
     x-helper: true
     x-available-languages:
-      - javascript
       - go
-      - python
       - java
+      - javascript
+      - php
+      - python
     tags:
       - Records
     operationId: partialUpdateObjectsWithTransformation

specs/search/helpers/saveObjectsWithTransformation.yml

@@ -2,10 +2,11 @@ method:
   get:
     x-helper: true
     x-available-languages:
-      - javascript
       - go
-      - python
       - java
+      - javascript
+      - php
+      - python
     tags:
       - Records
     operationId: saveObjectsWithTransformation

templates/java/api.mustache

@@ -56,6 +56,11 @@ public class {{classname}} extends ApiClient {
     {{#isSearchClient}}
     private IngestionClient ingestionTransporter;
 
+    /**
+     * Sets the region of the current algolia application to the configuration, this is required to be called if you wish to leverage the transformation pipeline (via the *WithTransformation methods).
+     *
+     * @param region (required)
+     */
     public void setTransformationRegion(String region) {
       this.ingestionTransporter = new IngestionClient(this.authInterceptor.getApplicationId(), this.authInterceptor.getApiKey(), region, this.clientOptions);
     }

templates/php/api.mustache

@@ -18,6 +18,10 @@ use {{invokerPackage}}\RetryStrategy\ApiWrapperInterface;
 use {{invokerPackage}}\RetryStrategy\ClusterHosts;
 use {{invokerPackage}}\Support\Helpers;
 
+{{#isSearchClient}}
+use {{invokerPackage}}\Configuration\IngestionConfig;
+{{/isSearchClient}}
+
 use Algolia\AlgoliaSearch\Exceptions\NotFoundException;
 
 /**
@@ -34,6 +38,11 @@ use Algolia\AlgoliaSearch\Exceptions\NotFoundException;
      */
     protected $api;
 
+    /**
+     * @var IngestionClient
+     */
+    protected $ingestionTransporter;
+
     /**
      * @var {{configClassname}}
      */
@@ -93,7 +102,25 @@ use Algolia\AlgoliaSearch\Exceptions\NotFoundException;
             self::getClusterHosts($config)
         );
 
-        return new static($apiWrapper, $config);
+        $client = new static($apiWrapper, $config);
+
+        {{#isSearchClient}}
+        if (null !== $config->getTransformationRegion()) {
+            $ingestionConfig = IngestionConfig::create($config->getAppId(), $config->getAlgoliaApiKey(), $config->getTransformationRegion());
+
+            if ($hosts = $config->getHosts()) {
+                if ($config->getHasFullHosts()) {
+                    $ingestionConfig = $ingestionConfig->setFullHosts($hosts);
+                } else {
+                    $ingestionConfig = $ingestionConfig->setHosts($hosts);
+                }
+            }
+
+            $client->ingestionTransporter = IngestionClient::createWithConfig($ingestionConfig);
+        }
+        {{/isSearchClient}}
+
+        return $client;
     }
 
     /**
@@ -514,6 +541,27 @@ use Algolia\AlgoliaSearch\Exceptions\NotFoundException;
       return $this->chunkedBatch($indexName, $objects, 'addObject', $waitForTasks, $batchSize, $requestOptions);
     }
 
+    /**
+     * Helper: Similar to the `saveObjects` method but requires a Push connector
+     * (https://www.algolia.com/doc/guides/sending-and-managing-data/send-and-update-your-data/connectors/push/)
+     * to be created first, in order to transform records before indexing them to Algolia. The
+     * `region` must have been passed to the client instantiation method.
+     *
+     * @param string $indexName      the `indexName` to replace `objects` in
+     * @param array  $objects        the array of `objects` to store in the given Algolia `indexName`
+     * @param bool   $waitForTasks   Whether or not we should wait until every `batch` tasks has been processed, this operation may slow the total execution time of this method but is more reliable
+     * @param array  $batchSize      The size of the chunk of `objects`. The number of `batch` calls will be equal to `length(objects) / batchSize`. Defaults to 1000.
+     * @param array  $requestOptions Request options
+     */
+    public function saveObjectsWithTransformation($indexName, $objects, $waitForTasks = false, $batchSize = 1000, $requestOptions = [])
+    {
+        if (null == $this->ingestionTransporter) {
+            throw new \InvalidArgumentException('`setTransformationRegion` must have been called before calling this method.');
+        }
+
+        return $this->ingestionTransporter->push($indexName, ['action'=>'addObject', 'records'=>$objects], $waitForTasks, $requestOptions);
+    }
+
     /**
     * Helper: Deletes every records for the given objectIDs. The `chunkedBatch` helper is used under the hood, which creates a `batch` requests with at most 1000 objectIDs in it.
     *
@@ -548,6 +596,28 @@ use Algolia\AlgoliaSearch\Exceptions\NotFoundException;
       return $this->chunkedBatch($indexName, $objects, ($createIfNotExists == TRUE) ? 'partialUpdateObject' : 'partialUpdateObjectNoCreate', $waitForTasks, $batchSize, $requestOptions);
     }
 
+    /**
+     * Helper: Similar to the `partialUpdateObjects` method but requires a Push connector
+     * (https://www.algolia.com/doc/guides/sending-and-managing-data/send-and-update-your-data/connectors/push/)
+     * to be created first, in order to transform records before indexing them to Algolia. The
+     * `region` must have been passed to the client instantiation method.
+     *
+     * @param string $indexName         the `indexName` to replace `objects` in
+     * @param array  $objects           the array of `objects` to store in the given Algolia `indexName`
+     * @param bool   $createIfNotExists To be provided if non-existing objects are passed, otherwise, the call will fail..
+     * @param bool   $waitForTasks      Whether or not we should wait until every `batch` tasks has been processed, this operation may slow the total execution time of this method but is more reliable
+     * @param array  $batchSize         The size of the chunk of `objects`. The number of `batch` calls will be equal to `length(objects) / batchSize`. Defaults to 1000.
+     * @param array  $requestOptions    Request options
+     */
+    public function partialUpdateObjectsWithTransformation($indexName, $objects, $createIfNotExists, $waitForTasks = false, $batchSize = 1000, $requestOptions = [])
+    {
+        if (null == $this->ingestionTransporter) {
+            throw new \InvalidArgumentException('`setTransformationRegion` must have been called before calling this method.');
+        }
+
+        return $this->ingestionTransporter->push($indexName, ['action'=>(true == $createIfNotExists) ? 'partialUpdateObject' : 'partialUpdateObjectNoCreate', 'records'=>$objects], $waitForTasks, $requestOptions);
+    }
+
     /**
     * Helper: Chunks the given `objects` list in subset of 1000 elements max in order to make it fit in `batch` requests.
     *

templates/php/client_config.mustache

@@ -66,6 +66,25 @@ class {{configClassname}} extends {{#hasRegionalHost}}ConfigWithRegion{{/hasRegi
     {
         return $this->config['defaultMaxRetries'];
     }
+
+    /**
+     * Sets the region of the current algolia application to the configuration, this is required to be called if you wish to leverage the transformation pipeline (via the *WithTransformation methods).
+     *
+     * @param string $region the user agent of the api client
+     *
+     * @return $this
+     */
+    public function setTransformationRegion($region)
+    {
+        $this->config['region'] = $region;
+
+        return $this;
+    }
+
+    public function getTransformationRegion()
+    {
+        return $this->config['region'];
+    }
     {{/isSearchClient}}
 
     public function getDefaultConfiguration()
@@ -80,6 +99,7 @@ class {{configClassname}} extends {{#hasRegionalHost}}ConfigWithRegion{{/hasRegi
             'connectTimeout' => {{#lambda.toSeconds}}{{x-timeouts.server.connect}}{{/lambda.toSeconds}},
             'defaultHeaders' => [],
             {{#isSearchClient}}
+            'region' => null,
             'waitTaskTimeBeforeRetry' => $this->defaultWaitTaskTimeBeforeRetry,
             'defaultMaxRetries' => $this->defaultMaxRetries,
             'defaultForwardToReplicas' => null,

templates/php/tests/client/createClient.mustache

@@ -4,6 +4,9 @@ $client = $this->createClient(
     {{#parametersWithDataTypeMap.apiKey}}"{{parametersWithDataTypeMap.apiKey.value}}"{{/parametersWithDataTypeMap.apiKey}}{{^parametersWithDataTypeMap.apiKey}}null{{/parametersWithDataTypeMap.apiKey}}{{#hasRegionalHost}},
     {{#parametersWithDataTypeMap.region}}"{{parametersWithDataTypeMap.region.value}}"{{/parametersWithDataTypeMap.region}}{{^parametersWithDataTypeMap.region}}null{{/parametersWithDataTypeMap.region}}{{/hasRegionalHost}}
 );
-{{^isError}}$this->assertIsObject($client);{{/isError}}{{/useEchoRequester}}{{#hasCustomHosts}}
+{{^isError}}$this->assertIsObject($client);{{/isError}}{{/useEchoRequester}}{{^hasTransformationRegion}}{{#hasCustomHosts}}
 $client = {{client}}::createWithConfig({{clientPrefix}}Config::create("{{parametersWithDataTypeMap.appId.value}}","{{parametersWithDataTypeMap.apiKey.value}}"{{#hasRegionalHost}}{{#parametersWithDataTypeMap.region}},"{{parametersWithDataTypeMap.region.value}}"{{/parametersWithDataTypeMap.region}}{{/hasRegionalHost}})->setFullHosts([{{#customHosts}}"http://" . (getenv("CI") == "true" ? "localhost" : "host.docker.internal") . ":{{port}}"{{^-last}},{{/-last}}{{/customHosts}}]));
-{{/hasCustomHosts}}
+{{/hasCustomHosts}}{{/hasTransformationRegion}}
+{{#hasTransformationRegion}}
+$client = {{client}}::createWithConfig({{clientPrefix}}Config::create("{{parametersWithDataTypeMap.appId.value}}","{{parametersWithDataTypeMap.apiKey.value}}")->setFullHosts([{{#customHosts}}"http://" . (getenv("CI") == "true" ? "localhost" : "host.docker.internal") . ":{{port}}"{{^-last}},{{/-last}}{{/customHosts}}])->setTransformationRegion("{{{transformationRegion}}}"));
+{{/hasTransformationRegion}}