Add a length limitation for auto-generated workspace names (#1045)

* fix: an error message typo

Signed-off-by: Oleksii Orel <oorel@redhat.com>

* fix: generateWorkspaceName method

Signed-off-by: Oleksii Orel <oorel@redhat.com>
---------

Signed-off-by: Oleksii Orel <oorel@redhat.com>

Author: olexii4

packages/dashboard-frontend/src/services/helpers/__tests__/getName.spec.ts

@@ -0,0 +1,39 @@
+/*
+ * Copyright (c) 2018-2024 Red Hat, Inc.
+ * This program and the accompanying materials are made
+ * available under the terms of the Eclipse Public License 2.0
+ * which is available at https://www.eclipse.org/legal/epl-2.0/
+ *
+ * SPDX-License-Identifier: EPL-2.0
+ *
+ * Contributors:
+ *   Red Hat, Inc. - initial API and implementation
+ */
+
+import { generateWorkspaceName, WORKSPACE_NAME_MAX_LENGTH } from '@/services/helpers/generateName';
+
+describe('Get a new workspace name', () => {
+  it('returns a workspace name which start from the generateName', () => {
+    const generateName = 'project-demo';
+
+    const workspaceName = generateWorkspaceName(generateName);
+
+    expect(workspaceName.startsWith(generateName)).toBeTruthy();
+  });
+
+  it('returns a workspace name with 5 char suffix', () => {
+    const generateName = 'project-demo';
+
+    const workspaceName = generateWorkspaceName(generateName);
+
+    expect(workspaceName.length).toBe(generateName.length + 5);
+  });
+
+  it('returns a workspace name less then WORKSPACE_NAME_MAX_LENGTH symbols', () => {
+    const generateName = 'a'.repeat(WORKSPACE_NAME_MAX_LENGTH + 100);
+
+    const workspaceName = generateWorkspaceName(generateName);
+
+    expect(workspaceName.length).toBeLessThan(WORKSPACE_NAME_MAX_LENGTH);
+  });
+});

packages/dashboard-frontend/src/services/helpers/__tests__/getProjectName.spec.ts

@@ -10,16 +10,16 @@
  *   Red Hat, Inc. - initial API and implementation
  */
 
-import { getProjectName } from '@/services/helpers/getProjectName';
+import { getProjectName, PROJECT_NAME_MAX_LENGTH } from '@/services/helpers/getProjectName';
 
 describe('Get a project name based on location', () => {
-  it('should return a valid name less then 63 symbols', () => {
+  it('should return a valid name less then PROJECT_NAME_MAX_LENGTH symbols', () => {
     let cloneUrl = 'http://dummy/test.com/project-demo';
 
     cloneUrl += 'a'.repeat(100);
     const projectName = getProjectName(cloneUrl);
 
-    expect(projectName).toEqual('project-demo' + 'a'.repeat(50));
+    expect(projectName.length).toBeLessThan(PROJECT_NAME_MAX_LENGTH);
   });
 
   it('should return a valid name which has the first char [a-z0-9]', () => {

packages/dashboard-frontend/src/services/helpers/generateName.ts

@@ -12,8 +12,15 @@
 
 import getRandomString from '@/services/helpers/random';
 
+export const WORKSPACE_NAME_MAX_LENGTH = 63;
+
 export function generateWorkspaceName(generateName: string): string {
-  return generateName + generateSuffix();
+  const suffix = generateSuffix();
+
+  if (generateName.length + suffix.length > WORKSPACE_NAME_MAX_LENGTH) {
+    generateName = generateName.substring(0, WORKSPACE_NAME_MAX_LENGTH - suffix.length - 1);
+  }
+  return generateName + suffix;
 }
 
 export function generateSuffix(): string {

packages/dashboard-frontend/src/services/helpers/getProjectName.ts

@@ -10,7 +10,7 @@
  *   Red Hat, Inc. - initial API and implementation
  */
 
-const PROJECT_NAME_MAX_LENGTH = 63;
+export const PROJECT_NAME_MAX_LENGTH = 63;
 
 export function getProjectName(cloneUrl: string): string {
   let name = cloneUrl
@@ -22,7 +22,7 @@ export function getProjectName(cloneUrl: string): string {
   name = name.replace(/(^[-]+)/, '');
   name = name.replace(/([-]+$)/, '');
   if (name.length > PROJECT_NAME_MAX_LENGTH) {
-    name = name.substr(0, PROJECT_NAME_MAX_LENGTH - 1);
+    name = name.substring(0, PROJECT_NAME_MAX_LENGTH - 1);
   }
 
   return name;

packages/dashboard-frontend/src/store/Workspaces/devWorkspaces/__tests__/editorImage.spec.ts

@@ -104,7 +104,7 @@ describe('Update editor image', () => {
       }
 
       expect(errorMessage).toEqual(
-        'Failed to update editor image. Editor components is not defined.',
+        'Failed to update editor image. Editor components are not defined.',
       );
     });
 
@@ -146,7 +146,7 @@ describe('Update editor image', () => {
       }
 
       expect(errorMessage).toEqual(
-        'Failed to update editor image. Editor components is not defined.',
+        'Failed to update editor image. Editor components are not defined.',
       );
     });
 

packages/dashboard-frontend/src/store/Workspaces/devWorkspaces/editorImage.ts

@@ -87,7 +87,7 @@ function updateComponents(
   editorImage: string,
 ): boolean {
   if (!components) {
-    throw new Error('Editor components is not defined.');
+    throw new Error('Editor components are not defined.');
   }
   let isUpdated = false;
   for (let i = 0; i < components.length; i++) {