github/meteor
1
1
Fork 0
mirror of https://github.com/meteor/meteor.git synced 2026-05-02 03:01:46 -04:00
Code Issues Packages Projects Releases Wiki Activity

Code cleanup including 80 character limit formatting and refactoring.

Browse Source 
Refactored rate-limit.js to remove duplicate code.
Removed commented out code and extra whitespace.
This commit is contained in:
Anubhav Jain
2015-06-22 15:40:56 -07:00
parent 9afcf90503
commit 239f806c7d
6 changed files with 100 additions and 71 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
packages/ddp-rate-limiter/ddp-rate-limiter-tests.js
View File

@@ -42,12 +42,7 @@ if ( Meteor.isClient ) {
error ) {
console.log( "We threw an error.", error );
} );
}
}
] );
};

34
packages/ddp-rate-limiter/ddp-rate-limiter.js
View File

@@ -1,25 +1,31 @@
// Write your package code here!
// Rate Limiter built into DDP
DDPRateLimiter = {}
DDPRateLimiter.RateLimiter = new RateLimiter();
// Add a default rule of limiting logins to 5 times per 10 seconds by IP address. Override using DDPRateLimiter.config
DDPRateLimiter.addRule({ userId: null, IPAddr : function (IPAddr) {
return true }, method: 'login'}, 5, 10000);
// Add a default rule of limiting logins to 5 times per 10 seconds by IP address.
// Override using DDPRateLimiter.config
DDPRateLimiter.RateLimiter.addRule( {
userId: null,
IPAddr: function( IPAddr ) {
return true
},
method: 'login'
}, 5, 10000 );
DDPRateLimiter.ErrorMessage = function (rateLimitResult) {
return "Error, too many requests. Please slow down. You must wait "
+ Math.ceil(rateLimitResult.timeToReset / 1000) + " seconds before trying again.";
}
DDPRateLimiter.getErrorMessage = function( rateLimitResult ) {
return "Error, too many requests. Please slow down. You must wait " + Math.ceil(
rateLimitResult.timeToReset / 1000 ) + " seconds before trying again.";
}
DDPRateLimiter.config = function (rules) {
DDPRateLimiter.RateLimiter.rules = rules;
DDPRateLimiter.config = function( rules ) {
DDPRateLimiter.RateLimiter.rules = rules;
};
DDPRateLimiter.addRule = function (rule, numRequests, intervalTime) {
DDPRateLimiter.RateLimiter.addRule(rule, numRequests, intervalTime);
DDPRateLimiter.addRule = function( rule, numRequests, intervalTime ) {
DDPRateLimiter.RateLimiter.addRule( rule, numRequests, intervalTime );
};
DDPRateLimiter.setErrorMessage = function (message) {
DDPRateLimiter.ErrorMessage = message;
DDPRateLimiter.setErrorMessage = function( message ) {
DDPRateLimiter.ErrorMessage = message;
}

2
packages/ddp-rate-limiter/package.js
View File

@@ -11,7 +11,7 @@ Package.describe({
});
Package.onUse(function(api) {
// api.versionsFrom('1.1.0.2');
// api.versionsFrom('1.1.0.2');
api.use('rate-limit');
api.export('DDPRateLimiter');
api.addFiles('ddp-rate-limiter.js');

6
packages/ddp-server/livedata_server.js
View File

@@ -242,7 +242,7 @@ var Session = function (server, version, socket, options) {
self._namedSubs = {};
self._universalSubs = [];
self.userId = null;
self.userId = null;
self.collectionViews = {};
// Set this to false to not send messages when collectionViews are
@@ -648,9 +648,9 @@ _.extend(Session.prototype, {
DDPRateLimiter.RateLimiter.increment(invocation);
var rateLimitResult = DDPRateLimiter.RateLimiter.check(invocation)
if (!rateLimitResult.valid) {
throw new Meteor.Error(429, DDPRateLimiter.ErrorMessage(rateLimitResult));
throw new Meteor.Error(429, DDPRateLimiter.getErrorMessage(rateLimitResult));
}
var result = DDPServer._CurrentWriteFence.withValue(fence, function () {
return DDP._CurrentInvocation.withValue(invocation, function () {
return maybeAuditArgumentChecks(

1
packages/rate-limit/rate-limit-tests.js
View File

@@ -105,6 +105,7 @@ Tinytest.add( 'Check two rules that affect same methodInvc still throw',
// After for loop runs, we only have 10 runs, so that's under the limit
test.equal( r.check( methodInvc1 ).valid, true );
// However, this triggers userId rule since this userId is even
test.equal(r.check(methodInvc2).valid, false);
test.equal( r.check( methodInvc2 ).valid, false );
// Running one more test causes it to be false, since we're at 11 now.

123
packages/rate-limit/rate-limit.js
View File

@@ -19,56 +19,59 @@ RateLimiter = function() {
/**
* Checks if this method invocation is valid
* @param {object} methodInvocation DDPCommon.MethodInvocation object with added 'method' attribute listing the method name
* @return {object} Returns object of whether method invocation is valid, time to next reset and number invocations left
* @param {object} methodInvocation DDPCommon.MethodInvocation object with
* added 'method' attribute listing the method name
* @return {object} Returns object of whether method invocation is valid, time
* to next reset and number invocations left
*/
RateLimiter.prototype.check = function( methodInvocation ) {
var self = this;
var reply = {
valid: true,
timeToReset: Infinity,
timeToReset: 0,
numInvocationsLeft: Infinity
};
// Figure out all the rules this method invocation matches
_.find( self.rules, function( rule ) {
_.each( self.rules, function( rule ) {
// Check if this rule should be applied for this method invocation
if ( RateLimiter.prototype.matchRuleUsingFind( rule, methodInvocation ) ) {
var methodString = self._generateMethodInvocationKeyStringFromRuleMapping(
rule, methodInvocation );
var timeSinceLastReset = new Date().getTime() - rule._lastResetTime;
var timeToNextReset = rule.intervalTime - timeSinceLastReset;
var numInvocations = self.ruleInvocationCounters[ rule.ruleId ][
methodString
];
var matchRuleHelper = self._matchRuleHelper( rule, methodInvocation );
if ( numInvocations > rule.numRequestsAllowed && timeSinceLastReset <
rule.intervalTime ) {
reply = {
valid: false,
timeToReset: timeToNextReset,
numInvocationsLeft: 0
}
return true;
var numInvocations = self.ruleInvocationCounters[ rule.ruleId ]
[ matchRuleHelper.methodString ];
if ( numInvocations > rule.numRequestsAllowed &&
matchRuleHelper.timeSinceLastReset < rule.intervalTime ) {
if ( reply.timeToReset < matchRuleHelper.timeToNextReset ) {
reply.timeToReset = matchRuleHelper.timeToNextReset;
};
reply.valid = false;
reply.numInvocationsLeft = 0;
} else {
if ( rule.numRequestsAllowed - numInvocations < reply.numInvocationsLeft )
if ( rule.numRequestsAllowed - numInvocations < reply.numInvocationsLeft &&
reply.valid ) {
reply = {
valid: true,
timeToReset: timeToNextReset < 0 ? rule.intervalTime : timeToNextReset,
numInvocationsLeft: rule.numRequestsAllowed - numInvocations
timeToReset: matchRuleHelper.timeToNextReset < 0 ?
rule.intervalTime : matchRuleHelper.timeToNextReset,
numInvocationsLeft: rule.numRequestsAllowed -
numInvocations
};
}
}
}
} );
// console.log('method invocation ', methodInvocation, ' reply :' , reply);
return reply;
}
/**
* Adds a rule to with a specified identifier query to list of rules that are checked against on every method invocation
* Adds a rule to with a specified identifier query to list of rules that are
* checked against on every method invocation
* @param {object} identifierQuery Specified domain for rate limit rule
* { userId: ID | function() | null,
* IPAddr: ID | function() | null,
* method: name | function() | null
* IPAddr: ID | function() | null,
* method: name | function() | null
* All functions must return T/F to input to determine rule match
* @param {integer} numRequestsAllowed Number of requests allowed per interval
* @param {integer} intervalTime Number of milliseconds before interval is reset
@@ -76,18 +79,20 @@ RateLimiter.prototype.check = function( methodInvocation ) {
RateLimiter.prototype.addRule = function( identifierQuery, numRequestsAllowed,
intervalTime ) {
identifierQuery.ruleId = this._createNewRuleId();
identifierQuery.numRequestsAllowed = numRequestsAllowed ?
numRequestsAllowed : DEFAULT_REQUESTS_PER_INTERVAL;
identifierQuery.intervalTime = intervalTime ? intervalTime :
identifierQuery.numRequestsAllowed = numRequestsAllowed ||
DEFAULT_REQUESTS_PER_INTERVAL;
identifierQuery.intervalTime = intervalTime ||
DEFAULT_INTERVAL_TIME_IN_MILLISECONDS;
identifierQuery._lastResetTime = new Date().getTime();
this.rules.push( identifierQuery );
}
/**
* Matches whether a given method invocation matches a certain rule. Short circuits search if rule and method invocation don't match
* Matches whether a given method invocation matches a certain rule. Short
* circuits search if rule and method invocation don't match
* @param {object} rule Rule as defined as an identifierQuery above
* @param {object} methodInvocation DDPCommon.MethodInvocation object with added 'method' attribute listing the method name
* @param {object} methodInvocation DDPCommon.MethodInvocation object with
* added 'method' attribute listing the method name
* @return {boolean} Returns whether the methodInvocation matches inputted rule
*/
RateLimiter.prototype.matchRuleUsingFind = function( rule, methodInvocation ) {
@@ -116,7 +121,8 @@ RateLimiter.prototype.matchRuleUsingFind = function( rule, methodInvocation ) {
/**
* Increment appropriate counters on every method invocation
* @param {object} methodInvocation DDPCommon.MethodInvocation object with added 'method' attribute listing the method name
* @param {object} methodInvocation DDPCommon.MethodInvocation object with
* added 'method' attribute listing the method name
*/
RateLimiter.prototype.increment = function( methodInvocation ) {
var self = this;
@@ -124,10 +130,9 @@ RateLimiter.prototype.increment = function( methodInvocation ) {
_.each( this.rules, function( rule ) {
// Check if this rule should be applied for this method invocation
if ( RateLimiter.prototype.matchRuleUsingFind( rule, methodInvocation ) ) {
var methodString = self._generateMethodInvocationKeyStringFromRuleMapping(
rule, methodInvocation );
var timeSinceLastReset = new Date().getTime() - rule._lastResetTime;
if ( timeSinceLastReset > rule.intervalTime ) {
var matchRuleHelper = self._matchRuleHelper( rule, methodInvocation )
if ( matchRuleHelper.timeSinceLastReset > rule.intervalTime ) {
rule._lastResetTime = new Date().getTime();
// Reset all the counters for this rule
_.each( self.ruleInvocationCounters[ rule.ruleId ], function(
@@ -136,16 +141,18 @@ RateLimiter.prototype.increment = function( methodInvocation ) {
0;
} );
}
var timeToNextReset = rule.intervalTime - timeSinceLastReset;
if ( rule.ruleId in self.ruleInvocationCounters ) {
if ( methodString in self.ruleInvocationCounters[ rule.ruleId ] ) {
self.ruleInvocationCounters[ rule.ruleId ][ methodString ]++;
if ( matchRuleHelper.methodString in self.ruleInvocationCounters[
rule.ruleId ] ) {
self.ruleInvocationCounters[ rule.ruleId ][ matchRuleHelper.methodString ]++;
} else {
self.ruleInvocationCounters[ rule.ruleId ][ methodString ] = 1;
self.ruleInvocationCounters[ rule.ruleId ][ matchRuleHelper.methodString ] =
1;
}
} else {
self.ruleInvocationCounters[ rule.ruleId ] = {};
self.ruleInvocationCounters[ rule.ruleId ][ methodString ] = 1;
self.ruleInvocationCounters[ rule.ruleId ][ matchRuleHelper.methodString ] =
1;
}
}
} );
@@ -157,10 +164,13 @@ RateLimiter.prototype._createNewRuleId = function() {
}
/**
* Generates string of fields that match between method invocation and rule to be used as a key for counters dictionary per rule
* Generates string of fields that match between method invocation and rule to
* be used as a key for counters dictionary per rule
* @param {object} rule Rule defined as identifierQuery in addRule
* @param {object} methodInvocation DDPCommon.MethodInvocation object with added 'method' attribute listing the method name
* @return {string} Key string made of all fields from rule that match in method invocation
* @param {object} methodInvocation DDPCommon.MethodInvocation object with
* added 'method' attribute listing the method name
* @return {string} Key string made of all fields from rule that match in
* method invocation
*/
RateLimiter.prototype._generateMethodInvocationKeyStringFromRuleMapping =
function( rule, methodInvocation ) {
@@ -182,10 +192,13 @@ RateLimiter.prototype._generateMethodInvocationKeyStringFromRuleMapping =
}
/**
* Helper method that uses the RATE_LIMITING_DICT to create a fast way to access values in methodInvocation without manually parsing the paths
* Helper method that uses the RATE_LIMITING_DICT to create a fast way to
* access values in methodInvocation without manually parsing the paths
* @param {string} key Key in rule dictionary (ie userId, IPAddr, method)
* @param {string} methodInvocation MethodInvocation object that is traversed to get the final value
* @return {object} Returns a string, value, or object of whatever is stored in appropriate field in MethodInvocation
* @param {string} methodInvocation MethodInvocation object that is traversed
* to get the final value
* @return {object} Returns a string, value, or object of whatever is stored in
* appropriate field in MethodInvocation
*/
RateLimiter.prototype._ruleMappingtoMethodInvocationDict = function( key,
methodInvocation ) {
@@ -196,4 +209,18 @@ RateLimiter.prototype._ruleMappingtoMethodInvocationDict = function( key,
methodInvocation = methodInvocation[ firstGuy ];
}
return methodInvocation;
};
};
RateLimiter.prototype._matchRuleHelper = function( rule, methodInvocation ) {
var self = this;
var methodString = self._generateMethodInvocationKeyStringFromRuleMapping(
rule, methodInvocation );
var timeSinceLastReset = new Date().getTime() - rule._lastResetTime;
var timeToNextReset = rule.intervalTime - timeSinceLastReset;
return {
methodString: methodString,
timeSinceLastReset: timeSinceLastReset,
timeToNextReset: timeToNextReset
};
}