make lstat in filesystem interface optional to avoid breaking change

support options argument in SyncAsyncFileSystem
CacheBackend should be able to cope with optional methods

Author: sokra

lib/CachedInputFileSystem.js

@@ -141,8 +141,8 @@ class CacheBackend {
 		/** @type {number | undefined} */
 		this._nextDecay = undefined;
 
-		this.provide = this.provide.bind(this);
-		this.provideSync = this.provideSync.bind(this);
+		this.provide = provider ? this.provide.bind(this) : null;
+		this.provideSync = syncProvider ? this.provideSync.bind(this) : null;
 	}
 
 	provide(path, options, callback) {
@@ -462,6 +462,7 @@ module.exports = class CachedInputFileSystem {
 
 	purge(what) {
 		this._statBackend.purge(what);
+		this._lstatBackend.purge(what);
 		this._readdirBackend.purgeParent(what);
 		this._readFileBackend.purge(what);
 		this._readlinkBackend.purge(what);

lib/Resolver.js

@@ -51,7 +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=} lstat
  * @property {(function(string, FileSystemCallback<FileSystemStats>): void) & function(string, object, FileSystemCallback<Buffer | string>): void} stat
  */
 
@@ -61,7 +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=} lstatSync
  * @property {function(string, object=): FileSystemStats} statSync
  */
 

lib/SyncAsyncFileSystemDecorator.js

@@ -15,76 +15,81 @@
 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.lstat = undefined;
+	this.lstatSync = undefined;
+	const lstatSync = fs.lstatSync;
+	if (lstatSync) {
+		this.lstat = (arg, options, callback) => {
+			let result;
+			try {
+				result = lstatSync.call(fs, arg);
+			} catch (e) {
+				return (callback || options)(e);
+			}
+			(callback || options)(null, result);
+		};
+		this.lstatSync = (arg, options) => lstatSync.call(fs, arg, options);
+	}
 
-	this.stat = (arg, callback) => {
+	this.stat = (arg, options, callback) => {
 		let result;
 		try {
-			result = fs.statSync(arg);
+			result = fs.statSync(arg, options);
 		} catch (e) {
-			return callback(e);
+			return (callback || options)(e);
 		}
-		callback(null, result);
+		(callback || options)(null, result);
 	};
-	this.statSync = arg => fs.statSync(arg);
+	this.statSync = (arg, options) => fs.statSync(arg, options);
 
-	this.readdir = (arg, callback) => {
+	this.readdir = (arg, options, callback) => {
 		let result;
 		try {
 			result = fs.readdirSync(arg);
 		} catch (e) {
-			return callback(e);
+			return (callback || options)(e);
 		}
-		callback(null, result);
+		(callback || options)(null, result);
 	};
-	this.readdirSync = arg => fs.readdirSync(arg);
+	this.readdirSync = (arg, options) => fs.readdirSync(arg, options);
 
-	this.readFile = (arg, callback) => {
+	this.readFile = (arg, options, callback) => {
 		let result;
 		try {
 			result = fs.readFileSync(arg);
 		} catch (e) {
-			return callback(e);
+			return (callback || options)(e);
 		}
-		callback(null, result);
+		(callback || options)(null, result);
 	};
-	this.readFileSync = arg => fs.readFileSync(arg);
+	this.readFileSync = (arg, options) => fs.readFileSync(arg, options);
 
-	this.readlink = (arg, callback) => {
+	this.readlink = (arg, options, callback) => {
 		let result;
 		try {
 			result = fs.readlinkSync(arg);
 		} catch (e) {
-			return callback(e);
+			return (callback || options)(e);
 		}
-		callback(null, result);
+		(callback || options)(null, result);
 	};
-	this.readlinkSync = arg => fs.readlinkSync(arg);
+	this.readlinkSync = (arg, options) => fs.readlinkSync(arg, options);
 
 	this.readJson = undefined;
 	this.readJsonSync = undefined;
 	const readJsonSync = fs.readJsonSync;
 	if (readJsonSync) {
-		this.readJson = (arg, callback) => {
+		this.readJson = (arg, options, callback) => {
 			let result;
 			try {
 				result = readJsonSync.call(fs, arg);
 			} catch (e) {
-				return callback(e);
+				return (callback || options)(e);
 			}
-			callback(null, result);
+			(callback || options)(null, result);
 		};
 
-		this.readJsonSync = arg => readJsonSync.call(fs, arg);
+		this.readJsonSync = (arg, options) => readJsonSync.call(fs, arg, options);
 	}
 }
 module.exports = SyncAsyncFileSystemDecorator;

types.d.ts

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