Fix OPDS2+ODL streaming DRM fulfillment (PP-3467) #2956
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jonathangreen
commented
Jan 7, 2026
| def _license_fulfill( | ||
| self, loan: Loan, delivery_mechanism: LicensePoolDeliveryMechanism | ||
| ) -> Fulfillment: | ||
| # We are unable to fulfill a loan that doesn't have its external identifier set, |
Member
Author
There was a problem hiding this comment.
This change isn't related, but while I was here, I noticed the first line of the doc comment was duplicated.
…ming DRM type - Add test coverage for streaming DRM in test_fulfill_success - Add test for unsupported streaming content type error case - Add helpful error messages when streaming content type is unsupported - Refactor test to use content_type parameter for cleaner parametrization
jonathangreen
force-pushed
the
bugfix/opds-odl-streaming-fulfill
branch
from
3717f1b to
f066a81
Compare
tdilauro
approved these changes
Jan 7, 2026
Contributor
tdilauro
left a comment
tdilauro
left a comment
There was a problem hiding this comment.
This looks good to me! 🛠️
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #2956 +/- ##
=======================================
Coverage 92.78% 92.78%
=======================================
Files 454 454
Lines 42844 42852 +8
Branches 5976 5978 +2
=======================================
+ Hits 39752 39760 +8
Misses 2021 2021
Partials 1071 1071 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
2 tasks
jonathangreen
added a commit
that referenced
this pull request
Jan 8, 2026
…) (#2966) ## Description This refactoring removes the streaming-specific conditional from `LoanController.fulfill()` by creating a new `StreamingFulfillment` class that encapsulates OPDS feed response generation. It shouldn't change the feed output, but in working on #2965, #2962, #2956 it became clear this refactoring would help the maintainability of this code. Changes: - Add `StreamingFulfillment` class that generates OPDS feed entries containing the streaming fulfillment link - Automatically append `STREAMING_PROFILE` to content type in constructor - Update `Fulfillment.response()` signature to accept optional `circulation` and `loan` parameters for subclasses that need them - Update `LoanController` to pass context to `fulfillment.response()` instead of special-casing streaming mechanisms - Update ODL and Overdrive integrations to return `StreamingFulfillment` for streaming delivery mechanisms - Add comprehensive tests for the new fulfillment class - Update existing tests to use `StreamingFulfillment` where appropriate ## Motivation and Context Previously, the `LoanController.fulfill()` method had special-case logic to check if a delivery mechanism was streaming and generate an OPDS feed response. This refactoring allows integrations to explicitly choose their response format by returning the appropriate fulfillment type, rather than having the controller make that decision based on delivery mechanism properties. ## How Has This Been Tested? - Added comprehensive unit tests for `StreamingFulfillment` class - Updated existing integration tests to use `StreamingFulfillment` - All existing tests pass ## Checklist - [x] I have updated the documentation accordingly. - [x] All new and existing tests passed.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Fix a bug where the OPDS2+ODL integration could not fulfill content with the streaming DRM type. The streaming DRM handler was missing from the fulfillment logic, causing these requests to fail.
The fix adds a new handler for
STREAMING_DRMthat:Streaming Text) to the appropriate link media type (text/html)RedirectFulfillmentto send the patron to the streaming readerAlso adds proper error handling when an unsupported streaming content type is encountered.
Motivation and Context
This resolves PP-3467 and should unblock PP-3296.
Streaming content from OPDS2+ODL providers could not be fulfilled because the
_license_fulfillmethod did not have a handler for theSTREAMING_DRMscheme. This caused the code to fall through to the default DRM handler, which looks for alicenserel link with the DRM scheme as the type—incorrect for streaming content.How Has This Been Tested?
test_fulfill_successtest_fulfill_streaming_unsupported_content_typeto verify error handling when an unsupported content type is used with streaming DRMChecklist