feat: migrate from reporters to workers (#691)

Use simple functions and modules to simplify worker code

Author: piotr-oles

.gitignore

@@ -2,7 +2,7 @@
 *.log
 
 # Package artifacts
-lib
+/lib
 
 # Package archive used by e2e tests
 fork-ts-checker-webpack-plugin-0.0.0-semantic-release.tgz

src/ForkTsCheckerWebpackPlugin.ts

@@ -1,3 +1,5 @@
+import * as path from 'path';
+
 import { cosmiconfigSync } from 'cosmiconfig';
 import merge from 'deepmerge';
 import type { JSONSchema7 } from 'json-schema';
@@ -15,10 +17,12 @@ import { dependenciesPool, issuesPool } from './hooks/pluginPools';
 import { tapAfterCompileToAddDependencies } from './hooks/tapAfterCompileToAddDependencies';
 import { tapAfterEnvironmentToPatchWatching } from './hooks/tapAfterEnvironmentToPatchWatching';
 import { tapErrorToLogMessage } from './hooks/tapErrorToLogMessage';
-import { tapStartToConnectAndRunReporter } from './hooks/tapStartToConnectAndRunReporter';
-import { tapStopToDisconnectReporter } from './hooks/tapStopToDisconnectReporter';
-import { createTypeScriptReporterRpcClient } from './typescript-reporter/reporter/TypeScriptReporterRpcClient';
-import { assertTypeScriptSupport } from './typescript-reporter/TypeScriptSupport';
+import { tapStartToRunWorkers } from './hooks/tapStartToRunWorkers';
+import { tapStopToTerminateWorkers } from './hooks/tapStopToTerminateWorkers';
+import { assertTypeScriptSupport } from './typescript/TypeScriptSupport';
+import type { GetDependenciesWorker } from './typescript/worker/get-dependencies-worker';
+import type { GetIssuesWorker } from './typescript/worker/get-issues-worker';
+import { createRpcWorker } from './utils/rpc';
 
 class ForkTsCheckerWebpackPlugin {
   /**
@@ -61,19 +65,20 @@ class ForkTsCheckerWebpackPlugin {
     const state = createForkTsCheckerWebpackPluginState();
 
     assertTypeScriptSupport(configuration.typescript);
-    const issuesReporter = createTypeScriptReporterRpcClient(configuration.typescript);
-    const dependenciesReporter = createTypeScriptReporterRpcClient(configuration.typescript);
+    const getIssuesWorker = createRpcWorker<GetIssuesWorker>(
+      path.resolve(__dirname, './typescript/worker/get-issues-worker.js'),
+      configuration.typescript,
+      configuration.typescript.memoryLimit
+    );
+    const getDependenciesWorker = createRpcWorker<GetDependenciesWorker>(
+      path.resolve(__dirname, './typescript/worker/get-dependencies-worker.js'),
+      configuration.typescript
+    );
 
     tapAfterEnvironmentToPatchWatching(compiler, state);
-    tapStartToConnectAndRunReporter(
-      compiler,
-      issuesReporter,
-      dependenciesReporter,
-      configuration,
-      state
-    );
+    tapStartToRunWorkers(compiler, getIssuesWorker, getDependenciesWorker, configuration, state);
     tapAfterCompileToAddDependencies(compiler, configuration, state);
-    tapStopToDisconnectReporter(compiler, issuesReporter, dependenciesReporter, state);
+    tapStopToTerminateWorkers(compiler, getIssuesWorker, getDependenciesWorker, state);
     tapErrorToLogMessage(compiler, configuration);
   }
 }

src/ForkTsCheckerWebpackPluginConfiguration.ts

@@ -7,8 +7,8 @@ import type { IssueConfiguration } from './issue/IssueConfiguration';
 import { createIssueConfiguration } from './issue/IssueConfiguration';
 import type { LoggerConfiguration } from './logger/LoggerConfiguration';
 import { createLoggerConfiguration } from './logger/LoggerConfiguration';
-import type { TypeScriptReporterConfiguration } from './typescript-reporter/TypeScriptReporterConfiguration';
-import { createTypeScriptReporterConfiguration } from './typescript-reporter/TypeScriptReporterConfiguration';
+import type { TypeScriptReporterConfiguration } from './typescript/TypeScriptReporterConfiguration';
+import { createTypeScriptReporterConfiguration } from './typescript/TypeScriptReporterConfiguration';
 
 interface ForkTsCheckerWebpackPluginConfiguration {
   async: boolean;

src/ForkTsCheckerWebpackPluginOptions.ts

@@ -1,7 +1,7 @@
 import type { FormatterOptions } from './formatter';
 import type { IssueOptions } from './issue/IssueOptions';
 import type LoggerOptions from './logger/LoggerOptions';
-import type { TypeScriptReporterOptions } from './typescript-reporter/TypeScriptReporterOptions';
+import type { TypeScriptReporterOptions } from './typescript/TypeScriptReporterOptions';
 
 interface ForkTsCheckerWebpackPluginOptions {
   async?: boolean;

src/ForkTsCheckerWebpackPluginState.ts

@@ -1,28 +1,26 @@
 import type { FullTap } from 'tapable';
 
+import type { FilesMatch } from './files-match';
 import type { Issue } from './issue';
-import type { FilesMatch, Report } from './reporter';
 
 interface ForkTsCheckerWebpackPluginState {
-  issuesReportPromise: Promise<Report | undefined>;
-  dependenciesReportPromise: Promise<Report | undefined>;
   issuesPromise: Promise<Issue[] | undefined>;
   dependenciesPromise: Promise<FilesMatch | undefined>;
   lastDependencies: FilesMatch | undefined;
   watching: boolean;
   initialized: boolean;
+  iteration: number;
   webpackDevServerDoneTap: FullTap | undefined;
 }
 
 function createForkTsCheckerWebpackPluginState(): ForkTsCheckerWebpackPluginState {
   return {
-    issuesReportPromise: Promise.resolve(undefined),
-    dependenciesReportPromise: Promise.resolve(undefined),
     issuesPromise: Promise.resolve(undefined),
     dependenciesPromise: Promise.resolve(undefined),
     lastDependencies: undefined,
     watching: false,
     initialized: false,
+    iteration: 0,
     webpackDevServerDoneTap: undefined,
   };
 }

src/error/OperationCanceledError.ts

@@ -1,24 +1,24 @@
-import type { Compiler } from 'webpack';
+import type * as webpack from 'webpack';
 
-import subtract from '../utils/array/substract';
-import unique from '../utils/array/unique';
+import subtract from './utils/array/substract';
+import unique from './utils/array/unique';
 
 interface FilesChange {
   changedFiles?: string[];
   deletedFiles?: string[];
 }
 
-const compilerFilesChangeMap = new WeakMap<Compiler, FilesChange>();
+const compilerFilesChangeMap = new WeakMap<webpack.Compiler, FilesChange>();
 
-function getFilesChange(compiler: Compiler): FilesChange {
+function getFilesChange(compiler: webpack.Compiler): FilesChange {
   return compilerFilesChangeMap.get(compiler) || { changedFiles: [], deletedFiles: [] };
 }
 
-function updateFilesChange(compiler: Compiler, change: FilesChange): void {
+function updateFilesChange(compiler: webpack.Compiler, change: FilesChange): void {
   compilerFilesChangeMap.set(compiler, aggregateFilesChanges([getFilesChange(compiler), change]));
 }
 
-function clearFilesChange(compiler: Compiler): void {
+function clearFilesChange(compiler: webpack.Compiler): void {
   compilerFilesChangeMap.delete(compiler);
 }
 

src/reporter/FilesChange.ts renamed to src/files-change.ts

@@ -2,12 +2,15 @@ import type webpack from 'webpack';
 
 import type { ForkTsCheckerWebpackPluginConfiguration } from '../ForkTsCheckerWebpackPluginConfiguration';
 import type { ForkTsCheckerWebpackPluginState } from '../ForkTsCheckerWebpackPluginState';
+import { getInfrastructureLogger } from '../infrastructure-logger';
 
 function interceptDoneToGetWebpackDevServerTap(
   compiler: webpack.Compiler,
   configuration: ForkTsCheckerWebpackPluginConfiguration,
   state: ForkTsCheckerWebpackPluginState
 ) {
+  const { debug } = getInfrastructureLogger(compiler);
+
   // inspired by https://github.com/ypresto/fork-ts-checker-async-overlay-webpack-plugin
   compiler.hooks.done.intercept({
     register: (tap) => {
@@ -16,6 +19,7 @@ function interceptDoneToGetWebpackDevServerTap(
         tap.type === 'sync' &&
         configuration.logger.devServer
       ) {
+        debug('Intercepting webpack-dev-server tap.');
         state.webpackDevServerDoneTap = tap;
       }
       return tap;

src/reporter/FilesMatch.ts renamed to src/files-match.ts

@@ -1,8 +1,8 @@
 import { SyncHook, SyncWaterfallHook, AsyncSeriesWaterfallHook } from 'tapable';
 import type * as webpack from 'webpack';
 
+import type { FilesChange } from '../files-change';
 import type { Issue } from '../issue';
-import type { FilesChange } from '../reporter';
 
 const compilerHookMap = new WeakMap<
   webpack.Compiler | webpack.MultiCompiler,

src/hooks/interceptDoneToGetWebpackDevServerTap.ts

@@ -2,12 +2,15 @@ import type webpack from 'webpack';
 
 import type { ForkTsCheckerWebpackPluginConfiguration } from '../ForkTsCheckerWebpackPluginConfiguration';
 import type { ForkTsCheckerWebpackPluginState } from '../ForkTsCheckerWebpackPluginState';
+import { getInfrastructureLogger } from '../infrastructure-logger';
 
 function tapAfterCompileToAddDependencies(
   compiler: webpack.Compiler,
   configuration: ForkTsCheckerWebpackPluginConfiguration,
   state: ForkTsCheckerWebpackPluginState
 ) {
+  const { debug } = getInfrastructureLogger(compiler);
+
   compiler.hooks.afterCompile.tapPromise('ForkTsCheckerWebpackPlugin', async (compilation) => {
     if (compilation.compiler !== compiler) {
       // run only for the compiler that the plugin was registered for
@@ -16,6 +19,7 @@ function tapAfterCompileToAddDependencies(
 
     const dependencies = await state.dependenciesPromise;
 
+    debug(`Got dependencies from the getDependenciesWorker.`, dependencies);
     if (dependencies) {
       state.lastDependencies = dependencies;
 

src/hooks/pluginHooks.ts

@@ -2,6 +2,7 @@ import type webpack from 'webpack';
 
 import type { ForkTsCheckerWebpackPluginConfiguration } from '../ForkTsCheckerWebpackPluginConfiguration';
 import type { ForkTsCheckerWebpackPluginState } from '../ForkTsCheckerWebpackPluginState';
+import { getInfrastructureLogger } from '../infrastructure-logger';
 import type { Issue } from '../issue';
 import { IssueWebpackError } from '../issue/IssueWebpackError';
 
@@ -13,6 +14,7 @@ function tapAfterCompileToGetIssues(
   state: ForkTsCheckerWebpackPluginState
 ) {
   const hooks = getForkTsCheckerWebpackPluginHooks(compiler);
+  const { debug } = getInfrastructureLogger(compiler);
 
   compiler.hooks.afterCompile.tapPromise('ForkTsCheckerWebpackPlugin', async (compilation) => {
     if (compilation.compiler !== compiler) {
@@ -29,6 +31,8 @@ function tapAfterCompileToGetIssues(
       return;
     }
 
+    debug('Got issues from getIssuesWorker.', issues?.length);
+
     if (!issues) {
       // some error has been thrown or it was canceled
       return;

src/hooks/tapAfterCompileToAddDependencies.ts

@@ -1,23 +1,29 @@
 import type webpack from 'webpack';
 
 import type { ForkTsCheckerWebpackPluginState } from '../ForkTsCheckerWebpackPluginState';
+import { getInfrastructureLogger } from '../infrastructure-logger';
 import { InclusiveNodeWatchFileSystem } from '../watch/InclusiveNodeWatchFileSystem';
 import type { WatchFileSystem } from '../watch/WatchFileSystem';
 
 function tapAfterEnvironmentToPatchWatching(
   compiler: webpack.Compiler,
   state: ForkTsCheckerWebpackPluginState
 ) {
+  const { debug } = getInfrastructureLogger(compiler);
+
   compiler.hooks.afterEnvironment.tap('ForkTsCheckerWebpackPlugin', () => {
     const watchFileSystem = compiler.watchFileSystem;
     if (watchFileSystem) {
+      debug("Overwriting webpack's watch file system.");
       // wrap original watch file system
       compiler.watchFileSystem = new InclusiveNodeWatchFileSystem(
         // we use some internals here
         watchFileSystem as WatchFileSystem,
         compiler,
         state
       );
+    } else {
+      debug('No watch file system found - plugin may not work correctly.');
     }
   });
 }

src/hooks/tapAfterCompileToGetIssues.ts

@@ -4,6 +4,7 @@ import type webpack from 'webpack';
 import type { ForkTsCheckerWebpackPluginConfiguration } from '../ForkTsCheckerWebpackPluginConfiguration';
 import type { ForkTsCheckerWebpackPluginState } from '../ForkTsCheckerWebpackPluginState';
 import { createWebpackFormatter } from '../formatter/WebpackFormatter';
+import { getInfrastructureLogger } from '../infrastructure-logger';
 import type { Issue } from '../issue';
 import { IssueWebpackError } from '../issue/IssueWebpackError';
 import isPending from '../utils/async/isPending';
@@ -17,14 +18,14 @@ function tapDoneToAsyncGetIssues(
   state: ForkTsCheckerWebpackPluginState
 ) {
   const hooks = getForkTsCheckerWebpackPluginHooks(compiler);
+  const { log, debug } = getInfrastructureLogger(compiler);
 
   compiler.hooks.done.tap('ForkTsCheckerWebpackPlugin', async (stats) => {
     if (stats.compilation.compiler !== compiler) {
       // run only for the compiler that the plugin was registered for
       return;
     }
 
-    const reportPromise = state.issuesReportPromise;
     const issuesPromise = state.issuesPromise;
     let issues: Issue[] | undefined;
 
@@ -38,6 +39,7 @@ function tapDoneToAsyncGetIssues(
       }
 
       issues = await issuesPromise;
+      debug('Got issues from getIssuesWorker.', issues?.length);
     } catch (error) {
       hooks.error.call(error, stats.compilation);
       return;
@@ -48,11 +50,6 @@ function tapDoneToAsyncGetIssues(
       return;
     }
 
-    if (reportPromise !== state.issuesReportPromise) {
-      // there is a newer report - ignore this one
-      return;
-    }
-
     // filter list of issues by provided issue predicate
     issues = issues.filter(configuration.issue.predicate);
 
@@ -81,13 +78,12 @@ function tapDoneToAsyncGetIssues(
         }
       });
 
+      debug('Sending issues to the webpack-dev-server.');
       state.webpackDevServerDoneTap.fn(stats);
     }
 
     if (stats.startTime) {
-      configuration.logger.infrastructure.log(
-        `Time: ${Math.round(Date.now() - stats.startTime).toString()} ms`
-      );
+      log(`Time: ${Math.round(Date.now() - stats.startTime).toString()} ms`);
     }
   });
 }

src/hooks/tapAfterEnvironmentToPatchWatching.ts

@@ -2,7 +2,7 @@ import chalk from 'chalk';
 import type webpack from 'webpack';
 
 import type { ForkTsCheckerWebpackPluginConfiguration } from '../ForkTsCheckerWebpackPluginConfiguration';
-import { RpcIpcMessagePortClosedError } from '../rpc/rpc-ipc/error/RpcIpcMessagePortClosedError';
+import { RpcExitError } from '../utils/rpc';
 
 import { getForkTsCheckerWebpackPluginHooks } from './pluginHooks';
 
@@ -15,7 +15,7 @@ function tapErrorToLogMessage(
   hooks.error.tap('ForkTsCheckerWebpackPlugin', (error) => {
     configuration.logger.issues.error(String(error));
 
-    if (error instanceof RpcIpcMessagePortClosedError) {
+    if (error instanceof RpcExitError) {
       if (error.signal === 'SIGINT') {
         configuration.logger.issues.error(
           chalk.red(