fix: Cannot read properties of undefined (reading 'map')

This fixes an exception that was happening when a source map with
sections was being processed.
It mainly occurred when a UI5 bundle such as a `Component-preload.js` is
part of the project sources and not excluded from linting.

UI5 bundles are now excluded from linting and AMD transpilation.
In addition, source maps with sections are not processed.

Fixes: #583

Author: matz3

src/linter/ui5Types/SourceFileReporter.ts

@@ -37,9 +37,13 @@ export default class SourceFileReporter {
 		this.#sourceFile = sourceFile;
 		if (sourceMap) {
 			const parsedSourceMap = JSON.parse(sourceMap) as EncodedSourceMap;
-			if (parsedSourceMap.mappings !== "") {
+			if (parsedSourceMap.mappings !== "" && !("sections" in parsedSourceMap)) {
 				// Only create a trace map if there are mappings.
 				// Otherwise, it will be useless and causes errors in some cases (Failed to map back to source).
+
+				// Also, sections are not supported as they only appear in bundles, which in general are not supported
+				// as source files should be linted individually.
+
 				this.#traceMap = new TraceMap(parsedSourceMap);
 			}
 		}

src/linter/ui5Types/TypeLinter.ts

@@ -133,31 +133,32 @@ export default class TypeLinter {
 		const messageDetails = this.#context.getIncludeMessageDetails();
 		const typeCheckDone = taskStart("Linting all transpiled resources");
 		for (const sourceFile of program.getSourceFiles()) {
-			if (!sourceFile.isDeclarationFile && pathsToLint.includes(sourceFile.fileName)) {
-				const sourceMap = this.#sourceMaps.get(sourceFile.fileName);
-				if (!sourceMap) {
-					log.verbose(`Failed to get source map for ${sourceFile.fileName}`);
-				}
-				let manifestContent;
-				if (sourceFile.fileName.endsWith("/Component.js") || sourceFile.fileName.endsWith("/Component.ts")) {
-					const res = await this.#workspace.byPath(path.dirname(sourceFile.fileName) + "/manifest.json");
-					if (res) {
-						manifestContent = await res.getString();
-					}
-				}
-				if (silly) {
-					log.silly(`Linting ${sourceFile.fileName}`);
+			if (sourceFile.isDeclarationFile || !pathsToLint.includes(sourceFile.fileName)) {
+				continue;
+			}
+			if (sourceFile.getFullText().startsWith("//@ui5-bundle ")) {
+				log.verbose(`Skipping linting of UI5 bundle '${sourceFile.fileName}'`);
+				continue;
+			}
+			let manifestContent;
+			if (sourceFile.fileName.endsWith("/Component.js") || sourceFile.fileName.endsWith("/Component.ts")) {
+				const res = await this.#workspace.byPath(path.dirname(sourceFile.fileName) + "/manifest.json");
+				if (res) {
+					manifestContent = await res.getString();
 				}
-				const linterDone = taskStart("Type-check resource", sourceFile.fileName, true);
-				const linter = new SourceFileLinter(
-					this,
-					sourceFile,
-					checker, reportCoverage, messageDetails,
-					apiExtract, this.#filePathsWorkspace, this.#workspace, ambientModuleCache, manifestContent
-				);
-				await linter.lint();
-				linterDone();
 			}
+			if (silly) {
+				log.silly(`Linting ${sourceFile.fileName}`);
+			}
+			const linterDone = taskStart("Type-check resource", sourceFile.fileName, true);
+			const linter = new SourceFileLinter(
+				this,
+				sourceFile,
+				checker, reportCoverage, messageDetails,
+				apiExtract, this.#filePathsWorkspace, this.#workspace, ambientModuleCache, manifestContent
+			);
+			await linter.lint();
+			linterDone();
 		}
 
 		// Will eventually produce new JS files for XML views and fragments
@@ -186,17 +187,18 @@ export default class TypeLinter {
 			checker = program.getTypeChecker();
 			ambientModuleCache = new AmbientModuleCache(checker.getAmbientModules());
 			for (const sourceFile of program.getSourceFiles()) {
-				if (!sourceFile.isDeclarationFile && /\.inline-[0-9]+\.(view|fragment)\.js/.exec(sourceFile.fileName)) {
-					const linterDone = taskStart("Type-check resource", sourceFile.fileName, true);
-					const linter = new SourceFileLinter(
-						this,
-						sourceFile,
-						checker, reportCoverage, messageDetails,
-						apiExtract, this.#filePathsWorkspace, this.#workspace, ambientModuleCache
-					);
-					await linter.lint();
-					linterDone();
+				if (sourceFile.isDeclarationFile || !/\.inline-[0-9]+\.(view|fragment)\.js/.exec(sourceFile.fileName)) {
+					continue;
 				}
+				const linterDone = taskStart("Type-check resource", sourceFile.fileName, true);
+				const linter = new SourceFileLinter(
+					this,
+					sourceFile,
+					checker, reportCoverage, messageDetails,
+					apiExtract, this.#filePathsWorkspace, this.#workspace, ambientModuleCache
+				);
+				await linter.lint();
+				linterDone();
 			}
 		}
 		typeCheckDone();

src/linter/ui5Types/amdTranspiler/transpiler.ts

@@ -53,6 +53,12 @@ function createProgram(inputFileNames: string[], host: ts.CompilerHost): ts.Prog
 export default function transpileAmdToEsm(
 	resourcePath: string, content: string, context: LinterContext, strict?: boolean
 ): TranspileResult {
+	// Do not transpile UI5 bundles
+	if (content.startsWith("//@ui5-bundle ")) {
+		log.verbose(`Skipping transformation of UI5 bundle ${resourcePath}.`);
+		return {source: content, map: ""};
+	}
+
 	// This is heavily inspired by the TypesScript "transpileModule" API
 	const fileName = path.basename(resourcePath);
 	const taskDone = taskStart("Transpiling AMD to ESM", fileName, true);

test/e2e/snapshots/compare-snapshots.ts.md

@@ -13,6 +13,28 @@ Generated by [AVA](https://avajs.dev).
 > Snapshot 2
 
     [
+      {
+        errorCount: 2,
+        fatalErrorCount: 0,
+        filePath: 'webapp/bundles/thirdparty-bundle.js',
+        messages: [
+          {
+            column: 20,
+            line: 1,
+            message: 'Access of global variable \'sap\' (sap.m.Button)',
+            ruleId: 'no-globals',
+            severity: 2,
+          },
+          {
+            column: 19,
+            line: 2,
+            message: 'Access of global variable \'sap\' (sap.m.Input)',
+            ruleId: 'no-globals',
+            severity: 2,
+          },
+        ],
+        warningCount: 0,
+      },
       {
         errorCount: 3,
         fatalErrorCount: 0,

test/e2e/snapshots/compare-snapshots.ts.snap

@@ -0,0 +1,18 @@
+//@ui5-bundle com/ui5/troublesome/app/bundles/ui5-bundle-without-sourcemap.js
+jQuery.sap.registerPreloadedModules({
+	"version": "2.0",
+	"modules": {
+		"com/ui5/troublesome/app/Component.js": function () {
+			sap.ui.define(["sap/ui/Device"], function () {
+				return sap.ui.core.UIComponent.extend("com.ui5.troublesome.app.Component", {
+					metadata: {
+						manifest: "json"
+					}
+				});
+			});
+		}
+	}
+});
+
+// This file should be excluded from linting as it is a UI5 bundle file.
+// It should also not be transformed  by the amdTranspiler.