Merge pull request #237 from os2display/release/2.3.0

Release 2.3.0

Author: tuj

.env

@@ -103,3 +103,5 @@ CALENDAR_API_FEED_SOURCE_DATE_FORMAT=
 CALENDAR_API_FEED_SOURCE_DATE_TIMEZONE=
 CALENDAR_API_FEED_SOURCE_CACHE_EXPIRE_SECONDS=300
 ###< Calendar Api Feed Source ###
+
+EVENTDATABASE_API_V2_CACHE_EXPIRE_SECONDS=300

CHANGELOG.md

@@ -4,6 +4,18 @@ All notable changes to this project will be documented in this file.
 
 ## [Unreleased]
 
+## [2.3.0] - 2025-03-24
+
+- [#235](https://github.com/os2display/display-api-service/pull/234)
+  - Fixed Eventdatabasen v2 subscription data order by using occurrences endpoint.
+- [#236](https://github.com/os2display/display-api-service/pull/236)
+  - Fixed bug where no media url made Notified feed crash.
+- [#231](https://github.com/os2display/display-api-service/pull/231)
+  - Adds new feed source: Eventdatabasen v2.
+- [#233](https://github.com/os2display/display-api-service/pull/233)
+  - Added calendar api feed source tests for modifiers.
+  - Changed to use PCRE pattern instead of custom pattern building and fixed modifier bugs for calendar api feed source.
+
 ## [2.2.0] - 2025-03-17
 
 - [#229](https://github.com/os2display/display-api-service/pull/229)

config/packages/cache.yaml

@@ -17,6 +17,9 @@ framework:
                 # Default expire set to 5 minutes
                 default_lifetime: 300
 
+            feed.without.expire.cache:
+                adapter: cache.adapter.redis
+
             # Creates a "calendar.api.cache" service
             calendar.api.cache:
                 adapter: cache.adapter.redis

config/services.yaml

@@ -51,6 +51,10 @@ services:
     Symfony\Component\Security\Http\Authentication\AuthenticationFailureHandlerInterface: '@Lexik\Bundle\JWTAuthenticationBundle\Security\Http\Authentication\AuthenticationFailureHandler'
     Symfony\Component\Security\Http\Authentication\AuthenticationSuccessHandlerInterface: '@Lexik\Bundle\JWTAuthenticationBundle\Security\Http\Authentication\AuthenticationSuccessHandler'
 
+    App\Feed\EventDatabaseApiV2FeedType:
+        arguments:
+            $cacheExpire: '%env(int:EVENTDATABASE_API_V2_CACHE_EXPIRE_SECONDS)%'
+
     App\Feed\CalendarApiFeedType:
         arguments:
             $locationEndpoint: '%env(string:CALENDAR_API_FEED_SOURCE_LOCATION_ENDPOINT)%'

docs/calender-api-feed.md

@@ -136,20 +136,19 @@ Modifiers can be set up to modify the output of the feed.
 
 Two types of modifiers are available:
 
-* EXCLUDE_IF_TITLE_NOT_CONTAINS: Removes entries from the feed if the title not contain the trigger word.
-* REPLACE_TITLE_IF_CONTAINS: Changes the title if it contains the trigger word.
+* EXCLUDE_IF_TITLE_NOT_CONTAINS: Removes entries from the feed if the title does not contain the pattern.
+* REPLACE_TITLE_IF_CONTAINS: Changes the title if it contains the pattern.
 
 Parameters:
 
 * type: EXCLUDE_IF_TITLE_NOT_CONTAINS or REPLACE_TITLE_IF_CONTAINS
 * id: Unique identifier for the modifier.
 * title: Display name when showing the modifier in the admin.
-* description: Help text for the modifier.
+* description: Description of the modifier.
 * activateInFeed: Should this filter be optional? If false the rule will always apply.
-* trigger: The string that should trigger the modifier.
-* replacement: The string to replace the title with.
 * removeTrigger: Should the trigger word be filtered from the title?
-* caseSensitive: Should the trigger word be case-sensitive?
+* pattern: The PCRE regular expression. See <https://www.php.net/manual/en/reference.pcre.pattern.syntax.php>.
+* replacement: The string to replace the title with. See <https://www.php.net/manual/en/function.preg-replace.php>.
 
 Examples of modifiers:
 
@@ -161,29 +160,26 @@ Examples of modifiers:
         "title": "Vis kun begivenheder med (liste) i titlen.",
         "description": "Denne mulighed fjerner begivenheder, der IKKE har (liste) i titlen. Den fjerner også (liste) fra titlen.",
         "activateInFeed": true,
-        "trigger": "(liste)",
-        "removeTrigger": true,
-        "caseSensitive": false
+        "pattern": "\/\\(liste\\)\/i",
+        "removeTrigger": true
     },
     {
         "type": "REPLACE_TITLE_IF_CONTAINS",
-        "id": "replaceIfContainsOptaget",
         "activateInFeed": false,
-        "trigger": "(optaget)",
+        "id": "replaceIfContainsOptaget",
+        "pattern": "\/\\(optaget\\)\/i",
         "replacement": "Optaget",
-        "removeTrigger": true,
-        "caseSensitive": false
+        "removeTrigger": true
     },
     {
         "type": "REPLACE_TITLE_IF_CONTAINS",
-        "id": "onlyShowAsOptaget",
         "activateInFeed": true,
+        "id": "onlyShowAsOptaget",
         "title": "Overskriv alle titler med Optaget",
         "description": "Denne mulighed viser alle titler som Optaget.",
-        "trigger": "",
+        "pattern": "\/\/",
         "replacement": "Optaget",
-        "removeTrigger": false,
-        "caseSensitive": false
+        "removeTrigger": false
     }
 ]
 ```

infrastructure/itkdev/display-api-service/etc/confd/templates/env.local.tmpl

@@ -60,5 +60,7 @@ CALENDAR_API_FEED_SOURCE_CUSTOM_MAPPINGS={{ getenv "APP_CALENDAR_API_FEED_SOURCE
 CALENDAR_API_FEED_SOURCE_EVENT_MODIFIERS={{ getenv "APP_CALENDAR_API_FEED_SOURCE_EVENT_MODIFIERS" "'{}'" }}
 CALENDAR_API_FEED_SOURCE_DATE_FORMAT={{ getenv "APP_CALENDAR_API_FEED_SOURCE_DATE_FORMAT" "" }}
 CALENDAR_API_FEED_SOURCE_DATE_TIMEZONE={{ getenv "APP_CALENDAR_API_FEED_SOURCE_DATE_TIMEZONE" "" }}
-CALENDAR_API_FEED_SOURCE_CACHE_EXPIRE_SECONDS={{ getenv "CALENDAR_API_FEED_SOURCE_CACHE_EXPIRE_SECONDS" "300" }}
+CALENDAR_API_FEED_SOURCE_CACHE_EXPIRE_SECONDS={{ getenv "APP_CALENDAR_API_FEED_SOURCE_CACHE_EXPIRE_SECONDS" "300" }}
 ###< Calendar Api Feed Source ###
+
+EVENTDATABASE_API_V2_CACHE_EXPIRE_SECONDS={{ getenv "APP_EVENTDATABASE_API_V2_CACHE_EXPIRE_SECONDS" "300" }}

infrastructure/os2display/display-api-service/etc/confd/templates/env.local.tmpl

@@ -62,3 +62,5 @@ CALENDAR_API_FEED_SOURCE_DATE_FORMAT={{ getenv "APP_CALENDAR_API_FEED_SOURCE_DAT
 CALENDAR_API_FEED_SOURCE_DATE_TIMEZONE={{ getenv "APP_CALENDAR_API_FEED_SOURCE_DATE_TIMEZONE" "" }}
 CALENDAR_API_FEED_SOURCE_CACHE_EXPIRE_SECONDS={{ getenv "CALENDAR_API_FEED_SOURCE_CACHE_EXPIRE_SECONDS" "300" }}
 ###< Calendar Api Feed Source ###
+
+EVENTDATABASE_API_V2_CACHE_EXPIRE_SECONDS={{ getenv "APP_EVENTDATABASE_API_V2_CACHE_EXPIRE_SECONDS" "300" }}

src/Feed/CalendarApiFeedType.php

@@ -63,8 +63,6 @@ public function __construct(
     public function getData(Feed $feed): array
     {
         try {
-            $results = [];
-
             $configuration = $feed->getConfiguration();
 
             $enabledModifiers = $configuration['enabledModifiers'] ?? [];
@@ -76,62 +74,28 @@ public function getData(Feed $feed): array
             }
 
             $resources = $configuration['resources'];
-            foreach ($resources as $resource) {
-                $events = $this->getResourceEvents($resource);
-
-                /** @var CalendarEvent $event */
-                foreach ($events as $event) {
-                    $title = $event->title;
-
-                    // Modify title according to event modifiers.
-                    foreach ($this->eventModifiers as $modifier) {
-                        // Make it configurable in the Feed if the modifiers should be enabled.
-                        if ($modifier['activateInFeed'] && !in_array($modifier['id'], $enabledModifiers)) {
-                            continue;
-                        }
-
-                        if (self::EXCLUDE_IF_TITLE_NOT_CONTAINS == $modifier['type']) {
-                            $match = preg_match('/'.$modifier['trigger'].'/'.(!$modifier['caseSensitive'] ? 'i' : ''), $title);
-
-                            if ($modifier['removeTrigger']) {
-                                $title = str_replace($modifier['trigger'], '', $title);
-                            }
-
-                            if (!$match) {
-                                continue;
-                            }
-                        }
-
-                        if (self::REPLACE_TITLE_IF_CONTAINS == $modifier['type']) {
-                            $match = preg_match('/'.$modifier['trigger'].'/'.(!$modifier['caseSensitive'] ? 'i' : ''), $title);
-
-                            if ($modifier['removeTrigger']) {
-                                $title = str_replace($modifier['trigger'], '', $title);
-                            }
-
-                            if ($match) {
-                                $title = $modifier['replacement'];
-                            }
-                        }
-                    }
 
-                    $title = trim($title);
+            $events = [];
 
-                    $results[] = [
-                        'id' => Ulid::generate(),
-                        'title' => $title,
-                        'startTime' => $event->startTimeTimestamp,
-                        'endTime' => $event->endTimeTimestamp,
-                        'resourceTitle' => $event->resourceDisplayName,
-                        'resourceId' => $event->resourceId,
-                    ];
-                }
+            foreach ($resources as $resource) {
+                $events += $this->getResourceEvents($resource);
             }
 
+            $modifiedResults = static::applyModifiersToEvents($events, $this->eventModifiers, $enabledModifiers);
+
+            $resultsAsArray = array_map(fn (CalendarEvent $event) => [
+                'id' => Ulid::generate(),
+                'title' => $event->title,
+                'startTime' => $event->startTimeTimestamp,
+                'endTime' => $event->endTimeTimestamp,
+                'resourceTitle' => $event->resourceDisplayName,
+                'resourceId' => $event->resourceId,
+            ], $modifiedResults);
+
             // Sort bookings by start time.
-            usort($results, fn (array $a, array $b) => $a['startTime'] > $b['startTime'] ? 1 : -1);
+            usort($resultsAsArray, fn (array $a, array $b) => $a['startTime'] > $b['startTime'] ? 1 : -1);
 
-            return $results;
+            return $resultsAsArray;
         } catch (\Throwable $throwable) {
             $this->logger->error('{code}: {message}', [
                 'code' => $throwable->getCode(),
@@ -142,6 +106,54 @@ public function getData(Feed $feed): array
         return [];
     }
 
+    public static function applyModifiersToEvents(array $events, array $eventModifiers, array $enabledModifiers): array
+    {
+        $results = [];
+
+        /** @var CalendarEvent $event */
+        foreach ($events as $event) {
+            $title = $event->title;
+
+            // Modify title according to event modifiers.
+            foreach ($eventModifiers as $modifier) {
+                // Make it configurable in the Feed if the modifiers should be enabled.
+                if ($modifier['activateInFeed'] && !in_array($modifier['id'], $enabledModifiers)) {
+                    continue;
+                }
+
+                $pattern = $modifier['pattern'];
+
+                if (self::EXCLUDE_IF_TITLE_NOT_CONTAINS == $modifier['type']) {
+                    $match = preg_match($pattern, $title);
+
+                    if (!$match) {
+                        continue 2;
+                    }
+
+                    if ($modifier['removeTrigger']) {
+                        $title = preg_replace($pattern, '', $title);
+                    }
+                }
+
+                if (self::REPLACE_TITLE_IF_CONTAINS == $modifier['type']) {
+                    $match = preg_match($pattern, $title);
+
+                    if ($match) {
+                        $title = $modifier['replacement'];
+                    }
+                }
+            }
+
+            $title = trim($title);
+
+            $event->title = $title;
+
+            $results[] = $event;
+        }
+
+        return $results;
+    }
+
     /**
      * {@inheritDoc}
      */

src/Feed/EventDatabaseApiFeedType.php

@@ -15,6 +15,8 @@
 use Symfony\Contracts\HttpClient\HttpClientInterface;
 
 /**
+ * @deprecated
+ *
  * See https://github.com/itk-event-database/event-database-api.
  */
 class EventDatabaseApiFeedType implements FeedTypeInterface