appolo
Version:
nodejs server framework
566 lines (493 loc) • 19.6 kB
Markdown
<p align=center>
<img src="https://www.dropbox.com/s/pwdvd6ohb74t7r7/appollo.png?raw=1" />
<br/>
<br/>
<img title="Known Vulnerabilities" src="https://travis-ci.org/shmoop207/appolo.svg?branch=master" />
<img title="Dependencies status" src="https://david-dm.org/shmoop207/appolo.svg" />
<img title="NPM version" src="https://badge.fury.io/js/appolo.svg" />
<img title="NPM Downloads" src="https://img.shields.io/npm/dm/appolo.svg?style=flat" />
<br/>
<br/>
<img title="Langauge" src="https://badge.langauge.io/shmoop207/appolo" />
</p>
Appolo is an light web server MVC Framework for Node.js written in Typescript<br>
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.
## Getting started
- Visit our [docs](https://appolojs.com) site [appolojs.com](https://appolojs.com)
## Features
* Super fast
* MVC Architecture
* Full support for [express][4] middleware
* Dependency injection
* Simple routing
* Modules system
* Manage easily configurations and environments
* Simple folder structures
* Easy integrate third party modules
* Easy to get started
## Installation
```javascript
npm install appolo --save
```
## Typescript
`appolo` requires TypeScript compiler version > 2.1 and the following settings in `tsconfig.json`:
```javascript
{
"experimentalDecorators": true
}
```
## Quick Start
In your app.js file:
```javascript
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
<!---## Appolo Http Boilerplate
Small example project to get you started with appolo.<br>
source code : [https://github.com/shmoop207/appolo-express-boilerplate][8]
```bash
git clone https://github.com/shmoop207/appolo-express-boilerplate.git
```
-->
## Examples
* __Real-time Stocks__: [demo](http://appolo-http-quotes-example.herokuapp.com) ,[code](https://github.com/shmoop207/quotes-example).
* __Chat__: [demo](http://appolo-chat-example.herokuapp.com/) , [source](https://github.com/shmoop207/appolo-chat-example).
## 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
```javascript
|- 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']`| | `root` | the root folder of the paths option | `string` | `process.cwd()` |
| `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:
```javascript
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`.
```javascript
//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`
```javascript
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.
```javascript
//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](https://expressjs.com/en/guide/routing.html) 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.
```javascript
import {define,inject,Controller,IRequest,IResponse,get,post} from 'appolo';
export class TestController extends Controller{
dataManager:DataManager
public test (req:IRequest, res:IResponse){
return this.dataManager.getData(req.params.userId));
}
}
```
or you can return response by using `res.send`
```javascript
export class Test2Controller extends Controller{
dataManager:DataManager
public test (req:IRequest, res:IResponse) {
res.send(this.dataManager.getData(req.params.userId));
}
}
```
You can also define routes using `appolo.route` method:
```javascript
import {controller,inject,Controller,IRequest,IResponse} from 'appolo';
export class TestController extends Controller{
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)
```
## 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][12] and [response][13] objects.
```javascript
import {controller,model,inject,Controller,IRequest,IResponse} from 'appolo';
export class LoginController extends Controller{
authManager:AuthManager;
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.
```javascript
import {controller,singleton,inject,lazy,mehtod,path,StaticController,Methods,IRequest,IResponse,IRouteOptions} from 'appolo';
export class LoginController extends StaticController{
authManager:AuthManager;
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.
```javascript
{ status: 500, message: "Bad Request", error: "Internal Server Error" }
```
or you can throw custom error
```javascript
import {controller,inject,Controller,IRequest,IResponse} from 'appolo';
export class LoginController extends Controller{
authManager:AuthManager;
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)
}
}
}
```
```javascript
{
"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:
```javascript
import {define,inject,Middleware,IRequest,IResponse,NextFn,IRouteOptions} from 'appolo';
export class AuthMiddleware extends Middleware {
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
```javascript
export class LoginController extends Controller{
public async someAction(req:IRequest,res:IResponse){
return req.user
}
}
```
## Dependency Injection System
Appolo has a powerful [Dependency Injection][22] system based on [appolo-inject](https://github.com/shmoop207/appolo-inject).
It enables you to write organised, testable code based on the [loose coupling][24] idea.
You can always access the injector via `app.injector`.
### class decorators
- `define` - make the object injectable
- [`singleton`](https://github.com/shmoop207/appolo-inject#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`](https://github.com/shmoop207/appolo-inject#alias) - add alias name to the object (allows injecting multiple objects which share an alias using `injectAlias`)
- [`aliasFactory`](https://github.com/shmoop207/appolo-inject#alias-factory) - add alias factory name to the object (allows injecting multiple objects which share an alias using `injectAliasFactory`)
### methods decorators
- [`initMethod`](https://github.com/shmoop207/appolo-inject#init-method) - The method will be called after all instances were created and all the properties injected.
### property decorators
- [`inject`](https://github.com/shmoop207/appolo-inject#inject-property-instance) - inject instance reference by id
- [`injectFactoryMethod`](https://github.com/shmoop207/appolo-inject#inject-factory-method) - factory method is a function that will return the injected object. This is useful to create many instances of the same class.
- [`injectAlias`](https://github.com/shmoop207/appolo-inject#alias) - inject objects by alias name
- [`injectArray`](https://github.com/shmoop207/appolo-inject#inject-property-array) - inject array of properties by reference or by value
- [`injectDictionary`](https://github.com/shmoop207/appolo-inject#inject-property-dictionary) - inject a dictionary of properties by reference or by value.
- [`injectAliasFactory`](https://github.com/shmoop207/appolo-inject#alias-factory) - inject factory methods by alias name
- [`injectFactory`](https://github.com/shmoop207/appolo-inject#inject-property-from-factory-object) inject object by factory class
- [`injectObjectProperty`](https://github.com/shmoop207/appolo-inject#inject-property-from-object-property) inject property of another object
- [`injectValue`](https://github.com/shmoop207/appolo-inject#inject-property-value) inject property by value
### method parameter decorators
- `injectParam` - inject object by parameter
```javascript
//dataRemoteManager.ts
import {define,singleton,initMethod,inject,IFactory,factory} from 'appolo';
export class DataRemoteManager {
getData(){ ...}
}
//dataManager.ts
export class DataManager implement IFactory {
dataRemoteManager:DataRemoteManager
get(){
return this.dataRemoteManager;
}
}
//fooController.ts
export class FooController{
dataManager:DataManager
constructor() {
this.data = null
}
initialize(){
this.data = this.dataManager.getData();
}
getData(){
return this.data;
}
}
```
You can also use constructor injection or method parameter injection:
```javascript
import {define,singleton,injectParam,initMethod,inject} from 'appolo';
export class DataManager {
getData(){ ... }
}
class FooController{
constructor( dataManager:DataManager) {
this.dataManager = dataManager;
}
public initialize(){
this.data = this.dataManager.getData();
}
public test( 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 `` on the parent class.
```javascript
import {define,singleton,injectParam,initMethod,inject} from 'appolo';
export class BaseManager {
protected env:any
private getData(){...}
}
class FooManager extends BaseManager{
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:
```javascript
import {define,singleton,injectParam,initMethod,inject,EventDispatcher} from 'appolo';
export class FooManager extends EventDispatcher{
public notifyUsers(){
this.fireEvent('someEventName',{someData:'someData'})
}
}
export class FooController {
fooManager:FooManager;
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:
```javascript
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:
```javascript
import {define,singleton,initMethod,inject} from 'appolo';
export class AuthMiddleware{
testObject:any
public doSomeThing() {
return this.testObject.data; //return 'test'
}
}
```
### Logger module example
A logger module example with [winston][19]
loggerModule.js file:
```javascript
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:
```javascript
import {define,singleton,initMethod,inject} from 'appolo';
export class DataManager{
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
```javascript
import {define,singleton,injectParam,initMethod,inject,bootstrap,IBootstrap} from 'appolo';
export class Bootstrap implements IBootstrap{
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 ##
```javascript
grunt test
```
## License ##
The `appolo` library is released under the MIT license. So feel free to modify and distribute it as you wish.
[1]: http://expressjs.com/
[2]: https://www.github.com/shmoop207/appolo
[3]: https://www.github.com/shmoop207/appolo-inject
[4]: http://expressjs.com/en/resources/middleware.html
[12]: http://expressjs.com/en/4x/api.html#req
[13]: http://expressjs.com/en/4x/api.html#res
[19]: https://github.com/flatiron/winston
[22]: http://en.wikipedia.org/wiki/Dependency_injection
[23]: https://github.com/shmoop207/appolo-inject
[24]: http://en.wikipedia.org/wiki/Loose_coupling