Uniformly use proxy to get the configuration of configcat (#16942)

* Uniformly use proxy to get the configuration of configcat

* Add configcat enabled in workspace info api

* enabled configcat in ide-service

Author: iQQBot

components/common-go/experiments/types.go

@@ -32,32 +32,43 @@ type Attributes struct {
 	VSCodeClientID string
 }
 
+type ClientOpt func(o *options)
+
+func WithGitpodProxy(gitpodHost string) ClientOpt {
+	return func(o *options) {
+		o.sdkKey = "gitpod"
+		o.baseURL = fmt.Sprintf("https://%s/configcat", gitpodHost)
+		o.pollInterval = 1 * time.Minute
+	}
+}
+
+type options struct {
+	pollInterval time.Duration
+	baseURL      string
+	sdkKey       string
+}
+
 // NewClient constructs a new experiments.Client. This is NOT A SINGLETON.
 // You should normally only call this once in the lifecycle of an application, clients are independent of each other will refresh flags on their own.
-// If the environment contains CONFIGCAT_SDK_KEY value, it vill be used to construct a ConfigCat client.
+// If the environment contains CONFIGCAT_SDK_KEY value, it will be used to construct a ConfigCat client.
 // Otherwise, it returns a client which always returns the default value. This client is used for Self-Hosted installations.
-func NewClient() Client {
-	// TODO: get rid fo GITPOD_HOST is implementaion detail of supervisor, it is a subject to change
-	// gitpodHost should be provided as an option instead
-	gitpodHost := os.Getenv("GITPOD_HOST")
-	if gitpodHost == "" {
-		gitpodHost = os.Getenv("HOST_URL")
+func NewClient(opts ...ClientOpt) Client {
+	opt := &options{
+		sdkKey:       os.Getenv("CONFIGCAT_SDK_KEY"),
+		baseURL:      os.Getenv("CONFIGCAT_BASE_URL"),
+		pollInterval: 3 * time.Minute,
 	}
-	if gitpodHost != "" {
-		return newConfigCatClient(configcat.Config{
-			SDKKey:       "gitpod",
-			BaseURL:      fmt.Sprintf("%s%s", gitpodHost, "/configcat"),
-			PollInterval: 1 * time.Minute,
-			HTTPTimeout:  3 * time.Second,
-		})
+	for _, o := range opts {
+		o(opt)
 	}
-	sdkKey := os.Getenv("CONFIGCAT_SDK_KEY")
-	if sdkKey == "" {
+
+	if opt.sdkKey == "" {
 		return NewAlwaysReturningDefaultValueClient()
 	}
 	return newConfigCatClient(configcat.Config{
-		SDKKey:       sdkKey,
-		PollInterval: 3 * time.Minute,
+		SDKKey:       opt.sdkKey,
+		BaseURL:      opt.baseURL,
+		PollInterval: opt.pollInterval,
 		HTTPTimeout:  3 * time.Second,
 		Logger:       &configCatLogger{log.Log},
 	})

components/gitpod-protocol/src/experiments/configcat-server.ts

@@ -35,6 +35,7 @@ export function getExperimentsClientForBackend(): Client {
         requestTimeoutMs: 2000,
         logger: configcat.createConsoleLogger(LogLevel.Error),
         maxInitWaitTimeSeconds: 0,
+        baseUrl: process.env.CONFIGCAT_BASE_URL,
     });
 
     client = new ConfigCatClient(configCatClient);

components/ide-service/pkg/server/server.go

@@ -254,6 +254,13 @@ func (s *IDEServiceServer) ResolveWorkspaceConfig(ctx context.Context, req *api.
 		IdeImageLayers:  defaultIde.ImageLayers,
 	}
 
+	if os.Getenv("CONFIGCAT_SDK_KEY") != "" {
+		resp.Envvars = append(resp.Envvars, &api.EnvironmentVariable{
+			Name:  "GITPOD_CONFIGCAT_ENABLED",
+			Value: "true",
+		})
+	}
+
 	var wsConfig *gitpodapi.GitpodConfig
 
 	if req.WorkspaceConfig != "" {

components/supervisor-api/go/info.pb.go

@@ -97,6 +97,9 @@ message WorkspaceInfoResponse {
 
     // debug_workspace_type indicates whether it is a regular or prebuild debug workspace
     DebugWorkspaceType debug_workspace_type = 17;
+
+    // configcat_enabled controls whether configcat is enabled
+    bool configcat_enabled = 18;
 }
 
 enum DebugWorkspaceType {

components/supervisor-api/info.proto

@@ -52,6 +52,7 @@ type ServiceConfig struct {
 	WorkspaceID       string
 	OwnerID           string
 	SupervisorVersion string
+	ConfigcatEnabled  bool
 }
 
 type Service struct {
@@ -109,11 +110,15 @@ func NewServerApiService(ctx context.Context, cfg *ServiceConfig, tknsrv api.Tok
 		return nil
 	}
 
+	opts := []experiments.ClientOpt{}
+	if cfg.ConfigcatEnabled {
+		opts = append(opts, experiments.WithGitpodProxy(cfg.Host))
+	}
 	service := &Service{
 		token:            tknres.Token,
 		gitpodService:    gitpodService,
 		cfg:              cfg,
-		experiments:      experiments.NewClient(),
+		experiments:      experiments.NewClient(opts...),
 		apiMetrics:       NewClientMetrics(),
 		onUsingPublicAPI: make(chan struct{}),
 		subs:             make(map[chan *gitpod.WorkspaceInstance]struct{}),

components/supervisor/pkg/serverapi/publicapi.go

@@ -298,6 +298,9 @@ type WorkspaceConfig struct {
 
 	// DebugWorkspaceContenSource indicates where the debug workspace content came from
 	DebugWorkspaceContenSource api.ContentSource `env:"SUPERVISOR_DEBUG_WORKSPACE_CONTENT_SOURCE"`
+
+	// ConfigcatEnabled controls whether configcat is enabled
+	ConfigcatEnabled bool `env:"GITPOD_CONFIGCAT_ENABLED"`
 }
 
 // WorkspaceGitpodToken is a list of tokens that should be added to supervisor's token service.

components/supervisor/pkg/supervisor/config.go

@@ -670,6 +670,7 @@ func (is *InfoService) WorkspaceInfo(context.Context, *api.WorkspaceInfoRequest)
 		WorkspaceClass:       &api.WorkspaceInfoResponse_WorkspaceClass{Id: is.cfg.WorkspaceClass},
 		OwnerId:              is.cfg.OwnerId,
 		DebugWorkspaceType:   is.cfg.DebugWorkspaceType,
+		ConfigcatEnabled:     is.cfg.ConfigcatEnabled,
 	}
 	if is.cfg.WorkspaceClassInfo != nil {
 		resp.WorkspaceClass.DisplayName = is.cfg.WorkspaceClassInfo.DisplayName

components/supervisor/pkg/supervisor/services.go

@@ -262,6 +262,7 @@ func Run(options ...RunOption) {
 			WorkspaceID:       cfg.WorkspaceID,
 			OwnerID:           cfg.OwnerId,
 			SupervisorVersion: Version,
+			ConfigcatEnabled:  cfg.ConfigcatEnabled,
 		}, tokenService)
 	}
 

components/supervisor/pkg/supervisor/supervisor.go

@@ -424,7 +424,11 @@ func ConfigcatEnv(ctx *RenderContext) []corev1.EnvVar {
 	return []corev1.EnvVar{
 		{
 			Name:  "CONFIGCAT_SDK_KEY",
-			Value: sdkKey,
+			Value: "gitpod",
+		},
+		{
+			Name:  "CONFIGCAT_BASE_URL",
+			Value: "https://" + ctx.Config.Domain + "/configcat",
 		},
 	}
 }