Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: fix #111 by generating sourcemaps even when a previous loader didn't pass them #113

Merged
merged 2 commits into from
Nov 1, 2021
Merged

fix: fix #111 by generating sourcemaps even when a previous loader didn't pass them #113

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
430cf4e
fix: fix #111 by generating sourcemaps even when a previous loader di…
Oct 29, 2021
b6c480a
revert test helper changes
Nov 1, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 28 additions & 10 deletions src/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
Author Tobias Koppers @sokra
*/

import { SourceNode, SourceMapConsumer } from "source-map";
import { SourceNode, SourceMapConsumer, SourceMapGenerator } from "source-map";

import schema from "./options.json";

Expand Down Expand Up @@ -74,18 +74,36 @@ export default function loader(content, sourceMap) {
codeAfterModule += `\n}.call(${thisArg}${args ? `, ${args}` : ""}));\n`;
}

if (this.sourceMap && sourceMap) {
const node = SourceNode.fromStringWithSourceMap(
content,
new SourceMapConsumer(sourceMap)
);
if (this.sourceMap) {
if (sourceMap) {
const node = SourceNode.fromStringWithSourceMap(
content,
new SourceMapConsumer(sourceMap)
);

node.prepend(`${importsCode}\n`);
node.add(codeAfterModule);

node.prepend(`${importsCode}\n`);
node.add(codeAfterModule);
const result = node.toStringWithSourceMap({ file: this.resourcePath });

const result = node.toStringWithSourceMap({ file: this.resourcePath });
callback(null, result.code, result.map.toJSON());

callback(null, result.code, result.map.toJSON());
return;
}
const generator = new SourceMapGenerator();

generator.setSourceContent(this.resourcePath, content);
generator.addMapping({
generated: { line: importsCode.split("\n").length + 1, column: 0 },
original: { line: 1, column: 0 },
source: this.resourcePath,
});

callback(
null,
`${importsCode}\n${content}\n${codeAfterModule}`,
generator.toString()
);

return;
}
Expand Down
32 changes: 0 additions & 32 deletions test/__snapshots__/loader.test.js.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,21 +1,5 @@
// Jest Snapshot v1, https://goo.gl/fbAQLP

exports[`loader should not work with source maps when the "devtool" options are disabled: errors 1`] = `Array []`;

exports[`loader should not work with source maps when the "devtool" options are disabled: module 1`] = `
"/*** IMPORTS FROM imports-loader ***/
import lib_1 from \\"lib_1\\";

var someCode = {
number: 123,
object: {
existingSubProperty: 123
}
};"
`;

exports[`loader should not work with source maps when the "devtool" options are disabled: warnings 1`] = `Array []`;

exports[`loader should throw an error on the empty string: errors 1`] = `
Array [
"ModuleBuildError: Module build failed (from \`replaced original path\`):
Expand Down Expand Up @@ -1113,22 +1097,6 @@ var someCode = {

exports[`loader should work with relative requests: warnings 1`] = `Array []`;

exports[`loader should work with source maps when the "devtool" option is enabled: errors 1`] = `Array []`;

exports[`loader should work with source maps when the "devtool" option is enabled: module 1`] = `
"/*** IMPORTS FROM imports-loader ***/
import lib_1 from \\"lib_1\\";

var someCode = {
number: 123,
object: {
existingSubProperty: 123
}
};"
`;

exports[`loader should work with source maps when the "devtool" option is enabled: warnings 1`] = `Array []`;
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do not remove tests

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I didn't remove the test, I rewrote it.


exports[`loader should work with the "additionalCode" option: errors 1`] = `Array []`;

exports[`loader should work with the "additionalCode" option: module 1`] = `
Expand Down
60 changes: 41 additions & 19 deletions test/loader.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,15 @@
import path from "path";

import { SourceMapConsumer } from "source-map";

import {
compile,
getCompiler,
getErrors,
getModuleSource,
getWarnings,
} from "./helpers";
import readAsset from "./helpers/readAsset";

describe("loader", () => {
it("should work with a string value", async () => {
Expand Down Expand Up @@ -307,7 +310,7 @@ describe("loader", () => {
expect(getWarnings(stats)).toMatchSnapshot("warnings");
});

it('should work with source maps when the "devtool" option is enabled', async () => {
it('should generate source maps when the "devtool" option is enabled', async () => {
const compiler = getCompiler(
"some-library.js",
{},
Expand All @@ -322,30 +325,39 @@ describe("loader", () => {
loader: path.resolve(__dirname, "../src"),
options: { imports: "lib_1" },
},
{
loader: "babel-loader",
},
],
},
],
},
}
);
const stats = await compile(compiler);

expect(getModuleSource("./some-library.js", stats)).toMatchSnapshot(
"module"
const bundle = readAsset(
"main.bundle.js",
stats.compilation.compiler,
stats
).split("\n");
const sourceMap = readAsset(
"main.bundle.js.map",
stats.compilation.compiler,
stats
);
expect(getErrors(stats)).toMatchSnapshot("errors");
expect(getWarnings(stats)).toMatchSnapshot("warnings");

const consumer = new SourceMapConsumer(sourceMap);
const result = consumer.generatedPositionFor({
line: 1,
column: 0,
source: "webpack://ImportsLoader/some-library.js",
});
expect(bundle[result.line - 1 /* 1-indexed */]).toEqual("var someCode = {");
});

it('should not work with source maps when the "devtool" options are disabled', async () => {
it('should update source maps from previous loaders when the "devtool" option is enabled', async () => {
const compiler = getCompiler(
"some-library.js",
{},
{
devtool: false,
devtool: "source-map",
module: {
rules: [
{
Expand All @@ -355,22 +367,32 @@ describe("loader", () => {
loader: path.resolve(__dirname, "../src"),
options: { imports: "lib_1" },
},
{
loader: "babel-loader",
},
{ loader: "babel-loader" },
],
},
],
},
}
);
const stats = await compile(compiler);

expect(getModuleSource("./some-library.js", stats)).toMatchSnapshot(
"module"
const bundle = readAsset(
"main.bundle.js",
stats.compilation.compiler,
stats
).split("\n");
const sourceMap = readAsset(
"main.bundle.js.map",
stats.compilation.compiler,
stats
);
expect(getErrors(stats)).toMatchSnapshot("errors");
expect(getWarnings(stats)).toMatchSnapshot("warnings");

const consumer = new SourceMapConsumer(sourceMap);
const result = consumer.generatedPositionFor({
line: 1,
column: 0,
source: "webpack://ImportsLoader/some-library.js",
});
expect(bundle[result.line - 1 /* 1-indexed */]).toEqual("var someCode = {");
});

it('should work with "default" imports without syntax', async () => {
Expand Down