appolo
nodejs server framework
Last updated a month ago by shmoop207 .
MIT · Repository · Bugs · Original npm · Tarball
$ cnpm install appolo 
SYNC missed versions from official npm registry.

Appolo

Build Status Dependencies status NPM version npm Downloads
appolo

Appolo is an light web server MVC Framework for Node.js written in Typescript

Appolo architecture follows common patten of MVC and dependency injection which makes it easy to build better performance, flexibility and easy maintenance server side in nodejs.

Features

  • Super fast
  • MVC Architecture
  • Full support for express middlewares
  • Dependency injection
  • Simple routing
  • Routes validation
  • Modules system
  • Manage easily configurations and environments
  • Simple folder structures
  • Easy integrate third party modules
  • Easy to get started

Installation

npm install appolo --save  

Typescript

appolo requires TypeScript compiler version > 2.1 and the following settings in tsconfig.json:

{  
	"experimentalDecorators": true
}  

Quick Start

In your app.js file:

var {createApp}  from 'appolo';
createApp().launch();  

Benchmarks

node benchmarks/benchmarks  

Machine: 2.2 GHz Intel Core i7, 16GiB RAM

Method: autocannon -c 100 -d 10 -p 10 localhost:3000

Name Average Min Max
Req/Sec 32,821.6 23,840 34,463

Examples

Directory Structure

Appolo will require all files in the config and src folders, but the env folder will be loaded first. All other folders are optional

|- config
    |- env
        |- all.ts
        |- development.ts
        |- production.ts
    |- middlewares 
        |- all.ts 
	|- modules 
	    |- logger.ts  
|- src  
    |- controllers 
    |- managers  
    |- services 
    |- bootstrap.ts  
    |- app.ts  

Configuration

appolo launch configuration options, all options are optional

key Description Type Default
paths folders that will be required and loaded on appolo launch array [ 'src']
environment environment file name that will override the settings in environments/all.js string (process.env.NODE_ENV || 'development')
startMessage the message that will be written to console log the the server starts string 'Appolo Server listening on port: {port} version:{version} environment: {environment}'
startServer if true the server will start immediately to listen to port else you will have to start in manually. boolean true
port the port that the app will listen to. number `process.env.PORT || this._options.port || appolo.environment.port || 8080)``
errorMessage print route http error.toString() boolen true
maxRouteCache the max size of route lookup lru cache number 10000

usage example:

import {createApp}  from 'appolo';
(async ()=>{
    let app = await createApp({
        paths:[ 'src'],
        root : process.cwd()+'/app',
        environment : 'testing',
        port:8182
     }).launch();
 })();  

Environments

With environments you can define different configurations depending on the environment type your app is currently running.
It is recommended to have 4 types of environments: development, testing, staging, production.
After appolo.launch you can always access the current environment vars via appolo.environment.

//all.ts  
export = {  
  name:'all',  
  someVar:'someVar'  
}  
//development.ts  
export = {  
  name:'develpment',  
  db:'mongo://development-url'  
}  
//development.ts  
export = {  
  name:'testing',  
  db:'mongo://testing-url'  
}  
  

If we launch our app.js with NODE_ENV = testing

import {createApp}  from 'appolo';
...
let app = await createApp().launch();  
var env = appolo.env;  
console.log(env.name,env.someVar,env.db) // 'testing someVar monog:://testing-url'  

Express Middlewares

You can configure express modules or add custom middleware by adding configuration files to the express folder.
The express configuration file is called after the environment files were loaded.

//middlewares/all.ts  
import favicon = require('static-favicon');  
import bodyParser = require("body-parser");  
import {App,IRequest,IResponse,NextFn}  from 'appolo';

export = function (app: App) {
    app.use(bodyParser.json());
    app.use(function (req:IRequest, res: IResponse, next: NextFn) {
        res.setHeader("Access-Control-Allow-Origin", "*"); 
        next();
    });
    app.use(favicon());}  

Routes

You can easily bind a route path to a controller method.
The routes path are defined in the same way as in expressjs router.

Each route class has the following methods:

  • path - same as in expressjs.
  • method - one of get,post,patch,delete,put. default get.
  • action - the action function the will be invoked to handle the route.
  • middleware - middleware function the will be invoked before the controller. If the next function is not called or called with an error, the controller won`t be created.
  • validation - validations object as defined in joi.
import {define,inject,Controller,IRequest,IResponse,get,post} from 'appolo';  
  
@define()  
export class TestController extends Controller{
    @inject() dataManager:DataManager
    
    @get("/test/:userId")
    public test (req:IRequest, res:IResponse){
        return this.dataManager.getData(req.params.userId));
    }
}  

or you can return response by using res.send

@define()  
export class Test2Controller extends Controller{  
   @inject() dataManager:DataManager  
   
   @post("/test2/:userId")  
   @validations("userId",validator.string().required())  
   public test (req:IRequest, res:IResponse) {
   	res.send(this.dataManager.getData(req.params.userId));  
   }
}  

You can also define routes using appolo.route method:

import {controller,inject,Controller,IRequest,IResponse} from 'appolo';  
  
@controller()  
export class TestController extends Controller{
    @inject() dataManager:DataManager
    public test (req:IRequest, res:IResponse) {
        res.send(this.dataManager.getData());
    }
 }  
  
app.route<TestController>(TestController)  
 .path("/test/")  
 .method(appolo.Methods.GET)  
 .action(c=>c.test)  

Routes Validation

You can add validations to your routes. The action controller will be called only if the route params are valid.

Validations are done using joi module .

The validator takes request params from req.param , req.query and req.body. After validation, all request params will be available on req.model.

import {controller,inject,Controller,IRequest,IResponse,validator,get} from 'appolo';  
@controller()  
export class TestController extends Controller{
    @inject() dataManager:DataManager
    
    @get("/search/")
    @validations({
        search:validator.string().required(),
        pageSize:validator.number().default(20),
        page:validator.number().default(1)
    })
    public async search (req:IRequest, res:IResponse,model:any) {
        return await this.dataManager.getSearchResults(model.search,model.page,model.pageSize)
    }      
}  

If the request params are not valid, appolo will return a 400 Bad Request response with detailed validation errors.

{  status: 400, message: "Bad Request",  error: "userId is required"  }  

Controllers

Controllers are classes that handle routes request.
In order for the router to be able to handle the request, a controller class must extend Controller.
Each controller action will be called with request and response objects.

import {controller,inject,validation,Controller,IRequest,IResponse,validator} from 'appolo';  
  
@controller()  
export class LoginController extends Controller{
    @inject() authManager:AuthManager;
    
    @post("/login/")
    @validation("username", validator.string())
    @validation("password", validator.string())
    public async loginUser(req:IRequest,res:IResponse,model:any){
        return  await this.authManager.validateUser(model.username,model.password)
    } 
}  

By default, appolo creates a new controller instance for every request. If you do not need a new controller instance for every request, you can inherit from StaticController which is singleton.

import {controller,singleton,inject,lazy,mehtod,path,validation,StaticController,Methods,validator,IRequest,IResponse,IRouteOptions} from 'appolo';  
@controller()  
@singleton()  
@lazy()  
export class LoginController extends StaticController{
    @inject() authManager:AuthManager;  
    
    @post("/login/")
    @validation("username", validator.string().required())
    @validation("password", validator.string().required())
    public aynsc loginUser(req:IRequest,res:IResponse,model:any){
        return await this.authManager.validateUser(req.model.username,req.model.password)  
	}
}  

Custom errors

by default the response will be wrapped with try catch and InternalServerError will be send to response.

	{  status: 500, message: "Bad Request",  error: "Internal Server Error"  }

or you can throw custom error

import {controller,inject,validation,Controller,IRequest,IResponse,validator} from 'appolo';  
  
@controller()  
export class LoginController extends Controller{
    @inject() authManager:AuthManager;
    @post("/login/")
    @validation("username", validator.string())
    @validation("password", validator.string())
    public async loginUser(req:IRequest,res:IResponse,model:any){
        try{
            return  await this.authManager.validateUser(model.username,model.password)
        }catch(e){
            throw new HttpError(401,"Not Found",e,{key:"value"},1000)
        }
    } 
}  
{
    "status": 401, "message": "Not Foundr", "error":"something is wrong", "code":1001,key:"value"
}  

Middleware

A middleware class will run before the action of the controller is invoked.
The middleware class must extend must extend appolo.Middleware and implement the run method.

Middleware file:

import {define,inject,Middleware,IRequest,IResponse,NextFn,IRouteOptions} from 'appolo';  
@define()  
export class AuthMiddleware extends Middleware {
    @inject() authManager:AuthManager;
    public async run(req:appolo.IRequest,res:IResponse,next:NextFn,route:IRouteOptions){
        try{
            let user =  await this.authManager.validateToken(req.headers.authorization)
            req.user = user;
            next();
        }catch(e){
            this.sendUnauthorized();
        }
    }
}  

now you can added the middleware to our route

@controller()  
export class LoginController extends Controller{
    @post("/someroute/")
    @middaleware(AuthMiddleware)
    public async someAction(req:IRequest,res:IResponse){
        return req.user
    } 
}  

Dependency Injection System

Appolo has a powerful Dependency Injection system based on appolo-inject.
It enables you to write organised, testable code based on the loose coupling idea.
You can always access the injector via app.injector.

class decorators

  • define - make the object injectable
  • singleton - the class will be created only once and the injector will return the same instance every time
  • lazy - wait for the class to be injected before creating it
  • alias - add alias name to the object (allows injecting multiple objects which share an alias using injectAlias)
  • aliasFactory - add alias factory name to the object (allows injecting multiple objects which share an alias using injectAliasFactory)

methods decorators

  • initMethod - The method will be called after all instances were created and all the properties injected.

property decorators

method parameter decorators

  • injectParam - inject object by parameter
//dataRemoteManager.ts  
import {define,singleton,initMethod,inject,IFactory,factory} from 'appolo';  
@define()  
@singleton()  
export class DataRemoteManager {
    getData(){ ...}
}
//dataManager.ts  
@define()  
@singleton()
@factory()  
export class DataManager implement IFactory {
    @inject() dataRemoteManager:DataRemoteManager
    
    get(){
        return this.dataRemoteManager;
    }
}    
//fooController.ts  
@controller()  
export class FooController{
    @inject() dataManager:DataManager
    constructor() {
        this.data = null
    }
    
    @initMethod()
    initialize(){
        this.data =  this.dataManager.getData();
    }
    
    @get("/data")
    getData(){
        return this.data;
    }
}   

You can also use constructor injection or method parameter injection:

import {define,singleton,injectParam,initMethod,inject} from 'appolo';  
@define()  
@singleton()  
export class DataManager {
    getData(){ ... }
}  
@define()
class FooController{
    constructor(@injectParam() dataManager:DataManager) {
        this.dataManager = dataManager;
    }
    
    @initMethod()
    public initialize(){
        this.data =  this.dataManager.getData();
    }
    
    public test(@injectParam() logger:Logger){... }
}  

Inherited injections

Inherited injections are supported as well.
Anything you inject on a base class will be available to child classes.
Remember not to use @define on the parent class.

import {define,singleton,injectParam,initMethod,inject} from 'appolo';  
  
export class BaseManager {
    @inject() protected env:any
    private getData(){...}
}  

@define()  
class FooManager extends BaseManager{
    @initMethod()
    public initialize(){
        //the env object in injected from the base class
        console.log(this.env.test)
    }
}    

Event Dispatcher

Appolo has a built-in event dispatcher to enable classes to listen to and fire events.
Event Dispatcher has the following methods:

import {define,singleton,injectParam,initMethod,inject,EventDispatcher} from 'appolo';  
@define()  
@singleton()  
export class FooManager extends EventDispatcher{
    public notifyUsers(){
        this.fireEvent('someEventName',{someData:'someData'})
    }
}  
@define()  
export class FooController {
    @inject() fooManager:FooManager;
    @initMethod()
    public initialize(){
        this.fooManager.on('someEventName',(data)=>{
            this.doSomething(data.someData)
        },this);
    }
    doSomething(data){...}  
}  

Modules

Third party modules can be easily loaded intto appolo inject and used in the inject container.
Each module must call appolo.module before it can be used by appolo launcher.
appolo.module accepts a function as an argument. The last argument to that function must be the next function: modules are loaded serially, so each module must call the next function or return a promise in order to continue the launch process.
Other arguments to the function are object which you wish to inject into the module (these objects must be injected earlier).

By default, each module can inject:

  • env - environment object,
  • inject - injector - to add objects to the injector,

Module example:

import {App} from 'appolo';  
export = async function(app:App){
    await app.module(async function(env:any,inject:appolo.Injector){
        let myModuleObject = {data:'test'};
        await toSomeThing();
        inject.addObject('myModuleObject',myModuleObject);
    });  
} 

Now we can inject myModuleObject to any class:

import {define,singleton,initMethod,inject} from 'appolo';  
@define()
export  class AuthMiddleware{
    @inject('myModuleObject') testObject:any
    public doSomeThing() {
        return this.testObject.data; //return 'test'
    }
}  

Logger module example

A logger module example with winston

loggerModule.js file:

import winston = require('winston');  
import {App} from 'appolo';  
export = async function(app:App){
    await appolo.module(async function(env:any,inject:appolo.Injector){
        transports = [];
        transports.push(new (winston.transports.Console)({
            json: false,
            timestamp: true
        })
    });
    let logger = new (winston.Logger)({  transports: transports});
    inject.addObject('logger', logger);});  

Now we you inject logger anywhere we need it:

import {define,singleton,initMethod,inject} from 'appolo';  
@define()  
export class DataManager{
    @inject() logger:Logger
    public initialize(){
        this.logger.info("dataManager initialized",{someData:'someData'})
    }
}  

Bootstrap

Once it launched, appolo will try to find an appolo bootstrap class and call it's run method. Only when the bootstrap is finished, the server will start

import {define,singleton,injectParam,initMethod,inject,bootstrap,IBootstrap} from 'appolo';  
@define()  
@bootstrap()  
export class Bootstrap implements IBootstrap{
    @inject() someManager1:SomeManager1
    public async run(){  
        //start your application logic here
        await this.someManager1.doSomeThing();
    }
}  
  

Reset

You can reset appolo sever by calling appolo.reset(). This will clean all environments, config, injector and close the server.

Tests

 grunt test  

License

The appolo library is released under the MIT license. So feel free to modify and distribute it as you wish.

Maintainers (1)
Downloads
Today 0
This Week 0
This Month 104
Last Day 0
Last Week 0
Last Month 223
Dependencies (6)
Dev Dependencies (38)

Copyright 2014 - 2016 © taobao.org |