feat: add new stat for access token expired in fb custom audience

package.json

@@ -64,7 +64,7 @@
     "@koa/router": "^12.0.0",
     "@ndhoule/extend": "^2.0.0",
     "@pyroscope/nodejs": "^0.2.6",
-    "@rudderstack/integrations-lib": "^0.1.8",
+    "@rudderstack/integrations-lib": "^0.2.1",
     "@rudderstack/workflow-engine": "^0.6.9",
     "ajv": "^8.12.0",
     "ajv-draft-04": "^1.0.0",

src/util/error-extractor/index.ts

@@ -1,14 +1,17 @@
 /* eslint-disable max-classes-per-file */
-import { MessageDetails, StatusCode } from "./types";
+import { MessageDetails, StatusCode, Stat } from "./types";
 
 export class ErrorDetailsExtractor {
   status: StatusCode;
 
   messageDetails: MessageDetails;
 
+  stat : Stat
+
   constructor (builder: ErrorDetailsExtractorBuilder) {
     this.status = builder.getStatus();
     this.messageDetails = builder.getMessageDetails();
+    this.stat = builder.getStat();
   }
 
 }
@@ -18,16 +21,23 @@ export class ErrorDetailsExtractorBuilder {
 
   messageDetails: MessageDetails;
 
+  stat: Stat;
   constructor() {
     this.status = 0;
     this.messageDetails = {};
+    this.stat = {};
   }
 
   setStatus(status: number): ErrorDetailsExtractorBuilder {
     this.status = status;
     return this;
   }
 
+  setStat(stat: Record<string, string>): ErrorDetailsExtractorBuilder {
+    this.stat = stat
+    return this;
+  }
+
   /**
    * This means we need to set a message from a specific field that we see from the destination's response
    * 
@@ -69,6 +79,10 @@ export class ErrorDetailsExtractorBuilder {
   getStatus(): number {
     return this.status;
   }
+
+  getStat(): Record<string, string> {
+    return this.stat;
+  }
 
   getMessageDetails(): Record<string, string> {
     return this.messageDetails;

src/util/error-extractor/types.ts

@@ -1,2 +1,3 @@
 export type MessageDetails = Record<string, string>;
-export type StatusCode = number;
+export type StatusCode = number;
+export type Stat =  Record<string, string>

src/v0/util/facebookUtils/networkHandler.js

@@ -1,6 +1,10 @@
 const { isEmpty } = require('lodash');
 const get = require('get-value');
-const { NetworkError } = require('@rudderstack/integrations-lib');
+const {
+  NetworkError,
+  ConfigurationAuthError,
+  isDefinedAndNotNull,
+} = require('@rudderstack/integrations-lib');
 const {
   processAxiosResponse,
   getDynamicErrorType,
@@ -100,12 +104,18 @@
   190: {
     460: new ErrorDetailsExtractorBuilder()
       .setStatus(400)
+      .setStat({
+        [tags.TAG_NAMES.ERROR_TYPE]: tags.ERROR_TYPES.ACCESS_TOKEN_EXPIRED,
+      })
       .setMessage(
         'The session has been invalidated because the user changed their password or Facebook has changed the session for security reasons',
       )
       .build(),
     default: new ErrorDetailsExtractorBuilder()
       .setStatus(400)
+      .setStat({
+        [tags.TAG_NAMES.ERROR_TYPE]: tags.ERROR_TYPES.UNAUTHORIZED,
+      })
       .setMessage('Invalid OAuth 2.0 access token')
       .build(),
   },
@@ -211,13 +221,14 @@
 
 const getStatus = (error) => {
   const errorDetail = getErrorDetailsFromErrorMap(error);
+  console.log(errorDetail);
   let errorStatus = 500;
   const isErrorDetailEmpty = isEmpty(errorDetail);
   if (isErrorDetailEmpty) {
     // Unhandled error response
     return {
       status: errorStatus,
-      tags: { [tags.TAG_NAMES.META]: tags.METADATA.UNHANDLED_STATUS_CODE },
+      stats: { [tags.TAG_NAMES.META]: tags.METADATA.UNHANDLED_STATUS_CODE },
     };
   }
   errorStatus = errorDetail.status;
@@ -227,7 +238,9 @@
     errorMessage = get(error, errorDetail?.messageDetails?.field);
   }
 
-  return { status: errorStatus, errorMessage };
+  const stats = errorDetail?.stat;
+
+  return { status: errorStatus, errorMessage, stats };
 };
 
 const errorResponseHandler = (destResponse) => {
@@ -237,7 +250,10 @@
     return;
   }
   const { error } = response;
-  const { status, errorMessage, tags: errorStatTags } = getStatus(error);
+  const { status, errorMessage, stats: errorStatTags } = getStatus(error);
+  if (isDefinedAndNotNull(errorStatTags) && errorStatTags?.errorType === 'accessTokenExpired') {
+    throw new ConfigurationAuthError(`${errorMessage}`);
+  }
   throw new NetworkError(
     `${errorMessage || error.message || 'Unknown failure during response transformation'}`,
     status,

src/v0/util/tags.js

@@ -52,6 +52,7 @@ const ERROR_TYPES = {
   UNSUPPORTED: 'unsupported',
   REDIS: 'redis',
   FILTERED: 'filtered',
+  UNAUTHORIZED: 'accessTokenExpired',
 };
 
 const METADATA = {

test/integrations/destinations/facebook_pixel/dataDelivery/data.ts

@@ -41,21 +41,14 @@ export const data = [
           output: {
             status: 400,
             message: 'Invalid OAuth 2.0 access token',
-            destinationResponse: {
-              error: {
-                message: 'The access token could not be decrypted',
-                type: 'OAuthException',
-                code: 190,
-                fbtrace_id: 'fbpixel_trace_id',
-              },
-              status: 500,
-            },
+            destinationResponse: '',
             statTags: {
               destType: 'FACEBOOK_PIXEL',
-              errorCategory: 'network',
+              errorCategory: 'dataValidation',
               destinationId: 'Non-determininable',
               workspaceId: 'Non-determininable',
-              errorType: 'aborted',
+              errorType: 'configuration',
+              meta: 'accessTokenExpired',
               feature: 'dataDelivery',
               implementation: 'native',
               module: 'destination',

test/integrations/destinations/fb/dataDelivery/data.ts

@@ -55,21 +55,14 @@ export const data = [
           output: {
             status: 400,
             message: 'Invalid OAuth 2.0 access token',
-            destinationResponse: {
-              error: {
-                message: 'The access token could not be decrypted',
-                type: 'OAuthException',
-                code: 190,
-                fbtrace_id: 'fbpixel_trace_id',
-              },
-              status: 500,
-            },
+            destinationResponse: '',
             statTags: {
               destType: 'FB',
-              errorCategory: 'network',
+              errorCategory: 'dataValidation',
               destinationId: 'Non-determininable',
               workspaceId: 'Non-determininable',
-              errorType: 'aborted',
+              errorType: 'configuration',
+              meta: 'accessTokenExpired',
               feature: 'dataDelivery',
               implementation: 'native',
               module: 'destination',

test/integrations/destinations/fb_custom_audience/dataDelivery/data.ts

@@ -572,4 +572,65 @@ export const data = [
       },
     },
   },
+  {
+    name: 'fb_custom_audience',
+    description: 'user addition failed due expired access token error',
+    feature: 'dataDelivery',
+    module: 'destination',
+    version: 'v0',
+    input: {
+      request: {
+        body: {
+          version: '1',
+          type: 'REST',
+          method: 'DELETE',
+          endpoint: getEndPoint('aud1'),
+          headers: {
+            'test-dest-response-key': 'accessTokenInvalidError',
+          },
+          params: {
+            access_token: 'ABC',
+            payload: {
+              is_raw: true,
+              data_source: {
+                sub_type: 'ANYTHING',
+              },
+              schema: ['DOBY', 'PHONE', 'GEN', 'FI', 'MADID', 'ZIP', 'ST', 'COUNTRY'],
+              data: [['2013', '@09432457768', 'f', 'Ms.', 'ABC', 'ZIP ', '123abc ', 'IN']],
+            },
+          },
+          body: {
+            JSON: {},
+            XML: {},
+            JSON_ARRAY: {},
+            FORM: {},
+          },
+          files: {},
+        },
+      },
+    },
+    output: {
+      response: {
+        status: 400,
+        body: {
+          output: {
+            destinationResponse: '',
+            message: 'Invalid OAuth 2.0 access token',
+            statTags: {
+              destType: 'FB_CUSTOM_AUDIENCE',
+              destinationId: 'Non-determininable',
+              errorCategory: 'dataValidation',
+              errorType: 'configuration',
+              meta: 'accessTokenExpired',
+              feature: 'dataDelivery',
+              implementation: 'native',
+              module: 'destination',
+              workspaceId: 'Non-determininable',
+            },
+            status: 400,
+          },
+        },
+      },
+    },
+  },
 ];

test/integrations/destinations/fb_custom_audience/network.ts

@@ -480,4 +480,46 @@ export const networkCallsData = [
       status: 403,
     },
   },
+  {
+    httpReq: {
+      version: '1',
+      type: 'REST',
+      method: 'DELETE',
+      endpoint: getEndPoint('aud1'),
+      headers: {
+        'test-dest-response-key': 'accessTokenInvalidError',
+      },
+      params: {
+        access_token: 'ABC',
+        payload: {
+          is_raw: true,
+          data_source: {
+            sub_type: 'ANYTHING',
+          },
+          schema: ['DOBY', 'PHONE', 'GEN', 'FI', 'MADID', 'ZIP', 'ST', 'COUNTRY'],
+          data: [['2013', '@09432457768', 'f', 'Ms.', 'ABC', 'ZIP ', '123abc ', 'IN']],
+        },
+      },
+      userId: '',
+      body: {
+        JSON: {},
+        XML: {},
+        JSON_ARRAY: {},
+        FORM: {},
+      },
+      files: {},
+    },
+    httpRes: {
+      data: {
+        error: {
+          message: 'Error validating access token: Session has expired on Tuesday, 01-Aug-23 10:12:14 PDT. The current time is Sunday, 28-Jan-24 16:01:17 PST.',
+          type: 'OAuthException',
+          code: 190,
+          error_subcode: 463,
+          fbtrace_id: 'A3b8C6PpI-kdIOwPwV4PANi'
+        },
+      },
+      status: 400,
+    },
+  }
 ];