aopromise v0.3.2
aopromise
Node.js Aspect oriented programming toolkit for Promise-based apps. It adds a simplified framework where you need are just providing a prepended and an appended function and aopromise will execute your aspects in the right order, exposing the necessary contextual information about the wrapped function. Aspects may read and manipulate arguments, prevent function execution, or even replace the function to be executed. It is suitable for implementing
- invocation logger
- pre-authorization
- argumentum validator (see JSON Schema validator aspect)
- memoize
- benchmark
- circuit-breaker (see Circuit-breaker aspect)
- timeout handler
Due to the asynchronous nature of many aspects, the library works only with synchronous functions or Promise-returning functions.
Quick start
var aop = require('aopromise');
// Have your aspect registered once
aop.register('logger', BeforeAfterLoggerAspect); // see definition below
// take a sync or promise-returning function
function addition(a, b) {
console.log('adding', a, 'and', b);
return a + b;
}
// Add you aspect using chaining
var loggedAdder = aop()
.logger('AdditionFunction')
.fn(addition);
// You may also use this syntax. The result is identical
loggedAdder = aop(addition, new BeforeAfterLoggerAspect('AdditionFunction')); // aspect declared below
// calling wrapped functions
loggedAdder(3, 4);
// outputs
// AdditionFunction was called with [ 3, 4 ]
// adding 3 and 4
// AdditionFunction returned with 7
/**
* Defining aspect. Using AspectFrame for factory.
*/
function BeforeAfterLoggerAspect(funcName) {
return new aop.AspectFrame(
function (preOpts) {
console.log(funcName || preOpts.originalFunction.name, 'was called with', preOpts.args);
},
function (postOpts) {
console.log(funcName || postOpts.originalFunction.name, 'returned with', postOpts.result);
}
);
}Ordering
The functions are executed in the following order: 1. pres 2. wrapped function 3. posts
As you can see later, you can add multiple aspects to a function. The order of the pre() functions is in the order how aspects were added. After the wrapped function executed, the post() methods are called in revers order. So if a logger and an auth aspect is added, the pre and post function order is 1. logger.pre 2. auth.pre 3. wrapped function 4. auth.post 5. logger.post
API
The aopromise API gives you API to register aspects and wrap functions with selected and configured aspects. To use chaining, first, you need to register the constructor functions of your aspects. They will be called with new operator, when used.
// sample aspects. They might be also available pretty soon
aop.register('logger', LoggerAspect);
aop.register('preauth', RoleBasedAuthorizerAspect);
aop.register('memoize', MemoizeAspect);A registered aspect is now can be used on the builder's interfaces. You can create a builder by invoking aopromise without any arguments. When you finished adding aspects, call fn(...) with your function as argument.
var getUserAop = aop()
.logger() // it will be logged
.preauth('ROLE_ADMIN') // function is preauthorized
.memoize() // caches the result for given argument
.fn(function getUser(userId){
// ...
});
getUserAop(123).then(function(){/*...*/});Binding
You may bind the function to an object by passing two parameter to fn()
function UserService(){
this.getUser = aop()
.logger() // it will be logged
.preauth('ROLE_ADMIN') // function is preauthorized
.memoize() // caches the result for given argument
.fn(
this, // this reference
function getUser(userId){ // the function to bind
// ...
}
);
}Alternatives
Don't like chaining or registering? Neither do I! Use wrapper function, parameters and array instead! You don't need to register either!
var getUserAop = aop.wrap(function getUser(userId){
// ...
} , new LoggerAspect(), new RoleBasedAuthorizerAspect(), new MemoizeAspect());You could even pass the aspects in an array if you sick of the smugness of beneficial of variable parameter!
var getUserAop = aop.wrap(function getUser(userId){/* ... */} , [new LoggerAspect(), new RoleBasedAuthorizerAspect(), new MemoizeAspect()]);Regardless of the sarcasm, this might be useful if you want to have factories adding the aspects for you.
Aspects
Aspects are orthogonal functionalities to your business logic. Boilerplates that are usually wrap your actually code. Your aspects may intercept the execution of the original function and apply custom logic, change arguments or the function itself.
Creating aspects
An aspect consist of an optional pre() and post() function. You may define either or both (or none, but that would be just silly). Pre and post functions of aspects must return promises, if defined, so chain execution would work.
AspectFrame
For convenience, you can use AspectPack class to create aspects easily. AspectFrame makes is simpler to create aspect and make sure you don't forget to return a promise: it returns a resolved promise if you don't have any return value.
var aop = require('aopromise');
function MyAspect(argumentForMyAspect){
return new aop.AspectFrame(
function (preOpts) {
// your pre
},
function (postOpts) {
// your post
}
);
}Pre and post methods are optional, of course.
function MyAspectWithPreOnly(){
return new aop.AspectFrame(function(){});
}
// or
function MyAspectWithPostOnly(){
return new aop.AspectFrame(null, function(){});
}Accessing arguments and result
Aspects receive contextual information about the exection. Pre methods receive the arguments, passed by invoker function. Post methods can additionally access the result. The example below demonstrate what properties the aspects may read at runtime.
var aop = require('aopromise');
function BeforeAfterLoggerAspect(funcName){
return new aop.AspectFrame(
function (preOpts) {
console.log(funcName, 'was called with', preOpts.args);
},
function (postOpts) {
console.log(funcName, 'returned with', postOpts.result);
console.log(funcName, 'was called with', preOpts.args);
console.log(funcName, 'was originally called with', preOpts.originalArgs);
console.log('Arguments replaced by any of the aspect.pre methods?', postOpts.argsReplaced);
console.log('Function replaced by any of the aspect.pre methods?', postOpts.functionReplaced);
}
);
}Manipulating the function invocation
You may want to create aspects that affect the execution of the wrapped function. Aspects may
- interrupt execution
- replace arguments
replace executed function
Interrupt execution
Aspect's pre() function may decide to interrupt execution of the wrapped function. This might be useful when creating validation or authorization aspects.
function OnlyNumberArgumentsAspect() {
return new aop.AspectFrame(
function (preOpts) {
// we are cloning the args with the slice function, since it is effective immutable
for (var i in preOpts.args) {
if (typeof(preOpts.args[i]) !== 'number') {
return Promise.reject('Argument #' + i + ' is not a number (' + typeof(e) + ' was given)');
}
}
;
return Promise.resolve();
}
);
}
var numberOnlyFunc = aop(
function () {
console.log('This function surely called with numbers only', arguments);
},
new OnlyNumberArgumentsAspect()
);
// will run ok
numberOnlyFunc(1, 2, 3).then(function () {
console.log('ok, numbers only');
}).catch(console.log);
// output error
numberOnlyFunc(1, 'oh-oh, not good, noooot good', 3).then(function () {
console.log('ok, numbers only');
}).catch(console.log);Replacing arguments
Aspect's pre() function may replace the arguments before the wrapped function is called by resolving the returned promise with a parameter object, having a newArgs property.
function AddExtraArgumentAspect(extraArgument) {
return new aop.AspectFrame(
function (preOpts) {
// we are cloning the args with the slice function, since it is effective immutable
var _args = preOpts.args.slice();
_args.push(extraArgument);
return Promise.resolve({newArgs: _args});
}
);
}
aop()
.aspect(new AddExtraArgumentAspect('additionArgValue'))
.fn(function(){
console.log('function called with', arguments);
})('normalArgument');Replacing function
You might need to prevent or replace the execution of the wrapped function if certain conditions are meet. A memoizer is an example, where you don't want to run the original function if the cache has a hit. The example above shows how you can replace the original function by returning an object with a newFunction property in the resolved promise in the pre function. You can also run the original function with the actual parameters easily by executing the runner() method which wraps the arguments for convenience.
var crypto = require('crypto');
function MemoizeAspect() {
var promiseMemory = {}; // you may want to use cache-server for this
return new AspectFrame(
function (preOpts) {
return Promise.resolve({newFunction: function () {
var hash = crypto.createHash('sha1').update(JSON.stringify(preOpts.args)).digest('hex'); // hash by the parameters
if (typeof promiseMemory[hash] !== 'undefined') { // hit?
return promiseMemory[hash];
} else {
// we are storing the promise as cached value, so no double calculation
return promiseMemory[hash] = preOpts.runner();
}
}});
}
)
}Replacing result
In some cases it is useful to replace the return value of the wrapped function. You may do that by returning newResult property in the post() function of the aspect. The example below sets the default value of the functions result if it was originally null.
function DefaultResultAspect(default) {
return new AspectFrame(
null, // no pre
function (opts) {
if(opts.result === null && !opts.hasOwnProperty('newResult')){
return Promise.resolve({newResult: default});
}
}
);
}Sharing data between pre and post
function BenchmarkAspect() {
return new AspectFrame(
function () {
return Promise.resolve({_startTime: process.hrtime()}); // adding \_startTime to the scope of the execution
},
function (opts) {
var diff = process.hrtime(opts._startTime); // we can access the \_startTime property here
console.log('Runtime: ' + (diff[0] + diff[1] / 1e9));
}
);
}