fix: show the 'Downloading IDE binaries...' step only when needed (#1405)

* fix: show the 'Downloading IDE binaries...' step only when needed

Signed-off-by: Oleksii Orel <[email protected]>

Author: olexii4

packages/dashboard-frontend/src/components/WorkspaceProgress/StartingSteps/WorkspaceConditions/__tests__/helpers.spec.ts

@@ -0,0 +1,151 @@
+/*
+ * 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 {
+  EDITORS_WITHOUT_BINARIES,
+  hasDownloadBinaries,
+} from '@/components/WorkspaceProgress/StartingSteps/WorkspaceConditions/helpers';
+import { DEVWORKSPACE_CHE_EDITOR } from '@/services/devfileApi/devWorkspace/metadata';
+import { constructWorkspace } from '@/services/workspace-adapter';
+import { DevWorkspaceBuilder } from '@/store/__mocks__/devWorkspaceBuilder';
+
+describe('hasDownloadBinaries', () => {
+  let devWorkspaceBuilder: DevWorkspaceBuilder;
+
+  beforeAll(() => {
+    devWorkspaceBuilder = new DevWorkspaceBuilder();
+  });
+
+  it('should return false', () => {
+    const name = 'test';
+    const namespace = 'che-user';
+    const editorId = 'che-incubator/che-code/latest';
+    const workspaceWithEditorId = constructWorkspace(
+      devWorkspaceBuilder
+        .withMetadata({
+          name,
+          namespace,
+          annotations: {
+            [DEVWORKSPACE_CHE_EDITOR]: editorId,
+          },
+        })
+        .build(),
+    );
+
+    // if workspaces list is empty
+    expect(hasDownloadBinaries([], { namespace, workspaceName: name })).toEqual(false);
+    // if namespace is undefined
+    expect(
+      hasDownloadBinaries([workspaceWithEditorId], { namespace: undefined, workspaceName: name }),
+    ).toEqual(false);
+    // if workspaceName is undefined
+    expect(
+      hasDownloadBinaries([workspaceWithEditorId], { namespace, workspaceName: undefined }),
+    ).toEqual(false);
+    // skip if no target workspace found (wrong namespace)
+    expect(
+      hasDownloadBinaries([workspaceWithEditorId], {
+        namespace: 'wrong-namespace',
+        workspaceName: name,
+      }),
+    ).toEqual(false);
+    // skip if no target workspace found (wrong name)
+    expect(
+      hasDownloadBinaries([workspaceWithEditorId], { namespace, workspaceName: 'wrong-name' }),
+    ).toEqual(false);
+
+    // skip if editor name is in the list of editors without binaries
+    expect(
+      hasDownloadBinaries([workspaceWithEditorId], { namespace, workspaceName: name }),
+    ).toEqual(false);
+
+    const workspaceWithEditorDevfileEmptyContent = constructWorkspace(
+      devWorkspaceBuilder
+        .withMetadata({
+          name,
+          namespace,
+          annotations: {
+            [DEVWORKSPACE_CHE_EDITOR]: '',
+          },
+        })
+        .build(),
+    );
+    // skip if editor annotation is empty
+    expect(
+      hasDownloadBinaries([workspaceWithEditorDevfileEmptyContent], {
+        namespace,
+        workspaceName: name,
+      }),
+    ).toEqual(false);
+
+    const editorDevfileV2Content = 'schemaVersion: 2.2.0';
+    const workspaceWithEditorDevfileV2Content = constructWorkspace(
+      devWorkspaceBuilder
+        .withMetadata({
+          name,
+          namespace,
+          annotations: {
+            [DEVWORKSPACE_CHE_EDITOR]: editorDevfileV2Content,
+          },
+        })
+        .build(),
+    );
+    // skip if editor annotation contains the V2 devfile content
+    expect(
+      hasDownloadBinaries([workspaceWithEditorDevfileV2Content], {
+        namespace,
+        workspaceName: name,
+      }),
+    ).toEqual(false);
+
+    const editorDevfileV1Content = 'apiVersion: 1.0.0';
+    const workspaceWithEditorDevfileV1Content = constructWorkspace(
+      devWorkspaceBuilder
+        .withMetadata({
+          name,
+          namespace,
+          annotations: {
+            [DEVWORKSPACE_CHE_EDITOR]: editorDevfileV1Content,
+          },
+        })
+        .build(),
+    );
+    // skip if editor annotation contains the V1 devfile content
+    expect(
+      hasDownloadBinaries([workspaceWithEditorDevfileV1Content], {
+        namespace,
+        workspaceName: name,
+      }),
+    ).toEqual(false);
+  });
+
+  it('should return true', () => {
+    const name = 'test';
+    const namespace = 'che-user';
+    const editorId = 'che-incubator/che-idea-server/latest';
+    const workspace = constructWorkspace(
+      devWorkspaceBuilder
+        .withMetadata({
+          name,
+          namespace,
+          annotations: {
+            [DEVWORKSPACE_CHE_EDITOR]: editorId,
+          },
+        })
+        .build(),
+    );
+    // verify the list of editors without binaries
+    expect(EDITORS_WITHOUT_BINARIES).toEqual(['che-code']);
+    // if editor name is not in the list of editors without binaries
+    expect(hasDownloadBinaries([workspace], { namespace, workspaceName: name })).toEqual(true);
+  });
+});

packages/dashboard-frontend/src/components/WorkspaceProgress/StartingSteps/WorkspaceConditions/__tests__/index.spec.tsx

@@ -14,7 +14,9 @@
 
 import { screen, waitFor } from '@testing-library/react';
 import React from 'react';
+import { Provider } from 'react-redux';
 import { Location } from 'react-router-dom';
+import { Store } from 'redux';
 
 import {
   conditionChangedTo,
@@ -25,6 +27,7 @@ import {
 import { ConditionType } from '@/components/WorkspaceProgress/utils';
 import { WorkspaceRouteParams } from '@/Routes';
 import getComponentRenderer from '@/services/__mocks__/getComponentRenderer';
+import { MockStoreBuilder } from '@/store/__mocks__/mockStore';
 
 import StartingStepWorkspaceConditions from '..';
 
@@ -45,8 +48,11 @@ const matchParams: WorkspaceRouteParams = {
   workspaceName,
 };
 
+let store: Store;
+
 describe('Starting steps, checking workspace conditions', () => {
   beforeEach(() => {
+    store = new MockStoreBuilder().build();
     jest.useFakeTimers();
   });
 
@@ -168,19 +174,21 @@ describe('Starting steps, checking workspace conditions', () => {
 
 function getComponent(condition: ConditionType, _matchParams = matchParams): React.ReactElement {
   return (
-    <React.Fragment>
-      <StartingStepWorkspaceConditions
-        distance={0}
-        hasChildren={false}
-        condition={condition}
-        location={{} as Location}
-        navigate={jest.fn()}
-        matchParams={_matchParams}
-        onNextStep={mockOnNextStep}
-        onRestart={mockOnRestart}
-        onError={mockOnError}
-        onHideError={mockOnHideError}
-      />
-    </React.Fragment>
+    <Provider store={store}>
+      <React.Fragment>
+        <StartingStepWorkspaceConditions
+          distance={0}
+          hasChildren={false}
+          condition={condition}
+          location={{} as Location}
+          navigate={jest.fn()}
+          matchParams={_matchParams}
+          onNextStep={mockOnNextStep}
+          onRestart={mockOnRestart}
+          onError={mockOnError}
+          onHideError={mockOnHideError}
+        />
+      </React.Fragment>
+    </Provider>
   );
 }

packages/dashboard-frontend/src/components/WorkspaceProgress/StartingSteps/WorkspaceConditions/helpers.ts

@@ -0,0 +1,45 @@
+/*
+ * 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 { WorkspaceRouteParams } from '@/Routes';
+import { DEVWORKSPACE_CHE_EDITOR } from '@/services/devfileApi/devWorkspace/metadata';
+import { Workspace } from '@/services/workspace-adapter';
+
+export const EDITORS_WITHOUT_BINARIES = ['che-code'];
+
+export function hasDownloadBinaries(
+  allWorkspaces: Workspace[],
+  matchParams: WorkspaceRouteParams,
+): boolean {
+  const { namespace: targetNamespace, workspaceName: targetWorkspaceName } = matchParams;
+  // skip if target namespace or workspace name is empty or workspaces list is empty
+  if (!targetNamespace || !targetWorkspaceName || allWorkspaces.length === 0) {
+    return false;
+  }
+  // find target workspace
+  const targetWorkspace = allWorkspaces.find(
+    w => w.name === targetWorkspaceName && w.namespace === targetNamespace,
+  );
+  // skip if no target workspace found
+  if (!targetWorkspace) {
+    return false;
+  }
+  const cheEditor = targetWorkspace.ref.metadata.annotations?.[DEVWORKSPACE_CHE_EDITOR];
+  // skip if editor annotation empty or contains the devfile content
+  if (!cheEditor || cheEditor.startsWith('apiVersion') || cheEditor.startsWith('schemaVersion')) {
+    return false;
+  }
+  // extract editor name from annotation
+  const name = cheEditor.split('/')[1];
+  // check if editor is in the list of editors without binaries
+  return !EDITORS_WITHOUT_BINARIES.includes(name);
+}

packages/dashboard-frontend/src/components/WorkspaceProgress/StartingSteps/WorkspaceConditions/index.tsx

@@ -14,12 +14,14 @@ import common from '@eclipse-che/common';
 import { AlertVariant } from '@patternfly/react-core';
 import isEqual from 'lodash/isEqual';
 import React from 'react';
+import { connect, ConnectedProps } from 'react-redux';
 
 import {
   ProgressStep,
   ProgressStepProps,
   ProgressStepState,
 } from '@/components/WorkspaceProgress/ProgressStep';
+import { hasDownloadBinaries } from '@/components/WorkspaceProgress/StartingSteps/WorkspaceConditions/helpers';
 import styles from '@/components/WorkspaceProgress/StartingSteps/WorkspaceConditions/index.module.css';
 import { PureSubCondition } from '@/components/WorkspaceProgress/StartingSteps/WorkspaceConditions/PureSubCondition';
 import { ProgressStepTitle } from '@/components/WorkspaceProgress/StepTitle';
@@ -30,19 +32,22 @@ import {
 } from '@/components/WorkspaceProgress/utils';
 import { WorkspaceRouteParams } from '@/Routes';
 import { AlertItem, LoaderTab } from '@/services/helpers/types';
-
-export type Props = ProgressStepProps & {
-  condition: ConditionType;
-  matchParams: WorkspaceRouteParams;
-};
+import { RootState } from '@/store';
+import { selectAllWorkspaces } from '@/store/Workspaces';
+
+export type Props = ProgressStepProps &
+  MappedProps & {
+    condition: ConditionType;
+    matchParams: WorkspaceRouteParams;
+  };
 export type State = ProgressStepState & {
   isWarning: boolean;
   isReady: boolean;
   condition: ConditionType;
   subConditionTitle: string;
 };
 
-export default class StartingStepWorkspaceConditions extends ProgressStep<Props, State> {
+class StartingStepWorkspaceConditions extends ProgressStep<Props, State> {
   private timerId: number | undefined;
 
   constructor(props: Props) {
@@ -85,12 +90,12 @@ export default class StartingStepWorkspaceConditions extends ProgressStep<Props,
 
     // Show sub-condition only for DeploymentReady
     if (condition.type === 'DeploymentReady') {
-      // Show sub-condition after 20 seconds
-      this.timerId = window.setTimeout(() => {
+      const { allWorkspaces, matchParams } = this.props;
+      if (hasDownloadBinaries(allWorkspaces, matchParams)) {
         this.setState({
           subConditionTitle: 'Downloading IDE binaries... (it can take a few minutes)',
         });
-      }, 20000);
+      }
     }
   }
 
@@ -179,3 +184,11 @@ export default class StartingStepWorkspaceConditions extends ProgressStep<Props,
     );
   }
 }
+
+const connector = connect((state: RootState) => ({
+  allWorkspaces: selectAllWorkspaces(state),
+}));
+
+type MappedProps = ConnectedProps<typeof connector>;
+
+export default connector(StartingStepWorkspaceConditions);