Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs and cleanup #3

Merged
merged 2 commits into from
Aug 10, 2016
Merged

Docs and cleanup #3

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
28e99e5
API cleanup
bajtos Aug 1, 2016
62f6871
Add big fat warning to README
bajtos Aug 1, 2016
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 18 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,28 @@
Current context for LoopBack applications, based on
node-continuation-local-storage.

## WARNING

The module node-continuation-local-storage is known to have many problems,
see e.g. [issue #59](https://github.com/othiym23/node-continuation-local-storage/issues/59).
As a result, loopback-context does not work in many situations, as can be
seen from issues reported in LoopBack's
[issue tracker](https://github.com/strongloop/loopback/issues?utf8=%E2%9C%93&q=is%3Aissue%20getCurrentcontext).

**We recommend AGAINST using this module.**

If you are running on Node v6, you can try the new alternative
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We need another alternative that doesn't use CLS at all.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We need another alternative that doesn't use CLS at all.

Agreed!

[cls-hooked](https://github.com/Jeff-Lewis/cls-hooked).

## Usage

1) Add `per-request-context` middleware to your
1) Add `per-request` middleware to your
`server/middleware-config.json`:

```json
{
"initial": {
"loopback-context#per-request-context": {
"loopback-context#per-request": {
}
}
}
Expand All @@ -31,4 +44,6 @@ MyModel.myMethod = function(cb) {
});
```

See also https://docs.strongloop.com/display/APIC/Using+current+context
See the official LoopBack
[documentation](https://docs.strongloop.com/display/APIC/Using+current+context)
for more details.
7 changes: 7 additions & 0 deletions server/current-context.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -94,3 +94,10 @@ LoopBackContext.createContext = function(scopeName) {
}
return ns;
};

/**
* Create middleware that sets up a new context for each incoming HTTP request.
*
* See perRequestContextFactory for more details.
*/
LoopBackContext.perRequest = require('./middleware/per-request');
6 changes: 3 additions & 3 deletions server/middleware/per-request-context.js → server/middleware/per-request.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@

var LoopBackContext = require('../current-context');

module.exports = context;
module.exports = perRequestContextFactory;

var name = 'loopback';

Expand All @@ -26,14 +26,14 @@ var name = 'loopback';
* @property {Boolean} enableHttpContext Whether HTTP context is enabled. Default is false.
*/

function context(options) {
function perRequestContextFactory(options) {
options = options || {};
var scope = options.name || name;
var enableHttpContext = options.enableHttpContext || false;
var ns = LoopBackContext.createContext(scope);

// Return the middleware
return function contextHandler(req, res, next) {
return function perRequestContext(req, res, next) {
if (req.loopbackContext) {
return next();
}
Expand Down
14 changes: 7 additions & 7 deletions test/main.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@

'use strict';

var ClsContext = require('..');
var LoopBackContext = require('..');
var Domain = require('domain');
var EventEmitter = require('events').EventEmitter;
var expect = require('./helpers/expect');
Expand Down Expand Up @@ -39,7 +39,7 @@ describe('LoopBack Context', function() {
var app = loopback({localRegistry: true, loadBuiltinModels: true});
app.set('remoting', {context: false});
app.set('legacyExplorer', false);
app.use(require('../server/middleware/per-request-context')());
app.use(LoopBackContext.perRequest());
app.use(loopback.rest());
app.dataSource('db', {connector: 'memory'});

Expand All @@ -48,7 +48,7 @@ describe('LoopBack Context', function() {

// function for remote method
TestModel.test = function(inst, cb) {
var tmpCtx = ClsContext.getCurrentContext();
var tmpCtx = LoopBackContext.getCurrentContext();
if (tmpCtx) tmpCtx.set('data', 'a value stored in context');
if (process.domain) cb = process.domain.bind(cb); // IMPORTANT
runInOtherDomain(cb);
Expand All @@ -63,7 +63,7 @@ describe('LoopBack Context', function() {

// after remote hook
TestModel.afterRemote('**', function(ctxx, inst, next) {
var tmpCtx = ClsContext.getCurrentContext();
var tmpCtx = LoopBackContext.getCurrentContext();
if (tmpCtx) {
ctxx.result.data = tmpCtx.get('data');
} else {
Expand All @@ -85,12 +85,12 @@ describe('LoopBack Context', function() {
});

it('works outside REST middleware', function(done) {
ClsContext.runInContext(function() {
var ctx = ClsContext.getCurrentContext();
LoopBackContext.runInContext(function() {
var ctx = LoopBackContext.getCurrentContext();
expect(ctx).is.an('object');
ctx.set('test-key', 'test-value');
process.nextTick(function() {
var ctx = ClsContext.getCurrentContext();
var ctx = LoopBackContext.getCurrentContext();
expect(ctx).is.an('object');
expect(ctx.get('test-key')).to.equal('test-value');

Expand Down