plugin: More review fixes

nhooyr · nhooyr · commit 8a8159c683c0 · 2020-11-06T10:13:01.000-05:00
Next commit will address Will's comments about the typings being weird.
diff --git a/src/node/plugin.ts b/src/node/plugin.ts
@@ -86,7 +86,7 @@ export class PluginAPI {
    */
   public mount(r: express.Router): void {
     for (const [, p] of this.plugins) {
-      r.use(`/${p.name}`, p.router())
+      r.use(`/${p.routerPath}`, p.router())
     }
   }
 
@@ -154,7 +154,7 @@ export class PluginAPI {
       this.plugins.set(p.name, p)
     } catch (err) {
       if (err.code !== "ENOENT") {
-        this.logger.warn(`failed to load plugin: ${err.message}`)
+        this.logger.warn(`failed to load plugin: ${err.stack}`)
       }
     }
   }
@@ -170,17 +170,24 @@ export class PluginAPI {
     const logger = this.logger.named(packageJSON.name)
     logger.debug("loading plugin", field("plugin_dir", dir), field("package_json", packageJSON))
 
+    if (!packageJSON.name) {
+      throw new Error("plugin package.json missing name")
+    }
+    if (!packageJSON.version) {
+      throw new Error("plugin package.json missing version")
+    }
+    if (!packageJSON.engines || !packageJSON.engines["code-server"]) {
+      throw new Error(`plugin package.json missing code-server range like:
+  "engines": {
+    "code-server": "^3.6.0"
+   }
+`)
+    }
     if (!semver.satisfies(version, packageJSON.engines["code-server"])) {
       throw new Error(
         `plugin range ${q(packageJSON.engines["code-server"])} incompatible` + ` with code-server version ${version}`,
       )
     }
-    if (!packageJSON.name) {
-      throw new Error("plugin missing name")
-    }
-    if (!packageJSON.version) {
-      throw new Error("plugin missing version")
-    }
 
     const p = {
       name: packageJSON.name,
@@ -198,6 +205,9 @@ export class PluginAPI {
     if (!p.routerPath) {
       throw new Error("plugin missing router path")
     }
+    if (!p.routerPath.startsWith("/") || p.routerPath.length < 2) {
+      throw new Error(`plugin router path ${q(p.routerPath)}: invalid`)
+    }
     if (!p.homepageURL) {
       throw new Error("plugin missing homepage")
     }
diff --git a/typings/pluginapi.d.ts b/typings/pluginapi.d.ts
@@ -45,7 +45,8 @@ import * as express from "express"
  *
  */
 
-/* Programmability
+/**
+ * Programmability
  *
  * There is also a /api/applications endpoint to allow programmatic access to all
  * available applications. It could be used to create a custom application dashboard

Original file line number	Diff line number	Diff line change
`@@ -45,7 +45,8 @@ import * as express from "express"`
`45`	`45`	`*`
`46`	`46`	`*/`
`47`	`47`
`48`		`-/* Programmability`
	`48`	`+/**`
	`49`	`+ * Programmability`
`49`	`50`	`*`
`50`	`51`	`* There is also a /api/applications endpoint to allow programmatic access to all`
`51`	`52`	`* available applications. It could be used to create a custom application dashboard`