Add streaming media support for OPDS for Distributors (PP-3590) by jonathangreen · Pull Request #3015 · ThePalaceProject/circulation

jonathangreen · 2026-01-30T15:58:34Z

Description

Add support for streaming media formats (e.g., Biblioboard web reader) in OPDS for Distributors feeds. This allows patrons to access streaming content through viewer URLs with authentication tokens appended.

Note

This implementation is specific to Biblioboard and includes hardcoded knowledge such as appending the token query parameter to the viewer URL. Since Biblioboard is currently the only user of the OPDS for Distributors importer, this is acceptable for now. Future work should migrate the Biblioboard feed to the OPDS 2.x importer, where templated links would allow us to generalize this pattern more cleanly.

Motivation and Context

This enables libraries to provide streaming content (text and audio) to patrons through OPDS for Distributors collections. Streaming content is delivered via web viewer URLs that require an OAuth token for authentication. The token is appended to the URL so patrons can access the content directly in their browser.

How Has This Been Tested?

Added unit tests for _streaming_format_data method covering:
- Non-streaming links returning None
- Audio medium returning STREAMING_AUDIO_CONTENT_TYPE
- Book medium returning STREAMING_TEXT_CONTENT_TYPE
- Default to text when medium is not specified
Added unit tests for _append_token_to_url with various URL formats
Added integration test for fulfill() with streaming delivery mechanism
Added tests for streaming format detection in OPDS 1.x extractor for both text and audio content

Checklist

I have updated the documentation accordingly.
All new and existing tests passed.

codecov · 2026-01-30T16:04:50Z

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 93.03%. Comparing base (17a2e0b) to head (62e6ec0).
⚠️ Report is 8 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #3015      +/-   ##
==========================================
+ Coverage   93.02%   93.03%   +0.01%     
==========================================
  Files         481      482       +1     
  Lines       43563    43588      +25     
  Branches     6055     6058       +3     
==========================================
+ Hits        40525    40553      +28     
+ Misses       1965     1964       -1     
+ Partials     1073     1071       -2

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

jonathangreen · 2026-01-30T19:07:30Z

src/palace/manager/integration/license/opds/for_distributors/api.py

-        open_access = False
-        media_type = None
-
-        for link in links:


Instead of doing this, I updated to just use the url cached on the resource. This is what we do in other apis, and it simplifies the logic here significantly.

jonathangreen · 2026-01-30T19:08:31Z

tests/files/opds_for_distributors/biblioboard_mini_feed.opds

 <link rel="self" type="application/atom+xml;type=entry;profile=opds-catalog" href="https://catalog.biblioboard.com/opds/items/04377e87-ab69-41c8-a2a4-812d55dc0952"/>
 <link rel="http://opds-spec.org/image/thumbnail" type="image/jpeg" href="https://api.biblioboard.com/media/04377e87-ab69-41c8-a2a4-812d55dc0952/assets/thumbnail.jpg"/>
-<link rel="http://opds-spec.org/acquisition" type="text/html" href="https://library.biblioboard.com/viewer/04377e87-ab69-41c8-a2a4-812d55dc0952" title="View on BiblioBoard"/>
+<link rel="http://opds-spec.org/acquisition" type="text/html;profile=http://librarysimplified.org/terms/profiles/streaming-media" href="https://library.biblioboard.com/viewer/04377e87-ab69-41c8-a2a4-812d55dc0952" title="View on BiblioBoard"/>


Updated the test data in our feed to match whats in the real feeds.

jonathangreen · 2026-01-30T19:10:08Z

tests/manager/celery/tasks/test_opds_for_distributors.py

-            assert (
-                pool.delivery_mechanisms[0].rights_status.uri
-                == RightsStatus.IN_COPYRIGHT
+        # -- Test the Camelot license pool --


I rewrote these tests a bit, the logic was getting a bit tortured, with the iteration of the pools, since each pool has different properties set. I just unrolled the loops, so that we test each one in sequence, so we can test the differences between them.

Add support for streaming media formats (e.g., Biblioboard web reader) in OPDS for Distributors feeds. This allows patrons to access streaming content through viewer URLs with authentication tokens. Changes: - Add _streaming_format_data method to detect streaming links by their media type profile (text/html;profile=...streaming-media) - Update fulfill() to return StreamingFulfillment for streaming content, appending the OAuth token to the viewer URL - Add STREAMING_MEDIA_LINK_TYPE constant for consistent exact matching - Allow STREAMING_DRM in can_fulfill_without_loan check - Extract STREAMING_MEDIA_PROFILE_URI as a reusable constant

dbernstein

Just a minor comment: feel free to ignore or fix as you see fit.

dbernstein · 2026-02-02T22:59:36Z

src/palace/manager/integration/license/opds/opds1/extractor.py

+                if format_data is None:
+                    # Fall back to bearer token format detection
+                    format_data = self._bearer_token_format_data(link)
+                if format_data is not None:


Why not else instead of if format_data is not None?

format_data = self._bearer_token_format_data(link) could be None as well, so that if always needs to be evaluated

…PP-3684) (#3055) ## Description > Note: #3035 needs to get merged before this can go in. Adds a startup task that dispatches a forced re-harvest of all OPDS for Distributors collections on the next deployment. ## Motivation and Context After streaming media support landed (PR #3015), existing OPDS for Distributors collections need to be re-imported with the new parsing logic to pick up the changes. Resolves PP-3684 ## How Has This Been Tested? The startup task follows the established pattern and delegates to the existing `import_all` Celery task with `force=True`. The `import_all` task is already covered by existing tests. ## Checklist - [x] I have updated the documentation accordingly. - [x] All new and existing tests passed.

jonathangreen added the feature New feature label Jan 30, 2026

jonathangreen commented Jan 30, 2026

View reviewed changes

jonathangreen added 3 commits January 30, 2026 15:19

Do some fixing up of tests

ec44605

Small code review changes

62e6ec0

jonathangreen force-pushed the feature/opds-distributors-streaming-media branch from b7647e7 to 62e6ec0 Compare January 30, 2026 19:19

jonathangreen marked this pull request as ready for review January 30, 2026 19:24

jonathangreen requested a review from a team January 30, 2026 19:24

dbernstein approved these changes Feb 2, 2026

View reviewed changes

jonathangreen merged commit a26ae45 into main Feb 3, 2026
20 of 22 checks passed

jonathangreen deleted the feature/opds-distributors-streaming-media branch February 3, 2026 16:10

jonathangreen mentioned this pull request Feb 17, 2026

Add startup task to force re-import OPDS for Distributors collections (PP-3684) #3055

Merged

2 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add streaming media support for OPDS for Distributors (PP-3590)#3015

Add streaming media support for OPDS for Distributors (PP-3590)#3015
jonathangreen merged 3 commits intomainfrom
feature/opds-distributors-streaming-media

jonathangreen commented Jan 30, 2026 •

edited

Loading

Uh oh!

codecov bot commented Jan 30, 2026 •

edited

Loading

Uh oh!

jonathangreen Jan 30, 2026

Uh oh!

jonathangreen Jan 30, 2026

Uh oh!

jonathangreen Jan 30, 2026

Uh oh!

dbernstein left a comment

Uh oh!

dbernstein Feb 2, 2026

Uh oh!

jonathangreen Feb 3, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Conversation

jonathangreen commented Jan 30, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Motivation and Context

How Has This Been Tested?

Checklist

Uh oh!

codecov bot commented Jan 30, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

jonathangreen Jan 30, 2026

Choose a reason for hiding this comment

Uh oh!

jonathangreen Jan 30, 2026

Choose a reason for hiding this comment

Uh oh!

jonathangreen Jan 30, 2026

Choose a reason for hiding this comment

Uh oh!

dbernstein left a comment

Choose a reason for hiding this comment

Uh oh!

dbernstein Feb 2, 2026

Choose a reason for hiding this comment

Uh oh!

jonathangreen Feb 3, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

jonathangreen commented Jan 30, 2026 •

edited

Loading

codecov bot commented Jan 30, 2026 •

edited

Loading