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

Don't error on ENOSYS, EINVAL or EPERM when changing ownership #55

Closed
wants to merge 1 commit into from
Closed

Don't error on ENOSYS, EINVAL or EPERM when changing ownership #55

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
44 changes: 40 additions & 4 deletions index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,19 @@ function serializeActiveFile (absoluteName) {
})
}

// https://github.com/isaacs/node-graceful-fs/blob/master/polyfills.js#L315-L342
function isChownErrOk (err) {
if (!err) { return true }
if (err.code === 'ENOSYS') { return true }

const nonroot = !process.getuid || process.getuid() !== 0
if (nonroot) {
if (err.code === 'EINVAL' || err.code === 'EPERM') { return true }
}

return false
}

async function writeFileAsync (filename, data, options = {}) {
if (typeof options === 'string') {
options = { encoding: options }
Expand Down Expand Up @@ -105,11 +118,19 @@ async function writeFileAsync (filename, data, options = {}) {

fd = null
if (options.chown) {
await promisify(fs.chown)(tmpfile, options.chown.uid, options.chown.gid)
try {
await promisify(fs.chown)(tmpfile, options.chown.uid, options.chown.gid)
} catch (err) {
if (!isChownErrOk(err)) throw err
}
}

if (options.mode) {
await promisify(fs.chmod)(tmpfile, options.mode)
try {
await promisify(fs.chmod)(tmpfile, options.mode)
} catch (err) {
if (!isChownErrOk(err)) throw err
}
}

await promisify(fs.rename)(tmpfile, truename)
Expand Down Expand Up @@ -193,8 +214,23 @@ function writeFileSync (filename, data, options) {
fs.fsyncSync(fd)
}
fs.closeSync(fd)
if (options.chown) fs.chownSync(tmpfile, options.chown.uid, options.chown.gid)
if (options.mode) fs.chmodSync(tmpfile, options.mode)

if (options.chown) {
try {
fs.chownSync(tmpfile, options.chown.uid, options.chown.gid)
} catch (err) {
if (!isChownErrOk(err)) throw err
}
}

if (options.mode) {
try {
fs.chmodSync(tmpfile, options.mode)
} catch (err) {
if (!isChownErrOk(err)) throw err
}
}

fs.renameSync(tmpfile, filename)
removeOnExitHandler()
} catch (err) {
Expand Down
72 changes: 54 additions & 18 deletions test/basic.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,75 +2,93 @@
const { test } = require('tap')
const requireInject = require('require-inject')

const createErr = code => {
const err = new Error(code)
err.code = code
return err
}

let unlinked = []
const writeFileAtomic = requireInject('../index', {
'fs': {
realpath (filename, cb) {
return cb(null, filename)
},
open (tmpfile, options, mode, cb) {
if (/noopen/.test(tmpfile)) return cb(new Error('ENOOPEN'))
if (/noopen/.test(tmpfile)) return cb(createErr('ENOOPEN'))
cb(null, tmpfile)
},
write (fd) {
const cb = arguments[arguments.length - 1]
if (/nowrite/.test(fd)) return cb(new Error('ENOWRITE'))
if (/nowrite/.test(fd)) return cb(createErr('ENOWRITE'))
cb()
},
fsync (fd, cb) {
if (/nofsync/.test(fd)) return cb(new Error('ENOFSYNC'))
if (/nofsync/.test(fd)) return cb(createErr('ENOFSYNC'))
cb()
},
close (fd, cb) { cb() },
chown (tmpfile, uid, gid, cb) {
if (/nochown/.test(tmpfile)) return cb(new Error('ENOCHOWN'))
if (/nochown/.test(tmpfile)) return cb(createErr('ENOCHOWN'))
if (/enosys/.test(tmpfile)) return cb(createErr('ENOSYS'))
if (/einval/.test(tmpfile)) return cb(createErr('EINVAL'))
if (/eperm/.test(tmpfile)) return cb(createErr('EPERM'))
cb()
},
chmod (tmpfile, mode, cb) {
if (/nochmod/.test(tmpfile)) return cb(new Error('ENOCHMOD'))
if (/nochmod/.test(tmpfile)) return cb(createErr('ENOCHMOD'))
if (/enosys/.test(tmpfile)) return cb(createErr('ENOSYS'))
if (/eperm/.test(tmpfile)) return cb(createErr('EPERM'))
if (/einval/.test(tmpfile)) return cb(createErr('EINVAL'))
cb()
},
rename (tmpfile, filename, cb) {
if (/norename/.test(tmpfile)) return cb(new Error('ENORENAME'))
if (/norename/.test(tmpfile)) return cb(createErr('ENORENAME'))
cb()
},
unlink (tmpfile, cb) {
if (/nounlink/.test(tmpfile)) return cb(new Error('ENOUNLINK'))
if (/nounlink/.test(tmpfile)) return cb(createErr('ENOUNLINK'))
cb()
},
stat (tmpfile, cb) {
if (/nostat/.test(tmpfile)) return cb(new Error('ENOSTAT'))
if (/nostat/.test(tmpfile)) return cb(createErr('ENOSTAT'))
cb()
},
realpathSync (filename, cb) {
return filename
},
openSync (tmpfile, options) {
if (/noopen/.test(tmpfile)) throw new Error('ENOOPEN')
if (/noopen/.test(tmpfile)) throw createErr('ENOOPEN')
return tmpfile
},
writeSync (fd) {
if (/nowrite/.test(fd)) throw new Error('ENOWRITE')
if (/nowrite/.test(fd)) throw createErr('ENOWRITE')
},
fsyncSync (fd) {
if (/nofsync/.test(fd)) throw new Error('ENOFSYNC')
if (/nofsync/.test(fd)) throw createErr('ENOFSYNC')
},
closeSync () { },
chownSync (tmpfile, uid, gid) {
if (/nochown/.test(tmpfile)) throw new Error('ENOCHOWN')
if (/nochown/.test(tmpfile)) throw createErr('ENOCHOWN')
if (/enosys/.test(tmpfile)) throw createErr('ENOSYS')
if (/einval/.test(tmpfile)) throw createErr('EINVAL')
if (/eperm/.test(tmpfile)) throw createErr('EPERM')
},
chmodSync (tmpfile, mode) {
if (/nochmod/.test(tmpfile)) throw new Error('ENOCHMOD')
if (/nochmod/.test(tmpfile)) throw createErr('ENOCHMOD')
if (/enosys/.test(tmpfile)) throw createErr('ENOSYS')
if (/einval/.test(tmpfile)) throw createErr('EINVAL')
if (/eperm/.test(tmpfile)) throw createErr('EPERM')
},
renameSync (tmpfile, filename) {
if (/norename/.test(tmpfile)) throw new Error('ENORENAME')
if (/norename/.test(tmpfile)) throw createErr('ENORENAME')
},
unlinkSync (tmpfile) {
if (/nounlink/.test(tmpfile)) throw new Error('ENOUNLINK')
if (/nounlink/.test(tmpfile)) throw createErr('ENOUNLINK')
unlinked.push(tmpfile)
},
statSync (tmpfile) {
if (/nostat/.test(tmpfile)) throw new Error('ENOSTAT')
if (/nostat/.test(tmpfile)) throw createErr('ENOSTAT')
}
}
})
Expand All @@ -97,7 +115,7 @@ test('cleanupOnExit', t => {
})

test('async tests', t => {
t.plan(14)
t.plan(17)
writeFileAtomic('good', 'test', { mode: '0777' }, err => {
t.notOk(err, 'No errors occur when passing in options')
})
Expand Down Expand Up @@ -140,10 +158,19 @@ test('async tests', t => {
writeFileAtomic('nofsync', 'test', err => {
t.is(err && err.message, 'ENOFSYNC', 'Fsync failures propagate')
})
writeFileAtomic('enosys', 'test', err => {
t.notOk(err, 'No errors on ENOSYS')
})
writeFileAtomic('einval', 'test', err => {
t.notOk(err, 'No errors on EINVAL for non root')
})
writeFileAtomic('eperm', 'test', err => {
t.notOk(err, 'No errors on EPERM for non root')
})
})

test('sync tests', t => {
t.plan(16)
t.plan(19)
const throws = function (shouldthrow, msg, todo) {
let err
try { todo() } catch (e) { err = e }
Expand Down Expand Up @@ -214,6 +241,15 @@ test('sync tests', t => {
throws('ENOFSYNC', 'Fsync errors propagate', () => {
writeFileAtomicSync('nofsync', 'test')
})
noexception('No errors on ENOSYS', () => {
writeFileAtomicSync('enosys', 'test', { chown: { uid: 100, gid: 100 } })
})
noexception('No errors on EINVAL for non root', () => {
writeFileAtomicSync('einval', 'test', { chown: { uid: 100, gid: 100 } })
})
noexception('No errors on EPERM for non root', () => {
writeFileAtomicSync('eperm', 'test', { chown: { uid: 100, gid: 100 } })
})
})

test('promises', async t => {
Expand Down