polyfill-library 3.106.0 → 3.110.0

package/tasks/buildsources/buildsources-child-proc.js

@@ -1,108 +0,0 @@
-'use strict';
-
-const path = require('path');
-
-const Polyfill = require('./polyfill');
-
-// Listen for messages from the parent process.
-process.on('message', function (message) {
-	// Validate the message from the parent.
-	if (!message.source || !message.destination || !message.list) {
-		if (!process.connected) {
-			return;
-		}
-
-		process.send({
-			child: process.pid,
-			error: new Error('Invalid message send to child process')
-		}, () => {
-			process.disconnect();
-		});
-		return;
-	}
-
-	// Process the list requested by the parent process.
-	handleList(message).then((polyfills) => {
-		if (!process.connected) {
-			return;
-		}
-
-		// Send the list back to the parent process.
-		process.send({
-			child: process.pid,
-			result: polyfills
-		}, () => {
-			process.disconnect();
-		});
-	}).catch((error) => {
-		if (!process.connected) {
-			return;
-		}
-
-		process.send({
-			child: process.pid,
-			error: error
-		}, () => {
-			process.disconnect();
-		});
-	});
-});
-
-/**
- * Handle a list of Polyfills.
- *
- * @param {{source: string, destination: string, list: Array<string>, onlyBuildFeature: string}} options
- * @returns {Promise<Array<Polyfill>>} The list of processed Polyfills.
- * @throws When a Polyfills fails to be build.
- */
-async function handleList(options) {
-	const source = options.source;
-	const destination = options.destination;
-	const list = options.list;
-	const onlyBuildFeature = options.onlyBuildFeature;
-
-	const polyfills = [];
-
-	for (const absolute of list) {
-		try {
-			const polyfill = new Polyfill(absolute, path.relative(source, absolute))
-			if (!polyfill.hasConfigFile) {
-				continue;
-			}
-
-			await polyfill.loadConfig();
-
-			polyfill.checkLicense();
-
-			if (!onlyBuildFeature || polyfill.name == onlyBuildFeature) {
-				polyfill.loadDetect();
-				await polyfill.loadSources();
-				polyfill.updateConfig();
-
-				await polyfill.writeOutput(destination);
-			}
-
-			polyfill.sources = {}; // No need to communicate this back to the parent process, output files have been written.
-			polyfills.push(polyfill);
-		} catch (error) {
-			if (error instanceof Error) {
-				throw {
-					name: "Build error",
-					message: `Error while building: ${path.relative(source, absolute)}`,
-					error: {
-						message: error.message,
-						error: error
-					}
-				};
-			}
-
-			throw {
-				name: "Build error",
-				message: `Error while building: ${path.relative(source, absolute)}`,
-				error
-			};
-		}
-	}
-
-	return polyfills;
-}

package/tasks/buildsources/buildsources.js

@@ -1,21 +0,0 @@
-'use strict';
-
-const path = require('path');
-
-const source = path.join(__dirname, '../../polyfills');
-const destination = path.join(source, '__dist');
-
-const build = require('./build');
-
-console.log(`Writing compiled polyfill sources to ${destination}/...`);
-
-build()
-	.then(() => {
-		console.log('Sources built successfully');
-	})
-	.catch(error => {
-		console.log(error);
-		console.log(JSON.stringify(error));
-		// eslint-disable-next-line unicorn/no-process-exit
-		process.exit(1);
-	});

package/tasks/buildsources/check-dependencies-exist.js

@@ -1,20 +0,0 @@
-'use strict';
-
-/**
- * Validate the depedency graph for a list of polyfills.
- *
- * @param {Array<Polyfill>} polyfills The list of polyfills.
- * @throws When a dependency is missing.
- */
-module.exports = function checkDependenciesExist(polyfills) {
-	for (const polyfill of polyfills) {
-		for (const dependency of polyfill.dependencies) {
-			if (!polyfills.some(function (polyfill) {
-					return dependency === polyfill.name;
-				})) {
-				return Promise.reject(`Polyfill ${polyfill.name} depends on ${dependency}, which does not exist within the polyfill-service. Recommended to either add the missing polyfill or remove the dependency.`);
-			}
-		}
-	}
-	return Promise.resolve();
-}

package/tasks/buildsources/check-for-circular-dependencies.js

@@ -1,27 +0,0 @@
-'use strict';
-
-const toposort = require('toposort');
-
-/**
- * Validate the depedency graph for a list of polyfills.
- *
- * @param {Array<Polyfill>} polyfills The list of polyfills.
- * @throws When there is a circular dependency.
- */
-module.exports = function checkForCircularDependencies(polyfills) {
-	const graph = [];
-
-	for (const polyfill of polyfills) {
-		for (const dependency of polyfill.dependencies) {
-			graph.push([dependency, polyfill.name]);
-		}
-	}
-
-	try {
-		toposort(graph);
-
-		return Promise.resolve();
-	} catch (error) {
-		return Promise.reject('\nThere is a circle in the dependency graph.\nCheck the `dependencies` property of polyfill config files that have recently changed, and ensure that they do not form a circle of references.' + error);
-	}
-}

package/tasks/buildsources/flatten-polyfill-directories.js

@@ -1,22 +0,0 @@
-'use strict';
-
-const fs = require('graceful-fs');
-const path = require('path');
-
-/**
- * Recursively discover all subfolders and produce a flattened list.
- * Directories prefixed with '__' are not polyfill features and are not included.
- *
- * @param {string} directory Directory to flatten.
- * @returns {Array<string>} Flattened directory.
- */
-module.exports = function flattenPolyfillDirectories(directory) {
-	let results = [];
-	for (const item of fs.readdirSync(directory)) {
-		const joined = path.join(directory, item);
-		if (fs.lstatSync(joined).isDirectory() && item.indexOf('__') !== 0) {
-			results = [...results, ...flattenPolyfillDirectories(joined), joined];
-		}
-	}
-	return results;
-}

package/tasks/buildsources/polyfill.js

@@ -1,359 +0,0 @@
-'use strict';
-
-const fs = require('graceful-fs');
-const path = require('path');
-const uglify = require('uglify-js');
-const makeDirectory = require('mkdirp');
-const {
-	promisify
-} = require('util');
-const spdxLicenses = require('spdx-licenses');
-const UA = require('@financial-times/polyfill-useragent-normaliser');
-const TOML = require('@iarna/toml');
-
-const writeFile = promisify(fs.writeFile);
-const readFile = promisify(fs.readFile);
-
-const validateSource = require('./validate-source');
-
-/**
- * Polyfill represents a single polyfill directory.
- */
-module.exports = class Polyfill {
-
-	/**
-	 * new Polyfill
-	 * @param  {string} absolute Path to polyfill.
-	 * @param  {string} relative Path to polyfill.
-	 */
-	constructor(absolute, relative) {
-		this.path = {
-			absolute,
-			relative
-		};
-		this.name = relative.replace(/(\/|\\)/g, '.');
-		this.config = {};
-		this.sources = {};
-	}
-
-	/**
-	 * Construct a Polyfill from JSON data.
-	 *
-	 * @param {any} data JSON data representing a Polyfill.
-	 *
-	 * @returns {Polyfill|undefined} A Polyfill or undefined when data is invalid.
-	 */
-	static fromJSON(data) {
-		if (!data) {
-			return;
-		}
-
-		if (!data.path) {
-			return;
-		}
-
-		const polyfill = new this(data.path.absolute, data.path.relative);
-
-		polyfill.name = data.name;
-		polyfill.config = data.config;
-		polyfill.sources = data.sources;
-
-		return polyfill;
-	}
-
-	/**
-	 *  Aliases for the Polyfill.
-	 *
-	 * @type {Array<string>}
-	 */
-	get aliases() {
-		return ['all', ...(this.config.aliases || [])];
-	}
-
-	/**
-	 * Depedencies for the Polyfill.
-	 *
-	 * @type {Array<string>}
-	 */
-	get dependencies() {
-		return this.config.dependencies || [];
-	}
-
-	/**
-	 * Path to "config.toml".
-	 *
-	 * @type {string}
-	 */
-	get configPath() {
-		return path.join(this.path.absolute, 'config.toml');
-	}
-
-	/**
-	 * Path to "detect.js".
-	 *
-	 * @type {string}
-	 */
-	get detectPath() {
-		return path.join(this.path.absolute, 'detect.js');
-	}
-
-	/**
-	 * Path to "polyfill.js".
-	 *
-	 * @type {string}
-	 */
-	get sourcePath() {
-		return path.join(this.path.absolute, 'polyfill.js');
-	}
-
-	/**
-	 * Path to "tests.js".
-	 *
-	 * @type {string}
-	 */
-	get testsPath() {
-		return path.join(this.path.absolute, 'tests.js');
-	}
-
-	/**
-	 * True when a "config.toml" file exists.
-	 *
-	 * @type {boolean}
-	 */
-	get hasConfigFile() {
-		return fs.existsSync(this.configPath);
-	}
-
-	/**
-	 * Update internal config after handling source files.
-	 */
-	updateConfig() {
-		this.config.size = this.sources.min.length;
-	}
-
-	/**
-	 * Load config for Polyfill.
-	 * Call this before doing any work with the Polyfill.
-	 *
-	 * @throws When the Polyfill has missing or invalid config.
-	 */
-	loadConfig() {
-		return readFile(this.configPath)
-			.catch(error => {
-				throw {
-					name: "Invalid config",
-					message: `Unable to read config from ${this.configPath}`,
-					error
-				};
-			})
-			.then(data => {
-				this.config = TOML.parse(data);
-
-				// Each internal polyfill needs to target all supported browsers at all versions.
-				if (this.path.relative.startsWith('_')) {
-					const supportedBrowsers = Object.keys(UA.getBaselines()).sort((a, b) => a.localeCompare(b));
-					if (!supportedBrowsers.every(browser => this.config.browsers[browser] === "*")) {
-						const browserSupport = {};
-						for (const browser of supportedBrowsers)  browserSupport[browser] = "*";
-						throw new Error("Internal polyfill called " + this.name + " is not targeting all supported browsers correctly. It should be: \n" + TOML.stringify(browserSupport));
-					}
-				}
-
-				this.config.detectSource = '';
-				this.config.baseDir = this.path.relative;
-
-				if ('licence' in this.config) {
-					throw new Error(`Incorrect spelling of license property in ${this.name}`);
-				}
-
-				this.config.hasTests = fs.existsSync(path.join(this.path.absolute, 'tests.js'));
-				this.config.isTestable = !('test' in this.config && 'ci' in this.config.test && this.config.test.ci === false);
-				this.config.isPublic = this.name.indexOf('_') !== 0;
-			});
-	}
-
-	/**
-	 * Check if the Polyfill has a License that allows it to be part of polyfill-library.
-	 *
-	 * @throws When the License isn't ok.
-	 */
-	checkLicense() {
-		if ('license' in this.config) {
-			const license = spdxLicenses.spdx(this.config.license);
-			if (license) {
-				// We allow CC0-1.0 and WTFPL as they are GPL compatible.
-				// https://www.gnu.org/licenses/license-list.html#WTFPL
-				// https://www.gnu.org/licenses/license-list.en.html#CC0
-				if (this.config.license !== 'CC0-1.0' && this.config.license !== 'WTFPL' && !license.OSIApproved) {
-					throw new Error(`The license ${this.config.license} (${license.name}) is not OSI approved.`);
-				}
-			} else {
-				throw new Error(`The license ${this.config.license} is not on the SPDX list of licenses ( https://spdx.org/licenses/ ).`);
-			}
-		}
-	}
-
-	/**
-	 * Load "detect.js" if it exists and validate.
-	 *
-	 * @throws When "detect.js" exists but isn't valid.
-	 */
-	loadDetect() {
-		if (fs.existsSync(this.detectPath)) {
-			this.config.detectSource = fs.readFileSync(this.detectPath, 'utf8').replace(/\s*$/, '') || '';
-			this.config.detectSource = this.minifyDetect(this.config.detectSource).min;
-			validateSource(`if (${this.config.detectSource}) true;`, `${this.name} feature detect from ${this.detectPath}`);
-		}
-	}
-
-	/**
-	 * Load "polyfill.js", minify, validate and remove source maps.
-	 *
-	 * @throws When "polyfill.js" doesn't exists or isn't valid.
-	 * @returns {Promise<void>} When done.
-	 */
-	loadSources() {
-		return readFile(this.sourcePath, 'utf8')
-			.catch(error => {
-				throw {
-					name: "Invalid source",
-					message: `Unable to read source from ${this.sourcePath}`,
-					error
-				};
-			})
-			.then(raw => this.minifyPolyfill(raw))
-			.catch(error => {
-				throw {
-					message: `Error minifying ${this.name}`,
-					error
-				};
-			})
-			.then(this.removeSourceMaps)
-			.then(sources => {
-				this.sources = sources;
-			});
-	}
-
-	/**
-	 * Minify "polyfill.js" and validate.
-	 *
-	 * @param {string} source Code found in "polyfill.js".
-	 * @throws When "polyfill.js" is invalid.
-	 * @returns {{raw: string, min: string}}
-	 */
-	minifyPolyfill(source) {
-		const raw = `\n// ${this.name}\n${source}`;
-
-		if (this.config.build && this.config.build.minify === false) {
-			// skipping any validation or minification process since
-			// the raw source is supposed to be production ready.
-			// Add a line break in case the final line is a comment
-			return {
-				raw: raw + '\n',
-				min: source + '\n'
-			};
-		} else {
-			validateSource(source, `${this.name} from ${this.sourcePath}`);
-
-			const minified = uglify.minify(source, {
-				fromString: true,
-				compress: {
-					screw_ie8: false,
-					keep_fnames: true
-				},
-				mangle: {
-					screw_ie8: false
-				},
-				output: {
-					screw_ie8: false,
-					beautify: false
-				}
-			});
-
-			return {
-				raw,
-				min: minified.code
-			};
-		}
-	}
-
-	/**
-	 * Minify "detect.js" and validate.
-	 *
-	 * @param {string} source Code found in "detect.js".
-	 * @throws When "detect.js" is invalid.
-	 * @returns {{raw: string, min: string}}
-	 */
-	minifyDetect(source) {
-		const raw = `\n// ${this.name}\n${source}`;
-
-		if (this.config.build && this.config.build.minify === false) {
-			// skipping any validation or minification process since
-			// the raw source is supposed to be production ready.
-			// Add a line break in case the final line is a comment
-			return {
-				raw: raw + '\n',
-				min: source + '\n'
-			};
-		} else {
-			validateSource(source, `${this.name} from ${this.sourcePath}`);
-
-			const minified = uglify.minify(source, {
-				fromString: true,
-				compress: {
-					screw_ie8: false,
-					expression: true,
-					keep_fnames: true
-				},
-				mangle: {
-					screw_ie8: false
-				},
-				output: {
-					screw_ie8: false,
-					beautify: false,
-					semicolons: false
-				}
-			});
-
-			return {
-				raw,
-				min: minified.code
-			};
-		}
-	}
-
-	/**
-	 * Remove source maps from source code.
-	 *
-	 * @param {{raw: string, min: string}} source JS source code.
-	 * @returns {{raw: string, min: string}} Cleaned source code.
-	 */
-	removeSourceMaps(source) {
-		const re = /^\/\/#\ssourceMappingURL(.+)$/gm;
-
-		return {
-			raw: source.raw.replace(re, ''),
-			min: source.min.replace(re, '')
-		};
-	}
-
-	/**
-	 * Write processed files to the output directory.
-	 *
-	 * @param {string} root The output directory.
-	 * @returns {Promise<void>} When done.
-	 */
-	writeOutput(root) {
-		const destination = path.join(root, this.name);
-		const files = [
-			['meta.json', JSON.stringify(this.config)],
-			['raw.js', this.sources.raw],
-			['min.js', this.sources.min]
-		];
-
-		return makeDirectory(destination)
-			.then(() => Promise.all(files
-				.map(([name, contents]) => [path.join(destination, name), contents])
-				.map(([path, contents]) => writeFile(path, contents))));
-	}
-}

package/tasks/buildsources/validate-source.js

@@ -1,23 +0,0 @@
-'use strict';
-
-const vm = require('vm');
-
-/**
- * Validate JS source code by compiling it in a separate V8 context
- *
- * @param {string} code JS source code
- * @param {string} label identifier for error messages
- *
- * @throws When code parsing fails
- */
-module.exports = function validateSource(code, label) {
-	try {
-		new vm.Script(code);
-	} catch (error) {
-		throw {
-			name: "Parse error",
-			message: `Error parsing source code for ${label}`,
-			error
-		};
-	}
-}

package/tasks/buildsources/watchsource.js

@@ -1,106 +0,0 @@
-'use strict';
-
-const path = require('path');
-const child_process = require('child_process');
-const fs = require('graceful-fs');
-
-const source = path.join(__dirname, '../../polyfills');
-
-const build = require('./build');
-const Polyfill = require('./polyfill');
-
-console.log('Doing a full build before starting watcher');
-
-// Keep a list of started test servers.
-let servers = [];
-
-// Kill all servers when exiting.
-process.on('exit', function () {
-	for (const serverProc of servers) {
-		serverProc.stdin.pause();
-		serverProc.kill();
-	}
-});
-
-
-processFeatureAndStartServer().then(() => {
-	console.log(`Watching...`);
-	let throttles = {};
-
-	if (fs.existsSync(source)) {
-		fs.watch(source, { recursive: true }, (eventType, fileName) => {
-			if (fileName.indexOf('__') === 0) {
-				return; // skip
-			}
-
-			const pathInfo = path.parse(fileName);
-			if (!fs.existsSync(path.join(source, pathInfo.dir, 'config.toml'))) {
-				return; // skip
-			}
-
-			const feature = (new Polyfill(path.join(source, pathInfo.dir), pathInfo.dir)).name;
-			if (throttles[feature]) {
-				clearTimeout(throttles[feature]);
-				delete throttles[feature];
-			}
-
-			throttles[feature] = setTimeout(() => {
-				delete throttles[feature];
-
-				console.log('Building : ' + feature);
-				processFeatureAndStartServer(feature).then(() => {
-					console.log(`Visit : http://bs-local.com:9876/test?includePolyfills=yes&always=no&feature=${feature}`);
-				});
-			}, 150);
-		});
-	} else {
-		console.warn('Polyfills directory does not exist.');
-		// eslint-disable-next-line unicorn/no-process-exit
-		process.exit(1);
-	}
-});
-
-/**
- * Build all or a single polyfill and (re)start the test server.
- *
- * @param {string|undefined} feature An optional feature to build. When omitted all polyfills will be build.
- * @returns {Promise<void>} When done.
- */
-async function processFeatureAndStartServer(feature) {
-	const startTime = new Date();
-
-	return build(feature)
-		.then(() => {
-			const endTime = new Date();
-			const timeDiff = (endTime - startTime) / 1000;
-
-			if (feature) {
-				console.log(`Built : ${feature} in ${Math.round(timeDiff)}s`);
-			} else {
-				console.log(`Built : everything in ${Math.round(timeDiff)}s`);
-			}
-
-			for (const serverProc of servers) {
-				serverProc.stdin.pause();
-				serverProc.kill();
-			}
-
-			servers = [];
-
-			const serverProc = child_process.spawn("node", ["./test/polyfills/server.js"], {
-				stdio: [undefined, process.stdout, process.stderr],
-			});
-
-			serverProc.on("exit", function (code) {
-				if (code) {
-					console.log("server exited with exit code " + code);
-				}
-			});
-
-			servers.push(serverProc);
-		})
-		.catch((error) => {
-			console.log(error);
-			console.log(JSON.stringify(error));
-		});
-}