Make Content Layer unit testable (#15659)

Author: matthewp

packages/astro/src/content/content-layer.ts

@@ -32,11 +32,12 @@ import {
 } from './utils.js';
 import { createWatcherWrapper, type WrappedWatcher } from './watcher.js';
 
-interface ContentLayerOptions {
+export interface ContentLayerOptions {
 	store: MutableDataStore;
 	settings: AstroSettings;
 	logger: Logger;
 	watcher?: FSWatcher;
+	contentConfigObserver?: ContentObservable;
 }
 
 type CollectionLoader<TData> = () =>
@@ -45,7 +46,7 @@ type CollectionLoader<TData> = () =>
 	| Record<string, Record<string, unknown>>
 	| Promise<Record<string, Record<string, unknown>>>;
 
-class ContentLayer {
+export class ContentLayer {
 	#logger: Logger;
 	#store: MutableDataStore;
 	#settings: AstroSettings;
@@ -54,16 +55,24 @@ class ContentLayer {
 	#unsubscribe?: () => void;
 	#markdownProcessor?: MarkdownProcessor;
 	#generateDigest?: (data: Record<string, unknown> | string) => string;
+	#contentConfigObserver: ContentObservable;
 
 	#queue: PQueue;
 
-	constructor({ settings, logger, store, watcher }: ContentLayerOptions) {
+	constructor({
+		settings,
+		logger,
+		store,
+		watcher,
+		contentConfigObserver = globalContentConfigObserver,
+	}: ContentLayerOptions) {
 		// The default max listeners is 10, which can be exceeded when using a lot of loaders
 		watcher?.setMaxListeners(50);
 
 		this.#logger = logger;
 		this.#store = store;
 		this.#settings = settings;
+		this.#contentConfigObserver = contentConfigObserver;
 		if (watcher) {
 			this.#watcher = createWatcherWrapper(watcher);
 		}
@@ -82,7 +91,7 @@ class ContentLayer {
 	 */
 	watchContentConfig() {
 		this.#unsubscribe?.();
-		this.#unsubscribe = globalContentConfigObserver.subscribe(async (ctx) => {
+		this.#unsubscribe = this.#contentConfigObserver.subscribe(async (ctx) => {
 			if (ctx.status === 'loaded' && ctx.config.digest !== this.#lastConfigDigest) {
 				this.sync();
 			}
@@ -172,13 +181,13 @@ class ContentLayer {
 	}
 
 	async #doSync(options: RefreshContentOptions) {
-		let contentConfig = globalContentConfigObserver.get();
+		let contentConfig = this.#contentConfigObserver.get();
 		const logger = this.#logger.forkIntegrationLogger('content');
 
 		if (contentConfig?.status === 'loading') {
 			contentConfig = await Promise.race<ReturnType<ContentObservable['get']>>([
 				new Promise((resolve) => {
-					const unsub = globalContentConfigObserver.subscribe((ctx) => {
+					const unsub = this.#contentConfigObserver.subscribe((ctx) => {
 						unsub();
 						resolve(ctx);
 					});
@@ -230,9 +239,9 @@ class ContentLayer {
 		this.#lastConfigDigest = currentConfigDigest;
 
 		let shouldClear = false;
-		const previousConfigDigest = await this.#store.metaStore().get('content-config-digest');
-		const previousAstroConfigDigest = await this.#store.metaStore().get('astro-config-digest');
-		const previousAstroVersion = await this.#store.metaStore().get('astro-version');
+		const previousConfigDigest = this.#store.metaStore().get('content-config-digest');
+		const previousAstroConfigDigest = this.#store.metaStore().get('astro-config-digest');
+		const previousAstroVersion = this.#store.metaStore().get('astro-version');
 
 		if (previousAstroConfigDigest && previousAstroConfigDigest !== astroConfigDigest) {
 			logger.info('Astro config changed');
@@ -252,13 +261,13 @@ class ContentLayer {
 			this.#store.clearAll();
 		}
 		if (process.env.ASTRO_VERSION) {
-			await this.#store.metaStore().set('astro-version', process.env.ASTRO_VERSION);
+			this.#store.metaStore().set('astro-version', process.env.ASTRO_VERSION);
 		}
 		if (currentConfigDigest) {
-			await this.#store.metaStore().set('content-config-digest', currentConfigDigest);
+			this.#store.metaStore().set('content-config-digest', currentConfigDigest);
 		}
 		if (astroConfigDigest) {
-			await this.#store.metaStore().set('astro-config-digest', astroConfigDigest);
+			this.#store.metaStore().set('astro-config-digest', astroConfigDigest);
 		}
 
 		if (!options?.loaders?.length) {
@@ -459,21 +468,3 @@ async function simpleLoader<TData extends { id: string }>(
 export function getDataStoreFile(settings: AstroSettings, isDev: boolean) {
 	return new URL(DATA_STORE_FILE, isDev ? settings.dotAstroDir : settings.config.cacheDir);
 }
-
-function contentLayerSingleton() {
-	let instance: ContentLayer | null = null;
-	return {
-		init: (options: ContentLayerOptions) => {
-			instance?.dispose();
-			instance = new ContentLayer(options);
-			return instance;
-		},
-		get: () => instance,
-		dispose: () => {
-			instance?.dispose();
-			instance = null;
-		},
-	};
-}
-
-export const globalContentLayer = contentLayerSingleton();

packages/astro/src/content/instance.ts

@@ -0,0 +1,30 @@
+import type { FSWatcher } from 'vite';
+import { ContentLayer } from './content-layer.js';
+import type { Logger } from '../core/logger/core.js';
+import type { AstroSettings } from '../types/astro.js';
+import type { MutableDataStore } from './mutable-data-store.js';
+
+interface ContentLayerOptions {
+	store: MutableDataStore;
+	settings: AstroSettings;
+	logger: Logger;
+	watcher?: FSWatcher;
+}
+
+function contentLayerSingleton() {
+	let instance: ContentLayer | null = null;
+	return {
+		init: (options: ContentLayerOptions) => {
+			instance?.dispose();
+			instance = new ContentLayer(options);
+			return instance;
+		},
+		get: () => instance,
+		dispose: () => {
+			instance?.dispose();
+			instance = null;
+		},
+	};
+}
+
+export const globalContentLayer = contentLayerSingleton();

packages/astro/src/core/dev/dev.ts

@@ -5,7 +5,8 @@ import { performance } from 'node:perf_hooks';
 import colors from 'piccolore';
 import { gt, major, minor, patch } from 'semver';
 import type * as vite from 'vite';
-import { getDataStoreFile, globalContentLayer } from '../../content/content-layer.js';
+import { getDataStoreFile } from '../../content/content-layer.js';
+import { globalContentLayer } from '../../content/instance.js';
 import { attachContentServerListeners } from '../../content/index.js';
 import { MutableDataStore } from '../../content/mutable-data-store.js';
 import { globalContentConfigObserver } from '../../content/utils.js';

packages/astro/src/core/dev/restart.ts

@@ -1,7 +1,7 @@
 import type nodeFs from 'node:fs';
 import { fileURLToPath } from 'node:url';
 import * as vite from 'vite';
-import { globalContentLayer } from '../../content/content-layer.js';
+import { globalContentLayer } from '../../content/instance.js';
 import { attachContentServerListeners } from '../../content/server-listeners.js';
 import { eventCliSession, telemetry } from '../../events/index.js';
 import { SETTINGS_FILE } from '../../preferences/constants.js';

packages/astro/src/core/sync/index.ts

@@ -6,7 +6,8 @@ import colors from 'piccolore';
 import { createServer, type FSWatcher, type HotPayload, type ViteDevServer } from 'vite';
 import { syncFonts } from '../../assets/fonts/sync.js';
 import { CONTENT_TYPES_FILE } from '../../content/consts.js';
-import { getDataStoreFile, globalContentLayer } from '../../content/content-layer.js';
+import { getDataStoreFile } from '../../content/content-layer.js';
+import { globalContentLayer } from '../../content/instance.js';
 import { createContentTypesGenerator } from '../../content/index.js';
 import { MutableDataStore } from '../../content/mutable-data-store.js';
 import { getContentPaths, globalContentConfigObserver } from '../../content/utils.js';

packages/astro/src/integrations/hooks.ts

@@ -7,7 +7,7 @@ import { mergeConfig as mergeViteConfig } from 'vite';
 import astroIntegrationActionsRouteHandler from '../actions/integration.js';
 import { isActionsFilePresent } from '../actions/utils.js';
 import { CONTENT_LAYER_TYPE } from '../content/consts.js';
-import { globalContentLayer } from '../content/content-layer.js';
+import { globalContentLayer } from '../content/instance.js';
 import { globalContentConfigObserver } from '../content/utils.js';
 import type { SerializedSSRManifest } from '../core/app/types.js';
 import type { PageBuildData } from '../core/build/types.js';