close tikv#4490: add comment

Signed-off-by: Cabinfever_B <cabinfeveroier@gmail.com>
CabinfeverB · Dec 28, 2021 · 86e5617 · 86e5617
1 parent a4fb71a
commit 86e5617
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 4 deletions.
diff --git a/pkg/apiutil/apiutil.go b/pkg/apiutil/apiutil.go
@@ -145,13 +145,14 @@ func GetComponentNameOnHTTP(r *http.Request) string {
 	return componentName
 }
 
-type UserSignatureRoundTripper struct {
+// ComponentSignatureRoundTripper is used to add component signature in HTTP header
+type ComponentSignatureRoundTripper struct {
 	Proxied   http.RoundTripper
 	Component string
 }
 
 // RoundTrip is used to implement RoundTripper
-func (rt *UserSignatureRoundTripper) RoundTrip(req *http.Request) (resp *http.Response, err error) {
+func (rt *ComponentSignatureRoundTripper) RoundTrip(req *http.Request) (resp *http.Response, err error) {
 	req.Header.Add(ComponentSignatureKey, rt.Component)
 	// Send the request, get the response and the error
 	resp, err = rt.Proxied.RoundTrip(req)

diff --git a/tools/pd-ctl/pdctl/command/global.go b/tools/pd-ctl/pdctl/command/global.go
@@ -31,7 +31,7 @@ import (
 
 var (
 	dialClient = &http.Client{
-		Transport: &apiutil.UserSignatureRoundTripper{
+		Transport: &apiutil.ComponentSignatureRoundTripper{
 			Component: "pdctl",
 			Proxied:   http.DefaultTransport,
 		},
@@ -52,7 +52,7 @@ func InitHTTPSClient(caPath, certPath, keyPath string) error {
 	}
 
 	dialClient = &http.Client{
-		Transport: &apiutil.UserSignatureRoundTripper{
+		Transport: &apiutil.ComponentSignatureRoundTripper{
 			Component: "pdctl",
 			Proxied: &http.Transport{
 				TLSClientConfig: tlsConfig},