Merge pull request #22 from AthennaIO/develop

feat: add facades to project

index.ts

@@ -7,6 +7,10 @@
  * file that was distributed with this source code.
  */
 
+export * from 'src/Facade'
 export * from 'src/Ignite'
+export * from 'src/Application'
 
-export * from 'src/Utils/AthennaErrorHandler'
+export * from 'src/Facades/Log'
+export * from 'src/Facades/HttpRoute'
+export * from 'src/Facades/HttpServer'

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@athenna/core",
-  "version": "1.1.9",
+  "version": "1.2.0",
   "description": "",
   "license": "MIT",
   "author": "João Lenon <[email protected]>",
@@ -149,10 +149,6 @@
     "src/*.d.ts",
     "src/**/*.js",
     "src/**/*.d.ts",
-    "container/*.js",
-    "container/*.d.ts",
-    "container/**/*.js",
-    "container/**/*.d.ts",
     "*.js",
     "*.d.ts"
   ],
@@ -165,7 +161,7 @@
     "@athenna/config": "1.0.8",
     "@athenna/ioc": "1.1.2",
     "@athenna/logger": "1.1.4",
-    "@athenna/http": "1.1.9",
+    "@athenna/http": "1.2.0",
     "@secjs/utils": "1.8.3",
     "reflect-metadata": "0.1.13",
     "tscpaths": "0.0.9"

src/Application.ts

@@ -9,22 +9,14 @@
 
 import { parse } from 'path'
 import { Ioc } from '@athenna/ioc'
-import { Logger } from '@athenna/logger'
+import { Log } from 'src/Facades/Log'
 import { Path, resolveModule } from '@secjs/utils'
 import { Http, Router as HttpRoute } from '@athenna/http'
-import { AthennaErrorHandler } from 'src/Utils/AthennaErrorHandler'
 import { NotBootedException } from 'src/Exceptions/NotBootedException'
 import { AlreadyBootedException } from 'src/Exceptions/AlreadyBootedException'
 import { AlreadyShutdownException } from 'src/Exceptions/AlreadyShutdownException'
 
 export class Application {
-  /**
-   * Simple logger for Application class.
-   *
-   * @private
-   */
-  private logger: Logger
-
   /**
    * An instance of the Ioc class that is a Monostate with
    * the Awilix container inside.
@@ -106,10 +98,6 @@ export class Application {
    * @return void
    */
   async bootHttpServer(): Promise<Http> {
-    if (!this.logger) {
-      this.logger = resolveModule(await import('./Utils/Logger'))
-    }
-
     if (this.httpServer) {
       throw new AlreadyBootedException('HttpServer')
     }
@@ -129,15 +117,14 @@ export class Application {
      */
     await this.preloadFile(Path.pwd('routes/http'))
 
-    this.httpServer.setErrorHandler(AthennaErrorHandler.http)
     this.httpRoute.register()
 
     const port = Config.get('http.port')
     const host = Config.get('http.host')
 
     await this.httpServer.listen(port, host)
 
-    this.logger.success(`Http server started on http://${host}:${port}`)
+    Log.success(`Http server started on http://${host}:${port}`)
 
     return this.httpServer
   }
@@ -152,7 +139,7 @@ export class Application {
       throw new AlreadyShutdownException('HttpServer')
     }
 
-    this.logger.warn(`Http server shutdown, bye! :)`)
+    Log.warn(`Http server shutdown, bye! :)`)
 
     await this.httpServer.close()
 
@@ -171,7 +158,7 @@ export class Application {
   private async preloadFile(filePath: string) {
     const { dir, name } = parse(filePath)
 
-    this.logger.success(`Preloading ${name} file`)
+    Log.success(`Preloading ${name} file`)
 
     await import(`${dir}/${name}${this.extension}`)
   }
@@ -188,7 +175,7 @@ export class Application {
       await import(`${dir}/${name}${this.extension}`),
     )
 
-    this.logger.success('Booting the Http Kernel')
+    Log.success('Booting the Http Kernel')
 
     await new HttpKernel().registerMiddlewares()
   }

src/Facade.ts

@@ -0,0 +1,38 @@
+/**
+ * @athenna/core
+ *
+ * (c) João Lenon <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+export class ProxyHandler {
+  private readonly alias: any
+
+  public constructor(alias: any) {
+    this.alias = alias
+  }
+
+  get(_object: any, key: string) {
+    const provider = ioc.use(this.alias)
+
+    if (!provider) {
+      return () => {}
+    }
+
+    return provider[key]
+  }
+}
+
+export class Facade {
+  /**
+   * Creates a new facade for alias.
+   *
+   * @param alias
+   * @return any
+   */
+  static createFor<Provider = any>(alias: string): Provider {
+    return new Proxy(this, new ProxyHandler(alias))
+  }
+}

container/HttpRoute.ts → src/Facades/HttpRoute.ts

@@ -7,6 +7,7 @@
  * file that was distributed with this source code.
  */
 
+import { Facade } from 'src/Facade'
 import { Router } from '@athenna/http'
 
-export const Route = ioc.safeUse<Router>('Athenna/Core/HttpRoute')
+export const Route = Facade.createFor<Router>('Athenna/Core/HttpRoute')

container/HttpServer.ts → src/Facades/HttpServer.ts

@@ -7,6 +7,7 @@
  * file that was distributed with this source code.
  */
 
+import { Facade } from 'src/Facade'
 import { Http } from '@athenna/http'
 
-export const Server = ioc.safeUse<Http>('Athenna/Core/HttpServer')
+export const HttpServer = Facade.createFor<Http>('Athenna/Core/HttpServer')

container/Logger.ts → src/Facades/Log.ts

@@ -7,6 +7,7 @@
  * file that was distributed with this source code.
  */
 
+import { Facade } from 'src/Facade'
 import { Logger as ILogger } from '@athenna/logger'
 
-export const Logger = ioc.safeUse<ILogger>('Athenna/Core/Logger')
+export const Log = Facade.createFor<ILogger>('Athenna/Core/Logger')

src/Ignite.ts

@@ -13,21 +13,14 @@
 import '@athenna/ioc'
 import '@athenna/config/src/Utils/global'
 
-import { Logger } from '@athenna/logger'
-import { File, Path, resolveModule } from '@secjs/utils'
+import { Log } from 'src/Facades/Log'
 import { Application } from 'src/Application'
 import { resolveEnvFile } from '@athenna/config'
 import { normalize, parse, resolve } from 'path'
+import { File, Path, resolveModule } from '@secjs/utils'
 import { DuplicatedApplicationException } from 'src/Exceptions/DuplicatedApplicationException'
 
 export class Ignite {
-  /**
-   * Simple logger for Ignite class.
-   *
-   * @private
-   */
-  private logger: Logger
-
   /**
    * An instance of the application. Is here that the
    * client will bootstrap his type of application.
@@ -73,12 +66,6 @@ export class Ignite {
 
     this.clearConsole()
 
-    /**
-     * Using import because logger needs to be set after
-     * resolveNodeEnv method has been called.
-     */
-    this.logger = resolveModule(await import('./Utils/Logger'))
-
     const providers = await this.getProviders()
 
     await this.registerProviders(providers)
@@ -201,9 +188,7 @@ export class Ignite {
       providersNormalized.push(resolveModule(Provider))
     })
 
-    providersNormalized.forEach(p =>
-      this.logger.success(`Registering ${p.name}`),
-    )
+    providersNormalized.forEach(p => Log.success(`Registering ${p.name}`))
 
     return providersNormalized
   }
@@ -261,7 +246,7 @@ export class Ignite {
       preload = normalize(preload)
 
       const { dir, name } = parse(Path.config(preload))
-      this.logger.success(`Preloading ${name} file`)
+      Log.success(`Preloading ${name} file`)
 
       return import(`${dir}/${name}${this.extension}`)
     })

tests/Stubs/config/http.ts

@@ -45,5 +45,5 @@ export default {
   |
   */
 
-  log: Env('APP_DEBUG', true),
+  log: Env('APP_DEBUG', false),
 }

tests/Stubs/routes/http.ts

@@ -1,4 +1,4 @@
-import { Route } from 'container/HttpRoute'
+import { Route } from 'src/Facades/HttpRoute'
 
 Route.get('/healthcheck', ({ response }) => {
   return response.status(200).send({ status: 'ok' })