Fix webpack deprecations (fix #1126) (#1135)

* update usage of webpack modules * tweak usage of errors * fix * add workaround * add workaround for webpack 5 * bump version and update changelog * update appveyor to use Visual Studio 2019 image Co-authored-by: John Reilly <[email protected]>
TypeStrong · Jul 15, 2020 · abae5fd · abae5fd
1 parent c2bc68c
commit abae5fd
Show file tree

Hide file tree

Showing 5 changed files with 72 additions and 36 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,9 @@
 # Changelog
 
+## v8.0.1
+
+* [Fix webpack deprecations](https://github.com/TypeStrong/ts-loader/pull/1135) - thanks @g-plane
+
 ## v8.0.0
 * [Support for symlinks in project references](https://github.com/TypeStrong/ts-loader/pull/1136) - thanks @sheetalkamat!
 * `ts-loader` now supports TypeScript 3.6 and greater **BREAKING CHANGE**

diff --git a/appveyor.yml b/appveyor.yml
@@ -1,4 +1,4 @@
-image: Visual Studio 2017
+image: Visual Studio 2019
 environment:
   FORCE_COLOR: 1
   nodejs_version: "14"

diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "ts-loader",
-  "version": "8.0.0",
+  "version": "8.0.1",
   "description": "TypeScript loader for webpack",
   "main": "index.js",
   "types": "dist",

diff --git a/src/after-compile.ts b/src/after-compile.ts
@@ -8,7 +8,6 @@ import {
   FilePathKey,
   TSFiles,
   TSInstance,
-  WebpackError,
   WebpackModule,
   TSFile,
 } from './interfaces';
@@ -42,8 +41,7 @@ export function makeAfterCompile(
       callback();
       return;
     }
-
-    removeTSLoaderErrors(compilation.errors);
+    removeCompilationTSLoaderErrors(compilation);
 
     provideCompilerOptionDiagnosticErrorsToWebpack(
       getCompilerOptionDiagnostics,
@@ -97,7 +95,7 @@ function provideCompilerOptionDiagnosticErrorsToWebpack(
 ) {
   if (getCompilerOptionDiagnostics) {
     const { languageService, loaderOptions, compiler, program } = instance;
-    const errorsToAdd = formatErrors(
+    const errors = formatErrors(
       program === undefined
         ? languageService!.getCompilerOptionsDiagnostics()
         : program.getOptionsDiagnostics(),
@@ -108,7 +106,7 @@ function provideCompilerOptionDiagnosticErrorsToWebpack(
       compilation.compiler.context
     );
 
-    compilation.errors.push(...errorsToAdd);
+    compilation.errors.push(...errors);
   }
 }
 
@@ -121,24 +119,23 @@ function determineModules(
   compilation: webpack.compilation.Compilation,
   { filePathKeyMapper }: TSInstance
 ) {
-  return compilation.modules.reduce<Map<FilePathKey, WebpackModule[]>>(
-    (modules, module) => {
-      if (module.resource) {
-        const modulePath = filePathKeyMapper(module.resource);
-        const existingModules = modules.get(modulePath);
-        if (existingModules !== undefined) {
-          if (existingModules.indexOf(module) === -1) {
-            existingModules.push(module);
-          }
-        } else {
-          modules.set(modulePath, [module]);
+  const modules: Map<FilePathKey, WebpackModule[]> = new Map();
+
+  compilation.modules.forEach(module => {
+    if (module.resource) {
+      const modulePath = filePathKeyMapper(module.resource);
+      const existingModules = modules.get(modulePath);
+      if (existingModules !== undefined) {
+        if (!existingModules.includes(module)) {
+          existingModules.push(module);
         }
+      } else {
+        modules.set(modulePath, [module]);
       }
+    }
+  });
 
-      return modules;
-    },
-    new Map()
-  );
+  return modules;
 }
 
 function determineFilesToCheckForErrors(
@@ -238,8 +235,7 @@ function provideErrorsToWebpack(
     const associatedModules = modules.get(instance.filePathKeyMapper(fileName));
     if (associatedModules !== undefined) {
       associatedModules.forEach(module => {
-        // remove any existing errors
-        removeTSLoaderErrors(module.errors);
+        removeModuleTSLoaderError(module);
 
         // append errors
         const formattedErrors = formatErrors(
@@ -251,7 +247,14 @@ function provideErrorsToWebpack(
           compilation.compiler.context
         );
 
-        module.errors.push(...formattedErrors);
+        formattedErrors.forEach(error => {
+          if (module.addError) {
+            module.addError(error);
+          } else {
+            module.errors.push(error);
+          }
+        });
+
         compilation.errors.push(...formattedErrors);
       });
     } else {
@@ -296,8 +299,7 @@ function provideSolutionErrorsToWebpack(
     const associatedModules = modules.get(filePath);
     if (associatedModules !== undefined) {
       associatedModules.forEach(module => {
-        // remove any existing errors
-        removeTSLoaderErrors(module.errors);
+        removeModuleTSLoaderError(module);
 
         // append errors
         const formattedErrors = formatErrors(
@@ -309,7 +311,14 @@ function provideSolutionErrorsToWebpack(
           compilation.compiler.context
         );
 
-        module.errors.push(...formattedErrors);
+        formattedErrors.forEach(error => {
+          if (module.addError) {
+            module.addError(error);
+          } else {
+            module.errors.push(error);
+          }
+        });
+
         compilation.errors.push(...formattedErrors);
       });
     } else {
@@ -435,13 +444,31 @@ function provideAssetsFromSolutionBuilderHost(
  * compilation-to-compilation, and since not every module always runs through
  * the loader, we need to detect and remove any pre-existing errors.
  */
-function removeTSLoaderErrors(errors: WebpackError[]) {
-  let index = -1;
-  let length = errors.length;
-  while (++index < length) {
-    if (errors[index].loaderSource === 'ts-loader') {
-      errors.splice(index--, 1);
-      length--;
-    }
+function removeCompilationTSLoaderErrors(
+  compilation: webpack.compilation.Compilation
+) {
+  compilation.errors = compilation.errors.filter(
+    error => error.loaderSource !== 'ts-loader'
+  );
+}
+
+function removeModuleTSLoaderError(module: WebpackModule) {
+  /**
+   * Since webpack 5, the `errors` property is deprecated,
+   * so we can check if some methods for reporting errors exist.
+   */
+  if (!!module.addError) {
+    const warnings = module.getWarnings();
+    const errors = module.getErrors();
+    module.clearWarningsAndErrors();
+
+    Array.from(warnings || []).forEach(warning => module.addWarning(warning));
+    Array.from(errors || [])
+      .filter((error: any) => error.loaderSource !== 'ts-loader')
+      .forEach(error => module.addError(error));
+  } else {
+    module.errors = module.errors.filter(
+      error => error.loaderSource !== 'ts-loader'
+    );
   }
 }
diff --git a/src/interfaces.ts b/src/interfaces.ts
@@ -25,6 +25,11 @@ export interface WebpackError {
 export interface WebpackModule {
   resource: string;
   errors: WebpackError[];
+  addWarning(warning: Error): void;
+  addError(error: WebpackError | Error): void;
+  getWarnings(): Iterable<Error> | undefined;
+  getErrors(): Iterable<WebpackError | Error> | undefined;
+  clearWarningsAndErrors(): void;
   buildMeta: {
     tsLoaderFileVersion: number;
     tsLoaderDefinitionFileVersions: string[];