@fontoxml/fontoxml-development-tools 3.8.1 → 3.9.0-beta.3

package/src/modules/editor/test/helpers/createWebpackWatch.js

@@ -1,444 +0,0 @@
-import assert from 'assert';
-import EventEmitter from 'events';
-import express from 'express';
-import mocha from 'mocha';
-import path from 'path';
-import webpack from 'webpack';
-import webpackDevMiddleware from 'webpack-dev-middleware';
-
-import setupDevCms from '../../dev-cms/setupDevCms.js';
-import { fromSnakeCaseToCamelCase } from '../../src/convert.js';
-import getWebpackConfig from '../../src/getWebpackConfig.js';
-import getWebpackDevMiddlewareConfig from '../../src/getWebpackDevMiddlewareConfig.js';
-import assertFixtureSnapshot from './assertFixtureSnapshot.js';
-import createAppStructure from './createAppStructure.js';
-import createTempDirectory from './createTempDirectory.js';
-
-const mochaColoring = mocha.reporters.Base.color;
-class WebpackWatch {
-	constructor(options) {
-		this.options = options;
-
-		this.compiler = null;
-		this.contextPath = null;
-		this.eventEmitter = null;
-		this.mutationBusyCount = 0;
-		this.server = null;
-		this.httpServer = null;
-		this.tempDirCleanup = null;
-
-		this.started = false;
-	}
-
-	async start() {
-		// Guard against already started.
-		if (this.started) {
-			throw new Error('Webpack watch test already started.');
-		}
-		this.started = true;
-
-		const tmpDir = await createTempDirectory();
-		this.contextPath = tmpDir.path;
-		this.tempDirCleanup = tmpDir.cleanupCallback;
-		const options = {
-			appTemplateType: 'minimal',
-			inDevelopmentMode: true,
-		};
-
-		await createAppStructure(this.contextPath, options.appTemplateType);
-
-		const appConfig = {
-			root: this.contextPath,
-			port: 41983,
-		};
-		const appManifest = {
-			_rawLoaderExtensions: [],
-		};
-		const webpackConfigDevelopment = getWebpackConfig(
-			appConfig,
-			appManifest,
-			options
-		);
-
-		this.compiler = webpack(webpackConfigDevelopment);
-
-		// this.compiler.hooks.compile.tap('webpack-watch-test', invalidPlugin);
-		// this.compiler.hooks.invalid.tap('webpack-watch-test', invalidPlugin);
-		const compilerDoneEvents = new EventEmitter();
-		this.compiler.hooks.done.tap('webpack-watch-test', (rawStats) => {
-			const stats = rawStats.toJson({
-				all: false,
-				hash: true,
-				assets: true,
-				warnings: true,
-				errors: true,
-				errorDetails: false,
-			});
-
-			const shouldEmit =
-				// !force &&
-				stats &&
-				(!stats.errors || stats.errors.length === 0) &&
-				stats.assets &&
-				stats.assets.every((asset) => !asset.emitted);
-
-			if (shouldEmit) {
-				compilerDoneEvents.emit('message', {
-					type: 'still-ok',
-					data: rawStats,
-				});
-				return;
-			}
-
-			if (stats.errors.length > 0) {
-				compilerDoneEvents.emit('message', {
-					type: 'errors',
-					data: stats.errors,
-				});
-			} else if (stats.warnings.length > 0) {
-				compilerDoneEvents.emit('message', {
-					type: 'warnings',
-					data: stats.warnings,
-				});
-			} else {
-				compilerDoneEvents.emit('message', {
-					type: 'ok',
-					data: rawStats,
-				});
-			}
-		});
-
-		const webpackDevMiddlewareConfig =
-			getWebpackDevMiddlewareConfig(appConfig);
-		webpackDevMiddlewareConfig.logLevel = 'silent';
-		webpackDevMiddlewareConfig.stats = 'none';
-		webpackDevMiddlewareConfig.watchOptions.aggregateTimeout =
-			this.options.aggregateTimeout;
-		webpackDevMiddlewareConfig.watchOptions.poll = this.options.poll;
-
-		this.server = express();
-		this.middleware = webpackDevMiddleware(
-			this.compiler,
-			getWebpackDevMiddlewareConfig(appConfig)
-		);
-		this.server.use(await setupDevCms(appConfig), this.middleware);
-
-		this.eventEmitter = new EventEmitter();
-
-		// We don't actually need the server or webpack dev middleware to run, but it does some
-		// convenient bootstrapping we can use.
-		await new Promise((resolve, reject) => {
-			this.httpServer = this.server.listen(
-				appConfig.port,
-				'0.0.0.0',
-				(error) => {
-					if (error) {
-						reject(error);
-						return;
-					}
-					resolve();
-				}
-			);
-		});
-
-		await new Promise((resolve, reject) => {
-			let isDone = false;
-			const compilerEventListener = ({ type, data }) => {
-				if (isDone) {
-					if (!this.mutationBusyCount) {
-						throw new Error(
-							`Webpack event "${type}" happened while not busy with a mutation.`
-						);
-					}
-
-					this.eventEmitter.emit(type, data);
-					return;
-				}
-
-				switch (type) {
-					case 'still-ok':
-					case 'ok':
-						isDone = true;
-						resolve(data);
-						return;
-					case 'warning':
-					case 'warnings':
-					case 'error':
-					case 'errors':
-					case 'close':
-						isDone = true;
-						reject((data && data[0]) || data);
-
-					case 'invalid':
-					// Updating...
-
-					default:
-				}
-			};
-			compilerDoneEvents.on('message', compilerEventListener);
-		});
-	}
-
-	async stop() {
-		await new Promise((resolve) => this.middleware.close(resolve));
-
-		await new Promise((resolve) => this.httpServer.close(resolve));
-
-		if (this.tempDirCleanup) {
-			await this.tempDirCleanup();
-		}
-
-		// Reset event listeners.
-		if (this.eventEmitter) {
-			this.eventEmitter.removeAllListeners();
-		}
-
-		this.mutationBusyCount = 0;
-
-		// Some tests seem to fail if we not wait a bit.
-		await new Promise((resolve) =>
-			setTimeout(resolve, this.options.waitTime)
-		);
-
-		this.started = false;
-	}
-
-	webpackMutation(callback) {
-		this.mutationBusyCount++;
-		return new Promise(async (resolve, reject) => {
-			let callbackCompleted = false;
-			let doneType = false;
-			let doneData;
-
-			// eslint-disable-next-line prefer-const
-			let doneHandlerOk;
-			let doneHandlerStillOk;
-			let doneHandlerErrors;
-			let doneHandlerWarnings;
-
-			const doneHandler = (type, data) => {
-				if (!callbackCompleted) {
-					// Wait for the next done-like event.
-					// TODO: Merge errors/warnings?
-					return;
-					// throw new Error(`Compiler emitted "${type}" before the mutation was finished, might be a timing issue.`);
-				}
-
-				this.eventEmitter.removeListener('ok', doneHandlerOk);
-				this.eventEmitter.removeListener(
-					'still-ok',
-					doneHandlerStillOk
-				);
-				this.eventEmitter.removeListener('errors', doneHandlerErrors);
-				this.eventEmitter.removeListener(
-					'warnings',
-					doneHandlerWarnings
-				);
-
-				doneType = type;
-				doneData = data;
-			};
-
-			doneHandlerOk = doneHandler.bind(undefined, 'ok');
-			doneHandlerStillOk = doneHandler.bind(undefined, 'still-ok');
-			doneHandlerErrors = doneHandler.bind(undefined, 'errors');
-			doneHandlerWarnings = doneHandler.bind(undefined, 'warnings');
-
-			this.eventEmitter.addListener('ok', doneHandlerOk);
-			this.eventEmitter.addListener('still-ok', doneHandlerStillOk);
-			this.eventEmitter.addListener('errors', doneHandlerErrors);
-			this.eventEmitter.addListener('warnings', doneHandlerWarnings);
-
-			// Some tests seem to fail if we not wait a bit.
-			await new Promise((timeoutResolve) =>
-				setTimeout(timeoutResolve, this.options.waitTime)
-			);
-
-			// Perform the mutations.
-			await callback.call(undefined, this);
-			callbackCompleted = true;
-
-			// Some tests seem to fail if we not wait a bit.
-			await new Promise((timeoutResolve) =>
-				setTimeout(timeoutResolve, this.options.waitTime)
-			);
-
-			// Listen for rebuild done.
-			let doneCheckIntervalCount = 0;
-			const doneCheckInterval = setInterval(() => {
-				if (
-					!doneType &&
-					doneCheckIntervalCount < this.options.doneCheckIntervalLimit
-				) {
-					doneCheckIntervalCount++;
-					return;
-				}
-
-				// Clear the interval.
-				clearInterval(doneCheckInterval);
-
-				// Make sure we cleanup the listeners.
-				this.eventEmitter.removeListener('ok', doneHandlerOk);
-				this.eventEmitter.removeListener(
-					'still-ok',
-					doneHandlerStillOk
-				);
-				this.eventEmitter.removeListener('errors', doneHandlerErrors);
-				this.eventEmitter.removeListener(
-					'warnings',
-					doneHandlerWarnings
-				);
-
-				if (!doneType) {
-					reject(new Error('Mutation did not trigger compile.'));
-					return;
-				}
-
-				if (doneType !== 'ok' && doneType !== 'still-ok') {
-					reject(
-						new Error(
-							doneData
-								? doneData[0]
-								: new Error(`Watch due to "${doneType}".`)
-						)
-					);
-					return;
-				}
-
-				// Get the latest stats from the ok event.
-				const stats = doneData;
-
-				// console.log('stats compare', stats === this._lastStats ? 'same' : (this._lastStats ? 'changed' : 'first'));
-				this._lastStats = stats;
-
-				resolve(stats);
-			}, this.options.doneCheckInterval);
-		}).catch((error) => {
-			this.mutationBusyCount--;
-
-			throw error;
-		});
-	}
-
-	getModuleFromStats(stats, srcPath) {
-		const modules = stats.toJson({ all: true }).modules;
-
-		// console.log(modules.filter(module => module.name.endsWith(srcPath)).map(m => m.name));
-
-		return modules.find((emittedModule) => {
-			return emittedModule.name.endsWith(srcPath);
-		});
-	}
-
-	getSnapshotPath(testFunction, parts, extension = '.js') {
-		if (
-			!testFunction ||
-			!testFunction.test ||
-			!testFunction.test.titlePath
-		) {
-			throw new Error(
-				'Cannot get snapshot path without a test function.'
-			);
-		}
-
-		if (!Array.isArray(parts)) {
-			parts = [parts];
-		}
-
-		parts = [].concat(testFunction.test.titlePath(), parts).map((part) => {
-			part = part.charAt(0).toLowerCase() + part.slice(1);
-			return fromSnakeCaseToCamelCase(
-				part.replace(/([^\w]|\s|_)+/g, '-')
-			);
-		});
-
-		parts[parts.length - 1] += `.out${extension}`;
-		return path.join(__dirname, '..', 'fixtures', ...parts);
-	}
-
-	async runDependencyTest(
-		testFunction,
-		outputModulesToTest,
-		mutationCallback
-	) {
-		// Increase timeouts on every test retry.
-		if (
-			testFunction &&
-			testFunction.test &&
-			testFunction.test._currentRetry >= 1
-		) {
-			this.options.waitTime += testFunction.test._currentRetry * 500;
-			this.options.doneCheckIntervalLimit += Math.round(
-				(testFunction.test._currentRetry * 2000) /
-					this.options.doneCheckInterval
-			);
-			console.warn(
-				mochaColoring(
-					'light',
-					`${'  '.repeat(
-						testFunction.test.titlePath().length
-					)}- Retrying "${testFunction.test.title}" (wait: ${
-						this.options.waitTime
-					}, done check: ${this.options.doneCheckInterval} * ${
-						this.options.doneCheckIntervalLimit
-					})...`
-				)
-			);
-		}
-
-		// Perform the mutation.
-		const stats = await this.webpackMutation(mutationCallback);
-
-		// Test results.
-		await Promise.all(
-			outputModulesToTest.map(async (outputModuleToTest) => {
-				if (Array.isArray(outputModuleToTest)) {
-					outputModuleToTest = {
-						filename: outputModuleToTest[0],
-						snapshot: outputModuleToTest[1],
-					};
-				}
-				const outputModule = this.getModuleFromStats(
-					stats,
-					outputModuleToTest.filename
-				);
-				assert.ok(outputModule);
-				await assertFixtureSnapshot(
-					outputModule.source,
-					this.getSnapshotPath(
-						testFunction,
-						outputModuleToTest.snapshot
-					)
-				);
-			})
-		);
-
-		// TODO: Check stats for correct file changes?
-		// TODO: Check if output special file contains the correct output?
-	}
-}
-
-const DEFAULT_OPTIONS = {
-	aggregateTimeout: 300,
-	appTemplateType: 'minimal',
-	doneCheckInterval: 20,
-	doneCheckIntervalLimit: 100,
-	inDevelopmentMode: true,
-	poll: false,
-	startupWaitTime: 50,
-	waitTime: 20,
-};
-
-export default async function createWebpackWatch(options = {}) {
-	options = { ...DEFAULT_OPTIONS, ...options };
-
-	const instance = new WebpackWatch(options);
-	await instance.start();
-
-	// Some tests seem to fail if we not wait a bit.
-	await new Promise((resolve) =>
-		setTimeout(resolve, options.startupWaitTime)
-	);
-
-	return instance;
-}