summaryrefslogtreecommitdiff
path: root/packages/integrations/web-vitals/src/index.ts
blob: c74ab32613eea096eef98993fff4d1c6a26e1a95 (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
import { defineDbIntegration } from '@astrojs/db/utils';
import { AstroError } from 'astro/errors';
import { WEB_VITALS_ENDPOINT_PATH } from './constants.js';

export default function webVitals({ deprecated }: { deprecated?: boolean } = {}) {
	process.env.DEPRECATE_WEB_VITALS = deprecated ? 'true' : undefined;
	return defineDbIntegration({
		name: '@astrojs/web-vitals',
		hooks: {
			'astro:db:setup'({ extendDb }) {
				extendDb({ configEntrypoint: '@astrojs/web-vitals/db-config' });
			},

			'astro:config:setup'({ addMiddleware, config, injectRoute, injectScript }) {
				if (!config.integrations.find(({ name }) => name === 'astro:db')) {
					throw new AstroError(
						'Astro DB integration not found.',
						'Run `npx astro add db` to install `@astrojs/db` and add it to your Astro config.',
					);
				}

				// Middleware that adds a `<meta>` tag to each page.
				addMiddleware({ entrypoint: '@astrojs/web-vitals/middleware', order: 'post' });
				// Endpoint that collects metrics and inserts them in Astro DB.
				injectRoute({
					entrypoint: '@astrojs/web-vitals/endpoint',
					pattern: WEB_VITALS_ENDPOINT_PATH + '/[...any]',
					prerender: false,
				});
				// Client-side performance measurement script.
				injectScript('page', `import '@astrojs/web-vitals/client-script';`);
			},
		},
	});
}