Better plugin development experience (#118)

plugin-runtime/src/PluginHandle.ts

@@ -1,14 +1,15 @@
-import { InternalEvent } from '@yaakapp/api';
+import { BootRequest, InternalEvent } from '@yaakapp-internal/plugin';
 import path from 'node:path';
 import { Worker } from 'node:worker_threads';
 import { EventChannel } from './EventChannel';
+import { PluginWorkerData } from './index.worker';
 
 export class PluginHandle {
   #worker: Worker;
 
   constructor(
-    readonly pluginDir: string,
     readonly pluginRefId: string,
+    readonly bootRequest: BootRequest,
     readonly events: EventChannel,
   ) {
     this.#worker = this.#createWorker();
@@ -24,28 +25,32 @@ export class PluginHandle {
 
   #createWorker(): Worker {
     const workerPath = process.env.YAAK_WORKER_PATH ?? path.join(__dirname, 'index.worker.cjs');
+    const workerData: PluginWorkerData = {
+      pluginRefId: this.pluginRefId,
+      bootRequest: this.bootRequest,
+    };
     const worker = new Worker(workerPath, {
-      workerData: { pluginDir: this.pluginDir, pluginRefId: this.pluginRefId },
+      workerData,
     });
 
     worker.on('message', (e) => this.events.emit(e));
     worker.on('error', this.#handleError.bind(this));
     worker.on('exit', this.#handleExit.bind(this));
 
-    console.log('Created plugin worker for ', this.pluginDir);
+    console.log('Created plugin worker for ', this.bootRequest.dir);
 
     return worker;
   }
 
   async #handleError(err: Error) {
-    console.error('Plugin errored', this.pluginDir, err);
+    console.error('Plugin errored', this.bootRequest.dir, err);
   }
 
   async #handleExit(code: number) {
     if (code === 0) {
-      console.log('Plugin exited successfully', this.pluginDir);
+      console.log('Plugin exited successfully', this.bootRequest.dir);
     } else {
-      console.log('Plugin exited with status', code, this.pluginDir);
+      console.log('Plugin exited with status', code, this.bootRequest.dir);
     }
   }
 }

plugin-runtime/src/index.ts

@@ -18,7 +18,7 @@ const plugins: Record<string, PluginHandle> = {};
       const pluginEvent: InternalEvent = JSON.parse(e.event);
       // Handle special event to bootstrap plugin
       if (pluginEvent.payload.type === 'boot_request') {
-        const plugin = new PluginHandle(pluginEvent.payload.dir, pluginEvent.pluginRefId, events);
+        const plugin = new PluginHandle(pluginEvent.pluginRefId, pluginEvent.payload, events);
         plugins[pluginEvent.pluginRefId] = plugin;
       }
 

plugin-runtime/src/index.worker.ts

@@ -1,4 +1,5 @@
 import {
+  BootRequest,
   Context,
   FindHttpResponsesResponse,
   GetHttpRequestByIdResponse,
@@ -14,13 +15,21 @@ import { HttpRequestActionPlugin } from '@yaakapp/api/lib/plugins/HttpRequestAct
 import { TemplateFunctionPlugin } from '@yaakapp/api/lib/plugins/TemplateFunctionPlugin';
 import interceptStdout from 'intercept-stdout';
 import * as console from 'node:console';
-import { Stats, readFileSync, statSync, watch } from 'node:fs';
+import { readFileSync, Stats, statSync, watch } from 'node:fs';
 import path from 'node:path';
 import * as util from 'node:util';
 import { parentPort, workerData } from 'node:worker_threads';
 
+export interface PluginWorkerData {
+  bootRequest: BootRequest;
+  pluginRefId: string;
+}
+
 async function initialize() {
-  const { pluginDir, pluginRefId } = workerData;
+  const {
+    bootRequest: { dir: pluginDir, watch: enableWatch },
+    pluginRefId,
+  }: PluginWorkerData = workerData;
   const pathPkg = path.join(pluginDir, 'package.json');
 
   const pathMod = path.posix.join(pluginDir, 'build', 'index.js');
@@ -102,8 +111,10 @@ async function initialize() {
     return sendPayload({ type: 'reload_response' }, null);
   };
 
-  watchFile(pathMod, cb);
-  watchFile(pathPkg, cb);
+  if (enableWatch) {
+    watchFile(pathMod, cb);
+    watchFile(pathPkg, cb);
+  }
 
   const ctx: Context = {
     clipboard: {