multiplexer (#22)

* multiplexer

* try fixing workflow

.do_tasks

@@ -0,0 +1 @@
+make terminal tree management logic unit testable

.github/workflows/build.yml

@@ -28,6 +28,9 @@ jobs:
         uses: actions/setup-node@v3
         with:
           node-version: ${{ matrix.node-version }}
+      - uses: actions/setup-python@v4
+        with:
+          python-version: '3.10' 
       - name: install dependencies
         run: npm ci
       - name: run build

README.md

@@ -15,8 +15,8 @@ A fast, elegant and intelligent cross-platform terminal emulator and multiplexer
 - Not written in Rust, yet still blazing fast.
 - GPU-accelerated rendering using [Xterm.js](https://xtermjs.org/).
 - Consistent experience across platforms using [Electron](https://www.electronjs.org/).
-- (WIP) Multi-chord key bindings.
-- (WIP) Built-in tmux-like multiplexer.
+- Multi-chord key bindings.
+- Built-in tmux-like multiplexer.
 
 ## Installation
 

apps/app/babel.config.js

@@ -1,3 +1,7 @@
 module.exports = {
-  presets: ['@babel/preset-env', '@babel/preset-react', '@babel/preset-typescript'],
+  presets: [
+    '@babel/preset-env',
+    '@babel/preset-react',
+    '@babel/preset-typescript',
+  ],
 };

apps/app/package.json

@@ -4,6 +4,7 @@
   "private": true,
   "scripts": {
     "lint": "eslint . --max-warnings 0",
+    "lint:fix": "eslint . --max-warnings 0 --fix",
     "build": "npm run build:app && shx cp -r ../terminal/dist/. dist/terminal/",
     "build:app": "shx rm -rf dist && tsc -p . && webpack --config webpack.config.js && webpack --config webpack.preload.config.js",
     "test": "jest --colors"

apps/app/src/nativeBridge/module.ts

@@ -20,10 +20,8 @@ type NativeBridgeModuleMetadata = {
   events: Record<string, ModuleEvent>;
 };
 
-export const MODULE_METADATA: Map<Function, NativeBridgeModuleMetadata> = new Map<
-  Function,
-  NativeBridgeModuleMetadata
->();
+export const MODULE_METADATA: Map<Function, NativeBridgeModuleMetadata> =
+  new Map<Function, NativeBridgeModuleMetadata>();
 
 function ensureModuleMetadata(ctor: Function): NativeBridgeModuleMetadata {
   if (!MODULE_METADATA.has(ctor)) {
@@ -53,11 +51,17 @@ export function getModuleKey(moduleName: string): string {
   return `TerminalOne:${moduleName}`;
 }
 
-export function getModuleFunctionKey(moduleName: string, functionName: string): string {
+export function getModuleFunctionKey(
+  moduleName: string,
+  functionName: string,
+): string {
   return `${getModuleKey(moduleName)}:${functionName}`;
 }
 
-export function getModuleEventKey(moduleName: string, eventName: string): string {
+export function getModuleEventKey(
+  moduleName: string,
+  eventName: string,
+): string {
   return `${getModuleKey(moduleName)}:${eventName}`;
 }
 

apps/app/src/nativeBridge/modules/applicationModule.ts

@@ -1,7 +1,12 @@
 import { LogLevel } from '@terminalone/types';
 import { app, BrowserWindow, session } from 'electron';
 
-import { moduleEvent, moduleFunction, NativeBridgeModule, nativeBridgeModule } from '../module';
+import {
+  moduleEvent,
+  moduleFunction,
+  NativeBridgeModule,
+  nativeBridgeModule,
+} from '../module';
 import { Logger } from './common/logger';
 
 @nativeBridgeModule('app')
@@ -12,7 +17,10 @@ export class ApplicationModule extends NativeBridgeModule {
   }
 
   @moduleFunction()
-  public async setOpenAtLogin(_mainWindow: BrowserWindow, openAtLogin: boolean): Promise<void> {
+  public async setOpenAtLogin(
+    _mainWindow: BrowserWindow,
+    openAtLogin: boolean,
+  ): Promise<void> {
     if (!app.isPackaged) {
       // do not make the dev app launch on startup
       return;
@@ -38,7 +46,11 @@ export class ApplicationModule extends NativeBridgeModule {
   }
 
   @moduleFunction()
-  public async log(_mainWindow: BrowserWindow, level: LogLevel, message: string): Promise<void> {
+  public async log(
+    _mainWindow: BrowserWindow,
+    level: LogLevel,
+    message: string,
+  ): Promise<void> {
     Logger.getInstance().log(level, message);
   }
 
@@ -48,7 +60,11 @@ export class ApplicationModule extends NativeBridgeModule {
   }
 
   @moduleEvent('on')
-  public onLog(_mainWindow: BrowserWindow, _level: LogLevel, _message: string): void {
+  public onLog(
+    _mainWindow: BrowserWindow,
+    _level: LogLevel,
+    _message: string,
+  ): void {
     return;
   }
 

apps/app/src/nativeBridge/modules/configModule.ts

@@ -1,11 +1,19 @@
-import { DEFAULT_CONFIG, resolveConfig, ResolvedConfig } from '@terminalone/types';
+import {
+  DEFAULT_CONFIG,
+  resolveConfig,
+  ResolvedConfig,
+} from '@terminalone/types';
 import { BrowserWindow } from 'electron';
 import { existsSync, mkdirSync, readFileSync, writeFileSync } from 'fs-extra';
 import os from 'os';
 import path from 'path';
 import vm from 'vm';
 
-import { moduleFunction, NativeBridgeModule, nativeBridgeModule } from '../module';
+import {
+  moduleFunction,
+  NativeBridgeModule,
+  nativeBridgeModule,
+} from '../module';
 import { getAppDirs } from './common';
 import { Logger } from './common/logger';
 
@@ -34,7 +42,10 @@ export class ConfigModule extends NativeBridgeModule {
     const configContent = readFileSync(configPath, 'utf8');
 
     try {
-      const script = new vm.Script(configContent, { filename: 'config.js', displayErrors: true });
+      const script = new vm.Script(configContent, {
+        filename: 'config.js',
+        displayErrors: true,
+      });
       const mod: Record<string, unknown> = {};
       script.runInNewContext({
         module: mod,
@@ -49,7 +60,10 @@ export class ConfigModule extends NativeBridgeModule {
         throw new Error('Invalid config: `module.exports` not set');
       }
 
-      Logger.getInstance().log('info', `Loaded config from ${configPath}}: ${JSON.stringify(mod.exports)}`);
+      Logger.getInstance().log(
+        'info',
+        `Loaded config from ${configPath}}: ${JSON.stringify(mod.exports)}`,
+      );
 
       const resolved = resolveConfig(mod.exports);
       this.config = resolved;

apps/app/src/nativeBridge/modules/externalLinksModule.ts

@@ -1,14 +1,19 @@
 import { BrowserWindow, shell } from 'electron';
 import { existsSync } from 'fs-extra';
 
-import { moduleFunction, NativeBridgeModule, nativeBridgeModule } from '../module';
+import {
+  moduleFunction,
+  NativeBridgeModule,
+  nativeBridgeModule,
+} from '../module';
 
 @nativeBridgeModule('links')
 export class ExternalLinksModule extends NativeBridgeModule {
   @moduleFunction()
   public async openExternalURL(_mainWindow: BrowserWindow, url: string) {
     // Security ref: https://benjamin-altpeter.de/shell-openexternal-dangers/
-    if (typeof url !== 'string') throw new Error('openExternalURL limited to strings');
+    if (typeof url !== 'string')
+      throw new Error('openExternalURL limited to strings');
     if (!url.startsWith('http://') && !url.startsWith('https://'))
       throw new Error('openExternalURL limited to http and https protocol');
     return shell.openExternal(url);

apps/app/src/nativeBridge/modules/mainWindowModule.ts

@@ -2,7 +2,12 @@ import { BrowserWindow } from 'electron';
 import { existsSync, mkdirSync, readFileSync, writeFile } from 'fs-extra';
 import path from 'path';
 
-import { moduleEvent, moduleFunction, NativeBridgeModule, nativeBridgeModule } from '../module';
+import {
+  moduleEvent,
+  moduleFunction,
+  NativeBridgeModule,
+  nativeBridgeModule,
+} from '../module';
 import { getAppDirs } from './common';
 
 @nativeBridgeModule('win')
@@ -23,7 +28,10 @@ export class MainWindowModule extends NativeBridgeModule {
   }
 
   @moduleFunction()
-  public async maximize(mainWindow: BrowserWindow, maximize?: boolean): Promise<void> {
+  public async maximize(
+    mainWindow: BrowserWindow,
+    maximize?: boolean,
+  ): Promise<void> {
     if (maximize === undefined) {
       maximize = true;
     }
@@ -41,12 +49,20 @@ export class MainWindowModule extends NativeBridgeModule {
   }
 
   @moduleFunction()
-  public async setWindowSize(mainWindow: BrowserWindow, width: number, height: number) {
+  public async setWindowSize(
+    mainWindow: BrowserWindow,
+    width: number,
+    height: number,
+  ) {
     mainWindow.setSize(width, height);
   }
 
   @moduleFunction()
-  public async setWindowPosition(mainWindow: BrowserWindow, x: number, y: number) {
+  public async setWindowPosition(
+    mainWindow: BrowserWindow,
+    x: number,
+    y: number,
+  ) {
     mainWindow.setPosition(x, y);
   }
 
@@ -77,7 +93,9 @@ export class MainWindowModule extends NativeBridgeModule {
     const configDir = getAppDirs().userData;
     const stateFilePath = path.join(configDir, 'window.json');
     if (existsSync(stateFilePath)) {
-      const stateFromFile = JSON.parse(readFileSync(stateFilePath, { encoding: 'utf8' }));
+      const stateFromFile = JSON.parse(
+        readFileSync(stateFilePath, { encoding: 'utf8' }),
+      );
       latestState = {
         x: stateFromFile.x ?? x,
         y: stateFromFile.y ?? y,
@@ -123,12 +141,20 @@ export class MainWindowModule extends NativeBridgeModule {
   }
 
   @moduleEvent('on')
-  public onWindowResized(_mainWindow: BrowserWindow, _w: number, _h: number): void {
+  public onWindowResized(
+    _mainWindow: BrowserWindow,
+    _w: number,
+    _h: number,
+  ): void {
     return;
   }
 
   @moduleEvent('on')
-  public onWindowMoved(_mainWindow: BrowserWindow, _x: number, _y: number): void {
+  public onWindowMoved(
+    _mainWindow: BrowserWindow,
+    _x: number,
+    _y: number,
+  ): void {
     return;
   }
 }

apps/app/src/nativeBridge/modules/terminalModule.ts

@@ -3,15 +3,26 @@ import { IPty } from 'node-pty';
 import os from 'os';
 import { osLocaleSync } from 'os-locale';
 
-import { moduleEvent, moduleFunction, NativeBridgeModule, nativeBridgeModule } from '../module';
+import {
+  moduleEvent,
+  moduleFunction,
+  NativeBridgeModule,
+  nativeBridgeModule,
+} from '../module';
 import { Logger } from './common/logger';
 
 class PTYInstance {
   private ptyProcess: IPty;
 
   public readonly id: string;
 
-  constructor(id: string, cols: number, rows: number, shellCommand: string, startupDirectory: string) {
+  constructor(
+    id: string,
+    cols: number,
+    rows: number,
+    shellCommand: string,
+    startupDirectory: string,
+  ) {
     this.id = id;
 
     const shell =
@@ -35,7 +46,10 @@ class PTYInstance {
       },
     });
 
-    Logger.getInstance().log('info', `Created new terminal with id: ${id}, size: ${cols}x${rows}, shell: ${shell}`);
+    Logger.getInstance().log(
+      'info',
+      `Created new terminal with id: ${id}, size: ${cols}x${rows}, shell: ${shell}`,
+    );
   }
 
   public resize(cols: number, rows: number): void {
@@ -63,15 +77,25 @@ export class TerminalModule extends NativeBridgeModule {
   private ptyInstances: { [id: string]: PTYInstance } = {};
 
   @moduleFunction()
-  public async newTerminal(
+  public async createTerminalIfNotExist(
     _mainWindow: BrowserWindow,
     id: string,
     cols: number,
     rows: number,
     shellCommand: string,
     startupDirectory: string,
   ): Promise<void> {
-    const ptyInstance = new PTYInstance(id, cols, rows, shellCommand, startupDirectory);
+    if (this.ptyInstances[id]) {
+      return;
+    }
+
+    const ptyInstance = new PTYInstance(
+      id,
+      cols,
+      rows,
+      shellCommand,
+      startupDirectory,
+    );
     ptyInstance.onData((data: string) => {
       this.onData(_mainWindow, ptyInstance.id, data);
     });
@@ -80,26 +104,41 @@ export class TerminalModule extends NativeBridgeModule {
   }
 
   @moduleFunction()
-  public async resizeTerminal(_mainWindow: BrowserWindow, id: string, cols: number, rows: number): Promise<void> {
+  public async resizeTerminal(
+    _mainWindow: BrowserWindow,
+    id: string,
+    cols: number,
+    rows: number,
+  ): Promise<void> {
     const ptyInstance = this.ptyInstances[id];
     if (ptyInstance) {
       ptyInstance.resize(cols, rows);
     }
   }
 
   @moduleFunction()
-  public async killTerminal(_mainWindow: BrowserWindow, id: string): Promise<void> {
+  public async killTerminal(
+    _mainWindow: BrowserWindow,
+    id: string,
+  ): Promise<void> {
     const ptyInstance = this.ptyInstances[id];
     if (ptyInstance) {
       ptyInstance.kill();
       delete this.ptyInstances[id];
     } else {
-      Logger.getInstance().log('warn', `Could not find terminal with id: ${id}`);
+      Logger.getInstance().log(
+        'warn',
+        `Could not find terminal with id: ${id}`,
+      );
     }
   }
 
   @moduleFunction()
-  public async writeTerminal(_mainWindow: BrowserWindow, id: string, data: string): Promise<void> {
+  public async writeTerminal(
+    _mainWindow: BrowserWindow,
+    id: string,
+    data: string,
+  ): Promise<void> {
     const ptyInstance = this.ptyInstances[id];
     if (ptyInstance) {
       ptyInstance.write(data);