bug #580 Turbo mercure package abandoned (weaverryan)

This PR was squashed before being merged into the 2.x branch. Discussion ---------- Turbo mercure package abandoned | Q | A | ------------- | --- | Bug fix? | yes | New feature? | no | Tickets | Fix #578 | License | MIT Hi! The `symfony/ux-turbo-mercure` package is now abandoned - see #578 - and instead now lives in `symfony/ux-turbo`. That's actually already the case in 2.6.0, but in 2.6.1, we will move the actual Stimulus controller as well. This moves the controller, fixes the autoloading & updates the README and CHANGELOG. I tested locally on ux.symfony.com (you can see those changes here too, though I'll need to update the package properly in that project after this is merged). Cheers! Commits ------- 0747273 Turbo mercure package abandoned
symfony · Dec 2, 2022 · 2c2eead · 2c2eead
2 parents 25b7635 + 0747273
commit 2c2eead
Show file tree

Hide file tree

Showing 21 changed files with 47 additions and 208 deletions.
diff --git a/src/Turbo/CHANGELOG.md b/src/Turbo/CHANGELOG.md
@@ -1,5 +1,20 @@
 # CHANGELOG
 
+## 2.6.1
+
+-   The `symfony/ux-turbo-mercure` package was abandoned and moved into this package.
+    If you were previously using `symfony/ux-turbo-mercure`, you can remove it
+    and only install mecure-bundle:
+
+    ```
+    composer require symfony/mercure-bundle
+    composer remove symfony/ux-turbo-mercure
+    ```
+
+    After upgrading this package to 2.6.1, you should have a new entry in
+    `assets/controllers.json` called `mercure-turbo-stream`. Change
+    `enabled: false` to `enabled: true`.
+
 ## 2.6.0
 
 -   [BC BREAK] The `assets/` directory was moved from `Resources/assets/` to `assets/`. Make

diff --git a/...re/assets/dist/turbo_stream_controller.js → ...bo/assets/dist/turbo_stream_controller.js b/...re/assets/dist/turbo_stream_controller.js → ...bo/assets/dist/turbo_stream_controller.js
diff --git a/src/Turbo/assets/package.json b/src/Turbo/assets/package.json
@@ -11,6 +11,11 @@
                 "webpackMode": "eager",
                 "fetch": "eager",
                 "enabled": true
+            },
+            "mercure-turbo-stream": {
+                "main": "dist/turbo_stream_controller.js",
+                "fetch": "eager",
+                "enabled": false
             }
         }
     },
@@ -20,6 +25,7 @@
     },
     "devDependencies": {
         "@hotwired/turbo": "^7.1.0",
-        "@hotwired/stimulus": "^3.0.0"
+        "@hotwired/stimulus": "^3.0.0",
+        "jest-canvas-mock": "^2.3.0"
     }
 }
diff --git a/...ure/assets/src/turbo_stream_controller.ts → ...rbo/assets/src/turbo_stream_controller.ts b/...ure/assets/src/turbo_stream_controller.ts → ...rbo/assets/src/turbo_stream_controller.ts
diff --git a/...sets/test/turbo_stream_controller.test.ts → ...sets/test/turbo_stream_controller.test.ts b/...sets/test/turbo_stream_controller.test.ts → ...sets/test/turbo_stream_controller.test.ts
@@ -16,7 +16,7 @@ import TurboStreamController from '../src/turbo_stream_controller';
 
 const startStimulus = () => {
     const application = Application.start();
-    application.register('symfony--ux-turbo-mercure--turbo-stream', TurboStreamController);
+    application.register('symfony--ux-turbo--mercure-turbo-stream', TurboStreamController);
 };
 
 /* eslint-disable no-undef */
@@ -31,7 +31,7 @@ describe('TurboStreamController', () => {
         }));
 
         container = mountDOM(
-            '<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>'
+            '<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('TurboStreamController', () => {
 
         // smoke test
         expect(getByTestId(container, 'turbo-stream-mercure')).toHaveAttribute(
-            'data-symfony--ux-turbo-mercure--turbo-stream-topic-value',
+            'data-symfony--ux-turbo--mercure-turbo-stream-topic-value',
             'foo'
         );
     });

diff --git a/src/Turbo/composer.json b/src/Turbo/composer.json
@@ -24,8 +24,7 @@
     ],
     "autoload": {
         "psr-4": {
-            "Symfony\\UX\\Turbo\\": "src/",
-            "Symfony\\UX\\Turbo\\Bridge\\Mercure\\": "src/Bridge/Mercure/src"
+            "Symfony\\UX\\Turbo\\": "src/"
         }
     },
     "autoload-dev": {

diff --git a/src/Turbo/doc/index.rst b/src/Turbo/doc/index.rst
@@ -383,9 +383,19 @@ Start by installing `the Mercure support`_ on your project:
 
 .. code-block:: terminal
 
-    $ composer require symfony/ux-turbo-mercure
-    $ yarn install --force
-    $ yarn encore dev
+    $ composer require symfony/mercure-bundle
+
+Then, enable the "mercure stream" controller in ``assets/controllers.json``:
+
+.. code-block:: diff
+
+    "@symfony/ux-turbo": {
+        "mercure-turbo-stream": {
+    +         "enabled": true,
+    -         "enabled": false,
+            "fetch": "lazy"
+        }
+    },
 
 The easiest way to have a working development (and production-ready)
 environment is to use `Symfony Docker`_, which comes with

diff --git a/...bo/src/Bridge/Mercure/src/Broadcaster.php → src/Turbo/src/Bridge/Mercure/Broadcaster.php b/...bo/src/Bridge/Mercure/src/Broadcaster.php → src/Turbo/src/Bridge/Mercure/Broadcaster.php
diff --git a/src/Turbo/src/Bridge/Mercure/LICENSE b/src/Turbo/src/Bridge/Mercure/LICENSE
diff --git a/src/Turbo/src/Bridge/Mercure/README.md b/src/Turbo/src/Bridge/Mercure/README.md
diff --git a/...Mercure/src/TurboStreamListenRenderer.php → ...dge/Mercure/TurboStreamListenRenderer.php b/...Mercure/src/TurboStreamListenRenderer.php → ...dge/Mercure/TurboStreamListenRenderer.php
@@ -18,7 +18,7 @@
 use Twig\Environment;
 
 /**
- * Renders the attributes to load the "turbo-stream-mercure" controller.
+ * Renders the attributes to load the "mercure-turbo-stream" controller.
  *
  * @author Kévin Dunglas <kevin@dunglas.fr>
  */
@@ -52,7 +52,7 @@ public function renderTurboStreamListen(Environment $env, $topic): string
 
         return $this->stimulusTwigExtension->renderStimulusController(
             $env,
-            'symfony/ux-turbo-mercure/turbo-stream',
+            'symfony/ux-turbo/mercure-turbo-stream',
             ['topic' => $topic, 'hub' => $this->hub->getPublicUrl()]
         );
     }

diff --git a/src/Turbo/src/Bridge/Mercure/assets/jest.config.js b/src/Turbo/src/Bridge/Mercure/assets/jest.config.js
diff --git a/src/Turbo/src/Bridge/Mercure/assets/package.json b/src/Turbo/src/Bridge/Mercure/assets/package.json
diff --git a/src/Turbo/src/Bridge/Mercure/composer.json b/src/Turbo/src/Bridge/Mercure/composer.json
diff --git a/src/Turbo/tests/app/assets/app.js b/src/Turbo/tests/app/assets/app.js
@@ -8,9 +8,9 @@
  */
 
 import { Application } from "@hotwired/stimulus";
-import TurboStreamMercureController from "@symfony/ux-turbo-mercure/dist/turbo_stream_controller";
+import TurboStreamMercureController from "@symfony/ux-turbo/dist/turbo_stream_controller";
 
 const application = Application.start();
-application.register("symfony--ux-turbo-mercure--turbo-stream", TurboStreamMercureController);
+application.register("symfony--ux-turbo--mercure-turbo-stream", TurboStreamMercureController);
 
 console.log('test app initialized');
diff --git a/src/Turbo/tests/app/package.json b/src/Turbo/tests/app/package.json
@@ -2,7 +2,6 @@
     "devDependencies": {
         "@hotwired/turbo": "^7.0.1",
         "@symfony/ux-turbo": "file:../../assets",
-        "@symfony/ux-turbo-mercure": "file:../../src/Bridge/Mercure/assets",
         "@symfony/webpack-encore": "^0.32.0",
         "core-js": "^3.0.0",
         "regenerator-runtime": "^0.13.2",

diff --git a/ux.symfony.com/assets/controllers.json b/ux.symfony.com/assets/controllers.json
@@ -71,10 +71,8 @@
             "turbo-core": {
                 "enabled": true,
                 "fetch": "eager"
-            }
-        },
-        "@symfony/ux-turbo-mercure": {
-            "turbo-stream": {
+            },
+            "mercure-turbo-stream": {
                 "enabled": true,
                 "fetch": "lazy"
             }

diff --git a/ux.symfony.com/composer.json b/ux.symfony.com/composer.json
@@ -22,7 +22,7 @@
         "symfony/flex": "^2",
         "symfony/form": "6.0.*",
         "symfony/framework-bundle": "6.0.*",
-        "symfony/mercure-bundle": "^0.3.4",
+        "symfony/mercure-bundle": "^0.3.5",
         "symfony/monolog-bundle": "^3.0",
         "symfony/notifier": "6.0.*",
         "symfony/proxy-manager-bridge": "6.0.*",
@@ -38,7 +38,6 @@
         "symfony/ux-react": "2.x-dev",
         "symfony/ux-swup": "2.x-dev",
         "symfony/ux-turbo": "2.x-dev",
-        "symfony/ux-turbo-mercure": "2.x-dev",
         "symfony/ux-twig-component": "2.x-dev",
         "symfony/ux-typed": "2.x-dev",
         "symfony/ux-vue": "2.x-dev",

diff --git a/ux.symfony.com/composer.lock b/ux.symfony.com/composer.lock
diff --git a/ux.symfony.com/package.json b/ux.symfony.com/package.json
@@ -24,7 +24,6 @@
         "@symfony/ux-react": "file:vendor/symfony/ux-react/Resources/assets",
         "@symfony/ux-swup": "file:vendor/symfony/ux-swup/Resources/assets",
         "@symfony/ux-turbo": "file:vendor/symfony/ux-turbo/Resources/assets",
-        "@symfony/ux-turbo-mercure": "file:vendor/symfony/ux-turbo-mercure/Resources/assets",
         "@symfony/ux-typed": "file:vendor/symfony/ux-typed/Resources/assets",
         "@symfony/ux-vue": "file:vendor/symfony/ux-vue/Resources/assets",
         "@symfony/webpack-encore": "^2.0.0",

diff --git a/ux.symfony.com/symfony.lock b/ux.symfony.com/symfony.lock
@@ -562,9 +562,6 @@
     "symfony/ux-turbo": {
         "version": "v2.1.0"
     },
-    "symfony/ux-turbo-mercure": {
-        "version": "v2.1.0"
-    },
     "symfony/ux-twig-component": {
         "version": "v2.1.0"
     },