feat: Added test for connect commands (apply, plan, import, etc) + improvements and fixes

Author: kevinwang5658

src/connect/http-routes/create-command.ts

@@ -6,11 +6,12 @@ import WebSocket from 'ws';
 import { Session, SocketServer } from '../socket-server.js';
 
 export enum ConnectCommand {
-  TERMINAL = 'terminal',
+  TERMINAL = 'start terminal',
   APPLY = 'apply',
   PLAN = 'plan',
   IMPORT = 'import',
   REFRESH = 'refresh',
+  INIT = 'init',
 }
 
 interface Params {

src/connect/http-routes/handlers/apply-handler.ts

@@ -1,6 +1,6 @@
 import { spawn } from '@homebridge/node-pty-prebuilt-multiarch';
 import { ConfigFileSchema } from 'codify-schemas';
-import fs from 'node:fs/promises';
+import * as fs from 'node:fs/promises';
 import os from 'node:os';
 import path from 'node:path';
 import { WebSocket } from 'ws';

src/connect/http-routes/handlers/import-handler.ts

@@ -1,7 +1,7 @@
 import { spawn } from '@homebridge/node-pty-prebuilt-multiarch';
 import { ConfigFileSchema } from 'codify-schemas';
 import { diffChars } from 'diff';
-import fs from 'node:fs/promises';
+import * as fs from 'node:fs/promises';
 import os from 'node:os';
 import path from 'node:path';
 import { WebSocket } from 'ws';

src/connect/http-routes/handlers/index.ts

@@ -18,8 +18,6 @@ router.post('/session', (req, res) => {
   }
 
   const sessionId = socketServer.createSession(clientId);
-  console.log('Terminal session created!', sessionId)
-
   return res.status(200).json({ sessionId });
 })
 

src/connect/http-routes/handlers/init-handler.ts

@@ -1,6 +1,6 @@
 import { spawn } from '@homebridge/node-pty-prebuilt-multiarch';
 import { diffChars } from 'diff';
-import fs from 'node:fs/promises';
+import * as fs from 'node:fs/promises';
 import os from 'node:os';
 import path from 'node:path';
 import { WebSocket } from 'ws';
@@ -46,7 +46,7 @@ export function initHandler() {
   }
 
   return createCommandHandler({
-    name: ConnectCommand.IMPORT,
+    name: ConnectCommand.INIT,
     spawnCommand,
     onExit
   });

src/connect/http-routes/handlers/plan-handler.ts

@@ -1,7 +1,7 @@
 import { spawn } from '@homebridge/node-pty-prebuilt-multiarch';
 import { ConfigFileSchema } from 'codify-schemas';
-import fs from 'node:fs/promises';
-import os from 'node:os';
+import * as fs from 'node:fs/promises';
+import * as os from 'node:os';
 import path from 'node:path';
 import { WebSocket } from 'ws';
 
@@ -25,7 +25,7 @@ export function planHandler() {
 
     const tmpDir = await fs.mkdtemp(os.tmpdir());
     const filePath = path.join(tmpDir, 'codify.jsonc');
-    await fs.writeFile(filePath, JSON.stringify(codifyConfig, null, 2));
+    await fs.writeFile(filePath, JSON.stringify(codifyConfig, null, 2), { });
 
     session.additionalData.filePath = filePath;
 

src/connect/http-routes/handlers/refresh-handler.ts

@@ -1,7 +1,7 @@
 import { spawn } from '@homebridge/node-pty-prebuilt-multiarch';
 import { ConfigFileSchema } from 'codify-schemas';
 import { diffChars } from 'diff';
-import fs from 'node:fs/promises';
+import * as fs from 'node:fs/promises';
 import os from 'node:os';
 import path from 'node:path';
 import { WebSocket } from 'ws';
@@ -26,7 +26,7 @@ export function refreshHandler() {
     }
 
     if (!type || !Object.values(RefreshType).includes(type as RefreshType)) {
-      throw new Error('Unable to parse import type');
+      throw new Error('Unable to parse refresh type');
     }
 
     if (type === RefreshType.REFRESH_SPECIFIC && (!resourceTypes || !Array.isArray(resourceTypes))) {

src/connect/http-server.ts

@@ -0,0 +1,91 @@
+import cors from 'cors';
+import express, { json } from 'express';
+// @ts-ignore
+import killPort from 'kill-port'
+import { Server } from 'node:http';
+import open from 'open';
+
+import { config } from '../config.js';
+import { ProcessName, ctx } from '../events/context.js';
+import { Reporter } from '../ui/reporters/reporter.js';
+import { registerKillListeners } from '../utils/register-kill-listeners.js';
+import router from './http-routes/router.js';
+
+export async function createHttpServer(
+  connectionSecret: string,
+  reporter: Reporter,
+  openBrowser = true,
+  onOpen?: (connectionCode: string, server: Server) => void
+): Promise<Server> {
+  const app = express();
+
+  app.use(cors({ origin: config.corsAllowedOrigins }))
+  app.use(json())
+  app.use(createAuthHandler(connectionSecret))
+  app.use(router);
+  app.use(errorHandler)
+  
+  return listen(app, reporter, (server) => {
+    if (openBrowser) {
+      open(`${config.dashboardUrl}/connection/success?code=${connectionSecret}`)
+      console.log(`Open browser window to store code.
+
+If unsuccessful manually enter the code:
+${connectionSecret}`)
+    }
+
+    onOpen?.(connectionSecret, server);
+  });
+  
+}
+
+function listen(app: express.Application, reporter: Reporter, onOpen: (server: Server) => void): Promise<Server> {
+  return new Promise((resolve) => {
+    const server = app.listen(config.connectServerPort, async (error) => {
+      if (error) {
+
+        // This whole below allows the user to terminate the existing instance and continue
+        // Use kill-port to terminate the existing instance
+        if (error.message.includes('EADDRINUSE')) {
+          const ifTerminate = await reporter.promptConfirmation('An instance of \'codify connect\' is already running. Do you want to terminate the existing instance and continue?');
+
+          if (!ifTerminate) {
+            console.error('\n\nExiting...')
+            process.exit(1);
+          }
+
+          ctx.processStarted(ProcessName.TERMINATE)
+          await reporter.displayProgress();
+          await killPort(config.connectServerPort);
+          ctx.processFinished(ProcessName.TERMINATE);
+          await reporter.hide();
+
+          setTimeout(() => {
+            ctx.log('Retrying connection...')
+            listen(app, reporter, onOpen).then((server) => resolve(server));
+          }, 300);
+        }
+      } else {
+        resolve(server);
+        onOpen(server);
+      }
+    });
+
+    registerKillListeners(() => server.close());
+  });
+}
+
+function createAuthHandler(connectionCode: string) {
+  return (req, res, next) => {
+    if (req.header('Authorization') !== connectionCode) {
+      return res.status(400).json({ error: 'Invalid authorization' })
+    }
+
+    next();
+  }
+}
+
+function errorHandler(err, req, res, next) {
+  console.log(err.message);
+  res.status(500).json({ error: err.message });
+}

src/connect/socket-server.ts

@@ -76,12 +76,7 @@ export class SocketServer {
   private onUpgrade = (request: IncomingMessage, socket: Duplex, head: Buffer): void => {
     const { pathname } = new URL(request.url!, 'ws://localhost:51040')
 
-    // Ignore all socket io so it does not interfere
-    if (pathname.includes('socket.io')) {
-      return;
-    }
-
-    if (/*! this.validateOrigin(request.headers.origin ?? request.headers.referer ?? '') || */ !this.validateConnectionSecret(request)) {
+    if (!this.validateConnectionSecret(request)) {
       console.error('Unauthorized request. Connection code:', request.headers['sec-websocket-protocol']);
       socket.write('HTTP/1.1 401 Unauthorized\r\n\r\n')
       socket.destroy();

src/orchestrators/connect.ts

@@ -1,20 +1,12 @@
-import { Config } from '@oclif/core';
-import cors from 'cors';
-import express, { json } from 'express';
-// @ts-ignore
-import killPort from 'kill-port';
 import { randomBytes } from 'node:crypto';
 import { Server } from 'node:http';
-import open from 'open';
 
-import { config } from '../config.js';
-import router from '../connect/http-routes/router.js';
+import { createHttpServer } from '../connect/http-server.js';
 import { LoginHelper } from '../connect/login-helper.js';
 import { SocketServer } from '../connect/socket-server.js';
-import { ProcessName, ctx } from '../events/context.js';
+import { ctx } from '../events/context.js';
 import { Reporter } from '../ui/reporters/reporter.js';
 import { LoginOrchestrator } from './login.js';
-import { registerKillListeners } from '../utils/register-kill-listeners.js';
 
 export class ConnectOrchestrator {
   static rootCommand: string;
@@ -31,60 +23,11 @@ export class ConnectOrchestrator {
     this.nodeBinary = process.execPath;
 
     const connectionSecret = ConnectOrchestrator.tokenGenerate()
-    const app = express();
-
-    app.use(cors({ origin: config.corsAllowedOrigins }))
-    app.use(json())
-    app.use(router);
-
-    const server = await ConnectOrchestrator.listen(app, reporter, (server) => {
-      if (openBrowser) {
-        open(`${config.dashboardUrl}/connection/success?code=${connectionSecret}`)
-        console.log(`Open browser window to store code.
-
-If unsuccessful manually enter the code:
-${connectionSecret}`)
-      }
-
-      onOpen?.(connectionSecret, server);
-    });
 
+    const server = await createHttpServer(connectionSecret, reporter, openBrowser, onOpen);
     SocketServer.init(server, connectionSecret);
   }
 
-  private static listen(app: express.Application, reporter: Reporter, onOpen: (server: Server) => void): Promise<Server> {
-     return new Promise((resolve) => {
-      const server = app.listen(config.connectServerPort, async (error) => {
-        if (error) {
-          if (error.message.includes('EADDRINUSE')) {
-            const ifTerminate = await reporter.promptConfirmation('An instance of \'codify connect\' is already running. Do you want to terminate the existing instance and continue?');
-
-            if (!ifTerminate) {
-              console.error('\n\nExiting...')
-              process.exit(1);
-            }
-
-            ctx.processStarted(ProcessName.TERMINATE)
-            await reporter.displayProgress();
-            await killPort(config.connectServerPort);
-            ctx.processFinished(ProcessName.TERMINATE);
-            await reporter.hide();
-
-            setTimeout(() => {
-              ctx.log('Retrying connection...')
-              ConnectOrchestrator.listen(app, reporter, onOpen).then((server) => resolve(server));
-            }, 300);
-
-          }
-        } else {
-          resolve(server);
-          onOpen(server);
-        }
-      });
-
-      registerKillListeners(() => server.close());
-    });
-  }
 
   private static tokenGenerate(bytes = 4): string {
     return Buffer.from(randomBytes(bytes)).toString('hex')