Fix editor update flow

[olexii4]

What does this PR do?

This PR fixes the editor update flow and changes the approach of how to store editorYamlUrl variable in the devworkspace.metadata.annotations[REGISTRY_URL].
The existing implementation allows using editorId instead of URL.
With these changes, a correct API request http://127.0.0.1:8080/dashboard/api/editors/devfile?che-editor=${editorId} will be stored instead of an editorID.

What issues does this PR fix or reference?

fixes https://issues.redhat.com/browse/CRW-7936

Is it tested? How?

1. Deploy Eclipse-Che with the image from this PR.
2. Create a new workspace from the source:

https://github.com/eclipse-che/che-dashboard.git

3. Stop the workspace. Open Swagger: {che-server}/dashboard/api/swagger.
   Use Devworkspace Template API and find the templateName.
4. Modify(remove field /spec/commands) the target template with the next patch:

[
  {
    "op": "replace",
    "path": "/spec/commands",
    "value": []
  }
]

5. Check the target template. The field /spec/commands should be empty.
6. Start the target workspace. Check the additional request with the template/spec data:
   
7. Check the target template. The field /spec/commands should be restored.

[che-bot]

Click here to review and test in web IDE:

[github-actions]

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

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-1310", name: che-dashboard}]}}]"

[codecov]

Codecov Report

Attention: Patch coverage is 84.21053% with 12 lines in your changes missing coverage. Please review.

Project coverage is 91.76%. Comparing base (1635623) to head (9a617d5).
Report is 2 commits behind head on main.

Files with missing lines	Patch %	Lines
...orkspace-client/devworkspace/devWorkspaceClient.ts	77.35%	12 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #1310      +/-   ##
==========================================
+ Coverage   91.68%   91.76%   +0.08%     
==========================================
  Files         500      501       +1     
  Lines       45482    45532      +50     
  Branches     3164     3179      +15     
==========================================
+ Hits        41700    41784      +84     
+ Misses       3754     3715      -39     
- Partials       28       33       +5     

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

[ibuziuk]

@olexii4 could you clarify this change please?

[olexii4]

@ibuziuk The previous implementation allowed assigning editorId to a field named "editorYamlUrl". Based on the variable name 'editorYamlUrl', it is unexpected to have the value editorId there.

This misunderstanding led to an error. That is why I changed the implementation to use URLs instead of IDs.

This URL http://127.0.0.1:8080/dashboard/api/editors/devfile?che-editor=${editorId} is a part of dashboard API, which returns the editor devfile by ID. You can test it with dashboard swagger:

For example, an HTTP POST request {che-server}/dashboard/api/data/resolver with JSON data

{
  "url": "http://127.0.0.1:8080/dashboard/api/editors/devfile?che-editor=che-incubator/che-code/latest"
}

PS
This request will be sent if we don't have the proper editor in the redux store.

[svor]

@olexii4
I've tested the PR according to the description, and it works as expected.
Could you clarify the root cause of why the template wasn't patched with editorId?

Based on the variable name 'editorYamlUrl', it is unexpected to have the value editorId there.

I’d prefer to avoid hardcoding the API URL here. Would it make sense to rename the variable while still using editorId?

[github-actions]

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

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-1310", name: che-dashboard}]}}]"

[olexii4]

Could you clarify the root cause of why the template wasn't patched with editorId?

@svor The main reason was an error while converting devfile into the devworkspace template. The previous implementation worked well because we got a new editor devfile object before converting it into the devworkspace template. The existing implementation tried to change the editor devfile object in the redux store.

[svor]

lgtm

[ibuziuk]

@olexii4 👍 LGTM
once approved by @dmytro-ndp please, backport to 7.98.x for 3.19

[openshift-ci]

[APPROVALNOTIFIER] This PR is NOT APPROVED

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

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

[dmytro-ndp]

@olexii4, @ibuziuk : hello,
What do you think about verifying this PR using the version upgrade flow?
For example:

1. Install Eclipse Che 7.98.x.
2. Create a few workspaces.
3. Update the Eclipse Che instance to the next version, with quay.io/eclipse/che-dashboard:pr-1310 on board.
4. Start the old test workspaces and ensure the VS Code Editor version has been upgraded to the Eclipse Che next version

[olexii4]

@olexii4, @ibuziuk : hello, What do you think about verifying this PR using the version upgrade flow? For example:

1. Install Eclipse Che 7.98.x.
2. Create a few workspaces.
3. Update the Eclipse Che instance to the next version, with quay.io/eclipse/che-dashboard:pr-1310 on board.
4. Start the old test workspaces and ensure the VS Code Editor version has been upgraded to the Eclipse Che next version

This is a brilliant idea. But it's not that simple.
Note: The editors are stored in a namespaced ConfigMap. We have to update them.