Tests for maybeUpdatePhishingList

Signed-off-by: Akintayo A. Olusegun <akintayo.segun@gmail.com>
MetaMask · Nov 23, 2022 · 96cc0ca · 96cc0ca
1 parent 763aab7
commit 96cc0ca
Show file tree

Hide file tree

Showing 2 changed files with 52 additions and 2 deletions.
diff --git a/packages/phishing-controller/src/PhishingController.test.ts b/packages/phishing-controller/src/PhishingController.test.ts
@@ -69,6 +69,56 @@ describe('PhishingController', () => {
     expect(nockScope.isDone()).toBe(false);
   });
 
+  describe('maybeUpdatePhishingLists', () => {
+    it('should not be out of date immediately after maybeUpdatePhishingLists is called', async () => {
+      const clock = sinon.useFakeTimers();
+      const controller = new PhishingController({ refreshInterval: 10 });
+      clock.tick(10);
+      expect(controller.isOutOfDate()).toBe(true);
+      await controller.maybeUpdatePhishingLists();
+      expect(controller.isOutOfDate()).toBe(false);
+    });
+
+    it('should not be out of date after maybeUpdatePhishingLists is called but before refresh interval has passed', async () => {
+      const clock = sinon.useFakeTimers();
+      const controller = new PhishingController({ refreshInterval: 10 });
+      clock.tick(10);
+      expect(controller.isOutOfDate()).toBe(true);
+      await controller.maybeUpdatePhishingLists();
+      clock.tick(5);
+      expect(controller.isOutOfDate()).toBe(false);
+    });
+
+    it('should still be out of date while update is in progress', async () => {
+      const clock = sinon.useFakeTimers();
+      const controller = new PhishingController({ refreshInterval: 10 });
+      clock.tick(10);
+      await controller.maybeUpdatePhishingLists();
+      expect(controller.isOutOfDate()).toBe(false);
+      clock.tick(10);
+      expect(controller.isOutOfDate()).toBe(true);
+      // do not wait
+      controller.maybeUpdatePhishingLists();
+      expect(controller.isOutOfDate()).toBe(true);
+      await controller.maybeUpdatePhishingLists();
+      expect(controller.isOutOfDate()).toBe(false);
+      clock.tick(10);
+      expect(controller.isOutOfDate()).toBe(true);
+    });
+
+    it('should not call update if it is out of date', async () => {
+      const clock = sinon.useFakeTimers();
+      const controller = new PhishingController({ refreshInterval: 10 });
+      const updateSpy = sinon.spy(controller, 'updatePhishingLists');
+      expect(controller.isOutOfDate()).toBe(false);
+      await controller.maybeUpdatePhishingLists();
+      expect(updateSpy.calledOnce).toBe(false);
+      clock.tick(10);
+      await controller.maybeUpdatePhishingLists();
+      expect(updateSpy.calledOnce).toBe(true);
+    });
+  });
+
   describe('isOutOfDate', () => {
     it('should not be out of date upon construction', () => {
       sinon.useFakeTimers();

diff --git a/packages/phishing-controller/src/PhishingController.ts b/packages/phishing-controller/src/PhishingController.ts
@@ -216,10 +216,10 @@ export class PhishingController extends BaseController<
     }
   }
 
-  maybeUpdatePhishingLists() {
+  async maybeUpdatePhishingLists() {
     const phishingListsAreOutOfDate = this.isOutOfDate();
     if (phishingListsAreOutOfDate) {
-      this.updatePhishingLists();
+      await this.updatePhishingLists();
     }
   }