fix: always return icon/logo URL in WS/WSK for now (#964)

* fix: Replace the hardcoded WSK icon URI with cm URL

Until #736 from Andy is fully cooked we atleast want to have some way of
showing the WSK icons in the upcoming alpha release.

Co-authored-by: Mathew Wicks <5735406+thesuperzapper@users.noreply.github.com>
Signed-off-by: Christian Heusel <christian@heusel.eu>

* mathew: 1

Signed-off-by: Mathew Wicks <5735406+thesuperzapper@users.noreply.github.com>

* mathew: 2

Signed-off-by: Mathew Wicks <5735406+thesuperzapper@users.noreply.github.com>

---------

Signed-off-by: Christian Heusel <christian@heusel.eu>
Signed-off-by: Mathew Wicks <5735406+thesuperzapper@users.noreply.github.com>
Co-authored-by: Mathew Wicks <5735406+thesuperzapper@users.noreply.github.com>

Author: christian-heusel

workspaces/backend/internal/models/workspacekinds/funcs.go

@@ -17,8 +17,6 @@ limitations under the License.
 package workspacekinds
 
 import (
-	"fmt"
-
 	kubefloworgv1beta1 "github.com/kubeflow/notebooks/workspaces/controller/api/v1beta1"
 	"k8s.io/utils/ptr"
 )
@@ -39,18 +37,15 @@ func NewWorkspaceKindModelFromWorkspaceKind(wsk *kubefloworgv1beta1.WorkspaceKin
 	statusImageConfigMap := buildOptionMetricsMap(wsk.Status.PodTemplateOptions.ImageConfig)
 	statusPodConfigMap := buildOptionMetricsMap(wsk.Status.PodTemplateOptions.PodConfig)
 
-	// TODO: icons can either be a remote URL or read from a ConfigMap.
-	//       in BOTH cases, we should cache and serve the image under a path on the backend API:
-	//       /api/v1/workspacekinds/{name}/assets/icon
 	iconRef := ImageRef{
-		URL: fmt.Sprintf("/workspaces/backend/api/v1/workspacekinds/%s/assets/icon", wsk.Name),
+		// TODO: icons MUST be either set to remote URL or read from a ConfigMap
+		//       we can remove this fallback once we implement the ConfigMap option.
+		URL: ptr.Deref(wsk.Spec.Spawner.Icon.Url, "__UNKNOWN_ICON_URL__"),
 	}
-
-	// TODO: logos can either be a remote URL or read from a ConfigMap.
-	//       in BOTH cases, we should cache and serve the image under a path on the backend API:
-	//       /api/v1/workspacekinds/{name}/assets/logo
 	logoRef := ImageRef{
-		URL: fmt.Sprintf("/workspaces/backend/api/v1/workspacekinds/%s/assets/logo", wsk.Name),
+		// TODO: logos MUST be either set to remote URL or read from a ConfigMap
+		//       we can remove this fallback once we implement the ConfigMap option.
+		URL: ptr.Deref(wsk.Spec.Spawner.Logo.Url, "__UNKNOWN_LOGO_URL__"),
 	}
 
 	return WorkspaceKind{

workspaces/backend/internal/models/workspaces/funcs.go

@@ -29,6 +29,8 @@ const (
 	UnknownHomeMountPath = "__UNKNOWN_HOME_MOUNT_PATH__"
 	UnknownImageConfig   = "__UNKNOWN_IMAGE_CONFIG__"
 	UnknownPodConfig     = "__UNKNOWN_POD_CONFIG__"
+	UnknownIconURL       = "__UNKNOWN_ICON_URL__"
+	UnknownLogoURL       = "__UNKNOWN_LOGO_URL__"
 )
 
 // NewWorkspaceListItemFromWorkspace creates a WorkspaceListItem model from a Workspace and WorkspaceKind object.
@@ -39,18 +41,20 @@ func NewWorkspaceListItemFromWorkspace(ws *kubefloworgv1beta1.Workspace, wsk *ku
 		panic("provided WorkspaceKind does not match the Workspace")
 	}
 
-	// TODO: icons can either be a remote URL or read from a ConfigMap.
-	//       in BOTH cases, we should cache and serve the image under a path on the backend API:
-	//       /api/v1/workspacekinds/{name}/assets/icon
-	iconRef := ImageRef{
-		URL: fmt.Sprintf("/workspaces/backend/api/v1/workspacekinds/%s/assets/icon", ws.Spec.Kind),
+	// we only know the icon url if the WorkspaceKind exists
+	iconURL := UnknownIconURL
+	if wskExists(wsk) {
+		// TODO: icons MUST be either set to remote URL or read from a ConfigMap
+		//       we can remove this fallback once we implement the ConfigMap option.
+		iconURL = ptr.Deref(wsk.Spec.Spawner.Icon.Url, UnknownIconURL)
 	}
 
-	// TODO: logos can either be a remote URL or read from a ConfigMap.
-	//       in BOTH cases, we should cache and serve the image under a path on the backend API:
-	//       /api/v1/workspacekinds/{name}/assets/logo
-	logoRef := ImageRef{
-		URL: fmt.Sprintf("/workspaces/backend/api/v1/workspacekinds/%s/assets/logo", ws.Spec.Kind),
+	// we only know the logo url if the WorkspaceKind exists
+	logoURL := UnknownLogoURL
+	if wskExists(wsk) {
+		// TODO: logos MUST be either set to remote URL or read from a ConfigMap
+		//       we can remove this fallback once we implement the ConfigMap option.
+		logoURL = ptr.Deref(wsk.Spec.Spawner.Logo.Url, UnknownLogoURL)
 	}
 
 	podLabels := make(map[string]string)
@@ -90,8 +94,12 @@ func NewWorkspaceListItemFromWorkspace(ws *kubefloworgv1beta1.Workspace, wsk *ku
 		WorkspaceKind: WorkspaceKindInfo{
 			Name:    ws.Spec.Kind,
 			Missing: !wskExists(wsk),
-			Icon:    iconRef,
-			Logo:    logoRef,
+			Icon: ImageRef{
+				URL: iconURL,
+			},
+			Logo: ImageRef{
+				URL: logoURL,
+			},
 		},
 		Paused:         ptr.Deref(ws.Spec.Paused, false),
 		PausedTime:     ws.Status.PauseTime,