[FEATURE] Generate source maps for bundles #695

RandomByte · 2022-01-26T16:29:01Z

Supersedes #282

JIRA: CPOUI5FOUNDATION-434

lib/processors/bundlers/moduleBundler.js

coveralls · 2022-02-08T13:47:16Z

Coverage decreased (-0.1%) to 94.672% when pulling a6e2f06 on feature-bundle-source-maps into 3b51c1b on next.

lib/lbt/bundle/Builder.js

BREAKING CHANGE: moduleBundler now returns an object containing a bundle- and an optional source map resource.

The bundle should still use predefine

…urce maps

Update scenarios in generateBundle.js

* Add option 'omitSourceMapResources' to minify task to control whether source map resource is tagged and no sourceMappingURL is added to the end of the resource content

…to parse them

matz3 · 2022-02-24T15:52:07Z

lib/processors/bundlers/moduleBundler.js

@@ -90,6 +90,8 @@ const log = require("@ui5/logger").getLogger("builder:processors:bundlers:module
 * @public
 * @typedef {object} ModuleBundleOptions
 * @property {boolean} [optimize=true] Whether the module bundle gets minified
+ * @property {boolean} [sourceMap] Whether to generate a source map file for the bundle.
+ *   Defaults to true if <code>optimize</code> is set to true


This is not correct anymore. A sourcemap is always created unless sourceMap: false is set.

In addition: Is this something to be added to the project configuration schema?

The default will be updated via #709

I've added a bullet-point for adding 'sourceMap' to the specVersion 3.0 bundleOptions to SAP/ui5-tooling#506

As discussed, adding this to the bundleOptions makes sense

matz3 · 2022-02-24T15:52:21Z

lib/processors/bundlers/moduleBundler.js

 * @param {ModuleBundleDefinition} parameters.options.bundleDefinition Module bundle definition
 * @param {ModuleBundleOptions} [parameters.options.bundleOptions] Module bundle options
- * @returns {Promise<module:@ui5/fs.Resource[]>} Promise resolving with module bundle resources
+ * @returns {Promise<module:@ui5/builder.processors.MinifierResult[]>} Promise resolving with module bundle resources


ModuleBundlerResult

Will be solved via #709

matz3 · 2022-02-24T15:54:48Z

lib/processors/minifier.js

@@ -34,10 +34,12 @@ const debugFileRegex = /((?:\.view|\.fragment|\.controller|\.designtime|\.suppor
 * @alias module:@ui5/builder.processors.minifier
 * @param {object} parameters Parameters
 * @param {module:@ui5/fs.Resource[]} parameters.resources List of resources to be processed
+ * @param {boolean} [parameters.addSourceMappingUrl=true]


Usually in our processors we have an options object that contains such parameters.

Yes, I forgot about that. This should be changed then 👍

Fixed via #709

matz3 · 2022-02-24T16:02:23Z

lib/tasks/bundlers/generateComponentPreload.js

-		.then((processedResources) => {
-			return Promise.all(processedResources.map((resource) => {
+		.then((results) => {
+			const bundles = Array.prototype.concat.apply([], results);


I wonder why this is needed in here

I wonder the same 🤷

matz3 · 2022-02-24T16:05:22Z

lib/tasks/bundlers/generateStandaloneAppBundle.js

+		// For "unoptimized" bundles, the non-debug files have already been filtered out above.
+		// Now we need to create a mapping from the debug-variant resource path to the respective module name,
+		// which is basically the non-debug resource path, minus the "/resources/"" prefix.
+		// This mapping overwrites internal logic of the LocatorResourcePool which would otherwise determine
+		// the module name from the resource path, which would contain "-dbg" in this case. That would be
+		// incorrect since debug-variants should still keep the original module name.
+		for (let i = unoptimizedResources.length - 1; i >= 0; i--) {
+			const resourcePath = unoptimizedResources[i].getPath();
+			if (taskUtil.getTag(resourcePath, taskUtil.STANDARD_TAGS.IsDebugVariant)) {
+				const nonDbgPath = ModuleName.getNonDebugName(resourcePath);
+				if (!nonDbgPath) {
+					throw new Error(`Failed to resolve non-debug name for ${resourcePath}`);
+				}
+				unoptimizedModuleNameMapping[resourcePath] = nonDbgPath.slice("/resources/".length);
+			}
+		}


We have this code in three places now, so it would be better to refactor it

As discussed, maybe we could have all bundling tasks call the generateBundle-task or create a "helper" module in lib/tasks/bundlers/ for this purpose 👍

Issue was introduced with #695.

RandomByte force-pushed the feature-bundle-source-maps branch from 863a79d to 7303498 Compare January 26, 2022 16:30

matz3 reviewed Jan 28, 2022

View reviewed changes

lib/processors/bundlers/moduleBundler.js Show resolved Hide resolved

RandomByte force-pushed the feature-bundle-source-maps branch from 4930295 to 7b51d11 Compare February 14, 2022 10:42

matz3 reviewed Feb 22, 2022

View reviewed changes

lib/lbt/bundle/Builder.js Outdated Show resolved Hide resolved

matz3 reviewed Feb 22, 2022

View reviewed changes

lib/lbt/bundle/Builder.js Outdated Show resolved Hide resolved

RandomByte marked this pull request as ready for review February 22, 2022 15:01

matz3 force-pushed the feature-bundle-source-maps branch from e74779f to 9bb1025 Compare February 22, 2022 15:10

RandomByte and others added 22 commits February 23, 2022 17:52

[FEATURE] Generate source maps for bundles

36f792e

BREAKING CHANGE: moduleBundler now returns an object containing a bundle- and an optional source map resource.

[INTERNAL] WIP: Adapt tests

bc99d7b

Fix rewriteDefine call

d448dc8

Add basic rewriteDefine tests, improve transform function

2d0e31c

Fix generateComponentPreload / generateLibraryPreload tests

135085f

Revert changes to expected library-preload.support.js

b276aeb

The bundle should still use predefine

Minor test corrections

0a7c507

moduleBundler: Update 'returns' JSDoc

4940445

Update more tests

1daeb52

Fix ESLint issues

8c58e9b

Also create source maps when optimize=false

c29e1cc

Update tests, skip new tests

1c05cae

Enable and fix new tests

c0345f1

WIP

8ea6a7c

Don't add sourceMappingURL to JS files

f3186fb

Pass sourceMappingUrl via tag

c2b57e7

moduleBundler: Pass original file name to search for corresponding so…

c5fbc96

…urce maps

Generate more transitive source maps

e1faa48

Add more transient source maps, adapt generateLibraryPreload

80af48f

Do not write transient map for afterPreloads-brackets

499d460

Update scenarios in generateBundle.js

Fix sourceRoot/path of transient source maps

530180f

Minor fix, update tests and expected build results

d561591

RandomByte added 8 commits February 23, 2022 17:52

Update comment for moduleNameMapping

52e069e

Rename transient bundle source maps form '?inline' to '?bundle-code'

aceb35c

Update implementation and tests

8cb09ed

* Add option 'omitSourceMapResources' to minify task to control whether source map resource is tagged and no sourceMappingURL is added to the end of the resource content

Align dir naming for 'sap.ui.core-buildtime' fixture

ddd0a42

Update expected test results: No sourceMappingURL in minified resources

1fafcdf

Fix eslint errors

018a4d7

Add additional tests for getSourceMapForModule

c3ca1be

Use constant for //# sourceMappingURL to prevent Node.js from trying …

c13ce14

…to parse them

RandomByte force-pushed the feature-bundle-source-maps branch from ae415dc to c13ce14 Compare February 23, 2022 16:53

RandomByte added 2 commits February 23, 2022 18:02

Fix assertion message

0157595

Enhance getSourceMapForModule tests

a6e2f06

matz3 approved these changes Feb 23, 2022

View reviewed changes

RandomByte merged commit 8a20c42 into next Feb 23, 2022

RandomByte deleted the feature-bundle-source-maps branch February 23, 2022 17:35

matz3 reviewed Feb 24, 2022

View reviewed changes

This was referenced Feb 25, 2022

[INTERNAL] SourceMaps follow-up #709

Merged

[ROADMAP] Specification Version 3.0 // UI5 Tooling 3.0 SAP/ui5-tooling#506

Closed

This was referenced Mar 8, 2022

fix locator resource pool #717

Closed

next #718

Closed

flovogt added a commit that referenced this pull request Mar 9, 2022

[FIX] LocatorResourcePool: Wait for resources in prepare step (#719)

1b7f93f

Issue was introduced with #695.

matz3 mentioned this pull request Mar 10, 2022

[INTERNAL] replaceVersion: Also process css files #720

Merged

flovogt mentioned this pull request Mar 30, 2022

css variables api next #727

Closed

matz3 mentioned this pull request Apr 1, 2022

[INTERNAL] Add preliminary guide for v3 migration SAP/ui5-tooling#608

Merged

flovogt mentioned this pull request Apr 6, 2022

[FEATURE] generateThemeDesignerResources task: Create css_variables.less #730

Merged

RandomByte mentioned this pull request Apr 15, 2022

[FEATURE] Sourcemap support in the ui5-builder preload generation #282

Closed

3 tasks

This was referenced May 4, 2022

feat/next/jsdocDemoLink #742

Closed

execution time measurement #744

Closed

matz3 mentioned this pull request Jul 29, 2022

[FEATURE] builder: Improve support for ES6+ syntax #774

Merged

RandomByte mentioned this pull request Aug 5, 2022

[PoC] Refactor bundle process to exclude debug-files and enable source maps #657

Closed

flovogt mentioned this pull request Mar 20, 2023

ui5 cli does not create source maps SAP/ui5-tooling#472

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[FEATURE] Generate source maps for bundles #695

[FEATURE] Generate source maps for bundles #695

RandomByte commented Jan 26, 2022 •

edited

coveralls commented Feb 8, 2022 •

edited

matz3 Feb 24, 2022

matz3 Feb 25, 2022

matz3 Feb 25, 2022

RandomByte Feb 25, 2022

matz3 Feb 24, 2022

matz3 Feb 25, 2022

matz3 Feb 24, 2022

RandomByte Feb 25, 2022

matz3 Feb 25, 2022

matz3 Feb 24, 2022

RandomByte Feb 25, 2022

matz3 Feb 24, 2022

RandomByte Feb 25, 2022

[FEATURE] Generate source maps for bundles #695

[FEATURE] Generate source maps for bundles #695

Conversation

RandomByte commented Jan 26, 2022 • edited

coveralls commented Feb 8, 2022 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

RandomByte commented Jan 26, 2022 •

edited

coveralls commented Feb 8, 2022 •

edited