feat(go): add bridge to transformation on search (#4924)

Author: shortcuts

playground/go/search.go

@@ -4,6 +4,7 @@ import (
 	"fmt"
 
 	"github.com/algolia/algoliasearch-client-go/v4/algolia/search"
+	// "github.com/algolia/algoliasearch-client-go/v4/algolia/transport"
 )
 
 func testSearch(appID, apiKey string) int {
@@ -23,6 +24,29 @@ func testSearch(appID, apiKey string) int {
 		panic(err)
 	}
 
+	// config := search.SearchConfiguration{
+	// 	Configuration: transport.Configuration{
+	// 		AppID:  appID,
+	// 		ApiKey: apiKey,
+	// 	},
+	// }
+	//
+	// config.WithTransformation("eu")
+	//
+	// fmt.Println(config.Transformation.Region)
+	//
+	// searchClient, err := search.NewClientWithConfig(config)
+	// if err != nil {
+	// 	panic(err)
+	// }
+	//
+	// watchResponse, err := searchClient.SaveObjectsWithTransformation("foo", []map[string]any{{"objectID": "foobarbaz"}}, search.WithWaitForTasks(true))
+	// if err != nil {
+	// 	panic(err)
+	// }
+	//
+	// fmt.Printf("%#v\n", watchResponse)
+
 	/*
 		response, err := searchClient.AddOrUpdateObject(
 			searchClient.NewApiAddOrUpdateObjectRequest(

templates/go/api.mustache

@@ -11,6 +11,7 @@ import (
 	"strings"
   {{#isSearchClient}}
   "github.com/algolia/algoliasearch-client-go/v4/algolia/errs"
+	"github.com/algolia/algoliasearch-client-go/v4/algolia/ingestion"
   "cmp"
   "crypto/hmac"
 	"crypto/sha256"

templates/go/client.mustache

@@ -20,6 +20,7 @@ import (
 
   "github.com/algolia/algoliasearch-client-go/v4/algolia/call"
   "github.com/algolia/algoliasearch-client-go/v4/algolia/compression"
+	"github.com/algolia/algoliasearch-client-go/v4/algolia/ingestion"
   "github.com/algolia/algoliasearch-client-go/v4/algolia/transport"
 )
 
@@ -29,6 +30,9 @@ type APIClient struct {
 	appID     string
 	cfg       *{{#lambda.titlecase}}{{#lambda.camelcase}}{{client}}{{/lambda.camelcase}}{{/lambda.titlecase}}Configuration
 	transport *transport.Transport
+  {{#isSearchClient}}
+	ingestionTransporter *ingestion.APIClient
+  {{/isSearchClient}}
 }
 
 // NewClient creates a new API client with {{#hasRegionalHost}}appID, apiKey and region.{{/hasRegionalHost}}{{^hasRegionalHost}}appID and apiKey.{{/hasRegionalHost}}
@@ -72,13 +76,26 @@ func NewClientWithConfig(cfg {{#lambda.titlecase}}{{#lambda.camelcase}}{{client}
 		cfg.WriteTimeout = {{x-timeouts.server.write}} * time.Millisecond
 	}
 
-  return &APIClient{
+  apiClient := APIClient{
 		appID: cfg.AppID,
 		cfg:   &cfg,
 		transport: transport.New(
-      cfg.Configuration,
+			cfg.Configuration,
 		),
-	}, nil
+	}
+
+  {{#isSearchClient}}
+  if cfg.Transformation != nil && cfg.Transformation.Region != "" {
+		ingestionClient, err := ingestion.NewClient(apiClient.appID, cfg.ApiKey, cfg.Transformation.Region)
+    if err != nil {
+      return nil, err //nolint:wrapcheck
+    }
+
+    apiClient.ingestionTransporter = ingestionClient
+  }
+  {{/isSearchClient}}
+
+	return &apiClient, nil
 }
 
 {{#hasRegionalHost}}
@@ -375,4 +392,4 @@ func (a APIError) Is(target error) bool {
   _, ok := target.(*APIError)
 
   return ok
-}
+}

templates/go/configuration.mustache

@@ -3,6 +3,7 @@ package {{packageName}}
 
 import (
   "github.com/algolia/algoliasearch-client-go/v4/algolia/transport"
+	"github.com/algolia/algoliasearch-client-go/v4/algolia/ingestion"
 )
 
 {{#hasRegionalHost}}
@@ -22,4 +23,20 @@ type {{#lambda.titlecase}}{{#lambda.camelcase}}{{client}}{{/lambda.camelcase}}{{
 	transport.Configuration
   
   {{#hasRegionalHost}}Region Region{{/hasRegionalHost}}
+  {{#isSearchClient}}
+  Transformation *TransformationConfiguration
+  {{/isSearchClient}}
 }
+
+{{#isSearchClient}}
+type TransformationConfiguration struct {
+  Region ingestion.Region
+}
+
+// WithTransformation 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).
+func (s *SearchConfiguration) WithTransformation(region ingestion.Region) {
+  s.Transformation = &TransformationConfiguration{
+    Region: region,
+  }
+}
+{{/isSearchClient}}

templates/go/search_helpers.mustache

@@ -735,4 +735,94 @@ func (c *APIClient) IndexExists(indexName string) (bool, error) {
 	}
 
 	return false, err
+}
+
+/*
+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've been passed to the client's config at instantiation.
+
+	@param indexName string - the index name to save objects into.
+	@param objects []map[string]any - List of objects to save.
+	@param opts ...ChunkedBatchOption - Optional parameters for the request.
+	@return []BatchResponse - List of batch responses.
+	@return error - Error if any.
+*/
+func (c *APIClient) SaveObjectsWithTransformation(indexName string, objects []map[string]any, opts ...ChunkedBatchOption) (*ingestion.WatchResponse, error) {
+  if c.ingestionTransporter == nil {
+		return nil, reportError("`region` must be provided at client instantiation before calling this method.")
+  }
+
+  var records []ingestion.PushTaskRecords
+
+  rawObjects, err := json.Marshal(objects)
+  if err != nil {
+    return nil, reportError("unable to marshal the given `objects`: %w", err)
+  }
+
+  err = json.Unmarshal(rawObjects, &records)
+  if err != nil {
+    return nil, reportError("unable to unmarshal the given `objects` to an `[]ingestion.PushTaskRecords` payload: %w", err)
+  }
+
+  return c.ingestionTransporter.Push( //nolint:wrapcheck
+    c.ingestionTransporter.NewApiPushRequest(
+      indexName,
+      ingestion.NewEmptyPushTaskPayload().
+        SetAction(ingestion.ACTION_ADD_OBJECT).
+        SetRecords(records),
+      ),
+    )
+}
+
+/*
+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've been passed to the client instantiation method.
+
+	@param indexName string - the index name to save objects into.
+	@param objects []map[string]any - List of objects to save.
+	@param opts ...ChunkedBatchOption - Optional parameters for the request.
+	@return []BatchResponse - List of batch responses.
+	@return error - Error if any.
+*/
+func (c *APIClient) PartialUpdateObjectsWithTransformation(indexName string, objects []map[string]any, opts ...PartialUpdateObjectsOption) (*ingestion.WatchResponse, error) {
+  if c.ingestionTransporter == nil {
+		return nil, reportError("`region` must be provided at client instantiation before calling this method.")
+  }
+
+
+	conf := config{
+		headerParams:      map[string]string{},
+		createIfNotExists: true,
+	}
+
+	for _, opt := range opts {
+		opt.apply(&conf)
+	}
+
+	var action ingestion.Action
+
+	if conf.createIfNotExists {
+		action = ingestion.ACTION_PARTIAL_UPDATE_OBJECT
+	} else {
+		action = ingestion.ACTION_PARTIAL_UPDATE_OBJECT_NO_CREATE
+	}
+
+  var records []ingestion.PushTaskRecords
+
+  rawObjects, err := json.Marshal(objects)
+  if err != nil {
+    return nil, reportError("unable to marshal the given `objects`: %w", err)
+  }
+
+  err = json.Unmarshal(rawObjects, &records)
+  if err != nil {
+    return nil, reportError("unable to unmarshal the given `objects` to an `[]ingestion.PushTaskRecords` payload: %w", err)
+  }
+
+  return c.ingestionTransporter.Push( //nolint:wrapcheck
+    c.ingestionTransporter.NewApiPushRequest(
+      indexName,
+      ingestion.NewEmptyPushTaskPayload().
+        SetAction(action).
+        SetRecords(records),
+      ),
+    )
 }