updated regex and validation to properly catch non-compliant DNS-1035 labels (#3681)

Author: rsun19

frontend/src/concepts/k8s/__tests__/utils.spec.ts

@@ -7,6 +7,7 @@ import {
   translateDisplayNameForK8s,
   translateDisplayNameForK8sAndReport,
 } from '~/concepts/k8s/utils';
+import { K8_NOTEBOOK_RESOURCE_NAME_VALIDATOR } from '~/pages/projects/screens/spawner/const';
 
 describe('getDisplayNameFromK8sResource', () => {
   it('gets the display name when present', () => {
@@ -49,6 +50,10 @@ describe('translateDisplayNameForK8s', () => {
     expect(translateDisplayNameForK8s('-1234', { safeK8sPrefix: 'wb-' })).toBe('wb-1234');
     expect(translateDisplayNameForK8s('-1-', { safeK8sPrefix: 'wb-' })).toBe('wb-1');
     expect(translateDisplayNameForK8s('1-', { safeK8sPrefix: 'wb-' })).toBe('wb-1');
+    expect(translateDisplayNameForK8s('213-workbench-1-tls', { safeK8sPrefix: 'wb-' })).toBe(
+      'wb-213-workbench-1-tls',
+    );
+    expect(translateDisplayNameForK8s('$-12hello', { safeK8sPrefix: 'wb-' })).toBe('wb-12hello');
     expect(translateDisplayNameForK8s('-validcharacters')).toBe(`validcharacters`);
   });
 });
@@ -160,3 +165,37 @@ describe('isValidK8sName', () => {
     expect(isValidK8sName('ymbols--capitals-and-spaces-these-are-invalid')).toBe(true);
   });
 });
+
+describe('isValidK8sName for Notebook resource names', () => {
+  it('identifies invalid names', () => {
+    expect(isValidK8sName('', K8_NOTEBOOK_RESOURCE_NAME_VALIDATOR)).toBe(false);
+    expect(isValidK8sName('Test Project 1', K8_NOTEBOOK_RESOURCE_NAME_VALIDATOR)).toBe(false);
+    expect(isValidK8sName("John Doe's Cool Project!", K8_NOTEBOOK_RESOURCE_NAME_VALIDATOR)).toBe(
+      false,
+    );
+    expect(
+      isValidK8sName(
+        '$ymbols & Capitals and Spaces! (These are invalid!)',
+        K8_NOTEBOOK_RESOURCE_NAME_VALIDATOR,
+      ),
+    ).toBe(false);
+    expect(isValidK8sName('--213-workbench-1-tls', K8_NOTEBOOK_RESOURCE_NAME_VALIDATOR)).toBe(
+      false,
+    );
+    expect(isValidK8sName('1234', K8_NOTEBOOK_RESOURCE_NAME_VALIDATOR)).toBe(false);
+    expect(isValidK8sName('213-workbench-1-tls', K8_NOTEBOOK_RESOURCE_NAME_VALIDATOR)).toBe(false);
+  });
+
+  it('identifies valid names', () => {
+    expect(isValidK8sName('test-project-1', K8_NOTEBOOK_RESOURCE_NAME_VALIDATOR)).toBe(true);
+    expect(isValidK8sName('john-does-cool-project', K8_NOTEBOOK_RESOURCE_NAME_VALIDATOR)).toBe(
+      true,
+    );
+    expect(
+      isValidK8sName(
+        'ymbols--capitals-and-spaces-these-are-invalid',
+        K8_NOTEBOOK_RESOURCE_NAME_VALIDATOR,
+      ),
+    ).toBe(true);
+  });
+});

frontend/src/concepts/k8s/utils.ts

@@ -57,10 +57,10 @@ export const translateDisplayNameForK8sAndReport = (
   let translatedName = name
     .trim()
     .toLowerCase()
-    .replace(/^-*/, '') // remove any leading dashes
-    .replace(/-*$/, '') // remove any trailing dashes
     .replace(/\s/g, '-') // spaces to dashes
     .replace(/[^a-z0-9-]/g, '') // remove inverse of good k8s characters
+    .replace(/^-*/, '') // remove any leading dashes
+    .replace(/-*$/, '') // remove any trailing dashes
     .replace(/[-]+/g, '-'); // simplify double dashes ('A - B' turns into 'a---b' where 'a-b' is enough)
 
   /** Allows constant length checks -- modifies translatedName & appliedCriteria */
@@ -84,8 +84,8 @@ export const translateDisplayNameForK8sAndReport = (
       }
       appliedCriteria.safeK8sPrefix = true;
       appliedCriteria.staticPrefix = true;
-    } else if (/^\d+$/.test(translatedName)) {
-      // Avoid pure digit names
+    } else if (/^\d+/.test(translatedName)) {
+      // Avoid names that start with a digit
       translatedName = `${safeK8sPrefix}${translatedName}`;
       appliedCriteria.safeK8sPrefix = true;
     }

frontend/src/pages/projects/screens/spawner/SpawnerPage.tsx

@@ -37,7 +37,11 @@ import useNotebookPVCItems from '~/pages/projects/pvc/useNotebookPVCItems';
 import { getNotebookPVCMountPathMap } from '~/pages/projects/notebook/utils';
 import { getNotebookPVCNames } from '~/pages/projects/pvc/utils';
 import { SpawnerPageSectionID } from './types';
-import { ScrollableSelectorID, SpawnerPageSectionTitles } from './const';
+import {
+  K8_NOTEBOOK_RESOURCE_NAME_VALIDATOR,
+  ScrollableSelectorID,
+  SpawnerPageSectionTitles,
+} from './const';
 import SpawnerFooter from './SpawnerFooter';
 import ImageSelectorField from './imageSelector/ImageSelectorField';
 import ContainerSizeSelector from './deploymentSize/ContainerSizeSelector';
@@ -76,6 +80,7 @@ const SpawnerPage: React.FC<SpawnerPageProps> = ({ existingNotebook }) => {
     initialData: existingNotebook,
     limitNameResourceType: LimitNameResourceType.WORKBENCH,
     safePrefix: 'wb-',
+    regexp: K8_NOTEBOOK_RESOURCE_NAME_VALIDATOR,
   });
   const [isAttachStorageModalOpen, setIsAttachStorageModalOpen] = React.useState(false);
   const [isCreateStorageModalOpen, setIsCreateStorageModalOpen] = React.useState(false);

frontend/src/pages/projects/screens/spawner/const.ts

@@ -14,6 +14,7 @@ export const ScrollableSelectorID = 'workbench-spawner-page';
 
 export const FAILED_PHASES = [BuildPhase.ERROR, BuildPhase.FAILED];
 export const PENDING_PHASES = [BuildPhase.NEW, BuildPhase.PENDING, BuildPhase.CANCELLED];
+export const K8_NOTEBOOK_RESOURCE_NAME_VALIDATOR = /^[a-z]([-a-z0-9]*[a-z0-9])?$/;
 
 // TODO: Convert to enum
 export const IMAGE_ANNOTATIONS = {