Skip to content

[public-api] align context url with server #18292

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 4 commits into from
Jul 20, 2023
Merged

[public-api] align context url with server #18292

merged 4 commits into from
Jul 20, 2023

Conversation

@mustard-mh
Copy link
Contributor

@mustard-mh mustard-mh commented Jul 17, 2023 •
edited
Loading

Description

See for context: https://gitpod.slack.com/archives/C03QM0ZHF5Z/p1689583726280819?thread_ts=1689581295.424429&cid=C03QM0ZHF5Z

Related Issue(s)

Fixes #

How to test

It should able to start a workspace from prebuild with VS Code Desktop

Documentation

Preview status

Gitpod was successfully deployed to your preview environment.

Build Options

Build
  • /werft with-werft
    Run the build with werft instead of GHA
  • leeway-no-cache
  • /werft no-test
    Run Leeway with --dont-test
Publish
  • /werft publish-to-npm
  • /werft publish-to-jb-marketplace
Installer
  • analytics=segment
  • with-dedicated-emulation
  • workspace-feature-flags
    Add desired feature flags to the end of the line above, space separated
Preview Environment
  • /werft with-local-preview
    If enabled this will build install/preview
  • /werft with-preview
  • /werft with-large-vm
  • /werft with-gce-vm
    If enabled this will create the environment on GCE infra
  • with-integration-tests=all
    Valid options are all, workspace, webapp, ide, jetbrains, vscode, ssh
  • with-monitoring

/hold

akosyakov
akosyakov reviewed Jul 17, 2023
View reviewed changes
akosyakov
akosyakov reviewed Jul 17, 2023
View reviewed changes
@akosyakov
Copy link
Member

akosyakov commented Jul 17, 2023 •
edited
Loading

It maybe also would be cool to encapsulate https://github.com/gitpod-io/gitpod/blob/0bb6aaad9d4923d5510de865437f22c7f726833f/components/gitpod-protocol/src/context-url.ts#L31C28-L31C28 here instead of each client dealing with it. It is especially going to be problematic for any other runtimes but js/ts.

cc @easyCZ @geropl

@mustard-mh
Copy link
Contributor Author

mustard-mh commented Jul 17, 2023

It can start in VS Code Desktop (need desktop code change), and right click context is correct

New VS Code
img1 img2

@mustard-mh mustard-mh marked this pull request as ready for review July 17, 2023 10:13
@mustard-mh mustard-mh requested a review from a team July 17, 2023 10:13
@mustard-mh
Copy link
Contributor Author

mustard-mh commented Jul 17, 2023

/unhold

@github-actions github-actions bot added the team: webapp Issue belongs to the WebApp team label Jul 17, 2023
@mustard-mh mustard-mh mentioned this pull request Jul 17, 2023
Merged
@roboquat roboquat added size/S and removed size/XS labels Jul 17, 2023
jeanp413
jeanp413 reviewed Jul 17, 2023
View reviewed changes
components/public-api-server/pkg/apiv1/workspace.go
Comment on lines 325 to +327
ContextUrl: input.Workspace.ContextURL,
Details: &v1.WorkspaceContext_Git_{Git: &v1.WorkspaceContext_Git{
NormalizedContextUrl: input.Workspace.ContextURL,
NormalizedContextUrl: input.Workspace.Context.NormalizedContextURL,
Copy link
Member

@jeanp413 jeanp413 Jul 17, 2023 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Does it make sense to expose the raw url in public api in the first place? I thought it's more an internal thing on server side.
I think ContextUrl should be the actual normalized context and if there's more additional metadata it should be part of Details

Copy link
Member

@filiptronicek filiptronicek Jul 17, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We discussed this during teaming and I agree: ContextURL seems to be more of a burden than a benefit to have. The normalized one should be the default

Copy link
Member

@akosyakov akosyakov Jul 17, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The question is why it was modelled like that in first place and with whom we need to discuss it then?

@roboquat roboquat merged commit d32e231 into main Jul 20, 2023
@roboquat roboquat deleted the hw/fix-ctx branch July 20, 2023 12:53
@roboquat roboquat added deployed: webapp Meta team change is running in production deployed Change is completely running in production labels Jul 21, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@akosyakov akosyakov akosyakov approved these changes

@jeanp413 jeanp413 jeanp413 left review comments

@filiptronicek filiptronicek filiptronicek left review comments

+1 more reviewer

@svenefftinge svenefftinge svenefftinge left review comments

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

deployed: webapp Meta team change is running in production deployed Change is completely running in production size/S team: webapp Issue belongs to the WebApp team

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

7 participants

@mustard-mh @akosyakov @svenefftinge @jeanp413 @filiptronicek @roboquat