Merge branch 'b-7.4.x-refactorings-OXDEV-8947' into b-7.4.x

Author: tkcreateit

.editorconfig

@@ -0,0 +1,18 @@
+# EditorConfig is awesome: https://EditorConfig.org
+
+# top-most EditorConfig file
+root = true
+
+# Unix-style newlines with a newline ending every file
+[*]
+end_of_line = lf
+charset = utf-8
+indent_style = space
+indent_size = 4
+
+[*.php]
+insert_final_newline = true
+
+# Unix-style newlines with a newline ending every file
+[{*.yml,*.yaml}]
+indent_size = 2

CHANGELOG.md

@@ -4,6 +4,28 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/)
 and this project adheres to [Semantic Versioning](http://semver.org/).
 
+## [v2.0.0] - Unreleased
+
+### Added
+- Added the UserInterface with getId method to rely on
+- SaveGreetingRequestInterface extracted from the Service layer
+- Example of triggering an event after the vote action (new event - ProductVotedEvent)
+- TrackerInterface added to not rely on the shop model directly
+- Editorconfig file for more consistent coding style between devs
+
+### Changed
+- Switch to OXID eShop 7.4 as dev dependency - updated the recipe and github workflows.
+- Segregate the Settings interface and moved pieces to their own domain directories:
+  - LoggingSettingsInterface
+  - GreetingSettingsInterface
+- Reworked how the active user is accessed - do not use the getUser controller method anymore.
+  - Its better to not rely on the old controller abstractions. 
+- Restructured the directories in Tracker - Repository and Factory goes to Infrastructure directory.
+- README improved with more information on the module Goals and more links to concrete example cases
+
+### Fixed
+- More waiting time for the acceptance tests to avoid random failures.
+
 ## [v1.0.0] - 2025-06-05
 
 ### Added

README.md

@@ -53,6 +53,37 @@ Story:
 
 Install and try out the module with simple examples to most common development questions.
 
+We would like to encourage following ideas and principles in module development:
+
+* Separate contexts into their own folders (e.g. Greeting, Tracker, ProductVote)
+  * Basics of DDD in module development
+  * Controllers are our use cases and entry points
+  * Services contain business logic
+  * Infrastructure contains shop framework/database related code
+* Layered architecture within those contexts (e.g. Infrastructure, Service, Controller, Subscriber)
+  * Changing the implementation should not affect other layers
+  * Interfaces are the contracts between layers
+  * Data Transfer Objects (DTOs) used for data exchange between layers
+  * Factories are responsible for creating DTOs (e.g. from database rows)
+    * Centralizes mapping logic and makes it reusable and testable
+* Hexagonal architecture ideas
+  * Ports (interfaces here) and adapters (implementations here)
+  * Adapters depend on ports, not the other way round
+  * Application core is independent of external systems (as much as possible in the current context)
+* Dependency injection
+  * Allows awesome testability and flexibility
+  * Avoids usage of global state (Registry, oxNew, static calls)
+    * Use factories to create model objects instead of oxNew directly
+* SOLID principles
+  * SRP and DIP in focus
+* Clean architecture ideas
+  * Dependencies point inwards
+  * Business logic is independent of frameworks, databases, UIs
+* Avoid the extension of shop core classes as much as possible
+  * Prefer event listeners, DI service decoration/replacement
+  * If extension is necessary, follow minimal invasion principle
+* Tests are a good example of Unit usage
+
 ## Examples
 
 The repository contains examples of following cases and more:
@@ -61,44 +92,53 @@ The repository contains examples of following cases and more:
   * extending a shop model (`OxidEsales\ExamplesModule\Extension\Model\User`) / (`OxidEsales\ExamplesModule\Extension\Model\Basket`)
   * extending a shop controller (`OxidEsales\ExamplesModule\Extension\Controller\StartController`)
 
-* [Controllers as service](https://github.com/OXID-eSales/examples-module/blob/b-7.4.x/src/Greeting/services.yaml#L28)
+* [Controllers as service](https://github.com/OXID-eSales/examples-module/blob/b-7.4.x/src/Greeting/services.yaml#L29)
   * own module controller (`oeem_greeting` with own template and own translations)
   * own module admin controller (`oeem_admin_greeting` with own template and own translations)
 
-* [Using Symfony DI](https://github.com/OXID-eSales/examples-module/blob/b-7.4.x/services.yaml)
-  * [Injection of Registry classes with bind](https://github.com/OXID-eSales/examples-module/blob/b-7.4.x/src/Greeting/services.yaml#L5)
+* [Using Symfony DI](services.yaml)
+  * [Injection of Registry classes with bind](https://github.com/OXID-eSales/examples-module/blob/b-7.4.x/services.yaml#L16)
+  * [Service decoration](src/Greeting/Service/Decorator/GreetingValidationDecorator.php) - shows how to decorate services
+    * Note: While the example uses validation/truncation for simplicity, better use cases include logging, caching, performance monitoring, or audit trails
+    * [Decorator registration](src/Greeting/services.yaml) - using `decorates:` in DI configuration
 
-* [Migrations](https://github.com/OXID-eSales/examples-module/tree/b-7.4.x/migration)
+* [Migrations](migration)
   * extending a shop database table (`oxuser`)
 
 * Accessing the database
-  * model with a database (`OxidEsales\ExamplesModule\Tracker\Model\GreetingTracker`)
-  * ``oxNew`` object factory example (`OxidEsales\ExamplesModule\Greeting\Infrastructure\UserModelFactory`)
-  * [DAO](src/ProductVote/Dao)
+  * Model with a database (`OxidEsales\ExamplesModule\Tracker\Model\TrackerModel`)
+  * ``oxNew`` object factory example (`OxidEsales\ExamplesModule\Greeting\Infrastructure\Factory\UserModelFactory`)
+  * [DAO examples](src/ProductVote/Dao) - lower level abstraction for database access
+  * Repository examples - higher level abstraction for data access
+    * [GreetingRepository](src/Greeting/Infrastructure/Repository/GreetingRepository.php) - direct database query with QueryBuilder example (consider making DAO instead for cases like this)
+    * [UserRepository](src/Greeting/Infrastructure/Repository/UserRepository.php) - loading shop user with model example
+    * [TrackerRepository](src/Tracker/Infrastructure/Repository/TrackerRepository.php) - more comprehensive example showing dependencies and DTO usage
 
 * [Various types of module settings](https://github.com/OXID-eSales/examples-module/blob/b-7.4.x/metadata.php#L38)
 
 * Templates
-  * [creating templates for your module](https://github.com/OXID-eSales/examples-module/blob/b-7.4.x/views/twig/templates/greetingtemplate.html.twig)
-  * [extending of oxid theme templates or blocks](https://github.com/OXID-eSales/examples-module/tree/b-7.4.x/views/twig/extensions/themes)
+  * [creating templates for your module](views/twig/templates/greetingtemplate.html.twig)
+  * [extending of oxid theme templates or blocks](views/twig/extensions/themes)
     * extending a shop admin template block (`admin_user_main_form` - only an extension of a block, without functionality)
     * extending a shop template block (`start_newest_articles`)
 
 * Using the translations for your module specific phrases
-  * [in admin](https://github.com/OXID-eSales/examples-module/tree/b-7.4.x/views/admin_twig)
-  * [in frontend](https://github.com/OXID-eSales/examples-module/tree/b-7.4.x/translations)
+  * [in admin](views/admin_twig)
+  * [in frontend](translations)
 
 * Events and listeners
-  * [Subscribing to shop events](https://github.com/OXID-eSales/examples-module/blob/b-7.4.x/src/Tracker/Subscriber/BeforeModelUpdate.php)
+  * [Subscribing to shop events](src/Tracker/Subscriber/BeforeModelUpdate.php) - listening to `BeforeModelUpdateEvent`
+  * [Creating and dispatching custom module events](src/ProductVote/Event/ProductVotedEvent.php)
+    * [Dispatching the event](src/ProductVote/Service/VoteService.php) - triggering events from services
 
 * Testing your module backend and frontend part
   * [Composer aliases for easy running of tests and quality tools](https://github.com/OXID-eSales/examples-module/blob/b-7.4.x/composer.json#L48)
-  * [Using the github actions as CI tool with all recommended tools preconfigured for you.](https://github.com/OXID-eSales/examples-module/tree/b-7.4.x/.github)
+  * [Using the github actions as CI tool with all recommended tools preconfigured for you.](.github)
 
-* [Using variables from .env file](https://github.com/OXID-eSales/examples-module/tree/b-7.4.x/.env)
-  * [Access via `getenv()` function](https://github.com/OXID-eSales/examples-module/tree/b-7.4.x/src/Extension/Controller/StartController.php)
+* [Using variables from .env file](.env)
+  * [Access via `getenv()` function](src/Extension/Controller/StartController.php)
     * Note: Changes to environment variables take effect immediately — no cache clearing is required.
-  * [Access via DI container](https://github.com/OXID-eSales/examples-module/tree/b-7.4.x/src/Greeting/services.yaml)
+  * [Access via DI container](src/Greeting/services.yaml)
     * Note: After updating environment variables, you must clear the cache for changes to take effect.
 
 **HINTS**:

services.yaml

@@ -6,14 +6,17 @@ imports:
   - { resource: src/Greeting/services.yaml }
   - { resource: src/Logging/services.yaml }
   - { resource: src/ProductVote/services.yaml }
-  - { resource: src/Settings/services.yaml }
   - { resource: src/Tracker/services.yaml }
 
 services:
 
   _defaults:
     public: false
     autowire: true
+#    This is how you can bind shop registry services to your services
+#    bind:
+#      OxidEsales\Eshop\Core\Language: '@=service("OxidEsales\\ExamplesModule\\Core\\Registry").getLang()'
+#      OxidEsales\Eshop\Core\Session: '@=service("OxidEsales\\ExamplesModule\\Core\\Registry").getSession()'
 
   OxidEsales\ExamplesModule\Core\Registry:
     class: OxidEsales\Eshop\Core\Registry

src/Extension/Controller/StartController.php

@@ -11,7 +11,7 @@
 
 use OxidEsales\Eshop\Application\Model\User as EshopModelUser;
 use OxidEsales\ExamplesModule\Greeting\Service\GreetingMessageServiceInterface;
-use OxidEsales\ExamplesModule\Settings\Service\ModuleSettingsServiceInterface;
+use OxidEsales\ExamplesModule\Greeting\Settings\GreetingSettingsInterface;
 
 /**
  * @eshopExtension
@@ -55,9 +55,9 @@ public function getOeemGreeting(): string
 
     public function canUpdateOeemGreeting(): bool
     {
-        $moduleSettings = $this->getService(ModuleSettingsServiceInterface::class);
+        $greetingSettings = $this->getService(GreetingSettingsInterface::class);
 
         /** @phpstan-ignore-next-line */
-        return is_a($this->getUser(), EshopModelUser::class) && $moduleSettings->isPersonalGreetingMode();
+        return is_a($this->getUser(), EshopModelUser::class) && $greetingSettings->isPersonalGreetingMode();
     }
 }

src/Extension/Model/User.php

@@ -11,7 +11,6 @@
 
 use OxidEsales\Eshop\Core\Model\BaseModel;
 use OxidEsales\ExamplesModule\Greeting\Model\PersonalGreetingUser;
-use OxidEsales\ExamplesModule\Greeting\Model\PersonalGreetingUserInterface;
 
 /**
  * @eshopExtension
@@ -28,4 +27,9 @@
 class User extends User_parent implements UserInterface
 {
     use PersonalGreetingUser;
+
+    public function getId(): ?string
+    {
+        return parent::getId();
+    }
 }

src/Extension/Model/UserInterface.php

@@ -11,4 +11,5 @@
 
 interface UserInterface extends PersonalGreetingUserInterface
 {
+    public function getId(): ?string;
 }

src/Greeting/Controller/GreetingController.php

@@ -10,12 +10,14 @@
 namespace OxidEsales\ExamplesModule\Greeting\Controller;
 
 use OxidEsales\Eshop\Application\Controller\FrontendController;
-use OxidEsales\Eshop\Application\Model\User as EshopModelUser;
 use OxidEsales\ExamplesModule\Core\Module as ModuleCore;
-use OxidEsales\ExamplesModule\Extension\Model\User as ExamplesModelUser;
+use OxidEsales\ExamplesModule\Extension\Model\UserInterface;
+use OxidEsales\ExamplesModule\Greeting\Exception\UserNotLoggedIn;
+use OxidEsales\ExamplesModule\Greeting\Infrastructure\Repository\UserRepositoryInterface;
 use OxidEsales\ExamplesModule\Greeting\Service\GreetingMessageServiceInterface;
-use OxidEsales\ExamplesModule\Settings\Service\ModuleSettingsServiceInterface;
-use OxidEsales\ExamplesModule\Tracker\Repository\TrackerRepositoryInterface;
+use OxidEsales\ExamplesModule\Greeting\Settings\GreetingSettingsInterface;
+use OxidEsales\ExamplesModule\Greeting\Transput\SaveGreetingRequestInterface;
+use OxidEsales\ExamplesModule\Tracker\Infrastructure\Repository\TrackerRepositoryInterface;
 
 /**
  * @extendable-class
@@ -34,9 +36,11 @@ class GreetingController extends FrontendController
     protected $_sThisTemplate = '@oe_examples_module/templates/greetingtemplate';
 
     public function __construct(
-        private readonly ModuleSettingsServiceInterface $moduleSettings,
+        private readonly GreetingSettingsInterface $greetingSettings,
         private readonly TrackerRepositoryInterface $trackerRepository,
         private readonly GreetingMessageServiceInterface $greetingService,
+        private readonly SaveGreetingRequestInterface $saveGreetingRequest,
+        private readonly UserRepositoryInterface $userRepository,
     ) {
         parent::__construct();
     }
@@ -50,13 +54,19 @@ public function render()
     {
         $template = parent::render();
 
-        /** @var ExamplesModelUser $user */
-        $user = $this->getUser();
+        try {
+            $activeUser = $this->userRepository->getActiveUser();
+        } catch (UserNotLoggedIn $e) {
+            $activeUser = null;
+        }
 
-        /** @phpstan-ignore-next-line */
-        if (is_a($user, EshopModelUser::class) && $this->moduleSettings->isPersonalGreetingMode()) {
-            $greeting = $user->getPersonalGreeting();
-            $tracker = $this->trackerRepository->getTrackerByUserId($user->getId());
+        if (
+            $activeUser instanceof UserInterface
+            && !empty($activeUser->getId())
+            && $this->greetingSettings->isPersonalGreetingMode()
+        ) {
+            $greeting = $activeUser->getPersonalGreeting();
+            $tracker = $this->trackerRepository->getTrackerByUserId($activeUser->getId());
             $counter = $tracker->getCount();
         }
 
@@ -74,12 +84,8 @@ public function render()
      */
     public function updateGreeting(): void
     {
-        /** @var EshopModelUser $user */
-        $user = $this->getUser();
-
-        /** @phpstan-ignore-next-line */
-        if (is_a($user, EshopModelUser::class) && $this->moduleSettings->isPersonalGreetingMode()) {
-            $this->greetingService->saveGreeting($user);
+        if ($this->greetingSettings->isPersonalGreetingMode()) {
+            $this->greetingService->saveGreetingForCurrentUser($this->saveGreetingRequest->getGreetingMessage());
         }
     }
 }

src/Greeting/Exception/UserNotLoggedIn.php

@@ -0,0 +1,14 @@
+<?php
+
+/**
+ * Copyright © OXID eSales AG. All rights reserved.
+ * See LICENSE file for license details.
+ */
+
+declare(strict_types=1);
+
+namespace OxidEsales\ExamplesModule\Greeting\Exception;
+
+class UserNotLoggedIn extends \Exception
+{
+}

…ting/Infrastructure/UserModelFactory.php …rastructure/Factory/UserModelFactory.phpsrc/Greeting/Infrastructure/UserModelFactory.php renamed to src/Greeting/Infrastructure/Factory/UserModelFactory.php src/Greeting/Infrastructure/UserModelFactory.php renamed to src/Greeting/Infrastructure/Factory/UserModelFactory.php

@@ -7,7 +7,7 @@
 
 declare(strict_types=1);
 
-namespace OxidEsales\ExamplesModule\Greeting\Infrastructure;
+namespace OxidEsales\ExamplesModule\Greeting\Infrastructure\Factory;
 
 use OxidEsales\Eshop\Application\Model\User;