Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Show injected custom 404 route in dev #6940

Merged
merged 10 commits into from
May 1, 2023
Merged
Show file tree
Hide file tree
Changes from 5 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
14 changes: 5 additions & 9 deletions packages/astro/src/vite-plugin-astro-server/route.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import type http from 'http';
import mime from 'mime';
import type { AstroSettings, ComponentInstance, ManifestData, RouteData } from '../@types/astro';
import type { ComponentInstance, ManifestData, RouteData } from '../@types/astro';
import type {
ComponentPreload,
DevelopmentEnvironment,
Expand All @@ -12,12 +12,10 @@ import { call as callEndpoint } from '../core/endpoint/dev/index.js';
import { throwIfRedirectNotAllowed } from '../core/endpoint/index.js';
import { AstroErrorData } from '../core/errors/index.js';
import { warn } from '../core/logger/core.js';
import { appendForwardSlash } from '../core/path.js';
import { preload, renderPage } from '../core/render/dev/index.js';
import { getParamsAndProps, GetParamsAndPropsError } from '../core/render/index.js';
import { createRequest } from '../core/request.js';
import { matchAllRoutes } from '../core/routing/index.js';
import { resolvePages } from '../core/util.js';
import { log404 } from './common.js';
import { handle404Response, writeSSRResult, writeWebResponse } from './response.js';

Expand All @@ -35,11 +33,9 @@ interface MatchedRoute {
mod: ComponentInstance;
}

function getCustom404Route({ config }: AstroSettings, manifest: ManifestData) {
// For Windows compat, use relative page paths to match the 404 route
const relPages = resolvePages(config).href.replace(config.root.href, '');
const pattern = new RegExp(`${appendForwardSlash(relPages)}404.(astro|md)`);
return manifest.routes.find((r) => r.component.match(pattern));
function getCustom404Route(manifest: ManifestData): RouteData | undefined {
const route404 = /^\/404\/?$/;
return manifest.routes.find((r) => route404.test(r.route));
Copy link
Member Author

@delucis delucis Apr 29, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this is safe? Previously we only supported 404.astro, 404.md, 404.mdx, and 404.mdoc as custom 404 routes. Those would all have a route of /404 or /404/, so are still supported. This change adds custom 404 support for src/pages/404.html or for injectRoute({ pattern: '404', entrypoint: '...' }) in dev.

}

export async function matchRoute(
Expand Down Expand Up @@ -97,7 +93,7 @@ export async function matchRoute(
}

log404(logging, pathname);
const custom404 = getCustom404Route(settings, manifest);
const custom404 = getCustom404Route(manifest);

if (custom404) {
const filePath = new URL(`./${custom404.component}`, settings.config.root);
Expand Down
42 changes: 42 additions & 0 deletions packages/astro/test/custom-404-injected.test.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
import { expect } from 'chai';
import * as cheerio from 'cheerio';
import { loadFixture } from './test-utils.js';

describe('Custom 404 with injectRoute', () => {
let fixture;

before(async () => {
fixture = await loadFixture({
root: './fixtures/custom-404-injected/',
site: 'http://example.com',
});
});

describe('dev', () => {
let devServer;
let $;

before(async () => {
devServer = await fixture.startDevServer();
});

after(async () => {
await devServer.stop();
});

it('renders /', async () => {
const html = await fixture.fetch('/').then((res) => res.text());
$ = cheerio.load(html);

expect($('h1').text()).to.equal('Home');
});

it('renders 404 for /a', async () => {
const html = await fixture.fetch('/a').then((res) => res.text());
$ = cheerio.load(html);

expect($('h1').text()).to.equal('Page not found');
expect($('p').text()).to.equal('/a');
});
});
});
18 changes: 18 additions & 0 deletions packages/astro/test/fixtures/custom-404-injected/astro.config.mjs
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
import { defineConfig } from 'astro/config';

// https://astro.build/config
export default defineConfig({
integrations: [
{
name: '404-integration',
hooks: {
'astro:config:setup': ({ injectRoute }) => {
injectRoute({
pattern: '404',
entryPoint: '/src/404.astro',
});
},
},
},
],
});
8 changes: 8 additions & 0 deletions packages/astro/test/fixtures/custom-404-injected/package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
{
"name": "@test/custom-404-injected",
"version": "0.0.0",
"private": true,
"dependencies": {
"astro": "workspace:*"
}
}
13 changes: 13 additions & 0 deletions packages/astro/test/fixtures/custom-404-injected/src/404.astro
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
---
const canonicalURL = new URL(Astro.url.pathname, Astro.site);
---

<html lang="en">
<head>
<title>Not Found - Custom 404</title>
</head>
<body>
<h1>Page not found</h1>
<p>{canonicalURL.pathname}</p>
</body>
</html>
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
---

<html lang="en">
<head>
<title>Custom 404</title>
</head>
<body>
<h1>Home</h1>
</body>
</html>
62 changes: 62 additions & 0 deletions packages/astro/test/units/dev/dev.test.js
Original file line number Diff line number Diff line change
Expand Up @@ -158,6 +158,68 @@ describe('dev container', () => {
);
});

it('Serves injected 404 route for any 404', async () => {
const fs = createFs(
{
'/src/components/404.astro': `<h1>Custom 404</h1>`,
'/src/pages/page.astro': `<h1>Regular page</h1>`,
},
root
);

await runInContainer(
{
fs,
root,
userConfig: {
output: 'server',
integrations: [
{
name: '@astrojs/test-integration',
hooks: {
'astro:config:setup': ({ injectRoute }) => {
injectRoute({
pattern: '/404',
entryPoint: './src/components/404.astro',
});
},
},
},
],
},
},
async (container) => {
{
// Regular pages are served as expected.
const r = createRequestAndResponse({ method: 'GET', url: '/page' });
container.handle(r.req, r.res);
await r.done;
const doc = await r.text();
expect(doc).to.match(/<h1>Regular page<\/h1>/);
expect(r.res.statusCode).to.equal(200);
}
{
// `/404` serves the custom 404 page as expected.
const r = createRequestAndResponse({ method: 'GET', url: '/404' });
container.handle(r.req, r.res);
await r.done;
const doc = await r.text();
expect(doc).to.match(/<h1>Custom 404<\/h1>/);
expect(r.res.statusCode).to.equal(200);
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not quite sure whether we should expect a 404 status here or whether this request/response mock always returns 200?

}
{
// A non-existent page also serves the custom 404 page.
const r = createRequestAndResponse({ method: 'GET', url: '/other-page' });
container.handle(r.req, r.res);
await r.done;
const doc = await r.text();
expect(doc).to.match(/<h1>Custom 404<\/h1>/);
expect(r.res.statusCode).to.equal(200);
}
}
);
});

it('items in public/ are not available from root when using a base', async () => {
await runInContainer(
{
Expand Down
6 changes: 6 additions & 0 deletions pnpm-lock.yaml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.