Skip to content

Simplify default SSR excludePathPatterns (and consider prefix matching instead of regex) - #6279

Open
saschaszott wants to merge 8 commits into
DSpace:mainfrom
saschaszott:saschaszott-patch-29
Open

saschaszott wants to merge 8 commits into
DSpace:mainfrom
saschaszott:saschaszott-patch-29

Conversation

@saschaszott

Copy link
Copy Markdown
Contributor

References

n/a

Description

This PR simplifies the default ssr.excludePathPatterns to plain path prefixes.

Since none of the remaining defaults actually needs regex features anymore, this PR also asks the community whether regex matching is still needed, or whether a simple prefix check (path.startsWith(prefix)) would be sufficient.

The current defaults mix anchored ($) and unanchored patterns, which is easy to get wrong:

  • ^/statistics/? / ^/processes/?: the optional /? has no effect without $
  • ^/community-list$ / ^/health$: a trailing slash is not matched (/community-list/ is still rendered via SSR)

Question to reviewers / the DSpace community

Do we still need regex support for excludePathPatterns, or would a simple URL path "startsWith" check be enough?

Arguments for a prefix check (and against regex-based comparision):

  • easier to configure, e.g., no pitfalls with anchors
  • no escaping needed
  • no regex flags needed
  • all default patterns are plain prefixes anyway

Instructions for Reviewers

  1. build and start the DSpace frontend in production mode (with SSR enabled)
  2. Request an excluded path (e.g. /search, /browse) and check that the server log prints Universal off, serving for direct client-side rendering (CSR)
  3. Request a non-excluded path (e.g. /, /items/<uuid>) and check that the page is server-side rendered (view source contains rendered content)

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 follows all coding best practices based on the Code Conventions Guide
  • My PR passes ESLint validation using npm run lint
  • x ] 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.
  • x ] 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.

@saschaszott

Copy link
Copy Markdown
Contributor Author

Please note that this PR is currently causing some SSR checks in build.yml to fail, for example those for collections and communities. We should first clarify whether we actually need SSR for collections and communities, and whether the sitemap should continue to include their URLs. I've also raised this question in the #dev Slack channel.

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant