Feat/crossref rate limit enhancement

.gitignore

@@ -11,6 +11,7 @@ dist/
 .cache
 coverage/
 .vscode/
+.phpunit.result.cache
 
 # local deployment files
 /deploy.sh
@@ -74,5 +75,11 @@ local_dev/tools/**/*.csv
 local_dev/tools/**/*.json
 local_dev/tools/**/*.log
 
+# Playwright
+/test-results/
+/playwright-report/
+/blob-report/
+/playwright/.cache/
+
 # mac os
 .DS_Store

docker-compose.yml

@@ -247,6 +247,8 @@ services:
       PYTHONIOENCODING: "utf-8"
       R_ALTMETRIC_APIKEY: "${R_ALTMETRIC_APIKEY}"
       R_CROSSREF_APIMAIL: "${R_CROSSREF_APIMAIL}"
+      R_CROSSREF_PLUS_TOKEN: "${R_CROSSREF_PLUS_TOKEN}"
+      R_CROSSREF_BATCH_SIZE: "${R_CROSSREF_BATCH_SIZE}"
     restart: unless-stopped
     volumes:
       - ./local_dev/renv/cache:/renv/cache

e2e/basicTests/AQUANAVI.spec.ts

@@ -0,0 +1,27 @@
+import { test, expect } from "@playwright/test";
+import { prepareVisualisation } from "../../vis/js/utils/e2eVisualisationLoader";
+
+test.describe("Basic tests for AQUANAVI integration (Geomap visualisation type)", () => {
+  test.describe("Using direct dynamic URL / PSVS link", () => {
+    test("Loads default Geomap visualisation", async ({ page }) => {
+      const VISUALISATION_DYNAMIC_URL =
+        "/search?type=get&vis_type=geomap&q=mesocosms&service=aquanavi&custom_title=aquatic+mesocosm+facilities&min_descsize=0";
+
+      await prepareVisualisation(page, VISUALISATION_DYNAMIC_URL);
+
+      await expect(page.locator("#search-term-unique")).toContainText(
+        "aquatic mesocosm facilities",
+      );
+      await expect(page.locator("#source")).toContainText(
+        "Data source: AQUANAVI",
+      );
+      await page.getByTestId("context").getByText("More information").click();
+      await expect(page.locator("#info-body")).toContainText(
+        "This geo map presents you with an overview of aquatic mesocosm facilities.",
+      );
+      await expect(page.locator("#info-body")).toContainText(
+        "This visualization has a custom title and was created using the following query: mesocosms",
+      );
+    });
+  });
+});

e2e/basicTests/ORCID.spec.ts

@@ -0,0 +1,50 @@
+import { test, expect } from "@playwright/test";
+import { prepareVisualisation } from "../../vis/js/utils/e2eVisualisationLoader";
+import { waitForVisualisationCreation } from "../../vis/js/utils/e2eWaitForVisualisationCreation";
+
+test.describe("Basic tests for ORCID integration (Knowledge Map visualisation type)", () => {
+  test.describe("Using direct dynamic URL / PSVS link", () => {
+    test("Loads default Knowledge Map visualisation", async ({ page }) => {
+      const VISUALISATION_DYNAMIC_URL =
+        "/search?type=get&vis_type=overview&orcid=0000-0001-6011-4382&service=orcid&embed=true";
+
+      await prepareVisualisation(page, VISUALISATION_DYNAMIC_URL);
+
+      await expect(page.locator("#search-term-unique")).toContainText(
+        "Sebastian  Dennerlein (0000-0001-6011-4382)",
+      );
+
+      await page.getByText("About the map").click();
+      await expect(page.locator("#info-body")).toContainText(
+        "This knowledge map presents you with a topical overview of the most recent works of Sebastian Dennerlein (0000-0001-6011-4382).",
+      );
+    });
+  });
+
+  test.describe("Using search embedded search box", () => {
+    test("Loads default Knowledge Map visualisation", async ({ page }) => {
+      const VISUALISATION_DYNAMIC_URL =
+        "/embedded_searchbox?service=orcid&embed=true";
+
+      await page.goto(VISUALISATION_DYNAMIC_URL);
+      await page
+        .getByRole("textbox", { name: "Enter ORCID (e.g. 0000-0002-" })
+        .click();
+      await page
+        .getByRole("textbox", { name: "Enter ORCID (e.g. 0000-0002-" })
+        .fill("0000-0001-6011-4382");
+      await page.getByRole("button", { name: "Create Overview" }).click();
+
+      await waitForVisualisationCreation(page);
+
+      await expect(page.locator("#search-term-unique")).toContainText(
+        "Sebastian  Dennerlein (0000-0001-6011-4382)",
+      );
+
+      await page.getByText("About the map").click();
+      await expect(page.locator("#info-body")).toContainText(
+        "This knowledge map presents you with a topical overview of the most recent works of Sebastian Dennerlein (0000-0001-6011-4382).",
+      );
+    });
+  });
+});

e2e/basicTests/OpenAIRE.spec.ts

@@ -0,0 +1,24 @@
+import { test, expect } from "@playwright/test";
+import { prepareVisualisation } from "../../vis/js/utils/e2eVisualisationLoader";
+
+test.describe("Basic tests for OpenAIRE integration (Knowledge Map visualisation type)", () => {
+  test.describe("Using direct dynamic URL / PSVS link", () => {
+    test("Loads default Knowledge Map visualisation", async ({ page }) => {
+      const VISUALISATION_DYNAMIC_URL =
+        "/search?type=get&vis_type=&q=&service=openaire&project_id=710722&funder=EC";
+
+      await prepareVisualisation(page, VISUALISATION_DYNAMIC_URL);
+
+      await expect(page.locator(".truncated-project-title")).toContainText(
+        "OpenUP - OPENing UP new methods, indicators",
+      );
+      await expect(page.locator("#source")).toContainText(
+        "Data source: OpenAIRE",
+      );
+      await page.getByTestId("context").getByText("More information").click();
+      await expect(page.locator("#info-body")).toContainText(
+        "This knowledge map presents you with a topical overview of research conducted in the following project:Project DetailsTitleOPENing UP new methods, indicators and tools for peer review, impact measurement and dissemination of research resultsAcronymOpenUPFunderECFunding programCSAH2020CallH2020-GARRI-2015-1Contract (GA) number710722Start Date2016-06-01End Date2018-11-30Open Access mandatetrueOrganizationsUGOE, UvA, PUBLIC POLICY AND MANAGEMENT INSTITUTE, FRONTIERS MEDIA  SA, UoA, DZHW, AIT, Know Center, CNROpenAire LinkLinkWe use text similarity to create a knowledge map. The algorithm groups those resources together that have many words in common. Area titles are created from subject keywords of resources that have been assigned to the same area. We select those keywords and phrases that appear frequently in one area, and seldom in other areas.Knowledge maps provide an instant overview of a topic by showing the main areas at a glance, and resources related to them. This makes it possible to easily identify useful, pertinent information.Please read our FAQs to find out more about knowledge maps.Data sourceThe data is taken from OpenAIRE. OpenAIRE is a key infrastructure that enables the European transition to open science. It provides access to 3 million research projects and more than 70 million research outputs from more than 100,000 data sources.Open source softwareThe visualization is created with the award winning open source software Head Start provided by Open Knowledge Maps. Open Knowledge Maps is a non-profit organisation run by a group of dedicated team members and volunteers. In order to improve our free and open service, we need your support. Please send us your feedback to info@openknowledgemaps.org.If you want to support us financially, you can:Make a donationBecome an organisational memberBecome a funder of our roadmapSign-up for our newsletter to receive occasional updates.",
+      );
+    });
+  });
+});

e2e/basicTests/PubMed.spec.ts

@@ -0,0 +1,112 @@
+import { test, expect } from "@playwright/test";
+import { prepareVisualisation } from "../../vis/js/utils/e2eVisualisationLoader";
+import { waitForVisualisationCreation } from "../../vis/js/utils/e2eWaitForVisualisationCreation";
+
+test.describe("Basic tests for PubMed integration (Knowledge Map visualisation type)", () => {
+  test.describe("Using direct dynamic URL / PSVS link", () => {
+    test("Loads default Knowledge Map visualisation", async ({ page }) => {
+      const VISUALISATION_DYNAMIC_URL =
+        "/search?type=get&vis_type=overview&q=infection&service=pubmed&sorting=most-relevant";
+
+      await prepareVisualisation(page, VISUALISATION_DYNAMIC_URL);
+
+      await expect(page.locator("#search-term-unique")).toContainText(
+        "infection",
+      );
+      await expect(page.locator("#source")).toContainText(
+        "Data source: PubMed",
+      );
+      await page.getByTestId("context").getByText("More information").click();
+      await expect(page.locator("#info-body")).toContainText(
+        "This knowledge map presents you with a topical overview of research on infection based on the 100 most relevant resources matching your search query.",
+      );
+    });
+  });
+
+  test.describe("Using search embedded search box", () => {
+    test("Loads default Knowledge Map visualisation", async ({ page }) => {
+      const VISUALISATION_DYNAMIC_URL = "/embedded_searchbox?service=pubmed";
+
+      await page.goto(VISUALISATION_DYNAMIC_URL);
+      await page
+        .getByRole("textbox", { name: "Enter search query (e.g." })
+        .click();
+      await page
+        .getByRole("textbox", { name: "Enter search query (e.g." })
+        .fill("infection");
+      await page.getByRole("button", { name: "Create Overview" }).click();
+      await waitForVisualisationCreation(page);
+
+      await expect(page.locator("#search-term-unique")).toContainText(
+        "infection",
+      );
+      await expect(page.locator("#source")).toContainText(
+        "Data source: PubMed",
+      );
+      await page.getByTestId("context").getByText("More information").click();
+      await expect(page.locator("#info-body")).toContainText(
+        "This knowledge map presents you with a topical overview of research on infection based on the 100 most relevant resources matching your search query.",
+      );
+    });
+  });
+
+  test.describe("Using old search box", () => {
+    const MAIN_PAGE = "";
+
+    test("Loads default Knowledge Map visualisation using the 'covid-19' try out link", async ({
+      page,
+    }) => {
+      await page.goto(MAIN_PAGE);
+
+      await page.getByRole("radio", { name: "PubMed (life sciences)" }).check();
+
+      const visualisationPagePromise = page.waitForEvent("popup");
+      await page.getByRole("link", { name: "covid-" }).click();
+      const visualisationPage = await visualisationPagePromise;
+
+      await waitForVisualisationCreation(visualisationPage);
+
+      await expect(
+        visualisationPage.locator("#search-term-unique"),
+      ).toContainText("covid-19");
+      await expect(visualisationPage.locator("#source")).toContainText(
+        "Data source: PubMed",
+      );
+      await visualisationPage
+        .getByTestId("context")
+        .getByText("More information")
+        .click();
+      await expect(visualisationPage.locator("#info-body")).toContainText(
+        "This knowledge map presents you with a topical overview of research on covid-19 based on the 100 most relevant resources matching your search query.We use text similarity to create a knowledge map. The algorithm groups those resources together that have many words in common. Area titles are created from subject keywords of resources that have been assigned to the same area. We select those keywords and phrases that appear frequently in one area, and seldom in other areas.Knowledge maps provide an instant overview of a topic by showing the main areas at a glance, and resources related to them. This makes it possible to easily identify useful, pertinent information.Please read our FAQs to find out more about knowledge maps.Data sourceThe data is taken from PubMed. PubMed comprises more than 38 million citations for biomedical literature from MEDLINE, life science journals, and online books. For more information please visit the PubMed website.Citations are available for resources with a DOI and based on citation data provided by Crossref. Results may be impacted by accuracy and completeness of this data.Open source softwareThe visualization is created with the award winning open source software Head Start provided by Open Knowledge Maps. Open Knowledge Maps is a non-profit organisation run by a group of dedicated team members and volunteers. In order to improve our free and open service, we need your support. Please send us your feedback to info@openknowledgemaps.org.If you want to support us financially, you can:Make a donationBecome an organisational memberBecome a funder of our roadmapSign-up for our newsletter to receive occasional updates.",
+      );
+    });
+
+    test('Loads default Knowledge Map visualisation using the "climate change" try out link', async ({
+      page,
+    }) => {
+      await page.goto(MAIN_PAGE);
+
+      await page.getByRole("radio", { name: "PubMed (life sciences)" }).check();
+
+      const visualisationPagePromise = page.waitForEvent("popup");
+      await page.getByRole("link", { name: '"climate change"' }).click();
+      const visualisationPage = await visualisationPagePromise;
+
+      await waitForVisualisationCreation(visualisationPage);
+
+      await expect(
+        visualisationPage.locator("#search-term-unique"),
+      ).toContainText('"climate change"');
+      await expect(visualisationPage.locator("#source")).toContainText(
+        "Data source: PubMed",
+      );
+      await visualisationPage
+        .getByTestId("context")
+        .getByText("More information")
+        .click();
+      await expect(visualisationPage.locator("#info-body")).toContainText(
+        'This knowledge map presents you with a topical overview of research on "climate change" based on the 100 most relevant resources matching your search query.',
+      );
+    });
+  });
+});