Merge remote-tracking branch 'origin/release/3.0.0' into feature/update-infrastructure-for-mono-repo

# Conflicts:
#	CHANGELOG.md
#	composer.lock
#	infrastructure/itkdev/display-api-service/etc/confd/templates/env.local.tmpl
#	infrastructure/os2display/display-api-service/etc/confd/templates/env.local.tmpl
#	package-lock.json

Author: turegjorup

.env

@@ -61,14 +61,20 @@ REDIS_CACHE_PREFIX=DisplayApiService
 REDIS_CACHE_DSN=redis://redis:6379/0
 ###< redis ###
 
+###> Http Client ###
+HTTP_CLIENT_TIMEOUT=5
+HTTP_CLIENT_MAX_DURATION=30
+HTTP_CLIENT_LOG_LEVEL=error
+###< Http Client ###
+
 ###> App ###
-APP_DEFAULT_DATE_FORMAT='Y-m-d\TH:i:s.v\Z'
-APP_ACTIVATION_CODE_EXPIRE_INTERVAL=P2D
-APP_KEY_VAULT_SOURCE=ENVIRONMENT
-APP_KEY_VAULT_JSON="{}"
-EVENTDATABASE_API_V2_CACHE_EXPIRE_SECONDS=300
+DEFAULT_DATE_FORMAT='Y-m-d\TH:i:s.v\Z'
+ACTIVATION_CODE_EXPIRE_INTERVAL=P2D
+KEY_VAULT_SOURCE=ENVIRONMENT
+KEY_VAULT_JSON="{}"
 TRACK_SCREEN_INFO=false
 TRACK_SCREEN_INFO_UPDATE_INTERVAL_SECONDS=300
+RELATIONS_CHECKSUM_ENABLED=true
 ###< App ###
 
 ###> itk-dev/openid-connect-bundle ###
@@ -108,6 +114,10 @@ CALENDAR_API_FEED_SOURCE_DATE_TIMEZONE=
 CALENDAR_API_FEED_SOURCE_CACHE_EXPIRE_SECONDS=300
 ###< Calendar Api Feed Source ###
 
+###> Event Database Api V2 Feed Type ###
+EVENTDATABASE_API_V2_CACHE_EXPIRE_SECONDS=300
+###< Event Database Api V2 Feed Type ###
+
 ###> Admin configuration ###
 ADMIN_REJSEPLANEN_APIKEY=
 ADMIN_SHOW_SCREEN_STATUS=false

.github/workflows/composer.yaml

@@ -56,13 +56,3 @@ jobs:
           docker network create frontend
           docker compose run --rm phpfpm composer install
           docker compose run --rm phpfpm composer normalize --dry-run
-
-  composer-audit:
-    runs-on: ubuntu-latest
-    strategy:
-      fail-fast: false
-    steps:
-      - uses: actions/checkout@v4
-      - run: |
-          docker network create frontend
-          docker compose run --rm phpfpm composer audit --locked

.github/workflows/vitest.yaml

@@ -0,0 +1,23 @@
+on: pull_request
+
+name: Unit tests
+
+env:
+  COMPOSE_USER: runner
+
+jobs:
+  vitest:
+    name: Vitest
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup network
+        run: docker network create frontend
+
+      - name: Install dependencies
+        run: docker compose run --rm node npm install
+
+      - name: Run unit tests
+        run: docker compose run --rm node npm run test:unit

.gitignore

@@ -64,3 +64,5 @@ phpstan.neon
 ###> vincentlanglet/twig-cs-fixer ###
 /.twig-cs-fixer.cache
 ###< vincentlanglet/twig-cs-fixer ###
+
+.claude/

CHANGELOG.md

@@ -14,18 +14,28 @@ All notable changes to this project will be documented in this file.
 - Removed propTypes.
 - Upgraded redux-toolkit and how api slices are generated.
 - Fixed redux-toolkit cache handling.
-- Added Taskfile
+- Added Taskfile.
 - Added update command.
 - Added (Client) online-check to public.
 - Updated developer documentation.
-- Removed admin/access-config.json fetch
+- Removed admin/access-config.json fetch.
 - Aligned with v. 2.5.2.
 - Removed themes.
 - Added command to migrate config.json files.
-- Fix data fetching bug
+- Fix data fetching bug and tests
 - Refactored screen layout commands.
-- Moved list components (search and checkboxes) around
-- Updated infrastructure and image build for mono-repo
+- Moved list components (search and checkboxes) around.
+- Aligned environment variable names.
+- Aligned with v. 2.6.0.
+- Added relations checksum feature flag.
+- Fixes saving issues described in issue where saving resulted in infinite spinner.
+- Fixed loading of routes containing null string values.
+- Fixed relations checksum test.
+- Optimized release data fetching.
+- Optimized list loading.
+- Removed fixture length check from test.
+- Added vitest for frontend unit tests.
+- Updated infrastructure and image build for mono-repo.
 
 ### NB! Prior to 3.x the project was split into separate repositories
 

README.md

@@ -304,8 +304,26 @@ We use PHPUnit for API tests:
 task test:api
 ```
 
+### Unit tests - Vitest
+
+Use Vitest for unit and component tests (pure functions, utilities, components with jsdom).
+
+Test files are located in `assets/tests/` alongside the Playwright tests.
+
+Vitest picks up `*.test.js` files.
+
+Unit tests for client and admin utility functions use Vitest:
+
+```shell
+task test:unit
+```
+
 ### Frontend tests - Playwright
 
+Use Playwright for end-to-end tests that run against the full application in a real browser.
+
+Playwright picks up `*.spec.js` files.
+
 To test the React apps we use playwright.
 
 #### Updating Playwright
@@ -391,22 +409,23 @@ Configuration of the project should be added to `.env.local`. Default values are
 
 ```dotenv
 ###> App ###
-APP_ACTIVATION_CODE_EXPIRE_INTERVAL=P2D
-APP_KEY_VAULT_SOURCE=ENVIRONMENT
-APP_KEY_VAULT_JSON="{}"
-EVENTDATABASE_API_V2_CACHE_EXPIRE_SECONDS=300
+DEFAULT_DATE_FORMAT='Y-m-d\TH:i:s.v\Z'
+ACTIVATION_CODE_EXPIRE_INTERVAL=P2D
+KEY_VAULT_SOURCE=ENVIRONMENT
+KEY_VAULT_JSON="{}"
 TRACK_SCREEN_INFO=false
 TRACK_SCREEN_INFO_UPDATE_INTERVAL_SECONDS=300
 ###< App ###
 ```
 
-- APP_ACTIVATION_CODE_EXPIRE_INTERVAL: Specifies how long an external user activation code should live.
+- DEFAULT_DATE_FORMAT: The default format of serialized dates.
+- ACTIVATION_CODE_EXPIRE_INTERVAL: Specifies how long an external user activation code should live.
   The format of the interval should follow <https://www.php.net/manual/en/dateinterval.construct.php>.
 
   **Default**: 2 days.
-- APP_KEY_VAULT_SOURCE: Source of key-value pair for `src/Service/KeyVaultService`. Atm. "ENVIRONMENT" is the only
+- KEY_VAULT_SOURCE: Source of key-value pair for `src/Service/KeyVaultService`. Atm. "ENVIRONMENT" is the only
   option.
-- APP_KEY_VAULT_JSON: A json object formatted as a string. Contains key-value pairs that can be accessed by through
+- KEY_VAULT_JSON: A json object formatted as a string. Contains key-value pairs that can be accessed by through
   `src/Service/KeyVaultService`.
 - EVENTDATABASE_API_V2_CACHE_EXPIRE_SECONDS: What should the expire be for cache entries in EventDatabaseApiV2FeedType?
 - TRACK_SCREEN_INFO: Should screen info be tracked (true|false)?
@@ -494,9 +513,11 @@ CLIENT_DEBUG=false
   waiting for being activated in the administration.
 
   **Default**: 20 s.
-- CLIENT_REFRESH_TOKEN_TIMEOUT: How often (milliseconds) should it be checked whether the token needs to be refreshed?
+- CLIENT_RELEASE_TIMESTAMP_INTERVAL_TIMEOUT: How often (milliseconds) should it be checked whether a new release is
+  available?
+  Value should not be lower than 5 minutes, since release.json is only fetched with a minimum of 5 minutes interval.
 
-  **Default**: 30 s.
+  **Default**: 10 m.
 - CLIENT_REFRESH_TOKEN_TIMEOUT: How often (milliseconds) should it be checked whether the token needs to be refreshed?
 
   **Default**: 60 s.
@@ -523,6 +544,17 @@ CLIENT_DEBUG=false
 - See `docs/configuration/openid-connect.md` for configuration of OpenID Connect.
 - See `docs/configuration/calendar-api-feed.md` for configuration of CalenderApiFeedType.
 
+#### Event Database Api V2 Feed Type
+
+```dotenv
+###> Event Database Api V2 Feed Source ###
+EVENTDATABASE_API_V2_CACHE_EXPIRE_SECONDS=300
+###< Event Database Api V2 Feed Source ###
+```
+
+- EVENTDATABASE_API_V2_CACHE_EXPIRE_SECONDS: What should the expiration be for cache entries in
+  EventDatabaseApiV2FeedType?
+
 ## Rest API & Relationships
 
 To avoid embedding all relations in REST representations but still allow the clients to minimize the amount of API calls

Taskfile.yml

@@ -192,7 +192,7 @@ tasks:
     desc: "Runs API tests (PHPUnit)."
     cmds:
       - task composer -- test-setup
-      - task compose -- exec --env SYMFONY_DEPRECATIONS_HELPER=disabled phpfpm composer test
+      - task compose -- exec --env SYMFONY_DEPRECATIONS_HELPER=disabled phpfpm vendor/bin/phpunit --stop-on-failure {{.CLI_ARGS}}
 
   test:frontend-built:
     desc: "Runs frontend tests (Playwright) on the built files. This temporarily stops the node container."
@@ -227,4 +227,14 @@ tasks:
   fixtures:copy-assets:
     desc: "Copy the folder from fixtures/public/fixtures to public/fixtures. Rerun if fixtures are changed."
     cmds:
-      - task compose -- exec phpfpm cp -r fixtures/public/fixtures public/fixtures
+      - task compose -- exec phpfpm cp -r fixtures/public/fixtures public/
+
+  test:unit:
+    desc: "Runs client unit tests (Vitest)."
+    cmds:
+      - task compose -- run --rm node npm run test:unit {{.CLI_ARGS}}
+
+  assets:build:
+    desc: "Build the assets."
+    cmds:
+      - task compose -- run --rm node npm run build

UPGRADE.md

@@ -17,7 +17,11 @@ Because of these changes, it will be necessary to adjust the server setup to mat
 
 ### Upgrade steps
 
-#### 0 - Convert external templates to custom templates
+#### 0.1 - Upgrade the API to the latest version of 2.x
+
+#### 0.2 - Checkout the API to 3.x
+
+#### 1 - Convert external templates to custom templates
 
 Instead of loading javascript for templates from possibly external urls we have made the change to only include
 templates that are a part of the code. Standard templates are now located in `assets/shared/templates/`.
@@ -28,8 +32,6 @@ Custom templates are documented in the [README.md#custom-templates](README.md#cu
 
 The important thing is that the `id` of the template should remain the same when converted to a custom template.
 
-#### 1 - Upgrade the API to the latest version of 2.x
-
 #### 2 - Configure the following environment variables in `.env.local`
 
 ```dotenv
@@ -62,6 +64,15 @@ docker compose exec phpfpm bin/console app:utils:convert-config-json-to-env --ty
 docker compose exec phpfpm bin/console app:utils:convert-config-json-to-env --type=client path/to/client/config.json
 ```
 
+#### 2.1 - Rename environment variables
+
+Rename the following .env variables in `.env.local`:
+
+- From `APP_DEFAULT_DATE_FORMAT` to `DEFAULT_DATE_FORMAT`
+- From `APP_ACTIVATION_CODE_EXPIRE_INTERVAL` to `ACTIVATION_CODE_EXPIRE_INTERVAL`
+- From `APP_KEY_VAULT_SOURCE` to `KEY_VAULT_SOURCE`
+- From `APP_KEY_VAULT_JSON` to `KEY_VAULT_JSON`
+
 #### 3 - Run doctrine migrate
 
 ```shell

assets/admin/components/feed-sources/feed-source-form.jsx

@@ -13,6 +13,7 @@ import EventDatabaseApiFeedType from "./templates/event-database-feed-type";
 import ColiboFeedType from "./templates/colibo-feed-type";
 import StickyFooter from "../util/sticky-footer";
 import EventDatabaseApiV2FeedType from "./templates/event-database-v2-feed-type";
+import BrndFeedType from "./templates/brnd-feed-type.jsx";
 
 /**
  * The feed-source form component.
@@ -124,6 +125,14 @@ function FeedSourceForm({
                   feedSourceId={feedSource["@id"]}
                 />
               )}
+              {feedSource?.feedType === "App\\Feed\\BrndFeedType" && (
+                <BrndFeedType
+                  handleInput={handleSecretInput}
+                  formStateObject={feedSource.secrets}
+                  mode={mode}
+                  feedSourceId={feedSource["@id"]}
+                />
+              )}
               {feedSource?.feedType ===
                 "App\\Feed\\EventDatabaseApiFeedType" && (
                 <EventDatabaseApiFeedType

assets/admin/components/feed-sources/templates/brnd-feed-type.jsx

@@ -0,0 +1,50 @@
+import React from "react";
+import { useTranslation } from "react-i18next";
+import FormInput from "../../util/forms/form-input";
+
+const BrndFeedType = ({ handleInput, formStateObject, mode }) => {
+  const { t } = useTranslation("common", {
+    keyPrefix: "brnd-feed-type",
+  });
+
+  return (
+    <>
+      <FormInput
+        name="api_base_uri"
+        type="text"
+        label={t("api-base-uri")}
+        className="mb-2"
+        onChange={handleInput}
+        placeholder={
+          mode === "PUT" ? t("redacted-value-input-placeholder") : ""
+        }
+        value={formStateObject?.api_base_uri}
+      />
+
+      <FormInput
+        name="company_id"
+        type="text"
+        className="mb-2"
+        label={t("company-id")}
+        onChange={handleInput}
+        placeholder={
+          mode === "PUT" ? t("redacted-value-input-placeholder") : ""
+        }
+        value={formStateObject?.company_id}
+      />
+
+      <FormInput
+        name="api_auth_key"
+        type="text"
+        label={t("api-auth-key")}
+        onChange={handleInput}
+        placeholder={
+          mode === "PUT" ? t("redacted-value-input-placeholder") : ""
+        }
+        value={formStateObject?.api_auth_key}
+      />
+    </>
+  );
+};
+
+export default BrndFeedType;