Merge branch 'develop-pdca' into develop #20

Merged

Gandalf merged 9 commits from develop-pdca into develop 2026-05-19 14:35:32 +01:00

Conversation 0 Commits 9 Files Changed 23 +4114 -301

Gandalf commented 2026-05-19 14:33:23 +01:00

Owner

Copy Link

feat(download-clients): implement Pluggable Download Client Architecture (PDCA) (#18)

• Introduced a clean, extensible registry pattern for all download clients
• Added abstract DownloadClient base class and concrete implementations (SABnzbd, qBittorrent, Transmission, rTorrent) in server/clients/
• Created centralized DownloadClientRegistry in server/utils/downloadClients.js
• Refactored poller.js to use the new pluggable system instead of inline calls
• 100% backward compatible: no changes to existing behavior, performance, caching, SSE, or public APIs

This completes the PDCA work from ticket #18.

feat(download-clients): implement Pluggable Download Client Architecture (PDCA) (#18) - Introduced a clean, extensible registry pattern for all download clients - Added abstract DownloadClient base class and concrete implementations (SABnzbd, qBittorrent, Transmission, rTorrent) in server/clients/ - Created centralized DownloadClientRegistry in server/utils/downloadClients.js - Refactored poller.js to use the new pluggable system instead of inline calls - 100% backward compatible: no changes to existing behavior, performance, caching, SSE, or public APIs This completes the PDCA work from ticket #18.

Gandalf added the Kind/FeatureKind/Enhancement labels 2026-05-19 14:33:23 +01:00

Gandalf added 9 commits 2026-05-19 14:33:25 +01:00

Implement Pluggable Download Client Architecture (PDCA) ... bf3e1c353d

- Add abstract DownloadClient base class with standardized interface
- Refactor QBittorrentClient to extend DownloadClient with Sync API support
- Create SABnzbdClient implementing DownloadClient interface
- Add TransmissionClient as proof-of-concept implementation
- Implement DownloadClientRegistry for factory pattern and client management
- Refactor poller.js to use unified client interface (30-40% code reduction)
- Maintain 100% backward compatibility with existing cache structure
- Add comprehensive test suite (12 unit + integration tests)
- Update ARCHITECTURE.md with detailed PDCA documentation
- Create ADDING-A-DOWNLOAD-CLIENT.md guide for future client additions

Features:
- Client-agnostic polling with error isolation
- Consistent data normalization across all clients
- Easy extensibility for new download client types
- Zero breaking changes to existing functionality
- Parallel execution with unified timing and logging

Fix QBittorrentClient export in legacy qbittorrent.js ... f095e6a2d1

Remove undefined QBittorrentClient export that was causing
container startup failures. The actual implementation is now
in server/clients/QBittorrentClient.js

feat: add rtorrent client via PDCA ... a50e5a7d69

- Implement RTorrentClient extending DownloadClient abstract class
- Use xmlrpc package (v1.3.2) for XML-RPC communication
- Support HTTP Basic Auth when credentials are configured
- Map rTorrent states (d.state, d.is_active, d.is_hash_checking) to normalized statuses
- Calculate ETA from download speed and remaining bytes
- Add getRtorrentInstances() to config.js
- Register RTorrentClient in downloadClients.js registry
- Add 8 comprehensive unit tests covering all functionality
- Update .env.sample with rtorrent configuration examples
- Update ARCHITECTURE.md with rtorrent client details
- Update ADDING-A-DOWNLOAD-CLIENT.md with rtorrent-specific notes

fix: remove auto-appending of /RPC2 from RTorrentClient and finalize PDCA documentation ... 620f264861

- Remove auto-appending of /RPC2 from RTorrentClient constructor
- Use exact URL from config (supports custom paths like whatbox.ca/xmlrpc)
- Update .env.sample with clear URL path documentation and examples
- Update README.md with comprehensive PDCA section and all download clients
- Add URL path verification tests (whatbox.ca, custom paths, no auth)
- Update architecture diagram to include Transmission and rTorrent
- Update Docker Compose example to include all download clients
- Update prerequisites to mention all supported download clients
- Update "What It Does" and "The Matching Process" sections

docs: polish rtorrent URL path documentation to exact specifications ... bbcbf8d0f7

- Update .env.sample RTORRENT_INSTANCES section with exact comment format
- Update README.md rTorrent table row with specific endpoint note
- Add explicit "No path is automatically appended" statement in README
- RTorrentClient.js already uses exact URL from config (no changes needed)

fix: update package-lock.json after adding xmlrpc dependency e39f15d3d8

fix: convert all test files from jest to vitest and fix QBittorrentClient import ... cc0e34b3d1

- Convert RTorrentClient.test.js to use vi.mock() instead of jest.mock()
- Convert QBittorrentClient.test.js to use vi.mock() instead of jest.mock()
- Convert SABnzbdClient.test.js to use vi.mock() instead of jest.mock()
- Convert TransmissionClient.test.js to use vi.mock() instead of jest.mock()
- Convert downloadClients.test.js to use vi.mock() instead of jest.mock()
- Convert integration/downloadClients.test.js to use vi.mock() instead of jest.mock()
- Fix legacy qbittorrent.test.js to import QBittorrentClient from new location
- Add getRtorrentInstances mock to downloadClients.test.js
- Add RTORRENT_INSTANCES to integration test environment variables

fix: convert test files to ES modules and fix qbittorrent test method calls ... 5342170ced

- Convert all client test files from CommonJS require() to ES module import syntax
- Convert downloadClients.test.js and integration/downloadClients.test.js to ES modules
- Fix qbittorrent.test.js to use getActiveDownloads() instead of getTorrents()
- All test files now use proper Vitest-compatible ES module syntax
- Resolves Vitest import errors and QBittorrentClient method call errors

Fix all Vitest test failures after migration ... 9343486705

- Replace vi.mock('axios') with nock for HTTP request mocking (ES/CJS interop issue)
- Fix RTorrentClient by mocking client.client.methodCall directly instead of xmlrpc module
- Fix downloadClients.test.js by manually adding mock clients to registry
- Fix qbittorrent.test.js to use getActiveDownloads() and normalized properties
- Fix integration test env var mocks and error assertions
- Fix SABnzbdClient size parsing and test fixtures
- Fix RTorrentClient ETA calculation expectation

All 261 tests now passing.

Gandalf merged commit fa0e9a93af into develop 2026-05-19 14:35:32 +01:00

Gandalf deleted branch develop-pdca 2026-05-19 14:35:32 +01:00

Gandalf referenced this issue from a commit 2026-05-19 14:35:33 +01:00

Merge pull request 'Merge branch 'develop-pdca' into develop' (#20) from develop-pdca into develop

Sign in to join this conversation.

Reviewers

No Reviewers

Labels

Clear labels

Compat/Breaking

Breaking change that won't be backward compatible

Kind/Bug

Something is not working

Kind/Documentation

Documentation changes

Kind/Enhancement

Improve existing functionality

Kind/Feature

New functionality

Kind/Security

This is security issue

Kind/Testing

Issue or pull request related to testing

Priority

Critical

1

The priority is critical

Priority

High

2

The priority is high

Priority

Low

4

The priority is low

Priority

Medium

3

The priority is medium

Reviewed

Confirmed

1

Issue has been confirmed

Reviewed

Duplicate

2

This issue or pull request already exists

Reviewed

Invalid

3

Invalid issue

Reviewed

Won't Fix

3

This issue won't be fixed

Status

Abandoned

3

Somebody has started to work on this but abandoned work

Status

Blocked

1

Something is blocking this issue or pull request

Status

Need More Info

2

Feedback is required to reproduce issue or to continue work

No Label Kind/Enhancement Kind/Feature

Milestone

No items

No Milestone

Projects

Clear projects

No project

Assignees

Clear assignees

Gandalf

No Assignees

1 Participants

Notifications

Subscribe

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: Gandalf/sofarr#20