Skip to content

Commit

Permalink
BREAKING: Use internal fork of make-dir for mkdirs implementation (#756)
Browse files Browse the repository at this point in the history
* BREAKING: Use internal fork of make-dir for mkdirs implementation

Resolves #619

Everything should work similarly to how it did before; except that
we no longer return a file path on success (to match fs.mkdir).
Also, errors may be different.

* Hopefully fix Windows tests

- Error codes are different
- Match fs.mkdir behavior on Windows when creating root

* Port sindresorhus/make-dir#24

* Add comment for clarity

* Use at-least-node for version sniffing

* Consistent error codes across OSes

* Allow different error codes on different Node versions
  • Loading branch information
RyanZim committed Feb 18, 2020
1 parent 075c2d1 commit ab92b24
Show file tree
Hide file tree
Showing 11 changed files with 167 additions and 241 deletions.
6 changes: 1 addition & 5 deletions lib/mkdirs/__tests__/clobber.test.js
Expand Up @@ -42,11 +42,7 @@ describe('mkdirp / clobber', () => {
it('should clobber', done => {
fse.mkdirp(file, 0o755, err => {
assert.ok(err)
if (os.platform().indexOf('win') === 0) {
assert.strictEqual(err.code, 'EEXIST')
} else {
assert.strictEqual(err.code, 'ENOTDIR')
}
assert.strictEqual(err.code, 'ENOTDIR')
done()
})
})
Expand Down
11 changes: 9 additions & 2 deletions lib/mkdirs/__tests__/issue-93.test.js
Expand Up @@ -4,6 +4,7 @@ const os = require('os')
const fse = require(process.cwd())
const path = require('path')
const assert = require('assert')
const util = require('util')

/* global before, describe, it */

Expand All @@ -23,13 +24,19 @@ describe('mkdirp: issue-93, win32, when drive does not exist, it should return a

it('should return a cleaner error than inifinite loop, stack crash', done => {
const file = 'R:\\afasd\\afaff\\fdfd' // hopefully drive 'r' does not exist on appveyor
// Different error codes on different Node versions (matches native mkdir behavior)
const assertErr = (err) => assert(
['EPERM', 'ENOENT'].includes(err.code),
`expected 'EPERM' or 'ENOENT', got ${util.inspect(err.code)}`
)

fse.mkdirp(file, err => {
assert.strictEqual(err.code, 'ENOENT')
assertErr(err)

try {
fse.mkdirsSync(file)
} catch (err) {
assert.strictEqual(err.code, 'ENOENT')
assertErr(err)
}

done()
Expand Down
3 changes: 1 addition & 2 deletions lib/mkdirs/__tests__/opts-undef.test.js
Expand Up @@ -5,7 +5,6 @@ const os = require('os')
const fse = require(process.cwd())
const path = require('path')
const assert = require('assert')
const mkdirs = require('../mkdirs')

/* global beforeEach, describe, it */

Expand All @@ -22,7 +21,7 @@ describe('mkdirs / opts-undef', () => {
const newDir = path.join(TEST_DIR, 'doest', 'not', 'exist')
assert(!fs.existsSync(newDir))

mkdirs(newDir, undefined, err => {
fse.mkdirs(newDir, undefined, err => {
assert.ifError(err)
assert(fs.existsSync(newDir))
done()
Expand Down
41 changes: 0 additions & 41 deletions lib/mkdirs/__tests__/return.test.js

This file was deleted.

39 changes: 0 additions & 39 deletions lib/mkdirs/__tests__/return_sync.test.js

This file was deleted.

10 changes: 5 additions & 5 deletions lib/mkdirs/__tests__/root.test.js
Expand Up @@ -8,17 +8,17 @@ const assert = require('assert')
/* global describe, it */

describe('mkdirp / root', () => {
// '/' on unix, 'c:/' on windows.
// '/' on unix
const dir = path.normalize(path.resolve(path.sep)).toLowerCase()

// if not 'c:\\' or 'd:\\', it's probably a network mounted drive, this fails then. TODO: investigate
if (process.platform === 'win32' && (dir.indexOf('c:\\') === -1) && (dir.indexOf('d:\\') === -1)) return
// Windows does not have permission to mkdir on root
if (process.platform === 'win32') return

it('should', done => {
fse.mkdirp(dir, 0o755, err => {
if (err) throw err
if (err) return done(err)
fs.stat(dir, (er, stat) => {
if (er) throw er
if (er) return done(er)
assert.ok(stat.isDirectory(), 'target is a directory')
done()
})
Expand Down
18 changes: 9 additions & 9 deletions lib/mkdirs/index.js
@@ -1,14 +1,14 @@
'use strict'
const u = require('universalify').fromCallback
const mkdirs = u(require('./mkdirs'))
const mkdirsSync = require('./mkdirs-sync')
const u = require('universalify').fromPromise
const { makeDir: _makeDir, makeDirSync } = require('./make-dir')
const makeDir = u(_makeDir)

module.exports = {
mkdirs,
mkdirsSync,
mkdirs: makeDir,
mkdirsSync: makeDirSync,
// alias
mkdirp: mkdirs,
mkdirpSync: mkdirsSync,
ensureDir: mkdirs,
ensureDirSync: mkdirsSync
mkdirp: makeDir,
mkdirpSync: makeDirSync,
ensureDir: makeDir,
ensureDirSync: makeDirSync
}
142 changes: 142 additions & 0 deletions lib/mkdirs/make-dir.js
@@ -0,0 +1,142 @@
// Adapted from https://github.com/sindresorhus/make-dir
// Copyright (c) Sindre Sorhus <sindresorhus@gmail.com> (sindresorhus.com)
// Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
// The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
'use strict'
const fs = require('../fs')
const path = require('path')
const atLeastNode = require('at-least-node')

const useNativeRecursiveOption = atLeastNode('10.12.0')

// https://github.com/nodejs/node/issues/8987
// https://github.com/libuv/libuv/pull/1088
const checkPath = pth => {
if (process.platform === 'win32') {
const pathHasInvalidWinCharacters = /[<>:"|?*]/.test(pth.replace(path.parse(pth).root, ''))

if (pathHasInvalidWinCharacters) {
const error = new Error(`Path contains invalid characters: ${pth}`)
error.code = 'EINVAL'
throw error
}
}
}

const processOptions = options => {
// Must be defined here so we get fresh process.umask()
const defaults = { mode: 0o777 & (~process.umask()) }
if (typeof options === 'number') options = { mode: options }
return { ...defaults, ...options }
}

const permissionError = pth => {
// This replicates the exception of `fs.mkdir` with native the
// `recusive` option when run on an invalid drive under Windows.
const error = new Error(`operation not permitted, mkdir '${pth}'`)
error.code = 'EPERM'
error.errno = -4048
error.path = pth
error.syscall = 'mkdir'
return error
}

module.exports.makeDir = async (input, options) => {
checkPath(input)
options = processOptions(options)

if (useNativeRecursiveOption) {
const pth = path.resolve(input)

return fs.mkdir(pth, {
mode: options.mode,
recursive: true
})
}

const make = async pth => {
try {
await fs.mkdir(pth, options.mode)
} catch (error) {
if (error.code === 'EPERM') {
throw error
}

if (error.code === 'ENOENT') {
if (path.dirname(pth) === pth) {
throw permissionError(pth)
}

if (error.message.includes('null bytes')) {
throw error
}

await make(path.dirname(pth))
return make(pth)
}

try {
const stats = await fs.stat(pth)
if (!stats.isDirectory()) {
// This error is never exposed to the user
// it is caught below, and the original error is thrown
throw new Error('The path is not a directory')
}
} catch {
throw error
}
}
}

return make(path.resolve(input))
}

module.exports.makeDirSync = (input, options) => {
checkPath(input)
options = processOptions(options)

if (useNativeRecursiveOption) {
const pth = path.resolve(input)

return fs.mkdirSync(pth, {
mode: options.mode,
recursive: true
})
}

const make = pth => {
try {
fs.mkdirSync(pth, options.mode)
} catch (error) {
if (error.code === 'EPERM') {
throw error
}

if (error.code === 'ENOENT') {
if (path.dirname(pth) === pth) {
throw permissionError(pth)
}

if (error.message.includes('null bytes')) {
throw error
}

make(path.dirname(pth))
return make(pth)
}

try {
if (!fs.statSync(pth).isDirectory()) {
// This error is never exposed to the user
// it is caught below, and the original error is thrown
throw new Error('The path is not a directory')
}
} catch {
throw error
}
}
}

return make(path.resolve(input))
}
52 changes: 0 additions & 52 deletions lib/mkdirs/mkdirs-sync.js

This file was deleted.

0 comments on commit ab92b24

Please sign in to comment.