Plugin API to add more applications to code-server #2252

nhooyr · 2020-10-30T07:28:53Z

This PR introduces the commits that implement the plugin system we've discussed.

It is described in detail in ./typings/plugin.d.ts.

The overlay is not yet implemented but I'm working on it.

wbobeirne

Code overall looks good, but deviates from the agreed spec. We should probably catch up about the changes.

src/node/plugin.ts

typings/plugin.d.ts

src/node/plugin.ts

test/test-plugin/package.json

src/node/plugin.ts

typings/plugin.d.ts

nhooyr · 2020-11-04T02:46:34Z

So addressed every comment + added /api/applications endpoint + plugins/apps now have a homepage field.

Should be good to merge now!

nhooyr · 2020-11-04T02:51:57Z

Example endpoint output (also in docs):

[
  {
    "name": "Test App",
    "version": "4.0.0",
    "iconPath": "/test-plugin/test-app/icon.svg",
    "path": "/test-plugin/test-app",
    "description": "This app does XYZ.",
    "homepageURL": "https://example.com",
    "plugin": {
      "name": "test-plugin",
      "version": "1.0.0",
      "modulePath": "/Users/nhooyr/src/cdr/code-server/test/test-plugin",
      "displayName": "Test Plugin",
      "description": "Plugin used in code-server tests.",
      "routerPath": "/test-plugin",
      "homepageURL": "https://example.com"
    }
  }
]

wbobeirne

Started creating a test plugin for this and ran into some quirks.

I also think this may be going too hard on the plugins === applications angle, but we can loosen that up later if something like an rsync plugin or other "headless" plugin became useful to consider.

src/node/plugin.ts

test/test-plugin/src/index.ts

wbobeirne · 2020-11-04T21:49:23Z

test/test-plugin/src/index.ts

+export const displayName = "Test Plugin"
+export const routerPath = "/test-plugin"
+export const homepageURL = "https://example.com"
+export const description = "Plugin used in code-server tests."


The ergonomics of this are kind of weird, any reason we don't just do a single export of an interface so that you can type your export? Right now you'd just have to "know" that you're fulfilling the expected exports, and we wouldn't be able to communicate breaking changes to the API via TS types, just through throwing.

Yea I agree it's weird. Is there any way to type a bunch of your top level exports?

If not, I'll just make the top level export a single plugin and then that'll be easy.

There's not, to my knowledge.

src/node/plugin.ts

wbobeirne · 2020-11-04T22:17:36Z

test/test-plugin/package.json

+  "name": "test-plugin",
+  "version": "1.0.0",
+  "engines": {
+    "code-server": "^3.6.0"


This annoyingly warns on every npm command, perhaps we should use a custom key?

warning [email protected]: The engine "code-server" appears to be invalid.

So this is how vscode does things as well. I'm leaning in favour of keeping it the same to keep with the idiom but also ok changing to our own key.

cc @code-asher

Cool, no worries if it's already convention

It does seem to be a convention in use, as mentioned VS Code does it this way and I could have sworn I've seen it elsewhere although the details escape me. Supposedly --ignore-engines can ignore it; I wonder if that's a valid setting for a .yarnrc or something.

code-asher

👍

typings/pluginapi.d.ts

nhooyr · 2020-11-05T04:12:58Z

I also think this may be going too hard on the plugins === applications angle, but we can loosen that up later if something like an rsync plugin or other "headless" plugin became useful to consider.

Agreed things can definitely easily change later. I'm not sure what would be useful to consider or how it'd work so I can't design for them. I do think that they should be able to easily work with just the init function, report zero applications and register zero routes. Perhaps we'd need another field to indicate they provide no applications/are headless so we can indicate that in the overlay.

wbobeirne · 2020-11-05T16:01:41Z

src/node/plugin.ts

+   */
+  public mount(r: express.Router): void {
+    for (const [, p] of this.plugins) {
+      r.use(`/${p.routerPath}`, p.router())


This makes it accessible on e.g. //test-plugin, not /test-plugin.

Suggested change

r.use(`/${p.routerPath}`, p.router())

r.use(p.routerPath, p.router())

Ah interesting, I figured express would normalize it.

code-asher · 2020-11-05T16:36:00Z

We could have just init that returns all the info and optionally a router and an applications func (or pass init something that lets you do something like api.registerRoute()) then if it doesn't have a router skip the use and if it doesn't have applications skip it when getting all the apps.

nhooyr · 2020-11-05T19:19:41Z

How about we just make the applications and router callback optional? I prefer that to putting things into init as it's not really something that will change per init, it's something the plugin either implements or doesn't.

Will work on testing overlay next.

See my discussion with Will in the PR.

More clear.

Addresses Will's comments.

Next commit will address Will's comments about the typings being weird.

Makes typing much easier. Addresse's Will's last comment.

Unfortunately we can't use node-mocks-http to test a express.Router that has async routes. See eugef/node-mocks-http#225 router will just return undefined if the executing handler is async and so the test will have no way to wait for it to complete. Thus, we have to use supertest which starts an actual HTTP server in the background and uses a HTTP client to send requests.

nhooyr requested review from wbobeirne and code-asher October 30, 2020 07:28

nhooyr force-pushed the plugin-5d60 branch 2 times, most recently from ec67639 to 9e5fa30 Compare October 30, 2020 07:41

wbobeirne suggested changes Oct 30, 2020

View reviewed changes

src/node/plugin.ts Show resolved Hide resolved

src/node/plugin.ts Outdated Show resolved Hide resolved

src/node/plugin.ts Outdated Show resolved Hide resolved

typings/plugin.d.ts Outdated Show resolved Hide resolved

src/node/plugin.ts Outdated Show resolved Hide resolved

code-asher reviewed Nov 2, 2020

View reviewed changes

src/node/plugin.ts Outdated Show resolved Hide resolved

src/node/plugin.ts Show resolved Hide resolved

test/test-plugin/package.json Show resolved Hide resolved

code-asher reviewed Nov 2, 2020

View reviewed changes

src/node/plugin.ts Outdated Show resolved Hide resolved

code-asher reviewed Nov 2, 2020

View reviewed changes

src/node/plugin.ts Show resolved Hide resolved

src/node/plugin.ts Outdated Show resolved Hide resolved

src/node/plugin.ts Outdated Show resolved Hide resolved

kylecarbs reviewed Nov 2, 2020

View reviewed changes

typings/plugin.d.ts Outdated Show resolved Hide resolved

nhooyr force-pushed the plugin-5d60 branch 2 times, most recently from 90d46cb to 24e46c3 Compare November 4, 2020 02:45

nhooyr requested review from kylecarbs, code-asher, wbobeirne and GirlBossRush November 4, 2020 02:46

nhooyr force-pushed the plugin-5d60 branch from 660eb18 to e2ca3aa Compare November 4, 2020 02:51

wbobeirne suggested changes Nov 4, 2020

View reviewed changes

code-asher approved these changes Nov 4, 2020

View reviewed changes

typings/pluginapi.d.ts Outdated Show resolved Hide resolved

nhooyr requested a review from wbobeirne November 5, 2020 04:13

wbobeirne suggested changes Nov 5, 2020

View reviewed changes

code-asher force-pushed the code-asher/ch1385 branch from ef7ce56 to 3f1750c Compare November 5, 2020 21:08

nhooyr added 4 commits November 6, 2020 10:11

typings/plugin.d.ts: Create

aa2cfa2

ci/dev/test.sh: Pass through args

481df70

src/node/plugin.ts: Implement new plugin API

e08a55d

plugin: Add basic loading test

bea185b

Will work on testing overlay next.

nhooyr added 18 commits November 6, 2020 10:12

src/node/plugin.ts: Warn on duplicate plugin and only load first

30d2962

plugin.test.ts: Make it clear iconPath is a path

ef97100

plugin.ts: Fixes for @wbobeirne

f4d7f00

plugin.ts: Fixes for @code-asher

75e52a3

plugin.d.ts: Document plugin priority correctly

8d3a772

plugin.d.ts: Add explicit path field and adjust types to reflect

6638daf

See my discussion with Will in the PR.

plugin.d.ts -> pluginapi.d.ts

fed545e

More clear.

plugin.ts: Adjust to implement pluginapi.d.ts correctly

afff86a

routes/apps.ts: Implement /api/applications endpoint

e03bbe3

plugin.ts: Describe private counterpart functions

139a28e

Addresses Will's comments.

plugin.ts: Make application endpoint paths absolute

6870948

plugin.ts: Add homepageURL to plugin and application

2a13d00

routes/apps.ts: Add example output

af73b96

plugin: Fixes for CI

706bc23

plugin: More review fixes

8a8159c

Next commit will address Will's comments about the typings being weird.

plugin: Plugin modules now export a single top level identifier

14f408a

Makes typing much easier. Addresse's Will's last comment.

plugin.ts: Fix usage of routerPath in mount

9453f89

nhooyr force-pushed the plugin-5d60 branch 4 times, most recently from 3e82a47 to 6bc111f Compare November 6, 2020 19:40

nhooyr added 3 commits November 6, 2020 14:47

plugin: Give test-plugin some html to test overlay

9d39c53

plugin: Make init and applications callbacks optional

277211c

Fix formatting

fe399ff

nhooyr force-pushed the plugin-5d60 branch from 4ca288e to fe399ff Compare November 6, 2020 19:47

nhooyr merged commit d969a5b into code-asher/ch1385 Nov 6, 2020

nhooyr deleted the plugin-5d60 branch November 6, 2020 19:49

This was referenced Dec 8, 2020

Well-defined Plugin Interface #1959

Closed

Collaboration (multi user) support #33

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Plugin API to add more applications to code-server #2252

Plugin API to add more applications to code-server #2252

nhooyr commented Oct 30, 2020

wbobeirne left a comment

nhooyr commented Nov 4, 2020

nhooyr commented Nov 4, 2020

wbobeirne left a comment

wbobeirne Nov 4, 2020

nhooyr Nov 5, 2020

wbobeirne Nov 5, 2020

wbobeirne Nov 4, 2020

nhooyr Nov 5, 2020

wbobeirne Nov 5, 2020

code-asher Nov 5, 2020 •

edited

Loading

code-asher left a comment

nhooyr commented Nov 5, 2020

wbobeirne Nov 5, 2020 •

edited

Loading

nhooyr Nov 5, 2020

code-asher commented Nov 5, 2020

nhooyr commented Nov 5, 2020

	r.use(`/${p.routerPath}`, p.router())
	r.use(p.routerPath, p.router())

Plugin API to add more applications to code-server #2252

Plugin API to add more applications to code-server #2252

Conversation

nhooyr commented Oct 30, 2020

wbobeirne left a comment

Choose a reason for hiding this comment

nhooyr commented Nov 4, 2020

nhooyr commented Nov 4, 2020

wbobeirne left a comment

Choose a reason for hiding this comment

wbobeirne Nov 4, 2020

Choose a reason for hiding this comment

nhooyr Nov 5, 2020

Choose a reason for hiding this comment

wbobeirne Nov 5, 2020

Choose a reason for hiding this comment

wbobeirne Nov 4, 2020

Choose a reason for hiding this comment

nhooyr Nov 5, 2020

Choose a reason for hiding this comment

wbobeirne Nov 5, 2020

Choose a reason for hiding this comment

code-asher Nov 5, 2020 • edited Loading

Choose a reason for hiding this comment

code-asher left a comment

Choose a reason for hiding this comment

nhooyr commented Nov 5, 2020

wbobeirne Nov 5, 2020 • edited Loading

Choose a reason for hiding this comment

nhooyr Nov 5, 2020

Choose a reason for hiding this comment

code-asher commented Nov 5, 2020

nhooyr commented Nov 5, 2020

code-asher Nov 5, 2020 •

edited

Loading

wbobeirne Nov 5, 2020 •

edited

Loading