Merge pull request #708 from ueokande/sync-storage

Synchronize settings with Firefox Sync

1 files changed, 161 insertions, 0 deletions

diff --git a/test/background/usecases/SettingUseCase.test.ts b/test/background/usecases/SettingUseCase.test.ts
new file mode 100644
index 0000000..bfa599c
--- /dev/null
+++ b/test/background/usecases/SettingUseCase.test.ts
@@ -0,0 +1,161 @@
+import "reflect-metadata";
+import SettingUseCase from "../../../src/background/usecases/SettingUseCase";
+import SettingRepository from "../../../src/background/repositories/SettingRepository";
+import SettingData, {JSONTextSettings} from "../../../src/shared/SettingData";
+import CachedSettingRepository from "../../../src/background/repositories/CachedSettingRepository";
+import Settings, {DefaultSetting} from "../../../src/shared/settings/Settings";
+import Notifier from "../../../src/background/presenters/Notifier";
+import {expect} from "chai";
+import Properties from "../../../src/shared/settings/Properties";
+import sinon from 'sinon';
+
+class MockSettingRepository implements SettingRepository {
+  load(): Promise<SettingData | null> {
+    throw new Error("not implemented");
+  }
+
+  onChange(_: () => void): void {
+  }
+}
+
+class MockCachedSettingRepository implements CachedSettingRepository {
+  private current: Settings = DefaultSetting;
+
+  get(): Promise<Settings> {
+    return Promise.resolve(this.current);
+  }
+
+  setProperty(name: string, value: string | number | boolean): Promise<void> {
+    (this.current.properties as any)[name] = value;
+    return Promise.resolve();
+  }
+
+  update(value: Settings): Promise<void> {
+    this.current = value;
+    return Promise.resolve();
+  }
+}
+
+class NopNotifier implements Notifier {
+  notifyInvalidSettings(_onclick: () => void): Promise<void> {
+    return Promise.resolve();
+  }
+
+  notifyUpdated(_version: string, _onclick: () => void): Promise<void> {
+    return Promise.resolve();
+  }
+}
+
+describe('SettingUseCase', () => {
+  let localSettingRepository : SettingRepository;
+  let syncSettingRepository : SettingRepository;
+  let cachedSettingRepository : CachedSettingRepository;
+  let notifier: Notifier;
+  let sut : SettingUseCase;
+
+  beforeEach(() => {
+    localSettingRepository = new MockSettingRepository();
+    syncSettingRepository = new MockSettingRepository();
+    cachedSettingRepository = new MockCachedSettingRepository();
+    notifier = new NopNotifier();
+    sut = new SettingUseCase(
+      localSettingRepository,
+      syncSettingRepository,
+      cachedSettingRepository,
+      notifier
+    );
+  });
+
+  describe('getCached', () => {
+    it("returns cached settings", async () => {
+      const settings = new Settings({
+        keymaps: DefaultSetting.keymaps,
+        search: DefaultSetting.search,
+        blacklist: DefaultSetting.blacklist,
+        properties: new Properties({
+          hintchars: "abcd1234"
+        }),
+      });
+      sinon.stub(cachedSettingRepository, "get")
+        .returns(Promise.resolve(settings));
+
+      const got = await sut.getCached();
+      expect(got.properties.hintchars).to.equal("abcd1234");
+
+    });
+  });
+
+  describe("reload", () => {
+    context("when sync is not set", () => {
+      it("loads settings from local storage", async() => {
+        const settings = new Settings({
+          keymaps: DefaultSetting.keymaps,
+          search: DefaultSetting.search,
+          blacklist: DefaultSetting.blacklist,
+          properties: new Properties({
+            hintchars: "abcd1234"
+          }),
+        });
+        const settingData = SettingData.fromJSON({
+          source: "json",
+          json: JSONTextSettings.fromSettings(settings).toJSONText(),
+        });
+
+        sinon.stub(syncSettingRepository, "load")
+          .returns(Promise.resolve(null));
+        sinon.stub(localSettingRepository, "load")
+          .returns(Promise.resolve(settingData));
+
+        await sut.reload();
+
+        const current = await cachedSettingRepository.get();
+        expect(current.properties.hintchars).to.equal("abcd1234");
+      });
+    });
+
+    context("when local is not set", () => {
+      it("loads settings from sync storage", async() => {
+        const settings = new Settings({
+          keymaps: DefaultSetting.keymaps,
+          search: DefaultSetting.search,
+          blacklist: DefaultSetting.blacklist,
+          properties: new Properties({
+            hintchars: "aaaa1111"
+          }),
+        });
+        const settingData = SettingData.fromJSON({
+          source: "json",
+          json: JSONTextSettings.fromSettings(settings).toJSONText(),
+        });
+
+        sinon.stub(syncSettingRepository, "load")
+          .returns(Promise.resolve(settingData));
+        sinon.stub(localSettingRepository, "load")
+          .returns(Promise.resolve(null));
+
+        await sut.reload();
+
+        const current = await cachedSettingRepository.get();
+        expect(current.properties.hintchars).to.equal("aaaa1111");
+      });
+    });
+
+    context("neither local nor sync not set", () => {
+      it("loads default settings", async() => {
+        it("loads settings from sync storage", async() => {
+          sinon.stub(syncSettingRepository, "load")
+            .returns(Promise.resolve(null));
+          sinon.stub(localSettingRepository, "load")
+            .returns(Promise.resolve(null));
+
+          await sut.reload();
+
+          const current = await cachedSettingRepository.get();
+          expect(current.properties.hintchars).to.equal(DefaultSetting.properties.hintchars);
+        });
+
+      })
+    })
+  })
+});
+