feat: signature in payload

ubiquity-os · Jun 3, 2024 · 6cfd934 · 6cfd934
1 parent 5830d37
commit 6cfd934
Show file tree

Hide file tree

Showing 6 changed files with 42 additions and 16 deletions.
diff --git a/src/github/handlers/index.ts b/src/github/handlers/index.ts
@@ -4,7 +4,7 @@ import { GitHubEventHandler } from "../github-event-handler";
 import { getConfig } from "../utils/config";
 import { repositoryDispatch } from "./repository-dispatch";
 import { dispatchWorker, dispatchWorkflow, getDefaultBranch } from "../utils/workflow-dispatch";
-import { DelegatedComputeInputs } from "../types/plugin";
+import { PluginInput } from "../types/plugin";
 import { isGithubPlugin, PluginConfiguration } from "../types/plugin-configuration";
 
 function tryCatchWrapper(fn: (event: EmitterWebhookEvent) => unknown) {
@@ -86,20 +86,20 @@ async function handleEvent(event: EmitterWebhookEvent, eventHandler: InstanceTyp
 
     const ref = isGithubPluginObject ? plugin.ref ?? (await getDefaultBranch(context, plugin.owner, plugin.repo)) : plugin;
     const token = await eventHandler.getToken(event.payload.installation.id);
-    const inputs = new DelegatedComputeInputs(stateId, context.key, event.payload, settings, token, ref);
+    const inputs = new PluginInput(context.eventHandler, stateId, context.key, event.payload, settings, token, ref);
 
     state.inputs[0] = inputs;
     await eventHandler.pluginChainState.put(stateId, state);
 
     if (!isGithubPluginObject) {
-      await dispatchWorker(plugin, inputs.getInputs());
+      await dispatchWorker(plugin, await inputs.getWorkerInputs());
     } else {
       await dispatchWorkflow(context, {
         owner: plugin.owner,
         repository: plugin.repo,
         workflowId: plugin.workflowId,
         ref: plugin.ref,
-        inputs: inputs.getInputs(),
+        inputs: inputs.getWorkflowInputs(),
       });
     }
   }

diff --git a/src/github/handlers/repository-dispatch.ts b/src/github/handlers/repository-dispatch.ts
@@ -1,7 +1,7 @@
 import { GitHubContext } from "../github-context";
 import { dispatchWorker, dispatchWorkflow, getDefaultBranch } from "../utils/workflow-dispatch";
 import { Value } from "@sinclair/typebox/value";
-import { DelegatedComputeInputs, PluginChainState, expressionRegex, pluginOutputSchema } from "../types/plugin";
+import { PluginInput, PluginChainState, expressionRegex, pluginOutputSchema } from "../types/plugin";
 import { isGithubPlugin } from "../types/plugin-configuration";
 
 export async function repositoryDispatch(context: GitHubContext<"repository_dispatch">) {
@@ -61,7 +61,7 @@ export async function repositoryDispatch(context: GitHubContext<"repository_disp
   } else {
     ref = nextPlugin.plugin;
   }
-  const inputs = new DelegatedComputeInputs(pluginOutput.state_id, state.eventName, state.eventPayload, settings, token, ref);
+  const inputs = new PluginInput(context.eventHandler, pluginOutput.state_id, state.eventName, state.eventPayload, settings, token, ref);
 
   state.currentPlugin++;
   state.inputs[state.currentPlugin] = inputs;
@@ -73,10 +73,10 @@ export async function repositoryDispatch(context: GitHubContext<"repository_disp
       repository: nextPlugin.plugin.repo,
       ref: nextPlugin.plugin.ref,
       workflowId: nextPlugin.plugin.workflowId,
-      inputs: inputs.getInputs(),
+      inputs: inputs.getWorkflowInputs(),
     });
   } else {
-    await dispatchWorker(nextPlugin.plugin, inputs.getInputs());
+    await dispatchWorker(nextPlugin.plugin, await inputs.getWorkerInputs());
   }
 }
 

diff --git a/src/github/types/plugin-configuration.ts b/src/github/types/plugin-configuration.ts
@@ -50,7 +50,7 @@ const pluginChainSchema = T.Array(
     id: T.Optional(T.String()),
     plugin: githubPluginType(),
     type: T.Union([T.Literal("github")], { default: "github" }),
-    with: T.Record(T.String(), T.Unknown()),
+    with: T.Record(T.String(), T.Unknown(), { default: {} }),
   }),
   { minItems: 1 }
 );

diff --git a/src/github/types/plugin.ts b/src/github/types/plugin.ts
@@ -1,6 +1,7 @@
 import { EmitterWebhookEvent, EmitterWebhookEventName } from "@octokit/webhooks";
 import { StaticDecode, Type } from "@sinclair/typebox";
 import { PluginChain } from "./plugin-configuration";
+import { GitHubEventHandler } from "../github-event-handler";
 
 export const expressionRegex = /^\s*\${{\s*(\S+)\s*}}\s*$/;
 
@@ -17,15 +18,25 @@ export const pluginOutputSchema = Type.Object({
 
 export type PluginOutput = StaticDecode<typeof pluginOutputSchema>;
 
-export class DelegatedComputeInputs<T extends EmitterWebhookEventName = EmitterWebhookEventName> {
+export class PluginInput<T extends EmitterWebhookEventName = EmitterWebhookEventName> {
+  public eventHandler: GitHubEventHandler;
   public stateId: string;
   public eventName: T;
   public eventPayload: EmitterWebhookEvent<T>["payload"];
   public settings: unknown;
   public authToken: string;
   public ref: string;
 
-  constructor(stateId: string, eventName: T, eventPayload: EmitterWebhookEvent<T>["payload"], settings: unknown, authToken: string, ref: string) {
+  constructor(
+    eventHandler: GitHubEventHandler,
+    stateId: string,
+    eventName: T,
+    eventPayload: EmitterWebhookEvent<T>["payload"],
+    settings: unknown,
+    authToken: string,
+    ref: string
+  ) {
+    this.eventHandler = eventHandler;
     this.stateId = stateId;
     this.eventName = eventName;
     this.eventPayload = eventPayload;
@@ -34,7 +45,7 @@ export class DelegatedComputeInputs<T extends EmitterWebhookEventName = EmitterW
     this.ref = ref;
   }
 
-  public getInputs() {
+  public getWorkflowInputs() {
     return {
       stateId: this.stateId,
       eventName: this.eventName,
@@ -44,6 +55,22 @@ export class DelegatedComputeInputs<T extends EmitterWebhookEventName = EmitterW
       ref: this.ref,
     };
   }
+
+  public async getWorkerInputs() {
+    const inputs = {
+      stateId: this.stateId,
+      eventName: this.eventName,
+      eventPayload: this.eventPayload,
+      settings: this.settings,
+      authToken: this.authToken,
+      ref: this.ref,
+    };
+    const signature = await this.eventHandler.signPayload(JSON.stringify(inputs));
+    return {
+      ...inputs,
+      signature,
+    };
+  }
 }
 
 export type PluginChainState<T extends EmitterWebhookEventName = EmitterWebhookEventName> = {
@@ -52,6 +79,6 @@ export type PluginChainState<T extends EmitterWebhookEventName = EmitterWebhookE
   eventPayload: EmitterWebhookEvent<T>["payload"];
   currentPlugin: number;
   pluginChain: PluginChain;
-  inputs: DelegatedComputeInputs[];
+  inputs: PluginInput[];
   outputs: PluginOutput[];
 };
diff --git a/src/github/utils/config.ts b/src/github/utils/config.ts
@@ -1,5 +1,4 @@
 import { Value } from "@sinclair/typebox/value";
-import { generateConfiguration } from "@ubiquibot/configuration";
 import YAML from "yaml";
 import { GitHubContext } from "../github-context";
 import { expressionRegex } from "../types/plugin";
@@ -10,7 +9,7 @@ const UBIQUIBOT_CONFIG_FULL_PATH = ".github/.ubiquibot-config.yml";
 
 export async function getConfig(context: GitHubContext): Promise<PluginConfiguration> {
   const payload = context.payload;
-  const defaultConfiguration = generateConfiguration();
+  const defaultConfiguration = Value.Decode(configSchema, Value.Default(configSchema, {}));
   if (!("repository" in payload) || !payload.repository) {
     console.warn("Repository is not defined");
     return defaultConfiguration;

diff --git a/src/github/utils/workflow-dispatch.ts b/src/github/utils/workflow-dispatch.ts
@@ -32,7 +32,7 @@ export async function dispatchWorkflow(context: GitHubContext, options: Workflow
   });
 }
 
-export async function dispatchWorker(targetUrl: string, payload: WorkflowDispatchOptions["inputs"]) {
+export async function dispatchWorker(targetUrl: string, payload?: { [key: string]: unknown }) {
   const result = await fetch(targetUrl, {
     body: JSON.stringify(payload),
     method: "POST",