Merge branch 'turbo-mercure' into turbo

* turbo-mercure:
  run yarn tests for all workspaces
  -
  -
  -
  fix cs
  fix build
  re-add main package.json
  Fix JS
  Move Mercure integration to a dedicated bridge

Author: nicolas-grekas

.php_cs.dist

@@ -24,6 +24,6 @@ return PhpCsFixer\Config::create()
             ->append([__FILE__])
             ->notPath('#/Fixtures/#')
             ->notPath('#/app/var/#')
-            ->notPath('Turbo/Broadcast.php') // Need https://github.com/FriendsOfPHP/PHP-CS-Fixer/issues/4702
+            ->notPath('Turbo/Attribute/Broadcast.php') // Need https://github.com/FriendsOfPHP/PHP-CS-Fixer/issues/4702
     )
 ;

package.json

@@ -1,7 +1,7 @@
 {
     "private": true,
     "workspaces": [
-        "src/*/Resources/assets"
+        "src/**/Resources/assets"
     ],
     "scripts": {
         "build": "yarn workspaces run build",

src/Chartjs/composer.json

@@ -39,7 +39,7 @@
     },
     "extra": {
         "branch-alias": {
-            "dev-main": "1.1-dev"
+            "dev-main": "1.3-dev"
         },
         "thanks": {
             "name": "symfony/ux",

src/Cropperjs/composer.json

@@ -42,7 +42,7 @@
     },
     "extra": {
         "branch-alias": {
-            "dev-main": "1.1-dev"
+            "dev-main": "1.3-dev"
         },
         "thanks": {
             "name": "symfony/ux",

src/Dropzone/composer.json

@@ -40,7 +40,7 @@
     },
     "extra": {
         "branch-alias": {
-            "dev-main": "1.1-dev"
+            "dev-main": "1.3-dev"
         },
         "thanks": {
             "name": "symfony/ux",

src/LazyImage/composer.json

@@ -41,7 +41,7 @@
     },
     "extra": {
         "branch-alias": {
-            "dev-main": "1.1-dev"
+            "dev-main": "1.3-dev"
         },
         "thanks": {
             "name": "symfony/ux",

src/Swup/composer.json

@@ -19,7 +19,7 @@
     ],
     "extra": {
         "branch-alias": {
-            "dev-main": "1.1-dev"
+            "dev-main": "1.3-dev"
         },
         "thanks": {
             "name": "symfony/ux",

src/Turbo/Attribute/Broadcast.php

@@ -11,7 +11,7 @@
 
 namespace Symfony\UX\Turbo\Attribute;
 
-use Symfony\UX\Turbo\Mercure\Broadcaster;
+use Symfony\UX\Turbo\Bridge\Mercure\Broadcaster;
 
 /**
  * Marks the entity as broadcastable.

src/Turbo/Mercure/Broadcaster.php renamed to src/Turbo/Bridge/Mercure/Broadcaster.php

@@ -9,7 +9,7 @@
  * file that was distributed with this source code.
  */
 
-namespace Symfony\UX\Turbo\Mercure;
+namespace Symfony\UX\Turbo\Bridge\Mercure;
 
 use Symfony\Component\Mercure\HubInterface;
 use Symfony\Component\Mercure\Update;

src/Turbo/Bridge/Mercure/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2021 Fabien Potencier
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is furnished
+to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

src/Turbo/Resources/assets/.babelrc renamed to src/Turbo/Bridge/Mercure/Resources/assets/.babelrc

@@ -0,0 +1,42 @@
+{
+    "name": "@symfony/ux-turbo-mercure",
+    "description": "Mercure integration for Symfony UX Turbo",
+    "license": "MIT",
+    "private": true,
+    "version": "0.1.0",
+    "symfony": {
+        "controllers": {
+            "turbo-stream": {
+                "main": "dist/turbo_stream_controller.js",
+                "webpackMode": "eager",
+                "fetch": "eager",
+                "enabled": true
+            }
+        }
+    },
+    "scripts": {
+        "build": "babel src -d dist",
+        "test": "babel src -d dist && jest",
+        "lint": "eslint src test"
+    },
+    "peerDependencies": {
+        "@hotwired/turbo": "^7.0.0-beta.4",
+        "stimulus": "^2.0.0"
+    },
+    "devDependencies": {
+        "@babel/cli": "^7.12.1",
+        "@babel/core": "^7.12.3",
+        "@babel/plugin-proposal-class-properties": "^7.12.1",
+        "@babel/preset-env": "^7.12.7",
+        "@hotwired/turbo": "^7.0.0-beta.4",
+        "@symfony/stimulus-testing": "^1.1.0",
+        "jest-canvas-mock": "^2.3.0",
+        "stimulus": "^2.0.0"
+    },
+    "jest": {
+        "testRegex": "test/.*\\.test.js",
+        "setupFilesAfterEnv": [
+            "./test/setup.js"
+        ]
+    }
+}

src/Turbo/Resources/assets/dist/turbo_stream_mercure_controller.js renamed to src/Turbo/Bridge/Mercure/Resources/assets/dist/turbo_stream_controller.js

@@ -12,15 +12,15 @@
 import { Application } from 'stimulus';
 import { getByTestId } from '@testing-library/dom';
 import { clearDOM, mountDOM } from '@symfony/stimulus-testing';
-import TurboStreamController from '../src/turbo_stream_mercure_controller.js';
+import TurboStreamController from '../src/turbo_stream_controller.js';
 
 const startStimulus = () => {
     const application = Application.start();
-    application.register('symfony--ux-turbo--turbo-stream-mercure', TurboStreamController);
+    application.register('symfony--ux-turbo-mercure--turbo-stream', TurboStreamController);
 };
 
 /* eslint-disable no-undef */
-describe('TurboStreamMercureController', () => {
+describe('TurboStreamController', () => {
     let container;
 
     beforeEach(() => {
@@ -31,7 +31,7 @@ describe('TurboStreamMercureController', () => {
         }));
 
         container = mountDOM(
-            '<div data-testid="turbo-stream-mercure" data-controller="symfony--ux-turbo--turbo-stream-mercure" data-symfony--ux-turbo--turbo-stream-mercure-hub-value="https://example.com/.well-known/mercure" data-symfony--ux-turbo--turbo-stream-mercure-topic-value="foo"></div>'
+            '<div data-testid="turbo-stream-mercure" data-controller="symfony--ux-turbo-mercure--turbo-stream" data-symfony--ux-turbo-mercure--turbo-stream-hub-value="https://example.com/.well-known/mercure" data-symfony--ux-turbo-mercure--turbo-stream-topic-value="foo"></div>'
         );
     });
 
@@ -44,7 +44,7 @@ describe('TurboStreamMercureController', () => {
 
         // smoke test
         expect(getByTestId(container, 'turbo-stream-mercure')).toHaveAttribute(
-            'data-symfony--ux-turbo--turbo-stream-mercure-topic-value',
+            'data-symfony--ux-turbo-mercure--turbo-stream-topic-value',
             'foo'
         );
     });

src/Turbo/Bridge/Mercure/Resources/assets/package.json

@@ -9,7 +9,7 @@
  * file that was distributed with this source code.
  */
 
-namespace Symfony\UX\Turbo\Mercure;
+namespace Symfony\UX\Turbo\Bridge\Mercure;
 
 use Symfony\Component\Mercure\HubInterface;
 use Symfony\UX\Turbo\Broadcaster\IdAccessor;
@@ -52,7 +52,7 @@ public function renderTurboStreamListen(Environment $env, $topic): string
 
         return $this->stimulusTwigExtension->renderStimulusController(
             $env,
-            'symfony/ux-turbo/turbo-stream-mercure',
+            'symfony/ux-turbo-mercure/turbo-stream',
             ['topic' => $topic, 'hub' => $this->hub->getPublicUrl()]
         );
     }

src/Turbo/Resources/assets/src/turbo_stream_mercure_controller.js renamed to src/Turbo/Bridge/Mercure/Resources/assets/src/turbo_stream_controller.js

@@ -0,0 +1,44 @@
+{
+    "name": "symfony/ux-turbo-mercure",
+    "type": "library",
+    "description": "Mercure bridge for Symfony UX Turbo",
+    "keywords": [
+        "symfony-ux",
+        "turbo",
+        "hotwire",
+        "mercure"
+    ],
+    "homepage": "https://symfony.com",
+    "license": "MIT",
+    "authors": [
+        {
+            "name": "Kévin Dunglas",
+            "email": "[email protected]"
+        },
+        {
+            "name": "Symfony Community",
+            "homepage": "https://symfony.com/contributors"
+        }
+    ],
+    "autoload": {
+        "psr-4": {
+            "Symfony\\UX\\Turbo\\Bridge\\Mercure\\": ""
+        }
+    },
+    "require": {
+        "php": ">=7.2.5",
+        "symfony/mercure-bundle": "^0.3",
+        "symfony/twig-bundle": "^5.2",
+        "symfony/ux-turbo": "^1.3"
+    },
+    "extra": {
+        "branch-alias": {
+            "dev-main": "1.3-dev"
+        },
+        "thanks": {
+            "name": "symfony/ux-turbo",
+            "url": "https://github.com/symfony/ux"
+        }
+    },
+    "minimum-stability": "dev"
+}

src/Turbo/Resources/assets/test/setup.js renamed to src/Turbo/Bridge/Mercure/Resources/assets/test/setup.js

@@ -13,7 +13,6 @@
 
 use Doctrine\Bundle\DoctrineBundle\DoctrineBundle;
 use Doctrine\ORM\EntityManagerInterface;
-use Symfony\Bundle\MercureBundle\MercureBundle;
 use Symfony\Component\Config\Definition\Builder\TreeBuilder;
 use Symfony\Component\Config\Definition\ConfigurationInterface;
 
@@ -47,17 +46,6 @@ public function getConfigTreeBuilder(): TreeBuilder
                     ->end()
                 ->end()
                 ->scalarNode('default_transport')->defaultValue('default')->end()
-                ->arrayNode('mercure')
-                    ->{class_exists(MercureBundle::class) ? 'canBeDisabled' : 'canBeEnabled'}()
-                    ->info('If no Mercure hubs are configured explicitly, the default Mercure hub will be used.')
-                    ->children()
-                        ->arrayNode('hubs')
-                            ->fixXmlConfig('hub')
-                            ->info('The name of the Mercure hubs (configured in MercureBundle) to use as transports')
-                            ->scalarPrototype()->end()
-                        ->end()
-                    ->end()
-                ->end()
             ->end()
         ;
 

src/Turbo/Resources/assets/test/turbo_stream_mercure_controller.test.js renamed to src/Turbo/Bridge/Mercure/Resources/assets/test/turbo_stream_controller.test.js

@@ -13,17 +13,13 @@
 
 use Doctrine\Bundle\DoctrineBundle\DoctrineBundle;
 use Doctrine\ORM\EntityManagerInterface;
-use Symfony\Bundle\MercureBundle\MercureBundle;
 use Symfony\Bundle\TwigBundle\TwigBundle;
 use Symfony\Component\Config\Definition\Exception\InvalidConfigurationException;
 use Symfony\Component\Config\FileLocator;
 use Symfony\Component\Config\Loader\LoaderInterface;
-use Symfony\Component\DependencyInjection\ChildDefinition;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
 use Symfony\Component\DependencyInjection\Loader\PhpFileLoader;
-use Symfony\Component\DependencyInjection\Reference;
 use Symfony\Component\HttpKernel\DependencyInjection\Extension;
-use Symfony\Component\Mercure\HubInterface;
 use Symfony\UX\Turbo\Broadcaster\BroadcasterInterface;
 use Symfony\UX\Turbo\Twig\TurboStreamListenRendererInterface;
 
@@ -48,7 +44,6 @@ public function load(array $configs, ContainerBuilder $container): void
 
         $this->registerTwig($config, $container);
         $this->registerBroadcast($config, $container, $loader);
-        $this->registerMercureTransports($config, $container, $loader);
     }
 
     /**
@@ -99,55 +94,4 @@ private function registerBroadcast(array $config, ContainerBuilder $container, L
             throw new InvalidConfigurationException('You cannot use the Doctrine ORM integration as the Doctrine bundle is not installed. Try running "composer require symfony/orm-pack".');
         }
     }
-
-    /**
-     * @param array<string, mixed> $config
-     */
-    private function registerMercureTransports(array $config, ContainerBuilder $container, LoaderInterface $loader): void
-    {
-        if (!$config['mercure']['enabled']) {
-            return;
-        }
-
-        $missingDeps = array_filter([
-            'symfony/mercure-bundle' => !class_exists(MercureBundle::class),
-            'symfony/twig-pack' => !class_exists(TwigBundle::class),
-        ]);
-
-        if ($missingDeps) {
-            throw new InvalidConfigurationException(sprintf('You cannot use the Mercure integration as some required dependencies are missing. Try running "composer require %s".', implode(' ', $missingDeps)));
-        }
-
-        $loader->load('mercure.php');
-
-        if (!$config['mercure']['hubs']) {
-            // Wire the default Mercure hub
-            $this->registerMercureTransport($container, $config, $config['default_transport'], HubInterface::class);
-
-            return;
-        }
-
-        foreach ($config['mercure']['hubs'] as $hub) {
-            $this->registerMercureTransport($container, $config, $hub, "mercure.hub.{$hub}");
-        }
-    }
-
-    /**
-     * @param array<string, mixed> $config
-     */
-    private function registerMercureTransport(ContainerBuilder $container, array $config, string $name, string $hubId): void
-    {
-        $renderer = $container->setDefinition("turbo.mercure.{$name}.renderer", new ChildDefinition('turbo.stream_listen_renderer.mercure'));
-        $renderer->replaceArgument(0, new Reference($hubId));
-        $renderer->addTag('turbo.renderer.stream_listen', ['transport' => $name]);
-
-        if (!$config['broadcast']['enabled']) {
-            return;
-        }
-
-        $broadcaster = $container->setDefinition("turbo.mercure.{$name}.broadcaster", new ChildDefinition('turbo.broadcaster.mercure'));
-        $broadcaster->replaceArgument(0, $name);
-        $broadcaster->replaceArgument(1, new Reference($hubId));
-        $broadcaster->addTag('turbo.broadcaster');
-    }
 }

src/Turbo/Mercure/TurboStreamListenRenderer.php renamed to src/Turbo/Bridge/Mercure/TurboStreamListenRenderer.php

@@ -20,7 +20,7 @@
 use Symfony\UX\Turbo\Broadcaster\BroadcasterInterface;
 
 /**
- * Detects changes made from Doctrine entities and broadcasts updates to the Mercure hub.
+ * Detects changes made from Doctrine entities and broadcasts updates to the broadcasters.
  *
  * @author Kévin Dunglas <[email protected]>
  *