fix(bff): remove kubeflow-userid requirement from health check endpoint (kubeflow#898)

Signed-off-by: Christian Vogt <cvogt@redhat.com>

Author: christianvogt

clients/ui/README.md

@@ -27,7 +27,7 @@ To run the a mocked dev environment you can either:
 
 ### Kubernetes Deployment
 
-For a in-depth guide on how to deploy the Model Registry UI, please refer to the [local kubernetes deployment](./bff/docs/dev-guide.md) documentation.
+For a in-depth guide on how to deploy the Model Registry UI, please refer to the [local kubernetes deployment](./bff/docs/local-development-guide.md) documentation.
 
 To quickly enable the Model Registry UI in your Kind cluster, you can use the following command:
 

clients/ui/api/openapi/mod-arch.yaml

@@ -10,7 +10,7 @@ servers:
   - url: "https://localhost:8080"
   - url: "http://localhost:8080"
 paths:
-  /api/v1/healthcheck:
+  /healthcheck:
     summary: Path targeted for healthcheck purposes.
     description: >-
       The REST endpoint/path used to allow a healthcheck update.

clients/ui/bff/internal/api/app.go

@@ -27,7 +27,7 @@ const (
 	ModelVersionId                = "model_version_id"
 	ModelArtifactId               = "model_artifact_id"
 	ArtifactId                    = "artifact_id"
-	HealthCheckPath               = ApiPathPrefix + "/healthcheck"
+	HealthCheckPath               = "/healthcheck"
 	UserPath                      = ApiPathPrefix + "/user"
 	ModelRegistryListPath         = ApiPathPrefix + "/model_registry"
 	ModelRegistryPath             = ModelRegistryListPath + "/:" + ModelRegistryId
@@ -106,7 +106,6 @@ func (app *App) Routes() http.Handler {
 
 	// HTTP client routes (requests that we forward to Model Registry API)
 	// on those, we perform SAR on Specific Service on a given namespace
-	apiRouter.GET(HealthCheckPath, app.HealthcheckHandler)
 	apiRouter.GET(RegisteredModelListPath, app.AttachNamespace(app.PerformSARonSpecificService(app.AttachRESTClient(app.GetAllRegisteredModelsHandler))))
 	apiRouter.GET(RegisteredModelPath, app.AttachNamespace(app.PerformSARonSpecificService(app.AttachRESTClient(app.GetRegisteredModelHandler))))
 	apiRouter.POST(RegisteredModelListPath, app.AttachNamespace(app.PerformSARonSpecificService(app.AttachRESTClient(app.CreateRegisteredModelHandler))))
@@ -162,5 +161,16 @@ func (app *App) Routes() http.Handler {
 		http.ServeFile(w, r, path.Join(app.config.StaticAssetsDir, "index.html"))
 	})
 
-	return app.RecoverPanic(app.EnableTelemetry(app.EnableCORS(app.InjectUserHeaders(appMux))))
+	// Create a mux for the healthcheck endpoint
+	healthcheckMux := http.NewServeMux()
+	healthcheckRouter := httprouter.New()
+	healthcheckRouter.GET(HealthCheckPath, app.HealthcheckHandler)
+	healthcheckMux.Handle(HealthCheckPath, app.RecoverPanic(app.EnableTelemetry(healthcheckRouter)))
+
+	// Combines the healthcheck endpoint with the rest of the routes
+	combinedMux := http.NewServeMux()
+	combinedMux.Handle(HealthCheckPath, healthcheckMux)
+	combinedMux.Handle("/", app.RecoverPanic(app.EnableTelemetry(app.EnableCORS(app.InjectUserHeaders(appMux)))))
+
+	return combinedMux
 }

clients/ui/bff/internal/api/healthcheck__handler_test.go

@@ -1,22 +1,20 @@
 package api
 
 import (
-	"context"
 	"encoding/json"
+	"io"
+	"net/http"
+	"net/http/httptest"
+	"testing"
+
 	"github.com/kubeflow/model-registry/ui/bff/internal/config"
-	"github.com/kubeflow/model-registry/ui/bff/internal/constants"
 	"github.com/kubeflow/model-registry/ui/bff/internal/mocks"
 	"github.com/kubeflow/model-registry/ui/bff/internal/models"
 	"github.com/kubeflow/model-registry/ui/bff/internal/repositories"
 	"github.com/stretchr/testify/assert"
-	"io"
-	"net/http"
-	"net/http/httptest"
-	"testing"
 )
 
 func TestHealthCheckHandler(t *testing.T) {
-
 	mockMRClient, _ := mocks.NewModelRegistryClient(nil)
 
 	app := App{config: config.EnvConfig{
@@ -27,14 +25,11 @@ func TestHealthCheckHandler(t *testing.T) {
 
 	rr := httptest.NewRecorder()
 	req, err := http.NewRequest(http.MethodGet, HealthCheckPath, nil)
-	ctx := context.WithValue(req.Context(), constants.KubeflowUserIdKey, mocks.KubeflowUserIDHeaderValue)
-	req = req.WithContext(ctx)
 	assert.NoError(t, err)
 
 	app.HealthcheckHandler(rr, req, nil)
 
 	rs := rr.Result()
-
 	defer rs.Body.Close()
 
 	body, err := io.ReadAll(rs.Body)
@@ -51,7 +46,6 @@ func TestHealthCheckHandler(t *testing.T) {
 		SystemInfo: models.SystemInfo{
 			Version: Version,
 		},
-		UserID: mocks.KubeflowUserIDHeaderValue,
 	}
 
 	assert.Equal(t, expected, healthCheckRes)

clients/ui/bff/internal/api/healthcheck_handler.go

@@ -1,30 +1,20 @@
 package api
 
 import (
-	"errors"
-	"github.com/julienschmidt/httprouter"
-	"github.com/kubeflow/model-registry/ui/bff/internal/constants"
 	"net/http"
+
+	"github.com/julienschmidt/httprouter"
 )
 
 func (app *App) HealthcheckHandler(w http.ResponseWriter, r *http.Request, ps httprouter.Params) {
-
-	userId, ok := r.Context().Value(constants.KubeflowUserIdKey).(string)
-	if !ok || userId == "" {
-		app.serverErrorResponse(w, r, errors.New("failed to retrieve kubeflow-userid from context"))
-		return
-	}
-
-	healthCheck, err := app.repositories.HealthCheck.HealthCheck(Version, userId)
+	healthCheck, err := app.repositories.HealthCheck.HealthCheck(Version)
 	if err != nil {
 		app.serverErrorResponse(w, r, err)
 		return
 	}
 
 	err = app.WriteJSON(w, http.StatusOK, healthCheck, nil)
-
 	if err != nil {
 		app.serverErrorResponse(w, r, err)
 	}
-
 }

clients/ui/bff/internal/models/health_check.go

@@ -7,5 +7,4 @@ type SystemInfo struct {
 type HealthCheckModel struct {
 	Status     string     `json:"status"`
 	SystemInfo SystemInfo `json:"system_info"`
-	UserID     string     `json:"userId"`
 }

clients/ui/bff/internal/repositories/health_check.go

@@ -8,14 +8,12 @@ func NewHealthCheckRepository() *HealthCheckRepository {
 	return &HealthCheckRepository{}
 }
 
-func (r *HealthCheckRepository) HealthCheck(version string, userID string) (models.HealthCheckModel, error) {
-
+func (r *HealthCheckRepository) HealthCheck(version string) (models.HealthCheckModel, error) {
 	var res = models.HealthCheckModel{
 		Status: "available",
 		SystemInfo: models.SystemInfo{
 			Version: version,
 		},
-		UserID: userID,
 	}
 
 	return res, nil

clients/ui/docs/local-deployment-guide-ui.md

@@ -43,7 +43,7 @@ First you need to set up your new image
 
 ```shell
 cd manifests/kustomize/options/ui/base
-kustomize edit set image model-registry-ui-image=${IMG_UI_STANDALONE}
+kustomize edit set image model-registry-ui=${IMG_UI_STANDALONE}
 ```
 
 Now you can set the namespace to kubeflow and apply the manifests:

clients/ui/scripts/deploy_kind_cluster.sh

@@ -5,7 +5,7 @@ command -v docker >/dev/null 2>&1 || { echo >&2 "Docker is required but it's not
 command -v kubectl >/dev/null 2>&1 || { echo >&2 "kubectl is required but it's not installed. Aborting."; exit 1; }
 command -v kind >/dev/null 2>&1 || { echo >&2 "kind is required but it's not installed. Aborting."; exit 1; }
 
-echo "WARNING: You must have proper push / pull access to ${IMG_UI_STANDALONE}". If this is a new image, make sure you set it to public to avoid issues."
+echo "WARNING: You must have proper push / pull access to ${IMG_UI_STANDALONE}. If this is a new image, make sure you set it to public to avoid issues."
 
 if kubectl get deployment model-registry-deployment -n kubeflow >/dev/null 2>&1; then
   echo "Model Registry deployment already exists. Skipping to step 4."
@@ -42,7 +42,7 @@ make docker-push-standalone
 
 echo "Editing kustomize image..."
 pushd  ../../manifests/kustomize/options/ui/base
-kustomize edit set image model-registry-ui-image=${IMG_UI_STANDALONE}
+kustomize edit set image model-registry-ui=${IMG_UI_STANDALONE}
 
 pushd  ../overlays/standalone
 # Step 4: Deploy model registry UI

manifests/kustomize/options/ui/base/model-registry-ui-deployment.yaml

@@ -24,21 +24,20 @@ spec:
         image: model-registry-ui
         imagePullPolicy: Always
         livenessProbe:
-          tcpSocket:
+          httpGet:
+            path: /healthcheck
             port: 8080
+            scheme: HTTP
           initialDelaySeconds: 30
           timeoutSeconds: 15
           periodSeconds: 30
           successThreshold: 1
           failureThreshold: 3
         readinessProbe:
           httpGet:
-            path: /api/v1/healthcheck
+            path: /healthcheck
             port: 8080
             scheme: HTTP
-            httpHeaders:
-            - name: kubeflow-userid
-              value: user@example.com
           initialDelaySeconds: 15
           timeoutSeconds: 15
           periodSeconds: 30