Merge pull request #18887 from mozilla/gql-rate-limit-support

task(graphql): Support using new rate-limitting library for customs in graphql-api

Author: dschom

libs/accounts/rate-limit/jest.config.ts

@@ -8,4 +8,14 @@ export default {
   },
   moduleFileExtensions: ['ts', 'js', 'html'],
   coverageDirectory: '../../../coverage/libs/accounts/rate-limit',
+  reporters: [
+    'default',
+    [
+      'jest-junit',
+      {
+        outputDirectory: 'artifacts/tests/lib/accounts/rate-limit',
+        outputName: 'nestjs-customs-jest-unit-results.xml',
+      },
+    ],
+  ],
 };

libs/accounts/rate-limit/package.json

@@ -4,5 +4,6 @@
   "dependencies": {},
   "type": "commonjs",
   "main": "./index.cjs",
+  "types": "./index.d.ts",
   "private": true
 }

libs/accounts/rate-limit/src/index.ts

@@ -3,6 +3,7 @@
  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
 
 export * from './lib/rate-limit';
+export * from './lib/rate-limit.provider';
 export * from './lib/config';
 export * from './lib/error';
 export * from './lib/models';

libs/accounts/rate-limit/src/lib/config.ts

@@ -11,6 +11,15 @@ export class RateLimitConfig {
   @IsString()
   @IsArray()
   rules!: Array<string> | string;
+
+  @IsArray()
+  ignoreIPs!: Array<string>;
+
+  @IsArray()
+  ignoreEmails!: Array<string>;
+
+  @IsArray()
+  ignoreUIDs!: Array<string>;
 }
 
 /**

libs/accounts/rate-limit/src/lib/rate-limit.provider.spec.ts

@@ -0,0 +1,65 @@
+/* This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
+
+import { Test, TestingModule } from '@nestjs/testing';
+import { ConfigService } from '@nestjs/config';
+import {
+  RateLimitClient,
+  RateLimitProvider,
+  RateLimitRedisClient,
+} from './rate-limit.provider';
+import { RateLimit } from './rate-limit';
+import { StatsDService } from '../../../../shared/metrics/statsd/src';
+
+const mockStatsd = jest.fn();
+jest.mock('hot-shots', () => {
+  return {
+    StatsD: function (...args: any) {
+      return mockStatsd(...args);
+    },
+  };
+});
+
+describe('RateLimitProvider', () => {
+  let rateLimit: RateLimit;
+
+  const mockConfig = {
+    rules: ['test : ip : 1 : 1 second : 1 second '],
+  };
+  const mockConfigService = {
+    get: jest.fn().mockImplementation((key: string) => {
+      if (key === 'rateLimit') {
+        return mockConfig;
+      }
+      return null;
+    }),
+  };
+
+  beforeEach(async () => {
+    jest.clearAllMocks();
+    const module: TestingModule = await Test.createTestingModule({
+      providers: [
+        RateLimitProvider,
+        {
+          provide: ConfigService,
+          useValue: mockConfigService,
+        },
+        {
+          provide: RateLimitRedisClient,
+          useValue: {},
+        },
+        {
+          provide: StatsDService,
+          useValue: {},
+        },
+      ],
+    }).compile();
+
+    rateLimit = await module.resolve<RateLimit>(RateLimitClient);
+  });
+
+  it('should provide statsd', async () => {
+    expect(rateLimit).toBeDefined();
+  });
+});

libs/accounts/rate-limit/src/lib/rate-limit.provider.ts

@@ -0,0 +1,57 @@
+/* This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
+
+import { ConfigService } from '@nestjs/config';
+import { parseConfigRules, RateLimitConfig } from './config';
+import { RateLimit } from './rate-limit';
+import Redis, { RedisOptions } from 'ioredis';
+import { StatsD, StatsDService } from '@fxa/shared/metrics/statsd';
+import { Provider } from '@nestjs/common';
+
+export const RateLimitRedisClient = Symbol('RATE_LIMIT__REDIS_CLIENT');
+
+export const RateLimitRedisProvider: Provider = {
+  provide: RateLimitRedisClient,
+  useFactory: (config: ConfigService) => {
+    const redisConfig = config.get<RedisOptions>('redis');
+    if (redisConfig == null) {
+      throw new Error('Missing config for redis');
+    }
+
+    const redisRateLimitConfig = config.get<RedisOptions>('redis.customs');
+    if (redisRateLimitConfig == null) {
+      throw new Error('Missing config for redis.customs');
+    }
+
+    return new Redis({
+      ...redisConfig,
+      ...redisRateLimitConfig,
+    });
+  },
+  inject: [ConfigService],
+};
+
+export const RateLimitClient = Symbol('RATE_LIMIT_CLIENT');
+export const RateLimitProvider = {
+  provide: RateLimitClient,
+  useFactory: (config: ConfigService, redis: Redis.Redis, statsd: StatsD) => {
+    const rateLimitConfig = config.get<RateLimitConfig>('rateLimit');
+    if (rateLimitConfig == null) {
+      throw new Error('Missing rateLimit config');
+    }
+
+    const rules = parseConfigRules(rateLimitConfig.rules);
+    return new RateLimit(
+      {
+        rules,
+        ignoreEmails: rateLimitConfig.ignoreEmails,
+        ignoreIPs: rateLimitConfig.ignoreIPs,
+        ignoreUIDs: rateLimitConfig.ignoreUIDs,
+      },
+      redis,
+      statsd
+    );
+  },
+  inject: [ConfigService, RateLimitRedisClient, StatsDService],
+};

libs/shared/nestjs/customs/.eslintrc.json

@@ -0,0 +1,18 @@
+{
+  "extends": ["../../../../.eslintrc.json"],
+  "ignorePatterns": ["!**/*"],
+  "overrides": [
+    {
+      "files": ["*.ts", "*.tsx", "*.js", "*.jsx"],
+      "rules": {}
+    },
+    {
+      "files": ["*.ts", "*.tsx"],
+      "rules": {}
+    },
+    {
+      "files": ["*.js", "*.jsx"],
+      "rules": {}
+    }
+  ]
+}

libs/shared/nestjs/customs/README.md

@@ -0,0 +1,12 @@
+# Customs
+
+This library supports adding customs (i.e. rate-limiting) as a nestjs service. It was initially designed to work with
+FxA's graphql-api, but could be repurposed to work else where.
+
+## Building
+
+Run `nx build customs` to build the library.
+
+## Running unit tests
+
+Run `nx test-unit customs` to execute the unit tests via [Jest](https://jestjs.io).

libs/shared/nestjs/customs/jest.config.ts

@@ -0,0 +1,25 @@
+import { Config } from 'jest';
+
+/* eslint-disable */
+const config: Config = {
+  displayName: 'shared-nestjs-customs',
+  preset: '../../../../jest.preset.js',
+  testEnvironment: 'node',
+  transform: {
+    '^.+\\.[tj]s$': ['ts-jest', { tsconfig: '<rootDir>/tsconfig.spec.json' }],
+  },
+  moduleFileExtensions: ['ts', 'js', 'html'],
+  coverageDirectory: '../../../../coverage/libs/nestjs/customs',
+  reporters: [
+    'default',
+    [
+      'jest-junit',
+      {
+        outputDirectory: 'artifacts/tests/lib/shared/nestjs/customs',
+        outputName: 'nestjs-customs-jest-unit-results.xml',
+      },
+    ],
+  ],
+};
+
+export default config;

libs/shared/nestjs/customs/package.json

@@ -0,0 +1,9 @@
+{
+  "name": "@fxa/shared/nestjs/customs",
+  "version": "0.0.1",
+  "private": true,
+  "type": "commonjs",
+  "main": "./index.cjs",
+  "types": "./index.d.ts",
+  "dependencies": {}
+}