@studyportals/fawkes 8.7.0 → 8.7.1-0

package/dist/tests/organisations/policies/ranked/RankedAttendance.test.mjs

@@ -0,0 +1,139 @@
+import { describe, it, expect, beforeEach, vi } from 'vitest';
+import { FilterKey } from '@studyportals/search-filters/server-side';
+import { SearchDependencies } from '../../../organisations/utils/SearchDependencies.util.mjs';
+import { SitemapDependencies } from '../../utils/SitemapDependencies.util.mjs';
+import { SortingOptions } from '@/enums/SortingOptions';
+import { RankedAttendance } from '@/organisations/policies';
+import { PortalType } from '@studyportals/domain-client';
+import { AttendancePresenter } from '@/presenters/AttendancePresenter';
+describe('Policy:RankedAttendance', () => {
+    describe('shouldIndex', () => {
+        let searchDependenciesHelper;
+        let rankedAttendancePolicy;
+        beforeEach(() => {
+            searchDependenciesHelper = new SearchDependencies();
+            rankedAttendancePolicy = new RankedAttendance(searchDependenciesHelper.dependencies);
+            searchDependenciesHelper.setSortingState(SortingOptions.UNIVERSITY_META_RANKING);
+            searchDependenciesHelper.setRankedResultsCount(10);
+        });
+        it('Should return true when all conditions are met', async () => {
+            const attendanceId = 'online';
+            searchDependenciesHelper.setFilterKeyValues(new Map([[FilterKey.DELIVERY_METHOD, [attendanceId]]]));
+            const result = await rankedAttendancePolicy.shouldIndex();
+            expect(result).toBe(true);
+        });
+        it.each([[PortalType.BACHELOR], [PortalType.PHD], [PortalType.SHORT]])('Should return false when the selected portal type is %s', async (portalType) => {
+            const attendanceId = 'online';
+            searchDependenciesHelper.setFilterKeyValues(new Map([[FilterKey.DELIVERY_METHOD, [attendanceId]]]));
+            searchDependenciesHelper.setPortalType(portalType);
+            const result = await rankedAttendancePolicy.shouldIndex();
+            expect(result).toBe(false);
+        });
+        it('Should return false when area when Our Picks sorting is selected', async () => {
+            searchDependenciesHelper.setSortingState(SortingOptions.OUR_PICKS);
+            const result = await rankedAttendancePolicy.shouldIndex();
+            expect(result).toBe(false);
+        });
+        it('Should return false when multiple attendances are selected', async () => {
+            const firstAttendance = 'online';
+            const secondAttendance = 'blended';
+            searchDependenciesHelper.setFilterKeyValues(new Map([[FilterKey.DELIVERY_METHOD, [firstAttendance, secondAttendance]]]));
+            const result = await rankedAttendancePolicy.shouldIndex();
+            expect(result).toBe(false);
+        });
+        it('Should return false when no attendances are selected', async () => {
+            const countryId = '30'; // UK
+            searchDependenciesHelper.setFilterKeyValues(new Map([[FilterKey.COUNTRY, [countryId]]]));
+            const result = await rankedAttendancePolicy.shouldIndex();
+            expect(result).toBe(false);
+        });
+        it('Should return false when other filters are selected', async () => {
+            const attendanceId = 'online';
+            const countryId = '30'; // UK
+            const disciplineId = '1';
+            searchDependenciesHelper.setFilterKeyValues(new Map([
+                [FilterKey.DELIVERY_METHOD, [attendanceId]],
+                [FilterKey.COUNTRY, [countryId]],
+                [FilterKey.DISCIPLINES, [disciplineId]]
+            ]));
+            const result = await rankedAttendancePolicy.shouldIndex();
+            expect(result).toBe(false);
+        });
+        it('Should return false when there are less then 2 ranked results', async () => {
+            const rankedResultsCount = 1;
+            const attendanceId = 'online';
+            searchDependenciesHelper.setRankedResultsCount(rankedResultsCount);
+            searchDependenciesHelper.setFilterKeyValues(new Map([[FilterKey.DELIVERY_METHOD, [attendanceId]]]));
+            const result = await rankedAttendancePolicy.shouldIndex();
+            expect(result).toBe(false);
+        });
+    });
+    describe('generateSitemapUrls', () => {
+        const pathPrefix = 'rankings/';
+        const enoughRankedOrganisations = 10;
+        const noRankedOrganisations = 0;
+        let sitemapDependenciesHelper;
+        let rankedAttendancePolicy;
+        let attendanceFragments;
+        beforeEach(() => {
+            sitemapDependenciesHelper = new SitemapDependencies();
+            rankedAttendancePolicy = new RankedAttendance(sitemapDependenciesHelper.dependencies);
+            vi.spyOn(AttendancePresenter, 'getInstance').mockReturnValue({
+                getFragments: vi.fn(() => attendanceFragments),
+                generatePaths: vi.fn(() => attendanceFragments),
+                fragments: attendanceFragments
+            });
+            sitemapDependenciesHelper.setRankedOrganisationCount(enoughRankedOrganisations);
+        });
+        it('Should return path when all conditions are met', async () => {
+            const attendanceId = 'online';
+            const attendancePath = 'attendance-path';
+            attendanceFragments = [
+                {
+                    id: attendanceId,
+                    path: attendancePath
+                }
+            ];
+            const result = await rankedAttendancePolicy.generateSitemapUrls();
+            expect(result).toEqual([`${pathPrefix}${attendancePath}`]);
+        });
+        it.each([[PortalType.BACHELOR], [PortalType.PHD], [PortalType.SHORT]])('Should not return path when portal type is %s', async (portalType) => {
+            const attendanceId = 'online';
+            const attendancePath = 'attendance-path';
+            attendanceFragments = [
+                {
+                    id: attendanceId,
+                    path: attendancePath
+                }
+            ];
+            sitemapDependenciesHelper.setPortalType(portalType);
+            const result = await rankedAttendancePolicy.generateSitemapUrls();
+            expect(result).toEqual([]);
+        });
+        it('Should not return path when there is no ranked organisation', async () => {
+            const attendanceId = 'online';
+            const attendancePath = 'attendance-path';
+            attendanceFragments = [
+                {
+                    id: attendanceId,
+                    path: attendancePath
+                }
+            ];
+            sitemapDependenciesHelper.setRankedOrganisationCount(noRankedOrganisations);
+            const result = await rankedAttendancePolicy.generateSitemapUrls();
+            expect(result).toEqual([]);
+        });
+        it('Should not return path when attendance is not online', async () => {
+            const attendanceId = 'not-online';
+            const attendancePath = 'attendance-path';
+            attendanceFragments = [
+                {
+                    id: attendanceId,
+                    path: attendancePath
+                }
+            ];
+            const result = await rankedAttendancePolicy.generateSitemapUrls();
+            expect(result).toEqual([]);
+        });
+    });
+});

package/dist/tests/organisations/policies/ranked/RankedAttendanceDiscipline.test.d.mts

@@ -0,0 +1 @@
+export {};

package/dist/tests/organisations/policies/ranked/RankedAttendanceDiscipline.test.mjs

@@ -0,0 +1,224 @@
+import { describe, it, expect, beforeEach, vi } from 'vitest';
+import { FilterKey } from '@studyportals/search-filters/server-side';
+import { SearchDependencies } from '../../../organisations/utils/SearchDependencies.util.mjs';
+import { SitemapDependencies } from '../../utils/SitemapDependencies.util.mjs';
+import { SortingOptions } from '@/enums/SortingOptions';
+import { RankedAttendanceDiscipline } from '@/organisations/policies';
+import { PortalType } from '@studyportals/domain-client';
+import { AttendancePresenter } from '@/presenters/AttendancePresenter';
+import { DisciplinePresenter } from '@/presenters/DisciplinePresenter';
+describe('Policy:RankedAttendanceDiscipline', () => {
+    describe('shouldIndex', () => {
+        let searchDependenciesHelper;
+        let rankedAttendanceDisciplinePolicy;
+        beforeEach(() => {
+            searchDependenciesHelper = new SearchDependencies();
+            rankedAttendanceDisciplinePolicy = new RankedAttendanceDiscipline(searchDependenciesHelper.dependencies);
+            searchDependenciesHelper.setSortingState(SortingOptions.UNIVERSITY_META_RANKING);
+            searchDependenciesHelper.setRankedResultsCount(10);
+        });
+        it('Should return true when all conditions are met', async () => {
+            const attendance = 'online';
+            const disciplineId = '54'; // Agriculture & Forestry
+            searchDependenciesHelper.setFilterKeyValues(new Map([
+                [FilterKey.DELIVERY_METHOD, [attendance]],
+                [FilterKey.DISCIPLINES, [disciplineId]]
+            ]));
+            const result = await rankedAttendanceDisciplinePolicy.shouldIndex();
+            expect(result).toBe(true);
+        });
+        it.each([[PortalType.BACHELOR], [PortalType.PHD], [PortalType.SHORT]])('Should return false when the selected portal type is %s', async (portalType) => {
+            const attendance = 'online';
+            const disciplineId = '54'; // Agriculture & Forestry
+            searchDependenciesHelper.setFilterKeyValues(new Map([
+                [FilterKey.DELIVERY_METHOD, [attendance]],
+                [FilterKey.DISCIPLINES, [disciplineId]]
+            ]));
+            searchDependenciesHelper.setPortalType(portalType);
+            const result = await rankedAttendanceDisciplinePolicy.shouldIndex();
+            expect(result).toBe(false);
+        });
+        it('Should return false when area when Our Picks sorting is selected', async () => {
+            searchDependenciesHelper.setSortingState(SortingOptions.OUR_PICKS);
+            const result = await rankedAttendanceDisciplinePolicy.shouldIndex();
+            expect(result).toBe(false);
+        });
+        it('Should return false when multiple disciplines are selected', async () => {
+            const attendance = 'online';
+            const firstDisciplineId = '54'; // Agriculture & Forestry
+            const secondDisciplineId = '12'; // Applied Sciences & Professions
+            searchDependenciesHelper.setFilterKeyValues(new Map([
+                [FilterKey.DELIVERY_METHOD, [attendance]],
+                [FilterKey.DISCIPLINES, [firstDisciplineId, secondDisciplineId]]
+            ]));
+            const result = await rankedAttendanceDisciplinePolicy.shouldIndex();
+            expect(result).toBe(false);
+        });
+        it('Should return false when multiple attendances are selected', async () => {
+            const disciplineId = '54'; // Agriculture & Forestry
+            const firstAttendance = 'online';
+            const secondAttendance = 'blended';
+            searchDependenciesHelper.setFilterKeyValues(new Map([
+                [FilterKey.DISCIPLINES, [disciplineId]],
+                [FilterKey.DELIVERY_METHOD, [firstAttendance, secondAttendance]]
+            ]));
+            const result = await rankedAttendanceDisciplinePolicy.shouldIndex();
+            expect(result).toBe(false);
+        });
+        it('Should return false when no attendances are selected', async () => {
+            const disciplineId = '54'; // Agriculture & Forestry
+            searchDependenciesHelper.setFilterKeyValues(new Map([[FilterKey.DISCIPLINES, [disciplineId]]]));
+            const result = await rankedAttendanceDisciplinePolicy.shouldIndex();
+            expect(result).toBe(false);
+        });
+        it('Should return false when no disciplines are selected', async () => {
+            const attendance = 'online';
+            searchDependenciesHelper.setFilterKeyValues(new Map([[FilterKey.DELIVERY_METHOD, [attendance]]]));
+            const result = await rankedAttendanceDisciplinePolicy.shouldIndex();
+            expect(result).toBe(false);
+        });
+        it('Should return false when other filters are selected', async () => {
+            const countryId = '30'; // UK
+            const disciplineId = '12'; // Applied Sciences & Professions
+            const attendance = 'online';
+            searchDependenciesHelper.setFilterKeyValues(new Map([
+                [FilterKey.COUNTRY, [countryId]],
+                [FilterKey.DISCIPLINES, [disciplineId]],
+                [FilterKey.DELIVERY_METHOD, [attendance]]
+            ]));
+            const result = await rankedAttendanceDisciplinePolicy.shouldIndex();
+            expect(result).toBe(false);
+        });
+        it('Should return false when there are less then 2 ranked results', async () => {
+            const rankedResultsCount = 1;
+            const areaId = '3578'; // Arkansas
+            const countryId = '30'; // US
+            const disciplineId = '54'; // Agriculture & Forestry
+            searchDependenciesHelper.setRankedResultsCount(rankedResultsCount);
+            searchDependenciesHelper.setFilterKeyValues(new Map([
+                [FilterKey.AREA, [areaId]],
+                [FilterKey.COUNTRY, [countryId]],
+                [FilterKey.DISCIPLINES, [disciplineId]]
+            ]));
+            const result = await rankedAttendanceDisciplinePolicy.shouldIndex();
+            expect(result).toBe(false);
+        });
+        it('Should return false when attendance is not online', async () => {
+            const attendance = 'blended';
+            const disciplineId = '54'; // Agriculture & Forestry
+            searchDependenciesHelper.setFilterKeyValues(new Map([
+                [FilterKey.DELIVERY_METHOD, [attendance]],
+                [FilterKey.DISCIPLINES, [disciplineId]]
+            ]));
+            const result = await rankedAttendanceDisciplinePolicy.shouldIndex();
+            expect(result).toBe(false);
+        });
+    });
+    describe('generateSitemapUrls', () => {
+        const pathPrefix = 'rankings/';
+        const enoughRankedOrganisations = 10;
+        const noRankedOrganisations = 0;
+        let sitemapDependenciesHelper;
+        let rankedAttendanceDisciplinePolicy;
+        let attendanceFragments;
+        let disciplineFragments;
+        beforeEach(() => {
+            sitemapDependenciesHelper = new SitemapDependencies();
+            rankedAttendanceDisciplinePolicy = new RankedAttendanceDiscipline(sitemapDependenciesHelper.dependencies);
+            vi.spyOn(AttendancePresenter, 'getInstance').mockReturnValue({
+                getFragments: vi.fn(() => attendanceFragments),
+                generatePaths: vi.fn(() => attendanceFragments),
+                fragments: attendanceFragments
+            });
+            vi.spyOn(DisciplinePresenter, 'getInstance').mockReturnValue({
+                getFragments: vi.fn(() => disciplineFragments),
+                generatePaths: vi.fn(() => disciplineFragments),
+                fragments: disciplineFragments
+            });
+            sitemapDependenciesHelper.setRankedOrganisationCount(enoughRankedOrganisations);
+        });
+        it('Should return path when all conditions are met', async () => {
+            const attendanceId = 'online';
+            const attendancePath = 'attendance-path';
+            const disciplineId = '54'; // Agriculture & Forestry
+            const disciplinePath = 'discipline-path';
+            attendanceFragments = [
+                {
+                    id: attendanceId,
+                    path: attendancePath
+                }
+            ];
+            disciplineFragments = [
+                {
+                    id: disciplineId,
+                    path: disciplinePath
+                }
+            ];
+            const result = await rankedAttendanceDisciplinePolicy.generateSitemapUrls();
+            expect(result).toEqual([`${pathPrefix}${attendancePath}/${disciplinePath}`]);
+        });
+        it.each([[PortalType.BACHELOR], [PortalType.PHD], [PortalType.SHORT]])('Should not return path when portal type is %s', async (portalType) => {
+            const attendanceId = 'online';
+            const attendancePath = 'attendance-path';
+            const disciplineId = '54'; // Agriculture & Forestry
+            const disciplinePath = 'discipline-path';
+            attendanceFragments = [
+                {
+                    id: attendanceId,
+                    path: attendancePath
+                }
+            ];
+            disciplineFragments = [
+                {
+                    id: disciplineId,
+                    path: disciplinePath
+                }
+            ];
+            sitemapDependenciesHelper.setPortalType(portalType);
+            const result = await rankedAttendanceDisciplinePolicy.generateSitemapUrls();
+            expect(result).toEqual([]);
+        });
+        it('Should not return path when there is no ranked organisation', async () => {
+            const attendanceId = 'online';
+            const attendancePath = 'attendance-path';
+            const disciplineId = '54'; // Agriculture & Forestry
+            const disciplinePath = 'discipline-path';
+            attendanceFragments = [
+                {
+                    id: attendanceId,
+                    path: attendancePath
+                }
+            ];
+            disciplineFragments = [
+                {
+                    id: disciplineId,
+                    path: disciplinePath
+                }
+            ];
+            sitemapDependenciesHelper.setRankedOrganisationCount(noRankedOrganisations);
+            const result = await rankedAttendanceDisciplinePolicy.generateSitemapUrls();
+            expect(result).toEqual([]);
+        });
+        it('Should not return path when attendance is not online', async () => {
+            const attendanceId = 'not-online';
+            const attendancePath = 'attendance-path';
+            const disciplineId = '54'; // Agriculture & Forestry
+            const disciplinePath = 'discipline-path';
+            attendanceFragments = [
+                {
+                    id: attendanceId,
+                    path: attendancePath
+                }
+            ];
+            disciplineFragments = [
+                {
+                    id: disciplineId,
+                    path: disciplinePath
+                }
+            ];
+            sitemapDependenciesHelper.setRankedOrganisationCount(noRankedOrganisations);
+            const result = await rankedAttendanceDisciplinePolicy.generateSitemapUrls();
+            expect(result).toEqual([]);
+        });
+    });
+});

package/dist/tests/organisations/policies/ranked/RankedContinent.test.d.mts

@@ -0,0 +1 @@
+export {};

package/dist/tests/organisations/policies/ranked/RankedContinent.test.mjs

@@ -0,0 +1,125 @@
+import { describe, it, expect, beforeEach, vi } from 'vitest';
+import { FilterKey } from '@studyportals/search-filters/server-side';
+import { SearchDependencies } from '../../../organisations/utils/SearchDependencies.util.mjs';
+import { SitemapDependencies } from '../../utils/SitemapDependencies.util.mjs';
+import { SortingOptions } from '@/enums/SortingOptions';
+import { RankedContinent } from '@/organisations/policies';
+import { PortalType } from '@studyportals/domain-client';
+import { ContinentPresenter } from '@/presenters/ContinentPresenter';
+describe('Policy:RankedContinent', () => {
+    describe('shouldIndex', () => {
+        let searchDependenciesHelper;
+        let rankedContinentPolicy;
+        beforeEach(() => {
+            searchDependenciesHelper = new SearchDependencies();
+            rankedContinentPolicy = new RankedContinent(searchDependenciesHelper.dependencies);
+            searchDependenciesHelper.setSortingState(SortingOptions.UNIVERSITY_META_RANKING);
+            searchDependenciesHelper.setRankedResultsCount(10);
+        });
+        it('Should return true when all conditions are met', async () => {
+            const continentId = '9'; // Asia
+            searchDependenciesHelper.setFilterKeyValues(new Map([[FilterKey.CONTINENT, [continentId]]]));
+            const result = await rankedContinentPolicy.shouldIndex();
+            expect(result).toBe(true);
+        });
+        it.each([[PortalType.BACHELOR], [PortalType.PHD], [PortalType.SHORT]])('Should return false when the selected portal type is %s', async (portalType) => {
+            const continentId = '9'; // Asia
+            searchDependenciesHelper.setFilterKeyValues(new Map([[FilterKey.CONTINENT, [continentId]]]));
+            searchDependenciesHelper.setPortalType(portalType);
+            const result = await rankedContinentPolicy.shouldIndex();
+            expect(result).toBe(false);
+        });
+        it('Should return false when area when Our Picks sorting is selected', async () => {
+            searchDependenciesHelper.setSortingState(SortingOptions.OUR_PICKS);
+            const result = await rankedContinentPolicy.shouldIndex();
+            expect(result).toBe(false);
+        });
+        it('Should return false when multiple continents are selected', async () => {
+            const firstContinentId = '1'; // Europe
+            const secondContinentId = '9'; // Asia
+            searchDependenciesHelper.setFilterKeyValues(new Map([[FilterKey.CONTINENT, [firstContinentId, secondContinentId]]]));
+            const result = await rankedContinentPolicy.shouldIndex();
+            expect(result).toBe(false);
+        });
+        it('Should return false when no continents are selected', async () => {
+            const countryId = '30'; // UK
+            searchDependenciesHelper.setFilterKeyValues(new Map([[FilterKey.COUNTRY, [countryId]]]));
+            const result = await rankedContinentPolicy.shouldIndex();
+            expect(result).toBe(false);
+        });
+        it('Should return false when other filters are selected', async () => {
+            const continentId = '1'; // Europe
+            const disciplineId = '1';
+            searchDependenciesHelper.setFilterKeyValues(new Map([
+                [FilterKey.CONTINENT, [continentId]],
+                [FilterKey.DISCIPLINES, [disciplineId]]
+            ]));
+            const result = await rankedContinentPolicy.shouldIndex();
+            expect(result).toBe(false);
+        });
+        it('Should return false when there are less then 2 ranked results', async () => {
+            const rankedResultsCount = 1;
+            const continentId = '1'; // Europe
+            searchDependenciesHelper.setRankedResultsCount(rankedResultsCount);
+            searchDependenciesHelper.setFilterKeyValues(new Map([[FilterKey.CONTINENT, [continentId]]]));
+            const result = await rankedContinentPolicy.shouldIndex();
+            expect(result).toBe(false);
+        });
+    });
+    describe('generateSitemapUrls', () => {
+        const pathPrefix = 'rankings/';
+        const enoughRankedOrganisations = 10;
+        const noRankedOrganisations = 0;
+        let sitemapDependenciesHelper;
+        let rankedContinentPolicy;
+        let continentFragments;
+        beforeEach(() => {
+            sitemapDependenciesHelper = new SitemapDependencies();
+            rankedContinentPolicy = new RankedContinent(sitemapDependenciesHelper.dependencies);
+            vi.spyOn(ContinentPresenter, 'getInstance').mockReturnValue({
+                getFragments: vi.fn(() => continentFragments),
+                generatePaths: vi.fn(() => continentFragments),
+                fragments: continentFragments
+            });
+            sitemapDependenciesHelper.setRankedOrganisationCount(enoughRankedOrganisations);
+        });
+        it('Should return path when all conditions are met', async () => {
+            const continentId = '9'; // Asia
+            const continentPath = 'continent-path';
+            continentFragments = [
+                {
+                    id: continentId,
+                    path: continentPath
+                }
+            ];
+            const result = await rankedContinentPolicy.generateSitemapUrls();
+            expect(result).toEqual([`${pathPrefix}${continentPath}`]);
+        });
+        it.each([[PortalType.BACHELOR], [PortalType.PHD], [PortalType.SHORT]])('Should not return path when portal type is %s', async (portalType) => {
+            const continentId = '9'; // Asia
+            const continentPath = 'continent-path';
+            continentFragments = [
+                {
+                    id: continentId,
+                    path: continentPath
+                }
+            ];
+            sitemapDependenciesHelper.setPortalType(portalType);
+            const result = await rankedContinentPolicy.generateSitemapUrls();
+            expect(result).toEqual([]);
+        });
+        it('Should not return path when there is no ranked organisation', async () => {
+            const continentId = '9'; // Asia
+            const continentPath = 'continent-path';
+            continentFragments = [
+                {
+                    id: continentId,
+                    path: continentPath
+                }
+            ];
+            sitemapDependenciesHelper.setRankedOrganisationCount(noRankedOrganisations);
+            const result = await rankedContinentPolicy.generateSitemapUrls();
+            expect(result).toEqual([]);
+        });
+    });
+});

package/dist/tests/organisations/policies/ranked/RankedContinentAttendance.test.d.mts

@@ -0,0 +1 @@
+export {};