Feature: Throw errors with proper http code

packages/build/src/containers/container.ts

@@ -1,5 +1,5 @@
 import { Container as InversifyContainer } from 'inversify';
-import { Container as CoreContainer } from '@vulcan-sql/core';
+import { Container as CoreContainer, InternalError } from '@vulcan-sql/core';
 import { IBuildOptions } from '@vulcan-sql/build/models';
 import {
   documentGeneratorModule,
@@ -15,7 +15,7 @@ export class Container {
   public get<T>(type: symbol) {
     const instance = this.inversifyContainer?.get<T>(type);
     if (!instance)
-      throw new Error(`Cannot resolve ${type.toString()} in container`);
+      throw new InternalError(`Cannot resolve ${type.toString()} in container`);
     return instance;
   }
 

packages/build/src/lib/document-generator/spec-generator/oas3/oas3SpecGenerator.ts

@@ -17,6 +17,7 @@ import {
   VulcanExtensionId,
   VulcanInternalExtension,
   DocumentSpec,
+  ConfigurationError,
 } from '@vulcan-sql/core';
 import { isEmpty } from 'lodash';
 
@@ -104,7 +105,9 @@ export class OAS3SpecGenerator extends SpecGenerator<oas3.OpenAPIObject> {
       case FieldInType.QUERY:
         return 'query';
       default:
-        throw new Error(`FieldInType ${fieldInType} is not supported`);
+        throw new ConfigurationError(
+          `FieldInType ${fieldInType} is not supported`
+        );
     }
   }
 
@@ -145,7 +148,9 @@ export class OAS3SpecGenerator extends SpecGenerator<oas3.OpenAPIObject> {
       case FieldDataType.STRING:
         return 'string';
       default:
-        throw new Error(`FieldDataType ${fieldDataType} is not supported`);
+        throw new ConfigurationError(
+          `FieldDataType ${fieldDataType} is not supported`
+        );
     }
   }
 

packages/build/src/lib/schema-parser/middleware/checkProfile.ts

@@ -1,5 +1,10 @@
 import { RawAPISchema, SchemaParserMiddleware } from './middleware';
-import { APISchema, DataSource, TYPES as CORE_TYPES } from '@vulcan-sql/core';
+import {
+  APISchema,
+  ConfigurationError,
+  DataSource,
+  TYPES as CORE_TYPES,
+} from '@vulcan-sql/core';
 import { inject, interfaces } from 'inversify';
 
 export class CheckProfile extends SchemaParserMiddleware {
@@ -21,15 +26,15 @@ export class CheckProfile extends SchemaParserMiddleware {
     await next();
     const transformedSchemas = schemas as APISchema;
     if (!transformedSchemas.profiles)
-      throw new Error(
+      throw new ConfigurationError(
         `The profile of schema ${transformedSchemas.urlPath} is not defined`
       );
 
     for (const profile of transformedSchemas.profiles) {
       try {
         this.dataSourceFactory(profile);
       } catch (e: any) {
-        throw new Error(
+        throw new ConfigurationError(
           `The profile ${profile} of schema ${transformedSchemas.urlPath} is invalid: ${e?.message}`
         );
       }

packages/build/src/lib/schema-parser/middleware/checkValidator.ts

@@ -2,6 +2,7 @@ import { RawAPISchema, SchemaParserMiddleware } from './middleware';
 import { chain } from 'lodash';
 import {
   APISchema,
+  ConfigurationError,
   IValidatorLoader,
   TYPES as CORE_TYPES,
 } from '@vulcan-sql/core';
@@ -26,7 +27,7 @@ export class CheckValidator extends SchemaParserMiddleware {
 
     for (const validatorRequest of validators) {
       if (!validatorRequest.name) {
-        throw new Error('Validator name is required');
+        throw new ConfigurationError('Validator name is required');
       }
 
       const validator = this.validatorLoader.getValidator(

packages/build/src/lib/schema-parser/middleware/responseSampler.ts

@@ -2,6 +2,7 @@ import { inject } from 'inversify';
 import { RawAPISchema, SchemaParserMiddleware } from './middleware';
 import {
   APISchema,
+  ConfigurationError,
   FieldDataType,
   ResponseProperty,
   TemplateEngine,
@@ -27,7 +28,7 @@ export class ResponseSampler extends SchemaParserMiddleware {
     const schema = rawSchema as APISchema;
     if (!schema.sample) return;
     if (!schema.sample.profile) {
-      throw new Error(
+      throw new ConfigurationError(
         `Schema ${schema.urlPath} misses the required property: sample.profile`
       );
     }

packages/build/src/lib/schema-parser/schema-reader/fileSchemaReader.ts

@@ -12,6 +12,7 @@ import {
   VulcanExtensionId,
   VulcanInternalExtension,
   TYPES as CORE_TYPES,
+  ConfigurationError,
 } from '@vulcan-sql/core';
 import { inject } from 'inversify';
 import { TYPES } from '@vulcan-sql/build/containers';
@@ -36,7 +37,9 @@ export class FileSchemaReader extends SchemaReader {
 
   public async *readSchema(): AsyncGenerator<SchemaData> {
     if (!this.options?.folderPath)
-      throw new Error(`Config schema-parser.folderPath must be defined`);
+      throw new ConfigurationError(
+        `Config schema-parser.folderPath must be defined`
+      );
     const files = await this.getSchemaFilePaths();
 
     for (const file of files) {

packages/build/src/lib/schema-parser/schemaParser.ts

@@ -1,4 +1,8 @@
-import { APISchema, AllTemplateMetadata } from '@vulcan-sql/core';
+import {
+  APISchema,
+  AllTemplateMetadata,
+  InternalError,
+} from '@vulcan-sql/core';
 import {
   SchemaData,
   SchemaFormat,
@@ -61,7 +65,7 @@ export class SchemaParser {
           ...(yaml.load(schemaData.content) as object),
         } as RawAPISchema;
       default:
-        throw new Error(`Unsupported schema type: ${schemaData.type}`);
+        throw new InternalError(`Unsupported schema type: ${schemaData.type}`);
     }
   }
 }

packages/build/src/options/schemaParser.ts

@@ -5,6 +5,7 @@ import {
   SchemaReaderType,
 } from '@vulcan-sql/build/models';
 import { IsOptional, IsString, validateSync } from 'class-validator';
+import { ConfigurationError } from '@vulcan-sql/core';
 
 @injectable()
 export class SchemaParserOptions implements ISchemaParserOptions {
@@ -23,7 +24,9 @@ export class SchemaParserOptions implements ISchemaParserOptions {
     Object.assign(this, options);
     const errors = validateSync(this);
     if (errors.length > 0) {
-      throw new Error('Invalid schema parser options: ' + errors.join(', '));
+      throw new ConfigurationError(
+        'Invalid schema parser options: ' + errors.join(', ')
+      );
     }
   }
 }

packages/cli/src/index.ts

@@ -9,7 +9,7 @@ import { program } from './cli';
   } catch (e: any) {
     // Ignore error with exit code = 0, e.g. commander.helpDisplayed error
     if (e?.exitCode === 0) return;
-    logger.prettyError(e, true, false, false);
+    logger.prettyError(e, true, false, true);
     process.exit(e?.exitCode ?? 1);
   }
 })();

packages/core/src/containers/modules/executor.ts

@@ -9,6 +9,7 @@ import {
 import { Profile } from '../../models/profile';
 import 'reflect-metadata';
 import { ClassType } from '../../lib/utils/module';
+import { ConfigurationError } from '@vulcan-sql/core/utils';
 
 export const executorModule = (profiles: Map<string, Profile>) =>
   new AsyncContainerModule(async (bind) => {
@@ -23,7 +24,8 @@ export const executorModule = (profiles: Map<string, Profile>) =>
       TYPES.Factory_DataSource
     ).toFactory((context) => (profileName: string) => {
       const profile = profiles.get(profileName);
-      if (!profile) throw new Error(`Profile ${profileName} not found`);
+      if (!profile)
+        throw new ConfigurationError(`Profile ${profileName} not found`);
       return context.container.getNamed(
         TYPES.Extension_DataSource,
         profile.type

packages/core/src/lib/artifact-builder/vulcanArtifactBuilder.ts

@@ -3,6 +3,7 @@ import { PersistentStore } from '@vulcan-sql/core/models';
 import { Serializer } from '@vulcan-sql/core/models';
 import { inject, injectable } from 'inversify';
 import { TYPES } from '@vulcan-sql/core/types';
+import { InternalError } from '../utils';
 
 @injectable()
 export class VulcanArtifactBuilder implements ArtifactBuilder {
@@ -32,7 +33,7 @@ export class VulcanArtifactBuilder implements ArtifactBuilder {
 
   public getArtifact<T = any>(key: string): T {
     const target = this.artifact[key];
-    if (!target) throw new Error(`Artifact ${key} not found`);
+    if (!target) throw new InternalError(`Artifact ${key} not found`);
     return target as T;
   }
 

packages/core/src/lib/data-query/builder/dataQueryBuilder.ts

@@ -21,6 +21,7 @@ import {
   JoinOnClause,
   JoinOnClauseOperation,
 } from './joinOnClause';
+import { TemplateError } from '../../utils/errors';
 
 export enum SelectCommandType {
   SELECT = 'SELECT',
@@ -612,7 +613,7 @@ export class DataQueryBuilder implements IDataQueryBuilder {
     value: string | number | boolean | IDataQueryBuilder
   ) {
     if (!isOfComparisonOperator(operator))
-      throw new Error(`'There is no ${operator}  operator.`);
+      throw new TemplateError(`'There is no ${operator}  operator.`);
 
     this.recordWhere({
       command: null,
@@ -860,7 +861,7 @@ export class DataQueryBuilder implements IDataQueryBuilder {
   ) {
     const normalized = typeof column === 'string' ? { name: column } : column;
     if (!isOfComparisonOperator(operator))
-      throw new Error(`'There is no ${operator}  operator.`);
+      throw new TemplateError(`'There is no ${operator}  operator.`);
 
     this.recordHaving({
       command: null,

packages/core/src/lib/data-query/builder/joinOnClause.ts

@@ -1,3 +1,4 @@
+import { TemplateError } from '../../utils/errors';
 import {
   ComparisonPredicate,
   ComparisonOperator,
@@ -68,7 +69,7 @@ export class JoinOnClause implements IJoinOnClause {
 
   public on(leftColumn: string, operator: string, rightColumn: string) {
     if (!isOfComparisonOperator(operator))
-      throw new Error(`'There is no ${operator} operator.`);
+      throw new TemplateError(`'There is no ${operator} operator.`);
 
     this.recordOn({
       command: null,
@@ -79,7 +80,9 @@ export class JoinOnClause implements IJoinOnClause {
 
   public onBetween(column: string, min: number, max: number) {
     if (min > max)
-      throw new Error(`min value ${min} not smaller than max value ${max}.`);
+      throw new TemplateError(
+        `min value ${min} not smaller than max value ${max}.`
+      );
 
     this.recordOn({
       command: ComparisonPredicate.BETWEEN,

packages/core/src/lib/data-query/profile/profile-readers/localFile.ts

@@ -8,6 +8,7 @@ import {
 import * as path from 'path';
 import * as fs from 'fs';
 import * as jsYAML from 'js-yaml';
+import { ConfigurationError } from '@vulcan-sql/core/utils';
 
 export interface LocalFileProfileReaderOptions {
   path: string;
@@ -18,7 +19,9 @@ export interface LocalFileProfileReaderOptions {
 export class LocalFileProfileReader extends ProfileReader {
   public async read(options: LocalFileProfileReaderOptions) {
     if (!options.path)
-      throw new Error('LocalFile profile reader needs options.path property');
+      throw new ConfigurationError(
+        'LocalFile profile reader needs options.path property'
+      );
 
     const profilePath = path.resolve(process.cwd(), options.path);
     if (!fs.existsSync(profilePath)) return [];
@@ -30,7 +33,7 @@ export class LocalFileProfileReader extends ProfileReader {
     // validate profiles
     for (const profile of profiles) {
       if (!profile.name || !profile.type)
-        throw new Error(
+        throw new ConfigurationError(
           `Invalid profile in ${profilePath}. Profile name and type are required.`
         );
     }

packages/core/src/lib/extension-loader/extensionLoader.ts

@@ -1,6 +1,6 @@
 import { ExtensionBase, ICoreOptions } from '@vulcan-sql/core/models';
 import { interfaces } from 'inversify';
-import { ClassType, defaultImport } from '../utils';
+import { ClassType, defaultImport, InternalError } from '../utils';
 import {
   EXTENSION_ENFORCED_ID_METADATA_KEY,
   EXTENSION_IDENTIFIER_METADATA_KEY,
@@ -30,7 +30,7 @@ export class ExtensionLoader {
   /** Load external extensions (should be called by core package) */
   public async loadExternalExtensionModules() {
     if (this.bound)
-      throw new Error(
+      throw new InternalError(
         `We must load all extensions before call bindExtension function`
       );
 
@@ -61,7 +61,7 @@ export class ExtensionLoader {
 
   public loadInternalExtensionModule(moduleEntry: ExtensionModuleEntry) {
     if (this.bound)
-      throw new Error(
+      throw new InternalError(
         `We must load all extensions before call bindExtension function`
       );
 
@@ -70,7 +70,7 @@ export class ExtensionLoader {
     for (const extension of extensions) {
       const name = Reflect.getMetadata(EXTENSION_NAME_METADATA_KEY, extension);
       if (name === undefined)
-        throw new Error(
+        throw new InternalError(
           `Internal extension must have @VulcanInternalExtension decorator`
         );
       this.loadExtension(name, extension);
@@ -113,7 +113,7 @@ export class ExtensionLoader {
       extension
     );
     if (enforcedId && !extensionId)
-      throw new Error(
+      throw new InternalError(
         `Extension ${extension.name} needed an extension id but was not found, please use the decorator @VulcanExtensionId to set the id.`
       );
 
@@ -128,7 +128,7 @@ export class ExtensionLoader {
       extension
     );
     if (!extensionType)
-      throw new Error(
+      throw new InternalError(
         `Extension must have @VulcanExtension decorator, have you use extend the correct super class?`
       );
     if (!this.extensionRegistry.has(extensionType))

packages/core/src/lib/template-engine/built-in-extensions/custom-error/errorTagBuilder.ts

@@ -2,6 +2,7 @@ import * as nunjucks from 'nunjucks';
 import { chain } from 'lodash';
 import { METADATA_NAME } from './constants';
 import { TagBuilder, VulcanInternalExtension } from '@vulcan-sql/core/models';
+import { TemplateError } from '../../../utils/errors';
 
 interface ErrorCode {
   code: string;
@@ -39,7 +40,9 @@ export class ErrorTagBuilder extends TagBuilder {
 
       const errorCodeNode = node.args.children[0];
       if (!(errorCodeNode instanceof nunjucks.nodes.Literal))
-        throw new Error(`Expected literal, got ${errorCodeNode.typename}`);
+        throw new TemplateError(
+          `Expected literal, got ${errorCodeNode.typename}`
+        );
 
       this.errorCodes.push({
         code: errorCodeNode.value,

packages/core/src/lib/template-engine/built-in-extensions/custom-error/errorTagRunner.ts

@@ -3,6 +3,7 @@ import {
   TagRunnerOptions,
   VulcanInternalExtension,
 } from '@vulcan-sql/core/models';
+import { UserError } from '../../../utils/errors';
 
 @VulcanInternalExtension()
 export class ErrorTagRunner extends TagRunner {
@@ -12,6 +13,8 @@ export class ErrorTagRunner extends TagRunner {
     const message = args[0];
     const lineno = args[1];
     const colno = args[2];
-    throw new Error(`${message} at ${lineno}:${colno}`);
+    throw new UserError(String(message), {
+      description: `Error throw from template at ${lineno}:${colno}.`,
+    });
   }
 }

packages/core/src/lib/template-engine/built-in-extensions/query-builder/parameterizer.ts

@@ -1,4 +1,5 @@
 import { RequestParameter } from '@vulcan-sql/core/models';
+import { InternalError } from '../../../utils/errors';
 
 type PrepareParameterFuncWithoutProfile = {
   (param: Omit<RequestParameter, 'profileName'>): Promise<string>;
@@ -20,7 +21,7 @@ export class Parameterizer {
 
   public async generateIdentifier(value: any): Promise<string> {
     if (this.sealed)
-      throw new Error(
+      throw new InternalError(
         `This parameterizer has been sealed, we might use the parameterizer from a wrong request scope.`
       );
     if (this.valueToIdMapping.has(value))