Skip to content

Commit 955099d

Browse files
fix(node): strip trailing slashes when resolving view names (#18372)
1 parent 32790fb commit 955099d

2 files changed

Lines changed: 62 additions & 8 deletions

File tree

‎packages/platform-node/test/views/view-renderer.spec.ts‎

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -323,6 +323,7 @@ describe('ViewRenderer', () => {
323323
renderer.setEngine({ engine: { ejs }, root: views });
324324

325325
await expect(renderer.render('users')).resolves.toBe('users index');
326+
await expect(renderer.render('users/')).resolves.toBe('users index');
326327
await expect(renderer.render('users.ejs')).resolves.toBe('users index');
327328
});
328329

@@ -334,6 +335,46 @@ describe('ViewRenderer', () => {
334335
await expect(renderer.render('users')).resolves.toBe('users file');
335336
});
336337

338+
it('should resolve to the index file when trailing slash is used, even if a file shares the name', async () => {
339+
write('views/a.ejs', 'a file');
340+
write('views/a/index.ejs', 'a index');
341+
renderer.setEngine({ engine: { ejs }, root: views });
342+
343+
await expect(renderer.render('a')).resolves.toBe('a file');
344+
await expect(renderer.render('a/')).resolves.toBe('a index');
345+
});
346+
347+
it('should not fall back to a view file when trailing slash names a missing index file', async () => {
348+
write('views/a.ejs', 'a file');
349+
renderer.setEngine({ engine: { ejs }, root: views });
350+
351+
await expect(renderer.render('a')).resolves.toBe('a file');
352+
await expect(renderer.render('a/')).rejects.toThrow(
353+
'Failed to lookup view',
354+
);
355+
});
356+
357+
it('should resolve a view named with its extension and a trailing slash, as Express does', async () => {
358+
write('views/a.ejs', 'a file');
359+
write('views/users/index.ejs', 'users index');
360+
renderer.setEngine({ engine: { ejs }, root: views });
361+
362+
await expect(renderer.render('a.ejs/')).resolves.toBe('a file');
363+
await expect(renderer.render('users.ejs/')).resolves.toBe('users index');
364+
});
365+
366+
it('should not resolve "/" to ".<ext>" at the views root', async () => {
367+
write('views/.ejs', 'root dot ejs');
368+
renderer.setEngine({ engine: { ejs }, root: views });
369+
370+
await expect(renderer.render('/')).rejects.toThrow(
371+
'Failed to lookup view',
372+
);
373+
await expect(renderer.render('\\')).rejects.toThrow(
374+
'Failed to lookup view',
375+
);
376+
});
377+
337378
it('should not take a directory named like the view file for it', async () => {
338379
mkdirSync(join(views, 'users.ejs'));
339380
write('views/users/index.ejs', 'users index');

‎packages/platform-node/views/view-renderer.ts‎

Lines changed: 21 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,14 @@
11
import { readFile, stat } from 'fs/promises';
2-
import { extname, isAbsolute, join, parse, relative, resolve, sep } from 'path';
2+
import {
3+
basename,
4+
extname,
5+
isAbsolute,
6+
join,
7+
parse,
8+
relative,
9+
resolve,
10+
sep,
11+
} from 'path';
312

413
/**
514
* Template engine configuration for `app.setViewEngine()`, shaped like the
@@ -152,9 +161,7 @@ export class ViewRenderer {
152161
private async createRenderFn(view: string): Promise<RenderFn> {
153162
const { name, module } = await this.getEngine();
154163
const extension = this.viewExt ?? DEFAULT_EXTENSIONS[name] ?? name;
155-
const file = await this.resolveFile(
156-
extname(view) ? view : `${view}.${extension}`,
157-
);
164+
const file = await this.resolveFile(view, extension);
158165
// Express-style engines take the data and the options in one object.
159166
// "settings" is where Express puts application settings and where ejs
160167
// reads its options from ("view options"): it is set last, so data derived
@@ -220,12 +227,18 @@ export class ViewRenderer {
220227
return this.engine;
221228
}
222229

223-
private async resolveFile(view: string): Promise<string> {
224-
const { dir, name, ext } = parse(view);
230+
private async resolveFile(view: string, extension: string): Promise<string> {
231+
const ext = extname(view) || `.${extension}`;
232+
const fileName = extname(view) ? view : `${view}${ext}`;
233+
const { dir, base } = parse(fileName);
225234
// "users" is "users.ext", then "users/index.ext", as with Express. Unlike
226235
// Express, which tries both in each directory in turn, a file in any
227-
// directory wins over an index
228-
for (const candidate of [view, join(dir, name, `index${ext}`)]) {
236+
// directory wins over an index. For "users/", base is only the extension,
237+
// so the index is "users/index.ext"
238+
for (const candidate of [
239+
fileName,
240+
join(dir, basename(base, ext), `index${ext}`),
241+
]) {
229242
for (const root of this.roots) {
230243
const file = resolve(root, candidate);
231244
// Never resolve outside the views directories ("../", absolute paths)

0 commit comments

Comments
 (0)