feat(ws): Notebooks 2.0 // Backend // add count to workspacekind schema response

rafriat · rafriat · commit 7421ad0a50af · 2025-06-25T10:35:59.000+03:00
Signed-off-by: rafriat &lt;roee.afriat.ext@nokia.com&gt;
diff --git a/workspaces/backend/api/suite_test.go b/workspaces/backend/api/suite_test.go
@@ -454,5 +454,34 @@ func NewExampleWorkspaceKind(name string) *kubefloworgv1beta1.WorkspaceKind {
 				},
 			},
 		},
+		Status: kubefloworgv1beta1.WorkspaceKindStatus{
+			Workspaces: 1,
+			PodTemplateOptions: kubefloworgv1beta1.PodTemplateOptionsMetrics{
+				ImageConfig: []kubefloworgv1beta1.OptionMetric{
+					{
+						Id:         "jupyterlab_scipy_180",
+						Workspaces: 1,
+					},
+					{
+						Id:         "jupyterlab_scipy_190",
+						Workspaces: 0,
+					},
+				},
+				PodConfig: []kubefloworgv1beta1.OptionMetric{
+					{
+						Id:         "tiny_cpu",
+						Workspaces: 1,
+					},
+					{
+						Id:         "small_cpu",
+						Workspaces: 0,
+					},
+					{
+						Id:         "big_gpu",
+						Workspaces: 0,
+					},
+				},
+			},
+		},
 	}
 }
diff --git a/workspaces/backend/internal/models/workspacekinds/funcs.go b/workspaces/backend/internal/models/workspacekinds/funcs.go
@@ -36,6 +36,8 @@ func NewWorkspaceKindModelFromWorkspaceKind(wsk *kubefloworgv1beta1.WorkspaceKin
 			podAnnotations[k] = v
 		}
 	}
+	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:
@@ -60,6 +62,7 @@ func NewWorkspaceKindModelFromWorkspaceKind(wsk *kubefloworgv1beta1.WorkspaceKin
 		Hidden:             ptr.Deref(wsk.Spec.Spawner.Hidden, false),
 		Icon:               iconRef,
 		Logo:               logoRef,
+		Workspaces:         wsk.Status.Workspaces,
 		PodTemplate: PodTemplate{
 			PodMetadata: PodMetadata{
 				Labels:      podLabels,
@@ -71,18 +74,26 @@ func NewWorkspaceKindModelFromWorkspaceKind(wsk *kubefloworgv1beta1.WorkspaceKin
 			Options: PodTemplateOptions{
 				ImageConfig: ImageConfig{
 					Default: wsk.Spec.PodTemplate.Options.ImageConfig.Spawner.Default,
-					Values:  buildImageConfigValues(wsk.Spec.PodTemplate.Options.ImageConfig),
+					Values:  buildImageConfigValues(wsk.Spec.PodTemplate.Options.ImageConfig, statusImageConfigMap),
 				},
 				PodConfig: PodConfig{
 					Default: wsk.Spec.PodTemplate.Options.PodConfig.Spawner.Default,
-					Values:  buildPodConfigValues(wsk.Spec.PodTemplate.Options.PodConfig),
+					Values:  buildPodConfigValues(wsk.Spec.PodTemplate.Options.PodConfig, statusPodConfigMap),
 				},
 			},
 		},
 	}
 }
 
-func buildImageConfigValues(imageConfig kubefloworgv1beta1.ImageConfig) []ImageConfigValue {
+func buildOptionMetricsMap(metrics []kubefloworgv1beta1.OptionMetric) map[string]int32 {
+	resultMap := make(map[string]int32)
+	for _, metric := range metrics {
+		resultMap[metric.Id] = metric.Workspaces
+	}
+	return resultMap
+}
+
+func buildImageConfigValues(imageConfig kubefloworgv1beta1.ImageConfig, statusImageConfigMap map[string]int32) []ImageConfigValue {
 	imageConfigValues := make([]ImageConfigValue, len(imageConfig.Values))
 	for i := range imageConfig.Values {
 		option := imageConfig.Values[i]
@@ -93,12 +104,13 @@ func buildImageConfigValues(imageConfig kubefloworgv1beta1.ImageConfig) []ImageC
 			Labels:      buildOptionLabels(option.Spawner.Labels),
 			Hidden:      ptr.Deref(option.Spawner.Hidden, false),
 			Redirect:    buildOptionRedirect(option.Redirect),
+			Workspaces:  statusImageConfigMap[option.Id],
 		}
 	}
 	return imageConfigValues
 }
 
-func buildPodConfigValues(podConfig kubefloworgv1beta1.PodConfig) []PodConfigValue {
+func buildPodConfigValues(podConfig kubefloworgv1beta1.PodConfig, statusPodConfigMap map[string]int32) []PodConfigValue {
 	podConfigValues := make([]PodConfigValue, len(podConfig.Values))
 	for i := range podConfig.Values {
 		option := podConfig.Values[i]
@@ -109,6 +121,7 @@ func buildPodConfigValues(podConfig kubefloworgv1beta1.PodConfig) []PodConfigVal
 			Labels:      buildOptionLabels(option.Spawner.Labels),
 			Hidden:      ptr.Deref(option.Spawner.Hidden, false),
 			Redirect:    buildOptionRedirect(option.Redirect),
+			Workspaces:  statusPodConfigMap[option.Id],
 		}
 	}
 	return podConfigValues
diff --git a/workspaces/backend/internal/models/workspacekinds/types.go b/workspaces/backend/internal/models/workspacekinds/types.go
@@ -25,6 +25,7 @@ type WorkspaceKind struct {
 	Hidden             bool        `json:"hidden"`
 	Icon               ImageRef    `json:"icon"`
 	Logo               ImageRef    `json:"logo"`
+	Workspaces         int32       `json:"workspacesCount"`
 	PodTemplate        PodTemplate `json:"podTemplate"`
 }
 
@@ -64,6 +65,7 @@ type ImageConfigValue struct {
 	Labels      []OptionLabel   `json:"labels"`
 	Hidden      bool            `json:"hidden"`
 	Redirect    *OptionRedirect `json:"redirect,omitempty"`
+	Workspaces  int32           `json:"workspacesCount"`
 }
 
 type PodConfig struct {
@@ -78,6 +80,7 @@ type PodConfigValue struct {
 	Labels      []OptionLabel   `json:"labels"`
 	Hidden      bool            `json:"hidden"`
 	Redirect    *OptionRedirect `json:"redirect,omitempty"`
+	Workspaces  int32           `json:"workspacesCount"`
 }
 
 type OptionLabel struct {
diff --git a/workspaces/backend/openapi/docs.go b/workspaces/backend/openapi/docs.go
@@ -740,6 +740,9 @@ const docTemplate = `{
                 },
                 "redirect": {
                     "$ref": "#/definitions/workspacekinds.OptionRedirect"
+                },
+                "workspacesCount": {
+                    "type": "integer"
                 }
             }
         },
@@ -810,6 +813,9 @@ const docTemplate = `{
                 },
                 "redirect": {
                     "$ref": "#/definitions/workspacekinds.OptionRedirect"
+                },
+                "workspacesCount": {
+                    "type": "integer"
                 }
             }
         },
@@ -916,6 +922,9 @@ const docTemplate = `{
                 },
                 "podTemplate": {
                     "$ref": "#/definitions/workspacekinds.PodTemplate"
+                },
+                "workspacesCount": {
+                    "type": "integer"
                 }
             }
         },
diff --git a/workspaces/backend/openapi/swagger.json b/workspaces/backend/openapi/swagger.json
@@ -738,6 +738,9 @@
                 },
                 "redirect": {
                     "$ref": "#/definitions/workspacekinds.OptionRedirect"
+                },
+                "workspacesCount": {
+                    "type": "integer"
                 }
             }
         },
@@ -808,6 +811,9 @@
                 },
                 "redirect": {
                     "$ref": "#/definitions/workspacekinds.OptionRedirect"
+                },
+                "workspacesCount": {
+                    "type": "integer"
                 }
             }
         },
@@ -914,6 +920,9 @@
                 },
                 "podTemplate": {
                     "$ref": "#/definitions/workspacekinds.PodTemplate"
+                },
+                "workspacesCount": {
+                    "type": "integer"
                 }
             }
         },
diff --git a/workspaces/backend/openapi/swagger.yaml b/workspaces/backend/openapi/swagger.yaml
@@ -140,6 +140,8 @@ definitions:
         type: array
       redirect:
         $ref: '#/definitions/workspacekinds.OptionRedirect'
+      workspacesCount:
+        type: integer
     type: object
   workspacekinds.ImageRef:
     properties:
@@ -185,6 +187,8 @@ definitions:
         type: array
       redirect:
         $ref: '#/definitions/workspacekinds.OptionRedirect'
+      workspacesCount:
+        type: integer
     type: object
   workspacekinds.PodMetadata:
     properties:
@@ -255,6 +259,8 @@ definitions:
         type: string
       podTemplate:
         $ref: '#/definitions/workspacekinds.PodTemplate'
+      workspacesCount:
+        type: integer
     type: object
   workspaces.Activity:
     properties:

Original file line number	Diff line number	Diff line change
`@@ -25,6 +25,7 @@ type WorkspaceKind struct {`
`25`	`25`	Hidden bool `json:"hidden"`
`26`	`26`	Icon ImageRef `json:"icon"`
`27`	`27`	Logo ImageRef `json:"logo"`
	`28`	+ Workspaces int32 `json:"workspacesCount"`
`28`	`29`	PodTemplate PodTemplate `json:"podTemplate"`
`29`	`30`	`}`
`30`	`31`
`@@ -64,6 +65,7 @@ type ImageConfigValue struct {`
`64`	`65`	Labels []OptionLabel `json:"labels"`
`65`	`66`	Hidden bool `json:"hidden"`
`66`	`67`	Redirect *OptionRedirect `json:"redirect,omitempty"`
	`68`	+ Workspaces int32 `json:"workspacesCount"`
`67`	`69`	`}`
`68`	`70`
`69`	`71`	`type PodConfig struct {`
`@@ -78,6 +80,7 @@ type PodConfigValue struct {`
`78`	`80`	Labels []OptionLabel `json:"labels"`
`79`	`81`	Hidden bool `json:"hidden"`
`80`	`82`	Redirect *OptionRedirect `json:"redirect,omitempty"`
	`83`	+ Workspaces int32 `json:"workspacesCount"`
`81`	`84`	`}`
`82`	`85`
`83`	`86`	`type OptionLabel struct {`
Original file line number	Diff line number	Diff line change
@@ -740,6 +740,9 @@ const docTemplate = `{
`740`	`740`	`},`
`741`	`741`	`"redirect": {`
`742`	`742`	`"$ref": "#/definitions/workspacekinds.OptionRedirect"`
	`743`	`+ },`
	`744`	`+ "workspacesCount": {`
	`745`	`+ "type": "integer"`
`743`	`746`	`}`
`744`	`747`	`}`
`745`	`748`	`},`
@@ -810,6 +813,9 @@ const docTemplate = `{
`810`	`813`	`},`
`811`	`814`	`"redirect": {`
`812`	`815`	`"$ref": "#/definitions/workspacekinds.OptionRedirect"`
	`816`	`+ },`
	`817`	`+ "workspacesCount": {`
	`818`	`+ "type": "integer"`
`813`	`819`	`}`
`814`	`820`	`}`
`815`	`821`	`},`
@@ -916,6 +922,9 @@ const docTemplate = `{
`916`	`922`	`},`
`917`	`923`	`"podTemplate": {`
`918`	`924`	`"$ref": "#/definitions/workspacekinds.PodTemplate"`
	`925`	`+ },`
	`926`	`+ "workspacesCount": {`
	`927`	`+ "type": "integer"`
`919`	`928`	`}`
`920`	`929`	`}`
`921`	`930`	`},`
Original file line number	Diff line number	Diff line change
`@@ -738,6 +738,9 @@`
`738`	`738`	`},`
`739`	`739`	`"redirect": {`
`740`	`740`	`"$ref": "#/definitions/workspacekinds.OptionRedirect"`
	`741`	`+ },`
	`742`	`+ "workspacesCount": {`
	`743`	`+ "type": "integer"`
`741`	`744`	`}`
`742`	`745`	`}`
`743`	`746`	`},`
`@@ -808,6 +811,9 @@`
`808`	`811`	`},`
`809`	`812`	`"redirect": {`
`810`	`813`	`"$ref": "#/definitions/workspacekinds.OptionRedirect"`
	`814`	`+ },`
	`815`	`+ "workspacesCount": {`
	`816`	`+ "type": "integer"`
`811`	`817`	`}`
`812`	`818`	`}`
`813`	`819`	`},`
`@@ -914,6 +920,9 @@`
`914`	`920`	`},`
`915`	`921`	`"podTemplate": {`
`916`	`922`	`"$ref": "#/definitions/workspacekinds.PodTemplate"`
	`923`	`+ },`
	`924`	`+ "workspacesCount": {`
	`925`	`+ "type": "integer"`
`917`	`926`	`}`
`918`	`927`	`}`
`919`	`928`	`},`