Refactoring

Author: bjoern-hempel

.env

@@ -75,35 +75,51 @@ NETWORK_NAME_TRAEFIK_PUBLIC_LOCAL=traefik
 # Traefik network name (public)
 NETWORK_NAME_TRAEFIK_PUBLIC_PRODUCTION=traefik-public
 
-# https port
+# https port (is usually not changed)
+PORT_HTTP=80
+
+# https port (is usually not changed)
 PORT_HTTPS=443
 
-# Internal docker adminer http port
+# Internal docker adminer http port (is usually not changed)
+PORT_MYSQL_INTERNAL=3306
+
+# Internal docker adminer http port (is usually not changed)
 PORT_HTTP_ADMINER_INTERNAL=8080
 
-# Internal docker mailhog http port
+# Internal docker mailhog http port (is usually not changed)
 PORT_HTTP_MAILHOG_INTERNAL=8025
 
-# Internal docker mailhog smtp port
+# Internal docker mailhog smtp port (is usually not changed)
 PORT_SMTP_MAILHOG_INTERNAL=1025
 
 # Expose api https port (To bypass the Traefik proxy or if it is not installed)
-PORT_HTTPS_API_EXPOSE=44443
+PORT_HTTP_APP_EXPOSE=5080
+
+# Expose api https port (To bypass the Traefik proxy or if it is not installed)
+PORT_HTTPS_APP_EXPOSE=5043
+
+# Expose db (mysql) port (External db app)
+# Attention for PORT_DB_MAIN_EXPOSE: Please also make changes to the DOCTRINE_DB_PORT variable.
+PORT_DB_MAIN_EXPOSE=5006
+
+# Expose db (mysql) port (External db app)
+PORT_DB_TEST_EXPOSE=5007
 
 # Expose adminer http port (To bypass the Traefik proxy or if it is not installed)
-PORT_HTTP_ADMINER_EXPOSE=8081
+PORT_HTTP_ADMINER_EXPOSE=5081
 
 # Expose mailhog http port (To bypass the Traefik proxy or if it is not installed)
-PORT_HTTP_MAILHOG_EXPOSE=8082
+PORT_HTTP_MAILHOG_EXPOSE=5082
 
 # Expose mailhog smtp port (To bypass the Traefik proxy or if it is not installed)
-PORT_SMTP_MAILHOG_EXPOSE=1025
+PORT_SMTP_MAILHOG_EXPOSE=5025
 
 ###< General Config / Docker Compose Settings ###
 
 ###> symfony/framework-bundle ###
-APP_ENV=dev
-APP_DEBUG=1
+APP_ENV=prod
+APP_DEBUG=0
 APP_SECRET=3b337448a0100c94f60efc26437e0a57
 ###< symfony/framework-bundle ###
 
@@ -115,11 +131,12 @@ PHP_VERSION_HOSTNAME=8-1-11
 ###< PHP Configuration ###
 
 ###> Docker Configuration: MySQL secrets and configurations
+MYSQL_SERVER_HOST=127.0.0.1
 MYSQL_SERVER_ROOT_USER=root
 MYSQL_SERVER_ROOT_PASSWORD=secret-pass
-MYSQL_SERVER_DB=hdb
-MYSQL_SERVER_DB_TEST=hdb-test
-MYSQL_SERVER_PORT=3306
+MYSQL_SERVER_DB=pavb
+MYSQL_SERVER_DB_TEST=pavb-test
+MYSQL_SERVER_PORT=${PORT_MYSQL_INTERNAL}
 MYSQL_SERVER_VERSION=8.0
 MYSQL_SERVER_DRIVER=pdo_mysql
 ###< Docker Configuration: MySQL secrets and configurations
@@ -131,12 +148,6 @@ MAIL_SERVER_HOST=localhost
 MAIL_SERVER_PORT=1025
 ###< Docker Configuration: Mail secrets and configurations
 
-###> Docker Configuration: General configurations
-# Attention for EXPOSE_MYSQL_PORT: Please also make changes to the DOCTRINE_DB_PORT variable.
-EXPOSE_MYSQL_PORT=3336
-EXPOSE_MYSQL_PORT_TEST=3337
-###< Docker Configuration: General configurations
-
 ##> doctrine/doctrine-bundle (mysql) ###
 # Format described at https://www.doctrine-project.org/projects/doctrine-dbal/en/latest/reference/configuration.html#connecting-using-a-url
 # IMPORTANT: You MUST configure your server version, either here or in config/packages/doctrine.yaml
@@ -145,32 +156,15 @@ DOCTRINE_DB_VERSION=${MYSQL_SERVER_VERSION}
 DOCTRINE_DB_PATH=
 DOCTRINE_DB_NAME=${MYSQL_SERVER_DB}
 DOCTRINE_DB_HOST=${ENV_DB_HOST:-127.0.0.1}
-# Workaround for default port for DOCTRINE_DB_PORT: Because ${ENV_DB_PORT:-${EXPOSE_MYSQL_PORT}} does not work
-DOCTRINE_DB_PORT=${ENV_DB_PORT:-3336}
+# Workaround for default port for DOCTRINE_DB_PORT: Because ${ENV_DB_PORT:-${PORT_DB_MAIN_EXPOSE}} does not work
+DOCTRINE_DB_PORT=${ENV_DB_PORT:-50306}
 DOCTRINE_DB_USER=${MYSQL_SERVER_ROOT_USER}
 DOCTRINE_DB_PASS=${MYSQL_SERVER_ROOT_PASSWORD}
 DOCTRINE_DB_SSL_CA=
 DOCTRINE_DB_SSL_VERIFY_SERVER_CERT=false
 DOCTRINE_DB_INIT_COMMAND="SET NAMES utf8"
 ###< doctrine/doctrine-bundle (mysql) ###
 
-##> doctrine/doctrine-bundle (mysql) ###
-# Format described at https://www.doctrine-project.org/projects/doctrine-dbal/en/latest/reference/configuration.html#connecting-using-a-url
-# IMPORTANT: You MUST configure your server version, either here or in config/packages/doctrine.yaml
-DOCTRINE_DB_DRIVER_SQLITE=${MYSQL_SERVER_DRIVER}
-DOCTRINE_DB_VERSION_SQLITE=${MYSQL_SERVER_VERSION}
-DOCTRINE_DB_PATH_SQLITE=
-DOCTRINE_DB_NAME_SQLITE=${MYSQL_SERVER_DB}
-DOCTRINE_DB_HOST_SQLITE=${ENV_DB_HOST:-127.0.0.1}
-# Workaround for default port for DOCTRINE_DB_PORT: Because ${ENV_DB_PORT:-${EXPOSE_MYSQL_PORT}} does not work
-DOCTRINE_DB_PORT_SQLITE=${ENV_DB_PORT:-3336}
-DOCTRINE_DB_USER_SQLITE=${MYSQL_SERVER_ROOT_USER}
-DOCTRINE_DB_PASS_SQLITE=${MYSQL_SERVER_ROOT_PASSWORD}
-DOCTRINE_DB_SSL_CA_SQLITE=
-DOCTRINE_DB_SSL_VERIFY_SERVER_CERT_SQLITE=false
-DOCTRINE_DB_INIT_COMMAND_SQLITE="SET NAMES utf8"
-###< doctrine/doctrine-bundle (mysql) ###
-
 ###> own variables ###
 PROJECT_NAME="PHP Api Version Bundle"
 PROJECT_DESCRIPTION="Provides the base API plattform functionality."
@@ -179,7 +173,7 @@ API_COUNTRY_CODE=de_DE
 ###< own variables ###
 
 ###> table-dumper (local docker settings) ###
-MYSQLDUMP_DATABASE_URL=mysql://root:secret-pass@127.0.0.1:3336/hdb?serverVersion=8.0
+MYSQLDUMP_DATABASE_URL=mysql://${MYSQL_SERVER_ROOT_USER}:${MYSQL_SERVER_ROOT_PASSWORD}@${MYSQL_SERVER_HOST}:${MYSQL_SERVER_PORT}/${MYSQL_SERVER_DB}?serverVersion=${MYSQL_SERVER_VERSION}
 MYSQLDUMP_IGNORED_TABLES=
 #MYSQLDUMP_FILTERED_TABLES=
 #MYSQLDUMP_TABLES_NO_DATA=
@@ -191,5 +185,5 @@ CORS_ALLOW_ORIGIN='^https?://(php-api-version-bundle.ixnode.de|api-version.local
 ###< nelmio/cors-bundle ###
 
 ###> symfony/mailer ###
-MAILER_DSN=smtp://localhost:1025
+MAILER_DSN=smtp://${MAIL_SERVER_PORT}:${MAIL_SERVER_PORT}
 ###< symfony/mailer ###

.env.test

@@ -14,11 +14,11 @@ DOCTRINE_DB_VERSION=${MYSQL_SERVER_VERSION}
 DOCTRINE_DB_PATH="%kernel.project_dir%/var/app.db"
 DOCTRINE_DB_NAME=${MYSQL_SERVER_DB}
 DOCTRINE_DB_HOST=${ENV_DB_HOST:-127.0.0.1}
-# Workaround for default port for DOCTRINE_DB_PORT: Because ${ENV_DB_PORT:-${EXPOSE_MYSQL_PORT}} does not work
-DOCTRINE_DB_PORT=${ENV_DB_PORT:-3336}
+# Workaround for default port for DOCTRINE_DB_PORT: Because ${ENV_DB_PORT:-${PORT_DB_MAIN_EXPOSE}} does not work
+DOCTRINE_DB_PORT=${ENV_DB_PORT:-50306}
 DOCTRINE_DB_USER=${MYSQL_SERVER_ROOT_USER}
 DOCTRINE_DB_PASS=${MYSQL_SERVER_ROOT_PASSWORD}
 DOCTRINE_DB_SSL_CA=
 DOCTRINE_DB_SSL_VERIFY_SERVER_CERT=false
-DOCTRINE_DB_INIT_COMMAND=
+DOCTRINE_DB_INIT_COMMAND="SET NAMES utf8"
 ###< doctrine/doctrine-bundle (sqlite) ###

composer.json

@@ -96,8 +96,9 @@
 
         "ixno:header": "bin/header/ixno",
 
-        "db:initialize:test": "bin/header/dbinit 'bin/console db:reinitialize --format=text --env=test' 'Test-DB Initialization'",
-        "db:initialize:main": "for dump in fixtures/db/*.sql; do mysql -h127.0.0.1 -P3336 -uroot -psecret-pass --default-character-set=utf8 opa < \"$dump\"; done",
+        "db:initialize:test:fixture": "bin/header/dbinit 'bin/console db:reinitialize --format=text --env=test' 'Test-DB Initialization'",
+        "db:initialize:main:fixture": "bin/header/dbinit 'bin/console db:reinitialize --format=text --env=dev' 'Test-DB Initialization'",
+        "db:initialize:main:sql": "for dump in fixtures/db/*.sql; do mysql -h127.0.0.1 -P3336 -uroot -psecret-pass --default-character-set=utf8 opa < \"$dump\"; done",
 
         "doc:build:schema": "bin/console validator:schema data/json/api/private/power/private.power.json --reformat",
         "doc:build:endpoint": "bin/console document-generator:api --generate",
@@ -126,19 +127,19 @@
         "phpunit:functional:debug": "bin/header/phpunit 'PHPUNIT_DEBUG=1 vendor/bin/phpunit -d memory_limit=512M --configuration .phpunit/phpunit.functional.xml' 'Functional'",
         "phpunit:unit:debug": "bin/header/phpunit 'PHPUNIT_DEBUG=1 vendor/bin/phpunit -d memory_limit=512M --configuration .phpunit/phpunit.unit.xml' 'Unit'",
         "phpunit:all": [
-            "@db:initialize:test",
+            "@db:initialize:test:fixture",
             "@phpunit:unit",
             "@phpunit:functional",
             "@phpunit:api"
         ],
         "phpunit:all:coverage": [
-            "@db:initialize:test",
+            "@db:initialize:test:fixture",
             "@phpunit:unit:coverage",
             "@phpunit:functional:coverage",
             "@phpunit:api:coverage"
         ],
         "phpunit:all:debug": [
-            "@db:initialize:test",
+            "@db:initialize:test:fixture",
             "@phpunit:unit:debug",
             "@phpunit:functional:debug",
             "@phpunit:api:debug"
@@ -255,8 +256,9 @@
         ".test:hardcore": " ",
         ".test:most": " ",
 
-        "db:initialize:test": "Initializes the test db.",
-        "db:initialize:main": "Initializes the main db.",
+        "db:initialize:test:fixture": "Initializes the test db via fixtures.",
+        "db:initialize:main:fixture": "Initializes the main db via fixtures.",
+        "db:initialize:main:sql": "Initializes the main db via sql dumps.",
 
         "doc:build:schema": "Builds schema documents.",
         "doc:build:endpoint": "Builds endpoint documents.",

composer.lock

@@ -12,14 +12,14 @@ doctrine:
                 user: "%env(resolve:DOCTRINE_DB_USER)%"
                 password: "%env(resolve:DOCTRINE_DB_PASS)%"
             sqlite:
-                driver: "%env(resolve:DOCTRINE_DB_DRIVER_SQLITE)%"
-                server_version: "%env(resolve:DOCTRINE_DB_VERSION_SQLITE)%"
-                path: "%env(resolve:DOCTRINE_DB_PATH_SQLITE)%"
-                dbname: "%env(resolve:DOCTRINE_DB_NAME_SQLITE)%"
-                host: "%env(resolve:DOCTRINE_DB_HOST_SQLITE)%"
-                port: "%env(resolve:DOCTRINE_DB_PORT_SQLITE)%"
-                user: "%env(resolve:DOCTRINE_DB_USER_SQLITE)%"
-                password: "%env(resolve:DOCTRINE_DB_PASS_SQLITE)%"
+                driver: "%env(resolve:DOCTRINE_DB_DRIVER)%"
+                server_version: "%env(resolve:DOCTRINE_DB_VERSION)%"
+                path: "%env(resolve:DOCTRINE_DB_PATH)%"
+                dbname: "%env(resolve:DOCTRINE_DB_NAME)%"
+                host: "%env(resolve:DOCTRINE_DB_HOST)%"
+                port: "%env(resolve:DOCTRINE_DB_PORT)%"
+                user: "%env(resolve:DOCTRINE_DB_USER)%"
+                password: "%env(resolve:DOCTRINE_DB_PASS)%"
 
     orm:
         auto_generate_proxy_classes: true

config/packages/doctrine.yaml

@@ -1,4 +1,4 @@
 api_platform:
     resource: .
     type: api_platform
-    prefix: /api
+    prefix: '%api.base_url%'

config/routes/api_platform.yaml

@@ -4,6 +4,9 @@
 # Put parameters here that don't need to change on each machine where the app is deployed
 # https://symfony.com/doc/current/best_practices.html#use-parameters-for-application-configuration
 parameters:
+    api.base_url: '%env(resolve:API_BASE_URL)%'
+    api.cors_allow_origin: '%env(CORS_ALLOW_ORIGIN)%'
+    api.country_code: '%env(resolve:API_COUNTRY_CODE)%'
 
 services:
     # default configuration for services in *this* file

config/services.yaml

@@ -62,7 +62,7 @@ services:
   # Nginx to serve the app.
   nginx:
     ports:
-      - "${PORT_HTTPS_API_EXPOSE}:${PORT_HTTPS}"
+      - "${PORT_HTTPS_APP_EXPOSE}:${PORT_HTTPS}"
     networks:
       - network-internal
       - network-traefik
@@ -88,10 +88,15 @@ services:
       # network
       - "traefik.docker.network=${NETWORK_NAME_TRAEFIK_PUBLIC_LOCAL}"
 
-  # MySQL 5.7.39 Server
+  # MySQL 8.0.31 Server
   database:
     ports:
-      - ${EXPOSE_MYSQL_PORT}:${MYSQL_SERVER_PORT}
+      - ${PORT_DB_MAIN_EXPOSE}:${MYSQL_SERVER_PORT}
+
+  # MySQL 8.0.31 Server
+  database-test:
+    ports:
+      - ${PORT_DB_TEST_EXPOSE}:${MYSQL_SERVER_PORT}
 
   # Adminer MySQL Client
   adminer:

docker-compose.override.yml

@@ -132,7 +132,8 @@ services:
       ENV_MAIL_SERVER_HOST: "${MAIL_SERVER_HOST}"
       ENV_MAIL_SERVER_PORT: "${MAIL_SERVER_PORT}"
       # some ports
-      ENV_EXPOSE_API_HTTPS_PORT: "${PORT_HTTPS_API_EXPOSE}"
+      ENV_EXPOSE_APP_HTTPS_PORT: "${PORT_HTTPS_APP_EXPOSE}"
+      ENV_EXPOSE_APP_HTTP_PORT: "${PORT_HTTP_APP_EXPOSE}"
     depends_on:
       - database
       - database-test

docker-compose.yml

@@ -0,0 +1,43 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * This file is part of the ixnode/php-api-version-bundle project.
+ *
+ * (c) Björn Hempel <https://www.hempel.li/>
+ *
+ * For the full copyright and license information, please view the LICENSE.md
+ * file that was distributed with this source code.
+ */
+
+use Rector\CodeQuality\Rector\Class_\InlineConstructorDefaultToPropertyRector;
+use Rector\Config\RectorConfig;
+use Rector\Doctrine\Set\DoctrineSetList;
+use Rector\Php80\Rector\FunctionLike\MixedTypeRector;
+use Rector\Php80\Rector\FunctionLike\UnionTypesRector;
+use Rector\Set\ValueObject\LevelSetList;
+use Rector\Symfony\Set\SensiolabsSetList;
+use Rector\Symfony\Set\SymfonySetList;
+
+return static function (RectorConfig $rectorConfig): void {
+    $rectorConfig->paths([
+        __DIR__ . '/src',
+        __DIR__ . '/tests',
+    ]);
+
+    $rectorConfig->rule(InlineConstructorDefaultToPropertyRector::class);
+
+    $rectorConfig->sets([
+        LevelSetList::UP_TO_PHP_81,
+        DoctrineSetList::ANNOTATIONS_TO_ATTRIBUTES,
+        SymfonySetList::ANNOTATIONS_TO_ATTRIBUTES,
+        SensiolabsSetList::FRAMEWORK_EXTRA_61,
+    ]);
+
+    /* Ignore additional type hints (param, return) within doc blocks */
+    $rectorConfig->skip([
+        MixedTypeRector::class,
+        UnionTypesRector::class,
+    ]);
+};