Merge pull request #226 from vankop/add-hash-support

add fragment support

Author: sokra

lib/ExportsFieldPlugin.js

@@ -51,9 +51,12 @@ module.exports = class ExportsFieldPlugin {
 				)
 					return callback();
 
-				const remainingRequest = request.query
-					? (request.request === "." ? "./" : request.request) + request.query
-					: request.request;
+				const remainingRequest =
+					request.query || request.fragment
+						? (request.request === "." ? "./" : request.request) +
+						  request.query +
+						  request.fragment
+						: request.request;
 				/** @type {ExportsField|null} */
 				const exportsField = DescriptionFileUtils.getField(
 					request.descriptionFileData,
@@ -106,20 +109,12 @@ module.exports = class ExportsFieldPlugin {
 				forEachBail(
 					paths,
 					(p, callback) => {
-						let query;
-						let relativePath;
-
-						if (request.query) {
-							const queryIndex = p.indexOf("?");
-							if (queryIndex > -1) {
-								query = p.slice(queryIndex);
-								relativePath = p.slice(0, queryIndex);
-							} else {
-								relativePath = p;
-							}
-						} else {
-							relativePath = p;
-						}
+						const match = /^([^?#]*)(\?[^#]*)?(#.*)?$/.exec(p);
+
+						if (!match) return callback();
+
+						const [, relativePath, query, fragment] = match;
+
 						const error = checkExportsFieldTarget(relativePath);
 
 						if (error) {
@@ -134,7 +129,8 @@ module.exports = class ExportsFieldPlugin {
 								relativePath
 							),
 							relativePath,
-							query
+							query: query || "",
+							fragment: fragment || ""
 						};
 
 						resolver.doResolve(

lib/LogInfoPlugin.js

@@ -32,6 +32,8 @@ module.exports = class LogInfoPlugin {
 				if (request.directory) log(prefix + "Request is a directory request.");
 				if (request.query)
 					log(prefix + "Resolving request query: " + request.query);
+				if (request.fragment)
+					log(prefix + "Resolving request fragment: " + request.fragment);
 				if (request.descriptionFilePath)
 					log(
 						prefix + "Has description data from " + request.descriptionFilePath

lib/ParsePlugin.js

@@ -27,11 +27,14 @@ module.exports = class ParsePlugin {
 		resolver
 			.getHook(this.source)
 			.tapAsync("ParsePlugin", (request, resolveContext, callback) => {
-				const parsed = resolver.parse(request.request);
+				const parsed = resolver.parse(/** @type {string} */ (request.request));
 				const obj = { ...request, ...parsed };
 				if (request.query && !parsed.query) {
 					obj.query = request.query;
 				}
+				if (request.fragment && !parsed.fragment) {
+					obj.fragment = request.fragment;
+				}
 				if (parsed && resolveContext.log) {
 					if (parsed.module) resolveContext.log("Parsed request is a module");
 					if (parsed.directory)

lib/Resolver.js

@@ -38,11 +38,22 @@ const {
  * @property {function(string, function(PossibleFileSystemError & Error | null | undefined, FileSystemStats=): void): void} stat
  */
 
+/**
+ * @typedef {Object} ParsedIdentifier
+ * @property {string} request
+ * @property {string} query
+ * @property {string} fragment
+ * @property {boolean} directory
+ * @property {boolean} module
+ * @property {boolean} file
+ */
+
 /**
  * @typedef {Object} ResolveRequest
  * @property {string | false} path
  * @property {string=} request
  * @property {string=} query
+ * @property {string=} fragment
  * @property {boolean=} directory
  * @property {boolean=} module
  * @property {string=} descriptionFilePath
@@ -93,6 +104,7 @@ class Resolver {
 			") " +
 			(request.request || "") +
 			(request.query || "") +
+			(request.fragment || "") +
 			(request.directory ? " directory" : "") +
 			(request.module ? " module" : "")
 		);
@@ -215,7 +227,7 @@ class Resolver {
 	 * @param {string} path context path
 	 * @param {string} request request string
 	 * @param {ResolveContext} resolveContext resolve context
-	 * @param {function(Error | null, string=, ResolveRequest=): void} callback callback function
+	 * @param {function(Error | null, (string|false)=, ResolveRequest=): void} callback callback function
 	 * @returns {void}
 	 */
 	resolve(context, path, request, resolveContext, callback) {
@@ -230,7 +242,9 @@ class Resolver {
 		const finishResolved = result => {
 			return callback(
 				null,
-				result.path === false ? false : result.path + (result.query || ""),
+				result.path === false
+					? false
+					: `${result.path}${result.query || ""}${result.fragment || ""}`,
 				result
 			);
 		};
@@ -363,23 +377,28 @@ class Resolver {
 		}
 	}
 
+	/**
+	 * @param {string} identifier identifier
+	 * @returns {ParsedIdentifier} parsed identifier
+	 */
 	parse(identifier) {
 		const part = {
 			request: "",
 			query: "",
+			fragment: "",
 			module: false,
 			directory: false,
 			file: false
 		};
-		const idxQuery = identifier.indexOf("?");
-		if (idxQuery === 0) {
-			part.query = identifier;
-		} else if (idxQuery > 0) {
-			part.request = identifier.slice(0, idxQuery);
-			part.query = identifier.slice(idxQuery);
-		} else {
-			part.request = identifier;
-		}
+
+		const match = /^([^?#]*)(\?[^#]*)?(#.*)?$/.exec(identifier);
+
+		if (!match) return part;
+
+		part.request = match[1] || "";
+		part.query = match[2] || "";
+		part.fragment = match[3] || "";
+
 		if (part.request) {
 			part.module = this.isModule(part.request);
 			part.directory = this.isDirectory(part.request);

lib/UnsafeCachePlugin.js

@@ -15,6 +15,7 @@ function getCacheId(request, withContext) {
 		context: withContext ? request.context : "",
 		path: request.path,
 		query: request.query,
+		fragment: request.fragment,
 		request: request.request
 	});
 }

test/exportsField.js

@@ -1429,6 +1429,35 @@ describe("ExportsFieldPlugin", () => {
 		});
 	});
 
+	it("resolver should respect fragment parameters #1", done => {
+		resolver.resolve(
+			{},
+			fixture2,
+			"exports-field/dist/browser.js#foo",
+			{},
+			(err, result) => {
+				if (err) return done(err);
+				if (!result) throw new Error("No result");
+				result.should.equal(
+					path.resolve(
+						fixture2,
+						"node_modules/exports-field/lib/browser.js#foo"
+					)
+				);
+				done();
+			}
+		);
+	});
+
+	it("resolver should respect fragment parameters #2. Direct matching", done => {
+		resolver.resolve({}, fixture2, "exports-field#foo", {}, (err, result) => {
+			if (!err) throw new Error(`expect error, got ${result}`);
+			err.should.be.instanceof(Error);
+			err.message.should.match(/Package path \.\/#foo is not exported/);
+			done();
+		});
+	});
+
 	it("relative path should work, if relative path as request is used", done => {
 		resolver.resolve(
 			{},

test/resolve.js

@@ -131,12 +131,49 @@ describe("resolve", function() {
 		"./main1.js?query",
 		path.join(fixtures, "main1.js") + "?query"
 	);
+	testResolve(
+		"file with fragment",
+		fixtures,
+		"./main1.js#fragment",
+		path.join(fixtures, "main1.js") + "#fragment"
+	);
+	testResolve(
+		"file with fragment and query",
+		fixtures,
+		"./main1.js#fragment?query",
+		path.join(fixtures, "main1.js") + "#fragment?query"
+	);
+	testResolve(
+		"file with query and fragment",
+		fixtures,
+		"./main1.js?#fragment",
+		path.join(fixtures, "main1.js") + "?#fragment"
+	);
+
 	testResolve(
 		"file in module with query",
 		fixtures,
 		"m1/a?query",
 		path.join(fixtures, "node_modules", "m1", "a.js") + "?query"
 	);
+	testResolve(
+		"file in module with fragment",
+		fixtures,
+		"m1/a#fragment",
+		path.join(fixtures, "node_modules", "m1", "a.js") + "#fragment"
+	);
+	testResolve(
+		"file in module with fragment and query",
+		fixtures,
+		"m1/a#fragment?query",
+		path.join(fixtures, "node_modules", "m1", "a.js") + "#fragment?query"
+	);
+	testResolve(
+		"file in module with query and fragment",
+		fixtures,
+		"m1/a?#fragment",
+		path.join(fixtures, "node_modules", "m1", "a.js") + "?#fragment"
+	);
 
 	testResolveContext("context for fixtures", fixtures, "./", fixtures);
 	testResolveContext(

types.d.ts

@@ -68,6 +68,14 @@ declare class LogInfoPlugin {
 	source: any;
 	apply(resolver: Resolver): void;
 }
+declare interface ParsedIdentifier {
+	request: string;
+	query: string;
+	fragment: string;
+	directory: boolean;
+	module: boolean;
+	file: boolean;
+}
 declare interface PnpApiImpl {
 	resolveToUnqualified: (arg0: string, arg1: string, arg2?: any) => string;
 }
@@ -140,6 +148,7 @@ declare interface ResolveRequest {
 	path: string | false;
 	request?: undefined | string;
 	query?: undefined | string;
+	fragment?: undefined | string;
 	directory?: undefined | boolean;
 	module?: undefined | boolean;
 	descriptionFilePath?: undefined | string;
@@ -199,7 +208,7 @@ declare abstract class Resolver {
 		resolveContext: ResolveContext,
 		callback: (
 			arg0: null | Error,
-			arg1: undefined | string,
+			arg1: undefined | string | false,
 			arg2: undefined | ResolveRequest
 		) => void
 	): void;
@@ -210,15 +219,7 @@ declare abstract class Resolver {
 		resolveContext?: any,
 		callback?: any
 	): any;
-	parse(
-		identifier?: any
-	): {
-		request: string;
-		query: string;
-		module: boolean;
-		directory: boolean;
-		file: boolean;
-	};
+	parse(identifier: string): ParsedIdentifier;
 	isModule(path?: any): boolean;
 	isDirectory(path: string): boolean;
 	join(path?: any, request?: any): string;