@ecopages/core 0.2.0-alpha.23 → 0.2.0-alpha.25

package/src/services/assets/asset-processing-service/processors/script/file-script.processor.test.ts

@@ -0,0 +1,326 @@
+import { describe, expect, test, beforeEach, afterEach, vi } from 'vitest';
+import { fileSystem } from '@ecopages/file-system';
+import { FileScriptProcessor } from './file-script.processor';
+import type { EcoPagesAppConfig, IHmrManager } from '../../../../../types/internal-types';
+import type { FileScriptAsset } from '../../assets.types';
+
+const originalReadFileSync = fileSystem.readFileSync;
+const originalCopyFile = fileSystem.copyFile;
+const originalExists = fileSystem.exists;
+
+const createMockConfig = (): EcoPagesAppConfig =>
+	({
+		rootDir: '/test/project',
+		srcDir: 'src',
+		distDir: '.eco/public',
+		absolutePaths: {
+			distDir: '/test/project/.eco/public',
+			srcDir: '/test/project/src',
+		},
+		processors: new Map(),
+		loaders: new Map(),
+	}) as unknown as EcoPagesAppConfig;
+
+describe('FileScriptProcessor', () => {
+	let readFileSyncMock: any;
+	let copyFileMock: any;
+	let existsMock: any;
+
+	beforeEach(() => {
+		readFileSyncMock = vi.fn(() => 'console.log("test");');
+		copyFileMock = vi.fn(() => {});
+		existsMock = vi.fn(() => false);
+		fileSystem.readFileSync = readFileSyncMock;
+		fileSystem.copyFile = copyFileMock;
+		fileSystem.exists = existsMock;
+	});
+
+	afterEach(() => {
+		fileSystem.readFileSync = originalReadFileSync;
+		fileSystem.copyFile = originalCopyFile;
+		fileSystem.exists = originalExists;
+		vi.restoreAllMocks();
+	});
+
+	describe('setHmrManager', () => {
+		test('should accept an HMR manager', () => {
+			const processor = new FileScriptProcessor({ appConfig: createMockConfig() });
+			const HmrManager = {
+				isEnabled: () => true,
+				registerScriptEntrypoint: async () => '/hmr/script.js',
+			} as unknown as IHmrManager;
+
+			expect(() => processor.setHmrManager(HmrManager)).not.toThrow();
+		});
+	});
+
+	describe('process', () => {
+		test('should delegate to HMR manager when enabled and not inline and preserve excludeFromHtml', async () => {
+			const processor = new FileScriptProcessor({ appConfig: createMockConfig() });
+			const HmrManager = {
+				isEnabled: () => true,
+				registerScriptEntrypoint: vi.fn(async () => '/hmr/script.js'),
+				getDistDir: () => '/test/project/.eco/public/assets/_hmr',
+			} as unknown as IHmrManager;
+			processor.setHmrManager(HmrManager);
+
+			const dep: FileScriptAsset = {
+				kind: 'script',
+				source: 'file',
+				filepath: '/test/project/src/script.ts',
+				inline: false,
+				excludeFromHtml: true,
+			};
+
+			const result = await processor.process(dep);
+
+			expect(HmrManager.registerScriptEntrypoint).toHaveBeenCalledWith('/test/project/src/script.ts');
+			expect(result.srcUrl).toBe('/hmr/script.js');
+			expect(result.filepath).toBe('/test/project/.eco/public/assets/_hmr/script.js');
+			expect(result.inline).toBe(false);
+			expect(result.excludeFromHtml).toBe(true);
+		});
+
+		test('should preserve excludeFromHtml: false when delegating to HMR manager', async () => {
+			const processor = new FileScriptProcessor({ appConfig: createMockConfig() });
+			const HmrManager = {
+				isEnabled: () => true,
+				registerScriptEntrypoint: vi.fn(async () => '/hmr/script.js'),
+			} as unknown as IHmrManager;
+			processor.setHmrManager(HmrManager);
+
+			const dep: FileScriptAsset = {
+				kind: 'script',
+				source: 'file',
+				filepath: '/test/project/src/script.ts',
+				inline: false,
+				excludeFromHtml: false,
+			};
+
+			const result = await processor.process(dep);
+
+			expect(HmrManager.registerScriptEntrypoint).toHaveBeenCalledWith('/test/project/src/script.ts');
+			expect(result.srcUrl).toBe('/hmr/script.js');
+			expect(result.inline).toBe(false);
+			expect(result.excludeFromHtml).toBe(false);
+		});
+
+		test('should fall back to the source filepath when the HMR manager does not expose a dist directory', async () => {
+			const processor = new FileScriptProcessor({ appConfig: createMockConfig() });
+			const HmrManager = {
+				isEnabled: () => true,
+				registerScriptEntrypoint: vi.fn(async () => '/hmr/script.js'),
+			} as unknown as IHmrManager;
+			processor.setHmrManager(HmrManager);
+
+			const dep: FileScriptAsset = {
+				kind: 'script',
+				source: 'file',
+				filepath: '/test/project/src/script.ts',
+				inline: false,
+			};
+
+			const result = await processor.process(dep);
+
+			expect(result.filepath).toBe('/test/project/src/script.ts');
+		});
+
+		test('should not use HMR when inline is true', async () => {
+			const processor = new FileScriptProcessor({ appConfig: createMockConfig() });
+			const HmrManager = {
+				isEnabled: () => true,
+				registerScriptEntrypoint: vi.fn(async () => '/hmr/script.js'),
+			} as unknown as IHmrManager;
+			processor.setHmrManager(HmrManager);
+
+			const dep: FileScriptAsset = {
+				kind: 'script',
+				source: 'file',
+				filepath: '/test/project/src/script.ts',
+				inline: true,
+				bundle: false,
+			};
+
+			const result = await processor.process(dep);
+
+			expect(HmrManager.registerScriptEntrypoint).not.toHaveBeenCalled();
+			expect(result.inline).toBe(true);
+			expect(result.content).toBeDefined();
+		});
+
+		test('should copy file without bundling when bundle is false', async () => {
+			const processor = new FileScriptProcessor({ appConfig: createMockConfig() });
+
+			const dep: FileScriptAsset = {
+				kind: 'script',
+				source: 'file',
+				filepath: '/test/project/src/scripts/app.js',
+				bundle: false,
+				inline: false,
+			};
+
+			const result = await processor.process(dep);
+
+			expect(copyFileMock).toHaveBeenCalled();
+			expect(result.kind).toBe('script');
+			expect(result.inline).toBe(false);
+		});
+
+		test('should return consistent result when called multiple times with same file', async () => {
+			const processor = new FileScriptProcessor({ appConfig: createMockConfig() });
+
+			const dep: FileScriptAsset = {
+				kind: 'script',
+				source: 'file',
+				filepath: '/test/project/src/scripts/cached.js',
+				bundle: false,
+				inline: false,
+			};
+
+			const result1 = await processor.process(dep);
+			const result2 = await processor.process(dep);
+
+			expect(result1).toEqual(result2);
+		});
+
+		test('should include content when inline is true and bundle is false', async () => {
+			const processor = new FileScriptProcessor({ appConfig: createMockConfig() });
+
+			const dep: FileScriptAsset = {
+				kind: 'script',
+				source: 'file',
+				filepath: '/test/project/src/inline.js',
+				bundle: false,
+				inline: true,
+			};
+
+			const result = await processor.process(dep);
+
+			expect(result.inline).toBe(true);
+			expect(result.content).toBe('console.log("test");');
+			expect(result.filepath).toBeUndefined();
+		});
+
+		test('should preserve attributes from dependency', async () => {
+			const processor = new FileScriptProcessor({ appConfig: createMockConfig() });
+
+			const dep: FileScriptAsset = {
+				kind: 'script',
+				source: 'file',
+				filepath: '/test/project/src/script.js',
+				bundle: false,
+				attributes: { defer: 'true', 'data-custom': 'value' },
+			};
+
+			const result = await processor.process(dep);
+
+			expect(result.attributes).toEqual({ defer: 'true', 'data-custom': 'value' });
+		});
+
+		test('should preserve position from dependency', async () => {
+			const processor = new FileScriptProcessor({ appConfig: createMockConfig() });
+
+			const dep: FileScriptAsset = {
+				kind: 'script',
+				source: 'file',
+				filepath: '/test/project/src/script.js',
+				bundle: false,
+				position: 'head',
+			};
+
+			const result = await processor.process(dep);
+
+			expect(result.position).toBe('head');
+		});
+
+		test('should pass bundle plugins through when bundling', async () => {
+			const processor = new FileScriptProcessor({ appConfig: createMockConfig() });
+			const bundleScriptSpy = vi.spyOn(processor as any, 'bundleScript').mockResolvedValue('/tmp/out.js');
+			const customPlugin = {
+				name: 'custom-plugin',
+				setup() {},
+			};
+
+			const dep: FileScriptAsset = {
+				kind: 'script',
+				source: 'file',
+				filepath: '/test/project/src/script.tsx',
+				bundle: true,
+				bundleOptions: {
+					plugins: [customPlugin],
+				},
+			};
+
+			await processor.process(dep);
+
+			expect(bundleScriptSpy).toHaveBeenCalled();
+			const buildArgs = bundleScriptSpy.mock.calls[0]?.[0] as { plugins?: Array<{ name?: string }> };
+			expect(buildArgs.plugins?.some((plugin) => plugin.name === 'custom-plugin')).toBe(true);
+		});
+
+		test('should bundle nested source files into dist assets subdirectories', async () => {
+			const processor = new FileScriptProcessor({ appConfig: createMockConfig() });
+			const bundleScriptSpy = vi.spyOn(processor as any, 'bundleScript').mockResolvedValue('/tmp/out.js');
+
+			const dep: FileScriptAsset = {
+				kind: 'script',
+				source: 'file',
+				filepath: '/test/project/src/pages/index.tsx',
+				bundle: true,
+			};
+
+			await processor.process(dep);
+
+			const buildArgs = bundleScriptSpy.mock.calls[0]?.[0] as { outdir?: string };
+			expect(buildArgs.outdir).toBe('/test/project/.eco/public/assets/pages');
+		});
+
+		test('should disable splitting for page-owned script bundles by default', async () => {
+			const processor = new FileScriptProcessor({ appConfig: createMockConfig() });
+			const bundleScriptSpy = vi.spyOn(processor as any, 'bundleScript').mockResolvedValue('/tmp/out.js');
+
+			const dep: FileScriptAsset = {
+				kind: 'script',
+				source: 'file',
+				filepath: '/test/project/src/pages/index.tsx',
+				bundle: true,
+				packageRole: 'page-script',
+			};
+
+			await processor.process(dep);
+
+			const buildArgs = bundleScriptSpy.mock.calls[0]?.[0] as { splitting?: boolean };
+			expect(buildArgs.splitting).toBe(false);
+		});
+
+		test('should return updated attributes when cached asset is retrieved with different attributes', async () => {
+			const processor = new FileScriptProcessor({ appConfig: createMockConfig() });
+
+			const depWithDefer: FileScriptAsset = {
+				kind: 'script',
+				source: 'file',
+				filepath: '/test/project/src/cached-attrs.js',
+				bundle: false,
+				attributes: { defer: '' },
+				position: 'head',
+			};
+
+			const depWithAsync: FileScriptAsset = {
+				kind: 'script',
+				source: 'file',
+				filepath: '/test/project/src/cached-attrs.js',
+				bundle: false,
+				attributes: { async: '' },
+				position: 'body',
+			};
+
+			const result1 = await processor.process(depWithDefer);
+			const result2 = await processor.process(depWithAsync);
+
+			expect(result1.attributes).toEqual({ defer: '' });
+			expect(result1.position).toBe('head');
+			expect(result2.attributes).toEqual({ async: '' });
+			expect(result2.position).toBe('body');
+		});
+	});
+});

package/src/services/assets/asset-processing-service/processors/script/file-script.processor.ts

@@ -0,0 +1,110 @@
+import path from 'node:path';
+import { RESOLVED_ASSETS_DIR } from '../../../../../config/constants.ts';
+import { fileSystem } from '@ecopages/file-system';
+import type { IHmrManager } from '../../../../../types/internal-types.ts';
+import type { FileScriptAsset, ProcessedAsset } from '../../assets.types.ts';
+import { BaseScriptProcessor } from '../base/base-script-processor.ts';
+
+export class FileScriptProcessor extends BaseScriptProcessor<FileScriptAsset> {
+	private hmrManager?: IHmrManager;
+
+	private resolveHmrOutputFilepath(entrypointPath: string): string | undefined {
+		if (!this.hmrManager || !('getDistDir' in this.hmrManager)) {
+			return undefined;
+		}
+
+		const getDistDir = this.hmrManager.getDistDir;
+		if (typeof getDistDir !== 'function') {
+			return undefined;
+		}
+
+		const relativePathJs = path
+			.relative(this.appConfig.absolutePaths.srcDir, entrypointPath)
+			.replace(/\.(tsx?|jsx?|mdx?)$/, '.js')
+			.replace(/\[([^\]]+)\]/g, '_$1_');
+
+		return path.join(getDistDir.call(this.hmrManager), relativePathJs);
+	}
+
+	setHmrManager(hmrManager: IHmrManager) {
+		this.hmrManager = hmrManager;
+	}
+
+	async process(dep: FileScriptAsset): Promise<ProcessedAsset> {
+		/**
+		 * If HMR Manager is active, delegate build/watch to it.
+		 */
+		if (this.hmrManager?.isEnabled() && !dep.inline) {
+			const outputUrl = await this.hmrManager.registerScriptEntrypoint(dep.filepath);
+			const outputFilepath = this.resolveHmrOutputFilepath(dep.filepath);
+			return {
+				filepath: outputFilepath ?? dep.filepath,
+				srcUrl: outputUrl,
+				kind: 'script',
+				position: dep.position,
+				attributes: dep.attributes,
+				inline: false,
+				excludeFromHtml: dep.excludeFromHtml,
+				packageRole: dep.packageRole,
+			};
+		}
+
+		const content = fileSystem.readFileSync(dep.filepath);
+		const shouldBundle = this.shouldBundle(dep);
+		const configHash = this.generateHash(
+			JSON.stringify({
+				bundle: shouldBundle,
+				minify: shouldBundle && this.isProduction,
+				opts: dep.bundleOptions,
+			}),
+		);
+		const cachekey = `${this.buildCacheKey(dep.filepath, this.generateHash(content), dep)}:${configHash}`;
+
+		return this.getOrProcess(cachekey, async () => {
+			if (!shouldBundle) {
+				const outFilepath = path.relative(this.appConfig.absolutePaths.srcDir, dep.filepath);
+				let filepath: string | undefined;
+
+				if (!dep.inline) {
+					filepath = path.join(this.getAssetsDir(), outFilepath);
+					fileSystem.copyFile(dep.filepath, filepath);
+				}
+
+				return {
+					filepath,
+					content,
+					kind: 'script',
+					position: dep.position,
+					attributes: dep.attributes,
+					inline: dep.inline,
+					excludeFromHtml: dep.excludeFromHtml,
+					packageRole: dep.packageRole,
+				};
+			}
+
+			const relativeFilepath = path.relative(this.appConfig.absolutePaths.srcDir, dep.filepath);
+			const outdirPath = path.join(this.appConfig.absolutePaths.distDir, RESOLVED_ASSETS_DIR, relativeFilepath);
+			const outdirDirname = path.dirname(outdirPath);
+			const bundlerOptions = this.getBundlerOptions(dep);
+
+			const bundledFilePath = await this.bundleScript({
+				entrypoint: dep.filepath,
+				outdir: outdirDirname,
+				minify: this.isProduction,
+				...bundlerOptions,
+				plugins: bundlerOptions.plugins,
+			});
+
+			return {
+				filepath: bundledFilePath,
+				content: dep.inline ? fileSystem.readFileSync(bundledFilePath).toString() : undefined,
+				kind: 'script',
+				position: dep.position,
+				attributes: dep.attributes,
+				inline: dep.inline,
+				excludeFromHtml: dep.excludeFromHtml,
+				packageRole: dep.packageRole,
+			};
+		});
+	}
+}

package/src/services/assets/asset-processing-service/processors/script/node-module-script.processor.test.ts

@@ -0,0 +1,227 @@
+import { describe, expect, test, beforeEach, afterEach, vi } from 'vitest';
+import { fileSystem } from '@ecopages/file-system';
+import { NodeModuleScriptProcessor } from './node-module-script.processor';
+import type { EcoPagesAppConfig } from '../../../../../types/internal-types';
+import type { NodeModuleScriptAsset } from '../../assets.types';
+
+const originalExists = fileSystem.exists;
+const originalReadFileAsBuffer = fileSystem.readFileAsBuffer;
+
+const createMockConfig = (): EcoPagesAppConfig =>
+	({
+		rootDir: '/test/project',
+		srcDir: 'src',
+		distDir: '.eco/public',
+		absolutePaths: {
+			distDir: '/test/project/.eco/public',
+			srcDir: '/test/project/src',
+		},
+		processors: new Map(),
+		loaders: new Map(),
+	}) as unknown as EcoPagesAppConfig;
+
+describe('NodeModuleScriptProcessor', () => {
+	let existsMock: any;
+	let readFileAsBufferMock: any;
+
+	beforeEach(() => {
+		existsMock = vi.fn(() => true);
+		readFileAsBufferMock = vi.fn(() => Buffer.from('// module content'));
+		fileSystem.exists = existsMock;
+		fileSystem.readFileAsBuffer = readFileAsBufferMock;
+	});
+
+	afterEach(() => {
+		fileSystem.exists = originalExists;
+		fileSystem.readFileAsBuffer = originalReadFileAsBuffer;
+		vi.restoreAllMocks();
+	});
+
+	describe('process - inline module', () => {
+		test('should return inline content for inline modules', async () => {
+			const processor = new NodeModuleScriptProcessor({ appConfig: createMockConfig() });
+
+			const dep: NodeModuleScriptAsset = {
+				kind: 'script',
+				source: 'node-module',
+				importPath: 'some-package/dist/index.js',
+				inline: true,
+			};
+
+			const result = await processor.process(dep);
+
+			expect(result.inline).toBe(true);
+			expect(result.content).toBe('// module content');
+			expect(result.kind).toBe('script');
+		});
+
+		test('should preserve attributes for inline modules', async () => {
+			const processor = new NodeModuleScriptProcessor({ appConfig: createMockConfig() });
+
+			const dep: NodeModuleScriptAsset = {
+				kind: 'script',
+				source: 'node-module',
+				importPath: 'some-package/dist/index.js',
+				inline: true,
+				attributes: { type: 'module' },
+			};
+
+			const result = await processor.process(dep);
+
+			expect(result.attributes).toEqual({ type: 'module' });
+		});
+
+		test('should preserve position for inline modules', async () => {
+			const processor = new NodeModuleScriptProcessor({ appConfig: createMockConfig() });
+
+			const dep: NodeModuleScriptAsset = {
+				kind: 'script',
+				source: 'node-module',
+				importPath: 'some-package/dist/index.js',
+				inline: true,
+				position: 'head',
+			};
+
+			const result = await processor.process(dep);
+
+			expect(result.position).toBe('head');
+		});
+	});
+
+	describe('process - caching', () => {
+		test('should return cached result on subsequent calls', async () => {
+			const processor = new NodeModuleScriptProcessor({ appConfig: createMockConfig() });
+
+			const dep: NodeModuleScriptAsset = {
+				kind: 'script',
+				source: 'node-module',
+				importPath: 'cached-package/dist/index.js',
+				inline: true,
+			};
+
+			const result1 = await processor.process(dep);
+			const result2 = await processor.process(dep);
+
+			expect(readFileAsBufferMock.mock.calls.length).toBe(1);
+			expect(result1).toEqual(result2);
+		});
+	});
+
+	describe('resolveModulePath', () => {
+		test('should throw error when module not found', async () => {
+			existsMock = vi.fn(() => false);
+			fileSystem.exists = existsMock;
+
+			const processor = new NodeModuleScriptProcessor({ appConfig: createMockConfig() });
+
+			const dep: NodeModuleScriptAsset = {
+				kind: 'script',
+				source: 'node-module',
+				importPath: 'non-existent-package/index.js',
+				inline: true,
+			};
+
+			await expect(processor.process(dep)).rejects.toThrow(/Could not resolve module/);
+		});
+
+		test('should find module in parent directories', async () => {
+			let callCount = 0;
+			existsMock = vi.fn((_path: string) => {
+				callCount++;
+				return callCount >= 3;
+			});
+			fileSystem.exists = existsMock;
+
+			const processor = new NodeModuleScriptProcessor({ appConfig: createMockConfig() });
+
+			const dep: NodeModuleScriptAsset = {
+				kind: 'script',
+				source: 'node-module',
+				importPath: 'parent-package/index.js',
+				inline: true,
+			};
+
+			const result = await processor.process(dep);
+
+			expect(result).toBeDefined();
+			expect(callCount).toBeGreaterThanOrEqual(3);
+		});
+	});
+
+	describe('process - custom name', () => {
+		test('should use custom name when provided', async () => {
+			const processor = new NodeModuleScriptProcessor({ appConfig: createMockConfig() });
+
+			const dep: NodeModuleScriptAsset = {
+				kind: 'script',
+				source: 'node-module',
+				importPath: 'some-package/dist/index.js',
+				name: 'custom-vendor',
+				inline: true,
+			};
+
+			const result = await processor.process(dep);
+
+			expect(result).toBeDefined();
+			expect(result.inline).toBe(true);
+		});
+
+		test('should preserve explicit bundle naming when provided', async () => {
+			const processor = new NodeModuleScriptProcessor({ appConfig: createMockConfig() });
+			const bundleScriptSpy = vi
+				.spyOn(
+					processor as unknown as { bundleScript: (options: Record<string, unknown>) => Promise<string> },
+					'bundleScript',
+				)
+				.mockResolvedValue('/test/project/.eco/public/assets/vendors/react.development.js');
+
+			const dep: NodeModuleScriptAsset = {
+				kind: 'script',
+				source: 'node-module',
+				importPath: 'react',
+				name: 'react',
+				inline: false,
+				bundleOptions: {
+					naming: 'react.development.js',
+				},
+			};
+
+			const result = await processor.process(dep);
+
+			expect(bundleScriptSpy).toHaveBeenCalledWith(
+				expect.objectContaining({
+					naming: 'react.development.js',
+				}),
+			);
+			expect(result.filepath).toBe('/test/project/.eco/public/assets/vendors/react.development.js');
+		});
+	});
+
+	describe('resolveModulePath with real dependencies', () => {
+		beforeEach(() => {
+			fileSystem.exists = originalExists;
+			fileSystem.readFileAsBuffer = originalReadFileAsBuffer;
+		});
+
+		test('should resolve @ecopages/logger using Bun.resolveSync', async () => {
+			const config = createMockConfig();
+			config.rootDir = process.cwd();
+			const processor = new NodeModuleScriptProcessor({ appConfig: config });
+			fileSystem.readFileAsBuffer = vi.fn().mockResolvedValue(Buffer.from('dummy content'));
+
+			const dep: NodeModuleScriptAsset = {
+				kind: 'script',
+				source: 'node-module',
+				importPath: '@ecopages/logger',
+				inline: true,
+			};
+
+			const result = await processor.process(dep);
+
+			expect(result).toBeDefined();
+			expect(result.inline).toBe(true);
+			expect(result.content).toBeDefined();
+			expect(result.content!.length).toBeGreaterThan(0);
+		});
+	});
+});