fix: make lifecycle methods optional in interface + try/catch in json-schema-faker-rule

Author: shanejonas

src/coverage.test.ts

@@ -131,23 +131,12 @@ describe("coverage", () => {
         only: ["foo", "bar"],
       });
       class MyCustomRule implements Rule {
-        onBegin(options: IOptions, exampleCalls: ExampleCall[]): void {}
-        onEnd(options: IOptions, exampleCalls: ExampleCall[]): void {}
         getExampleCalls(openrpcDocument: OpenrpcDocument, method: any) {
           return [];
         }
         async validateExampleCall(exampleCall: ExampleCall) {
           return exampleCall;
         }
-        async beforeRequest(options: IOptions, exampleCall: ExampleCall) {
-          return;
-        }
-        async afterRequest(options: IOptions, exampleCall: ExampleCall) {
-          return;
-        }
-        async afterResponse(options: IOptions, exampleCall: ExampleCall) {
-          return;
-        }
       }
       const myCustomRule = new MyCustomRule();
 

src/coverage.ts

@@ -72,6 +72,11 @@ export default async (options: IOptions) => {
   for (const reporter of options.reporters) {
     reporter.onBegin(options, exampleCalls);
   }
+  if (options.rules && options.rules.length > 0) {
+    for (const rule of options.rules) {
+      await Promise.resolve(rule.onBegin?.(options));
+    }
+  }
 
   for (const exampleCall of exampleCalls) {
     for (const reporter of options.reporters) {

src/rules/examples-rule.ts

@@ -16,7 +16,6 @@ class ExamplesRule implements Rule {
     this.skip = options?.skip;
     this.only = options?.only;
   }
-  onBegin(options: IOptions, exampleCalls: ExampleCall[]) {}
   getExampleCalls(openrpcDocument: OpenrpcDocument, method: MethodObject): ExampleCall[] {
     if (this.skip && this.skip.includes(method.name)) {
       return [];
@@ -56,13 +55,6 @@ class ExamplesRule implements Rule {
     }
     return exampleCall;
   }
-  onEnd(options: IOptions, exampleCalls: ExampleCall[]) {}
-
-  // example call lifecycle
-  beforeRequest(options: IOptions, exampleCall: ExampleCall) {}
-  afterRequest(options: IOptions, exampleCall: ExampleCall) {}
-
-  afterResponse(options: IOptions, exampleCall: ExampleCall) {}
 }
 
 export default ExamplesRule;

src/rules/json-schema-faker-rule.ts

@@ -21,7 +21,6 @@ class JsonSchemaFakerRule implements Rule {
     this.skip = options?.skip;
     this.only = options?.only;
   }
-  onBegin(options: IOptions, exampleCalls: ExampleCall[]) {}
   getExampleCalls(openrpcDocument: OpenrpcDocument, method: MethodObject): ExampleCall[] {
     if (this.skip && this.skip.includes(method.name)) {
       return [];
@@ -51,23 +50,21 @@ class JsonSchemaFakerRule implements Rule {
     return exampleCalls;
   }
   validateExampleCall(exampleCall: ExampleCall): ExampleCall {
-    const ajv = new Ajv();
-    ajv.validate(exampleCall.resultSchema, exampleCall.result);
-    if (ajv.errors && ajv.errors.length > 0) {
+    try {
+      const ajv = new Ajv();
+      ajv.validate(exampleCall.resultSchema, exampleCall.result);
+      if (ajv.errors && ajv.errors.length > 0) {
+        exampleCall.valid = false;
+        exampleCall.reason = JSON.stringify(ajv.errors);
+      } else {
+        exampleCall.valid = true;
+      }
+    } catch (e: any) {
       exampleCall.valid = false;
-      exampleCall.reason = JSON.stringify(ajv.errors);
-    } else {
-      exampleCall.valid = true;
+      exampleCall.reason = e.message;
     }
     return exampleCall;
   }
-  onEnd(options: IOptions, exampleCalls: ExampleCall[]) {}
-
-  // example call lifecycle
-  async beforeRequest(options: IOptions, exampleCall: ExampleCall) {}
-  async afterRequest(options: IOptions, exampleCall: ExampleCall) {}
-
-  afterResponse(options: IOptions, exampleCall: ExampleCall) {}
 }
 
 export default JsonSchemaFakerRule;

src/rules/rule.ts

@@ -2,14 +2,14 @@ import { MethodObject, OpenrpcDocument } from "@open-rpc/meta-schema";
 import { ExampleCall, IOptions } from "../coverage";
 
 interface Rule {
-  onBegin(options: IOptions, exampleCalls: ExampleCall[]): void;
+  onBegin?(options: IOptions): Promise<void> | void;
   getExampleCalls(openrpcDocument: OpenrpcDocument, method: MethodObject): ExampleCall[] | Promise<ExampleCall[]>;
   validateExampleCall(exampleCall: ExampleCall): Promise<ExampleCall> | ExampleCall;
-  onEnd(options: IOptions, exampleCalls: ExampleCall[]): void;
+  onEnd?(options: IOptions, exampleCalls: ExampleCall[]): void;
   // example call lifecycle
-  beforeRequest(options: IOptions, exampleCall: ExampleCall): Promise<any> | void;
-  afterRequest(options: IOptions, exampleCall: ExampleCall): Promise<any> | void;
-  afterResponse(options: IOptions, exampleCall: ExampleCall): Promise<any> | void;
+  beforeRequest?(options: IOptions, exampleCall: ExampleCall): Promise<void> | void;
+  afterRequest?(options: IOptions, exampleCall: ExampleCall): Promise<void> | void;
+  afterResponse?(options: IOptions, exampleCall: ExampleCall): Promise<void> | void;
 }
 
 export default Rule;