fix: make Platform configuration parameters optional (#204)

Author: agneum

cmd/database-lab/main.go

@@ -77,9 +77,9 @@ func main() {
 		log.Fatalf(err)
 	}
 
-	// Create a platform service to verify Platform tokens.
-	platformSvc := platform.New(cfg.Platform)
-	if err := platformSvc.Init(ctx); err != nil {
+	// Create a platform service to make requests to Platform.
+	platformSvc, err := platform.New(ctx, cfg.Platform)
+	if err != nil {
 		log.Fatalf(errors.WithMessage(err, "failed to create a new platform service"))
 	}
 
@@ -98,7 +98,7 @@ func main() {
 		for range c {
 			log.Msg("Reloading configuration")
 
-			if err := reloadConfig(instanceID, provisionSvc, retrievalSvc, cloningSvc, platformSvc, server); err != nil {
+			if err := reloadConfig(ctx, instanceID, provisionSvc, retrievalSvc, cloningSvc, platformSvc, server); err != nil {
 				log.Err("Failed to reload configuration", err)
 			}
 
@@ -130,8 +130,8 @@ func loadConfiguration(instanceID string) (*config.Config, error) {
 	return cfg, nil
 }
 
-func reloadConfig(instanceID string, provisionSvc provision.Provision, retrievalSvc *retrieval.Retrieval, cloningSvc cloning.Cloning,
-	platformSvc *platform.Service, server *srv.Server) error {
+func reloadConfig(ctx context.Context, instanceID string, provisionSvc provision.Provision, retrievalSvc *retrieval.Retrieval,
+	cloningSvc cloning.Cloning, platformSvc *platform.Service, server *srv.Server) error {
 	cfg, err := loadConfiguration(instanceID)
 	if err != nil {
 		return err
@@ -145,10 +145,15 @@ func reloadConfig(instanceID string, provisionSvc provision.Provision, retrieval
 		return err
 	}
 
+	newPlatformSvc, err := platform.New(ctx, cfg.Platform)
+	if err != nil {
+		return err
+	}
+
 	provisionSvc.Reload(cfg.Provision)
 	retrievalSvc.Reload(cfg)
 	cloningSvc.Reload(cfg.Cloning)
-	platformSvc.Reload(cfg.Platform)
+	platformSvc.Reload(newPlatformSvc)
 	server.Reload(cfg.Server)
 
 	return nil

pkg/client/platform/client.go

@@ -25,6 +25,9 @@ const (
 	accessToken = "Access-Token"
 )
 
+// ConfigValidationError represents a config validation error.
+type ConfigValidationError error
+
 // APIResponse represents common fields of an API response.
 type APIResponse struct {
 	Hint    string `json:"hint"`
@@ -72,7 +75,7 @@ func NewClient(platformCfg ClientConfig) (*Client, error) {
 
 func validateConfig(config ClientConfig) error {
 	if config.URL == "" || config.AccessToken == "" {
-		return errors.New("invalid config of Platform Client given: URL and AccessToken must not be empty")
+		return ConfigValidationError(errors.New("invalid config of Platform Client given: URL and AccessToken must not be empty"))
 	}
 
 	return nil

pkg/services/platform/platform.go

@@ -11,6 +11,7 @@ import (
 	"github.com/pkg/errors"
 
 	"gitlab.com/postgres-ai/database-lab/pkg/client/platform"
+	"gitlab.com/postgres-ai/database-lab/pkg/log"
 )
 
 // PersonalTokenVerifier declares an interface of a struct for Platform Personal Token verification.
@@ -34,45 +35,45 @@ type Service struct {
 }
 
 // New creates a new platform service.
-func New(cfg Config) *Service {
-	return &Service{
-		cfg: cfg,
-	}
-}
-
-// Reload reloads service configuration.
-func (s *Service) Reload(cfg Config) {
-	s.cfg = cfg
-}
+func New(ctx context.Context, cfg Config) (*Service, error) {
+	s := &Service{cfg: cfg}
 
-// Init initialize a Platform service instance.
-func (s *Service) Init(ctx context.Context) error {
 	client, err := platform.NewClient(platform.ClientConfig{
 		URL:         s.cfg.URL,
 		AccessToken: s.cfg.AccessToken,
 	})
 	if err != nil {
-		return errors.Wrap(err, "failed to create a new Platform Client")
+		if _, ok := err.(platform.ConfigValidationError); ok {
+			log.Msg("Warning: ", err)
+			return s, nil
+		}
+
+		return nil, errors.Wrap(err, "failed to create a new Platform Client")
 	}
 
 	s.Client = client
 
 	if !s.IsPersonalTokenEnabled() {
-		return nil
+		return s, nil
 	}
 
 	platformToken, err := client.CheckPlatformToken(ctx, platform.TokenCheckRequest{Token: s.cfg.AccessToken})
 	if err != nil {
-		return err
+		return nil, err
 	}
 
 	if platformToken.OrganizationID == 0 {
-		return errors.New("invalid organization ID associated with the given Platform Access Token")
+		return nil, errors.New("invalid organization ID associated with the given Platform Access Token")
 	}
 
 	s.organizationID = platformToken.OrganizationID
 
-	return nil
+	return s, nil
+}
+
+// Reload reloads service configuration.
+func (s *Service) Reload(newService *Service) {
+	*s = *newService
 }
 
 // IsAllowedToken checks if the Platform Personal Token is allowed.

pkg/srv/middlewares.go

@@ -49,7 +49,8 @@ func (a *authMW) isAccessAllowed(ctx context.Context, token string) bool {
 		return true
 	}
 
-	if a.personalTokenVerifier.IsPersonalTokenEnabled() && a.personalTokenVerifier.IsAllowedToken(ctx, token) {
+	if a.personalTokenVerifier != nil && a.personalTokenVerifier.IsPersonalTokenEnabled() &&
+		a.personalTokenVerifier.IsAllowedToken(ctx, token) {
 		return true
 	}
 

pkg/srv/routes.go

@@ -156,10 +156,14 @@ func (s *Server) resetClone(w http.ResponseWriter, r *http.Request) {
 }
 
 func (s *Server) startObservation(w http.ResponseWriter, r *http.Request) {
+	if s.Platform.Client == nil {
+		sendBadRequestError(w, r, "cannot start the session observation because a Platform client is not configured")
+		return
+	}
+
 	var observationRequest *types.StartObservationRequest
 	if err := readJSON(r, &observationRequest); err != nil {
 		sendBadRequestError(w, r, err.Error())
-
 		return
 	}
 
@@ -207,6 +211,11 @@ func (s *Server) startObservation(w http.ResponseWriter, r *http.Request) {
 }
 
 func (s *Server) stopObservation(w http.ResponseWriter, r *http.Request) {
+	if s.Platform.Client == nil {
+		sendBadRequestError(w, r, "cannot stop the session observation because a Platform client is not configured")
+		return
+	}
+
 	var observationRequest *types.StopObservationRequest
 
 	if err := readJSON(r, &observationRequest); err != nil {