Skip to content

Reduce bitstream authorization requests for item page - #5028

Merged
tdonohue merged 1 commit into
DSpace:mainfrom
tinsch:less-bitstream-calls
Mar 3, 2026
Merged

Reduce bitstream authorization requests for item page#5028
tdonohue merged 1 commit into
DSpace:mainfrom
tinsch:less-bitstream-calls

Conversation

@tinsch

@tinsch tinsch commented Jan 22, 2026

Copy link
Copy Markdown
Contributor

Description

This PR reduces the number of calls to the REST API by executing certain authorization requests only conditionally if the normal download is not possible for the user. Before, the authorization request "canRequestACopy" was always sent for every bitstream, now this only happens if the "canDownload" request returns false. This improves the response time performance for items with a large number of bitstreams and a large pagesize (>=50), as can be seen in a graph below.

Instructions for Reviewers

Currently the response time is slow for items with a large number of bitstreams. The current workaround are small pageSizes for the item's bitstreams per default. However, from a UX standpoint it would be nice to be able to show a larger list of bitstreams to the users, especially in the case of uploaded research data.

How to test this PR:

  • create an Item with >=50 bitstreams
  • edit some bitstreams, so that they are embargoed, or the access is otherwise restricted to anonymous users
  • set item.bitstream.pageSize to 50 (or more)
  • check that the response time is slower without this PR on the item page, and faster with the PR changes
  • check that the "Request a copy" functionality still works for embargoed and otherwise restricted items

Here is a comparison of the reponse time of an item page, varied in the page size:
response-times-compared

Related Issues, former issues with item bitstream pagesize:

DSpace/DSpace#8648
#2065

Checklist

This checklist provides a reminder of what we are going to look for when reviewing your PR. You do not need to complete this checklist prior creating your PR (draft PRs are always welcome).
However, reviewers may request that you complete any actions in this list if you have not done so. If you are unsure about an item in the checklist, don't hesitate to ask. We're here to help!

  • My PR is created against the main branch of code (unless it is a backport or is fixing an issue specific to an older branch).
  • My PR is small in size (e.g. less than 1,000 lines of code, not including comments & specs/tests), or I have provided reasons as to why that's not possible.
  • My PR passes ESLint validation using npm run lint
  • My PR doesn't introduce circular dependencies (verified via npm run check-circ-deps)
  • My PR includes TypeDoc comments for all new (or modified) public methods and classes. It also includes TypeDoc for large or complex private methods.
  • My PR passes all specs/tests and includes new/updated specs or tests based on the Code Testing Guide.
  • My PR aligns with Accessibility guidelines if it makes changes to the user interface.
  • My PR uses i18n (internationalization) keys instead of hardcoded English text, to allow for translations.
  • My PR includes details on how to test it. I've provided clear instructions to reviewers on how to successfully test this fix or feature.
  • If my PR includes new libraries/dependencies (in package.json), I've made sure their licenses align with the DSpace BSD License based on the Licensing of Contributions documentation.
  • If my PR includes new features or configurations, I've provided basic technical documentation in the PR itself.
  • If my PR fixes an issue ticket, I've linked them together.

Co-funded by the European Union and Universitätsbibliothek TU Berlin (DSpaceQPO project)

@tinsch tinsch added the performance / caching Related to performance, caching or embedded objects label Jan 22, 2026
@tinsch tinsch changed the title Reduce bitstream authorization requests Reduce bitstream authorization requests for item page Jan 26, 2026
@tinsch
tinsch marked this pull request as ready for review January 26, 2026 13:09
@tinsch

tinsch commented Jan 26, 2026

Copy link
Copy Markdown
Contributor Author

Please note: I am not a frontend dev, so I would be grateful for a review by a more experienced frontend developer :) especially concerning the revised tests

@tdonohue tdonohue added high priority 1 APPROVAL pull request only requires a single approval to merge labels Jan 26, 2026
@tdonohue tdonohue moved this to 🙋 Needs Reviewers Assigned in DSpace 10.0 Release Jan 26, 2026
@tdonohue
tdonohue requested review from artlowel and tdonohue January 29, 2026 15:52
@EikLoe

EikLoe commented Jan 30, 2026

Copy link
Copy Markdown
Member

@tinsch Thanks for the PR!
I tested it and it worked fine for me! I only saw the backend requests for the restricted bitstreams. 👍🏾

@tdonohue tdonohue moved this from 🙋 Needs Reviewers Assigned to 👍 Reviewer Approved in DSpace 10.0 Release Jan 30, 2026
@tinsch tinsch self-assigned this Feb 12, 2026
@tinsch

tinsch commented Feb 24, 2026

Copy link
Copy Markdown
Contributor Author

Any news on this? I think @EikLoe tested it, but did not do a code review. I'm asking because I am not sure if my contribution counts as a feature or a bug fix for DSpace 10.

@tdonohue

Copy link
Copy Markdown
Member

@tinsch : This would be considered a bug fix. It's still waiting on a code review but is in our "Reviewer Approved" column of the board. I was waiting to see if @artlowel had a chance to take a quick look at it since he previously volunteered. Otherwise, I'll get back to this hopefully in the next week or two.

@tdonohue tdonohue added the bug label Feb 24, 2026
@kshepherd
kshepherd self-requested a review March 2, 2026 19:29
Comment thread src/app/shared/file-download-link/file-download-link.component.ts Outdated

@kshepherd kshepherd left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

+1 this looks good to me, thanks @tinsch
I can confirm that in item with 60 bitstreams including 8 non-public bitstreams (4 embargoes, 4 totally restricted), I got the request-a-copy links I expected, and the number of requests for the "canRequestACopy" feature were reduced down to 8, after the false canDownload feature was evaluated for each of those bitstreams.

I didn't see quite the stark contrast in page load time in my own local instance (~2800ms vs ~3500ms) but it's definitely quicker and more efficient.

I also confirmed that the links to restricted items work as expected when the Request-a-Copy feature is disabled.

@tinsch
tinsch force-pushed the less-bitstream-calls branch from 4ef4dc2 to b156688 Compare March 3, 2026 09:34
@tinsch
tinsch force-pushed the less-bitstream-calls branch from b156688 to 97ebfd8 Compare March 3, 2026 10:31
@tdonohue

tdonohue commented Mar 3, 2026

Copy link
Copy Markdown
Member

Thanks @tinsch ! As this is at +2, I think this is ready to merge. The code looks reasonable to me as well.

I'm going to attempt to backport this automatically to 9.x (as I think it should work cleanly). Backports to 8.x and 7.x are also welcome, but those are likely to need to be done manually (as the code of this component is a bit different in those releases). If anyone is interested, feel free to create the backport PRs.

@tdonohue tdonohue added the port to dspace-9_x This PR needs to be ported to `dspace-9_x` branch for next bug-fix release label Mar 3, 2026
@tdonohue tdonohue added this to the 10.0 milestone Mar 3, 2026
@tdonohue
tdonohue merged commit 64cf780 into DSpace:main Mar 3, 2026
16 checks passed
@github-project-automation github-project-automation Bot moved this from 👍 Reviewer Approved to ✅ Done in DSpace 10.0 Release Mar 3, 2026
@dspace-bot

Copy link
Copy Markdown
Contributor

Successfully created backport PR for dspace-9_x:

@tdonohue tdonohue removed the port to dspace-9_x This PR needs to be ported to `dspace-9_x` branch for next bug-fix release label Mar 3, 2026
@tinsch

tinsch commented Mar 3, 2026

Copy link
Copy Markdown
Contributor Author

Thanks @tdonohue! I'll have a look into the 7.x and 8.x codebase and see if a backport is feasible 👍

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

1 APPROVAL pull request only requires a single approval to merge bug high priority performance / caching Related to performance, caching or embedded objects

Projects

No open projects
Status: ✅ Done

Development

Successfully merging this pull request may close these issues.

5 participants