hazza/dspace-angular
1
0
Fork 1
mirror of https://github.com/DSpace/dspace-angular.git synced 2025-10-07 01:54:15 +00:00
Code Issues Packages Projects Releases Wiki Activity

[DURACOM-344] Adapt SSR page filtering mechanism to a not allowed list

Browse Source
This commit is contained in:
FrancescoMolinaro
2025-04-22 16:16:27 +02:00
parent 9a24fb2b64
commit b1c5460bbb
6 changed files with 48 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
config/config.example.yml
View File

@@ -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.

12
server.ts
View File

@@ -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
*/

4
src/config/ssr-config.interface.ts
View File

@@ -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<string>;
excludePathRegexes: RegExp[];
/**
* Whether to enable rendering of search component on SSR

9
src/environments/environment.production.ts
View File

@@ -10,7 +10,14 @@ export const environment: Partial<BuildConfig> = {
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,
},

9
src/environments/environment.test.ts
View File

@@ -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,
},

9
src/environments/environment.ts
View File

@@ -15,7 +15,14 @@ export const environment: Partial<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,
},