Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 7 additions & 18 deletions server.ts
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,7 @@ import {
RESPONSE,
} from './src/express.tokens';
import { SsrExcludePatterns } from "./src/config/ssr-config.interface";
import { getSsrCacheKey } from './src/app/shared/ssr-cache-key.util';

/*
* Set path for the browser application's dist folder
Expand Down Expand Up @@ -403,14 +404,14 @@ function anonymousCacheEnabled(): boolean {

/**
* Check if the currently requested page is in our server-side, in-memory cache.
* Caching is ONLY done for SSR requests. Pages are cached base on their path (e.g. /home or /search?query=test)
* Caching is ONLY done for SSR requests. Pages are cached by path, origin and language (see getSsrCacheKey)
*/
function cacheCheck(req, res, next) {
// Cached copy of page (if found)
let cachedCopy;

// If the bot cache is enabled and this request looks like a bot, check the bot cache for a cached page.
if (botCacheEnabled() && isbot(req.get('user-agent'))) {
// If the bot cache is enabled and this request looks like an anonymous bot, check the bot cache for a cached page.
if (botCacheEnabled() && isbot(req.get('user-agent')) && !isUserAuthenticated(req)) {
cachedCopy = checkCacheForRequest('bot', botCache, req, res, next);
} else if (anonymousCacheEnabled() && !isUserAuthenticated(req)) {
cachedCopy = checkCacheForRequest('anonymous', anonymousCache, req, res, next);
Expand Down Expand Up @@ -454,7 +455,7 @@ function cacheCheck(req, res, next) {
*/
function checkCacheForRequest(cacheName: string, cache: LRUCache<string, any>, req, res, next): any {
// Get the cache key for this request
const key = getCacheKey(req);
const key = getSsrCacheKey(req);

// Check if this page is in our cache
const cachedCopy = cache.get(key);
Expand All @@ -478,18 +479,6 @@ function checkCacheForRequest(cacheName: string, cache: LRUCache<string, any>, r
return cachedCopy;
}

/**
* Create a cache key from the current request.
* The cache key is the URL path (NOTE: this key will also include any querystring params).
* E.g. "/home" or "/search?query=test"
* @param req current request
* @returns cache key to use for this page
*/
function getCacheKey(req): string {
// NOTE: this will return the URL path *without* any baseUrl
return req.url;
}

/**
* Save page to server side cache(s), if enabled. If caching is not enabled or a user is authenticated, this is a noop
* If multiple caches are enabled, the page will be saved to any caches where it does not yet exist (or is expired).
Expand All @@ -502,9 +491,9 @@ function saveToCache(req, page: any) {
// NOTE: It's not safe to save page data to the cache when a user is authenticated. In that situation,
// the page may include sensitive or user-specific materials. As the cache is shared across all users, it can only contain public info.
if (!isUserAuthenticated(req)) {
const key = getCacheKey(req);
const key = getSsrCacheKey(req);
// Avoid caching "/reload/[random]" paths (these are hard refreshes after logout)
if (key.startsWith('/reload')) { return; }
if (req.url.startsWith('/reload')) { return; }
// Avoid caching not successful responses (status code different from 2XX status)
if (hasNotSucceeded(req.res.statusCode)) { return; }

Expand Down
32 changes: 20 additions & 12 deletions src/app/shared/html-content.service.spec.ts
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ describe('HtmlContentService', () => {
/**
* @param nameSpace value of appConfig.ui.nameSpace
* @param platformId 'server' exercises the SSR branch of buildRuntimeUrl
* @param request the express request injected through the REQUEST token
* @param request an express request provided through the REQUEST token; the service ignores it
*/
function setup(nameSpace: string, platformId: string = 'browser', request?: any): void {
TestBed.configureTestingModule({
Expand All @@ -52,7 +52,7 @@ describe('HtmlContentService', () => {
{
provide: APP_CONFIG,
useValue: {
ui: { nameSpace },
ui: { nameSpace, baseUrl: `http://localhost:4000${nameSpace}` },
},
},
],
Expand Down Expand Up @@ -170,28 +170,36 @@ describe('HtmlContentService', () => {
expect(content).toBe('');
});

it('should build an absolute URL from the injected express REQUEST when rendering on the server', async () => {
setup('/repository', 'server', expressRequest('https', 'dev-6.pc:8603'));
it('should fetch static content from the configured UI origin, not the request Host, during SSR', async () => {
setup('/repository', 'server', expressRequest('https', 'other.example'));

const contentPromise = firstValueFrom(service.getHtmlContent('static-files/about.html'));

const request = httpMock.expectOne('https://dev-6.pc:8603/repository/static-files/about.html');
expect(request.request.method).toBe('GET');
request.flush('<div>About</div>');
const promise = service.getHmtlContentByPathAndLocale('about');
await settle();

expect(await contentPromise).toBe('<div>About</div>');
httpMock.expectOne('http://localhost:4000/repository/static-files/about.html').flush('Trusted content');
expect(await promise).toBe('Trusted content');
});

it('should keep the relative URL on the server when no REQUEST is available', async () => {
it('should use the configured UI origin on the server also without a REQUEST', async () => {
setup('/repository', 'server');

const contentPromise = firstValueFrom(service.getHtmlContent('static-files/about.html'));

httpMock.expectOne('/repository/static-files/about.html').flush('<div>About</div>');
httpMock.expectOne('http://localhost:4000/repository/static-files/about.html').flush('<div>About</div>');

expect(await contentPromise).toBe('<div>About</div>');
});

it('should not request a file name that leaves static-files once decoded', async () => {
setup('/repository');

const promise = service.getHmtlContentByPathAndLocale('..%2Findex');
await settle();

httpMock.expectNone(() => true);
expect(await promise).toBeUndefined();
});

it('should ignore the REQUEST and keep the relative URL in the browser', async () => {
setup('/repository', 'browser', expressRequest('https', 'dev-6.pc:8603'));

Expand Down
30 changes: 19 additions & 11 deletions src/app/shared/html-content.service.ts
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,6 @@ import {
import {
Inject,
Injectable,
Optional,
PLATFORM_ID,
} from '@angular/core';
import {
Expand All @@ -19,7 +18,6 @@ import {
APP_CONFIG,
AppConfig,
} from '../../config/app-config.interface';
import { REQUEST } from '../../express.tokens';
import { LocaleService } from '../core/locale/locale.service';
import {
HTML_SUFFIX,
Expand All @@ -36,7 +34,6 @@ export class HtmlContentService {
private localeService: LocaleService,
@Inject(APP_CONFIG) protected appConfig?: AppConfig,
@Inject(PLATFORM_ID) private platformId?: object,
@Optional() @Inject(REQUEST) private request?: any,
) {}

private getNamespacePrefix(): string {
Expand All @@ -63,17 +60,12 @@ export class HtmlContentService {
}

private buildRuntimeUrl(path: string): string {
if (!isPlatformServer(this.platformId) || !this.request) {
if (!isPlatformServer(this.platformId)) {
return path;
}

const protocol = this.request.protocol;
const host = this.request.get?.('host');
if (!protocol || !host) {
return path;
}

return `${protocol}://${host}${path}`;
// The request Host header is client-controlled; SSR loads static HTML only from the configured UI origin.
return `${new URL(this.appConfig.ui.baseUrl).origin}${path}`;
}

getHtmlContent(url: string) {
Expand Down Expand Up @@ -109,10 +101,26 @@ export class HtmlContentService {
return undefined;
}

/**
* Whether a file name taken from the URL is still one file name once the server decodes it,
* so it cannot address a file outside `static-files` (e.g. `..%2Findex`). A query part is ignored.
*/
private isPlainFileName(fileName: string): boolean {
try {
return !/[/\\]/.test(decodeURIComponent(fileName.split('?')[0]));
} catch {
// Missing name or malformed percent-encoding: nothing to load.
return false;
}
}

/**
* Get the html file content as a string by the file name and the current locale.
*/
async getHmtlContentByPathAndLocale(fileName: string) {
if (!this.isPlainFileName(fileName)) {
return undefined;
}
let url = '';
// Get current language
let language = await firstValueFrom(this.localeService.getCurrentLanguageCode());
Expand Down
21 changes: 21 additions & 0 deletions src/app/shared/ssr-cache-key.util.spec.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
import { Request } from 'express';

import { LANG_COOKIE } from '../core/locale/locale.service';
import { getSsrCacheKey } from './ssr-cache-key.util';

describe('getSsrCacheKey', () => {
function request(protocol: string, host: string, cookies: Record<string, string> = {}): Request {
return { url: '/static/about', protocol, get: () => host, cookies } as unknown as Request;
}

it('should separate renders for different language cookies', () => {
expect(getSsrCacheKey(request('https', 'repo.example', { [LANG_COOKIE]: 'cs' })))
.not.toEqual(getSsrCacheKey(request('https', 'repo.example', { [LANG_COOKIE]: 'en' })));
});

it('should separate renders for different request origins', () => {
const key = getSsrCacheKey(request('https', 'repo.example'));
expect(getSsrCacheKey(request('https', 'other.example'))).not.toEqual(key);
expect(getSsrCacheKey(request('http', 'repo.example'))).not.toEqual(key);
});
});
13 changes: 13 additions & 0 deletions src/app/shared/ssr-cache-key.util.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
import { Request } from 'express';

import { LANG_COOKIE } from '../core/locale/locale.service';

/**
* Key of a server-side rendered page in the SSR page caches (see server.ts).
* Besides path and query, an anonymous render depends on the request origin (protocol and Host header)
* and on the language cookie, so they are part of the key.
* @param req current request
*/
export function getSsrCacheKey(req: Request): string {
return JSON.stringify([req.protocol, req.get('host'), req.cookies?.[LANG_COOKIE], req.url]);
}
Loading