Merge pull request #17201 from overleaf/dp-ip-rate-limit

Add subnet rate limiter for login rate limit GitOrigin-RevId: c9f68829887dbc1778eff3b465dbde40bc2073d8
2024-02-29 09:04:15 +00:00
parent 3c98e028f5
commit 6d99f6dfae
2 changed files with 106 additions and 3 deletions
@@ -0,0 +1,63 @@
+const SandboxedModule = require('sandboxed-module')
+const sinon = require('sinon')
+const { expect } = require('chai')
+const modulePath = require('path').join(
+  __dirname,
+  '../../../../app/src/infrastructure/RateLimiter'
+)
+
+describe('RateLimiter', function () {
+  beforeEach(function () {
+    this.rclient = {}
+    this.RedisWrapper = {
+      client: sinon.stub().returns(this.rclient),
+    }
+    this.RateLimiter = {
+      RateLimiter: sinon.stub().withArgs('login').returns(this.rateLimiter),
+    }
+
+    this.RateLimiterFlexible = {
+      RateLimiterRedis: sinon.stub(),
+    }
+
+    this.RateLimiter = SandboxedModule.require(modulePath, {
+      requires: {
+        './RedisWrapper': this.RedisWrapper,
+        'rate-limiter-flexible': this.RateLimiterFlexible,
+      },
+    })
+  })
+
+  describe('getSubnetKeyFromIp', function () {
+    beforeEach(function () {
+      this.rateLimiter = new this.RateLimiter.RateLimiter('some-limit', {
+        points: 20,
+        subnetPoints: 200,
+        duration: 60,
+      })
+    })
+
+    it('should correctly extract a subnet key from an ip address', function () {
+      expect(this.rateLimiter.getSubnetKeyFromIp('255.255.255.255')).to.equal(
+        '255.255.255'
+      )
+      expect(this.rateLimiter.getSubnetKeyFromIp('127.0.0.1')).to.equal(
+        '127.0.0'
+      )
+      expect(this.rateLimiter.getSubnetKeyFromIp('243.12.3.126')).to.equal(
+        '243.12.3'
+      )
+    })
+
+    it('should throw an error when given an incorrectly formatted ip', function () {
+      expect(() => this.rateLimiter.getSubnetKeyFromIp(1)).to.throw()
+      expect(() => this.rateLimiter.getSubnetKeyFromIp('Not an ip')).to.throw()
+      expect(() =>
+        this.rateLimiter.getSubnetKeyFromIp('255.255.255.255.255.255')
+      ).to.throw()
+      expect(() =>
+        this.rateLimiter.getSubnetKeyFromIp('255.255.255')
+      ).to.throw()
+    })
+  })
+})