[server] add editor prefix to choose custom IDE #9467

mustard-mh · 2022-04-21T17:19:22Z

Description

Support choose custom IDE with prefix /#editor:<ide>:<version?>/<repo>

Name	Desc	Required	values	Default	Example
ide	IDE id choose to open	true	see here	code	`code` `goland` ...
version	IDE version	false	stable or latest	stable	latest

Related Issue(s)

Fixes #9434

https://github.com/gitpod-io/template-sveltejs

How to test

Open with

code stable => https://hw-9434-open-via-url.staging.gitpod-dev.com/#editor:code/https://github.com/gitpod-io/template-sveltejs
code desktop stable => https://hw-9434-open-via-url.staging.gitpod-dev.com/#editor:code-desktop/https://github.com/gitpod-io/template-sveltejs
goland stable => https://hw-9434-open-via-url.staging.gitpod-dev.com/#editor:goland/https://github.com/gitpod-io/template-sveltejs
goland latest => https://hw-9434-open-via-url.staging.gitpod-dev.com/#editor:goland:latest/https://github.com/gitpod-io/template-sveltejs
unknown ide will use default code => https://hw-9434-open-via-url.staging.gitpod-dev.com/#editor:not-exists:latest/https://github.com/gitpod-io/template-sveltejs

Release Notes

NONE

Documentation

/werft analytics=segment|TEZnsG4QbLSxLfHfNieLYGF4cDwyFWoe

mustard-mh · 2022-04-21T17:30:57Z

/werft run with-vm

👎 cannot start job - please talk to whoever's in charge of your Werft installation

mustard-mh · 2022-04-21T17:35:40Z

/werft run with-vm

👍 started the job as gitpod-build-hw-9434-open-via-url.3

components/server/src/workspace/workspace-starter.ts

components/gitpod-protocol/src/protocol.ts

mustard-mh · 2022-04-22T10:30:01Z

/werft run

👍 started the job as gitpod-build-hw-9434-open-via-url.15

akosyakov · 2022-04-22T12:18:49Z

components/gitpod-protocol/src/protocol.ts

 export interface WithReferrerContext extends WorkspaceContext {
    referrer: string;
    referrerIde?: string;
 }

 export namespace WithReferrerContext {
    export function is(context: any): context is WithReferrerContext {
-        return context && "referrer" in context;
+        return context && "referrer" in context && !("ide" in context);


&& !WithEditorContext.is(context)?

How about using #referrer and remove checkes above? #editor likes like referrer..

Could you elaborate please? I did not grasp an idea, sorry.

#editor works like #referrer we can extend #referrer and remove #editor.

Now #referrer only works for client (referrer) vscode vscode-insiders and jetbrains-gateway, and IDE option can only be one of these below 👇 .

gitpod/chart/templates/server-ide-configmap.yaml

Line 109 in 330ddb2

desktopIDEs: ["intellij", "goland", "pycharm", "phpstorm"]

We can remove this check and make referrer to be anything like bowser-extension dashboard-project readme etc and IDEs with any IDE. They are worth tracking too

Or extend ide-configmap to support browser-extension

Or with #editor if referrer is not define, we do not send track here, and consider #editor as make to choose IDE

This PR introduces the editor parameter, which have three parameters, ide, version, and referrer, but except ide all of them are optional

So it can be used to solve #7525, just use #ediror:code/http://xxxx
It can also be used to solve #9434 with just #editor:code:stable:browser-extension/http://xxxx
It can also be used to solve any need to temporarily switch IDEs, for example, we may introduce another feature later, where we can hold down the option key in the Open workspace (select url) to temporarily select the current open IDE #9433 (comment)

Let's solve one issue at the time instead of use one technical solution for everything, and don't be to worry about all possible issues which we will need to solve somewhen 🙏

It can also be used to solve #9434 with just #editor:code:stable:browser-extension/http://xxxx

Let's use referrer still there, but introduce a new kind browser-extension which allows any IDE and use code as default, i.e. referrer:browser-extension:code We don't want to allow users to specify random referrers. Please also prioritise browser-extension support as minor. It is not a primary onboarding experience.

So it can be used to solve #7525, just use #ediror:code/http://xxxx

We don't need uncontrolled referrer here at all. It also not nice syntax I would go with something like #editor:code&referrer=.../https://, but then it is better to use referrer prefix with new kinds. I suggest we go with an initial proposal here editor:<ide>(:<version>)?. Adding analytics is not bad then to see whether it is used, but it should not be mixed with ide_referrer event anymore then, something like ide_editor_prefix.

It can also be used to solve any need to temporarily switch IDEs, for example, we may introduce another feature later, where we can hold down the option key in the Open workspace (select url) to temporarily select the current open IDE #9433 (comment)

From the dashboard, we should not rely on prefix parsers, but improve APIs to allow passing concrete IDE to create or start workspace methods. This one actually sounds like most important issue of all mentioned above. But should rather align with @loujaybee and @andreafalzetti what is goal for onboarding right now.

I suggest we go with an initial proposal here editor:(:)?

Go with this. will create a PR to open workspace with custom IDE via API later.

If PR above is created, and PR to add referrer browser-extension is created, why we need this PR? No one will use it.🙈

Feel free to close this PR @akosyakov

If PR above is created, and PR to add referrer browser-extension is created, why we need this PR? No one will use it.🙈

People will add to README if a project is configured only to work nicely with VS Code for instance.

I already would like to use it on gitpod-io/gitpod, since I usually have IntelliJ one, but would like to have a workspace only with VS Code 🙏

I think we will need to add some docs about this prefix somewhere. @loujaybee

Ah, sorry I misunderstand. You say you will do 2 PRs instead? Then yes just close this PR and open 2 others.

components/server/src/workspace/workspace-starter.ts

jeanp413 · 2022-04-25T07:24:39Z

I have a question:
Why are we using this format /#editor:<ide>:<version?>/<repo> instead of just using the query parameters in the url?
I get the idea of using the fragment part to pass the repo url as it's really easy to just prepend gitpod.io# to some repo url, but for more complex stuff like this I don't see a point, it just makes it more complex and cumbersome to use, for both end users and us 🤔

geropl

Apart from the general question "what is meant to be part of the start workpace URL": We should really have a basic test converage before merging a ContextParser.

Two things I would be interested in:

the "internal" stuff works, and does not throw exceptions (extensive)
the "external" facet: it does play nicely with other context parsers, e.g. EnvVars (some examples)

mustard-mh · 2022-04-25T08:01:16Z

I have a question:
Why are we using this format /#editor::<version?>/ instead of just using the query parameters in the url?
I get the idea of using the fragment part to pass the repo url as it's really easy to just prepend gitpod.io# to some repo url, but for more complex stuff like this I don't see a point, it just makes it more complex and cumbersome to use, for both end users and us 🤔

@jeanp413 I think this question should back to why we use fragment for/#prebuild and env var😂

In my opinion, we may just want to split input into Repo from user and Gitpod params

mustard-mh · 2022-04-25T16:26:18Z

Close, will create a new one for it in the future

roboquat added do-not-merge/work-in-progress release-note size/M labels Apr 21, 2022

mustard-mh mentioned this pull request Apr 21, 2022

Property aware users that they can choose IDEs with onboarding dashboard #9433

Closed

roboquat added release-note-none and removed release-note labels Apr 21, 2022

akosyakov reviewed Apr 22, 2022

View reviewed changes

components/server/src/workspace/workspace-starter.ts Outdated Show resolved Hide resolved

akosyakov reviewed Apr 22, 2022

View reviewed changes

components/server/src/workspace/workspace-starter.ts Outdated Show resolved Hide resolved

akosyakov reviewed Apr 22, 2022

View reviewed changes

components/server/src/workspace/workspace-starter.ts Outdated Show resolved Hide resolved

akosyakov reviewed Apr 22, 2022

View reviewed changes

components/gitpod-protocol/src/protocol.ts Outdated Show resolved Hide resolved

mustard-mh force-pushed the hw/9434-open-via-url branch from 6192dd1 to d6926f7 Compare April 22, 2022 10:16

roboquat added size/L and removed size/M labels Apr 22, 2022

mustard-mh force-pushed the hw/9434-open-via-url branch from d6926f7 to 08c92e6 Compare April 22, 2022 10:18

mustard-mh marked this pull request as ready for review April 22, 2022 10:30

mustard-mh requested a review from a team April 22, 2022 10:30

roboquat removed the do-not-merge/work-in-progress label Apr 22, 2022

github-actions bot added the team: webapp Issue belongs to the WebApp team label Apr 22, 2022

mustard-mh requested a review from akosyakov April 22, 2022 10:43

akosyakov reviewed Apr 22, 2022

View reviewed changes

components/server/src/workspace/workspace-starter.ts Show resolved Hide resolved

akosyakov reviewed Apr 22, 2022

View reviewed changes

components/server/src/workspace/workspace-starter.ts Outdated Show resolved Hide resolved

akosyakov reviewed Apr 22, 2022

View reviewed changes

components/server/src/workspace/workspace-starter.ts Outdated Show resolved Hide resolved

mustard-mh force-pushed the hw/9434-open-via-url branch from 08c92e6 to 1bcf2a0 Compare April 22, 2022 13:33

mustard-mh added 2 commits April 25, 2022 07:14

[server] add editor prefix to choose custom IDE

fd4cac9

Fix ide not exists bug

2104a66

mustard-mh force-pushed the hw/9434-open-via-url branch from 1bcf2a0 to 2104a66 Compare April 25, 2022 07:14

roboquat added size/M and removed size/L labels Apr 25, 2022

geropl requested changes Apr 25, 2022

View reviewed changes

geropl self-assigned this Apr 25, 2022

mustard-mh marked this pull request as draft April 25, 2022 08:56

roboquat added the do-not-merge/work-in-progress label Apr 25, 2022

loujaybee added the team: IDE label Apr 25, 2022

mustard-mh closed this Apr 25, 2022

mustard-mh mentioned this pull request Apr 27, 2022

[server] fix ide option not exists bug #9541

Merged

1 task

This was referenced Oct 4, 2022

Open workspace in ad-hoc (per-workspace) editor or IDE #8573

Closed

Create "Open In Gitpod (JetBrains)" button #7525

Closed

mustard-mh deleted the hw/9434-open-via-url branch January 24, 2024 12:43

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[server] add editor prefix to choose custom IDE #9467

[server] add editor prefix to choose custom IDE #9467

mustard-mh commented Apr 21, 2022 •

edited

Loading

mustard-mh commented Apr 21, 2022 •

edited by werft-gitpod-dev-com bot

Loading

mustard-mh commented Apr 21, 2022 •

edited by werft-gitpod-dev-com bot

Loading

mustard-mh commented Apr 22, 2022 •

edited by werft-gitpod-dev-com bot

Loading

akosyakov Apr 22, 2022

mustard-mh Apr 22, 2022 •

edited

Loading

akosyakov Apr 22, 2022

mustard-mh Apr 22, 2022

mustard-mh Apr 22, 2022 •

edited

Loading

mustard-mh Apr 22, 2022 •

edited

Loading

akosyakov Apr 25, 2022 •

edited

Loading

mustard-mh Apr 25, 2022

akosyakov Apr 25, 2022

akosyakov Apr 25, 2022

jeanp413 commented Apr 25, 2022 •

edited

Loading

geropl left a comment

mustard-mh commented Apr 25, 2022 •

edited

Loading

mustard-mh commented Apr 25, 2022

[server] add editor prefix to choose custom IDE #9467

[server] add editor prefix to choose custom IDE #9467

Conversation

mustard-mh commented Apr 21, 2022 • edited Loading

Description

Related Issue(s)

How to test

Release Notes

Documentation

mustard-mh commented Apr 21, 2022 • edited by werft-gitpod-dev-com bot Loading

mustard-mh commented Apr 21, 2022 • edited by werft-gitpod-dev-com bot Loading

mustard-mh commented Apr 22, 2022 • edited by werft-gitpod-dev-com bot Loading

akosyakov Apr 22, 2022

Choose a reason for hiding this comment

mustard-mh Apr 22, 2022 • edited Loading

Choose a reason for hiding this comment

akosyakov Apr 22, 2022

Choose a reason for hiding this comment

mustard-mh Apr 22, 2022

Choose a reason for hiding this comment

mustard-mh Apr 22, 2022 • edited Loading

Choose a reason for hiding this comment

mustard-mh Apr 22, 2022 • edited Loading

Choose a reason for hiding this comment

akosyakov Apr 25, 2022 • edited Loading

Choose a reason for hiding this comment

mustard-mh Apr 25, 2022

Choose a reason for hiding this comment

akosyakov Apr 25, 2022

Choose a reason for hiding this comment

akosyakov Apr 25, 2022

Choose a reason for hiding this comment

jeanp413 commented Apr 25, 2022 • edited Loading

geropl left a comment

Choose a reason for hiding this comment

mustard-mh commented Apr 25, 2022 • edited Loading

mustard-mh commented Apr 25, 2022

mustard-mh commented Apr 21, 2022 •

edited

Loading

mustard-mh commented Apr 21, 2022 •

edited by werft-gitpod-dev-com bot

Loading

mustard-mh commented Apr 21, 2022 •

edited by werft-gitpod-dev-com bot

Loading

mustard-mh commented Apr 22, 2022 •

edited by werft-gitpod-dev-com bot

Loading

mustard-mh Apr 22, 2022 •

edited

Loading

mustard-mh Apr 22, 2022 •

edited

Loading

mustard-mh Apr 22, 2022 •

edited

Loading

akosyakov Apr 25, 2022 •

edited

Loading

jeanp413 commented Apr 25, 2022 •

edited

Loading

mustard-mh commented Apr 25, 2022 •

edited

Loading