feat(delete): delete replica indices in one go (#126)

* feat(delete): delete replica indices in one go

This commit makes deleting replicas possible.
By default, the API returns a 403 if you try to delete a replica index.
Since this is annoying, I added the multiple steps it takes to delete a
replica index to the `delete` command.
---------

Co-authored-by: Clement Denoix <[email protected]>

Author: kai687

pkg/cmd/indices/delete/delete.go

@@ -5,6 +5,7 @@ import (
 	"strings"
 
 	"github.com/MakeNowJust/heredoc"
+	"github.com/algolia/algoliasearch-client-go/v3/algolia/opt"
 	"github.com/algolia/algoliasearch-client-go/v3/algolia/search"
 	"github.com/spf13/cobra"
 
@@ -105,7 +106,12 @@ func runDeleteCmd(opts *DeleteOptions) error {
 
 	for _, index := range indices {
 		if _, err := index.Delete(); err != nil {
-			return fmt.Errorf("failed to delete index %q: %w", index.GetName(), err)
+			opts.IO.StartProgressIndicatorWithLabel(fmt.Sprint("Deleting replica index ", index.GetName()))
+			err := deleteReplicaIndex(client, index)
+			opts.IO.StopProgressIndicator()
+			if err != nil {
+				return fmt.Errorf("failed to delete index %q: %w", index.GetName(), err)
+			}
 		}
 	}
 
@@ -116,3 +122,81 @@ func runDeleteCmd(opts *DeleteOptions) error {
 
 	return nil
 }
+
+// Delete a replica index.
+func deleteReplicaIndex(client *search.Client, replicaIndex *search.Index) error {
+	replicaName := replicaIndex.GetName()
+	primaryName, err := findPrimaryIndex(replicaIndex)
+	if err != nil {
+		return fmt.Errorf("can't find primary index for %q: %w", replicaName, err)
+	}
+
+	err = detachReplicaIndex(replicaName, primaryName, client)
+	if err != nil {
+		return fmt.Errorf("can't unlink replica index %s from primary index %s: %w", replicaName, primaryName, err)
+	}
+
+	_, err = replicaIndex.Delete()
+	if err != nil {
+		return fmt.Errorf("can't delete replica index %q: %w", replicaName, err)
+	}
+
+	return nil
+}
+
+// Find the primary index of a replica index
+func findPrimaryIndex(replicaIndex *search.Index) (string, error) {
+	replicaName := replicaIndex.GetName()
+	settings, err := replicaIndex.GetSettings()
+
+	if err != nil {
+		return "", fmt.Errorf("can't get settings of replica index %q: %w", replicaName, err)
+	}
+
+	primary := settings.Primary
+	if primary == nil {
+		return "", fmt.Errorf("index %s doesn't have a primary", replicaName)
+	}
+
+	return primary.Get(), nil
+}
+
+// Remove replica from `replicas` settings of the primary index
+func detachReplicaIndex(replicaName string, primaryName string, client *search.Client) error {
+	primaryIndex := client.InitIndex(primaryName)
+	settings, err := primaryIndex.GetSettings()
+
+	if err != nil {
+		return fmt.Errorf("can't get settings of primary index %q: %w", primaryName, err)
+	}
+
+	replicas := settings.Replicas.Get()
+	indexOfReplica := findIndex(replicas, replicaName)
+
+	// Delete the replica at position `indexOfReplica` from the array
+	replicas = append(replicas[:indexOfReplica], replicas[indexOfReplica+1:]...)
+
+	res, err := primaryIndex.SetSettings(
+		search.Settings{
+			Replicas: opt.Replicas(replicas...),
+		},
+	)
+
+	if err != nil {
+		return fmt.Errorf("can't update settings of index %q: %w", primaryName, err)
+	}
+
+	// Wait until the settings are updated, else a subsequent `delete` will fail.
+	_ = res.Wait()
+	return nil
+}
+
+// Find the index of the string `target` in the array `arr`
+func findIndex(arr []string, target string) int {
+	for i, v := range arr {
+		if v == target {
+			return i
+		}
+	}
+	return -1
+}

pkg/cmd/indices/delete/delete_test.go

@@ -4,6 +4,7 @@ import (
 	"fmt"
 	"testing"
 
+	"github.com/algolia/algoliasearch-client-go/v3/algolia/opt"
 	"github.com/algolia/algoliasearch-client-go/v3/algolia/search"
 	"github.com/google/shlex"
 	"github.com/stretchr/testify/assert"
@@ -20,6 +21,7 @@ func TestNewDeleteCmd(t *testing.T) {
 		name      string
 		tty       bool
 		cli       string
+		isReplica bool
 		wantsErr  bool
 		wantsOpts DeleteOptions
 	}{
@@ -98,6 +100,7 @@ func Test_runDeleteCmd(t *testing.T) {
 		name    string
 		cli     string
 		indices []string
+		replica bool
 		isTTY   bool
 		wantOut string
 	}{
@@ -129,13 +132,37 @@ func Test_runDeleteCmd(t *testing.T) {
 			isTTY:   true,
 			wantOut: "✓ Deleted indices foo, bar\n",
 		},
+		{
+			name:    "TTY, replica indice",
+			cli:     "foo --confirm",
+			indices: []string{"foo"},
+			replica: true,
+			isTTY:   true,
+			wantOut: "✓ Deleted indices foo\n",
+		},
 	}
 
 	for _, tt := range tests {
 		t.Run(tt.name, func(t *testing.T) {
 			r := httpmock.Registry{}
 			for _, index := range tt.indices {
-				r.Register(httpmock.REST("GET", fmt.Sprintf("1/indexes/%s/settings", index)), httpmock.JSONResponse(search.DeleteKeyRes{}))
+				// First settings call with `Exists()`
+				r.Register(httpmock.REST("GET", fmt.Sprintf("1/indexes/%s/settings", index)), httpmock.JSONResponse(search.Settings{}))
+				if tt.replica {
+					// We want the first `Delete()` call to fail
+					r.Register(httpmock.REST("DELETE", fmt.Sprintf("1/indexes/%s", index)), httpmock.ErrorResponse())
+					// Second settings call to fetch the primary index name
+					r.Register(httpmock.REST("GET", fmt.Sprintf("1/indexes/%s/settings", index)), httpmock.JSONResponse(search.Settings{
+						Primary: opt.Primary("bar"),
+					}))
+					// Third settings call to fetch the primary index settings
+					r.Register(httpmock.REST("GET", "1/indexes/bar/settings"), httpmock.JSONResponse(search.Settings{
+						Replicas: opt.Replicas(index),
+					}))
+					// Fourth settings call to update the primary settings
+					r.Register(httpmock.REST("PUT", "1/indexes/bar/settings"), httpmock.JSONResponse(search.Settings{}))
+				}
+				// Final `Delete()` call
 				r.Register(httpmock.REST("DELETE", fmt.Sprintf("1/indexes/%s", index)), httpmock.JSONResponse(search.DeleteKeyRes{}))
 			}
 			defer r.Verify(t)

pkg/httpmock/registry.go

@@ -46,11 +46,9 @@ func (r *Registry) Request(req *http.Request) (*http.Response, error) {
 		if s.matched || !s.Matcher(req) {
 			continue
 		}
-		if stub != nil {
-			r.mu.Unlock()
-			return nil, fmt.Errorf("more than 1 stub matched %v", req)
-		}
+
 		stub = s
+		break
 	}
 	if stub != nil {
 		stub.matched = true

pkg/httpmock/stub.go

@@ -42,6 +42,12 @@ func JSONResponse(body interface{}) Responder {
 	}
 }
 
+func ErrorResponse() Responder {
+	return func(req *http.Request) (*http.Response, error) {
+		return httpResponse(404, req, bytes.NewBufferString("")), nil
+	}
+}
+
 func httpResponse(status int, req *http.Request, body io.Reader) *http.Response {
 	return &http.Response{
 		StatusCode: status,