feat: allow to toggle off v1 services (#770)

Details:

* add `revproxy.enableV1Services` and `login.enableV1Services` configuration fields
* when v1 services are not active:
    * do not serve `/api`, `/api/direct`, etc. -> GitLab
    * do not serve `/api/kg`, etc. -> KG, webhook
    * do not serve `/ui-server/*` routes related to v1 features
    * do not login though GitLab
    * do not logout from GitLab
 * also, remove routes to `/api/search` (service is not deployed anymore)

Author: leafty

internal/config/config.yaml

@@ -23,6 +23,7 @@ sessions:
       audience: renku
       authorizedParty: renku-cli
 revproxy:
+  enableV1Services: true
   renkuBaseUrl: "https://renkulab.io"
   externalGitlabUrl:
   k8sNamespace:
@@ -39,6 +40,7 @@ revproxy:
     keycloak:
     search:
 login:
+  enableV1Services: true
   endpointsBasePath:
   renkuBaseURL: "https://renkulab.io"
   tokenEncryption:

internal/config/login.go

@@ -11,6 +11,7 @@ type TokenEncryptionConfig struct {
 }
 
 type LoginConfig struct {
+	EnableV1Services            bool
 	RenkuBaseURL                *url.URL
 	LoginRoutesBasePath         string
 	TokenEncryption             TokenEncryptionConfig
@@ -34,6 +35,10 @@ type OIDCClient struct {
 }
 
 func (c LoginConfig) Validate(e RunningEnvironment) error {
+	// Fix the login config when EnableV1Services is false
+	if !c.EnableV1Services {
+		delete(c.Providers, "gitlab")
+	}
 	if c.TokenEncryption.Enabled && len(c.TokenEncryption.SecretKey) != 32 {
 		return fmt.Errorf(
 			"token encryption key has to be 32 bytes long, the provided one is %d long",

internal/config/revproxy.go

@@ -12,10 +12,10 @@ type RenkuServicesConfig struct {
 	DataService *url.URL
 	Keycloak    *url.URL
 	UIServer    *url.URL
-	Search      *url.URL
 }
 
 type RevproxyConfig struct {
+	EnableV1Services  bool
 	RenkuBaseURL      *url.URL
 	ExternalGitlabURL *url.URL
 	K8sNamespace      string
@@ -29,12 +29,7 @@ type CoreSvcConfig struct {
 }
 
 func (r *RevproxyConfig) Validate() error {
-	if r.RenkuServices.KG == nil {
-		return fmt.Errorf("the proxy config is missing the url to the knowledge graph service")
-	}
-	if r.RenkuServices.Webhook == nil {
-		return fmt.Errorf("the proxy config is missing the url to the webhook service")
-	}
+	// Check v2 services first
 	if r.RenkuServices.DataService == nil {
 		return fmt.Errorf("the proxy config is missing the url to the data service")
 	}
@@ -44,11 +39,19 @@ func (r *RevproxyConfig) Validate() error {
 	if r.RenkuServices.UIServer == nil {
 		return fmt.Errorf("the proxy config is missing the url to ui-server")
 	}
-	if r.RenkuServices.Search == nil {
-		return fmt.Errorf("the proxy config is missing the url to search")
-	}
-	if len(r.RenkuServices.Core.ServiceNames) != len(r.RenkuServices.Core.ServicePaths) {
-		return fmt.Errorf("the number of core service names and paths do not match")
+
+	// Check v1 services if needed
+	if r.EnableV1Services {
+		if r.RenkuServices.KG == nil {
+			return fmt.Errorf("the proxy config is missing the url to the knowledge graph service")
+		}
+		if r.RenkuServices.Webhook == nil {
+			return fmt.Errorf("the proxy config is missing the url to the webhook service")
+		}
+		if len(r.RenkuServices.Core.ServiceNames) != len(r.RenkuServices.Core.ServicePaths) {
+			return fmt.Errorf("the number of core service names and paths do not match")
+		}
 	}
+
 	return nil
 }

internal/config/revproxy_test.go

@@ -15,6 +15,7 @@ func getValidRevproxyConfig(t *testing.T) RevproxyConfig {
 	require.NoError(t, err)
 	renkuServicesConfig := getValidRenkuServicesConfig(t)
 	return RevproxyConfig{
+		EnableV1Services:  true,
 		RenkuBaseURL:      renkuBaseURL,
 		ExternalGitlabURL: externalGitlabURL,
 		RenkuServices:     renkuServicesConfig,
@@ -32,15 +33,37 @@ func getValidRenkuServicesConfig(t *testing.T) RenkuServicesConfig {
 	require.NoError(t, err)
 	uiServerURL, err := url.Parse("http://ui")
 	require.NoError(t, err)
-	searchURL, err := url.Parse("http://ui")
-	require.NoError(t, err)
 	return RenkuServicesConfig{
 		KG:          kgURL,
 		Webhook:     webhookURL,
 		DataService: dataServiceURL,
 		Keycloak:    keycloakURL,
 		UIServer:    uiServerURL,
-		Search:      searchURL,
+	}
+}
+
+func getValidV2OnlyRevproxyConfig(t *testing.T) RevproxyConfig {
+	renkuBaseURL, err := url.Parse("https://renku.example.org")
+	require.NoError(t, err)
+	renkuServicesConfig := getValidV2OnlyRenkuServicesConfig(t)
+	return RevproxyConfig{
+		EnableV1Services: false,
+		RenkuBaseURL:     renkuBaseURL,
+		RenkuServices:    renkuServicesConfig,
+	}
+}
+
+func getValidV2OnlyRenkuServicesConfig(t *testing.T) RenkuServicesConfig {
+	dataServiceURL, err := url.Parse("http://data-service")
+	require.NoError(t, err)
+	keycloakURL, err := url.Parse("http://keycloak")
+	require.NoError(t, err)
+	uiServerURL, err := url.Parse("http://ui")
+	require.NoError(t, err)
+	return RenkuServicesConfig{
+		DataService: dataServiceURL,
+		Keycloak:    keycloakURL,
+		UIServer:    uiServerURL,
 	}
 }
 
@@ -52,6 +75,21 @@ func TestValidRevproxyConfig(t *testing.T) {
 	assert.NoError(t, err)
 }
 
+func TestValidV2OnlyRevproxyConfig(t *testing.T) {
+	config := getValidV2OnlyRevproxyConfig(t)
+
+	err := config.Validate()
+
+	// Check that the v1 service configuration is not provided
+	assert.Nil(t, config.ExternalGitlabURL)
+	assert.Empty(t, config.RenkuServices.Core.ServiceNames)
+	assert.Empty(t, config.RenkuServices.Core.ServicePaths)
+	assert.Nil(t, config.RenkuServices.KG)
+	assert.Nil(t, config.RenkuServices.Webhook)
+
+	assert.NoError(t, err)
+}
+
 func TestInvalidKGURL(t *testing.T) {
 	config := getValidRevproxyConfig(t)
 	config.RenkuServices.KG = nil
@@ -97,15 +135,6 @@ func TestInvalidUIServerURL(t *testing.T) {
 	assert.ErrorContains(t, err, "the proxy config is missing the url to ui-server")
 }
 
-func TestInvalidSearchURL(t *testing.T) {
-	config := getValidRevproxyConfig(t)
-	config.RenkuServices.Search = nil
-
-	err := config.Validate()
-
-	assert.ErrorContains(t, err, "the proxy config is missing the url to search")
-}
-
 func TestInvalidCoreSvcConfig(t *testing.T) {
 	config := getValidRevproxyConfig(t)
 	config.RenkuServices.Core.ServiceNames = []string{"core-svc"}

internal/login/login_server_constants.go

@@ -1,3 +1,4 @@
 package login
 
 var defaultLoginSequence = [...]string{"renku", "gitlab"}
+var v2OnlyLoginSequence = [...]string{"renku"}

internal/login/login_server_routes.go

@@ -30,7 +30,7 @@ func (l *LoginServer) GetLogin(c echo.Context, params GetLoginParams) error {
 	if params.ProviderId != nil && len(*params.ProviderId) > 0 {
 		loginSequence = *params.ProviderId
 	} else {
-		loginSequence = defaultLoginSequence[:]
+		loginSequence = l.getLoginSequence()
 	}
 	session.LoginSequence = loginSequence
 	return l.nextAuthStep(c, session)
@@ -242,3 +242,11 @@ func (l *LoginServer) nextAuthStep(
 	l.sessions.Save(c)
 	return echo.WrapHandler(handler)(c)
 }
+
+func (l *LoginServer) getLoginSequence() (loginSequence []string) {
+	if l.config.EnableV1Services {
+		return defaultLoginSequence[:]
+	} else {
+		return v2OnlyLoginSequence[:]
+	}
+}

internal/login/login_server_routes_test.go

@@ -45,8 +45,18 @@ func getTestConfig(loginServerPort int, authServers ...testAuthServer) (config.L
 	if err != nil {
 		return config.LoginConfig{}, err
 	}
+
+	// Toggle `EnableV1Services` on if we authenticate with GitLab
+	enableV1Services := false
+	for _, auth := range authServers {
+		if auth.ClientID == "gitlab" {
+			enableV1Services = true
+		}
+	}
+
 	testConfig := config.LoginConfig{
-		RenkuBaseURL: renkuBaseURL,
+		EnableV1Services: enableV1Services,
+		RenkuBaseURL:     renkuBaseURL,
 		TokenEncryption: config.TokenEncryptionConfig{
 			Enabled:   true,
 			SecretKey: "1b195c6329ba7df1c1adf6975c71910d",