fix: refactor getExampleCalls to allow for it to be sync or async

Author: shanejonas

src/coverage.ts

@@ -54,12 +54,20 @@ export default async (options: IOptions) => {
     rules = options.rules;
   }
 
-  filteredMethods.forEach((method) => {
-    rules.forEach((rule) =>
-      rule.getExampleCalls(options.openrpcDocument, method)
-        .forEach((exampleCall) => exampleCalls.push({...exampleCall, rule}))
-    );
-  });
+  // getExampleCalls could be async or sync
+  const exampleCallsPromises = await Promise.all(filteredMethods.map((method) =>
+    Promise.all(
+      rules.map(async (rule) => {
+        const calls = await Promise.resolve(rule.getExampleCalls(options.openrpcDocument, method))
+        calls.forEach((call) => {
+          call.rule = rule;
+        });
+        return calls;
+      }
+      )
+    )
+  ));
+  exampleCalls.push(...exampleCallsPromises.flat().flat());
 
   for (const reporter of options.reporters) {
     reporter.onBegin(options, exampleCalls);
@@ -86,7 +94,9 @@ export default async (options: IOptions) => {
       exampleCall.valid = false;
       exampleCall.requestError = e;
     }
-    exampleCall.requestError ?? await Promise.resolve(exampleCall.rule?.validateExampleCall?.(exampleCall));
+    if (exampleCall.requestError === undefined) {
+      await Promise.resolve(exampleCall.rule?.validateExampleCall?.(exampleCall));
+    }
     await Promise.resolve(exampleCall.rule?.afterResponse?.(options, exampleCall));
     for (const reporter of options.reporters) {
       reporter.onTestEnd(options, exampleCall);

src/rules/rule.ts

@@ -3,7 +3,7 @@ import { ExampleCall, IOptions } from "../coverage";
 
 interface Rule {
   onBegin(options: IOptions, exampleCalls: ExampleCall[]): void;
-  getExampleCalls(openrpcDocument: OpenrpcDocument, method: MethodObject): ExampleCall[];
+  getExampleCalls(openrpcDocument: OpenrpcDocument, method: MethodObject): ExampleCall[] | Promise<ExampleCall[]>;
   validateExampleCall(exampleCall: ExampleCall): Promise<ExampleCall> | ExampleCall;
   onEnd(options: IOptions, exampleCalls: ExampleCall[]): void;
   // example call lifecycle