Skip to content

[chores] Added firmware upgrader websocket routes #534#625

Merged
nemesifier merged 1 commit into
masterfrom
issues/17-firmware-upgrader-routes
Jun 5, 2026
Merged

[chores] Added firmware upgrader websocket routes #534#625
nemesifier merged 1 commit into
masterfrom
issues/17-firmware-upgrader-routes

Conversation

@pandafy

@pandafy pandafy commented Jun 5, 2026

Copy link
Copy Markdown
Member

Checklist

  • I have read the OpenWISP Contributing Guidelines.
  • I have manually tested the changes proposed in this pull request.
  • I have written new test cases for new code and/or updated existing tests for changes to existing code.
  • I have updated the documentation.

Reference to Existing Issue

Closes #534

Description of Changes

Added conditional inclusion of websocket routes from openwisp_firmware_upgrader.routing.get_routes() in the Channels routing.py template, gated behind the openwisp2_firmware_upgrader variable.

This is required to support real-time upgrade progress tracking via WebSockets, introduced in openwisp/openwisp-firmware-upgrader#320.

Added conditional inclusion of websocket routes from
openwisp_firmware_upgrader.routing.get_routes() in the Channels
routing.py template, gated behind the openwisp2_firmware_upgrader
variable.

This is required to support real-time upgrade progress tracking via
WebSockets, introduced in openwisp/openwisp-firmware-upgrader#320.

Closes #534
@coderabbitai

coderabbitai Bot commented Jun 5, 2026

Copy link
Copy Markdown

Review Change Stack

📝 Walkthrough

Walkthrough

This PR adds conditional integration of firmware upgrader websocket routes to the routing template. When the openwisp2_firmware_upgrader feature is enabled, the template now imports get_routes from openwisp_firmware_upgrader.routing and extends the shared routes list with the returned websocket patterns, maintaining compatibility with existing extra websocket routes and the protocol type router construction.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~7 minutes

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 inconclusive)

Check name Status Explanation Resolution
Title check ❓ Inconclusive The title uses the correct [chores] prefix format and references issue #534, but describes the change as 'chores' when the PR objectives indicate this is a feature addition for firmware upgrader WebSocket routes support. Consider changing the type prefix to [feature] to better reflect that this adds new WebSocket routing functionality, or verify if this qualifies as chores per your project conventions.
✅ Passed checks (4 passed)
Check name Status Explanation
Description check ✅ Passed The description covers the main requirements: reference to issue #534, description of changes (conditional inclusion of websocket routes), and indicates manual testing was done.
Linked Issues check ✅ Passed The pull request successfully implements the objective from issue #534 by conditionally including websocket routes from openwisp_firmware_upgrader.routing in the routing.py template.
Out of Scope Changes check ✅ Passed All changes are scoped to the objective of adding firmware upgrader websocket routes; no unrelated modifications are present.
Bug Fixes ✅ Passed This PR is a feature addition (adding firmware upgrader websocket routes), not a bug fix. The custom check applies only to bug fixes, so it is not applicable here.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch issues/17-firmware-upgrader-routes

Comment @coderabbitai help to get the list of available commands and usage tips.

@github-project-automation github-project-automation Bot moved this from To do (general) to In progress in OpenWISP Contributor's Board Jun 5, 2026
@nemesifier nemesifier changed the title [feature] Added firmware upgrader websocket routes #534 [chores] Added firmware upgrader websocket routes #534 Jun 5, 2026
@openwisp-companion

Copy link
Copy Markdown

Proposed change log entry:

[feature] Add firmware upgrader websocket routes #534

Conditionally include websocket routes from
openwisp_firmware_upgrader.routing.get_routes() in the Channels
routing.py template. This is gated behind the
openwisp2_firmware_upgrader variable.

This change supports real-time upgrade progress tracking via WebSockets.

Closes #534

@nemesifier
nemesifier merged commit 5128314 into master Jun 5, 2026
9 checks passed
@nemesifier
nemesifier deleted the issues/17-firmware-upgrader-routes branch June 5, 2026 12:33
@github-project-automation github-project-automation Bot moved this from In progress to Done in OpenWISP Contributor's Board Jun 5, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Development

Successfully merging this pull request may close these issues.

[feature] Add firmware upgrader websocket routes

2 participants