add imported events to the async api endpoint

PaimaStudios · Aug 14, 2024 · 45eb5d5 · 45eb5d5
1 parent f10e80d
commit 45eb5d5
Show file tree

Hide file tree

Showing 4 changed files with 28 additions and 17 deletions.
diff --git a/packages/engine/paima-runtime/src/index.ts b/packages/engine/paima-runtime/src/index.ts
@@ -19,6 +19,7 @@ export {
   registerDocsPrecompiles,
   registerDocsOpenAPI,
   registerValidationErrorHandler,
+  registerDocsAppEvents,
 } from './server.js';
 export { TimeoutError } from './utils.js';
 

diff --git a/packages/engine/paima-runtime/src/server.ts b/packages/engine/paima-runtime/src/server.ts
@@ -7,7 +7,7 @@ import { merge, isErrorResult } from 'openapi-merge';
 import { doLog, ENV, logError } from '@paima/utils';
 import path from 'path';
 import { ValidateError } from 'tsoa';
-import { BuiltinEvents, toAsyncApi } from '@paima/events';
+import { BuiltinEvents, EventPathAndDef, toAsyncApi } from '@paima/events';
 import YAML from 'yaml';
 import { evmRpcEngine } from './evm-rpc/eip1193.js';
 import { StatusCodes } from 'http-status-codes';
@@ -141,17 +141,27 @@ function registerDocsOpenAPI(userStateMachineApi: object | undefined): void {
   );
 }
 
-server.get(`/${DocPaths.Root}/${DocPaths.AsyncApi.Root}/${DocPaths.AsyncApi.Spec}`, (_, res) => {
-  const asyncApi = toAsyncApi(
-    {
-      backendUri: ENV.MQTT_ENGINE_BROKER_URL,
-      // TODO: batcher docs theoretically should be hosted separately in some batcher-managed server
-      batcherUri: ENV.MQTT_BATCHER_BROKER_URL,
-    },
-    BuiltinEvents
+function registerDocsAppEvents(events: Record<string, EventPathAndDef[]>): void {
+  const appEvents: [string, EventPathAndDef][] = Object.entries(events).flatMap(
+    ([name, definitions]) =>
+      definitions.map((definition: EventPathAndDef, index: number): [string, EventPathAndDef] => [
+        name + index,
+        definition,
+      ])
   );
-  res.send(YAML.stringify(asyncApi, null, 2));
-});
+
+  server.get(`/${DocPaths.Root}/${DocPaths.AsyncApi.Root}/${DocPaths.AsyncApi.Spec}`, (_, res) => {
+    const asyncApi = toAsyncApi(
+      {
+        backendUri: ENV.MQTT_ENGINE_BROKER_URL,
+        // TODO: batcher docs theoretically should be hosted separately in some batcher-managed server
+        batcherUri: ENV.MQTT_BATCHER_BROKER_URL,
+      },
+      (Object.entries(BuiltinEvents) as [string, EventPathAndDef][]).concat(appEvents)
+    );
+    res.send(YAML.stringify(asyncApi, null, 2));
+  });
+}
 
 server.get(`/${DocPaths.Root}/${DocPaths.AsyncApi.Root}/${DocPaths.AsyncApi.Ui}`, (_, res) => {
   res.sendFile(path.join(__dirname, 'public', 'asyncapi.html'));
@@ -174,4 +184,5 @@ export {
   registerDocsPrecompiles,
   registerDocsOpenAPI,
   registerValidationErrorHandler,
+  registerDocsAppEvents,
 };
diff --git a/packages/engine/paima-standalone/src/utils/input.ts b/packages/engine/paima-standalone/src/utils/input.ts
@@ -1,5 +1,6 @@
 import { FunnelFactory } from '@paima/funnel';
 import paimaRuntime, {
+  registerDocsAppEvents,
   registerDocsOpenAPI,
   registerDocsPrecompiles,
   registerValidationErrorHandler,
@@ -172,6 +173,7 @@ export const runPaimaEngine = async (): Promise<void> => {
     registerDocsOpenAPI(importOpenApiJson());
     registerDocsPrecompiles(precompilesImport.precompiles);
     registerValidationErrorHandler();
+    registerDocsAppEvents(eventsImport.events);
 
     void engine.run(ENV.STOP_BLOCKHEIGHT, ENV.SERVER_ONLY_MODE);
   } else {

diff --git a/packages/paima-sdk/paima-events/src/builtin-events.ts b/packages/paima-sdk/paima-events/src/builtin-events.ts
@@ -108,10 +108,7 @@ type HostInfo = {
   backendUri: string;
   batcherUri?: string;
 };
-export function toAsyncApi(
-  info: HostInfo,
-  events: Record<string, EventPathAndDef>
-): AsyncAPI300Schema {
+export function toAsyncApi(info: HostInfo, events: [string, EventPathAndDef][]): AsyncAPI300Schema {
   const parsedUrl = new URL(info.backendUri);
   const servers: NonNullable<AsyncAPI300Schema['servers']> = {
     [PaimaEventBrokerNames.PaimaEngine]: {
@@ -132,7 +129,7 @@ export function toAsyncApi(
   }
 
   const channels: Channels = {};
-  for (const [k, v] of Object.entries(events)) {
+  for (const [k, v] of events) {
     if (v.broker === PaimaEventBrokerNames.Batcher && info.batcherUri == null) {
       continue;
     }
@@ -169,7 +166,7 @@ export function toAsyncApi(
   }
 
   const operations: Operations = {};
-  for (const [k, v] of Object.entries(events)) {
+  for (const [k, v] of events) {
     if (v.broker === PaimaEventBrokerNames.Batcher && info.batcherUri == null) {
       continue;
     }