Skip to content

Fix ssr error by only importing altcha on the client side#4161

Merged
kshepherd merged 1 commit intoDSpace:mainfrom
atmire:only-import-altcha-on-the-browser
Apr 10, 2025
Merged

Fix ssr error by only importing altcha on the client side#4161
kshepherd merged 1 commit intoDSpace:mainfrom
atmire:only-import-altcha-on-the-browser

Conversation

@artlowel
Copy link
Member

References

Description

The issue was caused by the fact that altcha was loaded server side, and that's not supported. When it tries to define the altcha-widget the server-side throws an exception.

I fixed it by removing the import everywhere, and putting it in browser-app.config.ts

I also removed an unnecessary ngVar, as they can be bad for performance.

Instructions for Reviewers

Ensure that the ssr error is gone, and that the altcha captchas still work.

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.

@artlowel artlowel added bug component: SEO Search Engine Optimization high priority testathon Reported by a tester during Community Testathon affects: main Issue impacts "main" (latest release). labels Apr 10, 2025
@artlowel artlowel requested review from kshepherd and tdonohue April 10, 2025 09:33
@artlowel artlowel self-assigned this Apr 10, 2025
@artlowel artlowel moved this to 👀 Under Review in DSpace 9.0 Release Apr 10, 2025
Copy link
Member

@kshepherd kshepherd left a comment

Choose a reason for hiding this comment

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

+1 thanks @artlowel and sorry for my oversight on the ssr compatibility.
The changes look good, including the tidyup of challegeHref usage, and I've confirmed ALTCHA is still working on the request-a-copy form.

@github-project-automation github-project-automation bot moved this from 👀 Under Review to 👍 Reviewer Approved in DSpace 9.0 Release Apr 10, 2025
@artlowel artlowel changed the title Fix ssr error by only importing alcha on the client side Fix ssr error by only importing altcha on the client side Apr 10, 2025
@kshepherd kshepherd added the 1 APPROVAL pull request only requires a single approval to merge label Apr 10, 2025
@kshepherd kshepherd merged commit 291db02 into DSpace:main Apr 10, 2025
15 checks passed
@github-project-automation github-project-automation bot moved this from 👍 Reviewer Approved to ✅ Done in DSpace 9.0 Release Apr 10, 2025
@artlowel artlowel deleted the only-import-altcha-on-the-browser branch April 10, 2025 11:26
@tdonohue tdonohue added this to the 9.0 milestone Apr 10, 2025
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 affects: main Issue impacts "main" (latest release). bug component: SEO Search Engine Optimization high priority testathon Reported by a tester during Community Testathon

Projects

No open projects
Status: ✅ Done

Development

Successfully merging this pull request may close these issues.

SSR for Item pages is currently broken (9.0 only)

3 participants