UHF-9214 Visual regression tests for Events list paragraph

backstop/backstop_dynamic_config.js

@@ -324,6 +324,15 @@ function getConfig(hostname, protocol, type) {
           ],
           'selectorExpansion': expandComponents,
         },
+        {
+          'label': 'DC: Event list',
+          'url': `${protocol}://${hostname}/en/dc-components/dc-event-list`,
+          'removeSelectors': removeDefault,
+          'selectors': [
+            '.component--event-list'
+          ],
+          'selectorExpansion': expandComponents,
+        },
         {
           'label': 'DC: Image',
           'url': `${protocol}://${hostname}/en/dc-components/dc-image`,

hdbt.theme

@@ -1637,14 +1637,18 @@ function hdbt_preprocess_paragraph__event_list(&$variables): void {
     ], $paragraph->getFilterKeywords($langcode));
 
     if ($paragraph->hasField('field_api_url') && !$paragraph->get('field_api_url')->isEmpty()) {
-      $linkedEvents = Drupal::service('helfi_react_search_linked_events');
+      /** @var \Drupal\helfi_react_search\LinkedEvents $linkedEvents */
+      $linkedEvents = Drupal::service(LinkedEvents::class);
       $link_field = $events_public_url = $paragraph->get('field_api_url')->first();
       assert($link_field instanceof LinkItemInterface);
       $events_public_url = $link_field->getUrl()->toString();
       $settings['events_public_url'] = $events_public_url;
       $params = $linkedEvents->parseParams($events_public_url);
       $eventUrl = $linkedEvents->getEventsRequest($params, $settings['field_event_count']);
       $settings['events_api_url'] = $eventUrl;
+      // @todo Remove this once the UHF-9214 has been merged to platform config.
+      // @phpstan-ignore-next-line
+      $settings['use_fixtures'] = $linkedEvents->getFixture();
       if (!empty($paragraph->get('field_event_location')->getValue()) && $paragraph->get('field_event_location')->first()->getValue()['value']) {
         $settings['places'] = $linkedEvents->getPlaceslist($eventUrl);
       }

phpstan.neon

@@ -9,7 +9,6 @@ parameters:
   excludePaths:
     - vendor
   level: 3
-  checkMissingIterableValueType: false
   treatPhpDocTypesAsCertain: false
   scanFiles:
     - ../../../core/themes/engines/twig/twig.engine

src/js/react/apps/linkedevents/containers/SearchContainer.tsx

@@ -4,7 +4,7 @@ import { useAtomValue, useAtom } from 'jotai';
 import ResultsContainer from './ResultsContainer';
 import FormContainer from './FormContainer';
 import type Event from '../types/Event';
-import { initialUrlAtom, urlAtom, initialParamsAtom, paramsAtom } from '../store';
+import { initialUrlAtom, urlAtom, initialParamsAtom, paramsAtom, useFixturesAtom } from '../store';
 
 type ResponseType = {
   data: Event[];
@@ -29,6 +29,17 @@ const SearchContainer = () => {
   const initialParams = useAtomValue(initialParamsAtom);
   const [params, setParams] = useAtom(paramsAtom);
   const url = useAtomValue(urlAtom) || initialUrl;
+  const fixtureData = useAtomValue(useFixturesAtom) as ResponseType;
+
+  // If we have fixture data set, return that instead of an API call.
+  if (fixtureData) {
+    return (
+      <>
+        <FormContainer />
+        <ResultsContainer countNumber={fixtureData?.meta.count || 0} loading={false} events={fixtureData?.data || []} />
+      </>
+    );
+  }
 
   if (!params.toString()) {
     setParams(new URLSearchParams(initialParams.toString()));

src/js/react/apps/linkedevents/store.tsx

@@ -8,6 +8,7 @@ import OptionType from './types/OptionType';
 import FormErrors from './types/FormErrors';
 import ApiKeys from './enum/ApiKeys';
 import Topic from './types/Topic';
+import type Event from './types/Event';
 
 interface Options {
   [key: string]: string
@@ -46,6 +47,7 @@ const createBaseAtom = () => {
   }
 
   const settings = drupalSettings.helfi_events?.data?.[paragraphId];
+  const useFixtures = settings?.use_fixtures;
   const eventsApiUrl = settings?.events_api_url;
   const eventListTitle = settings?.field_event_list_title;
   const eventsPublicUrl = settings?.events_public_url;
@@ -85,6 +87,7 @@ const createBaseAtom = () => {
     topics,
     eventListTitle,
     eventsPublicUrl,
+    useFixtures,
   };
 };
 
@@ -132,6 +135,10 @@ export const settingsAtom = atom(
   }
 );
 
+export const useFixturesAtom = atom<object|false>(
+  (get) => get(baseAtom)?.useFixtures
+);
+
 export const pageAtom = atom<number>(1);
 
 export const urlAtom = atom<string|undefined>(undefined);

src/js/types/drupalSettings.d.ts

@@ -26,7 +26,8 @@ declare namespace drupalSettings {
               [key: string]: string
             }
           }
-        }
+        },
+        use_fixtures: boolean
       }
     }
   };