interactive shell

Author: gregsadetsky

package-lock.json

@@ -1,7 +1,7 @@
 {
   "name": "disco",
   "description": "deploy and manage your web projects",
-  "version": "0.5.50",
+  "version": "0.5.51",
   "author": "The Disco Team",
   "bin": {
     "disco": "./bin/run.js"
@@ -26,7 +26,8 @@
     "node-ssh": "^13.2.0",
     "open": "^10.1.0",
     "tunnel-ssh": "^5.1.2",
-    "undici": "^7.7.0"
+    "undici": "^7.7.0",
+    "ws": "^8.18.3"
   },
   "devDependencies": {
     "@oclif/prettier-config": "^0.2.1",
@@ -35,6 +36,7 @@
     "@types/mocha": "^10",
     "@types/node": "^18",
     "@types/ssh2": "^1.15.0",
+    "@types/ws": "^8.18.1",
     "chai": "^4",
     "eslint": "^8",
     "eslint-config-oclif": "^5",

package.json

@@ -0,0 +1,124 @@
+import { Command, Flags } from '@oclif/core'
+import { compare } from 'compare-versions'
+import WebSocket from 'ws'
+
+import { request } from '../auth-request.js'
+import { getDisco } from '../config.js'
+
+export default class Shell extends Command {
+
+  static override description = 'open an interactive shell session in a project container'
+
+  static override examples = [
+    '<%= config.bin %> <%= command.id %> --project mysite',
+    '<%= config.bin %> <%= command.id %> --project mysite --service worker',
+  ]
+
+  static hidden = true
+
+  static override flags = {
+    project: Flags.string({ required: true, description: 'project name' }),
+    service: Flags.string({ required: false, description: 'service name (defaults to web or first non-static service)' }),
+    disco: Flags.string({ required: false, description: 'disco to use' }),
+  }
+
+  public async run(): Promise<void> {
+    const { flags } = await this.parse(Shell)
+
+    const discoConfig = getDisco(flags.disco || null)
+
+    // Check daemon version supports shell
+    const metaUrl = `https://${discoConfig.host}/api/disco/meta`
+    const res = await request({ method: 'GET', url: metaUrl, discoConfig })
+    const meta = (await res.json()) as { version: string }
+
+    if (compare(meta.version, '0.28.0', '<')) {
+      this.error(
+        'Interactive shell is not available for this version of Disco. Please upgrade using `disco meta:upgrade`',
+      )
+    }
+
+    // Connect directly to WebSocket endpoint
+    const wsUrl = `wss://${discoConfig.host}/api/projects/${flags.project}/shell`
+
+    const ws = new WebSocket(wsUrl)
+
+    const restoreTerminal = () => {
+      if (process.stdin.isTTY) {
+        process.stdin.setRawMode(false)
+      }
+      process.stdin.pause()
+    }
+
+    ws.on('open', () => {
+      // Send API key and optional service as first message for authentication
+      const authMessage: { token: string; service?: string } = { token: discoConfig.apiKey }
+      if (flags.service) {
+        authMessage.service = flags.service
+      }
+      ws.send(JSON.stringify(authMessage))
+    })
+
+    ws.on('message', (data: WebSocket.RawData, isBinary: boolean) => {
+      if (isBinary) {
+        // Binary data = terminal output
+        process.stdout.write(data as Buffer)
+      } else {
+        // Text data = JSON control message
+        try {
+          const message = JSON.parse(data.toString())
+          if (message.type === 'connected') {
+            // Successfully authenticated, set up terminal
+            if (process.stdin.isTTY) {
+              process.stdin.setRawMode(true)
+            }
+            process.stdin.resume()
+
+            // Send initial terminal size
+            if (process.stdout.isTTY) {
+              ws.send(JSON.stringify({
+                type: 'resize',
+                cols: process.stdout.columns,
+                rows: process.stdout.rows,
+              }))
+            }
+
+            // Handle terminal resize
+            process.stdout.on('resize', () => {
+              if (process.stdout.isTTY && ws.readyState === WebSocket.OPEN) {
+                ws.send(JSON.stringify({
+                  type: 'resize',
+                  cols: process.stdout.columns,
+                  rows: process.stdout.rows,
+                }))
+              }
+            })
+
+            // Forward stdin to WebSocket as binary
+            process.stdin.on('data', (chunk: Buffer) => {
+              if (ws.readyState === WebSocket.OPEN) {
+                ws.send(chunk)
+              }
+            })
+          }
+        } catch {
+          // Not JSON, treat as text output
+          process.stdout.write(data.toString())
+        }
+      }
+    })
+
+    ws.on('close', (code, reason) => {
+      restoreTerminal()
+      if (code !== 1000) {
+        this.error(`Connection closed: ${code} ${reason.toString()}`)
+      }
+      process.exit(0)
+    })
+
+    ws.on('error', (err) => {
+      restoreTerminal()
+      this.error(`WebSocket error: ${err.message}`)
+    })
+  }
+}

src/commands/shell.ts

@@ -1 +1 @@
-{"root":["./src/auth-request.ts","./src/config.ts","./src/index.ts","./src/commands/deploy.ts","./src/commands/init.ts","./src/commands/logs.ts","./src/commands/run.ts","./src/commands/apikeys/list.ts","./src/commands/apikeys/remove.ts","./src/commands/deploy/cancel.ts","./src/commands/deploy/list.ts","./src/commands/deploy/output.ts","./src/commands/discos/list.ts","./src/commands/domains/add.ts","./src/commands/domains/list.ts","./src/commands/domains/remove.ts","./src/commands/env/get.ts","./src/commands/env/list.ts","./src/commands/env/remove.ts","./src/commands/env/set.ts","./src/commands/github/apps/add.ts","./src/commands/github/apps/list.ts","./src/commands/github/apps/manage.ts","./src/commands/github/apps/prune.ts","./src/commands/github/repos/list.ts","./src/commands/invite/accept.ts","./src/commands/invite/create.ts","./src/commands/meta/host.ts","./src/commands/meta/info.ts","./src/commands/meta/stats.ts","./src/commands/meta/upgrade.ts","./src/commands/nodes/add.ts","./src/commands/nodes/list.ts","./src/commands/nodes/remove.ts","./src/commands/postgres/create.ts","./src/commands/postgres/tunnel.ts","./src/commands/postgres/addon/install.ts","./src/commands/postgres/addon/remove.ts","./src/commands/postgres/addon/update.ts","./src/commands/postgres/databases/add.ts","./src/commands/postgres/databases/attach.ts","./src/commands/postgres/databases/detach.ts","./src/commands/postgres/databases/list.ts","./src/commands/postgres/databases/remove.ts","./src/commands/postgres/instances/add.ts","./src/commands/postgres/instances/list.ts","./src/commands/postgres/instances/remove.ts","./src/commands/projects/add.ts","./src/commands/projects/list.ts","./src/commands/projects/move.ts","./src/commands/projects/remove.ts","./src/commands/registry/addon/install.ts","./src/commands/registry/addon/remove.ts","./src/commands/registry/addon/update.ts","./src/commands/scale/get.ts","./src/commands/scale/set.ts","./src/commands/syslog/add.ts","./src/commands/syslog/list.ts","./src/commands/syslog/remove.ts","./src/commands/volumes/export.ts","./src/commands/volumes/import.ts","./src/commands/volumes/list.ts"],"version":"5.8.3"}
+{"root":["./src/auth-request.ts","./src/config.ts","./src/index.ts","./src/commands/deploy.ts","./src/commands/init.ts","./src/commands/logs.ts","./src/commands/run.ts","./src/commands/shell.ts","./src/commands/apikeys/list.ts","./src/commands/apikeys/remove.ts","./src/commands/deploy/cancel.ts","./src/commands/deploy/list.ts","./src/commands/deploy/output.ts","./src/commands/discos/list.ts","./src/commands/domains/add.ts","./src/commands/domains/list.ts","./src/commands/domains/remove.ts","./src/commands/env/get.ts","./src/commands/env/list.ts","./src/commands/env/remove.ts","./src/commands/env/set.ts","./src/commands/github/apps/add.ts","./src/commands/github/apps/list.ts","./src/commands/github/apps/manage.ts","./src/commands/github/apps/prune.ts","./src/commands/github/repos/list.ts","./src/commands/invite/accept.ts","./src/commands/invite/create.ts","./src/commands/meta/host.ts","./src/commands/meta/info.ts","./src/commands/meta/stats.ts","./src/commands/meta/upgrade.ts","./src/commands/nodes/add.ts","./src/commands/nodes/list.ts","./src/commands/nodes/remove.ts","./src/commands/postgres/create.ts","./src/commands/postgres/tunnel.ts","./src/commands/postgres/addon/install.ts","./src/commands/postgres/addon/remove.ts","./src/commands/postgres/addon/update.ts","./src/commands/postgres/databases/add.ts","./src/commands/postgres/databases/attach.ts","./src/commands/postgres/databases/detach.ts","./src/commands/postgres/databases/list.ts","./src/commands/postgres/databases/remove.ts","./src/commands/postgres/instances/add.ts","./src/commands/postgres/instances/list.ts","./src/commands/postgres/instances/remove.ts","./src/commands/projects/add.ts","./src/commands/projects/list.ts","./src/commands/projects/move.ts","./src/commands/projects/remove.ts","./src/commands/registry/addon/install.ts","./src/commands/registry/addon/remove.ts","./src/commands/registry/addon/update.ts","./src/commands/scale/get.ts","./src/commands/scale/set.ts","./src/commands/syslog/add.ts","./src/commands/syslog/list.ts","./src/commands/syslog/remove.ts","./src/commands/volumes/export.ts","./src/commands/volumes/import.ts","./src/commands/volumes/list.ts"],"version":"5.8.3"}