fix: Filter API error handling and types

src/api/services/api-filter.service.ts

@@ -7,7 +7,6 @@ import { APIService } from './api.service';
 import AbortController from 'abort-controller';
 
 const handleFailover = (
-  userId: string,
   reason: string,
   configuration: Configuration,
   err?: Error
@@ -18,7 +17,6 @@ const handleFailover = (
   if (configuration.failoverStrategy === FailoverStrategy.throw) {
     throw err;
   }
-
   return {
     policy: {
       action: configuration.failoverStrategy,
@@ -52,9 +50,9 @@ export const APIFilterService = {
       );
     } catch (e) {
       if (isTimeoutError(e)) {
-        return handleFailover(options.user.id, 'timeout', configuration, e);
+        return handleFailover('timeout', configuration, e);
       } else if (e instanceof InternalServerError) {
-        return handleFailover(options.user.id, 'server error', configuration);
+        return handleFailover('server error', configuration, e);
       } else {
         throw e;
       }

src/payload/models/filter_payload.ts

@@ -13,4 +13,10 @@ export interface FilterPayload {
     ip: string;
     headers: IncomingHttpHeaders | { [key: string]: string | boolean };
   };
+  matching_user_id?: string;
+  params?: {
+    email?: string;
+    phone?: string;
+    username?: string;
+  }
 }

src/payload/models/risk_payload.ts

@@ -6,7 +6,7 @@ export interface RiskPayload {
   status: string;
   user: {
     id: string;
-    email: string;
+    email?: string;
     registered_at?: string;
     traits?: object;
     name?: string;

test/api/services/api-filter.service.test.ts

@@ -1,5 +1,6 @@
 import { APIFilterService } from '../../../src/api/api.module';
 import { Configuration } from '../../../src/configuraton';
+import { FailoverStrategy } from '../../../src/failover/models';
 import type { FilterPayload } from '../../../src/payload/payload.module';
 import MockDate from 'mockdate';
 import fetchMock from 'fetch-mock';
@@ -16,11 +17,8 @@ describe('APIFilterService', () => {
   const sampleRequestData: FilterPayload = {
     event: '$login',
     request_token: 'token',
-    status: '$succeeded',
-    user: {
-      id: 'userid',
-      email: 'myemail',
-    },
+    status: '$failed',
+    matching_user_id: 'userid',
     context: {
       ip: '8.8.8.8',
       headers: {},
@@ -38,7 +36,7 @@ describe('APIFilterService', () => {
       const config = new Configuration({
         apiSecret: 'test',
         overrideFetch: fetch,
-        logger: { info: () => {} },
+        logger: { info: () => { } },
       });
 
       const response = await (<any>(
@@ -58,7 +56,7 @@ describe('APIFilterService', () => {
       const config = new Configuration({
         apiSecret: 'test',
         overrideFetch: fetch,
-        logger: { info: () => {} },
+        logger: { info: () => { } },
       });
 
       const response = await APIFilterService.call(sampleRequestData, config);
@@ -82,7 +80,7 @@ describe('APIFilterService', () => {
       const config = new Configuration({
         apiSecret: 'test',
         overrideFetch: fetch,
-        logger: { info: () => {} },
+        logger: { info: () => { } },
       });
 
       const response = await (<any>(
@@ -97,5 +95,48 @@ describe('APIFilterService', () => {
       );
       expect(response.policy).toHaveProperty('name', 'Block Users from X');
     });
+
+    it('handles timeouts with failover strategy', async () => {
+      jest.useFakeTimers();
+      const fetch = fetchMock.sandbox().mock('*', {
+        action: 'deny',
+        device: {
+          token: 'device_token',
+        },
+        policy: {
+          id: 'q-rbeMzBTdW2Fd09sbz55A',
+          revision_id: 'pke4zqO2TnqVr-NHJOAHEg',
+          name: 'Block Users from X',
+        },
+      }, {
+        delay: 2000
+      });
+
+      const config = new Configuration({
+        apiSecret: 'test',
+        overrideFetch: fetch,
+        failoverStrategy: FailoverStrategy.allow,
+        timeout: 1000,
+        logger: { info: () => { } },
+      });
+
+      const filterCall = (<any>(
+        APIFilterService.call(sampleRequestData, config)
+      ));
+      jest.runAllTimers();
+
+      const response = await filterCall
+
+      expect(response).toEqual({
+        policy: {
+          action: 'allow',
+        },
+        action: 'allow',
+        failover: true,
+        failover_reason: 'timeout'
+      });
+
+      jest.useRealTimers();
+    });
   });
 });