hyperzlib
/
nodebb
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Merge pull request #4162 from akhoury/master

Browse Source 
add continuation-local-storage (CLS) support
v1.18.x
Barış Soner Uşaklı 9 years ago
parent d8c21cc09d 3dc63438de
commit f0685468f8
5 changed files with 252 additions and 163 deletions
Show Stats Download Patch File Download Diff File

1
package.json
Unescape Escape View File

@ -26,6 +26,7 @@
"connect-mongo": "~1.1.0", "connect-mongo": "~1.1.0",
"connect-multiparty": "^2.0.0", "connect-multiparty": "^2.0.0",
"connect-redis": "~3.0.2", "connect-redis": "~3.0.2",
"continuation-local-storage": "^3.1.6",
"cookie-parser": "^1.3.3", "cookie-parser": "^1.3.3",
"cron": "^1.0.5", "cron": "^1.0.5",
"csurf": "^1.6.1", "csurf": "^1.6.1",

38
src/middleware/cls.js
Unescape Escape View File

@ -0,0 +1,38 @@
var path = require('path');
var sockets = require('path');
var websockets = require('../socket.io/');
var continuationLocalStorage = require('continuation-local-storage');
var APP_NAMESPACE = require(path.join(__dirname, '../../package.json')).name;
var namespace = continuationLocalStorage.createNamespace(APP_NAMESPACE);
(function(cls) {
cls.http = function (req, res, next) {
namespace.run(function() {
namespace.set('request', req);
next && next();
});
};
cls.socket = function (socket, payload, event, next) {
namespace.run(function() {
namespace.set('request', websockets.reqFromSocket(socket, payload, event));
next && next();
});
};
cls.get = function (key) {
return namespace.get(key);
};
cls.set = function (key, value) {
return namespace.set(key, value);
};
cls.setItem = cls.set;
cls.getItem = cls.set;
cls.namespace = namespace;
cls.continuationLocalStorage = continuationLocalStorage;
})(exports);

2
src/middleware/index.js
Unescape Escape View File

@ -14,6 +14,7 @@ var meta = require('../meta'),
compression = require('compression'), compression = require('compression'),
favicon = require('serve-favicon'), favicon = require('serve-favicon'),
session = require('express-session'), session = require('express-session'),
cls = require('./cls'),
useragent = require('express-useragent'); useragent = require('express-useragent');
@ -73,6 +74,7 @@ module.exports = function(app) {
app.use(middleware.addHeaders); app.use(middleware.addHeaders);
app.use(middleware.processRender); app.use(middleware.processRender);
app.use(cls.http);
auth.initialize(app, middleware); auth.initialize(app, middleware);
return middleware; return middleware;

33
src/plugins/hooks.js
Unescape Escape View File

@ -8,6 +8,28 @@ module.exports = function(Plugins) {
'filter:user.custom_fields': null // remove in v1.1.0 'filter:user.custom_fields': null // remove in v1.1.0
}; };
Plugins.deprecatedHooksParams = {
'action:homepage.get': '{req, res}',
'filter:register.check': '{req, res}',
'action:user.loggedOut': '{req, res}',
'static:user.loggedOut': '{req, res}',
'filter:categories.build': '{req, res}',
'filter:category.build': '{req, res}',
'filter:group.build': '{req, res}',
'filter:register.build': '{req, res}',
'filter:composer.build': '{req, res}',
'filter:popular.build': '{req, res}',
'filter:recent.build': '{req, res}',
'filter:topic.build': '{req, res}',
'filter:users.build': '{req, res}',
'filter:admin.category.get': '{req, res}',
'filter:middleware.renderHeader': '{req, res}',
'filter:widget.render': '{req, res}',
'filter:middleware.buildHeader': '{req, locals}',
'action:middleware.pageView': '{req}',
'action:meta.override404': '{req}'
};
/* /*
`data` is an object consisting of (* is required): `data` is an object consisting of (* is required):
`data.hook`*, the name of the NodeBB hook `data.hook`*, the name of the NodeBB hook
@ -33,6 +55,17 @@ module.exports = function(Plugins) {
'there is no alternative.' 'there is no alternative.'
) )
); );
} else {
// handle hook's startsWith, i.e. action:homepage.get
var _parts = data.hook.split(':');
_parts.pop();
var _hook = _parts.join(':');
if (Plugins.deprecatedHooksParams[_hook]) {
winston.warn('[plugins/' + id + '] Hook `' + _hook + '` parameters: `' + Plugins.deprecatedHooksParams[_hook] + '`, are being deprecated, '
+ 'all plugins should now use the `middleware/cls` module instead of hook\'s arguments to get a reference to the `req`, `res` and/or `socket` object(s) (from which you can get the current `uid` if you need to.) '
+ '- for more info, visit https://docs.nodebb.org/en/latest/plugins/create.html#getting-a-reference-to-each-request-from-within-any-plugin-hook');
delete Plugins.deprecatedHooksParams[_hook];
}
} }
if (data.hook && data.method) { if (data.hook && data.method) {

91
src/socket.io/index.js
Unescape Escape View File

@ -10,13 +10,13 @@ var winston = require('winston');
var db = require('../database'); var db = require('../database');
var logger = require('../logger'); var logger = require('../logger');
var ratelimit = require('../middleware/ratelimit'); var ratelimit = require('../middleware/ratelimit');
var cls = require('../middleware/cls');
var Sockets = {}; (function(Sockets) {
var Namespaces = {}; var Namespaces = {};
var io;
var io; Sockets.init = function (server) {
Sockets.init = function(server) {
requireModules(); requireModules();
io = new SocketIO({ io = new SocketIO({
@ -29,44 +29,55 @@ Sockets.init = function(server) {
io.use(authorize); io.use(authorize);
io.on('connection', onConnection); io.on('connection', onConnection);
io.on('disconnect', onDisconnect);
io.listen(server, { io.listen(server, {
transports: nconf.get('socket.io:transports') transports: nconf.get('socket.io:transports')
}); });
Sockets.server = io; Sockets.server = io;
}; };
function onConnection(socket) { function onConnection(socket) {
socket.ip = socket.request.headers['x-forwarded-for'] || socket.request.connection.remoteAddress; socket.ip = socket.request.headers['x-forwarded-for'] || socket.request.connection.remoteAddress;
logger.io_one(socket, socket.uid); logger.io_one(socket, socket.uid);
cls.socket(socket, null, 'connection', function () {
onConnect(socket); onConnect(socket);
});
socket.on('*', function(payload) { socket.on('*', function (payload) {
cls.socket(socket, payload, null, function () {
onMessage(socket, payload); onMessage(socket, payload);
}); });
} });
}
function onConnect(socket) { function onConnect(socket) {
if (socket.uid) { if (socket.uid) {
socket.join('uid_' + socket.uid); socket.join('uid_' + socket.uid);
socket.join('online_users'); socket.join('online_users');
} else { } else {
socket.join('online_guests'); socket.join('online_guests');
} }
} }
function onDisconnect(socket) {
cls.socket(socket, null, 'disconnect', function () {
});
}
function onMessage(socket, payload) { function onMessage(socket, payload) {
if (!payload.data.length) { if (!payload.data.length) {
return winston.warn('[socket.io] Empty payload'); return winston.warn('[socket.io] Empty payload');
} }
var eventName = payload.data[0]; var eventName = payload.data[0];
var params = payload.data[1]; var params = payload.data[1];
var callback = typeof payload.data[payload.data.length - 1] === 'function' ? payload.data[payload.data.length - 1] : function() {}; var callback = typeof payload.data[payload.data.length - 1] === 'function' ? payload.data[payload.data.length - 1] : function () {
};
if (!eventName) { if (!eventName) {
return winston.warn('[socket.io] Empty method name'); return winston.warn('[socket.io] Empty method name');
@ -74,7 +85,7 @@ function onMessage(socket, payload) {
var parts = eventName.toString().split('.'); var parts = eventName.toString().split('.');
var namespace = parts[0]; var namespace = parts[0];
var methodToCall = parts.reduce(function(prev, cur) { var methodToCall = parts.reduce(function (prev, cur) {
if (prev !== null && prev[cur]) { if (prev !== null && prev[cur]) {
return prev[cur]; return prev[cur];
} else { } else {
@ -82,7 +93,7 @@ function onMessage(socket, payload) {
} }
}, Namespaces); }, Namespaces);
if(!methodToCall) { if (!methodToCall) {
if (process.env.NODE_ENV === 'development') { if (process.env.NODE_ENV === 'development') {
winston.warn('[socket.io] Unrecognized message: ' + eventName); winston.warn('[socket.io] Unrecognized message: ' + eventName);
} }
@ -114,36 +125,36 @@ function onMessage(socket, payload) {
function (next) { function (next) {
methodToCall(socket, params, next); methodToCall(socket, params, next);
} }
], function(err, result) { ], function (err, result) {
callback(err ? {message: err.message} : null, result); callback(err ? {message: err.message} : null, result);
}); });
} }
function requireModules() { function requireModules() {
var modules = ['admin', 'categories', 'groups', 'meta', 'modules', var modules = ['admin', 'categories', 'groups', 'meta', 'modules',
'notifications', 'plugins', 'posts', 'topics', 'user', 'blacklist' 'notifications', 'plugins', 'posts', 'topics', 'user', 'blacklist'
]; ];
modules.forEach(function(module) { modules.forEach(function (module) {
Namespaces[module] = require('./' + module); Namespaces[module] = require('./' + module);
}); });
} }
function validateSession(socket, callback) { function validateSession(socket, callback) {
var req = socket.request; var req = socket.request;
if (!req.signedCookies || !req.signedCookies['express.sid']) { if (!req.signedCookies || !req.signedCookies['express.sid']) {
return callback(new Error('[[error:invalid-session]]')); return callback(new Error('[[error:invalid-session]]'));
} }
db.sessionStore.get(req.signedCookies['express.sid'], function(err, sessionData) { db.sessionStore.get(req.signedCookies['express.sid'], function (err, sessionData) {
if (err || !sessionData) { if (err || !sessionData) {
return callback(err || new Error('[[error:invalid-session]]')); return callback(err || new Error('[[error:invalid-session]]'));
} }
callback(); callback();
}); });
} }
function authorize(socket, callback) { function authorize(socket, callback) {
var request = socket.request; var request = socket.request;
if (!request) { if (!request) {
@ -151,11 +162,11 @@ function authorize(socket, callback) {
} }
async.waterfall([ async.waterfall([
function(next) { function (next) {
cookieParser(request, {}, next); cookieParser(request, {}, next);
}, },
function(next) { function (next) {
db.sessionStore.get(request.signedCookies['express.sid'], function(err, sessionData) { db.sessionStore.get(request.signedCookies['express.sid'], function (err, sessionData) {
if (err) { if (err) {
return next(err); return next(err);
} }
@ -169,9 +180,9 @@ function authorize(socket, callback) {
}); });
} }
], callback); ], callback);
} }
function addRedisAdapter(io) { function addRedisAdapter(io) {
if (nconf.get('redis')) { if (nconf.get('redis')) {
var redisAdapter = require('socket.io-redis'); var redisAdapter = require('socket.io-redis');
var redis = require('../database/redis'); var redis = require('../database/redis');
@ -182,28 +193,33 @@ function addRedisAdapter(io) {
} else if (nconf.get('isCluster') === 'true') { } else if (nconf.get('isCluster') === 'true') {
winston.warn('[socket.io] Clustering detected, you are advised to configure Redis as a websocket store.'); winston.warn('[socket.io] Clustering detected, you are advised to configure Redis as a websocket store.');
} }
} }
Sockets.in = function(room) { Sockets.in = function (room) {
return io.in(room); return io.in(room);
}; };
Sockets.getUserSocketCount = function(uid) { Sockets.getUserSocketCount = function (uid) {
if (!io) { if (!io) {
return 0; return 0;
} }
var room = io.sockets.adapter.rooms['uid_' + uid]; var room = io.sockets.adapter.rooms['uid_' + uid];
return room ? room.length : 0; return room ? room.length : 0;
}; };
Sockets.reqFromSocket = function(socket) { Sockets.reqFromSocket = function (socket, payload, event) {
var headers = socket.request.headers; var headers = socket.request.headers;
var host = headers.host; var host = headers.host;
var referer = headers.referer || ''; var referer = headers.referer || '';
var data = ((payload || {}).data || []);
return { return {
uid: socket.uid,
params: data[1],
method: event || data[0],
body: payload,
ip: headers['x-forwarded-for'] || socket.ip, ip: headers['x-forwarded-for'] || socket.ip,
host: host, host: host,
protocol: socket.request.connection.encrypted ? 'https' : 'http', protocol: socket.request.connection.encrypted ? 'https' : 'http',
@ -212,7 +228,6 @@ Sockets.reqFromSocket = function(socket) {
path: referer.substr(referer.indexOf(host) + host.length), path: referer.substr(referer.indexOf(host) + host.length),
headers: headers headers: headers
}; };
}; };
module.exports = Sockets; })(exports);
Write Preview
Loading…
Cancel
Save