feat(server): beta.16 - fixed namespaces in http module; moved metada…

…ta-scanner, handler-creator to the core (#196)

server/integration/http/app-version/src/app.module.ts

@@ -1,11 +1,8 @@
-import { APP_VERSION, Module } from '@server';
+import { Module } from '@server';
 
 import { AppController } from './app.controller';
 
 @Module({
   controllers: [AppController],
-  providers: [
-    { provide: APP_VERSION, useValue: 'app-version' },
-  ],
 })
 export class AppModule { }

server/integration/http/app-version/test/express.spec.ts

@@ -1,4 +1,4 @@
-import { Application, HttpStatus, Module } from '@server';
+import { APP_VERSION, Application, HttpStatus, Module } from '@server';
 import { ExpressAdapter } from '@server/express';
 import { HttpModule } from '@server/http';
 import * as request from 'supertest';
@@ -10,6 +10,9 @@ import { AppModule } from '../src/app.module';
     HttpModule.create(ExpressAdapter),
     AppModule,
   ],
+  providers: [
+    { provide: APP_VERSION, useValue: 'app-version' },
+  ],
 })
 class TestModule { }
 

server/integration/http/app-version/test/fastify.spec.ts

@@ -1,4 +1,4 @@
-import { Application, HttpStatus, Module } from '@server';
+import { APP_VERSION, Application, HttpStatus, Module } from '@server';
 import { FastifyAdapter } from '@server/fastify';
 import { HttpModule } from '@server/http';
 import * as request from 'supertest';
@@ -10,6 +10,9 @@ import { AppModule } from '../src/app.module';
     HttpModule.create(FastifyAdapter),
     AppModule,
   ],
+  providers: [
+    { provide: APP_VERSION, useValue: 'app-version' },
+  ],
 })
 class TestModule { }
 

server/integration/http/app-version/test/koa.spec.ts

@@ -1,4 +1,4 @@
-import { Application, HttpStatus, Module } from '@server';
+import { APP_VERSION, Application, HttpStatus, Module } from '@server';
 import { HttpModule } from '@server/http';
 import { KoaAdapter } from '@server/koa';
 import * as request from 'supertest';
@@ -10,6 +10,9 @@ import { AppModule } from '../src/app.module';
     HttpModule.create(KoaAdapter),
     AppModule,
   ],
+  providers: [
+    { provide: APP_VERSION, useValue: 'app-version' },
+  ],
 })
 class TestModule { }
 

server/integration/http/metadata-scanner/test/express.spec.ts

@@ -1,7 +1,6 @@
-import { Application, Module } from '@server';
+import { Application, MetadataScanner, Module } from '@server';
 import { ExpressAdapter } from '@server/express';
 import { HttpModule } from '@server/http';
-import { MetadataScanner } from '@server/http';
 
 import { AppModule } from '../src/app.module';
 

server/integration/http/metadata-scanner/test/fastify.spec.ts

@@ -1,7 +1,6 @@
-import { Application, Module } from '@server';
+import { Application, MetadataScanner, Module } from '@server';
 import { FastifyAdapter } from '@server/fastify';
 import { HttpModule } from '@server/http';
-import { MetadataScanner } from '@server/http';
 
 import { AppModule } from '../src/app.module';
 

server/integration/http/metadata-scanner/test/koa.spec.ts

@@ -1,6 +1,5 @@
-import { Application, Module } from '@server';
+import { Application, MetadataScanner, Module } from '@server';
 import { HttpModule } from '@server/http';
-import { MetadataScanner } from '@server/http';
 import { KoaAdapter } from '@server/koa';
 
 import { AppModule } from '../src/app.module';

server/integration/sockets/app-version/test/socket-io.spec.ts

@@ -1,4 +1,4 @@
-import { Application, Module } from '@server';
+import { APP_VERSION, Application, Module } from '@server';
 import { SocketIoAdapter } from '@server/socket-io';
 import { SocketsModule } from '@server/sockets';
 import { connect, Socket } from 'socket.io-client';
@@ -10,6 +10,9 @@ import { AppModule } from '../src/app.module';
     SocketsModule.create(SocketIoAdapter),
     AppModule,
   ],
+  providers: [
+    { provide: APP_VERSION, useValue: 'app-version' },
+  ],
 })
 class TestModule { }
 

server/integration/sockets/metadata-scanner/test/socket-io.spec.ts

@@ -1,6 +1,6 @@
-import { Application, Module } from '@server';
+import { Application, MetadataScanner, Module } from '@server';
 import { SocketIoAdapter } from '@server/socket-io';
-import { MetadataScanner, SocketsModule } from '@server/sockets';
+import { SocketsModule } from '@server/sockets';
 
 import { AppModule } from '../src/app.module';
 

server/package.json

@@ -148,5 +148,5 @@
       ]
     }
   },
-  "version": "1.0.0-beta.15"
+  "version": "1.0.0-beta.16"
 }

server/src/core/application.ts

@@ -21,11 +21,11 @@ export class Application {
         provide: ContainerManager,
         useValue: containerManger,
       },
-      ...DEFAULT_PROVIDERS,
       {
         provide: ROOT_MODULE,
         useValue: rootModule,
       },
+      ...DEFAULT_PROVIDERS,
     ]);
 
     const moduleResolver = await container.get<ModuleResolver>(ModuleResolver);

server/src/core/helpers/decorators.ts

@@ -1,16 +1,29 @@
+import { ParamMetadata } from '../types';
 import { extractParamNames } from '../utils';
 import { METHOD_METADATA, PARAM_TYPE_METADATA, PARAMS_METADATA, RETURN_TYPE_METADATA } from './constants';
 import { Context } from './context';
 
-export function paramDecoratorFactory(metadata: object) {
+export function paramDecoratorFactory(metadata: Partial<ParamMetadata>) {
   return function (target: InstanceType<any>, methodName: string, index: number) {
-    const params = Reflect.getMetadata(PARAMS_METADATA, target.constructor) ?? [];
+    const params = Reflect.getMetadata(PARAMS_METADATA, target[methodName]) ?? [];
     const argType = Reflect.getMetadata(PARAM_TYPE_METADATA, target, methodName)[index];
     const argName = extractParamNames(target[methodName])[index];
 
-    params.push({ argName, argType, index, methodName, ...metadata });
+    params[index] = {
+      argName,
+      argType,
+      index,
+      methodName,
+      ...metadata,
+    };
 
-    Reflect.defineMetadata(PARAMS_METADATA, params, target.constructor);
+    params
+      .filter((param: ParamMetadata) => param.paramType === metadata.paramType)
+      .forEach((param: ParamMetadata, index: number) => {
+        param.callIndex = index;
+      });
+
+    Reflect.defineMetadata(PARAMS_METADATA, params, target[methodName]);
   };
 }
 

server/src/core/helpers/handler.ts

@@ -0,0 +1,51 @@
+import { Handler, ParamMetadata } from '../types';
+import { toStandardType } from '../utils';
+import { HttpStatus } from './constants';
+import { Context } from './context';
+import { ApiError } from './errors';
+
+export abstract class HandlerCreator {
+  abstract getParam(param: ParamMetadata, args: unknown[]): Promise<unknown> | unknown;
+
+  message(message: unknown) {
+    if (message instanceof ApiError) {
+      return message.toObject();
+    }
+
+    if (message instanceof Error) {
+      return { message: message.message };
+    }
+
+    return message;
+  }
+
+  async params(metadata: ParamMetadata[], context: Context, args: unknown[]) {
+    const params$ = metadata.map(param => param.factory
+      ? param.factory(context)
+      : this.getParam(param, args),
+    );
+    const params = await Promise.all(params$);
+
+    return params.map(paramFn => toStandardType(paramFn()));
+  }
+
+  async runHandler(handler: Handler) {
+    try {
+      return await handler();
+    } catch (error) {
+      return error;
+    }
+  }
+
+  status(message: unknown, status: number) {
+    if (message instanceof ApiError) {
+      return message.status;
+    }
+
+    if (message instanceof Error) {
+      return HttpStatus.INTERNAL_SERVER_ERROR;
+    }
+
+    return status;
+  }
+}

server/src/core/helpers/index.ts

@@ -3,6 +3,8 @@ export * from './container-manager';
 export * from './context';
 export * from './decorators';
 export * from './errors';
+export * from './handler';
+export * from './metadata-scanner';
 export * from './module-resolver';
 export * from './param-validator';
 export * from './pipe';

server/src/core/helpers/metadata-scanner.ts

@@ -0,0 +1,60 @@
+import { Inject, Injectable, Optional } from '@decorators/di';
+
+import { ClassConstructor, Metadata, MethodMetadata } from '../types';
+import { addLeadingSlash, buildUrl } from '../utils';
+import { APP_VERSION, ROOT_MODULE } from './constants';
+import { Reflector } from './reflector';
+
+@Injectable()
+export class MetadataScanner {
+  constructor(
+    @Inject(APP_VERSION) @Optional() private appVersion = '',
+    @Inject(ROOT_MODULE) private rootModule: ClassConstructor,
+    private reflector: Reflector,
+  ) { }
+
+  scan<M extends Metadata>() {
+    return this.scanModule(this.rootModule) as M[];
+  }
+
+  private scanModule(module: ClassConstructor, parentNamespaces = []) {
+    const { controllers, modules, namespace } = this.reflector.getModuleMetadata(module);
+    const namespaces = [...parentNamespaces, namespace];
+
+    const methods = controllers.map(controller => {
+      const metadata = this.reflector.getControllerMetadata(controller);
+
+      return metadata.methods.map((method: MethodMetadata) => {
+        const params = this.reflector.getParamsMetadata(controller, method.methodName);
+
+        const pipes = metadata.pipes
+          .filter(([, methodName]) => !methodName || methodName === method.methodName)
+          .map(([pipe]) => pipe);
+
+        const version = metadata.options?.ignoreVersion ? '' : this.appVersion;
+
+        const paths = [version, ...namespaces, metadata.url, method.url].filter(Boolean);
+        const url = addLeadingSlash(buildUrl(...paths));
+
+        return {
+          ...method,
+          controller,
+          module,
+          params,
+          paths,
+          pipes,
+          url,
+        };
+      });
+    });
+
+    const nestedMethods = modules.map(module =>
+      this.scanModule(module, namespaces),
+    );
+
+    return [
+      ...nestedMethods.flat(),
+      ...methods.flat(),
+    ];
+  }
+}

server/src/core/helpers/reflector.ts

@@ -8,10 +8,9 @@ export class Reflector {
   getControllerMetadata(controller: ClassConstructor) {
     const metadata = Reflect.getMetadata(CONTROLLER_METADATA, controller) as ControllerMetadata;
     const methods = (Reflect.getMetadata(METHOD_METADATA, controller) ?? []) as MethodMetadata[];
-    const params = (Reflect.getMetadata(PARAMS_METADATA, controller) ?? []) as ParamMetadata[];
     const pipes = (Reflect.getMetadata(PIPES_METADATA, controller) ?? []) as [ClassConstructor, string?][];
 
-    return { ...metadata, methods, params, pipes };
+    return { ...metadata, methods, pipes };
   }
 
   getMetadata(key: string, target: unknown, propertyKey?: string) {
@@ -21,4 +20,8 @@ export class Reflector {
   getModuleMetadata(module: ClassConstructor) {
     return Reflect.getMetadata(MODULE_METADATA, module) as ModuleMetadata;
   }
+
+  getParamsMetadata(controller: ClassConstructor, methodName: string) {
+    return (Reflect.getMetadata(PARAMS_METADATA, controller.prototype[methodName]) ?? []) as ParamMetadata[];
+  }
 }

server/src/core/providers.ts

@@ -1,12 +1,16 @@
 import { Provider } from '@decorators/di';
 
-import { ModuleResolver, ParamValidator, Pipeline, Reflector } from './helpers';
+import { MetadataScanner, ModuleResolver, ParamValidator, Pipeline, Reflector } from './helpers';
 
 export const DEFAULT_PROVIDERS = [
   {
     provide: Reflector,
     useClass: Reflector,
   },
+  {
+    provide: MetadataScanner,
+    useClass: MetadataScanner,
+  },
   {
     provide: ModuleResolver,
     useClass: ModuleResolver,

server/src/core/types.ts

@@ -38,10 +38,21 @@ export interface ParamMetadata {
   // argument name defined in the function
   argName?: string;
   argType?: Handler | ClassConstructor;
+  // If decorator is used multiple times over the same method
+  callIndex: number;
   factory?: (context: any) => Promise<any> | any;
   index: number;
   methodName: string;
   paramName: string;
   paramType: string;
   paramValidator?: Validator;
 }
+
+export interface Metadata extends MethodMetadata {
+  controller: ClassConstructor;
+  module: ClassConstructor;
+  params: ParamMetadata[];
+  paths: string[];
+  pipes: ClassConstructor[];
+  url: string;
+}

server/src/index.ts

@@ -1,8 +1,10 @@
 import 'reflect-metadata';
 export { Application } from './core/application';
 export * from './core/decorators';
+export { MetadataScanner } from './core/helpers';
 export * from './core/helpers/constants/http-status';
 export * from './core/helpers/constants/injectables';
+export { Context } from './core/helpers/context';
 export { createParamDecorator, Decorate } from './core/helpers/decorators';
 export * from './core/helpers/errors';
 export { PipeHandle, ProcessPipe } from './core/helpers/pipe';

server/src/platforms/express/express-adapter.ts

@@ -14,7 +14,9 @@ export class ExpressAdapter implements HttpApplicationAdapter {
   }
 
   close() {
-    this.server?.close();
+    if (this.server.listening) {
+      this.server.close();
+    }
   }
 
   getParam(type: ParameterType, name: string, req: express.Request, res: express.Response) {

server/src/platforms/fastify/fastify-adapter.ts

@@ -16,6 +16,10 @@ export class FastifyAdapter implements HttpApplicationAdapter {
 
   async close() {
     await this.app.close();
+
+    if (this.server.listening) {
+      this.server.close();
+    }
   }
 
   getParam(type: ParameterType, name: string, req: Fastify.FastifyRequest, res: Fastify.FastifyReply) {