feat: add support a devfile that includes a parent with the storage-t…

…ype attribute (#1303) * feat: add support a devfite which includes a parent with the storage-type attribute Signed-off-by: Oleksii Orel <[email protected]>
eclipse-che · Jan 29, 2025 · a67105b · a67105b
1 parent 900f6ef
commit a67105b
Show file tree

Hide file tree

Showing 24 changed files with 640 additions and 204 deletions.
diff --git a/packages/dashboard-frontend/src/components/BasicViewer/index.tsx b/packages/dashboard-frontend/src/components/BasicViewer/index.tsx
@@ -35,7 +35,6 @@ export class BasicViewer extends React.PureComponent<Props> {
       });
       editor.setSize(`100%`, `100%`);
       editor.setValue(this.props.value);
-      editor.focus();
 
       this.editor = editor;
     }
@@ -44,7 +43,6 @@ export class BasicViewer extends React.PureComponent<Props> {
   componentDidUpdate(prevProps: Readonly<Props>): void {
     if (this.editor && this.props.value !== prevProps.value) {
       this.editor.setValue(this.props.value);
-      this.editor.focus();
     }
   }
 

diff --git a/packages/dashboard-frontend/src/components/DevfileViewer/index.tsx b/packages/dashboard-frontend/src/components/DevfileViewer/index.tsx
@@ -43,20 +43,16 @@ export class DevfileViewer extends React.PureComponent<Props> {
         lineWrapping: true,
         readOnly: true,
         autoRefresh: true,
-        autofocus: true,
-        gooters: true,
       });
       editor.setSize(`100%`, `100%`);
       editor.setValue(this.props.value);
-      editor.focus();
 
       this.editor = editor;
     }
   }
 
   componentDidUpdate(): void {
     this.editor.setValue(this.props.value);
-    this.editor.focus();
   }
 
   public render(): React.ReactElement {

diff --git a/...end/src/components/WorkspaceProgress/CreatingSteps/Apply/Devfile/__tests__/index.spec.tsx b/...end/src/components/WorkspaceProgress/CreatingSteps/Apply/Devfile/__tests__/index.spec.tsx
@@ -78,6 +78,9 @@ const devfile = {
   },
 } as devfileApi.Devfile;
 
+// mute console.error
+console.error = jest.fn();
+
 describe('Creating steps, applying a devfile', () => {
   let searchParams: URLSearchParams;
   let factoryId: string;
@@ -245,6 +248,7 @@ describe('Creating steps, applying a devfile', () => {
           factoryId,
           undefined,
           false,
+          undefined,
         ),
       );
       await waitFor(() => expect(mockCreateWorkspaceFromDevfile).toHaveBeenCalled());
@@ -334,6 +338,7 @@ describe('Creating steps, applying a devfile', () => {
           factoryId,
           undefined,
           false,
+          undefined,
         ),
       );
       await waitFor(() => expect(mockCreateWorkspaceFromDevfile).toHaveBeenCalled());
@@ -410,6 +415,7 @@ describe('Creating steps, applying a devfile', () => {
           factoryId,
           undefined,
           false,
+          undefined,
         ),
       );
       await waitFor(() => expect(mockCreateWorkspaceFromDevfile).toHaveBeenCalled());
@@ -488,6 +494,7 @@ describe('Creating steps, applying a devfile', () => {
           factoryId,
           undefined,
           false,
+          undefined,
         ),
       );
       await waitFor(() => expect(mockCreateWorkspaceFromDevfile).toHaveBeenCalled());
@@ -511,7 +518,7 @@ describe('Creating steps, applying a devfile', () => {
       await jest.advanceTimersByTimeAsync(MIN_STEP_DURATION_MS);
 
       await waitFor(() =>
-        expect(prepareDevfile).toHaveBeenCalledWith(devfile, factoryId, undefined, true),
+        expect(prepareDevfile).toHaveBeenCalledWith(devfile, factoryId, undefined, true, undefined),
       );
     });
 
@@ -534,7 +541,7 @@ describe('Creating steps, applying a devfile', () => {
       await jest.advanceTimersByTimeAsync(MIN_STEP_DURATION_MS);
 
       await waitFor(() =>
-        expect(prepareDevfile).toHaveBeenCalledWith(devfile, factoryId, undefined, true),
+        expect(prepareDevfile).toHaveBeenCalledWith(devfile, factoryId, undefined, true, undefined),
       );
     });
 
@@ -554,7 +561,13 @@ describe('Creating steps, applying a devfile', () => {
       await jest.advanceTimersByTimeAsync(MIN_STEP_DURATION_MS);
 
       await waitFor(() =>
-        expect(prepareDevfile).toHaveBeenCalledWith(devfile, factoryId, undefined, false),
+        expect(prepareDevfile).toHaveBeenCalledWith(
+          devfile,
+          factoryId,
+          undefined,
+          false,
+          undefined,
+        ),
       );
     });
   });
@@ -679,7 +692,7 @@ describe('Creating steps, applying a devfile', () => {
       expect(mockOnNextStep).not.toHaveBeenCalled();
       expect(mockOnError).not.toHaveBeenCalled();
 
-      expect(mockCreateWorkspaceFromDevfile).toHaveBeenCalledTimes(1);
+      await waitFor(() => expect(mockCreateWorkspaceFromDevfile).toHaveBeenCalledTimes(1));
     });
 
     test('action callback to continue with default devfile', async () => {

diff --git a/...components/WorkspaceProgress/CreatingSteps/Apply/Devfile/__tests__/prepareDevfile.spec.ts b/...components/WorkspaceProgress/CreatingSteps/Apply/Devfile/__tests__/prepareDevfile.spec.ts
@@ -226,5 +226,112 @@ describe('FactoryLoaderContainer/prepareDevfile', () => {
       expect(newDevfile.metadata.attributes?.[DEVWORKSPACE_STORAGE_TYPE_ATTR]).toBeUndefined();
       expect(newDevfile.attributes?.[DEVWORKSPACE_STORAGE_TYPE_ATTR]).toEqual('ephemeral');
     });
+
+    describe('has parent', () => {
+      describe('with registryUrl', () => {
+        it('with storage-type attribute', () => {
+          // mute console logs
+          console.warn = jest.fn();
+          const devfile = {
+            schemaVersion: '2.2.0',
+            metadata: {
+              name: 'wksp-test',
+            },
+            parent: {
+              id: 'nodejs',
+              registryUrl: 'https://registry.devfile.io/',
+            },
+          } as devfileApi.Devfile;
+
+          const newDevfile = prepareDevfile(devfile, factoryId, 'ephemeral', false, {
+            schemaVersion: '2.2.2',
+            metadata: {
+              generateName: 'nodejs',
+            },
+            attributes: {
+              'controller.devfile.io/storage-type': 'ephemeral',
+            },
+          } as devfileApi.Devfile);
+
+          expect(console.warn).toHaveBeenCalledWith(
+            'Unable to apply controller.devfile.io/storage-type attribute.',
+          );
+          expect(newDevfile.attributes?.[DEVWORKSPACE_STORAGE_TYPE_ATTR]).toBeUndefined();
+        });
+
+        it('without storage-type attribute', () => {
+          const devfile = {
+            schemaVersion: '2.2.0',
+            metadata: {
+              name: 'wksp-test',
+            },
+            parent: {
+              id: 'nodejs',
+              registryUrl: 'https://registry.devfile.io/',
+            },
+          } as devfileApi.Devfile;
+
+          const newDevfile = prepareDevfile(devfile, factoryId, 'ephemeral', false, {
+            schemaVersion: '2.2.2',
+            metadata: {
+              generateName: 'nodejs',
+            },
+          } as devfileApi.Devfile);
+
+          expect(newDevfile.attributes?.[DEVWORKSPACE_STORAGE_TYPE_ATTR]).toEqual('ephemeral');
+        });
+      });
+      describe('with uri', () => {
+        it('with storage-type attribute', () => {
+          // mute console logs
+          console.warn = jest.fn();
+          const devfile = {
+            schemaVersion: '2.2.0',
+            metadata: {
+              name: 'wksp-test',
+            },
+            parent: {
+              uri: 'https://raw.githubusercontent.com/test/devfile.yaml',
+            },
+          } as devfileApi.Devfile;
+
+          const newDevfile = prepareDevfile(devfile, factoryId, 'ephemeral', false, {
+            schemaVersion: '2.2.2',
+            metadata: {
+              generateName: 'nodejs',
+            },
+            attributes: {
+              'controller.devfile.io/storage-type': 'ephemeral',
+            },
+          } as devfileApi.Devfile);
+
+          expect(console.warn).toHaveBeenCalledWith(
+            'Unable to apply controller.devfile.io/storage-type attribute.',
+          );
+          expect(newDevfile.attributes?.[DEVWORKSPACE_STORAGE_TYPE_ATTR]).toBeUndefined();
+        });
+
+        it('without storage-type attribute', () => {
+          const devfile = {
+            schemaVersion: '2.2.0',
+            metadata: {
+              name: 'wksp-test',
+            },
+            parent: {
+              uri: 'https://raw.githubusercontent.com/test/devfile.yaml',
+            },
+          } as devfileApi.Devfile;
+
+          const newDevfile = prepareDevfile(devfile, factoryId, 'ephemeral', false, {
+            schemaVersion: '2.2.2',
+            metadata: {
+              generateName: 'nodejs',
+            },
+          } as devfileApi.Devfile);
+
+          expect(newDevfile.attributes?.[DEVWORKSPACE_STORAGE_TYPE_ATTR]).toEqual('ephemeral');
+        });
+      });
+    });
   });
 });
diff --git a/...dashboard-frontend/src/components/WorkspaceProgress/CreatingSteps/Apply/Devfile/index.tsx b/...dashboard-frontend/src/components/WorkspaceProgress/CreatingSteps/Apply/Devfile/index.tsx
@@ -45,6 +45,7 @@ import { RootState } from '@/store';
 import { selectDefaultDevfile } from '@/store/DevfileRegistries/selectors';
 import { selectFactoryResolver } from '@/store/FactoryResolver/selectors';
 import { selectDefaultNamespace } from '@/store/InfrastructureNamespaces/selectors';
+import { selectPvcStrategy } from '@/store/ServerConfig';
 import { workspacesActionCreators } from '@/store/Workspaces';
 import { selectDevWorkspaceWarnings } from '@/store/Workspaces/devWorkspaces/selectors';
 import { selectAllWorkspaces } from '@/store/Workspaces/selectors';
@@ -176,7 +177,7 @@ class CreatingStepApplyDevfile extends ProgressStep<Props, State> {
   private updateCurrentDevfile(devfile: devfileApi.Devfile): void {
     const { factoryResolver, allWorkspaces, defaultDevfile } = this.props;
     const { factoryParams } = this.state;
-    const { factoryId, policiesCreate, sourceUrl, storageType, remotes } = factoryParams;
+    const { factoryId, policiesCreate, sourceUrl, remotes } = factoryParams;
 
     // when using the default devfile instead of a user devfile
     if (factoryResolver === undefined && isEqual(devfile, defaultDevfile)) {
@@ -214,8 +215,16 @@ class CreatingStepApplyDevfile extends ProgressStep<Props, State> {
     // test the devfile name to decide if we need to append a suffix to is
     const nameConflict = allWorkspaces.some(w => devfile.metadata.name === w.name);
 
+    const storageType = factoryParams.storageType || this.props.preferredStorageType || undefined;
     const appendSuffix = policiesCreate === 'perclick' || nameConflict;
-    const updatedDevfile = prepareDevfile(devfile, factoryId, storageType, appendSuffix);
+    const parentDevfile = factoryResolver?.parentDevfile;
+    const updatedDevfile = prepareDevfile(
+      devfile,
+      factoryId,
+      storageType,
+      appendSuffix,
+      parentDevfile,
+    );
 
     this.setState({
       devfile: updatedDevfile,
@@ -465,6 +474,7 @@ const mapStateToProps = (state: RootState) => ({
   factoryResolver: selectFactoryResolver(state),
   defaultDevfile: selectDefaultDevfile(state),
   devWorkspaceWarnings: selectDevWorkspaceWarnings(state),
+  preferredStorageType: selectPvcStrategy(state),
 });
 
 const connector = connect(mapStateToProps, workspacesActionCreators, null, {

diff --git a/...d-frontend/src/components/WorkspaceProgress/CreatingSteps/Apply/Devfile/prepareDevfile.ts b/...d-frontend/src/components/WorkspaceProgress/CreatingSteps/Apply/Devfile/prepareDevfile.ts
@@ -31,6 +31,7 @@ export function prepareDevfile(
   factoryId: string,
   storageType: che.WorkspaceStorageType | undefined,
   appendSuffix: boolean,
+  parentDevfile?: devfileApi.Devfile | undefined,
 ): devfileApi.Devfile {
   const devfile = cloneDeep(_devfile);
   const attributes = DevfileAdapter.getAttributes(devfile);
@@ -60,8 +61,15 @@ export function prepareDevfile(
   devfile.metadata.name = sanitizeName(devfile.metadata.name);
 
   // propagate storage type
-  if (storageType === 'ephemeral') {
-    attributes[DEVWORKSPACE_STORAGE_TYPE_ATTR] = 'ephemeral';
+  if (storageType) {
+    attributes[DEVWORKSPACE_STORAGE_TYPE_ATTR] = storageType;
+  }
+  if (parentDevfile && attributes[DEVWORKSPACE_STORAGE_TYPE_ATTR]) {
+    const parentDevfileAttributes = DevfileAdapter.getAttributes(parentDevfile);
+    if (parentDevfileAttributes[DEVWORKSPACE_STORAGE_TYPE_ATTR]) {
+      delete attributes[DEVWORKSPACE_STORAGE_TYPE_ATTR];
+      console.warn(`Unable to apply ${DEVWORKSPACE_STORAGE_TYPE_ATTR} attribute.`);
+    }
   }
 
   return devfile;

diff --git a/...shboard-frontend/src/components/WorkspaceProgress/CreatingSteps/Apply/Resources/index.tsx b/...shboard-frontend/src/components/WorkspaceProgress/CreatingSteps/Apply/Resources/index.tsx
@@ -41,6 +41,7 @@ import { selectDevWorkspaceResources } from '@/store/DevfileRegistries/selectors
 import { factoryResolverActionCreators } from '@/store/FactoryResolver';
 import { selectFactoryResolver } from '@/store/FactoryResolver/selectors';
 import { selectDefaultNamespace } from '@/store/InfrastructureNamespaces/selectors';
+import { selectPvcStrategy } from '@/store/ServerConfig';
 import { workspacesActionCreators } from '@/store/Workspaces';
 import { selectDevWorkspaceWarnings } from '@/store/Workspaces/devWorkspaces/selectors';
 import { selectAllWorkspaces } from '@/store/Workspaces/selectors';
@@ -174,7 +175,7 @@ class CreatingStepApplyResources extends ProgressStep<Props, State> {
   protected async runStep(): Promise<boolean> {
     const { devWorkspaceResources } = this.props;
     const { factoryParams, shouldCreate, resources, warning } = this.state;
-    const { cheEditor, factoryId, sourceUrl, storageType, policiesCreate } = factoryParams;
+    const { cheEditor, factoryId, sourceUrl, policiesCreate } = factoryParams;
 
     if (warning) {
       const newName = `Warning: ${warning}`;
@@ -202,7 +203,7 @@ class CreatingStepApplyResources extends ProgressStep<Props, State> {
       return true;
     }
 
-    if (shouldCreate === false) {
+    if (!shouldCreate) {
       throw new Error('The workspace creation unexpectedly failed.');
     }
 
@@ -218,6 +219,7 @@ class CreatingStepApplyResources extends ProgressStep<Props, State> {
       );
       const appendSuffix = policiesCreate === 'perclick' || nameConflict;
 
+      const storageType = factoryParams.storageType || this.props.preferredStorageType || undefined;
       // create a workspace using pre-generated resources
       const [devWorkspace, devWorkspaceTemplate] = prepareResources(
         _resources,
@@ -297,6 +299,7 @@ const mapStateToProps = (state: RootState) => ({
   factoryResolver: selectFactoryResolver(state),
   devWorkspaceResources: selectDevWorkspaceResources(state),
   devWorkspaceWarnings: selectDevWorkspaceWarnings(state),
+  preferredStorageType: selectPvcStrategy(state),
 });
 
 const connector = connect(

diff --git a/...ontend/src/components/WorkspaceProgress/CreatingSteps/Apply/Resources/prepareResources.ts b/...ontend/src/components/WorkspaceProgress/CreatingSteps/Apply/Resources/prepareResources.ts
@@ -45,7 +45,7 @@ export default function prepareResources(
   }
 
   // set storage type attribute
-  if (storageType === 'ephemeral') {
+  if (storageType) {
     if (!devWorkspace.spec.template.attributes) {
       devWorkspace.spec.template.attributes = {};
     }

diff --git a/...dashboard-frontend/src/pages/WorkspaceDetails/OverviewTab/StorageType/__mocks__/index.tsx b/...dashboard-frontend/src/pages/WorkspaceDetails/OverviewTab/StorageType/__mocks__/index.tsx
@@ -16,11 +16,24 @@ import { Props } from '@/pages/WorkspaceDetails/OverviewTab/StorageType';
 
 export default class StorageTypeFormGroup extends React.PureComponent<Props> {
   render() {
-    return (
-      <div>
-        Mock Storage Type Form
-        <button onClick={() => this.props.onSave('per-workspace')}>Change storage type</button>
-      </div>
-    );
+    if (this.props.parentStorageType) {
+      return (
+        <div>
+          Mock Storage Type Form
+          <button disabled={true} onClick={() => this.props.onSave('per-workspace')}>
+            Change storage type
+          </button>
+          <span>StorageType: {this.props.storageType}</span>
+        </div>
+      );
+    } else {
+      return (
+        <div>
+          Mock Storage Type Form
+          <button onClick={() => this.props.onSave('per-workspace')}>Change storage type</button>
+          <span>StorageType: {this.props.storageType}</span>
+        </div>
+      );
+    }
   }
 }