dspace-angular icon indicating copy to clipboard operation
dspace-angular copied to clipboard

[#2718] Migrate cookie consent from Klaro to Orejime

Open AndreaBarbasso opened this issue 1 year ago • 7 comments

References

  • Fixes #2718

Description

Migrated the cookie consent functionality from Klaro to Orejime, because of better accessibility and maintenance.

Instructions for Reviewers

All references to Klaro have been renamed to Orejime. Klaro has been removed from the package.json file and its config has been modified to be accepted by Orejime (which needs a similar, but not quite the same, config file). Since Orejime needs a URL for the privacy policy, this is now mandatory. Orejime does not allow raw HTML as text, so the i18n files have been changed accordingly. Orejime has less strings than Klaro, so a lot of i18n strings are now obsolete and have been removed.

List of changes in this PR:

  • Migrated Klaro instances to Orejime ones;
  • Cleaned up unused i18n strings and config properties;
  • Handled cookies grouping by purpose;
  • Fixed unit tests.

To review this PR. try to use the Orejime's cookie banner as if it was the Klaro's one. Remember to add a cookie to the configuration in order to test the banner when there is a new cookie to accept/decline.

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!

  • [x] 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).
  • [x] 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.
  • [x] My PR passes ESLint validation using yarn lint
  • [x] My PR doesn't introduce circular dependencies (verified via yarn check-circ-deps)
  • [x] My PR includes TypeDoc comments for all new (or modified) public methods and classes. It also includes TypeDoc for large or complex private methods.
  • [x] My PR passes all specs/tests and includes new/updated specs or tests based on the Code Testing Guide.
  • [x] My PR aligns with Accessibility guidelines if it makes changes to the user interface.
  • [x] My PR uses i18n (internationalization) keys instead of hardcoded English text, to allow for translations.
  • [x] 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.
  • [x] 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.
  • [x] If my PR includes new features or configurations, I've provided basic technical documentation in the PR itself.
  • [x] If my PR fixes an issue ticket, I've linked them together.

AndreaBarbasso avatar Jul 18 '24 10:07 AndreaBarbasso