feat: lstat and lstatSync

Author: alexander-akait

lib/CachedInputFileSystem.js

@@ -371,6 +371,17 @@ module.exports = class CachedInputFileSystem {
 	constructor(fileSystem, duration) {
 		this.fileSystem = fileSystem;
 
+		this._lstatBackend = createBackend(
+			duration,
+			this.fileSystem.lstat,
+			this.fileSystem.lstatSync,
+			this.fileSystem
+		);
+		const lstat = this._lstatBackend.provide;
+		this.lstat = /** @type {FileSystem["lstat"]} */ (lstat);
+		const lstatSync = this._lstatBackend.provideSync;
+		this.lstatSync = /** @type {SyncFileSystem["lstatSync"]} */ (lstatSync);
+
 		this._statBackend = createBackend(
 			duration,
 			this.fileSystem.stat,

lib/Resolver.js

@@ -51,6 +51,7 @@ const {
  * @property {(function(string, FileSystemCallback<(Buffer | string)[] | FileSystemDirent[]>): void) & function(string, object, FileSystemCallback<(Buffer | string)[] | FileSystemDirent[]>): void} readdir
  * @property {((function(string, FileSystemCallback<object>): void) & function(string, object, FileSystemCallback<object>): void)=} readJson
  * @property {(function(string, FileSystemCallback<Buffer | string>): void) & function(string, object, FileSystemCallback<Buffer | string>): void} readlink
+ * @property {(function(string, FileSystemCallback<FileSystemStats>): void) & function(string, object, FileSystemCallback<Buffer | string>): void} lstat
  * @property {(function(string, FileSystemCallback<FileSystemStats>): void) & function(string, object, FileSystemCallback<Buffer | string>): void} stat
  */
 
@@ -60,6 +61,7 @@ const {
  * @property {function(string, object=): (Buffer | string)[] | FileSystemDirent[]} readdirSync
  * @property {(function(string, object=): object)=} readJsonSync
  * @property {function(string, object=): Buffer | string} readlinkSync
+ * @property {function(string, object=): FileSystemStats} lstatSync
  * @property {function(string, object=): FileSystemStats} statSync
  */
 

lib/SyncAsyncFileSystemDecorator.js

@@ -14,6 +14,18 @@
  */
 function SyncAsyncFileSystemDecorator(fs) {
 	this.fs = fs;
+
+	this.lstat = (arg, callback) => {
+		let result;
+		try {
+			result = fs.lstatSync(arg);
+		} catch (e) {
+			return callback(e);
+		}
+		callback(null, result);
+	};
+	this.lstatSync = arg => fs.lstatSync(arg);
+
 	this.stat = (arg, callback) => {
 		let result;
 		try {

test/CachedInputFileSystem.js

@@ -2,7 +2,7 @@ var should = require("should");
 
 var { CachedInputFileSystem } = require("../");
 
-describe("CachedInputFileSystem OperationMergerBackend", function () {
+describe("CachedInputFileSystem OperationMergerBackend ('stat' and 'statSync')", function () {
 	this.timeout(3000);
 	var fs;
 
@@ -83,6 +83,87 @@ describe("CachedInputFileSystem OperationMergerBackend", function () {
 	});
 });
 
+describe("CachedInputFileSystem OperationMergerBackend ('lstat' and 'lstatSync')", function () {
+	this.timeout(3000);
+	var fs;
+
+	beforeEach(function () {
+		fs = new CachedInputFileSystem(
+			{
+				lstat: function (path, options, callback) {
+					if (!callback) {
+						callback = options;
+						options = undefined;
+					}
+					setTimeout(
+						() =>
+							callback(null, {
+								path,
+								options
+							}),
+						100
+					);
+				},
+				lstatSync: function (path, options) {
+					return {
+						path,
+						options
+					};
+				}
+			},
+			0
+		);
+	});
+	afterEach(function () {
+		fs.purge();
+	});
+
+	it("should join accesses", function (done) {
+		fs.lstat("a", function (err, result) {
+			should.exist(result);
+			result.a = true;
+		});
+		fs.lstat("a", function (err, result) {
+			should.exist(result);
+			should.exist(result.a);
+			done();
+		});
+	});
+
+	it("should not join accesses with options", function (done) {
+		fs.lstat("a", function (err, result) {
+			should.exist(result);
+			result.a = true;
+			result.path.should.be.eql("a");
+			should.not.exist(result.options);
+		});
+		fs.lstat("a", { options: true }, function (err, result) {
+			should.exist(result);
+			should.not.exist(result.a);
+			result.path.should.be.eql("a");
+			result.options.should.eql({ options: true });
+			done();
+		});
+	});
+
+	it("should not cache accesses", function (done) {
+		fs.lstat("a", function (err, result) {
+			result.a = true;
+			fs.lstat("a", function (err, result) {
+				should.not.exist(result.a);
+				done();
+			});
+		});
+	});
+
+	it("should not cache sync accesses", function () {
+		const result = fs.lstatSync("a");
+		result.a = true;
+		const result2 = fs.lstatSync("a");
+		should.not.exist(result2.a);
+	});
+});
+
 describe("CachedInputFileSystem CacheBackend", function () {
 	this.timeout(3000);
 	var fs;

types.d.ts

@@ -18,6 +18,11 @@ declare interface BaseResolveRequest {
 declare class CachedInputFileSystem {
 	constructor(fileSystem?: any, duration?: any);
 	fileSystem: any;
+	lstat: {
+		(arg0: string, arg1: FileSystemCallback<FileSystemStats>): void;
+		(arg0: string, arg1: any, arg2: FileSystemCallback<string | Buffer>): void;
+	};
+	lstatSync: (arg0: string, arg1?: any) => FileSystemStats;
 	stat: {
 		(arg0: string, arg1: FileSystemCallback<FileSystemStats>): void;
 		(arg0: string, arg1: any, arg2: FileSystemCallback<string | Buffer>): void;
@@ -85,6 +90,10 @@ declare interface FileSystem {
 		(arg0: string, arg1: FileSystemCallback<string | Buffer>): void;
 		(arg0: string, arg1: any, arg2: FileSystemCallback<string | Buffer>): void;
 	};
+	lstat: {
+		(arg0: string, arg1: FileSystemCallback<FileSystemStats>): void;
+		(arg0: string, arg1: any, arg2: FileSystemCallback<string | Buffer>): void;
+	};
 	stat: {
 		(arg0: string, arg1: FileSystemCallback<FileSystemStats>): void;
 		(arg0: string, arg1: any, arg2: FileSystemCallback<string | Buffer>): void;