add updatedAt to compliance v2 responses (#1360) (#1480)

(cherry picked from commit 4bc8bf7) Co-authored-by: dydxwill <119354122+dydxwill@users.noreply.github.com>
dydxprotocol · May 8, 2024 · e3f83bd · e3f83bd
1 parent 93b262a
commit e3f83bd
Show file tree

Hide file tree

Showing 5 changed files with 26 additions and 8 deletions.
diff --git a/indexer/services/comlink/__tests__/controllers/api/v4/compliance-v2-controller.test.ts b/indexer/services/comlink/__tests__/controllers/api/v4/compliance-v2-controller.test.ts
@@ -117,6 +117,7 @@ describe('ComplianceV2Controller', () => {
         });
         expect(response.body.status).toEqual(ComplianceStatus.BLOCKED);
         expect(response.body.reason).toEqual(ComplianceReason.COMPLIANCE_PROVIDER);
+        expect(response.body.updatedAt).toBeDefined();
         data = await ComplianceStatusTable.findAll({}, [], {});
         expect(data).toHaveLength(1);
         expect(data[0]).toEqual(expect.objectContaining({
@@ -147,6 +148,7 @@ describe('ComplianceV2Controller', () => {
         });
         expect(response.body.status).toEqual(ComplianceStatus.CLOSE_ONLY);
         expect(response.body.reason).toEqual(ComplianceReason.COMPLIANCE_PROVIDER);
+        expect(response.body.updatedAt).toBeDefined();
         data = await ComplianceStatusTable.findAll({}, [], {});
         expect(data).toHaveLength(1);
         expect(data[0]).toEqual(expect.objectContaining({
@@ -360,6 +362,7 @@ describe('ComplianceV2Controller', () => {
 
       expect(response.body.status).toEqual(ComplianceStatus.BLOCKED);
       expect(response.body.reason).toEqual(ComplianceReason.US_GEO);
+      expect(response.body.updatedAt).toBeDefined();
     });
 
     it('should set status to FIRST_STRIKE for CONNECT action from a restricted country with no existing compliance status', async () => {
@@ -387,6 +390,7 @@ describe('ComplianceV2Controller', () => {
 
       expect(response.body.status).toEqual(ComplianceStatus.FIRST_STRIKE);
       expect(response.body.reason).toEqual(ComplianceReason.US_GEO);
+      expect(response.body.updatedAt).toBeDefined();
     });
 
     it('should set status to COMPLIANT for any action from a non-restricted country with no existing compliance status', async () => {
@@ -439,6 +443,7 @@ describe('ComplianceV2Controller', () => {
 
       expect(response.body.status).toEqual(ComplianceStatus.FIRST_STRIKE);
       expect(response.body.reason).toEqual(ComplianceReason.US_GEO);
+      expect(response.body.updatedAt).toBeDefined();
     });
 
     it('should be a no-op for ONBOARD action with existing COMPLIANT status', async () => {
@@ -502,6 +507,7 @@ describe('ComplianceV2Controller', () => {
       }));
       expect(response.body.status).toEqual(ComplianceStatus.FIRST_STRIKE);
       expect(response.body.reason).toEqual(ComplianceReason.US_GEO);
+      expect(response.body.updatedAt).toBeDefined();
     });
 
     it('should update status to CLOSE_ONLY for CONNECT action from a restricted country with existing FIRST_STRIKE status', async () => {
@@ -534,6 +540,7 @@ describe('ComplianceV2Controller', () => {
 
       expect(response.body.status).toEqual(ComplianceStatus.CLOSE_ONLY);
       expect(response.body.reason).toEqual(ComplianceReason.US_GEO);
+      expect(response.body.updatedAt).toBeDefined();
     });
   });
 });
diff --git a/indexer/services/comlink/public/api-documentation.md b/indexer/services/comlink/public/api-documentation.md
@@ -704,7 +704,8 @@ fetch('https://dydx-testnet.imperator.co/v4/compliance/screen/{address}',
 ```json
 {
   "status": "COMPLIANT",
-  "reason": "MANUAL"
+  "reason": "MANUAL",
+  "updatedAt": "string"
 }
 ```
 
@@ -3281,7 +3282,8 @@ This operation does not require authentication
 ```json
 {
   "status": "COMPLIANT",
-  "reason": "MANUAL"
+  "reason": "MANUAL",
+  "updatedAt": "string"
 }
 
 ```
@@ -3292,6 +3294,7 @@ This operation does not require authentication
 |---|---|---|---|---|
 |status|[ComplianceStatus](#schemacompliancestatus)|true|none|none|
 |reason|[ComplianceReason](#schemacompliancereason)|false|none|none|
+|updatedAt|string|false|none|none|
 
 ## OrderSide
 

diff --git a/indexer/services/comlink/public/swagger.json b/indexer/services/comlink/public/swagger.json
@@ -372,6 +372,9 @@
           },
           "reason": {
             "$ref": "#/components/schemas/ComplianceReason"
+          },
+          "updatedAt": {
+            "type": "string"
           }
         },
         "required": [

diff --git a/indexer/services/comlink/src/controllers/api/v4/compliance-v2-controller.ts b/indexer/services/comlink/src/controllers/api/v4/compliance-v2-controller.ts
@@ -82,24 +82,26 @@ class ComplianceV2Controller extends Controller {
           [],
         );
         let complianceStatusFromDatabase: ComplianceStatusFromDatabase | undefined;
+        const updatedAt: string = DateTime.utc().toISO();
         if (complianceStatus.length === 0) {
           complianceStatusFromDatabase = await ComplianceStatusTable.upsert({
             address,
             status: ComplianceStatus.BLOCKED,
             reason: ComplianceReason.COMPLIANCE_PROVIDER,
-            updatedAt: DateTime.utc().toISO(),
+            updatedAt,
           });
         } else {
           complianceStatusFromDatabase = await ComplianceStatusTable.update({
             address,
             status: ComplianceStatus.CLOSE_ONLY,
             reason: ComplianceReason.COMPLIANCE_PROVIDER,
-            updatedAt: DateTime.utc().toISO(),
+            updatedAt,
           });
         }
         return {
           status: complianceStatusFromDatabase!.status,
           reason: complianceStatusFromDatabase!.reason,
+          updatedAt,
         };
       } else {
         return {
@@ -255,28 +257,29 @@ router.post(
         [],
       );
       let complianceStatusFromDatabase: ComplianceStatusFromDatabase | undefined;
+      const updatedAt: string = DateTime.utc().toISO();
       if (complianceStatus.length === 0) {
         if (isRestrictedCountryHeaders(req.headers as CountryHeaders)) {
           if (action === ComplianceAction.ONBOARD) {
             complianceStatusFromDatabase = await ComplianceStatusTable.upsert({
               address,
               status: ComplianceStatus.BLOCKED,
               reason: getGeoComplianceReason(req.headers as CountryHeaders)!,
-              updatedAt: DateTime.utc().toISO(),
+              updatedAt,
             });
           } else if (action === ComplianceAction.CONNECT) {
             complianceStatusFromDatabase = await ComplianceStatusTable.upsert({
               address,
               status: ComplianceStatus.FIRST_STRIKE,
               reason: getGeoComplianceReason(req.headers as CountryHeaders)!,
-              updatedAt: DateTime.utc().toISO(),
+              updatedAt,
             });
           }
         } else {
           complianceStatusFromDatabase = await ComplianceStatusTable.upsert({
             address,
             status: ComplianceStatus.COMPLIANT,
-            updatedAt: DateTime.utc().toISO(),
+            updatedAt,
           });
         }
       } else {
@@ -301,14 +304,15 @@ router.post(
               address,
               status: COMPLIANCE_PROGRESSION[complianceStatus[0].status],
               reason: getGeoComplianceReason(req.headers as CountryHeaders)!,
-              updatedAt: DateTime.utc().toISO(),
+              updatedAt,
             });
           }
         }
       }
       const response = {
         status: complianceStatusFromDatabase!.status,
         reason: complianceStatusFromDatabase!.reason,
+        updatedAt,
       };
 
       return res.send(response);

diff --git a/indexer/services/comlink/src/types.ts b/indexer/services/comlink/src/types.ts
@@ -484,6 +484,7 @@ export enum BlockedCode {
 export interface ComplianceV2Response {
   status: ComplianceStatus;
   reason?: ComplianceReason;
+  updatedAt?: string;
 }
 
 /* ------- HISTORICAL TRADING REWARD TYPES ------- */