aboutsummaryrefslogtreecommitdiff
path: root/packages/astro/test/ssr-prerender-get-static-paths.test.js
blob: 50b403891d112910dc7057181624eac74740591b (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
import assert from 'node:assert/strict';
import { after, afterEach, before, describe, it } from 'node:test';
import * as cheerio from 'cheerio';
import testAdapter from './test-adapter.js';
import { loadFixture } from './test-utils.js';

describe('Prerender', () => {
	/** @type {import('./test-utils').Fixture} */
	let fixture;
	describe('output: "server"', () => {
		describe('getStaticPaths - build calls', () => {
			before(async () => {
				fixture = await loadFixture({
					root: './fixtures/ssr-prerender-get-static-paths/',
					site: 'https://mysite.dev/',
					adapter: testAdapter(),
					base: '/blog',
					output: 'server',
				});
				await fixture.build();
			});

			after(async () => {
				await fixture.clean();
			});

			afterEach(() => {
				// reset the flag used by [...calledTwiceTest].astro between each test
				globalThis.isCalledOnce = false;
			});

			it('is only called once during build', () => {
				// useless expect; if build() throws in setup then this test fails
				assert.equal(true, true);
			});

			it('Astro.url sets the current pathname', async () => {
				const html = await fixture.readFile('/client/food/tacos/index.html');
				const $ = cheerio.load(html);

				assert.equal($('#props').text(), '10');
				assert.equal($('#url').text(), '/blog/food/tacos/');
			});
		});

		describe('getStaticPaths - dev calls', () => {
			let devServer;

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

			afterEach(() => {
				// reset the flag used by [...calledTwiceTest].astro between each test
				globalThis.isCalledOnce = false;
			});

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

			it('only calls prerender getStaticPaths once', async function () {
				// Sometimes this fail in CI as the chokidar watcher triggers an update and invalidates the route cache,
				// causing getStaticPaths to be called twice. Workaround this with 2 retries for now.
				// it was used in the original test using chai, but it's not available in the current version of node:test
				// this.retries(2);

				let res = await fixture.fetch('/blog/a');
				assert.equal(res.status, 200);

				res = await fixture.fetch('/blog/b');
				assert.equal(res.status, 200);

				res = await fixture.fetch('/blog/c');
				assert.equal(res.status, 200);
			});

			describe('404 behavior', () => {
				it('resolves 200 on matching static path - named params', async () => {
					const res = await fixture.fetch('/blog/pizza/provolone-sausage');
					assert.equal(res.status, 200);
				});

				it('resolves 404 on pattern match without static path - named params', async () => {
					const res = await fixture.fetch('/blog/pizza/provolone-pineapple');
					const html = await res.text();
					assert.equal(res.status, 404);
					assert.match(html, /404/);
				});

				it('resolves 200 on matching static path - rest params', async () => {
					const res = await fixture.fetch('/blog/pizza/grimaldis/new-york');
					assert.equal(res.status, 200);
				});

				it('resolves 404 on pattern match without static path - rest params', async () => {
					const res = await fixture.fetch('/blog/pizza/pizza-hut');
					const html = await res.text();

					assert.equal(res.status, 404);
					assert.match(html, /404/);
				});
			});

			describe('route params type validation', () => {
				it('resolves 200 on matching static path - string params', async () => {
					// route provided with { params: { year: "2022", slug: "post-2" }}
					const res = await fixture.fetch('/blog/blog/2022/post-1');
					assert.equal(res.status, 200);
				});

				it('resolves 200 on matching static path - numeric params', async () => {
					// route provided with { params: { year: 2022, slug: "post-2" }}
					const res = await fixture.fetch('/blog/blog/2022/post-2');
					assert.equal(res.status, 200);
				});
			});

			it('resolves 200 on matching static paths', async () => {
				// routes params provided for pages /posts/1, /posts/2, and /posts/3
				for (const page of [1, 2, 3]) {
					let res = await fixture.fetch(`/blog/posts/${page}`);
					assert.equal(res.status, 200);

					const html = await res.text();
					const $ = cheerio.load(html);

					const canonical = $('link[rel=canonical]');
					assert.equal(
						canonical.attr('href'),
						`https://mysite.dev/blog/posts/${page}`,
						`doesn't trim the /${page} route param`,
					);
				}
			});
		});
	});

	describe('output: "hybrid"', () => {
		describe('getStaticPaths - build calls', () => {
			before(async () => {
				fixture = await loadFixture({
					root: './fixtures/ssr-prerender-get-static-paths/',
					site: 'https://mysite.dev/',
					adapter: testAdapter(),
					base: '/blog',
					output: 'hybrid',
					vite: {
						plugins: [vitePluginRemovePrerenderExport()],
					},
				});
				await fixture.build();
			});

			after(async () => {
				await fixture.clean();
			});

			afterEach(() => {
				// reset the flag used by [...calledTwiceTest].astro between each test
				globalThis.isCalledOnce = false;
			});

			it('is only called once during build', () => {
				// useless expect; if build() throws in setup then this test fails
				assert.equal(true, true);
			});

			it('Astro.url sets the current pathname', async () => {
				const html = await fixture.readFile('/client/food/tacos/index.html');
				const $ = cheerio.load(html);

				assert.equal($('#props').text(), '10');
				assert.equal($('#url').text(), '/blog/food/tacos/');
			});
		});

		describe('getStaticPaths - dev calls', () => {
			let devServer;

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

			afterEach(() => {
				// reset the flag used by [...calledTwiceTest].astro between each test
				globalThis.isCalledOnce = false;
			});

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

			it('only calls hybrid getStaticPaths once', async () => {
				let res = await fixture.fetch('/blog/a');
				assert.equal(res.status, 200);

				res = await fixture.fetch('/blog/b');
				assert.equal(res.status, 200);

				res = await fixture.fetch('/blog/c');
				assert.equal(res.status, 200);
			});

			describe('404 behavior', () => {
				it('resolves 200 on matching static path - named params', async () => {
					const res = await fixture.fetch('/blog/pizza/provolone-sausage');
					assert.equal(res.status, 200);
				});

				it('resolves 404 on pattern match without static path - named params', async () => {
					const res = await fixture.fetch('/blog/pizza/provolone-pineapple');
					const html = await res.text();
					assert.equal(res.status, 404);
					assert.match(html, /404/);
				});

				it('resolves 200 on matching static path - rest params', async () => {
					const res = await fixture.fetch('/blog/pizza/grimaldis/new-york');
					assert.equal(res.status, 200);
				});

				it('resolves 404 on pattern match without static path - rest params', async () => {
					const res = await fixture.fetch('/blog/pizza/pizza-hut');
					const html = await res.text();

					assert.equal(res.status, 404);
					assert.match(html, /404/);
				});
			});

			describe('route params type validation', () => {
				it('resolves 200 on matching static path - string params', async () => {
					// route provided with { params: { year: "2022", slug: "post-2" }}
					const res = await fixture.fetch('/blog/blog/2022/post-1');
					assert.equal(res.status, 200);
				});

				it('resolves 200 on matching static path - numeric params', async () => {
					// route provided with { params: { year: 2022, slug: "post-2" }}
					const res = await fixture.fetch('/blog/blog/2022/post-2');
					assert.equal(res.status, 200);
				});
			});

			it('resolves 200 on matching static paths', async () => {
				// routes params provided for pages /posts/1, /posts/2, and /posts/3
				for (const page of [1, 2, 3]) {
					let res = await fixture.fetch(`/blog/posts/${page}`);
					assert.equal(res.status, 200);

					const html = await res.text();
					const $ = cheerio.load(html);

					const canonical = $('link[rel=canonical]');
					assert.equal(
						canonical.attr('href'),
						`https://mysite.dev/blog/posts/${page}`,
						`doesn't trim the /${page} route param`,
					);
				}
			});
		});
	});
});

/** @returns {import('vite').Plugin} */
function vitePluginRemovePrerenderExport() {
	const EXTENSIONS = ['.astro', '.ts'];
	/** @type {import('vite').Plugin} */
	const plugin = {
		name: 'remove-prerender-export',
		transform(code, id) {
			if (!EXTENSIONS.some((ext) => id.endsWith(ext))) return;
			return code.replace(/export\s+const\s+prerender\s+=\s+true;/g, '');
		},
	};
	return {
		name: 'remove-prerender-export-injector',
		configResolved(resolved) {
			resolved.plugins.unshift(plugin);
		},
	};
}