Symfony UX Turbo: content negotiation and Doctrine integration #64

dunglas · 2021-03-02T15:14:49Z

Q	A
Bug fix?	no
New feature?	no
Tickets	n/a
License	MIT

This PR introduces an integration of Hotwire Turbo with Symfony. It has been developed and tested over the past few months by @tgalopin, @nicolas-grekas, @chalasr, @weaverryan and me. It is complementary with #61 (#61 focuses on the integration with Twig while this one focuses on higher level features, #61 will have to be rebased on top of this one).

The best way to discover the features provided by this new component is to read the provided README file. To summarize, it provides:

an integration with Mercure to stream page changes to all connected browsers from the controller. It's also possible to plug other transports.
an integration with the Form component allowing to send changes to apply to the existing DOM in response to a POST
a new PHP 8 attribute (#[Broadcast]): when a Doctrine entity is marked with this attribute, all changes made to it will be broadcasted in real time to all connected clients, and the DOM will instantly update consequently (a Twig template defined the operations to apply to the existing DOM tree). An extension point is available to plug other persistence systems
a sample app, including Panther tests (used as functional tests for the bundle itself)
a template for GitHub Actions workflow

TODO:

Merge Introduce Symfony UX Turbo #61 into this one (can be done in another PR)

refactor: decouple Broadcast from Twig and Mercure

ci: add PHP-CS-Fixer and PHPStan

@nicolas-grekas

* test: add UI tests * Fix @nicolas-grekas' review

This will make it so that an invalid form is rendered correctly

* /Users/dunglas/workspace/hotwire-bundle: prepare merge in symfony/ux tweaking how the cloned form is used in the docs (symfony#12) updating stream media type to match changes in Turbo (symfony#11) ci: setup GitHub Actions (symfony#8) fix: regressions introduced in #5 (symfony#7) Relax minimum php version (#5) fix: various quality improvements (symfony#6) test: add UI tests (#4) ci: add PHPStan ci: add PHP-CS-Fixer refactor: broadcast template conventions and config refactor: decouple Broadcast from Twig and Mercure feat: initial implementation

src/Turbo/.gitattributes

src/Turbo/Broadcaster/TwigMercureBroadcaster.php

src/Turbo/README.md

src/Turbo/Tests/TurboStreamTest.php

src/Turbo/Tests/app/Entity/Book.php

src/Turbo/Tests/app/webpack.config.js

src/Turbo/Broadcaster/TwigMercureBroadcaster.php

src/Turbo/README.md

Co-authored-by: Antoine Bluchet <[email protected]>

Tweaks and review

Add $options to BroadcastListener::broadcast()

* 'turbo' of github.com:dunglas/ux: Add $options to BroadcastListener::broadcast() - Tweaks and review

Add generic TwigBroadcaster

chalasr

Looks solid!

chalasr · 2021-03-29T15:07:10Z

src/Turbo/Broadcaster/IdAccessor.php

+
+        if ($this->doctrine && $em = $this->doctrine->getManagerForClass($entityClass)) {
+            return $em->getClassMetadata($entityClass)->getIdentifierValues($entity);
+        }


…r to generate fragments URL (dunglas) This PR was squashed before being merged into the 5.3-dev branch. Discussion ---------- [FrameworkBundle][HttpKernel][TwigBridge] Add an helper to generate fragments URL | Q | A | ------------- | --- | Branch? | 5.x | Bug fix? | no | New feature? | yes  | Deprecations? | no  | Tickets | Fix n/a | License | MIT | Doc PR | todo This PR adds a new helper to generate raw fragment URL. Fragments will be useful to generate lazy frames with Symfony UX Turbo (symfony/ux#64). This will also be convenient when using hinclude, ESI etc in case you want full control over the generated HTML. This is also more in sync with the new best practices we apply in the form component (generate the HTML by yourself instead of using Twig helpers hiding the HTML elements). Example: ```html <turbo-frame id="set_aside_tray" src="{{ fragment_uri(controller('Symfony\Bundle\FrameworkBundle\Controller', {template: "foo.html.twig"})) }}"> <img src="/icons/spinner.gif"> </turbo-frame> ``` Commits ------- 5d29d76 [FrameworkBundle][HttpKernel][TwigBridge] Add an helper to generate fragments URL

…r to generate fragments URL (dunglas) This PR was squashed before being merged into the 5.3-dev branch. Discussion ---------- [FrameworkBundle][HttpKernel][TwigBridge] Add an helper to generate fragments URL | Q | A | ------------- | --- | Branch? | 5.x | Bug fix? | no | New feature? | yes  | Deprecations? | no  | Tickets | Fix n/a | License | MIT | Doc PR | todo This PR adds a new helper to generate raw fragment URL. Fragments will be useful to generate lazy frames with Symfony UX Turbo (symfony/ux#64). This will also be convenient when using hinclude, ESI etc in case you want full control over the generated HTML. This is also more in sync with the new best practices we apply in the form component (generate the HTML by yourself instead of using Twig helpers hiding the HTML elements). Example: ```html <turbo-frame id="set_aside_tray" src="{{ fragment_uri(controller('Symfony\Bundle\FrameworkBundle\Controller', {template: "foo.html.twig"})) }}"> <img src="/icons/spinner.gif"> </turbo-frame> ``` Commits ------- 5d29d76612 [FrameworkBundle][HttpKernel][TwigBridge] Add an helper to generate fragments URL

* 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

nicolas-grekas · 2021-03-30T17:17:48Z

Continued in #71

…ation (dunglas) This PR was merged into the main branch. Discussion ---------- Symfony UX Turbo: content negotiation and Doctrine integration | Q | A | ------------- | --- | Bug fix? | no | New feature? | yes | Tickets | Fix #64 | License | MIT Same as #64, just squashed. See there for details and history. Commits ------- 95d5f00 Symfony UX Turbo: content negotiation and Doctrine integration

dunglas and others added 19 commits December 24, 2020 18:04

feat: initial implementation

52ef583

refactor: decouple Broadcast from Twig and Mercure

0e528bc

refactor: broadcast template conventions and config

9550346

Merge pull request #1 from symfony/refactor/broadcast

b5352a0

refactor: decouple Broadcast from Twig and Mercure

ci: add PHP-CS-Fixer

4471ffe

ci: add PHPStan

0684f44

Merge pull request #2 from symfony/ci

601b394

ci: add PHP-CS-Fixer and PHPStan

test: add UI tests (#4)

73662ca

* test: add UI tests * Fix @nicolas-grekas' review

fix: various quality improvements (symfony#6)

0612bca

Relax minimum php version (#5)

2364545

fix: regressions introduced in #5 (symfony#7)

a90d68c

ci: setup GitHub Actions (symfony#8)

a08e7b6

updating stream media type to match changes in Turbo (symfony#11)

619b679

tweaking how the cloned form is used in the docs (symfony#12)

a54ed8d

This will make it so that an invalid form is rendered correctly

prepare merge in symfony/ux

2f49b9f

mark as experimental, fix PHP CS config

001308c

CS

f3f22ea

ci: fixes

ec5e8f8

dunglas force-pushed the turbo branch from fd57077 to ec5e8f8 Compare March 2, 2021 15:31

jdreesen reviewed Mar 2, 2021

View reviewed changes

src/Turbo/.gitattributes Outdated Show resolved Hide resolved

dunglas added 2 commits March 3, 2021 16:56

Add JS test for TurboStreamController, CS

47beb6b

fix tests

aef187e

dunglas force-pushed the turbo branch from cf81899 to aef187e Compare March 3, 2021 16:44

dunglas added 3 commits March 3, 2021 18:48

fix tests

c7e1a74

fix tests

be52534

fix tests

44c588f

soyuka reviewed Mar 3, 2021

View reviewed changes

jdreesen reviewed Mar 3, 2021

View reviewed changes

Update src/Turbo/Broadcaster/TwigMercureBroadcaster.php

851a349

Co-authored-by: Antoine Bluchet <[email protected]>

dunglas and others added 6 commits March 26, 2021 17:11

Merge pull request #1 from nicolas-grekas/turbo

8353ff3

Tweaks and review

Add $options to BroadcastListener::broadcast()

2400139

Merge pull request #2 from nicolas-grekas/turbo-options

f3d1711

Add $options to BroadcastListener::broadcast()

cleanup

47d8823

Merge branch 'turbo' of github.com:dunglas/ux into turbo

9ba1566

* 'turbo' of github.com:dunglas/ux: Add $options to BroadcastListener::broadcast() - Tweaks and review

prettier

fdcefe7

dunglas closed this Mar 27, 2021

dunglas reopened this Mar 27, 2021

nicolas-grekas and others added 2 commits March 29, 2021 16:48

Add generic TwigBroadcaster

573ef7d

Merge pull request #3 from nicolas-grekas/turbo

63efb1d

Add generic TwigBroadcaster

chalasr approved these changes Mar 29, 2021

View reviewed changes

nicolas-grekas and others added 10 commits March 30, 2021 16:59

Move Mercure integration to a dedicated bridge

3788406

Fix JS

b44ed86

re-add main package.json

c0dc43f

fix build

2d75ceb

fix cs

2391126

-

7a871fa

-

ab8d61c

-

80d3d9c

run yarn tests for all workspaces

57da895

Merge branch 'turbo-mercure' into turbo

861033a

* 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

nicolas-grekas force-pushed the turbo branch from 6623480 to 861033a Compare March 30, 2021 17:15

nicolas-grekas mentioned this pull request Mar 30, 2021

Symfony UX Turbo: content negotiation and Doctrine integration #71

Merged

nicolas-grekas closed this Mar 30, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

Symfony UX Turbo: content negotiation and Doctrine integration #64

Symfony UX Turbo: content negotiation and Doctrine integration #64

Uh oh!

dunglas commented Mar 2, 2021 •

edited

Loading

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

chalasr left a comment

Uh oh!

chalasr Mar 29, 2021

Uh oh!

nicolas-grekas commented Mar 30, 2021

Uh oh!

Uh oh!

Uh oh!

Symfony UX Turbo: content negotiation and Doctrine integration #64

Symfony UX Turbo: content negotiation and Doctrine integration #64

Uh oh!

Conversation

dunglas commented Mar 2, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

chalasr left a comment

Choose a reason for hiding this comment

Uh oh!

chalasr Mar 29, 2021

Choose a reason for hiding this comment

Uh oh!

nicolas-grekas commented Mar 30, 2021

Uh oh!

Uh oh!

dunglas commented Mar 2, 2021 •

edited

Loading