[ide] add user-agent header to ws connection to server

Author: iQQBot

components/gitpod-protocol/go/gitpod-service.go

@@ -218,6 +218,7 @@ type ConnectToServerOpts struct {
 	Log                 *logrus.Entry
 	ReconnectionHandler func()
 	CloseHandler        func(error)
+	ExtraHeaders        map[string]string
 }
 
 // ConnectToServer establishes a new websocket connection to the server
@@ -241,6 +242,9 @@ func ConnectToServer(endpoint string, opts ConnectToServerOpts) (*APIoverJSONRPC
 
 	reqHeader := http.Header{}
 	reqHeader.Set("Origin", origin)
+	for k, v := range opts.ExtraHeaders {
+		reqHeader.Set(k, v)
+	}
 	if opts.Token != "" {
 		reqHeader.Set("Authorization", "Bearer "+opts.Token)
 	}

components/local-app/main.go

@@ -261,6 +261,10 @@ func tryConnectToServer(gitpodUrl string, tkn string, reconnectionHandler func()
 		Log:                 logrus.NewEntry(logrus.StandardLogger()),
 		ReconnectionHandler: reconnectionHandler,
 		CloseHandler:        closeHandler,
+		ExtraHeaders: map[string]string{
+			"User-Agent":       "gitpod/local-companion",
+			"X-Client-Version": Version,
+		},
 	})
 	if err != nil {
 		return nil, err

components/server/src/websocket/websocket-connection-manager.ts

@@ -30,7 +30,7 @@ const EVENT_CLIENT_CONTEXT_CREATED = "EVENT_CLIENT_CONTEXT_CREATED";
 const EVENT_CLIENT_CONTEXT_CLOSED = "EVENT_CLIENT_CONTEXT_CLOSED";
 
 /** TODO(gpl) Refine this list */
-export type WebsocketClientType = "browser" | "go-client" | "vs-code";
+export type WebsocketClientType = "browser" | "go-client" | "vs-code" | "supervisor" | "local-companion";
 namespace WebsocketClientType {
     export function getClientType(req: express.Request): WebsocketClientType | undefined {
         const userAgent = req.headers["user-agent"];
@@ -47,7 +47,13 @@ namespace WebsocketClientType {
         if (userAgent.startsWith("VS Code")) {
             return "vs-code";
         }
-        log.debug("API client without 'User-Agent'", { headers: req.headers });
+        if (userAgent.startsWith("gitpod/supervisor")) {
+            return "supervisor";
+        }
+        if (userAgent.startsWith("gitpod/local-companion")) {
+            return "local-companion";
+        }
+        log.debug("API client with unknown 'User-Agent'", userAgent);
         return undefined;
     }
 }

components/supervisor/cmd/run.go

@@ -19,6 +19,7 @@ var runCmd = &cobra.Command{
 	Run: func(cmd *cobra.Command, args []string) {
 		log.Init(ServiceName, Version, true, false)
 		common_grpc.SetupLogging()
+		supervisor.Version = Version
 		supervisor.Run()
 	},
 }

components/supervisor/pkg/supervisor/supervisor.go

@@ -65,6 +65,7 @@ const (
 var (
 	additionalServices []RegisterableService
 	apiEndpointOpts    []grpc.ServerOption
+	Version            = ""
 )
 
 // RegisterAdditionalService registers additional services for the API endpoint
@@ -387,6 +388,11 @@ func createGitpodService(cfg *Config, tknsrv api.TokenServiceServer) *gitpod.API
 	gitpodService, err := gitpod.ConnectToServer(endpoint, gitpod.ConnectToServerOpts{
 		Token: tknres.Token,
 		Log:   log.Log,
+		ExtraHeaders: map[string]string{
+			"User-Agent":              "gitpod/supervisor",
+			"X-Workspace-Instance-Id": cfg.WorkspaceInstanceID,
+			"X-Client-Version":        Version,
+		},
 	})
 	if err != nil {
 		log.WithError(err).Error("cannot connect to Gitpod API")