feat(providers): feat(providers): add option to apply ratelimiting ov…

…er single API

Added an option to apply ratelimiting over single API

GH-46

README.md

@@ -27,17 +27,16 @@ For redis datasource, you have to pass the name of a loopback4 datasource
 ```ts
 this.bind(RateLimitSecurityBindings.CONFIG).to({
   name: 'redis',
-  type:'RedisStore'
+  type: 'RedisStore',
 });
 ```
 
-
 For memcache datasource
 
 ```ts
 this.bind(RateLimitSecurityBindings.CONFIG).to({
   client: memoryClient,
-  type:'MemcachedStore'
+  type: 'MemcachedStore',
 });
 ```
 
@@ -75,6 +74,25 @@ this.bind(RateLimitSecurityBindings.CONFIG).to({
 });
 ```
 
+## EnabledbyDefault
+
+enabledByDefault option in Config Binding will provide a configurable mode.
+When its enabled (default value is true),it will provide a way to
+ratelimit all API's except a few that are disabled using a decorator.
+
+To disable ratelimiting for all APIs except those that are enabled using the decorator,
+you can set its value to false in config binding option.
+
+```
+this.bind(RateLimitSecurityBindings.CONFIG).to({
+  name: 'redis',
+  type: 'RedisStore',
+  max: 60,
+  keyGenerator: rateLimitKeyGen,
+  enabledByDefault:false
+});
+```
+
 - The component exposes a sequence action which can be added to your server sequence class. Adding this will trigger ratelimiter middleware for all the requests passing through.
 
 ```ts

src/providers/ratelimit-action.provider.ts

@@ -24,6 +24,7 @@ export class RatelimitActionProvider implements Provider<RateLimitAction> {
   }
 
   async action(request: Request, response: Response): Promise<void> {
+    const enabledByDefault = this.config?.enabledByDefault ?? true;
     const metadata: RateLimitMetadata = await this.getMetadata();
     const dataStore = await this.getDatastore();
     if (metadata && !metadata.enabled) {
@@ -54,6 +55,12 @@ export class RatelimitActionProvider implements Provider<RateLimitAction> {
         resolve();
       });
     });
-    await promise;
+    if (enabledByDefault === true) {
+      await promise;
+    } else if (enabledByDefault === false && metadata && metadata.enabled) {
+      await promise;
+    } else {
+      return Promise.resolve();
+    }
   }
 }

src/types.ts

@@ -15,12 +15,16 @@ export interface DataSourceConfig {
   uri?: string;
   collectionName?: string;
 }
-
+export interface RateLimitConfig {
+  enabledByDefault?: boolean;
+}
 export interface RateLimitAction {
   (request: Request, response: Response): Promise<void>;
 }
 
-export type RateLimitOptions = Writable<Partial<Options>> & DataSourceConfig;
+export type RateLimitOptions = Writable<Partial<Options>> &
+  DataSourceConfig &
+  RateLimitConfig;
 
 /**
  * Rate limit metadata interface for the method decorator