@eeacms/volto-cca-policy 1.0.13 → 1.0.15

package/src/components/manage/Blocks/ChatbotCatalogue/useCatalogueDoc.js

@@ -0,0 +1,116 @@
+import { useEffect, useState } from 'react';
+import { registry } from '@eeacms/search';
+import { fetchResult } from '@eeacms/search/lib/hocs/useResult';
+
+const searchAppName = 'navigatorCatalogueSearch';
+
+/**
+ * Fetch a document from the globalsearch Elasticsearch index by URL.
+ *
+ * The globalsearch index uses the document URL as the ES `_id`, and the
+ * volto-searchlib express middleware whitelists/proxies
+ * `GET /_es/{app}/_doc/{id}` (see esGetDocWhitelist in
+ * volto-searchlib/src/middleware/elasticsearch.js). `fetchResult`
+ * (searchlib) issues that GET and wraps the hit in the searchlib Result
+ * model — the same object the Navigator catalogue cards consume.
+ *
+ * Results are cached in a module-level Map for the lifetime of the page
+ * (no refetch on re-render, repeat questions, or multiple cards for the
+ * same document).
+ */
+const docCache = new Map();
+// Resolved values (Result | null) keyed by URL. Lets a card that has already
+// been fetched render the full card synchronously instead of flashing the
+// basic card first (repeat doc, remount, or a second message citing the same
+// URL).
+const resolvedCache = new Map();
+
+/**
+ * Normalize URLs so they match the globalsearch Elasticsearch index `_id`.
+ * In globalsearch, Climate-ADAPT tools use `https://climate-adapt.eea.europa.eu/en/...`
+ * without trailing slashes.
+ */
+export function normalizeCatalogueUrl(url) {
+  if (!url || typeof url !== 'string') return url;
+  let normalized = url.trim();
+  // Strip trailing slashes
+  while (normalized.endsWith('/')) {
+    normalized = normalized.slice(0, -1);
+  }
+  // Map localhost or cca.localhost to production domain used in the globalsearch index
+  normalized = normalized.replace(
+    /^https?:\/\/(?:cca\.localhost|localhost(?::\d+)?)/i,
+    'https://climate-adapt.eea.europa.eu',
+  );
+  // Ensure /en/ prefix for metadata or other paths in Climate-ADAPT
+  // e.g. https://climate-adapt.eea.europa.eu/metadata/... -> https://climate-adapt.eea.europa.eu/en/metadata/...
+  const ccaDomain = 'https://climate-adapt.eea.europa.eu';
+  if (normalized.toLowerCase().startsWith(ccaDomain.toLowerCase())) {
+    const path = normalized.slice(ccaDomain.length);
+    if (path.startsWith('/') && !path.startsWith('/en/') && path !== '/en') {
+      normalized = `${ccaDomain}/en${path}`;
+    }
+  }
+  return normalized;
+}
+
+// The search app configs live on the searchlib registry's mutable `searchui`
+// part (see CompareTools/utils.js fetchResultsByUid for the same pattern).
+function getAppConfig() {
+  return registry.searchui?.[searchAppName] || null;
+}
+
+function fetchCatalogueDoc(rawUrl) {
+  const url = normalizeCatalogueUrl(rawUrl);
+  const appConfig = getAppConfig();
+  if (!docCache.has(url)) {
+    docCache.set(
+      url,
+      appConfig
+        ? fetchResult(url, appConfig, registry)
+            .then((result) => {
+              const value = result && result.found !== false ? result : null;
+              resolvedCache.set(url, value);
+              return value;
+            })
+            .catch(() => {
+              resolvedCache.set(url, null);
+              return null;
+            })
+        : Promise.resolve(null),
+    );
+  }
+  return docCache.get(url);
+}
+
+export function useCatalogueDoc(rawUrl) {
+  const url = normalizeCatalogueUrl(rawUrl);
+  // Start from the resolved cache (if any) so a known doc renders as the full
+  // card immediately, avoiding a basic→full flash on mount.
+  const [result, setResult] = useState(() =>
+    url && resolvedCache.has(url) ? resolvedCache.get(url) : null,
+  );
+
+  useEffect(() => {
+    if (!url) {
+      setResult(null);
+      return undefined;
+    }
+    // Already resolved: stay in sync without an effect round-trip.
+    if (resolvedCache.has(url)) {
+      setResult(resolvedCache.get(url));
+      return undefined;
+    }
+    let ignore = false;
+    fetchCatalogueDoc(url).then((doc) => {
+      if (!ignore) {
+        setResult(doc);
+      }
+    });
+    return () => {
+      ignore = true;
+    };
+  }, [url]);
+
+  return { result, loading: !!url && result === null };
+}

package/src/components/manage/Blocks/ChatbotCatalogue/useCatalogueDoc.test.js

@@ -0,0 +1,149 @@
+import { act, renderHook } from '@testing-library/react-hooks';
+
+import { registry } from '@eeacms/search';
+import { fetchResult } from '@eeacms/search/lib/hocs/useResult';
+import { useCatalogueDoc } from './useCatalogueDoc';
+
+jest.mock('@eeacms/search', () => ({
+  registry: { searchui: {} },
+}));
+
+jest.mock('@eeacms/search/lib/hocs/useResult', () => ({
+  fetchResult: jest.fn(),
+}));
+
+const appConfig = { app: 'navigatorCatalogueSearch', endpoint: '/_es' };
+
+const flushPromises = () => act(() => Promise.resolve());
+
+describe('useCatalogueDoc', () => {
+  beforeEach(() => {
+    fetchResult.mockReset();
+    registry.searchui.navigatorCatalogueSearch = appConfig;
+  });
+
+  it('returns a null result and loading state while the fetch is pending', () => {
+    fetchResult.mockReturnValue(new Promise(() => {}));
+    const { result } = renderHook(() =>
+      useCatalogueDoc('https://example.com/doc-a'),
+    );
+    expect(result.current).toEqual({ result: null, loading: true });
+  });
+
+  it('exposes the searchlib result when the document is found', async () => {
+    const esResult = { found: true, uid: 'https://example.com/doc-b' };
+    fetchResult.mockResolvedValue(esResult);
+
+    const { result } = renderHook(() =>
+      useCatalogueDoc('https://example.com/doc-b'),
+    );
+    await flushPromises();
+
+    expect(fetchResult).toHaveBeenCalledWith(
+      'https://example.com/doc-b',
+      appConfig,
+      registry,
+    );
+    expect(result.current).toEqual({ result: esResult, loading: false });
+  });
+
+  it('resolves to null when the document is not found', async () => {
+    fetchResult.mockResolvedValue({ found: false });
+
+    const { result } = renderHook(() =>
+      useCatalogueDoc('https://example.com/doc-missing'),
+    );
+    await flushPromises();
+
+    expect(result.current).toEqual({ result: null, loading: true });
+  });
+
+  it('resolves to null when the request fails', async () => {
+    fetchResult.mockRejectedValue(new Error('ES unavailable'));
+
+    const { result } = renderHook(() =>
+      useCatalogueDoc('https://example.com/doc-fail'),
+    );
+    await flushPromises();
+
+    expect(result.current).toEqual({ result: null, loading: true });
+  });
+
+  it('caches the fetch per URL: repeated renders do not refetch', async () => {
+    fetchResult.mockResolvedValue({
+      found: true,
+      uid: 'https://example.com/doc-c',
+    });
+
+    const { result, rerender } = renderHook(() =>
+      useCatalogueDoc('https://example.com/doc-c'),
+    );
+    await flushPromises();
+    rerender();
+    await flushPromises();
+
+    expect(fetchResult).toHaveBeenCalledTimes(1);
+    expect(result.current.result).toEqual({
+      found: true,
+      uid: 'https://example.com/doc-c',
+    });
+  });
+
+  it('serves an already-resolved URL synchronously from the resolved cache', async () => {
+    fetchResult.mockResolvedValue({
+      found: true,
+      uid: 'https://example.com/doc-d',
+    });
+
+    const first = renderHook(() =>
+      useCatalogueDoc('https://example.com/doc-d'),
+    );
+    await flushPromises();
+    first.unmount();
+
+    // A fresh render for the same URL must not refetch and starts with the
+    // cached result (no basic -> full flash).
+    fetchResult.mockClear();
+    const second = renderHook(() =>
+      useCatalogueDoc('https://example.com/doc-d'),
+    );
+    expect(fetchResult).not.toHaveBeenCalled();
+    expect(second.result.current.result).toEqual({
+      found: true,
+      uid: 'https://example.com/doc-d',
+    });
+  });
+
+  it('does not fetch when the search app is not configured', async () => {
+    delete registry.searchui.navigatorCatalogueSearch;
+
+    const { result } = renderHook(() =>
+      useCatalogueDoc('https://example.com/doc-unconfigured'),
+    );
+    await flushPromises();
+
+    expect(fetchResult).not.toHaveBeenCalled();
+    expect(result.current).toEqual({ result: null, loading: true });
+  });
+
+  it('returns idle state (not loading) when no URL is given', () => {
+    const { result } = renderHook(() => useCatalogueDoc(undefined));
+    expect(result.current).toEqual({ result: null, loading: false });
+  });
+
+  it('normalizes URLs before fetching from Elasticsearch', async () => {
+    fetchResult.mockResolvedValue({ found: true });
+    renderHook(() =>
+      useCatalogueDoc(
+        'http://cca.localhost/metadata/tools/climate-policy-radar/',
+      ),
+    );
+    await flushPromises();
+
+    expect(fetchResult).toHaveBeenCalledWith(
+      'https://climate-adapt.eea.europa.eu/en/metadata/tools/climate-policy-radar',
+      appConfig,
+      registry,
+    );
+  });
+});

package/src/components/manage/Blocks/index.js

@@ -23,6 +23,7 @@ import installASTNavigation from './ASTNavigation';
 import installFlourishEmbedBlock from './FlourishEmbedBlock';
 import installDataConnectedEmbed from './DataConnectedEmbedBlock';
 import installCountryMapProfile from './CountryMapProfile';
+import installChatbotCatalogue from './ChatbotCatalogue';
 
 export default function installBlocks(config) {
   config.blocks.blocksConfig.title.restricted = false;
@@ -81,6 +82,7 @@ export default function installBlocks(config) {
     installTransRegionSelect,
     installCollectionStats,
     installTabsBlock,
+    installChatbotCatalogue,
     installListing,
     installRedirectBlock,
     installContentLinks,

package/theme/globals/navigator.less

@@ -83,7 +83,12 @@
   }
 }
 
-.searchapp-navigatorCatalogueSearch .catalogue-compare {
+// The label+checkbox row is aligned via inline-flex. Needed both in the
+// searchlib results page and in the CCA chatbot "catalogue" chat cards
+// (see .catalogue-chat-navigator-card), otherwise the "Compare" text drops
+// out of line with the checkbox.
+.searchapp-navigatorCatalogueSearch .catalogue-compare,
+.catalogue-chat-navigator-card .catalogue-compare {
   display: inline-flex;
   align-items: center;
   gap: 0.45rem;
@@ -571,28 +576,9 @@
   }
 }
 
-body.searchlib-page .searchapp-navigatorCatalogueSearch {
-  .back-link {
-    display: none;
-  }
-
-  .search-input,
-  .sui-search-box {
-    margin-bottom: 2rem;
-  }
-
-  .ui.right.sidebar {
-    background-color: #fff;
-    box-shadow: -4px 0 4px rgba(0, 0, 0, 0.25);
-  }
-
-  .sidebar-wrapper {
-    display: flex;
-    height: 100%;
-    flex-direction: column;
-    padding: 1em;
-  }
-
+// Shared styles for the Navigator catalogue card. Applied both in the
+// searchlib results page and in the CCA chatbot "catalogue" chat cards.
+.navigator-catalogue-card-styles() {
   .navigator-catalogue-item {
     display: grid;
     padding: 1.2rem;
@@ -725,6 +711,37 @@ body.searchlib-page .searchapp-navigatorCatalogueSearch {
   }
 }
 
+body.searchlib-page .searchapp-navigatorCatalogueSearch {
+  .back-link {
+    display: none;
+  }
+
+  .search-input,
+  .sui-search-box {
+    margin-bottom: 2rem;
+  }
+
+  .ui.right.sidebar {
+    background-color: #fff;
+    box-shadow: -4px 0 4px rgba(0, 0, 0, 0.25);
+  }
+
+  .sidebar-wrapper {
+    display: flex;
+    height: 100%;
+    flex-direction: column;
+    padding: 1em;
+  }
+
+  .navigator-catalogue-card-styles();
+}
+
+// The chatbot "catalogue" chat renders the same Navigator card outside the
+// searchlib results page, so apply the shared card styles there too.
+.catalogue-chat-navigator-card {
+  .navigator-catalogue-card-styles();
+}
+
 .navigator-tool-provider,
 .catalogue-date {
   color: @navigatorMetaTextColor;

package/src/customizations/@eeacms/volto-banner/StagingBanner.jsx

@@ -1,5 +0,0 @@
-const StagingBanner = ({ banner, token, dispatch }) => {
-  return null;
-};
-
-export default StagingBanner;

package/src/customizations/@eeacms/volto-banner/index.js

@@ -1,3 +0,0 @@
-export default function dummyConfig(config) {
-  return config;
-}