From b1c5460bbba131d4f430f7d415000bc9a9809546 Mon Sep 17 00:00:00 2001 From: FrancescoMolinaro Date: Tue, 22 Apr 2025 16:16:27 +0200 Subject: [PATCH] [DURACOM-344] Adapt SSR page filtering mechanism to a not allowed list --- config/config.example.yml | 15 +++++++++++---- server.ts | 12 +++++++++++- src/config/ssr-config.interface.ts | 4 ++-- src/environments/environment.production.ts | 9 ++++++++- src/environments/environment.test.ts | 9 ++++++++- src/environments/environment.ts | 9 ++++++++- 6 files changed, 48 insertions(+), 10 deletions(-) diff --git a/config/config.example.yml b/config/config.example.yml index d5e7dfe501..c6ad21ffb8 100644 --- a/config/config.example.yml +++ b/config/config.example.yml @@ -23,10 +23,17 @@ ssr: # Determining which styles are critical is a relatively expensive operation; this option is # disabled (false) by default to boost server performance at the expense of loading smoothness. inlineCriticalCss: false - # Path prefixes to enable SSR for. By default these are limited to paths of primary DSpace objects. - # NOTE: The "/handle/" path ensures Handle redirects work via SSR. The "/reload/" path ensures - # hard refreshes (e.g. after login) trigger SSR while fully reloading the page. - paths: [ '/home', '/items/', '/entities/', '/collections/', '/communities/', '/bitstream/', '/bitstreams/', '/handle/', '/reload/' ] + # Regexes to be run against the path of the page to check if SSR is allowed. + # If the path match any of the regexes it will be served directly in CSR. + # By default, excludes community and collection browse, global browse, global search, community list, and statistics. + excludePathRegexes: [ + /^\/communities\/[ 0-9a-f ]{ 8 }-[ 0-9a-f ]{ 4 }-[ 0-9a-f ]{ 4 }-[ 0-9a-f ]{ 4 }-[ 0-9a-f ]{ 12 }\/browse(\/.*)?$/i, + /^\/collections\/[ 0-9a-f ]{ 8 }-[ 0-9a-f ]{ 4 }-[ 0-9a-f ]{ 4 }-[ 0-9a-f ]{ 4 }-[ 0-9a-f ]{ 12 }\/browse(\/.*)?$/i, + /^\/browse\//, + /^\/search$/, + /^\/community-list$/, + /^\/statistics$/, + ] # Whether to enable rendering of Search component on SSR. # If set to true the component will be included in the HTML returned from the server side rendering. # If set to false the component will not be included in the HTML returned from the server side rendering. diff --git a/server.ts b/server.ts index 52b2823d49..afde39178a 100644 --- a/server.ts +++ b/server.ts @@ -221,7 +221,7 @@ export function app() { * The callback function to serve server side angular */ function ngApp(req, res, next) { - if (environment.ssr.enabled && req.method === 'GET' && (req.path === '/' || environment.ssr.paths.some(pathPrefix => req.path.startsWith(pathPrefix)))) { + if (environment.ssr.enabled && req.method === 'GET' && (req.path === '/' || !isExcludedFromSsr(req.path, environment.ssr.excludePathRegexes))) { // Render the page to user via SSR (server side rendering) serverSideRender(req, res, next); } else { @@ -627,6 +627,16 @@ function start() { } } +/** + * Check if SSR should be skipped for path + * + * @param path + * @param excludePathRegexes + */ +function isExcludedFromSsr(path: string, excludePathRegexes: RegExp[]): boolean { + return excludePathRegexes.some((regex) => regex.test(path)); +} + /* * The callback function to serve health check requests */ diff --git a/src/config/ssr-config.interface.ts b/src/config/ssr-config.interface.ts index 2ce626b47b..13b216befc 100644 --- a/src/config/ssr-config.interface.ts +++ b/src/config/ssr-config.interface.ts @@ -39,9 +39,9 @@ export interface SSRConfig extends Config { replaceRestUrl: boolean; /** - * Paths to enable SSR for. Defaults to the home page and paths in the sitemap. + * Regexes to match url's path and check if SSR is disabled for it. */ - paths: Array; + excludePathRegexes: RegExp[]; /** * Whether to enable rendering of search component on SSR diff --git a/src/environments/environment.production.ts b/src/environments/environment.production.ts index 9bd663922c..8a96a32b19 100644 --- a/src/environments/environment.production.ts +++ b/src/environments/environment.production.ts @@ -10,7 +10,14 @@ export const environment: Partial = { inlineCriticalCss: false, transferState: true, replaceRestUrl: true, - paths: [ '/home', '/items/', '/entities/', '/collections/', '/communities/', '/bitstream/', '/bitstreams/', '/handle/', '/reload/' ], + excludePathRegexes: [ + /^\/communities\/[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}\/browse(\/.*)?$/i, + /^\/collections\/[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}\/browse(\/.*)?$/i, + /^\/browse\//, + /^\/search$/, + /^\/community-list$/, + /^\/statistics$/, + ], enableSearchComponent: false, enableBrowseComponent: false, }, diff --git a/src/environments/environment.test.ts b/src/environments/environment.test.ts index b6348f949d..20585e17b6 100644 --- a/src/environments/environment.test.ts +++ b/src/environments/environment.test.ts @@ -14,7 +14,14 @@ export const environment: BuildConfig = { inlineCriticalCss: false, transferState: true, replaceRestUrl: false, - paths: [ '/home', '/items/', '/entities/', '/collections/', '/communities/', '/bitstream/', '/bitstreams/', '/handle/', '/reload/' ], + excludePathRegexes: [ + /^\/communities\/[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}\/browse(\/.*)?$/i, + /^\/collections\/[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}\/browse(\/.*)?$/i, + /^\/browse\//, + /^\/search$/, + /^\/community-list$/, + /^\/statistics$/, + ], enableSearchComponent: false, enableBrowseComponent: false, }, diff --git a/src/environments/environment.ts b/src/environments/environment.ts index 39ab31de03..34d820aec9 100644 --- a/src/environments/environment.ts +++ b/src/environments/environment.ts @@ -15,7 +15,14 @@ export const environment: Partial = { inlineCriticalCss: false, transferState: true, replaceRestUrl: false, - paths: [ '/home', '/items/', '/entities/', '/collections/', '/communities/', '/bitstream/', '/bitstreams/', '/handle/', '/reload/' ], + excludePathRegexes: [ + /^\/communities\/[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}\/browse(\/.*)?$/i, + /^\/collections\/[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}\/browse(\/.*)?$/i, + /^\/browse\//, + /^\/search$/, + /^\/community-list$/, + /^\/statistics$/, + ], enableSearchComponent: false, enableBrowseComponent: false, },