123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302 |
- import path from 'path';
- import { VirtualStats } from './virtual-stats';
- import type { Compiler } from 'webpack';
- let inode = 45000000;
- function checkActivation(instance) {
- if (!instance._compiler) {
- throw new Error('You must use this plugin only after creating webpack instance!');
- }
- }
- function getModulePath(filePath, compiler) {
- return path.isAbsolute(filePath) ? filePath : path.join(compiler.context, filePath);
- }
- function createWebpackData(result) {
- return (backendOrStorage) => {
- // In Webpack v5, this variable is a "Backend", and has the data stored in a field
- // _data. In V4, the `_` prefix isn't present.
- if (backendOrStorage._data) {
- const curLevelIdx = backendOrStorage._currentLevel;
- const curLevel = backendOrStorage._levels[curLevelIdx];
- return {
- result,
- level: curLevel,
- };
- }
- // Webpack 4
- return [null, result];
- };
- }
- function getData(storage, key) {
- // Webpack 5
- if (storage._data instanceof Map) {
- return storage._data.get(key);
- } else if (storage._data) {
- return storage.data[key];
- } else if (storage.data instanceof Map) {
- // Webpack v4
- return storage.data.get(key);
- } else {
- return storage.data[key];
- }
- }
- function setData(backendOrStorage, key, valueFactory) {
- const value = valueFactory(backendOrStorage);
- // Webpack v5
- if (backendOrStorage._data instanceof Map) {
- backendOrStorage._data.set(key, value);
- } else if (backendOrStorage._data) {
- backendOrStorage.data[key] = value;
- } else if (backendOrStorage.data instanceof Map) {
- // Webpack 4
- backendOrStorage.data.set(key, value);
- } else {
- backendOrStorage.data[key] = value;
- }
- }
- function getStatStorage(fileSystem) {
- if (fileSystem._statStorage) {
- // Webpack v4
- return fileSystem._statStorage;
- } else if (fileSystem._statBackend) {
- // webpack v5
- return fileSystem._statBackend;
- } else {
- // Unknown version?
- throw new Error("Couldn't find a stat storage");
- }
- }
- function getFileStorage(fileSystem) {
- if (fileSystem._readFileStorage) {
- // Webpack v4
- return fileSystem._readFileStorage;
- } else if (fileSystem._readFileBackend) {
- // Webpack v5
- return fileSystem._readFileBackend;
- } else {
- throw new Error("Couldn't find a readFileStorage");
- }
- }
- function getReadDirBackend(fileSystem) {
- if (fileSystem._readdirBackend) {
- return fileSystem._readdirBackend;
- } else if (fileSystem._readdirStorage) {
- return fileSystem._readdirStorage;
- } else {
- throw new Error("Couldn't find a readDirStorage from Webpack Internals");
- }
- }
- class VirtualModulesPlugin {
- private _staticModules: Record<string, string> | null;
- private _compiler: Compiler | null = null;
- private _watcher: any = null;
- public constructor(modules?: Record<string, string>) {
- this._staticModules = modules || null;
- }
- public writeModule(filePath: string, contents: string): void {
- if (!this._compiler) {
- throw new Error(`Plugin has not been initialized`);
- }
- checkActivation(this);
- const len = contents ? contents.length : 0;
- const time = Date.now();
- const date = new Date(time);
- const stats = new VirtualStats({
- dev: 8675309,
- nlink: 0,
- uid: 1000,
- gid: 1000,
- rdev: 0,
- blksize: 4096,
- ino: inode++,
- mode: 33188,
- size: len,
- blocks: Math.floor(len / 4096),
- atime: date,
- mtime: date,
- ctime: date,
- birthtime: date,
- });
- const modulePath = getModulePath(filePath, this._compiler);
- if (process.env.WVM_DEBUG)
- // eslint-disable-next-line no-console
- console.log(this._compiler.name, 'Write virtual module:', modulePath, contents);
- // When using the WatchIgnorePlugin (https://github.com/webpack/webpack/blob/52184b897f40c75560b3630e43ca642fcac7e2cf/lib/WatchIgnorePlugin.js),
- // the original watchFileSystem is stored in `wfs`. The following "unwraps" the ignoring
- // wrappers, giving us access to the "real" watchFileSystem.
- let finalWatchFileSystem = this._watcher && this._watcher.watchFileSystem;
- while (finalWatchFileSystem && finalWatchFileSystem.wfs) {
- finalWatchFileSystem = finalWatchFileSystem.wfs;
- }
- let finalInputFileSystem: any = this._compiler.inputFileSystem;
- while (finalInputFileSystem && finalInputFileSystem._inputFileSystem) {
- finalInputFileSystem = finalInputFileSystem._inputFileSystem;
- }
- finalInputFileSystem._writeVirtualFile(modulePath, stats, contents);
- if (
- finalWatchFileSystem &&
- (finalWatchFileSystem.watcher.fileWatchers.size || finalWatchFileSystem.watcher.fileWatchers.length)
- ) {
- const fileWatchers =
- finalWatchFileSystem.watcher.fileWatchers instanceof Map
- ? Array.from(finalWatchFileSystem.watcher.fileWatchers.values())
- : finalWatchFileSystem.watcher.fileWatchers;
- for (let fileWatcher of fileWatchers) {
- if ('watcher' in fileWatcher) {
- fileWatcher = fileWatcher.watcher;
- }
- if (fileWatcher.path === modulePath) {
- if (process.env.DEBUG)
- // eslint-disable-next-line no-console
- console.log(this._compiler.name, 'Emit file change:', modulePath, time);
- delete fileWatcher.directoryWatcher._cachedTimeInfoEntries;
- fileWatcher.emit('change', time, null);
- }
- }
- }
- }
- public apply(compiler: Compiler) {
- this._compiler = compiler;
- const afterEnvironmentHook = () => {
- let finalInputFileSystem: any = compiler.inputFileSystem;
- while (finalInputFileSystem && finalInputFileSystem._inputFileSystem) {
- finalInputFileSystem = finalInputFileSystem._inputFileSystem;
- }
- if (!finalInputFileSystem._writeVirtualFile) {
- const originalPurge = finalInputFileSystem.purge;
- finalInputFileSystem.purge = () => {
- originalPurge.apply(finalInputFileSystem, []);
- if (finalInputFileSystem._virtualFiles) {
- Object.keys(finalInputFileSystem._virtualFiles).forEach((file) => {
- const data = finalInputFileSystem._virtualFiles[file];
- finalInputFileSystem._writeVirtualFile(file, data.stats, data.contents);
- });
- }
- };
- finalInputFileSystem._writeVirtualFile = (file, stats, contents) => {
- const statStorage = getStatStorage(finalInputFileSystem);
- const fileStorage = getFileStorage(finalInputFileSystem);
- const readDirStorage = getReadDirBackend(finalInputFileSystem);
- finalInputFileSystem._virtualFiles = finalInputFileSystem._virtualFiles || {};
- finalInputFileSystem._virtualFiles[file] = { stats: stats, contents: contents };
- setData(statStorage, file, createWebpackData(stats));
- setData(fileStorage, file, createWebpackData(contents));
- const segments = file.split(/[\\/]/);
- let count = segments.length - 1;
- const minCount = segments[0] ? 1 : 0;
- while (count > minCount) {
- const dir = segments.slice(0, count).join(path.sep) || path.sep;
- try {
- finalInputFileSystem.readdirSync(dir);
- } catch (e) {
- const time = Date.now();
- const dirStats = new VirtualStats({
- dev: 8675309,
- nlink: 0,
- uid: 1000,
- gid: 1000,
- rdev: 0,
- blksize: 4096,
- ino: inode++,
- mode: 16877,
- size: stats.size,
- blocks: Math.floor(stats.size / 4096),
- atime: time,
- mtime: time,
- ctime: time,
- birthtime: time,
- });
- setData(readDirStorage, dir, createWebpackData([]));
- setData(statStorage, dir, createWebpackData(dirStats));
- }
- let dirData = getData(getReadDirBackend(finalInputFileSystem), dir);
- // Webpack v4 returns an array, webpack v5 returns an object
- dirData = dirData[1] || dirData.result;
- const filename = segments[count];
- if (dirData.indexOf(filename) < 0) {
- const files = dirData.concat([filename]).sort();
- setData(getReadDirBackend(finalInputFileSystem), dir, createWebpackData(files));
- } else {
- break;
- }
- count--;
- }
- };
- }
- };
- const afterResolversHook = () => {
- if (this._staticModules) {
- for (const [filePath, contents] of Object.entries(this._staticModules)) {
- this.writeModule(filePath, contents);
- }
- this._staticModules = null;
- }
- };
- // The webpack property is not exposed in webpack v4
- const version = typeof (compiler as any).webpack === 'undefined' ? 4 : 5;
- const watchRunHook = (watcher, callback) => {
- this._watcher = watcher.compiler || watcher;
- const virtualFiles = (compiler as any).inputFileSystem._virtualFiles;
- const fts = compiler.fileTimestamps as any;
- if (virtualFiles && fts && typeof fts.set === 'function') {
- Object.keys(virtualFiles).forEach((file) => {
- const mtime = +virtualFiles[file].stats.mtime;
- // fts is
- // Map<string, number> in webpack 4
- // Map<string, { safeTime: number; timestamp: number; }> in webpack 5
- fts.set(
- file,
- version === 4
- ? mtime
- : {
- safeTime: mtime,
- timestamp: mtime,
- }
- );
- });
- }
- callback();
- };
- if (compiler.hooks) {
- compiler.hooks.afterEnvironment.tap('VirtualModulesPlugin', afterEnvironmentHook);
- compiler.hooks.afterResolvers.tap('VirtualModulesPlugin', afterResolversHook);
- compiler.hooks.watchRun.tapAsync('VirtualModulesPlugin', watchRunHook);
- } else {
- (compiler as any).plugin('after-environment', afterEnvironmentHook);
- (compiler as any).plugin('after-resolvers', afterResolversHook);
- (compiler as any).plugin('watch-run', watchRunHook);
- }
- }
- }
- export = VirtualModulesPlugin;
|