Go: Add command ZInterCard (valkey-io#3078)

* Go: Add command ZInterCard

Signed-off-by: TJ Zhang <tj.zhang@improving.com>

Author: tjzhang-BQ

CHANGELOG.md

@@ -5,6 +5,7 @@
 * Go: Add `ZUNION` ([#3119](https://github.com/valkey-io/valkey-glide/pull/3119))
 * Go: Add `ZUNIONSTORE` ([#3136](https://github.com/valkey-io/valkey-glide/pull/3136))
 * Go: Add `XINFO GROUPS` ([#3106](https://github.com/valkey-io/valkey-glide/pull/3106))
+* Go: Add `ZInterCard` ([#3078](https://github.com/valkey-io/valkey-glide/issues/3078))
 
 #### Breaking Changes
 
@@ -30,7 +31,6 @@
 * Node, Python: Add `IFEQ` option ([#2909](https://github.com/valkey-io/valkey-glide/pull/2909), [#2962](https://github.com/valkey-io/valkey-glide/pull/2962))
 * Java: Add `IFEQ` option ([#2978](https://github.com/valkey-io/valkey-glide/pull/2978))
 * Core: Add AzAffinityReplicasAndPrimary Read Strategy([#2986](https://github.com/valkey-io/valkey-glide/pull/2986))
-
 #### Breaking Changes
 
 #### Fixes

go/api/base_client.go

@@ -6031,7 +6031,7 @@ func (client *baseClient) ZInterWithScores(
 //
 // Return value:
 //
-//	The number of elements in the resulting sorted set stored at <code>destination</code>.
+//	The number of elements in the resulting sorted set stored at `destination`.
 //
 // [valkey.io]: https://valkey.io/commands/zinterstore/
 func (client *baseClient) ZInterStore(destination string, keysOrWeightedKeys options.KeysOrWeightedKeys) (int64, error) {
@@ -6060,7 +6060,7 @@ func (client *baseClient) ZInterStore(destination string, keysOrWeightedKeys opt
 //
 // Return value:
 //
-//	The number of elements in the resulting sorted set stored at <code>destination</code>.
+//	The number of elements in the resulting sorted set stored at `destination`.
 //
 // [valkey.io]: https://valkey.io/commands/zinterstore/
 func (client *baseClient) ZInterStoreWithOptions(
@@ -6330,3 +6330,52 @@ func (client *baseClient) ZUnionStoreWithOptions(
 	}
 	return handleIntResponse(result)
 }
+
+// Returns the cardinality of the intersection of the sorted sets specified by `keys`.
+//
+// See [valkey.io] for details.
+//
+// Parameters:
+//
+//	keys - The keys of the sorted sets.
+//
+// Return value:
+//
+//	The cardinality of the intersection of the sorted sets.
+//
+// [valkey.io]: https://valkey.io/commands/zintercard/
+func (client *baseClient) ZInterCard(keys []string) (int64, error) {
+	return client.ZInterCardWithOptions(keys, nil)
+}
+
+// Returns the cardinality of the intersection of the sorted sets specified by `keys`.
+// If the intersection cardinality reaches `options.limit` partway through the computation, the
+// algorithm will exit early and yield `options.limit` as the cardinality.
+//
+// See [valkey.io] for details.
+//
+// Parameters:
+//
+//	keys - The keys of the sorted sets.
+//	options - The options for the ZInterCard command, see - [options.ZInterCardOptions].
+//
+// Return value:
+//
+//	The cardinality of the intersection of the sorted sets.
+//
+// [valkey.io]: https://valkey.io/commands/zintercard/
+func (client *baseClient) ZInterCardWithOptions(keys []string, options *options.ZInterCardOptions) (int64, error) {
+	args := append([]string{strconv.Itoa(len(keys))}, keys...)
+	if options != nil {
+		optionsArgs, err := options.ToArgs()
+		if err != nil {
+			return defaultIntResponse, err
+		}
+		args = append(args, optionsArgs...)
+	}
+	result, err := client.executeCommand(C.ZInterCard, args)
+	if err != nil {
+		return defaultIntResponse, err
+	}
+	return handleIntResponse(result)
+}

go/api/options/zintercard_options.go

@@ -0,0 +1,31 @@
+// Copyright Valkey GLIDE Project Contributors - SPDX Identifier: Apache-2.0
+package options
+
+import (
+	"github.com/valkey-io/valkey-glide/go/utils"
+)
+
+// This struct represents the optional arguments for the ZINTER command.
+type ZInterCardOptions struct {
+	limit int64
+}
+
+func NewZInterCardOptions() *ZInterCardOptions {
+	return &ZInterCardOptions{limit: -1}
+}
+
+// SetLimit sets the limit for the ZInterCard command.
+func (options *ZInterCardOptions) SetLimit(limit int64) *ZInterCardOptions {
+	options.limit = limit
+	return options
+}
+
+func (options *ZInterCardOptions) ToArgs() ([]string, error) {
+	args := []string{}
+
+	if options.limit != -1 {
+		args = append(args, LimitKeyword, utils.IntToString(options.limit))
+	}
+
+	return args, nil
+}

go/api/sorted_set_commands.go

@@ -110,4 +110,8 @@ type SortedSetCommands interface {
 		keysOrWeightedKeys options.KeysOrWeightedKeys,
 		zUnionOptions *options.ZUnionOptions,
 	) (int64, error)
+
+	ZInterCard(keys []string) (int64, error)
+
+	ZInterCardWithOptions(keys []string, options *options.ZInterCardOptions) (int64, error)
 }

go/api/sorted_set_commands_test.go

@@ -1527,3 +1527,73 @@ func ExampleGlideClusterClient_ZUnionStoreWithOptions() {
 
 	// Output: 3
 }
+
+func ExampleGlideClient_ZInterCard() {
+	var client *GlideClient = getExampleGlideClient() // example helper function
+
+	client.ZAdd("key1", map[string]float64{"a": 1.0, "b": 2.0, "c": 3.0, "d": 4.0})
+	client.ZAdd("key2", map[string]float64{"e": 1.0, "f": 2.0, "g": 3.0, "h": 4.0})
+
+	res, err := client.ZInterCard([]string{"key1", "key2"})
+	if err != nil {
+		fmt.Println("Glide example failed with an error: ", err)
+	}
+	fmt.Println(res)
+
+	// Output:
+	// 3
+}
+
+func ExampleGlideClusterClient_ZInterCard() {
+	var client *GlideClusterClient = getExampleGlideClusterClient() // example helper function
+
+	client.ZAdd("key1", map[string]float64{"a": 1.0, "b": 2.0, "c": 3.0, "d": 4.0})
+	client.ZAdd("key2", map[string]float64{"e": 1.0, "f": 2.0, "g": 3.0, "h": 4.0})
+
+	res, err := client.ZInterCard([]string{"key1", "key2"})
+	if err != nil {
+		fmt.Println("Glide example failed with an error: ", err)
+	}
+	fmt.Println(res)
+
+	// Output:
+	// 3
+}
+
+func ExampleGlideClient_ZInterCardWithOptions() {
+	var client *GlideClient = getExampleGlideClient() // example helper function
+
+	client.ZAdd("key1", map[string]float64{"a": 1.0, "b": 2.0, "c": 3.0, "d": 4.0})
+	client.ZAdd("key2", map[string]float64{"e": 1.0, "f": 2.0, "g": 3.0, "h": 4.0})
+
+	res, err := client.ZInterCardWithOptions(
+		[]string{"key1", "key2"},
+		options.NewZInterCardOptions().SetLimit(5),
+	)
+	if err != nil {
+		fmt.Println("Glide example failed with an error: ", err)
+	}
+	fmt.Println(res)
+
+	// Output:
+	// 3
+}
+
+func ExampleGlideClusterClient_ZInterCardWithOptions() {
+	var client *GlideClusterClient = getExampleGlideClusterClient() // example helper function
+
+	client.ZAdd("key1", map[string]float64{"a": 1.0, "b": 2.0, "c": 3.0, "d": 4.0})
+	client.ZAdd("key2", map[string]float64{"e": 1.0, "f": 2.0, "g": 3.0, "h": 4.0})
+
+	res, err := client.ZInterCardWithOptions(
+		[]string{"key1", "key2"},
+		options.NewZInterCardOptions().SetLimit(5),
+	)
+	if err != nil {
+		fmt.Println("Glide example failed with an error: ", err)
+	}
+	fmt.Println(res)
+
+	// Output:
+	// 3
+}

go/integTest/shared_commands_test.go

@@ -8836,3 +8836,59 @@ func (suite *GlideTestSuite) TestZUnionStoreAndZUnionStoreWithOptions() {
 		assert.IsType(suite.T(), &errors.RequestError{}, err)
 	})
 }
+
+func (suite *GlideTestSuite) TestZInterCard() {
+	suite.SkipIfServerVersionLowerThanBy("7.0.0")
+	suite.runWithDefaultClients(func(client api.BaseClient) {
+		key1 := "{key}:1-" + uuid.NewString()
+		key2 := "{key}:2-" + uuid.NewString()
+		key3 := "{key}:3-" + uuid.NewString()
+
+		membersScores1 := map[string]float64{
+			"a": 1.0,
+			"b": 2.0,
+			"c": 3.0,
+		}
+		membersScores2 := map[string]float64{
+			"b": 1.0,
+			"c": 2.0,
+			"d": 3.0,
+		}
+
+		zAddResult1, err := client.ZAdd(key1, membersScores1)
+		assert.NoError(suite.T(), err)
+		assert.Equal(suite.T(), int64(3), zAddResult1)
+
+		zAddResult2, err := client.ZAdd(key2, membersScores2)
+		assert.NoError(suite.T(), err)
+		assert.Equal(suite.T(), int64(3), zAddResult2)
+
+		res, err := client.ZInterCard([]string{key1, key2})
+		assert.NoError(suite.T(), err)
+		assert.Equal(suite.T(), int64(2), res)
+
+		res, err = client.ZInterCard([]string{key1, key3})
+		assert.NoError(suite.T(), err)
+		assert.Equal(suite.T(), int64(0), res)
+
+		res, err = client.ZInterCardWithOptions([]string{key1, key2}, options.NewZInterCardOptions().SetLimit(0))
+		assert.NoError(suite.T(), err)
+		assert.Equal(suite.T(), int64(2), res)
+
+		res, err = client.ZInterCardWithOptions([]string{key1, key2}, options.NewZInterCardOptions().SetLimit(1))
+		assert.NoError(suite.T(), err)
+		assert.Equal(suite.T(), int64(1), res)
+
+		res, err = client.ZInterCardWithOptions([]string{key1, key2}, options.NewZInterCardOptions().SetLimit(3))
+		assert.NoError(suite.T(), err)
+		assert.Equal(suite.T(), int64(2), res)
+
+		// key exists but not a set
+		_, err = client.Set(key3, "bar")
+		assert.NoError(suite.T(), err)
+
+		_, err = client.ZInterCardWithOptions([]string{key1, key3}, options.NewZInterCardOptions().SetLimit(3))
+		assert.NotNil(suite.T(), err)
+		assert.IsType(suite.T(), &errors.RequestError{}, err)
+	})
+}