feat: add an ability to show provider info into a sample

Signed-off-by: Oleksii Orel <oorel@redhat.com>
eclipse-che · Oct 23, 2024 · 3efe8ae · 3efe8ae
1 parent 5252f8c
commit 3efe8ae
Show file tree

Hide file tree

Showing 16 changed files with 1,656 additions and 20 deletions.
diff --git a/.deps/EXCLUDED/prod.md b/.deps/EXCLUDED/prod.md
@@ -13,6 +13,7 @@ This file lists dependencies that do not need CQs or auto-detection does not wor
 | `fast-uri@2.4.0` | [clearlydefined](https://clearlydefined.io/definitions/npm/npmjs/-/fast-uri/2.4.0) |
 | `fastify@5.0.0` | [clearlydefined](https://clearlydefined.io/definitions/npm/npmjs/-/fastify/5.0.0) |
 | `glob@11.0.0` | [clearlydefined](https://clearlydefined.io/definitions/npm/npmjs/-/glob/11.0.0) |
+| `hast-util-to-jsx-runtime@2.3.2` | [clearlydefined](https://clearlydefined.io/definitions/npm/npmjs/-/hast-util-to-jsx-runtime/2.3.2) |
 | `jsep@1.3.9` | [clearlydefined](https://clearlydefined.io/definitions/npm/npmjs/-/jsep/1.3.9) |
 | `real-require@0.2.0` | [clearlydefined](https://clearlydefined.io/definitions/npm/npmjs/-/real-require/0.2.0) |
 | `light-my-request@6.0.0` | [clearlydefined](https://clearlydefined.io/definitions/npm/npmjs/-/light-my-request/6.0.0) |
diff --git a/.deps/dev.md b/.deps/dev.md
@@ -91,7 +91,6 @@
 | [`@types/babel__template@7.4.3`](https://github.com/DefinitelyTyped/DefinitelyTyped.git) | MIT | clearlydefined |
 | [`@types/babel__traverse@7.20.3`](https://github.com/DefinitelyTyped/DefinitelyTyped.git) | MIT | #8935 |
 | [`@types/eslint@8.44.6`](https://github.com/DefinitelyTyped/DefinitelyTyped.git) | MIT | #9382 |
-| [`@types/estree@1.0.4`](https://github.com/DefinitelyTyped/DefinitelyTyped.git) | MIT | #8266 |
 | [`@types/estree@1.0.5`](https://github.com/DefinitelyTyped/DefinitelyTyped.git) | MIT | #8266 |
 | [`@types/fs-extra@11.0.3`](https://github.com/DefinitelyTyped/DefinitelyTyped.git) | MIT | clearlydefined |
 | [`@types/graceful-fs@4.1.8`](https://github.com/DefinitelyTyped/DefinitelyTyped.git) | MIT | clearlydefined |
@@ -129,7 +128,6 @@
 | [`@typescript-eslint/typescript-estree@6.10.0`](https://github.com/typescript-eslint/typescript-eslint.git) | BSD-2-Clause | #14423 |
 | [`@typescript-eslint/utils@6.10.0`](https://github.com/typescript-eslint/typescript-eslint.git) | MIT | clearlydefined |
 | [`@typescript-eslint/visitor-keys@6.10.0`](https://github.com/typescript-eslint/typescript-eslint.git) | MIT | clearlydefined |
-| [`@ungap/structured-clone@1.2.0`](git+https://github.com/ungap/structured-clone.git) | ISC | clearlydefined |
 | [`@webassemblyjs/ast@1.12.1`](https://github.com/xtuc/webassemblyjs.git) | MIT | clearlydefined |
 | [`@webassemblyjs/floating-point-hex-parser@1.11.6`](https://github.com/xtuc/webassemblyjs.git) | MIT | #7959 |
 | [`@webassemblyjs/helper-api-error@1.11.6`](https://github.com/xtuc/webassemblyjs.git) | MIT | #7969 |
@@ -259,7 +257,6 @@
 | [`define-data-property@1.1.1`](git+https://github.com/ljharb/define-data-property.git) | MIT | #10591 |
 | `define-lazy-prop@3.0.0` | MIT | clearlydefined |
 | [`define-properties@1.2.1`](git://github.com/ljharb/define-properties.git) | MIT | #7116 |
-| `dequal@2.0.3` | MIT | clearlydefined |
 | `detect-indent@5.0.0` | MIT | clearlydefined |
 | `detect-newline@3.1.0` | MIT | clearlydefined |
 | [`diff-sequences@29.6.3`](https://github.com/jestjs/jest.git) | MIT | clearlydefined |

diff --git a/.deps/prod.md b/.deps/prod.md
diff --git a/packages/dashboard-backend/src/constants/examples.ts b/packages/dashboard-backend/src/constants/examples.ts
@@ -67,6 +67,9 @@ export const devWorkspaceResourcesExample = {
         displayName: 'VS Code - Open Source',
         name: 'che-code',
         tags: ['Tech-Preview'],
+        attributes: {
+          title: 'VS Code - Open Source',
+        },
       },
       commands: [
         {

diff --git a/packages/dashboard-frontend/jest.setup.tsx b/packages/dashboard-frontend/jest.setup.tsx
@@ -38,3 +38,9 @@ jest.mock('@/components/CheTooltip', () => {
     }),
   };
 });
+
+jest.mock('react-markdown', () => {
+  return jest.fn(props => {
+    return React.createElement('div', null, props.children, props.content);
+  });
+});
diff --git a/packages/dashboard-frontend/package.json b/packages/dashboard-frontend/package.json
@@ -55,6 +55,7 @@
     "react-copy-to-clipboard": "^5.1.0",
     "react-dom": "^18.3.1",
     "react-helmet": "^6.1.0",
+    "react-markdown": "^9.0.1",
     "react-pluralize": "^1.6.3",
     "react-redux": "^7.2.9",
     "react-router-dom": "^6.26.1",

diff --git a/...s/dashboard-frontend/src/components/EditorSelector/Gallery/Entry/__tests__/index.spec.tsx b/...s/dashboard-frontend/src/components/EditorSelector/Gallery/Entry/__tests__/index.spec.tsx
@@ -143,6 +143,17 @@ describe('Editor Selector Entry', () => {
     });
   });
 
+  describe('provider info', () => {
+    test('show text', () => {
+      renderComponent(
+        editorGroup[0].id,
+        [...editorGroup].map(editor => Object.assign({}, editor, { provider: 'Provided by...' })),
+      );
+
+      expect(screen.queryByText('Provided by...')).not.toBeNull();
+    });
+  });
+
   describe('props change', () => {
     test('sibling editor ID provided later', () => {
       const { reRenderComponent } = renderComponent(editorGroup[0].id, editorGroup);

diff --git a/packages/dashboard-frontend/src/components/EditorSelector/Gallery/Entry/index.tsx b/packages/dashboard-frontend/src/components/EditorSelector/Gallery/Entry/index.tsx
@@ -22,6 +22,7 @@ import {
 } from '@patternfly/react-core';
 import { CheckIcon } from '@patternfly/react-icons';
 import React from 'react';
+import ReactMarkdown from 'react-markdown';
 
 import styles from '@/components/EditorSelector/Gallery/Entry/index.module.css';
 import { TagLabel } from '@/components/TagLabel';
@@ -79,11 +80,13 @@ export class EditorSelectorEntry extends React.PureComponent<Props, State> {
   }
 
   private handleCardClick(event: React.MouseEvent) {
-    event.preventDefault();
-
     const { selectedId, onSelect } = this.props;
     const { activeEditor } = this.state;
 
+    if (!activeEditor.provider) {
+      event.preventDefault();
+    }
+
     if (activeEditor.id === selectedId) {
       return;
     }
@@ -199,6 +202,11 @@ export class EditorSelectorEntry extends React.PureComponent<Props, State> {
         </CardHeader>
         <CardBody>
           <span className={titleClassName}>{groupName}</span>
+          {activeEditor.provider && (
+            <div style={{ fontSize: '75%' }}>
+              <ReactMarkdown>{activeEditor.provider}</ReactMarkdown>
+            </div>
+          )}
         </CardBody>
       </Card>
     );

diff --git a/packages/dashboard-frontend/src/services/models/che.ts b/packages/dashboard-frontend/src/services/models/che.ts
@@ -29,6 +29,7 @@ export interface Plugin {
   type: string;
   version: string;
   description?: string;
+  provider?: string;
   links: {
     devfile: string;
   };

diff --git a/...ard-frontend/src/store/Plugins/chePlugins/__tests__/helpers.convertToEditorPlugin.spec.ts b/...ard-frontend/src/store/Plugins/chePlugins/__tests__/helpers.convertToEditorPlugin.spec.ts
@@ -78,8 +78,7 @@ describe('convertToEditorPlugin', () => {
     const plugin = convertToEditorPlugin(editor);
 
     expect(plugin).toEqual({
-      description:
-        'Microsoft Visual Studio Code - Open Source IDE for Eclipse Che - Insiders build',
+      description: 'Open Source IDE for Eclipse Che....',
       displayName: 'VS Code - Open Source',
       icon: `<svg width="100" height="100" viewBox="0 0 100 100" fill="none" xmlns="http://www.w3.org/2000/svg"></svg>`,
       iconMediatype: 'image/svg+xml',
@@ -88,6 +87,7 @@ describe('convertToEditorPlugin', () => {
         devfile: '',
       },
       name: 'che-code',
+      provider: 'Provided by ....',
       publisher: 'che-incubator',
       tags: ['Tech-Preview'],
       type: 'Che Editor',
@@ -123,11 +123,11 @@ function getEditor(): devfileApi.Devfile {
         iconMediatype: 'image/svg+xml',
         publisher: 'che-incubator',
         repository: 'https://github.com/che-incubator/che-code',
-        title: 'Microsoft Visual Studio Code - Open Source IDE for Eclipse Che - Insiders build',
+        title: 'Open Source IDE for Eclipse Che ....',
         version: 'insiders',
+        provider: 'Provided by ....',
       },
-      description:
-        'Microsoft Visual Studio Code - Open Source IDE for Eclipse Che - Insiders build',
+      description: 'Open Source IDE for Eclipse Che....',
       displayName: 'VS Code - Open Source',
       name: 'che-code',
       tags: ['Tech-Preview'],

diff --git a/packages/dashboard-frontend/src/store/Plugins/chePlugins/helpers.ts b/packages/dashboard-frontend/src/store/Plugins/chePlugins/helpers.ts
@@ -22,7 +22,7 @@ export function convertToEditorPlugin(editor: devfileApi.Devfile): che.Plugin {
   ) {
     throw new Error('Invalid editor metadata');
   }
-  return {
+  const plugin: che.Plugin = {
     id:
       editor.metadata.attributes.publisher +
       '/' +
@@ -42,4 +42,10 @@ export function convertToEditorPlugin(editor: devfileApi.Devfile): che.Plugin {
     icon: editor.metadata.attributes.iconData,
     iconMediatype: editor.metadata.attributes.iconMediatype,
   };
+
+  if (editor.metadata.attributes?.provider) {
+    plugin.provider = editor.metadata.attributes.provider;
+  }
+
+  return plugin;
 }
diff --git a/scripts/yarn/old_version/.deps/EXCLUDED/prod.md b/scripts/yarn/old_version/.deps/EXCLUDED/prod.md
@@ -13,6 +13,7 @@ This file lists dependencies that do not need CQs or auto-detection does not wor
 | `fast-uri@2.4.0` | [clearlydefined](https://clearlydefined.io/definitions/npm/npmjs/-/fast-uri/2.4.0) |
 | `fastify@5.0.0` | [clearlydefined](https://clearlydefined.io/definitions/npm/npmjs/-/fastify/5.0.0) |
 | `glob@11.0.0` | [clearlydefined](https://clearlydefined.io/definitions/npm/npmjs/-/glob/11.0.0) |
+| `hast-util-to-jsx-runtime@2.3.2` | [clearlydefined](https://clearlydefined.io/definitions/npm/npmjs/-/hast-util-to-jsx-runtime/2.3.2) |
 | `jsep@1.3.9` | [clearlydefined](https://clearlydefined.io/definitions/npm/npmjs/-/jsep/1.3.9) |
 | `real-require@0.2.0` | [clearlydefined](https://clearlydefined.io/definitions/npm/npmjs/-/real-require/0.2.0) |
 | `light-my-request@6.0.0` | [clearlydefined](https://clearlydefined.io/definitions/npm/npmjs/-/light-my-request/6.0.0) |
diff --git a/scripts/yarn/old_version/.deps/dev.md b/scripts/yarn/old_version/.deps/dev.md
@@ -99,7 +99,7 @@
 | [`@types/babel__template@7.4.3`](https://github.com/DefinitelyTyped/DefinitelyTyped.git) | MIT | clearlydefined |
 | [`@types/babel__traverse@7.20.3`](https://github.com/DefinitelyTyped/DefinitelyTyped.git) | MIT | #8935 |
 | [`@types/eslint@8.44.6`](https://github.com/DefinitelyTyped/DefinitelyTyped.git) | MIT | #9382 |
-| [`@types/estree@1.0.5`](https://github.com/DefinitelyTyped/DefinitelyTyped.git) | MIT | #8266 |
+| [`@types/estree@1.0.4`](https://github.com/DefinitelyTyped/DefinitelyTyped.git) | MIT | #8266 |
 | [`@types/fs-extra@11.0.3`](https://github.com/DefinitelyTyped/DefinitelyTyped.git) | MIT | clearlydefined |
 | [`@types/graceful-fs@4.1.8`](https://github.com/DefinitelyTyped/DefinitelyTyped.git) | MIT | clearlydefined |
 | [`@types/history@4.7.11`](https://github.com/DefinitelyTyped/DefinitelyTyped.git) | MIT | clearlydefined |
@@ -136,7 +136,6 @@
 | [`@typescript-eslint/typescript-estree@6.10.0`](https://github.com/typescript-eslint/typescript-eslint.git) | BSD-2-Clause | #14423 |
 | [`@typescript-eslint/utils@6.10.0`](https://github.com/typescript-eslint/typescript-eslint.git) | MIT | clearlydefined |
 | [`@typescript-eslint/visitor-keys@6.10.0`](https://github.com/typescript-eslint/typescript-eslint.git) | MIT | clearlydefined |
-| [`@ungap/structured-clone@1.2.0`](git+https://github.com/ungap/structured-clone.git) | ISC | clearlydefined |
 | [`@webassemblyjs/ast@1.12.1`](https://github.com/xtuc/webassemblyjs.git) | MIT | clearlydefined |
 | [`@webassemblyjs/floating-point-hex-parser@1.11.6`](https://github.com/xtuc/webassemblyjs.git) | MIT | #7959 |
 | [`@webassemblyjs/helper-api-error@1.11.6`](https://github.com/xtuc/webassemblyjs.git) | MIT | #7969 |
@@ -255,7 +254,6 @@
 | [`define-data-property@1.1.1`](git+https://github.com/ljharb/define-data-property.git) | MIT | #10591 |
 | [`define-lazy-prop@3.0.0`](https://github.com/sindresorhus/define-lazy-prop.git) | MIT | clearlydefined |
 | [`define-properties@1.2.1`](git://github.com/ljharb/define-properties.git) | MIT | #7116 |
-| [`dequal@2.0.3`](https://github.com/lukeed/dequal.git) | MIT | clearlydefined |
 | [`detect-indent@5.0.0`](https://github.com/sindresorhus/detect-indent.git) | MIT | clearlydefined |
 | [`detect-newline@3.1.0`](https://github.com/sindresorhus/detect-newline.git) | MIT | clearlydefined |
 | [`diff-sequences@29.6.3`](https://github.com/jestjs/jest.git) | MIT | clearlydefined |