Start on plugin ctx API (#64)

plugin-runtime/src/gen/plugins/runtime.ts

@@ -10,369 +10,10 @@ import * as _m0 from "protobufjs/minimal";
 
 export const protobufPackage = "yaak.plugins.runtime";
 
-export interface PluginInfo {
-  plugin: string;
-}
-
-export interface HookResponse {
-  info: PluginInfo | undefined;
-  data: string;
-}
-
-export interface HookImportRequest {
-  data: string;
-}
-
-export interface HookResponseFilterRequest {
-  filter: string;
-  body: string;
-  contentType: string;
-}
-
-export interface HookExportRequest {
-  request: string;
-}
-
 export interface EventStreamEvent {
   event: string;
 }
 
-function createBasePluginInfo(): PluginInfo {
-  return { plugin: "" };
-}
-
-export const PluginInfo = {
-  encode(message: PluginInfo, writer: _m0.Writer = _m0.Writer.create()): _m0.Writer {
-    if (message.plugin !== "") {
-      writer.uint32(10).string(message.plugin);
-    }
-    return writer;
-  },
-
-  decode(input: _m0.Reader | Uint8Array, length?: number): PluginInfo {
-    const reader = input instanceof _m0.Reader ? input : _m0.Reader.create(input);
-    let end = length === undefined ? reader.len : reader.pos + length;
-    const message = createBasePluginInfo();
-    while (reader.pos < end) {
-      const tag = reader.uint32();
-      switch (tag >>> 3) {
-        case 1:
-          if (tag !== 10) {
-            break;
-          }
-
-          message.plugin = reader.string();
-          continue;
-      }
-      if ((tag & 7) === 4 || tag === 0) {
-        break;
-      }
-      reader.skipType(tag & 7);
-    }
-    return message;
-  },
-
-  fromJSON(object: any): PluginInfo {
-    return { plugin: isSet(object.plugin) ? globalThis.String(object.plugin) : "" };
-  },
-
-  toJSON(message: PluginInfo): unknown {
-    const obj: any = {};
-    if (message.plugin !== "") {
-      obj.plugin = message.plugin;
-    }
-    return obj;
-  },
-
-  create(base?: DeepPartial<PluginInfo>): PluginInfo {
-    return PluginInfo.fromPartial(base ?? {});
-  },
-  fromPartial(object: DeepPartial<PluginInfo>): PluginInfo {
-    const message = createBasePluginInfo();
-    message.plugin = object.plugin ?? "";
-    return message;
-  },
-};
-
-function createBaseHookResponse(): HookResponse {
-  return { info: undefined, data: "" };
-}
-
-export const HookResponse = {
-  encode(message: HookResponse, writer: _m0.Writer = _m0.Writer.create()): _m0.Writer {
-    if (message.info !== undefined) {
-      PluginInfo.encode(message.info, writer.uint32(10).fork()).ldelim();
-    }
-    if (message.data !== "") {
-      writer.uint32(18).string(message.data);
-    }
-    return writer;
-  },
-
-  decode(input: _m0.Reader | Uint8Array, length?: number): HookResponse {
-    const reader = input instanceof _m0.Reader ? input : _m0.Reader.create(input);
-    let end = length === undefined ? reader.len : reader.pos + length;
-    const message = createBaseHookResponse();
-    while (reader.pos < end) {
-      const tag = reader.uint32();
-      switch (tag >>> 3) {
-        case 1:
-          if (tag !== 10) {
-            break;
-          }
-
-          message.info = PluginInfo.decode(reader, reader.uint32());
-          continue;
-        case 2:
-          if (tag !== 18) {
-            break;
-          }
-
-          message.data = reader.string();
-          continue;
-      }
-      if ((tag & 7) === 4 || tag === 0) {
-        break;
-      }
-      reader.skipType(tag & 7);
-    }
-    return message;
-  },
-
-  fromJSON(object: any): HookResponse {
-    return {
-      info: isSet(object.info) ? PluginInfo.fromJSON(object.info) : undefined,
-      data: isSet(object.data) ? globalThis.String(object.data) : "",
-    };
-  },
-
-  toJSON(message: HookResponse): unknown {
-    const obj: any = {};
-    if (message.info !== undefined) {
-      obj.info = PluginInfo.toJSON(message.info);
-    }
-    if (message.data !== "") {
-      obj.data = message.data;
-    }
-    return obj;
-  },
-
-  create(base?: DeepPartial<HookResponse>): HookResponse {
-    return HookResponse.fromPartial(base ?? {});
-  },
-  fromPartial(object: DeepPartial<HookResponse>): HookResponse {
-    const message = createBaseHookResponse();
-    message.info = (object.info !== undefined && object.info !== null)
-      ? PluginInfo.fromPartial(object.info)
-      : undefined;
-    message.data = object.data ?? "";
-    return message;
-  },
-};
-
-function createBaseHookImportRequest(): HookImportRequest {
-  return { data: "" };
-}
-
-export const HookImportRequest = {
-  encode(message: HookImportRequest, writer: _m0.Writer = _m0.Writer.create()): _m0.Writer {
-    if (message.data !== "") {
-      writer.uint32(10).string(message.data);
-    }
-    return writer;
-  },
-
-  decode(input: _m0.Reader | Uint8Array, length?: number): HookImportRequest {
-    const reader = input instanceof _m0.Reader ? input : _m0.Reader.create(input);
-    let end = length === undefined ? reader.len : reader.pos + length;
-    const message = createBaseHookImportRequest();
-    while (reader.pos < end) {
-      const tag = reader.uint32();
-      switch (tag >>> 3) {
-        case 1:
-          if (tag !== 10) {
-            break;
-          }
-
-          message.data = reader.string();
-          continue;
-      }
-      if ((tag & 7) === 4 || tag === 0) {
-        break;
-      }
-      reader.skipType(tag & 7);
-    }
-    return message;
-  },
-
-  fromJSON(object: any): HookImportRequest {
-    return { data: isSet(object.data) ? globalThis.String(object.data) : "" };
-  },
-
-  toJSON(message: HookImportRequest): unknown {
-    const obj: any = {};
-    if (message.data !== "") {
-      obj.data = message.data;
-    }
-    return obj;
-  },
-
-  create(base?: DeepPartial<HookImportRequest>): HookImportRequest {
-    return HookImportRequest.fromPartial(base ?? {});
-  },
-  fromPartial(object: DeepPartial<HookImportRequest>): HookImportRequest {
-    const message = createBaseHookImportRequest();
-    message.data = object.data ?? "";
-    return message;
-  },
-};
-
-function createBaseHookResponseFilterRequest(): HookResponseFilterRequest {
-  return { filter: "", body: "", contentType: "" };
-}
-
-export const HookResponseFilterRequest = {
-  encode(message: HookResponseFilterRequest, writer: _m0.Writer = _m0.Writer.create()): _m0.Writer {
-    if (message.filter !== "") {
-      writer.uint32(10).string(message.filter);
-    }
-    if (message.body !== "") {
-      writer.uint32(18).string(message.body);
-    }
-    if (message.contentType !== "") {
-      writer.uint32(26).string(message.contentType);
-    }
-    return writer;
-  },
-
-  decode(input: _m0.Reader | Uint8Array, length?: number): HookResponseFilterRequest {
-    const reader = input instanceof _m0.Reader ? input : _m0.Reader.create(input);
-    let end = length === undefined ? reader.len : reader.pos + length;
-    const message = createBaseHookResponseFilterRequest();
-    while (reader.pos < end) {
-      const tag = reader.uint32();
-      switch (tag >>> 3) {
-        case 1:
-          if (tag !== 10) {
-            break;
-          }
-
-          message.filter = reader.string();
-          continue;
-        case 2:
-          if (tag !== 18) {
-            break;
-          }
-
-          message.body = reader.string();
-          continue;
-        case 3:
-          if (tag !== 26) {
-            break;
-          }
-
-          message.contentType = reader.string();
-          continue;
-      }
-      if ((tag & 7) === 4 || tag === 0) {
-        break;
-      }
-      reader.skipType(tag & 7);
-    }
-    return message;
-  },
-
-  fromJSON(object: any): HookResponseFilterRequest {
-    return {
-      filter: isSet(object.filter) ? globalThis.String(object.filter) : "",
-      body: isSet(object.body) ? globalThis.String(object.body) : "",
-      contentType: isSet(object.contentType) ? globalThis.String(object.contentType) : "",
-    };
-  },
-
-  toJSON(message: HookResponseFilterRequest): unknown {
-    const obj: any = {};
-    if (message.filter !== "") {
-      obj.filter = message.filter;
-    }
-    if (message.body !== "") {
-      obj.body = message.body;
-    }
-    if (message.contentType !== "") {
-      obj.contentType = message.contentType;
-    }
-    return obj;
-  },
-
-  create(base?: DeepPartial<HookResponseFilterRequest>): HookResponseFilterRequest {
-    return HookResponseFilterRequest.fromPartial(base ?? {});
-  },
-  fromPartial(object: DeepPartial<HookResponseFilterRequest>): HookResponseFilterRequest {
-    const message = createBaseHookResponseFilterRequest();
-    message.filter = object.filter ?? "";
-    message.body = object.body ?? "";
-    message.contentType = object.contentType ?? "";
-    return message;
-  },
-};
-
-function createBaseHookExportRequest(): HookExportRequest {
-  return { request: "" };
-}
-
-export const HookExportRequest = {
-  encode(message: HookExportRequest, writer: _m0.Writer = _m0.Writer.create()): _m0.Writer {
-    if (message.request !== "") {
-      writer.uint32(10).string(message.request);
-    }
-    return writer;
-  },
-
-  decode(input: _m0.Reader | Uint8Array, length?: number): HookExportRequest {
-    const reader = input instanceof _m0.Reader ? input : _m0.Reader.create(input);
-    let end = length === undefined ? reader.len : reader.pos + length;
-    const message = createBaseHookExportRequest();
-    while (reader.pos < end) {
-      const tag = reader.uint32();
-      switch (tag >>> 3) {
-        case 1:
-          if (tag !== 10) {
-            break;
-          }
-
-          message.request = reader.string();
-          continue;
-      }
-      if ((tag & 7) === 4 || tag === 0) {
-        break;
-      }
-      reader.skipType(tag & 7);
-    }
-    return message;
-  },
-
-  fromJSON(object: any): HookExportRequest {
-    return { request: isSet(object.request) ? globalThis.String(object.request) : "" };
-  },
-
-  toJSON(message: HookExportRequest): unknown {
-    const obj: any = {};
-    if (message.request !== "") {
-      obj.request = message.request;
-    }
-    return obj;
-  },
-
-  create(base?: DeepPartial<HookExportRequest>): HookExportRequest {
-    return HookExportRequest.fromPartial(base ?? {});
-  },
-  fromPartial(object: DeepPartial<HookExportRequest>): HookExportRequest {
-    const message = createBaseHookExportRequest();
-    message.request = object.request ?? "";
-    return message;
-  },
-};
-
 function createBaseEventStreamEvent(): EventStreamEvent {
   return { event: "" };
 }

plugin-runtime/src/index.worker.ts

@@ -1,4 +1,11 @@
-import { ImportResponse, InternalEvent, InternalEventPayload } from '@yaakapp/api';
+import {
+  GetHttpRequestByIdResponse,
+  ImportResponse,
+  InternalEvent,
+  InternalEventPayload,
+  SendHttpRequestResponse,
+} from '@yaakapp/api';
+import { YaakContext } from '@yaakapp/api/lib/plugins/context';
 import interceptStdout from 'intercept-stdout';
 import * as console from 'node:console';
 import { readFileSync } from 'node:fs';
@@ -7,7 +14,7 @@ import * as util from 'node:util';
 import { parentPort, workerData } from 'node:worker_threads';
 
 new Promise<void>(async (resolve, reject) => {
-  const { pluginDir /*, pluginRefId*/ } = workerData;
+  const { pluginDir, pluginRefId } = workerData;
   const pathPkg = path.join(pluginDir, 'package.json');
 
   // NOTE: Use POSIX join because require() needs forward slash
@@ -33,8 +40,64 @@ new Promise<void>(async (resolve, reject) => {
 
   console.log('Plugin initialized', pkg.name, capabilities, Object.keys(mod));
 
+  function buildEventToSend(
+    payload: InternalEventPayload,
+    replyId: string | null = null,
+  ): InternalEvent {
+    return { pluginRefId, id: genId(), replyId, payload };
+  }
+
+  function sendPayload(payload: InternalEventPayload, replyId: string | null = null): string {
+    const event = buildEventToSend(payload, replyId);
+    sendEvent(event);
+    return event.id;
+  }
+
+  function sendEvent(event: InternalEvent) {
+    parentPort!.postMessage(event);
+  }
+
+  async function sendAndWaitForReply<T extends Omit<InternalEventPayload, 'type'>>(
+    payload: InternalEventPayload,
+  ): Promise<T> {
+    // 1. Build event to send
+    const eventToSend = buildEventToSend(payload, null);
+
+    // 2. Spawn listener in background
+    const promise = new Promise<InternalEventPayload>(async (resolve) => {
+      const cb = (event: InternalEvent) => {
+        if (event.replyId === eventToSend.id) {
+          resolve(event.payload); // Not type-safe but oh well
+          parentPort!.off('message', cb); // Unlisten, now that we're done
+        }
+      };
+      parentPort!.on('message', cb);
+    });
+
+    // 3. Send the event after we start listening (to prevent race)
+    sendEvent(eventToSend);
+
+    // 4. Return the listener promise
+    return promise as unknown as Promise<T>;
+  }
+
+  const ctx: YaakContext = {
+    httpRequest: {
+      async getById({ id }) {
+        const payload = { type: 'get_http_request_by_id_request', id } as const;
+        const { httpRequest } = await sendAndWaitForReply<GetHttpRequestByIdResponse>(payload);
+        return httpRequest;
+      },
+      async send({ httpRequest }) {
+        const payload = { type: 'send_http_request_request', httpRequest } as const;
+        const { httpResponse } = await sendAndWaitForReply<SendHttpRequestResponse>(payload);
+        return httpResponse;
+      },
+    },
+  };
+
   // Message comes into the plugin to be processed
-  parentPort!.on('message', async ({ payload, pluginRefId, id: replyId }: InternalEvent) => {
+  parentPort!.on('message', async ({ payload, id: replyId }: InternalEvent) => {
     console.log(`Received ${payload.type}`);
 
     try {
@@ -45,18 +108,18 @@ new Promise<void>(async (resolve, reject) => {
           version: pkg.version,
           capabilities,
         };
-        sendToServer({ id: genId(), pluginRefId, replyId, payload });
+        sendPayload(payload, replyId);
         return;
       }
 
       if (payload.type === 'import_request' && typeof mod.pluginHookImport === 'function') {
-        const reply: ImportResponse | null = await mod.pluginHookImport({}, payload.content);
+        const reply: ImportResponse | null = await mod.pluginHookImport(ctx, payload.content);
         if (reply != null) {
           const replyPayload: InternalEventPayload = {
             type: 'import_response',
             resources: reply?.resources,
           };
-          sendToServer({ id: genId(), pluginRefId, replyId, payload: replyPayload });
+          sendPayload(replyPayload, replyId);
           return;
         } else {
           // Continue, to send back an empty reply
@@ -67,25 +130,25 @@ new Promise<void>(async (resolve, reject) => {
         payload.type === 'export_http_request_request' &&
         typeof mod.pluginHookExport === 'function'
       ) {
-        const reply: string = await mod.pluginHookExport({}, payload.httpRequest);
+        const reply: string = await mod.pluginHookExport(ctx, payload.httpRequest);
         const replyPayload: InternalEventPayload = {
           type: 'export_http_request_response',
           content: reply,
         };
-        sendToServer({ id: genId(), pluginRefId, replyId, payload: replyPayload });
+        sendPayload(replyPayload, replyId);
         return;
       }
 
       if (payload.type === 'filter_request' && typeof mod.pluginHookResponseFilter === 'function') {
-        const reply: string = await mod.pluginHookResponseFilter(
-          {},
-          { filter: payload.filter, body: payload.content },
-        );
+        const reply: string = await mod.pluginHookResponseFilter(ctx, {
+          filter: payload.filter,
+          body: payload.content,
+        });
         const replyPayload: InternalEventPayload = {
           type: 'filter_response',
           content: reply,
         };
-        sendToServer({ id: genId(), pluginRefId, replyId, payload: replyPayload });
+        sendPayload(replyPayload, replyId);
         return;
       }
     } catch (err) {
@@ -94,9 +157,7 @@ new Promise<void>(async (resolve, reject) => {
     }
 
     // No matches, so send back an empty response so the caller doesn't block forever
-    const id = genId();
-    console.log('Sending nothing back to', id, { replyId });
-    sendToServer({ id, pluginRefId, replyId, payload: { type: 'empty_response' } });
+    sendPayload({ type: 'empty_response' }, replyId);
   });
 
   resolve();
@@ -104,10 +165,6 @@ new Promise<void>(async (resolve, reject) => {
   console.log('failed to boot plugin', err);
 });
 
-function sendToServer(e: InternalEvent) {
-  parentPort!.postMessage(e);
-}
-
 function genId(len = 5): string {
   const alphabet = '01234567890abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ';
   let id = '';