@ledgerhq/live-common 34.51.0-nightly.9 → 34.51.0

package/lib/__tests__/announcements/filterAnnouncements.js

@@ -0,0 +1,667 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const timemachine_1 = __importDefault(require("timemachine"));
+const logic_1 = require("../../notifications/AnnouncementProvider/logic");
+const announcements_1 = __importDefault(require("../test-helpers/announcements"));
+const package_json_1 = __importDefault(require("../../../package.json"));
+timemachine_1.default.config({
+    dateString: "February 22, 2021 13:12:59",
+});
+jest.mock("../../../package.json");
+let rawAnnouncements;
+let announcements;
+describe("filterAnnouncements", () => {
+    beforeEach(async () => {
+        rawAnnouncements = await announcements_1.default.fetchAnnouncements();
+    });
+    afterAll(() => {
+        timemachine_1.default.reset();
+    });
+    describe("language filters", () => {
+        describe("with context.language = 'en'", () => {
+            const context = {
+                language: "en",
+                currencies: ["bitcoin", "cosmos"],
+                getDate: () => new Date(),
+            };
+            beforeEach(() => {
+                announcements = (0, logic_1.localizeAnnouncements)(rawAnnouncements, context);
+            });
+            it("should return all anouncements for english only and all the non-scoped one", async () => {
+                const filtered = (0, logic_1.filterAnnouncements)(announcements, context);
+                expect(filtered).toStrictEqual(announcements);
+            });
+        });
+        describe("with context.language = 'fr'", () => {
+            const context = {
+                language: "fr",
+                currencies: ["bitcoin", "cosmos"],
+                getDate: () => new Date(),
+            };
+            beforeEach(() => {
+                announcements = (0, logic_1.localizeAnnouncements)(rawAnnouncements, context);
+            });
+            it("should return all anouncements for french only and all the non-scoped one", async () => {
+                const filtered = (0, logic_1.filterAnnouncements)(announcements, context);
+                const expected = [
+                    {
+                        uuid: "announcement-id-a",
+                        level: "info",
+                        icon: "warning",
+                        content: {
+                            title: "Incoming cosmos fork",
+                            text: "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nunc nibh felis, pom id...",
+                            link: {
+                                href: "https://ledger.com/there-is/an/incoming-cosmos-fork",
+                                label: "Click here for more information on upcoming fork",
+                            },
+                        },
+                        contextual: [],
+                        published_at: "2019-09-29T00:00:00.000Z",
+                        expired_at: "2021-03-06T00:00:00.000Z",
+                        utm_campaign: "promo_feb2021",
+                        currencies: ["cosmos"],
+                    },
+                    {
+                        uuid: "announcement-id-c",
+                        level: "warning",
+                        icon: "warning",
+                        content: {
+                            title: "Fork bitcoin en approche",
+                            text: "Lorem ipsum mais en français dolor sit amet, consectetur adipiscing elit. Nunc nibh felis, pom id...",
+                            link: {
+                                href: "https://ledger.com/there-is/an/fork-bitcoin-en-approche",
+                                label: "Clique ici pour en savoir plus sur le fork bitcoin ;)",
+                            },
+                        },
+                        priority: 1,
+                        contextual: ["send"],
+                        published_at: "2019-10-31T00:00:00.000Z",
+                        expired_at: "2021-05-06T00:00:00.000Z",
+                        currencies: ["bitcoin"],
+                    },
+                ];
+                expect(filtered).toStrictEqual(expected);
+            });
+        });
+    });
+    describe("currencies filters", () => {
+        describe("with context.currencies = ['bitcoin']", () => {
+            const context = {
+                language: "en",
+                currencies: ["bitcoin"],
+                getDate: () => new Date(),
+            };
+            beforeEach(() => {
+                announcements = (0, logic_1.localizeAnnouncements)(rawAnnouncements, context);
+            });
+            it("should return only the announcements scoped to bitcoin", () => {
+                const filtered = (0, logic_1.filterAnnouncements)(announcements, context);
+                const expected = [
+                    {
+                        uuid: "announcement-id-b",
+                        level: "info",
+                        icon: "info",
+                        content: {
+                            title: "Incoming cosmos fork",
+                            text: "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nunc nibh felis, pom id...",
+                            link: {
+                                href: "https://ledger.com/there-is/an/incoming-cosmos-fork",
+                                label: "Click here for more information on upcoming fork",
+                            },
+                        },
+                        contextual: [],
+                        languages: ["en"],
+                        published_at: "2019-10-31T00:00:00.000Z",
+                        expired_at: "2021-04-06T00:00:00.000Z",
+                    },
+                    {
+                        uuid: "announcement-id-c",
+                        level: "warning",
+                        icon: "warning",
+                        content: {
+                            title: "Incoming bitcoin fork",
+                            text: "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nunc nibh felis, pom id...",
+                            link: {
+                                href: "https://ledger.com/there-is/an/incoming-cosmos-fork",
+                                label: "Click here for more information on upcoming fork",
+                            },
+                        },
+                        priority: 1,
+                        contextual: ["send"],
+                        published_at: "2019-10-31T00:00:00.000Z",
+                        expired_at: "2021-05-06T00:00:00.000Z",
+                        currencies: ["bitcoin"],
+                    },
+                ];
+                expect(filtered).toStrictEqual(expected);
+            });
+        });
+        describe("with context.currencies = ['cosmos']", () => {
+            const context = {
+                language: "en",
+                currencies: ["cosmos"],
+                getDate: () => new Date(),
+            };
+            beforeEach(() => {
+                announcements = (0, logic_1.localizeAnnouncements)(rawAnnouncements, context);
+            });
+            it("should return only the announcements scoped to cosmos", () => {
+                const filtered = (0, logic_1.filterAnnouncements)(announcements, context);
+                const expected = [
+                    {
+                        uuid: "announcement-id-a",
+                        level: "info",
+                        icon: "warning",
+                        content: {
+                            title: "Incoming cosmos fork",
+                            text: "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nunc nibh felis, pom id...",
+                            link: {
+                                href: "https://ledger.com/there-is/an/incoming-cosmos-fork",
+                                label: "Click here for more information on upcoming fork",
+                            },
+                        },
+                        contextual: [],
+                        published_at: "2019-09-29T00:00:00.000Z",
+                        expired_at: "2021-03-06T00:00:00.000Z",
+                        utm_campaign: "promo_feb2021",
+                        currencies: ["cosmos"],
+                    },
+                    {
+                        uuid: "announcement-id-b",
+                        level: "info",
+                        icon: "info",
+                        content: {
+                            title: "Incoming cosmos fork",
+                            text: "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nunc nibh felis, pom id...",
+                            link: {
+                                href: "https://ledger.com/there-is/an/incoming-cosmos-fork",
+                                label: "Click here for more information on upcoming fork",
+                            },
+                        },
+                        contextual: [],
+                        languages: ["en"],
+                        published_at: "2019-10-31T00:00:00.000Z",
+                        expired_at: "2021-04-06T00:00:00.000Z",
+                    },
+                ];
+                expect(filtered).toStrictEqual(expected);
+            });
+        });
+        describe("with context.currencies = ['bitcoin', 'cosmos']", () => {
+            const context = {
+                language: "en",
+                currencies: ["bitcoin", "cosmos"],
+                getDate: () => new Date(),
+            };
+            beforeEach(() => {
+                announcements = (0, logic_1.localizeAnnouncements)(rawAnnouncements, context);
+            });
+            it("should return only the announcements scoped to cosmos and bitcoin", () => {
+                const filtered = (0, logic_1.filterAnnouncements)(announcements, context);
+                const expected = [
+                    {
+                        uuid: "announcement-id-a",
+                        level: "info",
+                        icon: "warning",
+                        content: {
+                            title: "Incoming cosmos fork",
+                            text: "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nunc nibh felis, pom id...",
+                            link: {
+                                href: "https://ledger.com/there-is/an/incoming-cosmos-fork",
+                                label: "Click here for more information on upcoming fork",
+                            },
+                        },
+                        contextual: [],
+                        published_at: "2019-09-29T00:00:00.000Z",
+                        expired_at: "2021-03-06T00:00:00.000Z",
+                        utm_campaign: "promo_feb2021",
+                        currencies: ["cosmos"],
+                    },
+                    {
+                        uuid: "announcement-id-b",
+                        level: "info",
+                        icon: "info",
+                        content: {
+                            title: "Incoming cosmos fork",
+                            text: "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nunc nibh felis, pom id...",
+                            link: {
+                                href: "https://ledger.com/there-is/an/incoming-cosmos-fork",
+                                label: "Click here for more information on upcoming fork",
+                            },
+                        },
+                        contextual: [],
+                        languages: ["en"],
+                        published_at: "2019-10-31T00:00:00.000Z",
+                        expired_at: "2021-04-06T00:00:00.000Z",
+                    },
+                    {
+                        uuid: "announcement-id-c",
+                        level: "warning",
+                        icon: "warning",
+                        content: {
+                            title: "Incoming bitcoin fork",
+                            text: "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nunc nibh felis, pom id...",
+                            link: {
+                                href: "https://ledger.com/there-is/an/incoming-cosmos-fork",
+                                label: "Click here for more information on upcoming fork",
+                            },
+                        },
+                        priority: 1,
+                        contextual: ["send"],
+                        published_at: "2019-10-31T00:00:00.000Z",
+                        expired_at: "2021-05-06T00:00:00.000Z",
+                        currencies: ["bitcoin"],
+                    },
+                ];
+                expect(filtered).toStrictEqual(expected);
+            });
+        });
+        describe("with context.currencies = []", () => {
+            const context = {
+                language: "en",
+                currencies: [],
+                getDate: () => new Date(),
+            };
+            beforeEach(() => {
+                announcements = (0, logic_1.localizeAnnouncements)(rawAnnouncements, context);
+            });
+            it("should return only the announcements not scoped to any currency", () => {
+                const filtered = (0, logic_1.filterAnnouncements)(announcements, context);
+                const expected = [
+                    {
+                        uuid: "announcement-id-b",
+                        level: "info",
+                        icon: "info",
+                        content: {
+                            title: "Incoming cosmos fork",
+                            text: "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nunc nibh felis, pom id...",
+                            link: {
+                                href: "https://ledger.com/there-is/an/incoming-cosmos-fork",
+                                label: "Click here for more information on upcoming fork",
+                            },
+                        },
+                        contextual: [],
+                        languages: ["en"],
+                        published_at: "2019-10-31T00:00:00.000Z",
+                        expired_at: "2021-04-06T00:00:00.000Z",
+                    },
+                ];
+                expect(filtered).toStrictEqual(expected);
+            });
+        });
+    });
+    describe("published_at filters", () => {
+        const context = {
+            language: "en",
+            currencies: ["bitcoin", "cosmos"],
+            getDate: () => new Date(),
+        };
+        describe("with current date higher than publish date", () => {
+            beforeAll(() => {
+                timemachine_1.default.config({
+                    dateString: "February 22, 2021 13:12:59",
+                });
+            });
+            beforeEach(() => {
+                announcements = (0, logic_1.localizeAnnouncements)(rawAnnouncements, context);
+            });
+            afterEach(() => {
+                timemachine_1.default.reset();
+            });
+            it(`should return all the article posted before `, () => {
+                const filtered = (0, logic_1.filterAnnouncements)(announcements, context);
+                const expected = [
+                    {
+                        uuid: "announcement-id-a",
+                        level: "info",
+                        icon: "warning",
+                        content: {
+                            title: "Incoming cosmos fork",
+                            text: "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nunc nibh felis, pom id...",
+                            link: {
+                                href: "https://ledger.com/there-is/an/incoming-cosmos-fork",
+                                label: "Click here for more information on upcoming fork",
+                            },
+                        },
+                        contextual: [],
+                        published_at: "2019-09-29T00:00:00.000Z",
+                        expired_at: "2021-03-06T00:00:00.000Z",
+                        utm_campaign: "promo_feb2021",
+                        currencies: ["cosmos"],
+                    },
+                    {
+                        uuid: "announcement-id-b",
+                        level: "info",
+                        icon: "info",
+                        content: {
+                            title: "Incoming cosmos fork",
+                            text: "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nunc nibh felis, pom id...",
+                            link: {
+                                href: "https://ledger.com/there-is/an/incoming-cosmos-fork",
+                                label: "Click here for more information on upcoming fork",
+                            },
+                        },
+                        contextual: [],
+                        languages: ["en"],
+                        published_at: "2019-10-31T00:00:00.000Z",
+                        expired_at: "2021-04-06T00:00:00.000Z",
+                    },
+                    {
+                        uuid: "announcement-id-c",
+                        level: "warning",
+                        icon: "warning",
+                        content: {
+                            title: "Incoming bitcoin fork",
+                            text: "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nunc nibh felis, pom id...",
+                            link: {
+                                href: "https://ledger.com/there-is/an/incoming-cosmos-fork",
+                                label: "Click here for more information on upcoming fork",
+                            },
+                        },
+                        priority: 1,
+                        contextual: ["send"],
+                        published_at: "2019-10-31T00:00:00.000Z",
+                        expired_at: "2021-05-06T00:00:00.000Z",
+                        currencies: ["bitcoin"],
+                    },
+                ];
+                expect(filtered).toStrictEqual(expected);
+            });
+        });
+        describe("with current date lower than publish date", () => {
+            beforeEach(() => {
+                timemachine_1.default.config({
+                    dateString: "October 10, 2019 13:12:59",
+                });
+            });
+            it("should return only the article posted before", () => {
+                const filtered = (0, logic_1.filterAnnouncements)(announcements, context);
+                const expected = [
+                    {
+                        uuid: "announcement-id-a",
+                        level: "info",
+                        icon: "warning",
+                        content: {
+                            title: "Incoming cosmos fork",
+                            text: "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nunc nibh felis, pom id...",
+                            link: {
+                                href: "https://ledger.com/there-is/an/incoming-cosmos-fork",
+                                label: "Click here for more information on upcoming fork",
+                            },
+                        },
+                        contextual: [],
+                        published_at: "2019-09-29T00:00:00.000Z",
+                        expired_at: "2021-03-06T00:00:00.000Z",
+                        utm_campaign: "promo_feb2021",
+                        currencies: ["cosmos"],
+                    },
+                ];
+                expect(filtered).toStrictEqual(expected);
+            });
+        });
+        afterAll(() => {
+            timemachine_1.default.config({
+                dateString: "February 22, 2021 13:12:59",
+            });
+        });
+    });
+    describe("expired_at filters", () => {
+        beforeAll(() => {
+            timemachine_1.default.config({
+                dateString: "February 22, 2021 13:12:59",
+            });
+        });
+        afterAll(() => {
+            timemachine_1.default.config({
+                dateString: "February 22, 2021 13:12:59",
+            });
+        });
+        const context = {
+            language: "en",
+            currencies: ["bitcoin", "cosmos"],
+            getDate: () => new Date(),
+        };
+        beforeEach(() => {
+            announcements = (0, logic_1.localizeAnnouncements)(rawAnnouncements, context);
+        });
+        describe("with current date lower than expiration date", () => {
+            it("should return all non-expired announcements", () => {
+                const filtered = (0, logic_1.filterAnnouncements)(announcements, context);
+                const expected = [
+                    {
+                        uuid: "announcement-id-a",
+                        level: "info",
+                        icon: "warning",
+                        content: {
+                            title: "Incoming cosmos fork",
+                            text: "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nunc nibh felis, pom id...",
+                            link: {
+                                href: "https://ledger.com/there-is/an/incoming-cosmos-fork",
+                                label: "Click here for more information on upcoming fork",
+                            },
+                        },
+                        contextual: [],
+                        published_at: "2019-09-29T00:00:00.000Z",
+                        expired_at: "2021-03-06T00:00:00.000Z",
+                        utm_campaign: "promo_feb2021",
+                        currencies: ["cosmos"],
+                    },
+                    {
+                        uuid: "announcement-id-b",
+                        level: "info",
+                        icon: "info",
+                        content: {
+                            title: "Incoming cosmos fork",
+                            text: "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nunc nibh felis, pom id...",
+                            link: {
+                                href: "https://ledger.com/there-is/an/incoming-cosmos-fork",
+                                label: "Click here for more information on upcoming fork",
+                            },
+                        },
+                        contextual: [],
+                        languages: ["en"],
+                        published_at: "2019-10-31T00:00:00.000Z",
+                        expired_at: "2021-04-06T00:00:00.000Z",
+                    },
+                    {
+                        uuid: "announcement-id-c",
+                        level: "warning",
+                        icon: "warning",
+                        content: {
+                            title: "Incoming bitcoin fork",
+                            text: "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nunc nibh felis, pom id...",
+                            link: {
+                                href: "https://ledger.com/there-is/an/incoming-cosmos-fork",
+                                label: "Click here for more information on upcoming fork",
+                            },
+                        },
+                        priority: 1,
+                        contextual: ["send"],
+                        published_at: "2019-10-31T00:00:00.000Z",
+                        expired_at: "2021-05-06T00:00:00.000Z",
+                        currencies: ["bitcoin"],
+                    },
+                ];
+                expect(filtered).toStrictEqual(expected);
+            });
+        });
+        describe("with current date higher than expiration date", () => {
+            beforeEach(() => {
+                timemachine_1.default.config({
+                    dateString: "April 22, 2021 13:12:59",
+                });
+            });
+            it("should return only non-expired announcements", () => {
+                const filtered = (0, logic_1.filterAnnouncements)(announcements, context);
+                const expected = [
+                    {
+                        uuid: "announcement-id-c",
+                        level: "warning",
+                        icon: "warning",
+                        content: {
+                            title: "Incoming bitcoin fork",
+                            text: "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nunc nibh felis, pom id...",
+                            link: {
+                                href: "https://ledger.com/there-is/an/incoming-cosmos-fork",
+                                label: "Click here for more information on upcoming fork",
+                            },
+                        },
+                        priority: 1,
+                        contextual: ["send"],
+                        published_at: "2019-10-31T00:00:00.000Z",
+                        expired_at: "2021-05-06T00:00:00.000Z",
+                        currencies: ["bitcoin"],
+                    },
+                ];
+                expect(filtered).toStrictEqual(expected);
+            });
+        });
+    });
+    describe("appVersion filters", () => {
+        beforeAll(() => {
+            timemachine_1.default.config({
+                dateString: "February 22, 2021 13:12:59",
+            });
+        });
+        afterAll(() => {
+            timemachine_1.default.config({
+                dateString: "February 22, 2021 13:12:59",
+            });
+        });
+        const context = {
+            language: "en",
+            currencies: ["bitcoin", "cosmos"],
+            getDate: () => new Date(),
+            appVersion: "2.41.2",
+        };
+        beforeEach(() => {
+            const appVersionsData = [["<=2.42.0", ">=3"], [], ["=2.41.3"]];
+            const rawAnnouncementsVersioned = rawAnnouncements.map((announcement, index) => ({
+                ...announcement,
+                appVersions: appVersionsData[index],
+            }));
+            announcements = (0, logic_1.localizeAnnouncements)(rawAnnouncementsVersioned, context);
+        });
+        describe("with context.appVersion = '2.41.2'", () => {
+            it("should return all matching announcements", () => {
+                const filtered = (0, logic_1.filterAnnouncements)(announcements, context);
+                const expected = [
+                    {
+                        uuid: "announcement-id-a",
+                        level: "info",
+                        icon: "warning",
+                        content: {
+                            title: "Incoming cosmos fork",
+                            text: "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nunc nibh felis, pom id...",
+                            link: {
+                                href: "https://ledger.com/there-is/an/incoming-cosmos-fork",
+                                label: "Click here for more information on upcoming fork",
+                            },
+                        },
+                        contextual: [],
+                        published_at: "2019-09-29T00:00:00.000Z",
+                        expired_at: "2021-03-06T00:00:00.000Z",
+                        utm_campaign: "promo_feb2021",
+                        currencies: ["cosmos"],
+                        appVersions: ["<=2.42.0", ">=3"],
+                    },
+                    {
+                        uuid: "announcement-id-b",
+                        level: "info",
+                        icon: "info",
+                        content: {
+                            title: "Incoming cosmos fork",
+                            text: "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nunc nibh felis, pom id...",
+                            link: {
+                                href: "https://ledger.com/there-is/an/incoming-cosmos-fork",
+                                label: "Click here for more information on upcoming fork",
+                            },
+                        },
+                        contextual: [],
+                        languages: ["en"],
+                        published_at: "2019-10-31T00:00:00.000Z",
+                        expired_at: "2021-04-06T00:00:00.000Z",
+                        appVersions: [],
+                    },
+                ];
+                expect(filtered).toStrictEqual(expected);
+            });
+        });
+    });
+    describe("liveCommonVersions filters", () => {
+        beforeAll(() => {
+            timemachine_1.default.config({
+                dateString: "February 22, 2021 13:12:59",
+            });
+            package_json_1.default.version = "12.41.2";
+        });
+        afterAll(() => {
+            timemachine_1.default.config({
+                dateString: "February 22, 2021 13:12:59",
+            });
+        });
+        const context = {
+            language: "en",
+            currencies: ["bitcoin", "cosmos"],
+            getDate: () => new Date(),
+        };
+        beforeEach(() => {
+            const liveCommonVersionsData = [["<=12.42.0", ">=13"], [], ["=12.41.3"]];
+            const rawAnnouncementsVersioned = rawAnnouncements.map((announcement, index) => ({
+                ...announcement,
+                liveCommonVersions: liveCommonVersionsData[index],
+            }));
+            announcements = (0, logic_1.localizeAnnouncements)(rawAnnouncementsVersioned, context);
+        });
+        describe("with current live-common version set to '12.41.2'", () => {
+            it("should return all matching announcements", () => {
+                const filtered = (0, logic_1.filterAnnouncements)(announcements, context);
+                const expected = [
+                    {
+                        uuid: "announcement-id-a",
+                        level: "info",
+                        icon: "warning",
+                        content: {
+                            title: "Incoming cosmos fork",
+                            text: "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nunc nibh felis, pom id...",
+                            link: {
+                                href: "https://ledger.com/there-is/an/incoming-cosmos-fork",
+                                label: "Click here for more information on upcoming fork",
+                            },
+                        },
+                        contextual: [],
+                        published_at: "2019-09-29T00:00:00.000Z",
+                        expired_at: "2021-03-06T00:00:00.000Z",
+                        utm_campaign: "promo_feb2021",
+                        currencies: ["cosmos"],
+                        liveCommonVersions: ["<=12.42.0", ">=13"],
+                    },
+                    {
+                        uuid: "announcement-id-b",
+                        level: "info",
+                        icon: "info",
+                        content: {
+                            title: "Incoming cosmos fork",
+                            text: "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nunc nibh felis, pom id...",
+                            link: {
+                                href: "https://ledger.com/there-is/an/incoming-cosmos-fork",
+                                label: "Click here for more information on upcoming fork",
+                            },
+                        },
+                        contextual: [],
+                        languages: ["en"],
+                        published_at: "2019-10-31T00:00:00.000Z",
+                        expired_at: "2021-04-06T00:00:00.000Z",
+                        liveCommonVersions: [],
+                    },
+                ];
+                expect(filtered).toStrictEqual(expected);
+            });
+        });
+    });
+});
+//# sourceMappingURL=filterAnnouncements.js.map