123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479 |
- /*
- MIT License http://www.opensource.org/licenses/mit-license.php
- Author Tobias Koppers @sokra
- */
- "use strict";
- const Stats = require("./Stats");
- /** @typedef {import("../declarations/WebpackOptions").WatchOptions} WatchOptions */
- /** @typedef {import("./Compilation")} Compilation */
- /** @typedef {import("./Compiler")} Compiler */
- /** @typedef {import("./FileSystemInfo").FileSystemInfoEntry} FileSystemInfoEntry */
- /**
- * @template T
- * @callback Callback
- * @param {(Error | null)=} err
- * @param {T=} result
- */
- class Watching {
- /**
- * @param {Compiler} compiler the compiler
- * @param {WatchOptions} watchOptions options
- * @param {Callback<Stats>} handler completion handler
- */
- constructor(compiler, watchOptions, handler) {
- this.startTime = null;
- this.invalid = false;
- this.handler = handler;
- /** @type {Callback<void>[]} */
- this.callbacks = [];
- /** @type {Callback<void>[] | undefined} */
- this._closeCallbacks = undefined;
- this.closed = false;
- this.suspended = false;
- this.blocked = false;
- this._isBlocked = () => false;
- this._onChange = () => {};
- this._onInvalid = () => {};
- if (typeof watchOptions === "number") {
- this.watchOptions = {
- aggregateTimeout: watchOptions
- };
- } else if (watchOptions && typeof watchOptions === "object") {
- this.watchOptions = { ...watchOptions };
- } else {
- this.watchOptions = {};
- }
- if (typeof this.watchOptions.aggregateTimeout !== "number") {
- this.watchOptions.aggregateTimeout = 20;
- }
- this.compiler = compiler;
- this.running = false;
- this._initial = true;
- this._invalidReported = true;
- this._needRecords = true;
- this.watcher = undefined;
- this.pausedWatcher = undefined;
- /** @type {Set<string>} */
- this._collectedChangedFiles = undefined;
- /** @type {Set<string>} */
- this._collectedRemovedFiles = undefined;
- this._done = this._done.bind(this);
- process.nextTick(() => {
- if (this._initial) this._invalidate();
- });
- }
- /**
- * @param {ReadonlySet<string>} changedFiles changed files
- * @param {ReadonlySet<string>} removedFiles removed files
- */
- _mergeWithCollected(changedFiles, removedFiles) {
- if (!changedFiles) return;
- if (!this._collectedChangedFiles) {
- this._collectedChangedFiles = new Set(changedFiles);
- this._collectedRemovedFiles = new Set(removedFiles);
- } else {
- for (const file of changedFiles) {
- this._collectedChangedFiles.add(file);
- this._collectedRemovedFiles.delete(file);
- }
- for (const file of removedFiles) {
- this._collectedChangedFiles.delete(file);
- this._collectedRemovedFiles.add(file);
- }
- }
- }
- /**
- * @param {ReadonlyMap<string, FileSystemInfoEntry | "ignore">=} fileTimeInfoEntries info for files
- * @param {ReadonlyMap<string, FileSystemInfoEntry | "ignore">=} contextTimeInfoEntries info for directories
- * @param {ReadonlySet<string>=} changedFiles changed files
- * @param {ReadonlySet<string>=} removedFiles removed files
- * @returns {void}
- */
- _go(fileTimeInfoEntries, contextTimeInfoEntries, changedFiles, removedFiles) {
- this._initial = false;
- if (this.startTime === null) this.startTime = Date.now();
- this.running = true;
- if (this.watcher) {
- this.pausedWatcher = this.watcher;
- this.lastWatcherStartTime = Date.now();
- this.watcher.pause();
- this.watcher = null;
- } else if (!this.lastWatcherStartTime) {
- this.lastWatcherStartTime = Date.now();
- }
- this.compiler.fsStartTime = Date.now();
- if (
- changedFiles &&
- removedFiles &&
- fileTimeInfoEntries &&
- contextTimeInfoEntries
- ) {
- this._mergeWithCollected(changedFiles, removedFiles);
- this.compiler.fileTimestamps = fileTimeInfoEntries;
- this.compiler.contextTimestamps = contextTimeInfoEntries;
- } else if (this.pausedWatcher) {
- if (this.pausedWatcher.getInfo) {
- const {
- changes,
- removals,
- fileTimeInfoEntries,
- contextTimeInfoEntries
- } = this.pausedWatcher.getInfo();
- this._mergeWithCollected(changes, removals);
- this.compiler.fileTimestamps = fileTimeInfoEntries;
- this.compiler.contextTimestamps = contextTimeInfoEntries;
- } else {
- this._mergeWithCollected(
- this.pausedWatcher.getAggregatedChanges &&
- this.pausedWatcher.getAggregatedChanges(),
- this.pausedWatcher.getAggregatedRemovals &&
- this.pausedWatcher.getAggregatedRemovals()
- );
- this.compiler.fileTimestamps =
- this.pausedWatcher.getFileTimeInfoEntries();
- this.compiler.contextTimestamps =
- this.pausedWatcher.getContextTimeInfoEntries();
- }
- }
- this.compiler.modifiedFiles = this._collectedChangedFiles;
- this._collectedChangedFiles = undefined;
- this.compiler.removedFiles = this._collectedRemovedFiles;
- this._collectedRemovedFiles = undefined;
- const run = () => {
- if (this.compiler.idle) {
- return this.compiler.cache.endIdle(err => {
- if (err) return this._done(err);
- this.compiler.idle = false;
- run();
- });
- }
- if (this._needRecords) {
- return this.compiler.readRecords(err => {
- if (err) return this._done(err);
- this._needRecords = false;
- run();
- });
- }
- this.invalid = false;
- this._invalidReported = false;
- this.compiler.hooks.watchRun.callAsync(this.compiler, err => {
- if (err) return this._done(err);
- const onCompiled = (err, compilation) => {
- if (err) return this._done(err, compilation);
- if (this.invalid) return this._done(null, compilation);
- if (this.compiler.hooks.shouldEmit.call(compilation) === false) {
- return this._done(null, compilation);
- }
- process.nextTick(() => {
- const logger = compilation.getLogger("webpack.Compiler");
- logger.time("emitAssets");
- this.compiler.emitAssets(compilation, err => {
- logger.timeEnd("emitAssets");
- if (err) return this._done(err, compilation);
- if (this.invalid) return this._done(null, compilation);
- logger.time("emitRecords");
- this.compiler.emitRecords(err => {
- logger.timeEnd("emitRecords");
- if (err) return this._done(err, compilation);
- if (compilation.hooks.needAdditionalPass.call()) {
- compilation.needAdditionalPass = true;
- compilation.startTime = this.startTime;
- compilation.endTime = Date.now();
- logger.time("done hook");
- const stats = new Stats(compilation);
- this.compiler.hooks.done.callAsync(stats, err => {
- logger.timeEnd("done hook");
- if (err) return this._done(err, compilation);
- this.compiler.hooks.additionalPass.callAsync(err => {
- if (err) return this._done(err, compilation);
- this.compiler.compile(onCompiled);
- });
- });
- return;
- }
- return this._done(null, compilation);
- });
- });
- });
- };
- this.compiler.compile(onCompiled);
- });
- };
- run();
- }
- /**
- * @param {Compilation} compilation the compilation
- * @returns {Stats} the compilation stats
- */
- _getStats(compilation) {
- const stats = new Stats(compilation);
- return stats;
- }
- /**
- * @param {Error=} err an optional error
- * @param {Compilation=} compilation the compilation
- * @returns {void}
- */
- _done(err, compilation) {
- this.running = false;
- const logger = compilation && compilation.getLogger("webpack.Watching");
- let stats = null;
- const handleError = (err, cbs) => {
- this.compiler.hooks.failed.call(err);
- this.compiler.cache.beginIdle();
- this.compiler.idle = true;
- this.handler(err, stats);
- if (!cbs) {
- cbs = this.callbacks;
- this.callbacks = [];
- }
- for (const cb of cbs) cb(err);
- };
- if (
- this.invalid &&
- !this.suspended &&
- !this.blocked &&
- !(this._isBlocked() && (this.blocked = true))
- ) {
- if (compilation) {
- logger.time("storeBuildDependencies");
- this.compiler.cache.storeBuildDependencies(
- compilation.buildDependencies,
- err => {
- logger.timeEnd("storeBuildDependencies");
- if (err) return handleError(err);
- this._go();
- }
- );
- } else {
- this._go();
- }
- return;
- }
- if (compilation) {
- compilation.startTime = this.startTime;
- compilation.endTime = Date.now();
- stats = new Stats(compilation);
- }
- this.startTime = null;
- if (err) return handleError(err);
- const cbs = this.callbacks;
- this.callbacks = [];
- logger.time("done hook");
- this.compiler.hooks.done.callAsync(stats, err => {
- logger.timeEnd("done hook");
- if (err) return handleError(err, cbs);
- this.handler(null, stats);
- logger.time("storeBuildDependencies");
- this.compiler.cache.storeBuildDependencies(
- compilation.buildDependencies,
- err => {
- logger.timeEnd("storeBuildDependencies");
- if (err) return handleError(err, cbs);
- logger.time("beginIdle");
- this.compiler.cache.beginIdle();
- this.compiler.idle = true;
- logger.timeEnd("beginIdle");
- process.nextTick(() => {
- if (!this.closed) {
- this.watch(
- compilation.fileDependencies,
- compilation.contextDependencies,
- compilation.missingDependencies
- );
- }
- });
- for (const cb of cbs) cb(null);
- this.compiler.hooks.afterDone.call(stats);
- }
- );
- });
- }
- /**
- * @param {Iterable<string>} files watched files
- * @param {Iterable<string>} dirs watched directories
- * @param {Iterable<string>} missing watched existence entries
- * @returns {void}
- */
- watch(files, dirs, missing) {
- this.pausedWatcher = null;
- this.watcher = this.compiler.watchFileSystem.watch(
- files,
- dirs,
- missing,
- this.lastWatcherStartTime,
- this.watchOptions,
- (
- err,
- fileTimeInfoEntries,
- contextTimeInfoEntries,
- changedFiles,
- removedFiles
- ) => {
- if (err) {
- this.compiler.modifiedFiles = undefined;
- this.compiler.removedFiles = undefined;
- this.compiler.fileTimestamps = undefined;
- this.compiler.contextTimestamps = undefined;
- this.compiler.fsStartTime = undefined;
- return this.handler(err);
- }
- this._invalidate(
- fileTimeInfoEntries,
- contextTimeInfoEntries,
- changedFiles,
- removedFiles
- );
- this._onChange();
- },
- (fileName, changeTime) => {
- if (!this._invalidReported) {
- this._invalidReported = true;
- this.compiler.hooks.invalid.call(fileName, changeTime);
- }
- this._onInvalid();
- }
- );
- }
- /**
- * @param {Callback<void>=} callback signals when the build has completed again
- * @returns {void}
- */
- invalidate(callback) {
- if (callback) {
- this.callbacks.push(callback);
- }
- if (!this._invalidReported) {
- this._invalidReported = true;
- this.compiler.hooks.invalid.call(null, Date.now());
- }
- this._onChange();
- this._invalidate();
- }
- _invalidate(
- fileTimeInfoEntries,
- contextTimeInfoEntries,
- changedFiles,
- removedFiles
- ) {
- if (this.suspended || (this._isBlocked() && (this.blocked = true))) {
- this._mergeWithCollected(changedFiles, removedFiles);
- return;
- }
- if (this.running) {
- this._mergeWithCollected(changedFiles, removedFiles);
- this.invalid = true;
- } else {
- this._go(
- fileTimeInfoEntries,
- contextTimeInfoEntries,
- changedFiles,
- removedFiles
- );
- }
- }
- suspend() {
- this.suspended = true;
- }
- resume() {
- if (this.suspended) {
- this.suspended = false;
- this._invalidate();
- }
- }
- /**
- * @param {Callback<void>} callback signals when the watcher is closed
- * @returns {void}
- */
- close(callback) {
- if (this._closeCallbacks) {
- if (callback) {
- this._closeCallbacks.push(callback);
- }
- return;
- }
- const finalCallback = (err, compilation) => {
- this.running = false;
- this.compiler.running = false;
- this.compiler.watching = undefined;
- this.compiler.watchMode = false;
- this.compiler.modifiedFiles = undefined;
- this.compiler.removedFiles = undefined;
- this.compiler.fileTimestamps = undefined;
- this.compiler.contextTimestamps = undefined;
- this.compiler.fsStartTime = undefined;
- const shutdown = err => {
- this.compiler.hooks.watchClose.call();
- const closeCallbacks = this._closeCallbacks;
- this._closeCallbacks = undefined;
- for (const cb of closeCallbacks) cb(err);
- };
- if (compilation) {
- const logger = compilation.getLogger("webpack.Watching");
- logger.time("storeBuildDependencies");
- this.compiler.cache.storeBuildDependencies(
- compilation.buildDependencies,
- err2 => {
- logger.timeEnd("storeBuildDependencies");
- shutdown(err || err2);
- }
- );
- } else {
- shutdown(err);
- }
- };
- this.closed = true;
- if (this.watcher) {
- this.watcher.close();
- this.watcher = null;
- }
- if (this.pausedWatcher) {
- this.pausedWatcher.close();
- this.pausedWatcher = null;
- }
- this._closeCallbacks = [];
- if (callback) {
- this._closeCallbacks.push(callback);
- }
- if (this.running) {
- this.invalid = true;
- this._done = finalCallback;
- } else {
- finalCallback();
- }
- }
- }
- module.exports = Watching;
|