Distinguish request and validation errors and export them

Author: SamyPesse

src/compileOperation.ts

@@ -3,7 +3,7 @@ import { namedTypes, builders } from 'ast-types';
 import { Compiler } from './compiler';
 import { OpenAPIOperation } from './types';
 import { compileValueSchema } from './compileValueSchema';
-import { ValidationErrorIdentifier, buildValidationError } from './error';
+import { ValidationErrorIdentifier, buildRequestError } from './error';
 import { OpenAPIParsedPath, getPathParamIndex, openapiPathToRegex } from './paths';
 
 /**
@@ -127,7 +127,7 @@ export function compileOperation(
                             builders.identifier('undefined'),
                         ),
                         builders.blockStatement([
-                            builders.returnStatement(buildValidationError('body is required')),
+                            builders.returnStatement(buildRequestError(400, 'body is required')),
                         ]),
                     ),
                 );
@@ -185,7 +185,7 @@ export function compileOperation(
                         builders.identifier('undefined'),
                     ),
                     builders.blockStatement([
-                        builders.returnStatement(buildValidationError('body is not allowed')),
+                        builders.returnStatement(buildRequestError(400, 'body is not allowed')),
                     ]),
                 ),
             );

src/compilePath.ts

@@ -3,7 +3,7 @@ import { namedTypes, builders } from 'ast-types';
 import { Compiler } from './compiler';
 import { OpenAPIPath } from './types';
 import { compileOperation } from './compileOperation';
-import { buildValidationError } from './error';
+import { buildRequestError } from './error';
 import { OpenAPIParsedPath } from './paths';
 
 /**
@@ -52,7 +52,7 @@ export function compilePath(
             );
         });
 
-        nodes.push(builders.returnStatement(buildValidationError('method not supported')));
+        nodes.push(builders.returnStatement(buildRequestError(405, 'method not supported')));
 
         return builders.functionDeclaration(
             functionId,

src/compileValidateRequest.ts

@@ -3,7 +3,7 @@ import { namedTypes, builders } from 'ast-types';
 import { Compiler } from './compiler';
 import { OpenAPISpec } from './types';
 import { compilePath } from './compilePath';
-import { buildValidationError } from './error';
+import { buildRequestError } from './error';
 import { OpenAPIParsedPath, openapiPathToRegex } from './paths';
 
 const COMMENT = `*
@@ -58,7 +58,7 @@ export function compileValidateRequest(compiler: Compiler, spec: OpenAPISpec) {
     });
 
     // Otherwise, return an error
-    nodes.push(builders.returnStatement(buildValidationError('no operation match path')));
+    nodes.push(builders.returnStatement(buildRequestError(404, 'no operation match path')));
 
     return [
         {

src/compiler.ts

@@ -1,6 +1,6 @@
 import escodegen from 'escodegen';
 import { namedTypes, builders } from 'ast-types';
-import { ValidationErrorClass, ValidationErrorIdentifier } from './error';
+import { RequestErrorClass, ValidationErrorClass, ValidationErrorIdentifier } from './error';
 import { OpenAPIRef, OpenAPISpec } from './types';
 import { compileValueSchema } from './compileValueSchema';
 import { hash } from './hash';
@@ -25,7 +25,11 @@ export class Compiler {
         | namedTypes.FunctionDeclaration
         | namedTypes.ClassDeclaration
         | namedTypes.VariableDeclaration
-    )[] = [ValidationErrorClass];
+        | namedTypes.ExportNamedDeclaration
+    )[] = [
+        builders.exportNamedDeclaration(RequestErrorClass),
+        builders.exportNamedDeclaration(ValidationErrorClass),
+    ];
 
     /** Map of hashes already processed */
     private processedHashes: Set<string> = new Set();
@@ -116,12 +120,12 @@ export class Compiler {
     /**
      * Build the AST from the entire spec.
      */
-    public build() {
+    public indexAllComponents() {
         // Index all the schema components.
-        // const schemas = this.input.components?.schemas ?? {};
-        // Object.values(schemas).forEach((schema) => {
-        //     compileValueSchema(this, schema);
-        // });
+        const schemas = this.input.components?.schemas ?? {};
+        Object.values(schemas).forEach((schema) => {
+            compileValueSchema(this, schema);
+        });
     }
 
     /**

src/error.ts

@@ -1,10 +1,40 @@
 import { namedTypes, builders } from 'ast-types';
 
-export const ValidationErrorIdentifier = builders.identifier('ValidationError');
+export const RequestErrorIdentifier = builders.identifier('RequestError');
+export const RequestErrorClass = builders.classDeclaration.from({
+    id: RequestErrorIdentifier,
+    superClass: builders.identifier('Error'),
+    body: builders.classBody([
+        builders.methodDefinition(
+            'constructor',
+            builders.identifier('constructor'),
+            builders.functionExpression(
+                null,
+                [builders.identifier('code'), builders.identifier('message')],
+                builders.blockStatement([
+                    builders.expressionStatement(
+                        builders.callExpression(builders.super(), [builders.identifier('message')]),
+                    ),
+                    builders.expressionStatement(
+                        builders.assignmentExpression(
+                            '=',
+                            builders.memberExpression(
+                                builders.thisExpression(),
+                                builders.identifier('code'),
+                            ),
+                            builders.identifier('code'),
+                        ),
+                    ),
+                ]),
+            ),
+        ),
+    ]),
+});
 
+export const ValidationErrorIdentifier = builders.identifier('ValidationError');
 export const ValidationErrorClass = builders.classDeclaration.from({
     id: ValidationErrorIdentifier,
-    superClass: builders.identifier('Error'),
+    superClass: RequestErrorIdentifier,
     body: builders.classBody([
         builders.methodDefinition(
             'constructor',
@@ -14,7 +44,10 @@ export const ValidationErrorClass = builders.classDeclaration.from({
                 [builders.identifier('path'), builders.identifier('message')],
                 builders.blockStatement([
                     builders.expressionStatement(
-                        builders.callExpression(builders.super(), [builders.identifier('message')]),
+                        builders.callExpression(builders.super(), [
+                            builders.literal(409),
+                            builders.identifier('message'),
+                        ]),
                     ),
                     builders.expressionStatement(
                         builders.assignmentExpression(
@@ -33,11 +66,11 @@ export const ValidationErrorClass = builders.classDeclaration.from({
 });
 
 /**
- * Build an empty error.
+ * Build a request error.
  */
-export function buildValidationError(message: string) {
-    return builders.newExpression(ValidationErrorIdentifier, [
-        builders.arrayExpression([]),
+export function buildRequestError(code: number, message: string) {
+    return builders.newExpression(RequestErrorIdentifier, [
+        builders.literal(code),
         builders.literal(message),
     ]);
 }