Skip to content

Conversation

@pzlakowski
Copy link

@pzlakowski pzlakowski commented Jan 16, 2026

References

Fixes Bitstream downloads fail when script blockers are active on sites with Matomo integration #4991

Description

This fixes bitstream download when Matomo is enabled and user disabled Matomo script.

Matomo integration enqueues tasks to window._paq and then Matomo sdk itself pop tasks from queue and executes them.

When user has any adblocker the task will never pop from the queue and process, thus promise will never get resolved or rejected. It will hang at this line of code exactly:

src/app/statistics/matomo.service.ts

appendVisitorId(url: string): Observable<string> {
  return fromPromise(this.matomoTracker?.getVisitorId())
    .pipe(
      map(visitorId => this.appendTrackerId(url, visitorId)),
      take(1),
    );
}

This does not happen for built-in tracking of ng-matomo-client - perhaps we should be more defensive and timeout with catchError for appendVistorId method rather than only checking whenever script got loaded correctly.

Instructions for Reviewers

Please add a more detailed description of the changes made by your PR. At a minimum, providing a bulleted list of changes in your PR is helpful to reviewers.

List of changes in this PR:

  • I have added isMatomoScriptLoaded$ in Matomo service to check whenever script gets loaded, errors out or hangs with loading status
  • I have integrated ngx-matomo-client with Matomo service to use custom script factory and use markAsLoaded and markAsError to set proper state respectively
  • I have modified bitstream download page to ignore silently when we cannot load script

Steps to test this PR:

Environment:

Case 1. Firefox with Ublock Origin enabled

  1. Attempt to download any bitstream resource and find out in network tab that trackerId will not be added to bitstream resource

Case 2. Firefox with Ublock Origin disabled

  1. Attempt to download any bitstream resource and find out in network tab that trackerId will be added to bitstream resource

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.

@pzlakowski pzlakowski marked this pull request as draft January 16, 2026 12:45
@tdonohue tdonohue added bug component: statistics 1 APPROVAL pull request only requires a single approval to merge labels Jan 16, 2026
@tdonohue tdonohue moved this to 🙋 Needs Reviewers Assigned in DSpace 10.0 Release Jan 16, 2026
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 component: statistics

Projects

Status: 🙋 Needs Reviewers Assigned

Development

Successfully merging this pull request may close these issues.

Bitstream downloads fail when script blockers are active on sites with Matomo integration

3 participants