Merge pull request valkey-io#3077 from EdricCua/Go-Implement-ClientId

Go: Implement ClientId

Author: niharikabhavaraju

CHANGELOG.md

@@ -28,6 +28,7 @@
 * Go/Core: Move FFI to a dedicated folder for reusability ([#3372](https://github.com/valkey-io/valkey-glide/pull/3372))
 * Go: Add `GeoPos` ([#3409](https://github.com/valkey-io/valkey-glide/pull/3409))
 * Go: Add `GeoDist` ([#3446](https://github.com/valkey-io/valkey-glide/pull/3446))
+* Go: Add `ClientId` ([#3077](https://github.com/valkey-io/valkey-glide/pull/3077))
 
 #### Breaking Changes
 

go/api/connection_management_cluster_commands.go

@@ -17,4 +17,8 @@ type ConnectionManagementClusterCommands interface {
 	Echo(message string) (Result[string], error)
 
 	EchoWithOptions(echoOptions options.ClusterEchoOptions) (ClusterValue[string], error)
+
+	ClientId() (ClusterValue[int64], error)
+
+	ClientIdWithOptions(routeOptions options.RouteOption) (ClusterValue[int64], error)
 }

go/api/connection_management_cluster_commands_test.go

@@ -63,3 +63,28 @@ func ExampleGlideClusterClient_EchoWithOptions() {
 
 	// Output: Hello World
 }
+
+func ExampleGlideClusterClient_ClientId() {
+	var client *GlideClusterClient = getExampleGlideClusterClient() // example helper function
+	result, err := client.ClientId()
+	if err != nil {
+		fmt.Println("Glide example failed with an error: ", err)
+	}
+	assert := result.IsSingleValue()
+	fmt.Println(assert)
+
+	// Output: true
+}
+
+func ExampleGlideClusterClient_ClientIdWithOptions() {
+	var client *GlideClusterClient = getExampleGlideClusterClient() // example helper function
+	opts := options.RouteOption{Route: nil}
+	result, err := client.ClientIdWithOptions(opts)
+	if err != nil {
+		fmt.Println("Glide example failed with an error: ", err)
+	}
+	assert := result.IsSingleValue()
+	fmt.Println(assert)
+
+	// Output: true
+}

go/api/connection_management_commands.go

@@ -15,4 +15,6 @@ type ConnectionManagementCommands interface {
 	PingWithOptions(pingOptions options.PingOptions) (string, error)
 
 	Echo(message string) (Result[string], error)
+
+	ClientId() (int64, error)
 }

go/api/connection_management_commands_test.go

@@ -41,3 +41,15 @@ func ExampleGlideClient_Echo() {
 
 	// Output: {Hello World false}
 }
+
+func ExampleGlideClient_ClientId() {
+	var client *GlideClient = getExampleGlideClient() // example helper function
+	result, err := client.ClientId()
+	if err != nil {
+		fmt.Println("Glide example failed with an error: ", err)
+	}
+	assert := result > 0
+	fmt.Println(assert)
+
+	// Output: true
+}

go/api/glide_client.go

@@ -352,3 +352,18 @@ func (client *baseClient) LolwutWithOptions(opts options.LolwutOptions) (string,
 	}
 	return handleStringResponse(result)
 }
+
+// Gets the current connection id.
+//
+// Return value:
+//
+//	The id of the client.
+//
+// [valkey.io]: https://valkey.io/commands/client-id/
+func (client *GlideClient) ClientId() (int64, error) {
+	result, err := client.executeCommand(C.ClientId, []string{})
+	if err != nil {
+		return defaultIntResponse, err
+	}
+	return handleIntResponse(result)
+}

go/api/glide_cluster_client.go

@@ -609,3 +609,54 @@ func (client *GlideClusterClient) LolwutWithOptions(lolwutOptions options.Cluste
 	}
 	return createClusterSingleValue[string](data), nil
 }
+
+// Gets the current connection id.
+//
+// Return value:
+//
+//	The id of the client.
+//
+// [valkey.io]: https://valkey.io/commands/client-id/
+func (client *GlideClusterClient) ClientId() (ClusterValue[int64], error) {
+	response, err := client.executeCommand(C.ClientId, []string{})
+	if err != nil {
+		return createEmptyClusterValue[int64](), err
+	}
+	data, err := handleIntResponse(response)
+	if err != nil {
+		return createEmptyClusterValue[int64](), err
+	}
+	return createClusterSingleValue[int64](data), nil
+}
+
+// Gets the current connection id.
+//
+// Parameters:
+//
+//	opts - Specifies the routing configuration for the command. The client will route the
+//	        command to the nodes defined by route.
+//
+// Return value:
+//
+//	The id of the client.
+//
+// [valkey.io]: https://valkey.io/commands/client-id/
+func (client *GlideClusterClient) ClientIdWithOptions(opts options.RouteOption) (ClusterValue[int64], error) {
+	response, err := client.executeCommandWithRoute(C.ClientId, []string{}, opts.Route)
+	if err != nil {
+		return createEmptyClusterValue[int64](), err
+	}
+	if opts.Route != nil &&
+		(opts.Route).IsMultiNode() {
+		data, err := handleStringIntMapResponse(response)
+		if err != nil {
+			return createEmptyClusterValue[int64](), err
+		}
+		return createClusterMultiValue[int64](data), nil
+	}
+	data, err := handleIntResponse(response)
+	if err != nil {
+		return createEmptyClusterValue[int64](), err
+	}
+	return createClusterSingleValue[int64](data), nil
+}

go/api/response_handlers.go

@@ -1361,3 +1361,30 @@ func handleTimeClusterResponse(response *C.struct_CommandResponse) (ClusterValue
 	}
 	return createClusterSingleValue(data), nil
 }
+
+func handleStringIntMapResponse(response *C.struct_CommandResponse) (map[string]int64, error) {
+	defer C.free_command_response(response)
+
+	typeErr := checkResponseType(response, C.Map, false)
+	if typeErr != nil {
+		return nil, typeErr
+	}
+
+	data, err := parseMap(response)
+	if err != nil {
+		return nil, err
+	}
+	aMap := data.(map[string]interface{})
+
+	converted, err := mapConverter[int64]{
+		nil, false,
+	}.convert(aMap)
+	if err != nil {
+		return nil, err
+	}
+	result, ok := converted.(map[string]int64)
+	if !ok {
+		return nil, &errors.RequestError{Msg: fmt.Sprintf("unexpected type of map: %T", converted)}
+	}
+	return result, nil
+}

go/integTest/cluster_commands_test.go

@@ -1163,3 +1163,36 @@ func (suite *GlideTestSuite) TestLolwutWithOptions_WithRandomRoute() {
 	singleValue := result.SingleValue()
 	assert.Contains(suite.T(), singleValue, "Redis ver.")
 }
+
+func (suite *GlideTestSuite) TestClientIdCluster() {
+	client := suite.defaultClusterClient()
+	t := suite.T()
+	response, err := client.ClientId()
+	assert.NoError(t, err)
+	assert.True(t, response.IsSingleValue())
+}
+
+func (suite *GlideTestSuite) TestClientIdWithOptionsCluster() {
+	client := suite.defaultClusterClient()
+	t := suite.T()
+
+	// ClientId with option or with multiple options without route
+	opts := options.RouteOption{Route: nil}
+	response, err := client.ClientIdWithOptions(opts)
+	assert.NoError(t, err)
+	assert.True(t, response.IsSingleValue())
+
+	// same sections with random route
+	route := config.Route(config.RandomRoute)
+	opts = options.RouteOption{Route: route}
+	response, err = client.ClientIdWithOptions(opts)
+	assert.NoError(t, err)
+	assert.True(t, response.IsSingleValue())
+
+	// default sections, multi node route
+	route = config.Route(config.AllPrimaries)
+	opts = options.RouteOption{Route: route}
+	response, err = client.ClientIdWithOptions(opts)
+	assert.NoError(t, err)
+	assert.True(t, response.IsMultiValue())
+}

go/integTest/standalone_commands_test.go

@@ -813,3 +813,10 @@ func (suite *GlideTestSuite) TestLolwutWithOptions_EmptyArgs() {
 	assert.NoError(suite.T(), err)
 	assert.Contains(suite.T(), res, "Redis ver.")
 }
+
+func (suite *GlideTestSuite) TestClientId() {
+	client := suite.defaultClient()
+	result, err := client.ClientId()
+	assert.Nil(suite.T(), err)
+	assert.Greater(suite.T(), result, int64(0))
+}