PoC new Module system to SSP 2.0 by sgomez · Pull Request #1294 · simplesamlphp/simplesamlphp

sgomez · 2020-02-26T14:27:59Z

This PR is related to #1286 issue.

Changes:

www/new.php is created to load new kernel. Also console has been changed to load the new kernel.
Old kernel renamed to ModuleKernel.php to indicate than only works with one module.
New kernel to load all modules and core application.

Instructions:

APP_ENV=dev environment variable must be configured
Run composer install. This will install [a demo module](https://packagist.org/packages/sgomez/simplesamlphp-module-expirycheck.
Copy modules.php inside config-templates to config directory.

I have this authsource to check the module:

    'example-static' => [
        'exampleauth:StaticSource',
        'uid' => ['testuser'],
        'eduPersonAffiliation' => ['member', 'employee'],
        'cn' => ['Test User'],
        'schacExpiryDate' => '20051231235959Z'
    ],

And this filter:

        10 => array(
            'class' => SimpleSAML\Modules\ExpiryCheckModule\Auth\Process\ExpiryDate::class,
            'netid_attr' => 'eduPersonPrincipalName',
            'expirydate_attr' => 'schacExpiryDate',
            'warndaysbefore' => '60',
            'date_format' => 'd.m.Y', # php date syntax
        ),

The idea is to run the ExpiredController and load templates and translation from vendor without install the modules inside simplesamlphp directory.

More explanations in the code.

sgomez · 2020-02-26T15:38:20Z

@@ -0,0 +1,11 @@
+<?php
+
+return [


This file returns all modules/bundles to be loaded. The kernel supports environments, so we can indicate if they should be loaded in all or just in a few of them.

sgomez · 2020-02-26T15:42:12Z

+
+return [
+    // Don't remove this bundles
+    Symfony\Bundle\FrameworkBundle\FrameworkBundle::class => ['all' => true],


Probably FrameworkBundle is too huge to be used and we can create a custom one.

sgomez · 2020-02-26T15:43:27Z

-    /**
-     * @param string $module
-     */
-    public function __construct(string $module)


New Kernel is not just for one module.

sgomez · 2020-02-26T15:45:53Z

-        $confDir = Module::getModuleDir($this->module) . '/routing/services';
-        if (is_dir($confDir)) {
-            $loader->load($confDir . '/**/*' . self::CONFIG_EXTS, 'glob');
+        foreach ($this->bundles as $bundle) {


This iterator search in all bundles the ones that are SSP Modules and checks if they have a routes directory (and load the route files). The module name is used a prefix to the url.

sgomez · 2020-02-26T15:47:19Z

-    }
+        $confDir = __DIR__ . '/Resources/config';

+        $routes->import($confDir.'/{routes}/'.$this->environment.'/**/*'.self::CONFIG_EXTS, '/', 'glob');


Load routes required by simplesaml to work. For example the route required to have the debug toolbar.

sgomez · 2020-02-26T15:48:34Z

-     * @return void
-     */
-    private function registerModuleControllers(ContainerBuilder $container): void
+    protected function configureContainer(ContainerBuilder $container, LoaderInterface $loader)


Load services required by the core of simplesaml (modules services are loaded inside the Module loader class).

sgomez · 2020-02-26T15:50:45Z

+use Symfony\Component\DependencyInjection\Loader\DirectoryLoader;
+use Symfony\Component\HttpKernel\Bundle\Bundle;
+
+abstract class Module extends Bundle


This abstract class extends from Symfony Bundle abstract class. So a module is a bundle. Probably we can create a thin abstract class because we don't require all the logic inside the base class.

sgomez · 2020-02-26T15:52:08Z

+{
+    abstract public function getShortName(): string;
+
+    public function build(ContainerBuilder $container)


This method is called when the cache is warmed. Here we can define the services this module will use.

sgomez · 2020-02-26T15:54:49Z

+     * @param ContainerBuilder $container
+     * @return void
+     */
+    private function registerModuleControllers(ContainerBuilder $container): void


We register controller services. The idea is to create similar methods for each service we want to define automatically (hooks/events, admin menus, etc.). The possibility to use a services.yml to load custom services will be available. But this methods exists to do the module development easiest.

sgomez · 2020-02-26T15:58:41Z

        $baseDir = $this->configuration->getBaseDir();
        if (is_null($module)) {
-            $file = $baseDir . 'www/assets/' . $asset;
+            $file = $baseDir . 'www/' . $asset;


I use symfony/asset module that implements asset function in twig. This modification is to have the same behaviour in the old a new way to read templates.

sgomez · 2020-02-26T16:03:05Z

Translations in symfony supports a lot of loaders (po, yaml, xliff, csv, ...). Gettext loader (po files) does not require gettext php module (apparently, I will investigate more about this).

There are a difference. The structure of translations files change from locales/LANGCODE/LC_MESSAGES/module.po to translations/module.LANGCODE.po. With a script is easy to move files. But trans function in yaml files requires that we indicate the module if it is differente from default (messages).

tvdijen · 2020-05-01T17:10:03Z

Oops, I did not intend to do this, but @sgomez should this be merged at some point? Let's not let this go to waste..

sgomez · 2020-05-04T11:45:49Z

Hi @tvdijen

This is just a PoC. This requires a lot of discussion because is a huge change in the way modules are loaded.

Required to run the tests for simplesamlphp/simplesamlphp#1294

tvdijen

The RouteCollectionBuilder was deprecated by Symfony in favour of the RoutingConfigurator.
Unfortunately I can't get it to work with the new class and I don't know what to do with the $prefix variable.

sgomez commented Feb 26, 2020

View reviewed changes

tvdijen marked this pull request as ready for review May 1, 2020 17:08

tvdijen force-pushed the master branch 3 times, most recently from 1c686ab to eb20457 Compare August 17, 2020 20:43

tvdijen force-pushed the module-base branch from f9cf4d5 to f8d9f8b Compare August 22, 2020 18:50

tvdijen force-pushed the module-base branch from f8d9f8b to ecc4716 Compare March 11, 2021 23:23

tvdijen force-pushed the master branch 2 times, most recently from 08ebb9c to 64fca25 Compare July 2, 2021 14:12

sgomez and others added 2 commits September 8, 2021 17:24

PoC new Module system to SSP 2.0

0466937

Fix syntax

51be57c

tvdijen force-pushed the module-base branch from ecc4716 to 51be57c Compare September 8, 2021 15:25

Restore config-file that got lost during rebasing

f8439e6

tvdijen added a commit to tvdijen/simplesamlphp-module-expirycheck that referenced this pull request Sep 8, 2021

Update composer.json

845a734

Required to run the tests for simplesamlphp/simplesamlphp#1294

tvdijen mentioned this pull request Sep 8, 2021

Update composer.json sgomez/simplesamlphp-module-expirycheck#1

Open

tvdijen requested changes Sep 8, 2021

View reviewed changes

tvdijen force-pushed the master branch 2 times, most recently from 7a53fc8 to d73ae47 Compare September 26, 2021 13:03

tvdijen force-pushed the master branch 11 times, most recently from 7b173cf to 3326beb Compare March 20, 2023 22:59

tvdijen force-pushed the master branch 2 times, most recently from 8ac729b to a16cf6e Compare April 25, 2023 08:33

tvdijen force-pushed the master branch 2 times, most recently from fc454de to 7ac76ae Compare May 3, 2023 08:31

tvdijen force-pushed the master branch 6 times, most recently from 29f7b69 to 1a911ce Compare May 12, 2023 16:07

tvdijen force-pushed the master branch 3 times, most recently from c7c8357 to fdbe001 Compare June 12, 2023 14:28

tvdijen force-pushed the master branch 6 times, most recently from b639fc0 to a6df6e9 Compare July 19, 2023 12:19

		@@ -0,0 +1,11 @@
		<?php

		return [

Conversation

sgomez commented Feb 26, 2020

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

sgomez commented Feb 26, 2020

Uh oh!

tvdijen commented May 1, 2020

Uh oh!

sgomez commented May 4, 2020

Uh oh!

tvdijen left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants