Merge branch 'release/2.4.0'

Author: turegjorup

.env

@@ -105,3 +105,6 @@ CALENDAR_API_FEED_SOURCE_CACHE_EXPIRE_SECONDS=300
 ###< Calendar Api Feed Source ###
 
 EVENTDATABASE_API_V2_CACHE_EXPIRE_SECONDS=300
+
+TRACK_SCREEN_INFO=false
+TRACK_SCREEN_INFO_UPDATE_INTERVAL_SECONDS=300

CHANGELOG.md

@@ -4,6 +4,15 @@ All notable changes to this project will be documented in this file.
 
 ## [Unreleased]
 
+## [2.4.0] - 2025-03-31
+
+- [#238](https://github.com/os2display/display-api-service/pull/238)
+  - Added screen status to infrastructure.
+- [#232](https://github.com/os2display/display-api-service/pull/232)
+  - Updated user emails in readme.
+- [#227](https://github.com/os2display/display-api-service/pull/227)
+  - Added screen status to cache and endpoint for exposing screen status.
+
 ## [2.3.0] - 2025-03-24
 
 - [#235](https://github.com/os2display/display-api-service/pull/234)

README.md

@@ -104,8 +104,8 @@ docker compose exec phpfpm bin/console doctrine:migrations:migrate
 docker compose exec phpfpm bin/console hautelook:fixtures:load --no-interaction
 ```
 
-The fixtures have an admin user: <john@example.com> with the password: apassword
-The fixtures have an editor user: <hans@editor.com> with the password: apassword
+The fixtures have an admin user: <admin@example.com> with the password: apassword
+The fixtures have an editor user: <editor@example.com> with the password: apassword
 The fixtures have the image-text template, and two screen layouts:
 full screen and "two boxes".
 

config/api_platform/screen.yaml

@@ -70,6 +70,8 @@ resources:
             ApiPlatform\Metadata\GetCollection:
                 filters:
                     - 'App\Filter\MultipleSearchFilter'
+                    - 'screen.screen_user_exists_filter'
+                    - 'screen.screen_user_latest_request_filter'
                     - 'entity.blameable_filter'
                     - 'entity.order_filter'
                     - 'created.at.order_filter'
@@ -100,7 +102,6 @@ resources:
                             content:
                                 application/ld+json:
                                     examples:
-
                             headers: {}
 
             ApiPlatform\Metadata\Post:

config/packages/cache.yaml

@@ -30,6 +30,12 @@ framework:
                 # Default expire set to 1 day
                 default_lifetime: 86400
 
+            # Creates a "screen.status.cache" service ($screenStatusCache)
+            screen.status.cache:
+                adapter: cache.adapter.redis
+                # Default expire set to infinity
+                default_lifetime: 0
+
             # Creates an "interactive_slide.cache" service
             interactive_slide.cache:
                 adapter: cache.adapter.redis

config/packages/test/cache.yaml

@@ -7,3 +7,6 @@ framework:
             auth.screen.cache:
                 adapter: cache.adapter.filesystem
                 default_lifetime: 3600
+            screen.status.cache:
+                adapter: cache.adapter.filesystem
+                default_lifetime: 0

config/services.yaml

@@ -17,6 +17,8 @@ services:
             # @see https://api-platform.com/docs/core/state-processors/#hooking-into-the-built-in-state-processors
             $persistProcessor: '@api_platform.doctrine.orm.state.persist_processor'
             $removeProcessor: '@api_platform.doctrine.orm.state.remove_processor'
+            $trackScreenInfo: '%env(bool:TRACK_SCREEN_INFO)%'
+            $trackScreenInfoUpdateIntervalSeconds: '%env(TRACK_SCREEN_INFO_UPDATE_INTERVAL_SECONDS)%'
 
     _instanceof:
         App\Feed\FeedTypeInterface:
@@ -299,6 +301,16 @@ services:
         tags: ['api_platform.filter']
         arguments: [ { fullName: 'partial', email: 'partial' } ]
 
+    screen.screen_user_exists_filter:
+        parent: 'api_platform.doctrine.orm.exists_filter'
+        tags: ['api_platform.filter']
+        arguments: [ { screenUser: ~ } ]
+
+    screen.screen_user_latest_request_filter:
+        parent: 'api_platform.doctrine.orm.date_filter'
+        tags: ['api_platform.filter']
+        arguments: [ { screenUser.latestRequest: ~ } ]
+
     # App filters for Api Platform
     App\Filter\PublishedFilter:
         tags: ['api_platform.filter']

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

@@ -64,3 +64,6 @@ CALENDAR_API_FEED_SOURCE_CACHE_EXPIRE_SECONDS={{ getenv "APP_CALENDAR_API_FEED_S
 ###< Calendar Api Feed Source ###
 
 EVENTDATABASE_API_V2_CACHE_EXPIRE_SECONDS={{ getenv "APP_EVENTDATABASE_API_V2_CACHE_EXPIRE_SECONDS" "300" }}
+
+TRACK_SCREEN_INFO={{ getenv "APP_TRACK_SCREEN_INFO" "false" }}
+TRACK_SCREEN_INFO_UPDATE_INTERVAL_SECONDS={{ getenv "APP_TRACK_SCREEN_INFO_UPDATE_INTERVAL_SECONDS" "300" }}

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

@@ -64,3 +64,6 @@ CALENDAR_API_FEED_SOURCE_CACHE_EXPIRE_SECONDS={{ getenv "CALENDAR_API_FEED_SOURC
 ###< Calendar Api Feed Source ###
 
 EVENTDATABASE_API_V2_CACHE_EXPIRE_SECONDS={{ getenv "APP_EVENTDATABASE_API_V2_CACHE_EXPIRE_SECONDS" "300" }}
+
+TRACK_SCREEN_INFO={{ getenv "APP_TRACK_SCREEN_INFO" "false" }}
+TRACK_SCREEN_INFO_UPDATE_INTERVAL_SECONDS={{ getenv "APP_TRACK_SCREEN_INFO_UPDATE_INTERVAL_SECONDS" "300" }}

migrations/Version20240506084815.php

@@ -0,0 +1,29 @@
+<?php
+
+declare(strict_types=1);
+
+namespace DoctrineMigrations;
+
+use Doctrine\DBAL\Schema\Schema;
+use Doctrine\Migrations\AbstractMigration;
+
+/**
+ * Add fields for tracking client status.
+ */
+final class Version20240506084815 extends AbstractMigration
+{
+    public function getDescription(): string
+    {
+        return '';
+    }
+
+    public function up(Schema $schema): void
+    {
+        $this->addSql('ALTER TABLE screen_user ADD release_timestamp INT DEFAULT NULL, ADD release_version VARCHAR(255) DEFAULT NULL, ADD latest_request DATETIME DEFAULT NULL, ADD client_meta JSON DEFAULT NULL COMMENT \'(DC2Type:json)\'');
+    }
+
+    public function down(Schema $schema): void
+    {
+        $this->addSql('ALTER TABLE screen_user DROP release_timestamp, DROP release_version, DROP latest_request, DROP client_meta');
+    }
+}