fs: move fs/promises to fs.promises

cjihrig · MylesBorins · commit 3191f30d0a43 · 2018-05-08T14:22:25.000-07:00
PR-URL: #20504 Refs: nodejs/TSC#389 Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Myles Borins <myles.borins@gmail.com> Reviewed-By: Shingo Inoue <leko.noor@gmail.com> Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com> Reviewed-By: Tiancheng "Timothy" Gu <timothygu99@gmail.com> Reviewed-By: Ali Ijaz Sheikh <ofrobots@google.com>
diff --git a/benchmark/fs/bench-stat-promise.js b/benchmark/fs/bench-stat-promise.js
@@ -1,7 +1,7 @@
 'use strict';
 
 const common = require('../common');
-const fsPromises = require('fs/promises');
+const fsPromises = require('fs').promises;
 
 const bench = common.createBenchmark(main, {
 n: [20e4],
diff --git a/doc/api/fs.md b/doc/api/fs.md
@@ -3382,9 +3382,9 @@ Synchronous versions of [`fs.write()`][]. Returns the number of bytes written.
 
 > Stability: 1 - Experimental
 
-The `fs/promises` API provides an alternative set of asynchronous file system
+The `fs.promises` API provides an alternative set of asynchronous file system
 methods that return `Promise` objects rather than using callbacks. The
-API is accessible via `require('fs/promises')`.
+API is accessible via `require('fs').promises`.
 
 ### class: FileHandle
 <!-- YAML
diff --git a/lib/fs.js b/lib/fs.js
@@ -45,7 +45,8 @@ const { Readable, Writable } = require('stream');
 const EventEmitter = require('events');
 const { FSReqWrap, statValues, kFsStatsFieldsLength } = binding;
 const { FSEvent } = process.binding('fs_event_wrap');
-const internalFS = require('internal/fs');
+const promises = require('internal/fs/promises');
+const internalFS = require('internal/fs/utils');
 const { getPathFromURL } = require('internal/url');
 const internalUtil = require('internal/util');
 const {
@@ -72,6 +73,21 @@ const {
 CHAR_BACKWARD_SLASH,
 } = require('internal/constants');
 
+let warn = true;
+
+Object.defineProperty(fs, 'promises', {
+ configurable: true,
+ enumerable: true,
+ get() {
+ if (warn) {
+ warn = false;
+ process.emitWarning('The fs.promises API is experimental',
+ 'ExperimentalWarning');
+ }
+ return promises;
+ }
+});
+
 Object.defineProperty(exports, 'constants', {
 configurable: false,
 enumerable: true,
diff --git a/lib/internal/fs/promises.js b/lib/internal/fs/promises.js
@@ -1,8 +1,5 @@
 'use strict';
 
-process.emitWarning('The fs/promises API is experimental',
- 'ExperimentalWarning');
-
 const {
 F_OK,
 O_SYMLINK,
@@ -37,7 +34,7 @@ const {
 validateOffsetLengthWrite,
 validatePath,
 validateUint32
-} = require('internal/fs');
+} = require('internal/fs/utils');
 const pathModule = require('path');
 
 const kHandle = Symbol('handle');
diff --git a/lib/internal/fs/utils.js b/lib/internal/fs/utils.js
diff --git a/lib/internal/modules/cjs/loader.js b/lib/internal/modules/cjs/loader.js
@@ -28,7 +28,7 @@ const { getURLFromFilePath } = require('internal/url');
 const vm = require('vm');
 const assert = require('assert').ok;
 const fs = require('fs');
-const internalFS = require('internal/fs');
+const internalFS = require('internal/fs/utils');
 const path = require('path');
 const {
 internalModuleReadJSON,
diff --git a/lib/internal/modules/esm/default_resolve.js b/lib/internal/modules/esm/default_resolve.js
@@ -2,7 +2,7 @@
 
 const { URL } = require('url');
 const CJSmodule = require('internal/modules/cjs/loader');
-const internalFS = require('internal/fs');
+const internalFS = require('internal/fs/utils');
 const { NativeModule, internalBinding } = require('internal/bootstrap/loaders');
 const { extname } = require('path');
 const { realpathSync } = require('fs');
diff --git a/lib/internal/process/stdio.js b/lib/internal/process/stdio.js
@@ -158,7 +158,7 @@ function createWritableStdioStream(fd) {
 break;
 
 case 'FILE':
- var fs = require('internal/fs');
+ var fs = require('internal/fs/utils');
 stream = new fs.SyncWriteStream(fd, { autoClose: false });
 stream._type = 'fs';
 break;
diff --git a/node.gyp b/node.gyp
@@ -39,7 +39,6 @@
 'lib/domain.js',
 'lib/events.js',
 'lib/fs.js',
- 'lib/fs/promises.js',
 'lib/http.js',
 'lib/http2.js',
 'lib/_http_agent.js',
@@ -103,7 +102,8 @@
 'lib/internal/errors.js',
 'lib/internal/fixed_queue.js',
 'lib/internal/freelist.js',
- 'lib/internal/fs.js',
+ 'lib/internal/fs/promises.js',
+ 'lib/internal/fs/utils.js',
 'lib/internal/http.js',
 'lib/internal/inspector_async_hook.js',
 'lib/internal/linkedlist.js',
diff --git a/test/parallel/test-fs-filehandle.js b/test/parallel/test-fs-filehandle.js
@@ -5,7 +5,7 @@ const common = require('../common');
 const assert = require('assert');
 const path = require('path');
 const fs = process.binding('fs');
-const { stringToFlags } = require('internal/fs');
+const { stringToFlags } = require('internal/fs/utils');
 
 // Verifies that the FileHandle object is garbage collected and that a
 // warning is emitted if it is not closed.
diff --git a/test/parallel/test-fs-open-flags.js b/test/parallel/test-fs-open-flags.js
@@ -39,7 +39,7 @@ const O_DSYNC = fs.constants.O_DSYNC || 0;
 const O_TRUNC = fs.constants.O_TRUNC || 0;
 const O_WRONLY = fs.constants.O_WRONLY || 0;
 
-const { stringToFlags } = require('internal/fs');
+const { stringToFlags } = require('internal/fs/utils');
 
 assert.strictEqual(stringToFlags('r'), O_RDONLY);
 assert.strictEqual(stringToFlags('r+'), O_RDWR);
diff --git a/test/parallel/test-fs-promises-file-handle-append-file.js b/test/parallel/test-fs-promises-file-handle-append-file.js
@@ -2,11 +2,11 @@
 
 const common = require('../common');
 
-// The following tests validate base functionality for the fs/promises
+// The following tests validate base functionality for the fs.promises
 // FileHandle.appendFile method.
 
 const fs = require('fs');
-const { open } = require('fs/promises');
+const { open } = fs.promises;
 const path = require('path');
 const tmpdir = require('../common/tmpdir');
 const assert = require('assert');
diff --git a/test/parallel/test-fs-promises-file-handle-chmod.js b/test/parallel/test-fs-promises-file-handle-chmod.js
@@ -2,11 +2,11 @@
 
 const common = require('../common');
 
-// The following tests validate base functionality for the fs/promises
+// The following tests validate base functionality for the fs.promises
 // FileHandle.chmod method.
 
 const fs = require('fs');
-const { open } = require('fs/promises');
+const { open } = fs.promises;
 const path = require('path');
 const tmpdir = require('../common/tmpdir');
 const assert = require('assert');
diff --git a/test/parallel/test-fs-promises-file-handle-read.js b/test/parallel/test-fs-promises-file-handle-read.js
@@ -2,11 +2,11 @@
 
 const common = require('../common');
 
-// The following tests validate base functionality for the fs/promises
+// The following tests validate base functionality for the fs.promises
 // FileHandle.read method.
 
 const fs = require('fs');
-const { open } = require('fs/promises');
+const { open } = fs.promises;
 const path = require('path');
 const tmpdir = require('../common/tmpdir');
 const assert = require('assert');
diff --git a/test/parallel/test-fs-promises-file-handle-readFile.js b/test/parallel/test-fs-promises-file-handle-readFile.js
@@ -2,11 +2,11 @@
 
 const common = require('../common');
 
-// The following tests validate base functionality for the fs/promises
+// The following tests validate base functionality for the fs.promises
 // FileHandle.readFile method.
 
 const fs = require('fs');
-const { open } = require('fs/promises');
+const { open } = fs.promises;
 const path = require('path');
 const tmpdir = require('../common/tmpdir');
 const assert = require('assert');
diff --git a/test/parallel/test-fs-promises-file-handle-stat.js b/test/parallel/test-fs-promises-file-handle-stat.js
@@ -2,10 +2,10 @@
 
 const common = require('../common');
 
-// The following tests validate base functionality for the fs/promises
+// The following tests validate base functionality for the fs.promises
 // FileHandle.stat method.
 
-const { open } = require('fs/promises');
+const { open } = require('fs').promises;
 const path = require('path');
 const tmpdir = require('../common/tmpdir');
 const assert = require('assert');
diff --git a/test/parallel/test-fs-promises-file-handle-write.js b/test/parallel/test-fs-promises-file-handle-write.js
@@ -2,11 +2,11 @@
 
 const common = require('../common');
 
-// The following tests validate base functionality for the fs/promises
+// The following tests validate base functionality for the fs.promises
 // FileHandle.read method.
 
 const fs = require('fs');
-const { open } = require('fs/promises');
+const { open } = fs.promises;
 const path = require('path');
 const tmpdir = require('../common/tmpdir');
 const assert = require('assert');
diff --git a/test/parallel/test-fs-promises-file-handle-writeFile.js b/test/parallel/test-fs-promises-file-handle-writeFile.js
@@ -2,11 +2,11 @@
 
 const common = require('../common');
 
-// The following tests validate base functionality for the fs/promises
+// The following tests validate base functionality for the fs.promises
 // FileHandle.readFile method.
 
 const fs = require('fs');
-const { open } = require('fs/promises');
+const { open } = fs.promises;
 const path = require('path');
 const tmpdir = require('../common/tmpdir');
 const assert = require('assert');
diff --git a/test/parallel/test-fs-promises-readfile.js b/test/parallel/test-fs-promises-readfile.js
@@ -4,7 +4,7 @@ const common = require('../common');
 
 const assert = require('assert');
 const path = require('path');
-const { writeFile, readFile } = require('fs/promises');
+const { writeFile, readFile } = require('fs').promises;
 const tmpdir = require('../common/tmpdir');
 tmpdir.refresh();
 
diff --git a/test/parallel/test-fs-promises-writefile.js b/test/parallel/test-fs-promises-writefile.js
@@ -2,7 +2,7 @@
 
 const common = require('../common');
 const fs = require('fs');
-const fsPromises = require('fs/promises');
+const fsPromises = fs.promises;
 const path = require('path');
 const tmpdir = require('../common/tmpdir');
 const assert = require('assert');
diff --git a/test/parallel/test-fs-promises.js b/test/parallel/test-fs-promises.js
@@ -5,7 +5,7 @@ const assert = require('assert');
 const tmpdir = require('../common/tmpdir');
 const fixtures = require('../common/fixtures');
 const path = require('path');
-const fsPromises = require('fs/promises');
+const fsPromises = require('fs').promises;
 const {
 access,
 chmod,
diff --git a/test/parallel/test-fs-syncwritestream.js b/test/parallel/test-fs-syncwritestream.js
@@ -6,8 +6,8 @@ const stream = require('stream');
 const fs = require('fs');
 const path = require('path');
 
-// require('internal/fs').SyncWriteStream is used as a stdio implementation
-// when stdout/stderr point to files.
+// require('internal/fs/utils').SyncWriteStream is used as a stdio
+// implementation when stdout/stderr point to files.
 
 if (process.argv[2] === 'child') {
 // Note: Calling console.log() is part of this test as it exercises the
diff --git a/test/parallel/test-internal-fs-syncwritestream.js b/test/parallel/test-internal-fs-syncwritestream.js
@@ -5,7 +5,7 @@ const common = require('../common');
 const assert = require('assert');
 const fs = require('fs');
 const path = require('path');
-const SyncWriteStream = require('internal/fs').SyncWriteStream;
+const SyncWriteStream = require('internal/fs/utils').SyncWriteStream;
 
 const tmpdir = require('../common/tmpdir');
 tmpdir.refresh();
diff --git a/test/parallel/test-internal-fs.js b/test/parallel/test-internal-fs.js
@@ -2,7 +2,7 @@
 'use strict';
 
 const common = require('../common');
-const fs = require('internal/fs');
+const fs = require('internal/fs/utils');
 
 // Valid encodings and no args should not throw.
 fs.assertEncoding();
diff --git a/test/sequential/test-async-wrap-getasyncid.js b/test/sequential/test-async-wrap-getasyncid.js
@@ -3,7 +3,7 @@
 const common = require('../common');
 const assert = require('assert');
 const fs = require('fs');
-const fsPromises = require('fs/promises');
+const fsPromises = fs.promises;
 const net = require('net');
 const providers = Object.assign({}, process.binding('async_wrap').Providers);
 const fixtures = require('../common/fixtures');

-Original file line number
+Diff line change
@@ @@ -1,7 +1,7 @@ @@
 'use strict';
 constcommon=require('../common');
 -constfsPromises=require('fs/promises');
 +constfsPromises=require('fs').promises;
 constbench=common.createBenchmark(main,{
 n: [20e4],
-Original file line number
+Diff line change
 constEventEmitter=require('events');
 const{ FSReqWrap, statValues, kFsStatsFieldsLength }=binding;
 const{ FSEvent }=process.binding('fs_event_wrap');
 -constinternalFS=require('internal/fs');
 +constpromises=require('internal/fs/promises');
 +constinternalFS=require('internal/fs/utils');
 const{ getPathFromURL }=require('internal/url');
 constinternalUtil=require('internal/util');
 const{
 CHAR_BACKWARD_SLASH,
 }=require('internal/constants');
 +letwarn=true;
++
 +Object.defineProperty(fs,'promises',{
 +configurable: true,
 +enumerable: true,
 +get(){
 +if(warn){
 +warn=false;
 +process.emitWarning('The fs.promises API is experimental',
 +'ExperimentalWarning');
 +}
 +returnpromises;
 +}
 +});
++
 Object.defineProperty(exports,'constants',{
 configurable: false,
 enumerable: true,
-Original file line number
+Diff line change
 const{URL}=require('url');
 constCJSmodule=require('internal/modules/cjs/loader');
 -constinternalFS=require('internal/fs');
 +constinternalFS=require('internal/fs/utils');
 const{ NativeModule, internalBinding }=require('internal/bootstrap/loaders');
 const{ extname }=require('path');
 const{ realpathSync }=require('fs');
-Original file line number
+Diff line change
 break;
 case'FILE':
 -varfs=require('internal/fs');
 +varfs=require('internal/fs/utils');
 stream=newfs.SyncWriteStream(fd,{autoClose: false});
 stream._type='fs';
 break;
-Original file line number
+Diff line change
 constassert=require('assert');
 constpath=require('path');
 constfs=process.binding('fs');
 -const{ stringToFlags }=require('internal/fs');
 +const{ stringToFlags }=require('internal/fs/utils');
 // Verifies that the FileHandle object is garbage collected and that a
 // warning is emitted if it is not closed.