Skeleton v2

Slim 4 / PHP 8.2 upgrade

A keretrendszerünk PHP verzió lépéséhez egy "speciális" Slim 4-en alapuló keretet készítettünk. A projekt célja hogy a meglévő moduljaink a lehető legkisebb változtatással működjenek az új környezetben (PHP 8.2).
A Slim 4 alapelve az volt, hogy minden ami (szerintük) nem a keretrendszer része (Routing, DI container stb...) az kerüljön ki a csomagból és majd a user eldönti hogy mit akar használni.
A megoldás nagyrészt abból állt, hogy a korábbi implementációkat átemeltük a Slim4-es keretbe. Ilyen módon a DI container az betűre ugyan az maradt, ugyanúgy a központi Trait-en keresztül tudjátok elérni.
Másik célkitűzésük volt hogy a saját HTTP/Request és Response dolgaikat PSR-7 kompatibilis megoldásokra cserélték le, ami szép és jó, de a mi esetünkben voltak kellemetlen mellékhatások, pl. a PSR-7 Response nem ismeri a withJSON függvény, amit mi a API végpontoknál előszeretettel használunk. Erre egy külön csomagot csináltak, ami a PSR-7 Response-t "kidekorálja" és kiegészíti a megfelelő függvényekkel (slim/http csomag).

Átállás folyamata:

Nyiss egy új branch-et a masterből (Ne kérj composer installt)
Portainerben indítsd el a konténert
- ** Másold be a referencia saml mappát (ez lehet majd kikerül, ha Johnny megálmodja a 2.0-s verziót), referencia a slim4-8 / master-ben
- A saml/config/authsources.php-ban írd áz az entityID-t a sajátodra
- A korábbi SimpleSAML_Logger::NOTICE class erre változott, a saml confiug.php-ban át kell írni SimpleSAML\Logger::DEBUG
Hozd át a settings.php-dat
Töröld le a comsposer.lock-ot, a composer.json require részét meg ürítsd ki
Composerrel telepítsd az alábbi függőségeket (lehet a konténeren belülről fog csak menni (ssh-docker PROJEKT-BRANCH), a külső composerrel PHP 8.2 alatt voltak gondok)
- Alap csomagok: composer require slim/slim slim/psr7 slim/twig-view slim/http pimple/pimple simplesamlphp/simplesamlphp
- Egyesével pakolgasd fel a projekthez kellő csomagokat, figyelj, mert a FaaZ/PDO-ból alapból a 2.0-t hozza, sok projekt viszont az 1.0-n van
Hozd át a core mappát a referencia projektből (slim4-8)
Módosítsd az index.php-t a public mappában a referencia projektnek megfelelően
A simplesaml vendorból szedd le a cert könyvtárat
A simplesaml 2.0 már másabb konfiggal megy, le kell választani a "régi" központi cuccról. Az app webapp.conf filejában a /simplesaml simlink-et állítsd a vendor-ban lévő simplesaml mappa public almappájára
Módosítsd a composer.json-t hogy a core mappát is töltse be, ne csak az app-ot (autoload szekció, psr-4), ha megvan akkor futtass egy composer dump-autoload-ot
Fésüld át a projektedet és a fenti változásokat vezesd át (route-ok, middleware-ek, dinamikus osztályok)
Teszteld a projekted, minden funkcionlitást, ha hibát látsz, log-ból túrd ki hogy mi az és javítsd (lib verzió ugrás is könnyedén okozhat hibát)

Változások:

Voltak olyan változások amiket nem lehetett / nagyon problémás lett volna áthidalni, ezek:

PHP 8 dinamikus osztály attribútumok

A Trait-nél és sok más helyen is használtuk ezt a megoldást, a példányosított objektumba olyan attribútumokat hoztunk létre ami nem szerepelt a osztály definícióban. Ez PHP 8-ban már nem működik sajnos. Ez volt:

<?php
    namespace App\Traits;
    
    trait CoreTrait {
    
        protected $container;
        protected $options;
    
        public function __construct($container, $options = array())
        {
            $this->container  = $container;
    
            // Options
            foreach ($options as $key => $value) {
                $this->{$key}  = $value;
            }
    
        }
    
        public function __get($property)
        {
            if (isset($this->container->{$property})) {
                return $this->container->{$property};
            }
        }
    
    }

    //használhat
    ...
    $this->kutyafule = 42;
    ...
?>

Ez lett:

<?php

    namespace App\Traits;
    
    trait CoreTrait {

        protected $container;
        protected $options;
    
        public function __construct($container, $options = array())
        {
            $this->container  = $container;
    
            // Options
            foreach ($options as $property => $value) {
                $this->options[$property]  = $value;
            }
    
        }
    
        public function __get($property)
        {
            if (isset($this->container->{$property})) {
                return $this->container->{$property};
            } elseif (isset($this->options[$property])) {
                return $this->options[$property];
            } 
    
            return null;
        }
    
        public function __set($property, $value)
        {
            $this->options[$property]  = $value;
        }
    
        public function jsonResponse($data, $response ) 
        {
            return $response->withJson(["data"=>$data]);
        }

    //használat:
    ...
    $this->kutyafule = 42;

    if ($this->kutyafule) {
        ...
    }
    ...

ALFI/Core

Ez a dinamikus attribútum dolog használva volt az ALFI/Core-ban is, így ebből készül egy 2.0-s változat, jelenleg ha ki akarjátok próbálni, akkor a composer fájlban a dev branch-et kell "kérni" (a dev- előtag jelzi hogy branch-et kérsz, a második dev a branch neve :)):

    ...
    "alfi/core": "dev-dev",
    "slim/twig-view": "^3.4",
    "pimple/pimple": "^3.5",
    "tuupola/slim-jwt-auth": "^3.8",
    ...

Routing group-olás

A Route fájlokban korábban az $app objektumon keresztül definiáltuk a bejegyzéseket és a groupokat is. Ezt kicsit átvariálták és bevezettek egy RouteCollectorProxy class-t
Ez volt:

<?php
    $app->get('/', '@Management\HomeAction:rootSelector')->setName('root');

    $app->group('/idp', function () use ($app) {
        $location = '@Management\IdpAction';
    
        /* Normal endpoints, returning a view */
        $app->get('',                $location . ':index')->setName('idp.index');
        $app->get('/{type}',         $location . ':index')->setName('idp.index.typeselected');
        $app->get('/show/{idp_id}',  $location . ':show')->setName('idp.show');
    
        /* "API" endpoints, returning a JSON response */
        $app->group('/api', function () use ($app, $location) {
            ...
?>

Ez lett:

<?php
    use Slim\Routing\RouteCollectorProxy;
    ...
    $app->get('/', '@Management\HomeAction:rootSelector')->setName('root');

    $app->group('/idp', function (RouteCollectorProxy $group) {
        $location = '@Management\IdpAction';
    
        /* Normal endpoints, returning a view */
        $group->get('',                $location . ':index')->setName('idp.index');
        $group->get('/{type}',         $location . ':index')->setName('idp.index.typeselected');
        $group->get('/show/{idp_id}',  $location . ':show')->setName('idp.show');
    
        /* "API" endpoints, returning a JSON response */
        $group->group('/api', function (RouteCollectorProxy $group) use ($location) {
            ...
    ?>

Route permission-ök

Amennyiben az alkalmazás használja a route permissionöket, az alábbi fájlokat/sorokat is módosítani kell.
Ez volt:

<?php

$app->group('/', function (RouteCollectorProxy $group) 
{
    $group->get   ('index',                                '@Actions\MainAction:index'         )->setName('releases_index');
})->add(new PM($container, ['permission' => ['eventlog:reporter']]));

Ez lett:

<?php

$app->group('/', function (RouteCollectorProxy $group) 
{
    $group->get   ('index',                                '@Actions\MainAction:index'         )->setName('releases_index');
})->add(new PM($container, ['options'=> ['permission' => ['eventlog:reporter']]]));

Továbbá a PermissionsMiddleware.php-ban kell módosítani az elábbi sorokat:
Erről:

<?php

public function __invoke($request, $response, $next)
{
    if (!$this->role->checkRole($this->permission)) 
    {
        return $this->view->render($response, 'error.twig', array(
            'error_header'  => 'Nincs hozzáférésed',
            'error_content' => 'Hozzáférés megtagadva!'
        ));
    }
    $response = $next($request, $response);
    return $response;
}

Erre:

<?php

public function __invoke(Request $request, RequestHandler $handler)
{
    global $app;
    $response = $app->getResponseFactory()->createResponse();
    if (!$this->role->checkRole($this->options['permission'])) 
    {
        return $this->view->render($response, 'error.twig', array(
            'error_header'  => 'Nincs hozzáférésed',
            'error_content' => 'Hozzáférés megtagadva!'
        ));
    }
    return $handler->handle($request);
}

pathFor metódus a router-ben és Twig-ben

A kiszervezési mánia sajnos a Router-t is érintette, eddig a konénerben volt egy router ami tudta a pathFor metódust. A pathFor az a routeParserben volt korábban is, ez volt kivezetve a routerbe mint "szolgálktatás", első körben a pathFor-t átnevezték urlFor-ra és nem vezették ki a routerbe.
A legegyszerűbb megoldás az volt hogy a route parser-t külön kitettem a konténerbe ahonnan bárhol el tudjátok érni.
Ez volt:

<?php
    $modal['modal-body'] = $this->view->fetchBlock('@UserManagement/applications/_modal_application_form.twig', 'body', [
    'data' => $applicationData,
    'form' => [
        'action' => $this->router->pathFor('applications.api.update', ['application_id' => $args['application_id']]),
        'method' => 'PUT'
    ]
]);

Ez lett:

<?php
    $modal['modal-body'] = $this->view->fetchBlock('@UserManagement/applications/_modal_application_form.twig', 'body', [
    'data' => $applicationData,
    'form' => [
        'action' => $this->route_parser->urlFor('applications.api.update', ['application_id' => $args['application_id']]),
        'method' => 'PUT'
    ]
]);
    ...
?>

Twig-ben ez volt:

{{ path_for('routeName', { ... }) }}

Twig-ben ez lett:

{{ url_for('routeName', { ... }) }}

Tömegs lecserélés a VSCode-ban: Ctrl + Shift + H

Middleware-ek

A middleware-eket kicsit átvariálták, korábban az __invoke megkapta a $next objektumot amivel továbblökhette a kérést illetve a DI konténerből le lehetett kérni a View-t amivel tetszőleges twig-et ki tudott renderelni (hiba oldalak).
Az új koncepcióban már egy Handler jön paraméterben, az egyedi hibaoldalak rendereléséhez a global $app-ból lehet kérni Response-t a funkción belül (ha szükséges Twig render miatt).
Ez volt:

<?php
    public function __invoke($request, $response, $next)
    {
        $settings = $this->container->get('settings')['modules'];

        if ($settings['Auth']['enabled']) {
            if (!$this->role->checkRole($this->permission)) {
                return $this->view->render($response, 'errors/403.twig', [
                    'error_header'  => 'Nincs hozzáférésed',
                    'error_content' => 'Hozzáférés megtagadva!'
                ]);
            }
        }

        $response = $next($request, $response);

        return $response;
    }
?>

Ez lett:

<?php
    use Psr\Http\Message\ServerRequestInterface as Request;
    use Psr\Http\Server\RequestHandlerInterface as RequestHandler;
    use Psr\Http\Message\ResponseInterface as Response;
    ...

    public function __invoke(Request $request, RequestHandler $handler): Response
    {
        // újabban itt jön létre response ami kell a twig renderhez
        global $app;
        $response = $app->getResponseFactory()->createResponse();

        $settings = $this->container->get('settings')['modules']['System']['dependencies'];
       
        if ($settings['Auth']['enabled']) {
            if (!$this->role->checkRole($this->options['permission'])) {
                $response = $response->withStatus(403);
                return $this->view->render($response, 'errors/403.twig', [
                    'error_header'  => 'Nincs hozzáférésed',
                    'error_content' => 'Hozzáférés megtagadva!'
                ]);
            }
        }

        return $handler->handle($request);
    }
?>

@ használata a kivételek elfedésére

A PHP 8.0-tól már nem "némítja" el a Fatal Error kategóriába eső dolgokat.

In PHP 8.0, the @ operator does not suppress certain types of errors that were silenced prior to PHP 8.0. This includes the following types of errors:

E_ERROR - Fatal run-time errors.
E_CORE_ERROR - Fatal errors occurred in PHP's initial startup.
E_COMPILE_ERROR - Fatal compile-time errors (from Zend engine).
E_USER_ERROR - User-triggered errors with trigger_error() function.
E_RECOVERABLE_ERROR - Catchable fatal error.
E_PARSE - Compile-time parse errors.

Ez már nem megy át hiba nélkül:

<?php
    $ret['columns'][$key] = array(
        'name' => @$cache['columns'][$key]?$cache['columns'][$key]:$key,
        'icon' => $item
    );
    if (@$cache[$key][$data[$key]]) {
        $data[$key.'_real'] = $data[$key];
        $data[$key]         = $cache[$key][$data[$key]];
    }
?>

Action return bug

A beépülő könyvtárakat átszervezte a Slim, így állt elő egy bosszantó bug:

<?php
    // Modules/Dashboard/Actions/DashboardAction.php
    //ez volt
    $response->getBody()->write( $html );

    //ez PHP 8.2 alatt egy int-el tér vissza, a write által leírt byte-ok száma, ami elkaszálja a middleware-eket
    //ez a fix:
    $response->getBody()->write( $html );
    return $response;
?>

Cache bug

Hibalog: ErrorException: Only variables should be passed by reference

<?php
    // Modules/Dashboard/Actions/DashboardAction.php
    //ez volt
    case 'update':
        return @reset($this->predis->transaction()->get($name .'_update')->execute());
        
        break;

    //ez a fix:
    case 'update':
        $var = $this->predis->transaction()->get($name .'_update')->execute();
        return @reset($var);
        
        break;
    //itt tesztelni kellene hogy a @ milyen hibákat nyelt el eddig...
?>

TwigView

A Twig integrációt is erősen érintette a frissítés, korábban volt egy gyári Twig Extension, ezt az új változatban már nem kell kézzel példányosítani.
A saját extensionban megváltoztak a névtér hivatkozások:
Ebből: new \Twig_SimpleFilter('number_afix',
Ez lett new \Twig\TwigFilter('number_afix',
Ugyanez érvényesült a Twig_SimpleFunction-nál, ő Twig\TwigFunction lett. A frissítés leginkább a konténerben lévő dolgokat kavarta meg, több beépülő függvény használt olyan függvényeket amik átkerültek máshova
(pl. pathFor, getBaseUrl). A végleges verió még tesztelés alatt van, itt majd érdemes lesz a System/View modult teljes egészében lecserélni a megadott frissített modulra.