2 var polyfills = require('./polyfills.js')
3 var legacy = require('./legacy-streams.js')
4 var clone = require('./clone.js')
6 var util = require('util')
8 /* istanbul ignore next - node 0.x polyfill */
12 /* istanbul ignore else - node 0.x polyfill */
13 if (typeof Symbol === 'function' && typeof Symbol.for === 'function') {
14 gracefulQueue = Symbol.for('graceful-fs.queue')
15 // This is used in testing by future versions
16 previousSymbol = Symbol.for('graceful-fs.previous')
18 gracefulQueue = '___graceful-fs.queue'
19 previousSymbol = '___graceful-fs.previous'
24 function publishQueue(context, queue) {
25 Object.defineProperty(context, gracefulQueue, {
34 debug = util.debuglog('gfs4')
35 else if (/\bgfs4\b/i.test(process.env.NODE_DEBUG || ''))
37 var m = util.format.apply(util, arguments)
38 m = 'GFS4: ' + m.split(/\n/).join('\nGFS4: ')
42 // Once time initialization
43 if (!fs[gracefulQueue]) {
44 // This queue can be shared by multiple loaded instances
45 var queue = global[gracefulQueue] || []
46 publishQueue(fs, queue)
48 // Patch fs.close/closeSync to shared queue version, because we need
49 // to retry() whenever a close happens *anywhere* in the program.
50 // This is essential when multiple graceful-fs instances are
51 // in play at the same time.
52 fs.close = (function (fs$close) {
53 function close (fd, cb) {
54 return fs$close.call(fs, fd, function (err) {
55 // This function uses the graceful-fs shared queue
60 if (typeof cb === 'function')
61 cb.apply(this, arguments)
65 Object.defineProperty(close, previousSymbol, {
71 fs.closeSync = (function (fs$closeSync) {
72 function closeSync (fd) {
73 // This function uses the graceful-fs shared queue
74 fs$closeSync.apply(fs, arguments)
78 Object.defineProperty(closeSync, previousSymbol, {
84 if (/\bgfs4\b/i.test(process.env.NODE_DEBUG || '')) {
85 process.on('exit', function() {
86 debug(fs[gracefulQueue])
87 require('assert').equal(fs[gracefulQueue].length, 0)
92 if (!global[gracefulQueue]) {
93 publishQueue(global, fs[gracefulQueue]);
96 module.exports = patch(clone(fs))
97 if (process.env.TEST_GRACEFUL_FS_GLOBAL_PATCH && !fs.__patched) {
98 module.exports = patch(fs)
102 function patch (fs) {
103 // Everything that references the open() function needs to be in here
105 fs.gracefulify = patch
107 fs.createReadStream = createReadStream
108 fs.createWriteStream = createWriteStream
109 var fs$readFile = fs.readFile
110 fs.readFile = readFile
111 function readFile (path, options, cb) {
112 if (typeof options === 'function')
113 cb = options, options = null
115 return go$readFile(path, options, cb)
117 function go$readFile (path, options, cb) {
118 return fs$readFile(path, options, function (err) {
119 if (err && (err.code === 'EMFILE' || err.code === 'ENFILE'))
120 enqueue([go$readFile, [path, options, cb]])
122 if (typeof cb === 'function')
123 cb.apply(this, arguments)
130 var fs$writeFile = fs.writeFile
131 fs.writeFile = writeFile
132 function writeFile (path, data, options, cb) {
133 if (typeof options === 'function')
134 cb = options, options = null
136 return go$writeFile(path, data, options, cb)
138 function go$writeFile (path, data, options, cb) {
139 return fs$writeFile(path, data, options, function (err) {
140 if (err && (err.code === 'EMFILE' || err.code === 'ENFILE'))
141 enqueue([go$writeFile, [path, data, options, cb]])
143 if (typeof cb === 'function')
144 cb.apply(this, arguments)
151 var fs$appendFile = fs.appendFile
153 fs.appendFile = appendFile
154 function appendFile (path, data, options, cb) {
155 if (typeof options === 'function')
156 cb = options, options = null
158 return go$appendFile(path, data, options, cb)
160 function go$appendFile (path, data, options, cb) {
161 return fs$appendFile(path, data, options, function (err) {
162 if (err && (err.code === 'EMFILE' || err.code === 'ENFILE'))
163 enqueue([go$appendFile, [path, data, options, cb]])
165 if (typeof cb === 'function')
166 cb.apply(this, arguments)
173 var fs$copyFile = fs.copyFile
175 fs.copyFile = copyFile
176 function copyFile (src, dest, flags, cb) {
177 if (typeof flags === 'function') {
181 return fs$copyFile(src, dest, flags, function (err) {
182 if (err && (err.code === 'EMFILE' || err.code === 'ENFILE'))
183 enqueue([fs$copyFile, [src, dest, flags, cb]])
185 if (typeof cb === 'function')
186 cb.apply(this, arguments)
192 var fs$readdir = fs.readdir
194 function readdir (path, options, cb) {
196 if (typeof options !== 'function') {
201 args.push(go$readdir$cb)
203 return go$readdir(args)
205 function go$readdir$cb (err, files) {
206 if (files && files.sort)
209 if (err && (err.code === 'EMFILE' || err.code === 'ENFILE'))
210 enqueue([go$readdir, [args]])
213 if (typeof cb === 'function')
214 cb.apply(this, arguments)
220 function go$readdir (args) {
221 return fs$readdir.apply(fs, args)
224 if (process.version.substr(0, 4) === 'v0.8') {
225 var legStreams = legacy(fs)
226 ReadStream = legStreams.ReadStream
227 WriteStream = legStreams.WriteStream
230 var fs$ReadStream = fs.ReadStream
232 ReadStream.prototype = Object.create(fs$ReadStream.prototype)
233 ReadStream.prototype.open = ReadStream$open
236 var fs$WriteStream = fs.WriteStream
237 if (fs$WriteStream) {
238 WriteStream.prototype = Object.create(fs$WriteStream.prototype)
239 WriteStream.prototype.open = WriteStream$open
242 Object.defineProperty(fs, 'ReadStream', {
246 set: function (val) {
252 Object.defineProperty(fs, 'WriteStream', {
256 set: function (val) {
264 var FileReadStream = ReadStream
265 Object.defineProperty(fs, 'FileReadStream', {
267 return FileReadStream
269 set: function (val) {
275 var FileWriteStream = WriteStream
276 Object.defineProperty(fs, 'FileWriteStream', {
278 return FileWriteStream
280 set: function (val) {
281 FileWriteStream = val
287 function ReadStream (path, options) {
288 if (this instanceof ReadStream)
289 return fs$ReadStream.apply(this, arguments), this
291 return ReadStream.apply(Object.create(ReadStream.prototype), arguments)
294 function ReadStream$open () {
296 open(that.path, that.flags, that.mode, function (err, fd) {
301 that.emit('error', err)
304 that.emit('open', fd)
310 function WriteStream (path, options) {
311 if (this instanceof WriteStream)
312 return fs$WriteStream.apply(this, arguments), this
314 return WriteStream.apply(Object.create(WriteStream.prototype), arguments)
317 function WriteStream$open () {
319 open(that.path, that.flags, that.mode, function (err, fd) {
322 that.emit('error', err)
325 that.emit('open', fd)
330 function createReadStream (path, options) {
331 return new fs.ReadStream(path, options)
334 function createWriteStream (path, options) {
335 return new fs.WriteStream(path, options)
338 var fs$open = fs.open
340 function open (path, flags, mode, cb) {
341 if (typeof mode === 'function')
342 cb = mode, mode = null
344 return go$open(path, flags, mode, cb)
346 function go$open (path, flags, mode, cb) {
347 return fs$open(path, flags, mode, function (err, fd) {
348 if (err && (err.code === 'EMFILE' || err.code === 'ENFILE'))
349 enqueue([go$open, [path, flags, mode, cb]])
351 if (typeof cb === 'function')
352 cb.apply(this, arguments)
362 function enqueue (elem) {
363 debug('ENQUEUE', elem[0].name, elem[1])
364 fs[gracefulQueue].push(elem)
368 var elem = fs[gracefulQueue].shift()
370 debug('RETRY', elem[0].name, elem[1])
371 elem[0].apply(null, elem[1])