[papi] List editor options #18530

filiptronicek · 2023-08-16T20:32:17Z

Description

Implements the server's getIDEOptions in a new EditorService named ListEditorOptions. It is a stripped down version of the original method, only exposing these fields:

id
title
type
logo
label
version

Sample response:

{
  "result": [
    {
      "id": "code",
      "title": "VS Code",
      "type": "TYPE_BROWSER",
      "logo": "https://ide.ft-list-editors.preview.gitpod-dev.com/image/ide-logo/vscode.svg",
      "label": "Browser",
      "stable": {
        "version": "1.81.1"
      },
      "latest": {
        "version": "1.81.1"
      }
    },
    {
      "id": "code-desktop",
      "title": "VS Code",
      "type": "TYPE_DESKTOP",
      "logo": "https://ide.ft-list-editors.preview.gitpod-dev.com/image/ide-logo/vscode.svg",
      "stable": {},
      "latest": {}
    },
    {
      "id": "intellij",
      "title": "IntelliJ IDEA",
      "type": "TYPE_DESKTOP",
      "logo": "https://ide.ft-list-editors.preview.gitpod-dev.com/image/ide-logo/intellijIdeaLogo.svg",
      "label": "Ultimate",
      "stable": {
        "version": "2023.2"
      },
      "latest": {
        "version": "2023.2.1"
      }
    },
    {
      "id": "goland",
      "title": "GoLand",
      "type": "TYPE_DESKTOP",
      "logo": "https://ide.ft-list-editors.preview.gitpod-dev.com/image/ide-logo/golandLogo.svg",
      "stable": {
        "version": "2023.2"
      },
      "latest": {
        "version": "2023.2"
      }
    },
    {
      "id": "pycharm",
      "title": "PyCharm",
      "type": "TYPE_DESKTOP",
      "logo": "https://ide.ft-list-editors.preview.gitpod-dev.com/image/ide-logo/pycharmLogo.svg",
      "label": "Professional",
      "stable": {
        "version": "2023.2"
      },
      "latest": {
        "version": "2023.2.1"
      }
    },
    {
      "id": "phpstorm",
      "title": "PhpStorm",
      "type": "TYPE_DESKTOP",
      "logo": "https://ide.ft-list-editors.preview.gitpod-dev.com/image/ide-logo/phpstormLogo.svg",
      "stable": {
        "version": "2023.2"
      },
      "latest": {
        "version": "2023.2.1"
      }
    },
    {
      "id": "rubymine",
      "title": "RubyMine",
      "type": "TYPE_DESKTOP",
      "logo": "https://ide.ft-list-editors.preview.gitpod-dev.com/image/ide-logo/rubymineLogo.svg",
      "stable": {
        "version": "2023.2"
      },
      "latest": {
        "version": "2023.2.1"
      }
    },
    {
      "id": "webstorm",
      "title": "WebStorm",
      "type": "TYPE_DESKTOP",
      "logo": "https://ide.ft-list-editors.preview.gitpod-dev.com/image/ide-logo/webstormLogo.svg",
      "stable": {
        "version": "2023.2"
      },
      "latest": {
        "version": "2023.2.1"
      }
    },
    {
      "id": "rider",
      "title": "Rider",
      "type": "TYPE_DESKTOP",
      "logo": "https://ide.ft-list-editors.preview.gitpod-dev.com/image/ide-logo/riderLogo.svg",
      "stable": {
        "version": "2023.2"
      },
      "latest": {
        "version": "2023.2"
      }
    },
    {
      "id": "clion",
      "title": "CLion",
      "type": "TYPE_DESKTOP",
      "logo": "https://ide.ft-list-editors.preview.gitpod-dev.com/image/ide-logo/clionLogo.svg",
      "stable": {
        "version": "2023.2"
      },
      "latest": {
        "version": "2023.2"
      }
    },
    {
      "id": "xterm",
      "title": "Terminal",
      "type": "TYPE_BROWSER",
      "logo": "https://ide.ft-list-editors.preview.gitpod-dev.com/image/ide-logo/terminal.svg",
      "label": "Insiders",
      "stable": {
        "version": "1.0.0"
      },
      "latest": {
        "version": "1.0.0"
      }
    }
  ]
}

Summary generated by Copilot

`🤖 Generated by Copilot at f88fc14`

This pull request adds a new editor service to the public API, which allows clients to query the available IDE options for the user. It also removes the obsolete workspaces service code from the public API TypeScript package. It involves changes to the gitpod service API, the public API server, the editor service protobuf definition, and the generated code for the editor service in Go and TypeScript.

Related Issue(s)

Fixes EXP-454

How to test

curl 'https://api.ft-list-editors.preview.gitpod-dev.com/gitpod.experimental.v1.EditorService/ListEditorOptions' \
  -H 'content-type: application/json' \
  -H 'Authorization: Bearer API_TOKEN' \
  --data '{}' | jq .

Documentation

Preview status

Gitpod was successfully deployed to your preview environment.

🏷️ Name - ft-list-editors
🔗 URL - ft-list-editors.preview.gitpod-dev.com/workspaces.
📚 Documentation - See our internal documentation for information on how to interact with your preview environment.
📦 Version - ft-list-editors-gha.15505

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 / Integration Tests

/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. If enabled, with-preview and with-large-vm will be enabled.
with-monitoring

/hold

akosyakov · 2023-08-17T14:52:06Z

components/public-api/gitpod/experimental/v1/editor_service.proto

+    repeated EditorOption options = 1;
+}
+
+message EditorOption {


fyi @svenefftinge @loujaybee we decided to call it Editor not IDE here to be aligned how we talk in our docs and on UI

components/public-api-server/pkg/apiv1/editor_service.go

akosyakov

generally looks good but i did not test

/hold

if no-one objects when merge when you are ready.

akosyakov · 2023-08-17T14:55:26Z

type does not look nice if someone will use it like REST, not sure whether we can make it simple browser or desktop

components/public-api/gitpod/experimental/v1/editor_service.proto

filiptronicek · 2023-08-17T16:01:45Z

@akosyakov I'm not sure how to make pretty types. Protobuf enums look strict:

gitpod/experimental/v1/editor_service.proto:26:7:Enum value name "unspecified" should be prefixed with "EDITOR_TYPE_".
gitpod/experimental/v1/editor_service.proto:26:7:Enum value name "unspecified" should be UPPER_SNAKE_CASE, such as "UNSPECIFIED".
gitpod/experimental/v1/editor_service.proto:26:7:Enum zero value name "unspecified" should be suffixed with "_UNSPECIFIED".
gitpod/experimental/v1/editor_service.proto:27:7:Enum value name "browser" should be prefixed with "EDITOR_TYPE_".
gitpod/experimental/v1/editor_service.proto:27:7:Enum value name "browser" should be UPPER_SNAKE_CASE, such as "BROWSER".
gitpod/experimental/v1/editor_service.proto:28:7:Enum value name "desktop" should be prefixed with "EDITOR_TYPE_".
gitpod/experimental/v1/editor_service.proto:28:7:Enum value name "desktop" should be UPPER_SNAKE_CASE, such as "DESKTOP".

filiptronicek added 4 commits August 16, 2023 09:57

options.init

71d1bb3

Respond with options

4e3fbbb

Move to editor service

225a4df

Unused imports

f88fc14

roboquat added do-not-merge/hold do-not-merge/work-in-progress size/XL labels Aug 16, 2023

filiptronicek added 2 commits August 17, 2023 08:56

Merge branch 'main' into ft/list-editors

84e6d8c

Mount ot the correct service

4906723

filiptronicek self-assigned this Aug 17, 2023

filiptronicek added the component: public-api label Aug 17, 2023

filiptronicek added 2 commits August 17, 2023 10:50

Sort by orderkey

58d9190

Merge branch 'main' into ft/list-editors

b9cc617

filiptronicek marked this pull request as ready for review August 17, 2023 12:03

filiptronicek requested a review from a team as a code owner August 17, 2023 12:03

roboquat removed the do-not-merge/work-in-progress label Aug 17, 2023

github-actions bot added the team: team-experience label Aug 17, 2023

akosyakov reviewed Aug 17, 2023

View reviewed changes

components/public-api-server/pkg/apiv1/editor_service.go Show resolved Hide resolved

akosyakov approved these changes Aug 17, 2023

View reviewed changes

akosyakov reviewed Aug 17, 2023

View reviewed changes

components/public-api/gitpod/experimental/v1/editor_service.proto Outdated Show resolved Hide resolved

filiptronicek added 4 commits August 17, 2023 16:11

Simplify enum name

c7d0688

Add tests

66ca2a5

Options -> result for consistency

3ab79e1

fix result field

218eba6

filiptronicek removed the do-not-merge/hold label Aug 18, 2023

roboquat merged commit 112eefc into main Aug 18, 2023

roboquat deleted the ft/list-editors branch August 18, 2023 09:19

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

[papi] List editor options #18530

[papi] List editor options #18530

Uh oh!

filiptronicek commented Aug 16, 2023 •

edited

Loading

Uh oh!

akosyakov Aug 17, 2023

Uh oh!

Uh oh!

akosyakov left a comment

Uh oh!

akosyakov commented Aug 17, 2023

Uh oh!

Uh oh!

filiptronicek commented Aug 17, 2023

Uh oh!

Uh oh!

[papi] List editor options #18530

[papi] List editor options #18530

Uh oh!

Conversation

filiptronicek commented Aug 16, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

🤖 Generated by Copilot at f88fc14

Related Issue(s)

How to test

Documentation

Preview status

Build Options

Uh oh!

akosyakov Aug 17, 2023

Choose a reason for hiding this comment

Uh oh!

Uh oh!

akosyakov left a comment

Choose a reason for hiding this comment

Uh oh!

akosyakov commented Aug 17, 2023

Uh oh!

Uh oh!

filiptronicek commented Aug 17, 2023

Uh oh!

Uh oh!

filiptronicek commented Aug 16, 2023 •

edited

Loading

`🤖 Generated by Copilot at f88fc14`