Drupal Live Update provides a reusable live-update layer for Drupal sites. It allows Drupal modules to publish events to named channels and lets browsers refresh parts of a page without a full page reload.
The base module uses Drupal-side polling, so it can work without a separate realtime service. Sites that need push delivery can add a compatible transport, such as a WebSocket, Server-Sent Events, Node.js, or Go integration.
How this differs from similar projects
Several Drupal projects address related realtime or live-update needs, but they focus on different parts of the problem:
- Nodejs connects Drupal to a Socket.IO service for push-based updates. Live Update provides a Drupal-side event and integration API, and can use Nodejs as an optional transport for sites that already run that service.
- Live content provides WebSocket-based live updates for content-focused use cases, including its own example block. Live Update aims to provide a broader, transport-independent API that other Drupal modules can use, with polling available when no push service is configured.
- Chatroom provides chat functionality. It can use Live Update as a message-delivery provider, while remaining responsible for chat-specific behavior and presentation.
Live Update is intended to complement these projects, not replace a chat feature or a realtime gateway. Its goal is to give Drupal modules a common way to publish and consume live-update events, while allowing sites to choose between the built-in polling approach and additional push transports.
Comments
Comment #2
vishal.kadamComment #3
avpadernoThank you for applying!
Before giving links helpful to understand how the review process works, what to expect from a review, and what to do to avoid a review takes more time than needed, I would like to thank all the reviewers for the work they do.
These applications are volunters-driven, which also means it is not possible to predict when an application will be marked fixed and the applicant will get the permission to opt projects into security advisory policy. While we aim to make an application as quick as possible, it is also important for us that more people review the project used for an application. In this way, we make sure applications do not miss some important points that should be instead reported.
Applications are not meant to be complete debugging sessions that eliminate every existing bug, though. I apologize if sometimes applications seem to go into too-detailed reviews.
Please read Review process for security advisory coverage: What to expect for more details and Security advisory coverage application checklist to understand what reviewers look for. Tips for ensuring a smooth review gives some hints for a smoother review.
The important notes are the following.
Keep in mind that once the project is opted into security advisory coverage, only Security Team members may change coverage.
To the reviewers
Please read How to review security advisory coverage applications, Application workflow, What to cover in an application review, and Tools to use for reviews.
The important notes are the following.
For new reviewers, I would also suggest to first read In which way the issue queue for coverage applications is different from other project queues.
Comment #4
avpadernoThe project page should describe the similar projects and say what the How this differs from similar projects section in the issue summary says.
Comment #5
afeijoupdated request description with intel requested by reviewers
Comment #6
vishal.kadam1. FILE: README.txt
The README file is missing the required sections - Requirements, Installation and Configuration.
2. FILE: liveupdate.module
For a new module that aims to be compatible with Drupal 10 and Drupal 11, I would rather implement hooks as class methods as described in Support for object oriented hook implementations using autowired services.
3. FILE: src/Controller/LiveUpdateController.php
Modules which are compatible with Drupal 10 and higher versions are expected to use constructor property promotion.
4. FILE: src/Form/LiveUpdateSettingsForm.php
With Drupal 10 and Drupal 11, there is no longer need to use #default_value for each form element, when the parent class is ConfigFormBase: It is sufficient to use #config_target, as in the following code.
Using that code, it is no longer needed to save the configuration values in the form submission handler: The parent class will take care of that.
Comment #7
afeijoThanks for the review, vishal.kadam.
I pushed updates to the 1.x branch addressing the requested items.
Latest commit:
4895c20 Address project application review feedback
Changes made:
- Added explicit Requirements, Installation, and Configuration sections to README.txt.
- Moved procedural hook implementations to OO hook classes using Drupal\Core\Hook\Attribute\Hook.
- Updated the controller constructor to use constructor property promotion.
- Updated the ConfigFormBase form to use #config_target.
- Kept the public helper/API functions in liveupdate.module.
- Cleaned up GitLab CI linting issues for ESLint, Stylelint, and CSpell.
GitLab CI is now fully green:
https://git.drupalcode.org/project/liveupdate/-/pipelines/976688
Verified jobs include:
- composer-lint
- phpcs
- phpstan
- phpunit
- cspell
- eslint
- stylelint
No new alpha release was created for these review fixes; the changes are on the 1.x branch.