[Feature] support client_protocol_version (#553)

* feature: support client_protocol_version

* feature: support client_protocol_version

Author: ValManP

cache/key.go

@@ -20,6 +20,9 @@ type Key struct {
 	// AcceptEncoding must contain 'Accept-Encoding' request header value.
 	AcceptEncoding string
 
+	// ClientProtocolVersion must contain `client_protocol_version` query arg.
+	ClientProtocolVersion string
+
 	// DefaultFormat must contain `default_format` query arg.
 	DefaultFormat string
 
@@ -62,6 +65,7 @@ func NewKey(query []byte, originParams url.Values, acceptEncoding string, userPa
 	return &Key{
 		Query:                 query,
 		AcceptEncoding:        acceptEncoding,
+		ClientProtocolVersion: originParams.Get("client_protocol_version"),
 		DefaultFormat:         originParams.Get("default_format"),
 		Database:              originParams.Get("database"),
 		Compress:              originParams.Get("compress"),
@@ -83,8 +87,8 @@ func (k *Key) filePath(dir string) string {
 
 // String returns string representation of the key.
 func (k *Key) String() string {
-	s := fmt.Sprintf("V%d; Query=%q; AcceptEncoding=%q; DefaultFormat=%q; Database=%q; Compress=%q; EnableHTTPCompression=%q; Namespace=%q; MaxResultRows=%q; Extremes=%q; ResultOverflowMode=%q; UserParams=%d; QueryParams=%d; UserCredentialHash=%d",
-		k.Version, k.Query, k.AcceptEncoding, k.DefaultFormat, k.Database, k.Compress, k.EnableHTTPCompression, k.Namespace,
+	s := fmt.Sprintf("V%d; Query=%q; AcceptEncoding=%q; ClientProtocolVersion=%q; DefaultFormat=%q; Database=%q; Compress=%q; EnableHTTPCompression=%q; Namespace=%q; MaxResultRows=%q; Extremes=%q; ResultOverflowMode=%q; UserParams=%d; QueryParams=%d; UserCredentialHash=%d",
+		k.Version, k.Query, k.AcceptEncoding, k.ClientProtocolVersion, k.DefaultFormat, k.Database, k.Compress, k.EnableHTTPCompression, k.Namespace,
 		k.MaxResultRows, k.Extremes, k.ResultOverflowMode, k.UserParamsHash, k.QueryParamsHash, k.UserCredentialHash)
 	h := sha256.Sum256([]byte(s))
 

cache/key_test.go

@@ -15,15 +15,15 @@ func TestKeyString(t *testing.T) {
 				Query:   []byte("SELECT 1 FROM system.numbers LIMIT 10"),
 				Version: 2,
 			},
-			expected: "f11e8438adeeb325881c9a4da01925b3",
+			expected: "4e3e71f4d94f34b6c8cab4888486a116",
 		},
 		{
 			key: &Key{
 				Query:          []byte("SELECT 1 FROM system.numbers LIMIT 10"),
 				AcceptEncoding: "gzip",
 				Version:        2,
 			},
-			expected: "045cbb29a40a81c42378569cf0bc4078",
+			expected: "ba19aeff43f8cd4440a28f883201f342",
 		},
 		{
 			key: &Key{
@@ -32,7 +32,7 @@ func TestKeyString(t *testing.T) {
 				DefaultFormat:  "JSON",
 				Version:        2,
 			},
-			expected: "186386850c49c60a49dbf7af89c671c9",
+			expected: "341b43e5ce0ceafb3f49664d9b124618",
 		},
 		{
 			key: &Key{
@@ -42,7 +42,7 @@ func TestKeyString(t *testing.T) {
 				Database:       "foobar",
 				Version:        2,
 			},
-			expected: "68f3231d17cad0a3473e63f419e07580",
+			expected: "bd864dd1d3dfec711f15830a0601a11e",
 		},
 		{
 			key: &Key{
@@ -53,7 +53,7 @@ func TestKeyString(t *testing.T) {
 				Namespace:      "ns123",
 				Version:        2,
 			},
-			expected: "8f5e765e69df7c24a58f13cdf752ad2f",
+			expected: "04e932bafebeeb6b4c7c07288b37db3c",
 		},
 		{
 			key: &Key{
@@ -65,23 +65,23 @@ func TestKeyString(t *testing.T) {
 				Namespace:      "ns123",
 				Version:        2,
 			},
-			expected: "93a121f03f438ef7969540c78e943e2c",
+			expected: "2cd1c2db405f570c2eb61fd4a02b8f05",
 		},
 		{
 			key: &Key{
 				Query:           []byte("SELECT * FROM {table_name:Identifier} LIMIT 10"),
 				QueryParamsHash: 3825709,
 				Version:         3,
 			},
-			expected: "7edddc7d9db4bc4036dee36893f57cb1",
+			expected: "b39b64fc48f705017a4734e824c4e62a",
 		},
 		{
 			key: &Key{
 				Query:           []byte("SELECT * FROM {table_name:Identifier} LIMIT 10"),
 				QueryParamsHash: 3825710,
 				Version:         3,
 			},
-			expected: "68ba76fb53a6fa71ba8fe63dd34a2201",
+			expected: "925e7c71544fc398a97d8e49426d61e3",
 		},
 		{
 			key: &Key{
@@ -90,7 +90,18 @@ func TestKeyString(t *testing.T) {
 				Version:            3,
 				UserCredentialHash: 234324,
 			},
-			expected: "c5b58ecb4ff026e62ee846dc63c749d5",
+			expected: "12b86ad023144c27676195e0ebce7f22",
+		},
+		{
+			key: &Key{
+				Query:                 []byte("SELECT 1 FROM system.numbers LIMIT 10"),
+				AcceptEncoding:        "gzip",
+				ClientProtocolVersion: "54460",
+				DefaultFormat:         "JSON",
+				Database:              "foobar",
+				Version:               5,
+			},
+			expected: "63faa92cb204a36ded33036ca4d429d5",
 		},
 	}
 

scope.go

@@ -363,6 +363,7 @@ var allowedParams = []string{
 	"query",
 	"database",
 	"default_format",
+	"client_protocol_version",
 	// if `compress=1`, CH will compress the data it sends you
 	"compress",
 	// if `decompress=1` , CH will decompress the same data that you pass in the POST method