Implement editors/devfile route

[dkwon17]

What does this PR do?

This PR adds a new route exposed by the dashboard backend:

What issues does this PR fix or reference?

eclipse-che/che#22994

Is it tested? How?

When testing on Eclipse Che, access the following link and verify that the che-code/latest devfile is returned:

<CHE-HOST>/dashboard/api/editors/devfile?che-editor=che-incubator/che-code/latest

If no che-editor query param is provided, then there is a 400 error:

<CHE-HOST>/dashboard/api/editors/devfile?che-editor=che-incubator/che-code/latest

If there is not editor with id che-editor, there is a 404 error:

<CHE-HOST>/dashboard/api/editors/devfile?che-editor=doesnotexist

Additionally, create this following devworkspace and verify that the workspace starts and verify that you can access the editor:

kind: DevWorkspace
apiVersion: workspace.devfile.io/v1alpha2
metadata:
  name: my-devworkspace
spec:
  routingClass: che
  started: true
  contributions:
    - name: ide
      uri: http://che-dashboard.eclipse-che.svc.cluster.local:8080/dashboard/api/editors/devfile?che-editor=che-incubator/che-code/latest
  template:
    projects:
      - name: my-project-name
        git:
          remotes:
            origin: https://github.com/eclipse-che/che-docs
    components:
      - name: tooling-container
        container:
          image: quay.io/devfile/universal-developer-image:ubi8-latest

Release Notes

Docs PR

[che-bot]

Click here to review and test in web IDE:

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 89.59%. Comparing base (28abf62) to head (64cb29d).

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #1134      +/-   ##
==========================================
- Coverage   89.61%   89.59%   -0.03%     
==========================================
  Files         411      411              
  Lines       41920    41982      +62     
  Branches     2809     2824      +15     
==========================================
+ Hits        37566    37613      +47     
- Misses       4329     4343      +14     
- Partials       25       26       +1     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[ibuziuk]

@dkwon17 great job. Are the custom editors going to be exposed as well if configured ?
eclipse-che/che-docs#2738

[dkwon17]

@ibuziuk thank you, yes, custom editors are also exposed and are accessible from the new endpoint

[ibuziuk]

LGTM, but it seems there is a linting error that should be fixed via yarn lint:fix

[github-actions]

Docker image build succeeded: quay.io/eclipse/che-dashboard:pr-1134

kubectl patch command

kubectl patch -n eclipse-che "checluster/eclipse-che" --type=json -p="[{"op": "replace", "path": "/spec/components/dashboard/deployment", "value": {containers: [{image: "quay.io/eclipse/che-dashboard:pr-1134", name: che-dashboard}]}}]"

[github-actions]

Docker image build succeeded: quay.io/eclipse/che-dashboard:pr-1134

kubectl patch command

kubectl patch -n eclipse-che "checluster/eclipse-che" --type=json -p="[{"op": "replace", "path": "/spec/components/dashboard/deployment", "value": {containers: [{image: "quay.io/eclipse/che-dashboard:pr-1134", name: che-dashboard}]}}]"

[dkwon17]

This was done in order to provide certain mock implementations for certain tests:

che-dashboard/packages/dashboard-backend/src/routes/api/__tests__/editors.spec.ts

Line 67 in 64cb29d

(getDevWorkspaceClient as jest.Mock).mockImplementation(() => {

[ibuziuk]

@dkwon17 please, also contribute to the docs - https://eclipse.dev/che/docs/next/administration-guide/configuring-editors-definitions/

[dkwon17]

@ibuziuk here is the docs PR: eclipse-che/che-docs#2747

[openshift-ci]

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: dkwon17, ibuziuk, olexii4

The full list of commands accepted by this bot can be found here.

Needs approval from an approver in each of these files:

• OWNERS

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

[ibuziuk]

@dkwon17 I believe we are good to merge together withhttps://github.com/eclipse-che/che-docs/pull/2747

[devstudio-release]

Build 3.15 :: dashboard_3.x/501: Console, Changes, Git Data

[devstudio-release]

Build 3.15 :: sync-to-downstream_3.x/6955: Console, Changes, Git Data

[devstudio-release]

Build 3.15 :: get-sources-rhpkg-container-build_3.x/6903: Console, Changes, Git Data