added fix to enumerate duplicate names in default notebook creation (#323)

* added fix to enumerate duplicate names in default notebook creation

* updated cypress version to fix firefox issue

---------

Co-authored-by: Mathis Marcotte <[email protected]>

Author: mathis-marcotte

frontend/jupyter/package-lock.json

@@ -70,7 +70,7 @@
     "@types/node": "^18.19.18",
     "@typescript-eslint/eslint-plugin": "^6.10.0",
     "@typescript-eslint/parser": "^6.10.0",
-    "cypress": "^13.2.0",
+    "cypress": "^13.8.1",
     "eslint": "^8.53.0",
     "eslint-plugin-import": "latest",
     "eslint-plugin-jsdoc": "^39.9.1",

frontend/jupyter/package.json

@@ -2790,7 +2790,7 @@
   dependencies:
     "@types/node" "*"
 
-"@types/node@*", "@types/node@^18.0.0 || >=20.0.0", "@types/node@^18.17.5", "@types/node@^18.19.18", "@types/node@>=10.0.0":
+"@types/node@*", "@types/node@^18.0.0 || >=20.0.0", "@types/node@^18.19.18", "@types/node@>=10.0.0":
   version "18.19.18"
   resolved "https://registry.npmjs.org/@types/node/-/node-18.19.18.tgz"
   integrity sha512-80CP7B8y4PzZF0GWx15/gVWRrB5y/bIjNI84NK3cmQJu0WZwvmj2WMA5LcofQFVfLqqCSp545+U2LsrVzX36Zg==
@@ -3737,7 +3737,7 @@ buffer-from@^1.0.0:
   resolved "https://registry.npmjs.org/buffer-from/-/buffer-from-1.1.2.tgz"
   integrity sha512-E+XQCRwSbaaiChtv6k6Dwgc+bx+Bs6vuKJHHl5kox/BaKbhiXzqQOwK4cO22yElGp2OCmjwVhT3HmxgyPGnJfQ==
 
-buffer@^5.5.0, buffer@^5.6.0:
+buffer@^5.5.0, buffer@^5.7.1:
   version "5.7.1"
   resolved "https://registry.npmjs.org/buffer/-/buffer-5.7.1.tgz"
   integrity sha512-EHcyIPBQ4BSGlvjB16k5KgAJ27CIsHY/2JBmCRReo48y9rQ3MaUzWX3KVlBa4U7MyX02HdVj0K7C3WaB3ju7FQ==
@@ -3828,9 +3828,9 @@ camelcase@^5.3.1:
   integrity sha512-L28STB170nwWS63UjtlEOE3dldQApaJXZkOI1uMFfzf3rRuPegHaHesyee+YxQ+W6SvRDQV6UrdOdRiR153wJg==
 
 caniuse-lite@^1.0.30001578, caniuse-lite@^1.0.30001587:
-  version "1.0.30001589"
-  resolved "https://registry.npmjs.org/caniuse-lite/-/caniuse-lite-1.0.30001589.tgz"
-  integrity sha512-vNQWS6kI+q6sBlHbh71IIeC+sRwK2N3EDySc/updIGhIee2x5z00J4c1242/5/d6EpEMdOnk/m+6tuk4/tcsqg==
+  version "1.0.30001615"
+  resolved "https://registry.npmjs.org/caniuse-lite/-/caniuse-lite-1.0.30001615.tgz"
+  integrity sha512-1IpazM5G3r38meiae0bHRnPhz+CBQ3ZLqbQMtrg+AsTPKAXgW38JNsXkyZ+v8waCsDmPq87lmfun5Q2AGysNEQ==
 
 caseless@~0.12.0:
   version "0.12.0"
@@ -4257,20 +4257,19 @@ custom-event@~1.0.0:
   resolved "https://registry.npmjs.org/custom-event/-/custom-event-1.0.1.tgz"
   integrity sha512-GAj5FOq0Hd+RsCGVJxZuKaIDXDf3h6GQoNEjFgbLLI/trgtavwUbSnZ5pVfg27DVCaWjIohryS0JFwIJyT2cMg==
 
-cypress@^13.2.0:
-  version "13.2.0"
-  resolved "https://registry.npmjs.org/cypress/-/cypress-13.2.0.tgz"
-  integrity sha512-AvDQxBydE771GTq0TR4ZUBvv9m9ffXuB/ueEtpDF/6gOcvFR96amgwSJP16Yhqw6VhmwqspT5nAGzoxxB+D89g==
+cypress@^13.8.1:
+  version "13.8.1"
+  resolved "https://registry.npmjs.org/cypress/-/cypress-13.8.1.tgz"
+  integrity sha512-Uk6ovhRbTg6FmXjeZW/TkbRM07KPtvM5gah1BIMp4Y2s+i/NMxgaLw0+PbYTOdw1+egE0FP3mWRiGcRkjjmhzA==
   dependencies:
     "@cypress/request" "^3.0.0"
     "@cypress/xvfb" "^1.2.4"
-    "@types/node" "^18.17.5"
     "@types/sinonjs__fake-timers" "8.1.1"
     "@types/sizzle" "^2.3.2"
     arch "^2.2.0"
     blob-util "^2.0.2"
     bluebird "^3.7.2"
-    buffer "^5.6.0"
+    buffer "^5.7.1"
     cachedir "^2.3.0"
     chalk "^4.1.0"
     check-more-types "^2.24.0"
@@ -4288,7 +4287,7 @@ cypress@^13.2.0:
     figures "^3.2.0"
     fs-extra "^9.1.0"
     getos "^3.2.1"
-    is-ci "^3.0.0"
+    is-ci "^3.0.1"
     is-installed-globally "~0.4.0"
     lazy-ass "^1.6.0"
     listr2 "^3.8.3"
@@ -6054,7 +6053,7 @@ is-callable@^1.1.3, is-callable@^1.1.4, is-callable@^1.2.7:
   resolved "https://registry.npmjs.org/is-callable/-/is-callable-1.2.7.tgz"
   integrity sha512-1BC0BVFhS/p0qtw6enp8e+8OD0UrK0oFLztSjNzhcKA3WDuJxxAPXzPuPtKkjEY9UUoEWlX/8fgKeu2S8i9JTA==
 
-is-ci@^3.0.0:
+is-ci@^3.0.1:
   version "3.0.1"
   resolved "https://registry.npmjs.org/is-ci/-/is-ci-3.0.1.tgz"
   integrity sha512-ZYvCgrefwqoQ6yTyYUbQu64HsITZ3NfKX1lzaEYdkTDcfKzzCI/wthRRYKkdjHKFVgNiXKAKm65Zo1pk2as/QQ==
@@ -6630,6 +6629,12 @@ klona@^2.0.4:
   resolved "https://registry.npmjs.org/klona/-/klona-2.0.6.tgz"
   integrity sha512-dhG34DXATL5hSxJbIexCft8FChFXtmskoZYnoPWjXQuebWYCNkVeV3KkGegCK9CP1oswI/vQibS2GY7Em/sJJA==
 
+"kubeflow@file:../common/kubeflow-common-lib/dist/kubeflow":
+  version "0.0.4"
+  resolved "file:../common/kubeflow-common-lib/dist/kubeflow"
+  dependencies:
+    tslib "^2.0.0"
+
 launch-editor@^2.6.0:
   version "2.6.1"
   resolved "https://registry.npmjs.org/launch-editor/-/launch-editor-2.6.1.tgz"

frontend/jupyter/yarn.lock

@@ -11,11 +11,13 @@ import (
 	"net/http"
 	"regexp"
 	"sort"
+	"strconv"
 	"strings"
 	"time"
 
 	kubeflowv1 "github.com/StatCan/kubeflow-apis/apis/kubeflow/v1"
 	"github.com/gorilla/mux"
+	"golang.org/x/exp/slices"
 	"gopkg.in/inf.v0"
 	corev1 "k8s.io/api/core/v1"
 	"k8s.io/apimachinery/pkg/api/resource"
@@ -479,10 +481,27 @@ func (s *server) handleVolume(ctx context.Context, req volrequest, notebook *kub
 	return nil
 }
 
+func (s *server) enumerateNames(name string, nameList []string) string {
+	if !slices.Contains(nameList, name) {
+		return name
+	}
+
+	count := 1
+	for slices.Contains(nameList, name+"-"+strconv.Itoa(count)) {
+		count++
+	}
+
+	return name + "-" + strconv.Itoa(count)
+}
+
 // Sets default values to notebook request if missing
-func (s *server) createDefaultNotebook(namespace string) (newnotebookrequest, error) {
+func (s *server) createDefaultNotebook(namespace string, notebookNames []string, pvcNames []string) (newnotebookrequest, error) {
 	var notebook newnotebookrequest
 	notebookname := namespace + "-notebook"
+
+	// updates the notebook name with a trailing number to avoid duplicate values
+	notebookname = s.enumerateNames(notebookname, notebookNames)
+
 	cpuvalue, err := resource.ParseQuantity(s.Config.SpawnerFormDefaults.CPU.Value)
 	if err != nil {
 		return notebook, err
@@ -508,6 +527,10 @@ func (s *server) createDefaultNotebook(namespace string) (newnotebookrequest, er
 		return notebook, err
 	}
 	workspacevolumename := notebookname + "-workspace"
+
+	// updates the volume name with a trailing number to avoid duplicate values
+	workspacevolumename = s.enumerateNames(workspacevolumename, pvcNames)
+
 	workspaceVol := volrequest{
 		Mount: s.Config.SpawnerFormDefaults.WorkspaceVolume.Value.Mount,
 		NewPvc: NewPvc{
@@ -586,7 +609,29 @@ func (s *server) NewDefaultNotebook(w http.ResponseWriter, r *http.Request) {
 	vars := mux.Vars(r)
 	namespace := vars["namespace"]
 
-	req, err := s.createDefaultNotebook(namespace)
+	notebooks, err := s.listers.notebooks.Notebooks(namespace).List(labels.Everything())
+	if err != nil {
+		s.error(w, r, err)
+		return
+	}
+
+	var notebookNames []string
+	for _, notebook := range notebooks {
+		notebookNames = append(notebookNames, notebook.Name)
+	}
+
+	pvcs, err := s.listers.persistentVolumeClaims.PersistentVolumeClaims(namespace).List(labels.Everything())
+	if err != nil {
+		s.error(w, r, err)
+		return
+	}
+
+	var pvcNames []string
+	for _, pvc := range pvcs {
+		pvcNames = append(pvcNames, pvc.Name)
+	}
+
+	req, err := s.createDefaultNotebook(namespace, notebookNames, pvcNames)
 	if err != nil {
 		s.error(w, r, err)
 		return

notebooks.go

@@ -17,27 +17,21 @@
 spawnerFormDefaults:
   image:
     # The container Image for the user's Jupyter Notebook
-    value: k8scc01covidacr.azurecr.io/jupyterlab-cpu:v1
+    value: artifactory.cloud.statcan.ca/das-aaw-docker/jupyterlab-cpu:v2
     # The list of available standard container Images
     options:
-      - k8scc01covidacr.azurecr.io/jupyterlab-cpu:v1
-      - k8scc01covidacr.azurecr.io/jupyterlab-pytorch:v1
-      - k8scc01covidacr.azurecr.io/jupyterlab-tensorflow:v1
+      - artifactory.cloud.statcan.ca/das-aaw-docker/jupyterlab-cpu:v2
+      - artifactory.cloud.statcan.ca/das-aaw-docker/jupyterlab-pytorch:v2
+      - artifactory.cloud.statcan.ca/das-aaw-docker/jupyterlab-tensorflow:v2
     readOnly: false
   imageGroupThree:
     # The container Image for the user's Group Three Server (SAS)
     # The annotation `notebooks.kubeflow.org/http-rewrite-uri: /`
     # is applied to notebook in this group, configuring
     # the Istio rewrite for containers that host their web UI at `/`
-    enabledCondition:
-      labels:
-        state.aaw.statcan.gc.ca/exists-non-sas-notebook-user: false
-    disabledMessage:
-      en: "SAS is unavailable while non-employees have access to this profile."
-      fr: "SAS n'est pas disponible lorsque des non-employés ont accès à ce profil."
-    value: k8scc01covidacr.azurecr.io/sas:latest    # The list of available standard container Images
+    value: artifactory.cloud.statcan.ca/das-aaw-docker/sas:v2    # The list of available standard container Images
     options:
-    - k8scc01covidacr.azurecr.io/sas:latest
+    - artifactory.cloud.statcan.ca/das-aaw-docker/sas:v2
   hideRegistry: true
   hideTag: true
   allowCustomImage: true
@@ -172,7 +166,7 @@ spawnerFormDefaults:
     readOnly: false
   tolerationGroup:
     # The default `groupKey` from the options list
-    # If readonly, the default value will be the only option 
+    # If readonly, the default value will be the only option
     value: "none"
     # The list of available tolerationGroup configs
     options: []