fix: allow the extensions to authenticate #339

vitaliy-guliy · 2024-03-20T12:35:38Z

What does this PR do?

It is possible to specify trusted extensions, which can authenticate using your GitHub account by specifying the extensions identifiers in VSCODE_TRUSTED_EXTENSIONS environment variable.

      env:
        - name: VSCODE_TRUSTED_EXTENSIONS
          value: "github.copilot,github.copilot-chat"

VS Code launcher will take the content of the environment variable and will create corresponding trustedExtensionAuthAccess section in product.json

	"trustedExtensionAuthAccess": [
		"github.copilot",
		"github.copilot-chat"
	]

Having that, the extensions can easily authenticate without prompting the user.

let session = await vscode.authentication.getSession('github', scopes, { silent: true });

It is helpful especially if the extension does not provide additional options like this

let session = await vscode.authentication.getSession('github', scopes, { createIfNone: true });

What issues does this PR fix?

eclipse-che/che#22781

How to test this PR?

!Note: for the purity of the experiment it is recommended to cleanup the browser database.
(Open browser Developer tools, switch to Application tab and remove everything in IndexedDB storage)

Create a workspace with

https://github.com/vitaliy-guliy/recommended-extensions-sample?che-editor=https://gist.githubusercontent.com/vitaliy-guliy/1d4e35e3f6be3b109d4d62948b24b8c6/raw/b975b63aaa5475d3f8442d690353c3c00c9fb864/editor.yaml

or with

https://gist.githubusercontent.com/vitaliy-guliy/baba9c6391f5dc6590b9e7902fdfa6f7/raw/11e46945583df4ccfbb070980ef84c5b993c2671/devfile.yaml?che-editor=https://gist.githubusercontent.com/vitaliy-guliy/1d4e35e3f6be3b109d4d62948b24b8c6/raw/b975b63aaa5475d3f8442d690353c3c00c9fb864/editor.yaml

Perform GitHub: Device Authentication
Download both extensions to your laptop

Open Extensions view, install the extensions

Both extensions should work.

You can check /checode/checode-linux-libc/ubi8/product.json file as well to be sure the trustedExtensionAuthAccess section is added at the end of the file.

Does this PR contain changes that override default upstream Code-OSS behavior?

the PR contains changes in the code folder (you can skip it if your changes are placed in a che extension )
the corresponding items were added to the CHANGELOG.md file
rules for automatic git rebase were added to the .rebase folder

Signed-off-by: vitaliy-guliy <vgulyy@redhat.com>

github-actions · 2024-03-20T12:35:50Z

Click here to review and test in web IDE:

github-actions · 2024-03-20T12:38:15Z

Pull Request Dev image published:
👉 quay.io/che-incubator-pull-requests/che-code-dev:pr-339-dev-amd64

github-actions · 2024-03-20T13:36:21Z

Pull Request Che-Code image published:
👉 quay.io/che-incubator-pull-requests/che-code:pr-339-amd64

Signed-off-by: vitaliy-guliy <vgulyy@redhat.com>

github-actions · 2024-03-20T14:43:36Z

Pull Request Dev image published:
👉 quay.io/che-incubator-pull-requests/che-code-dev:pr-339-dev-amd64

github-actions · 2024-03-20T15:40:07Z

Pull Request Che-Code image published:
👉 quay.io/che-incubator-pull-requests/che-code:pr-339-amd64

Signed-off-by: vitaliy-guliy <vgulyy@redhat.com>

github-actions · 2024-03-20T16:26:38Z

Pull Request Dev image published:
👉 quay.io/che-incubator-pull-requests/che-code-dev:pr-339-dev-amd64

github-actions · 2024-03-20T17:24:16Z

Pull Request Che-Code image published:
👉 quay.io/che-incubator-pull-requests/che-code:pr-339-amd64

Signed-off-by: vitaliy-guliy <vgulyy@redhat.com>

github-actions · 2024-03-21T09:59:27Z

Pull Request Dev image published:
👉 quay.io/che-incubator-pull-requests/che-code-dev:pr-339-dev-amd64

github-actions · 2024-03-21T10:58:12Z

Pull Request Che-Code image published:
👉 quay.io/che-incubator-pull-requests/che-code:pr-339-amd64

github-actions · 2024-03-21T13:43:48Z

Pull Request Dev image published:
👉 quay.io/che-incubator-pull-requests/che-code-dev:pr-339-dev-amd64

github-actions · 2024-03-21T14:43:40Z

Pull Request Che-Code image published:
👉 quay.io/che-incubator-pull-requests/che-code:pr-339-amd64

github-actions · 2024-03-21T15:34:19Z

Pull Request Dev image published:
👉 quay.io/che-incubator-pull-requests/che-code-dev:pr-339-dev-amd64

github-actions · 2024-03-21T16:31:22Z

Pull Request Che-Code image published:
👉 quay.io/che-incubator-pull-requests/che-code:pr-339-amd64

Signed-off-by: vitaliy-guliy <vgulyy@redhat.com>

github-actions · 2024-03-22T16:17:47Z

Pull Request Dev image published:
👉 quay.io/che-incubator-pull-requests/che-code-dev:pr-339-dev-amd64

Signed-off-by: vitaliy-guliy <vgulyy@redhat.com>

github-actions · 2024-03-22T19:16:15Z

Pull Request Che-Code image published:
👉 quay.io/che-incubator-pull-requests/che-code:pr-339-amd64

github-actions · 2024-03-22T19:29:22Z

Pull Request Dev image published:
👉 quay.io/che-incubator-pull-requests/che-code-dev:pr-339-dev-amd64

Signed-off-by: vitaliy-guliy <vgulyy@redhat.com>

github-actions · 2024-03-22T20:13:58Z

Pull Request Dev image published:
👉 quay.io/che-incubator-pull-requests/che-code-dev:pr-339-dev-amd64

github-actions · 2024-03-22T21:12:36Z

Pull Request Che-Code image published:
👉 quay.io/che-incubator-pull-requests/che-code:pr-339-amd64

Signed-off-by: vitaliy-guliy <vgulyy@redhat.com>

github-actions · 2024-03-22T22:20:05Z

Pull Request Dev image published:
👉 quay.io/che-incubator-pull-requests/che-code-dev:pr-339-dev-amd64

RomanNikitenko

Tested: I was able to generate a test and use explain function of the extension

Great job, @vitaliy-guliy !

launcher/src/trusted-extensions.ts

Signed-off-by: vitaliy-guliy <vgulyy@redhat.com>

github-actions · 2024-03-28T17:02:02Z

Pull Request Dev image published:
👉 quay.io/che-incubator-pull-requests/che-code-dev:pr-339-dev-amd64

launcher/src/trusted-extensions.ts

RomanNikitenko · 2024-03-28T17:15:08Z

launcher/src/trusted-extensions.ts

+      }
+
+      if (!extensions.length) {
+        console.log('  > env.VSCODE_TRUSTED_EXTENSIONS does not specify any extension');


I think it makes sense to add the value of the variable to the log
Let's say another separator is applied by a user, then:

I agree that extensions array is empty

but env.VSCODE_TRUSTED_EXTENSIONS does not specify any extension is NOT true

so it makes sense to clarify it in logs, this way it would help to identify and resolve the problem quickly

User specified env.VSCODE_TRUSTED_EXTENSIONS in his devfile.
Launcher says that env.VSCODE_TRUSTED_EXTENSIONS is wrong.
No need here to duplicate the value.

From the other side, if you have an idea, please share it.

yes, Launcher says that env.VSCODE_TRUSTED_EXTENSIONS is wrong.
but the launcher says nothing about:

what value of the variable the launcher has got

what could be wrong

what is expected

You use here , as a separator for the VSCODE_TRUSTED_EXTENSIONS env var,
but, for example, PATH env variable uses : as a separator

If a user uses : as a separator (just out of habit) for the VSCODE_TRUSTED_EXTENSIONS then:

VSCODE_TRUSTED_EXTENSIONS is defined, it's not empty, it contains extensions

but it doesn't work and there is nothing helpful in logs - isn't it?

My propose was just clarify it in logs - like - if the logic can not handle the variable - then it should be clear:

env variable VSCODE_TRUSTED_EXTENSIONS has some value here =>

using , as a separator to parse extensions =>

can not parse extensions, so the value of VSCODE_TRUSTED_EXTENSIONS will be ignored =>

the expected format of the VSCODE_TRUSTED_EXTENSIONS is: some-value,another-value

============
anyway I've approved your pull request yesterday, these changes are minor, it's up to you
so feel free to merge the pull request as soon as you believe it's good enough

Have just played with it and would say, that the cheapest way in case of errors is to print the current value of VSCODE_TRUSTED_EXTENSIONS environment variable and explain that it should contain one or several extension identifiers divided by comma.

It's for the first step.
The next, I think we should document the functionality provided by launcher. Among them, ability to configure trusted extensions, location of Open VSX registry, webviews, etc.

The output with one failed extension

# Configuring Trusted Extensions... > env.VSCODE_TRUSTED_EXTENSIONS is set to [redhat.yaml,redhat.openshift,red hat.java] > add redhat.yaml > add redhat.openshift > failure to add [red hat.java] because of wrong identifier

The output when the variable does not specify anything

# Configuring Trusted Extensions... > env.VSCODE_TRUSTED_EXTENSIONS is set to [,,,] > ERROR: The variable provided most likely has wrong format. It should specify one or more extensions separated by comma.

launcher/src/trusted-extensions.ts

github-actions · 2024-03-28T18:05:36Z

Pull Request Che-Code image published:
👉 quay.io/che-incubator-pull-requests/che-code:pr-339-amd64

Signed-off-by: vitaliy-guliy <vgulyy@redhat.com>

github-actions · 2024-03-28T18:49:23Z

Pull Request Dev image published:
👉 quay.io/che-incubator-pull-requests/che-code-dev:pr-339-dev-amd64

github-actions · 2024-03-28T20:03:29Z

Pull Request Che-Code image published:
👉 quay.io/che-incubator-pull-requests/che-code:pr-339-amd64

ibuziuk

great job
@vitaliy-guliy please, add relevant documentation about the new env var

musienko-maxim · 2024-04-01T13:03:28Z

Was checked on the DevSpaces based on 3.12 @ 0dc45 #10 :: Eclipse Che Dashboard 7.82.0 @ 896c. Worked as expected!

Signed-off-by: vitaliy-guliy <vgulyy@redhat.com>

github-actions · 2024-04-02T22:36:41Z

Pull Request Dev image published:
👉 quay.io/che-incubator-pull-requests/che-code-dev:pr-339-dev-amd64

github-actions · 2024-04-02T23:34:58Z

Pull Request Che-Code image published:
👉 quay.io/che-incubator-pull-requests/che-code:pr-339-amd64

devstudio-release · 2024-04-03T08:10:24Z

Build 3.13 :: code_3.x/1323: Console, Changes, Git Data

devstudio-release · 2024-04-03T08:17:47Z

Build 3.13 :: sync-to-downstream_3.x/6391: Console, Changes, Git Data

devstudio-release · 2024-04-03T08:24:30Z

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

devstudio-release · 2024-04-03T14:09:11Z

Build 3.13 :: get-sources-rhpkg-container-build_3.x/6353:

code : 3.x ::
; copied to quay

fix: the extension should get a session

9da511a

Signed-off-by: vitaliy-guliy <vgulyy@redhat.com>

vitaliy-guliy mentioned this pull request Mar 20, 2024

fix: copilot chat extension does not work #335

Closed

3 tasks

add extra output

10c6de2

Signed-off-by: vitaliy-guliy <vgulyy@redhat.com>

update

b73af0d

Signed-off-by: vitaliy-guliy <vgulyy@redhat.com>

Merge branch 'main' into copilot-chat-simplified

28abe2b

Signed-off-by: vitaliy-guliy <vgulyy@redhat.com>

update

206d690

update

6b8ec4e

update

15de59e

Signed-off-by: vitaliy-guliy <vgulyy@redhat.com>

update

7d27351

Signed-off-by: vitaliy-guliy <vgulyy@redhat.com>

update

f0ff574

Signed-off-by: vitaliy-guliy <vgulyy@redhat.com>

update

042fbc1

Signed-off-by: vitaliy-guliy <vgulyy@redhat.com>

RomanNikitenko approved these changes Mar 28, 2024

View reviewed changes

RomanNikitenko reviewed Mar 28, 2024

View reviewed changes

launcher/src/trusted-extensions.ts Outdated Show resolved Hide resolved

RomanNikitenko reviewed Mar 28, 2024

View reviewed changes

launcher/src/trusted-extensions.ts Outdated Show resolved Hide resolved

RomanNikitenko reviewed Mar 28, 2024

View reviewed changes

launcher/src/trusted-extensions.ts Outdated Show resolved Hide resolved

vitaliy-guliy requested a review from musienko-maxim March 28, 2024 14:54

vitaliy-guliy added 3 commits March 28, 2024 16:53

update

ed1841b

Signed-off-by: vitaliy-guliy <vgulyy@redhat.com>

update

bacface

Signed-off-by: vitaliy-guliy <vgulyy@redhat.com>

update

cf14e08

Signed-off-by: vitaliy-guliy <vgulyy@redhat.com>

RomanNikitenko reviewed Mar 28, 2024

View reviewed changes

launcher/src/trusted-extensions.ts Outdated Show resolved Hide resolved

RomanNikitenko reviewed Mar 28, 2024

View reviewed changes

launcher/src/trusted-extensions.ts Outdated Show resolved Hide resolved

update

8c6de55

Signed-off-by: vitaliy-guliy <vgulyy@redhat.com>

ibuziuk approved these changes Mar 29, 2024

View reviewed changes

musienko-maxim approved these changes Apr 1, 2024

View reviewed changes

vitaliy-guliy added the made-with-che Changes made with Che-Code label Apr 2, 2024

vitaliy-guliy added 2 commits April 2, 2024 22:32

update

a924544

Signed-off-by: vitaliy-guliy <vgulyy@redhat.com>

Merge branch 'main' into copilot-chat-simplified

7b1ad9f

Signed-off-by: vitaliy-guliy <vgulyy@redhat.com>

vitaliy-guliy merged commit a028116 into main Apr 3, 2024
7 checks passed

vitaliy-guliy deleted the copilot-chat-simplified branch April 3, 2024 08:09

fix: allow the extensions to authenticate #339

fix: allow the extensions to authenticate #339

Conversation

vitaliy-guliy commented Mar 20, 2024 • edited

What does this PR do?

What issues does this PR fix?

How to test this PR?

Does this PR contain changes that override default upstream Code-OSS behavior?

github-actions bot commented Mar 20, 2024 • edited

github-actions bot commented Mar 20, 2024

github-actions bot commented Mar 20, 2024

github-actions bot commented Mar 20, 2024

github-actions bot commented Mar 20, 2024

github-actions bot commented Mar 20, 2024

github-actions bot commented Mar 20, 2024

github-actions bot commented Mar 21, 2024

github-actions bot commented Mar 21, 2024

github-actions bot commented Mar 21, 2024

github-actions bot commented Mar 21, 2024

github-actions bot commented Mar 21, 2024

github-actions bot commented Mar 21, 2024

github-actions bot commented Mar 22, 2024

github-actions bot commented Mar 22, 2024

github-actions bot commented Mar 22, 2024

github-actions bot commented Mar 22, 2024

github-actions bot commented Mar 22, 2024

github-actions bot commented Mar 22, 2024

RomanNikitenko left a comment • edited

Choose a reason for hiding this comment

github-actions bot commented Mar 28, 2024

RomanNikitenko Mar 28, 2024 • edited

Choose a reason for hiding this comment

vitaliy-guliy Mar 28, 2024

Choose a reason for hiding this comment

RomanNikitenko Mar 29, 2024

Choose a reason for hiding this comment

vitaliy-guliy Apr 2, 2024

Choose a reason for hiding this comment

vitaliy-guliy Apr 2, 2024

Choose a reason for hiding this comment

github-actions bot commented Mar 28, 2024

github-actions bot commented Mar 28, 2024

github-actions bot commented Mar 28, 2024

ibuziuk left a comment

Choose a reason for hiding this comment

musienko-maxim commented Apr 1, 2024

github-actions bot commented Apr 2, 2024

github-actions bot commented Apr 2, 2024

devstudio-release commented Apr 3, 2024

devstudio-release commented Apr 3, 2024

devstudio-release commented Apr 3, 2024

devstudio-release commented Apr 3, 2024

vitaliy-guliy commented Mar 20, 2024 •

edited

github-actions bot commented Mar 20, 2024 •

edited

RomanNikitenko left a comment •

edited

RomanNikitenko Mar 28, 2024 •

edited