Browse Source

Rename 'posix' module to 'fs'

v0.7.4-release
Ryan Dahl 15 years ago
parent
commit
b82ef28d9d
  1. 54
      doc/api.txt
  2. 14
      lib/file.js
  3. 1
      lib/posix.js
  4. 8
      src/node.js
  5. 2
      test/mjsunit/common.js
  6. 4
      test/mjsunit/test-buffered-file.js
  7. 20
      test/mjsunit/test-eio-race.js
  8. 4
      test/mjsunit/test-eio-race2.js
  9. 4
      test/mjsunit/test-eio-race3.js
  10. 2
      test/mjsunit/test-eio-race4.js
  11. 2
      test/mjsunit/test-file-cat-noexist.js
  12. 4
      test/mjsunit/test-fs-stat.js
  13. 10
      test/mjsunit/test-fs-write.js
  14. 6
      test/mjsunit/test-http-tls.js
  15. 4
      test/mjsunit/test-mkdir-rmdir.js
  16. 2
      test/mjsunit/test-readdir.js
  17. 2
      test/mjsunit/test-sync-cat.js
  18. 8
      test/mjsunit/test-tcp-tls.js

54
doc/api.txt

@ -174,7 +174,7 @@ process.watchFile(f, function (curr, prev) {
}); });
------------------------- -------------------------
+ +
These stat objects are instances of +posix.Stat+. These stat objects are instances of +fs.Stat+.
+process.unwatchFile(filename)+:: +process.unwatchFile(filename)+::
Stop watching for changes on +filename+. Stop watching for changes on +filename+.
@ -609,16 +609,16 @@ will be sent +"SIGTERM"+. See signal(7) for a list of available signals.
=== POSIX module === POSIX module
File I/O is provided by simple wrappers around standard POSIX functions. To File I/O is provided by simple wrappers around standard POSIX functions. To
use this module do +require("posix")+. use this module do +require("fs")+.
All POSIX wrappers have a similar form. They return a promise All POSIX wrappers have a similar form. They return a promise
(+events.Promise+). Example of deleting a file: (+events.Promise+). Example of deleting a file:
------------------------------------------------------------------------------ ------------------------------------------------------------------------------
var posix = require("posix"), var fs = require("fs"),
sys = require("sys"); sys = require("sys");
var promise = posix.unlink("/tmp/hello"); var promise = fs.unlink("/tmp/hello");
promise.addCallback(function () { promise.addCallback(function () {
sys.puts("successfully deleted /tmp/hello"); sys.puts("successfully deleted /tmp/hello");
@ -629,8 +629,8 @@ There is no guaranteed ordering to the POSIX wrappers. The
following is very much prone to error following is very much prone to error
------------------------------------------------------------------------------ ------------------------------------------------------------------------------
posix.rename("/tmp/hello", "/tmp/world"); fs.rename("/tmp/hello", "/tmp/world");
posix.stat("/tmp/world").addCallback(function (stats) { fs.stat("/tmp/world").addCallback(function (stats) {
sys.puts("stats: " + JSON.stringify(stats)); sys.puts("stats: " + JSON.stringify(stats));
}); });
------------------------------------------------------------------------------ ------------------------------------------------------------------------------
@ -639,8 +639,8 @@ It could be that +stat()+ is executed before the +rename()+.
The correct way to do this is to chain the promises. The correct way to do this is to chain the promises.
------------------------------------------------------------------------------ ------------------------------------------------------------------------------
posix.rename("/tmp/hello", "/tmp/world").addCallback(function () { fs.rename("/tmp/hello", "/tmp/world").addCallback(function () {
posix.stat("/tmp/world").addCallback(function (stats) { fs.stat("/tmp/world").addCallback(function (stats) {
sys.puts("stats: " + JSON.stringify(stats)); sys.puts("stats: " + JSON.stringify(stats));
}); });
}); });
@ -649,25 +649,25 @@ posix.rename("/tmp/hello", "/tmp/world").addCallback(function () {
Or use the +promise.wait()+ functionality: Or use the +promise.wait()+ functionality:
------------------------------------------------------------------------------ ------------------------------------------------------------------------------
posix.rename("/tmp/hello", "/tmp/world").wait(); fs.rename("/tmp/hello", "/tmp/world").wait();
var stats = posix.stat("/tmp/world").wait(); var stats = fs.stat("/tmp/world").wait();
sys.puts("stats: " + JSON.stringify(stats)); sys.puts("stats: " + JSON.stringify(stats));
------------------------------------------------------------------------------ ------------------------------------------------------------------------------
+posix.rename(path1, path2)+ :: +fs.rename(path1, path2)+ ::
See rename(2). See rename(2).
- on success: no parameters. - on success: no parameters.
- on error: no parameters. - on error: no parameters.
+posix.truncate(fd, len)+ :: +fs.truncate(fd, len)+ ::
See ftruncate(2). See ftruncate(2).
- on success: no parameters. - on success: no parameters.
- on error: no parameters. - on error: no parameters.
+posix.stat(path)+ :: +fs.stat(path)+ ::
See stat(2). See stat(2).
- on success: Returns +posix.Stats+ object. It looks like this: - on success: Returns +fs.Stats+ object. It looks like this:
+ +
------------------------------------------------------------------------------ ------------------------------------------------------------------------------
{ dev: 2049, ino: 305352, mode: 16877, nlink: 12, uid: 1000, gid: 1000, { dev: 2049, ino: 305352, mode: 16877, nlink: 12, uid: 1000, gid: 1000,
@ -676,49 +676,49 @@ See stat(2).
"2009-06-29T11:11:40Z" }+ "2009-06-29T11:11:40Z" }+
------------------------------------------------------------------------------ ------------------------------------------------------------------------------
+ +
See the +posix.Stats+ section below for more information. See the +fs.Stats+ section below for more information.
- on error: no parameters. - on error: no parameters.
+posix.unlink(path)+ :: +fs.unlink(path)+ ::
See unlink(2) See unlink(2)
- on success: no parameters. - on success: no parameters.
- on error: no parameters. - on error: no parameters.
+posix.rmdir(path)+ :: +fs.rmdir(path)+ ::
See rmdir(2) See rmdir(2)
- on success: no parameters. - on success: no parameters.
- on error: no parameters. - on error: no parameters.
+posix.mkdir(path, mode)+ :: +fs.mkdir(path, mode)+ ::
See mkdir(2) See mkdir(2)
- on success: no parameters. - on success: no parameters.
- on error: no parameters. - on error: no parameters.
+posix.readdir(path)+ :: +fs.readdir(path)+ ::
Reads the contents of a directory. Reads the contents of a directory.
- on success: One argument, an array containing the names (strings) of the - on success: One argument, an array containing the names (strings) of the
files in the directory (excluding "." and ".."). files in the directory (excluding "." and "..").
- on error: no parameters. - on error: no parameters.
+posix.close(fd)+ :: +fs.close(fd)+ ::
See close(2) See close(2)
- on success: no parameters. - on success: no parameters.
- on error: no parameters. - on error: no parameters.
+posix.open(path, flags, mode)+:: +fs.open(path, flags, mode)+::
See open(2). The constants like +O_CREAT+ are defined at +process.O_CREAT+. See open(2). The constants like +O_CREAT+ are defined at +process.O_CREAT+.
- on success: +fd+ is given as the parameter. - on success: +fd+ is given as the parameter.
- on error: no parameters. - on error: no parameters.
+posix.write(fd, data, position, encoding)+:: +fs.write(fd, data, position, encoding)+::
Write data to the file specified by +fd+. +position+ refers to the offset Write data to the file specified by +fd+. +position+ refers to the offset
from the beginning of the file where this data should be written. If from the beginning of the file where this data should be written. If
+position+ is +null+, the data will be written at the current position. +position+ is +null+, the data will be written at the current position.
@ -726,7 +726,7 @@ See the +posix.Stats+ section below for more information.
- on success: returns an integer +written+ which specifies how many _bytes_ were written. - on success: returns an integer +written+ which specifies how many _bytes_ were written.
- on error: no parameters. - on error: no parameters.
+posix.read(fd, length, position, encoding)+:: +fs.read(fd, length, position, encoding)+::
Read data from the file specified by +fd+. Read data from the file specified by +fd+.
+ +
+length+ is an integer specifying the number of +length+ is an integer specifying the number of
@ -738,11 +738,11 @@ See the +posix.Stats+ section below for more information.
- on success: returns +data, bytes_read+, what was read from the file. - on success: returns +data, bytes_read+, what was read from the file.
- on error: no parameters. - on error: no parameters.
+posix.cat(filename, encoding="utf8")+:: +fs.cat(filename, encoding="utf8")+::
Outputs the entire contents of a file. Example: Outputs the entire contents of a file. Example:
+ +
-------------------------------- --------------------------------
posix.cat("/etc/passwd").addCallback(function (content) { fs.cat("/etc/passwd").addCallback(function (content) {
sys.puts(content); sys.puts(content);
}); });
-------------------------------- --------------------------------
@ -750,9 +750,9 @@ posix.cat("/etc/passwd").addCallback(function (content) {
- on success: returns +data+, what was read from the file. - on success: returns +data+, what was read from the file.
- on error: no parameters. - on error: no parameters.
==== +posix.Stats+ ==== +fs.Stats+
Objects returned from +posix.stat()+ are of this type. Objects returned from +fs.stat()+ are of this type.
+stats.isFile()+:: +stats.isFile()+::

14
lib/file.js

@ -1,4 +1,4 @@
var posix = require("./posix"); var fs = require("./fs");
var events = require('events'); var events = require('events');
/*jslint onevar: true, undef: true, eqeqeq: true, plusplus: true, regexp: true, newcap: true, immed: true */ /*jslint onevar: true, undef: true, eqeqeq: true, plusplus: true, regexp: true, newcap: true, immed: true */
/*globals exports, node, __filename */ /*globals exports, node, __filename */
@ -17,24 +17,24 @@ function debugObject (obj) {
} }
} }
exports.read = posix.cat; exports.read = fs.cat;
exports.write = function (filename, data, encoding) { exports.write = function (filename, data, encoding) {
var promise = new events.Promise(); var promise = new events.Promise();
encoding = encoding || "utf8"; // default to utf8 encoding = encoding || "utf8"; // default to utf8
posix.open(filename, process.O_WRONLY | process.O_TRUNC | process.O_CREAT, 0666) fs.open(filename, process.O_WRONLY | process.O_TRUNC | process.O_CREAT, 0666)
.addCallback(function (fd) { .addCallback(function (fd) {
function doWrite (_data) { function doWrite (_data) {
posix.write(fd, _data, 0, encoding) fs.write(fd, _data, 0, encoding)
.addErrback(function () { .addErrback(function () {
posix.close(fd); fs.close(fd);
promise.emitError(); promise.emitError();
}) })
.addCallback(function (written) { .addCallback(function (written) {
if (written === _data.length) { if (written === _data.length) {
posix.close(fd); fs.close(fd);
promise.emitSuccess(); promise.emitSuccess();
} else { } else {
doWrite(_data.slice(written)); doWrite(_data.slice(written));
@ -122,7 +122,7 @@ proto._maybeDispatch = function () {
if (!args[3] && (method === "read" || method === "write")) { if (!args[3] && (method === "read" || method === "write")) {
args[3] = self.encoding; args[3] = self.encoding;
} }
promise = posix[method].apply(self, args); promise = fs[method].apply(self, args);
userPromise = self.currentAction.promise; userPromise = self.currentAction.promise;

1
lib/posix.js

@ -0,0 +1 @@
throw new Error("The 'posix' module has been renamed to 'fs'");

8
src/node.js

@ -501,7 +501,7 @@ function debug (x) {
var posixModule = createInternalModule("posix", function (exports) { var fsModule = createInternalModule("fs", function (exports) {
exports.Stats = process.Stats; exports.Stats = process.Stats;
function callback (promise) { function callback (promise) {
@ -695,7 +695,7 @@ var posixModule = createInternalModule("posix", function (exports) {
}; };
}); });
var posix = posixModule.exports; var fs = fsModule.exports;
var pathModule = createInternalModule("path", function (exports) { var pathModule = createInternalModule("path", function (exports) {
@ -757,7 +757,7 @@ var pathModule = createInternalModule("path", function (exports) {
}; };
exports.exists = function (path, callback) { exports.exists = function (path, callback) {
var p = posix.stat(path); var p = fs.stat(path);
p.addCallback(function () { callback(true); }); p.addCallback(function () { callback(true); });
p.addErrback(function () { callback(false); }); p.addErrback(function () { callback(false); });
}; };
@ -927,7 +927,7 @@ function cat (id, loadPromise) {
loadPromise.emitError(new Error("could not load core module \"http\"")); loadPromise.emitError(new Error("could not load core module \"http\""));
}); });
} else { } else {
promise = posix.cat(id); promise = fs.cat(id);
} }
return promise; return promise;

2
test/mjsunit/common.js

@ -11,5 +11,5 @@ var sys = require("sys");
process.mixin(exports, sys); process.mixin(exports, sys);
exports.assert = require('assert'); exports.assert = require('assert');
exports.posix = require("posix"); exports.fs = require("fs");
exports.path = path; exports.path = path;

4
test/mjsunit/test-buffered-file.js

@ -16,7 +16,7 @@ setTimeout(function () {
file.write("world\n"); file.write("world\n");
file.close().addCallback(function () { file.close().addCallback(function () {
error("file closed..."); error("file closed...");
var out = posix.cat(testTxt).wait(); var out = fs.cat(testTxt).wait();
print("the file contains: "); print("the file contains: ");
p(out); p(out);
assert.equal("hello\nworld\nhello\nworld\n", out); assert.equal("hello\nworld\nhello\nworld\n", out);
@ -24,7 +24,7 @@ setTimeout(function () {
file2.read(5).addCallback(function (data) { file2.read(5).addCallback(function (data) {
puts("read(5): " + JSON.stringify(data)); puts("read(5): " + JSON.stringify(data));
assert.equal("hello", data); assert.equal("hello", data);
posix.unlink(testTxt).addCallback(function () { fs.unlink(testTxt).addCallback(function () {
fileUnlinked = true; fileUnlinked = true;
}); });
}); });

20
test/mjsunit/test-eio-race.js

@ -2,18 +2,18 @@ process.mixin(require("./common"));
var var
count = 100, count = 100,
posix = require('posix'); fs = require('fs');
function tryToKillEventLoop() { function tryToKillEventLoop() {
puts('trying to kill event loop ...'); puts('trying to kill event loop ...');
posix.stat(__filename) fs.stat(__filename)
.addCallback(function() { .addCallback(function() {
puts('first posix.stat succeeded ...'); puts('first fs.stat succeeded ...');
posix.stat(__filename) fs.stat(__filename)
.addCallback(function() { .addCallback(function() {
puts('second posix.stat succeeded ...'); puts('second fs.stat succeeded ...');
puts('could not kill event loop, retrying...'); puts('could not kill event loop, retrying...');
setTimeout(function () { setTimeout(function () {
@ -25,26 +25,26 @@ function tryToKillEventLoop() {
}, 1); }, 1);
}) })
.addErrback(function() { .addErrback(function() {
throw new Exception('second posix.stat failed') throw new Exception('second fs.stat failed')
}) })
}) })
.addErrback(function() { .addErrback(function() {
throw new Exception('first posix.stat failed') throw new Exception('first fs.stat failed')
}); });
} }
// Generate a lot of thread pool events // Generate a lot of thread pool events
var pos = 0; var pos = 0;
posix.open('/dev/zero', process.O_RDONLY, 0666).addCallback(function (rd) { fs.open('/dev/zero', process.O_RDONLY, 0666).addCallback(function (rd) {
function readChunk () { function readChunk () {
posix.read(rd, 1024, pos, 'binary').addCallback(function (chunk, bytesRead) { fs.read(rd, 1024, pos, 'binary').addCallback(function (chunk, bytesRead) {
if (chunk) { if (chunk) {
pos += bytesRead; pos += bytesRead;
//puts(pos); //puts(pos);
readChunk(); readChunk();
} else { } else {
posix.close(rd); fs.close(rd);
throw new Exception(BIG_FILE+' should not end before the issue shows up'); throw new Exception(BIG_FILE+' should not end before the issue shows up');
} }
}).addErrback(function () { }).addErrback(function () {

4
test/mjsunit/test-eio-race2.js

@ -1,6 +1,6 @@
process.mixin(require("./common")); process.mixin(require("./common"));
var testTxt = path.join(fixturesDir, "x.txt"); var testTxt = path.join(fixturesDir, "x.txt");
var posix = require('posix'); var fs = require('fs');
setTimeout(function () { setTimeout(function () {
// put this in a timeout, just so it doesn't get bunched up with the // put this in a timeout, just so it doesn't get bunched up with the
@ -8,7 +8,7 @@ setTimeout(function () {
N = 30; N = 30;
for (var i=0; i < N; i++) { for (var i=0; i < N; i++) {
puts("start " + i); puts("start " + i);
posix.cat(testTxt).addCallback(function(data) { fs.cat(testTxt).addCallback(function(data) {
puts("finish"); puts("finish");
}).addErrback(function (e) { }).addErrback(function (e) {
puts("error! " + e); puts("error! " + e);

4
test/mjsunit/test-eio-race3.js

@ -2,10 +2,10 @@ process.mixin(require("./common"));
puts('first stat ...'); puts('first stat ...');
posix.stat(__filename) fs.stat(__filename)
.addCallback( function(stats) { .addCallback( function(stats) {
puts('second stat ...'); puts('second stat ...');
posix.stat(__filename) fs.stat(__filename)
.timeout(1000) .timeout(1000)
.wait(); .wait();

2
test/mjsunit/test-eio-race4.js

@ -4,7 +4,7 @@ var N = 100;
var j = 0; var j = 0;
for (var i = 0; i < N; i++) { for (var i = 0; i < N; i++) {
posix.stat("does-not-exist-" + i) // these files don't exist fs.stat("does-not-exist-" + i) // these files don't exist
.addErrback(function (e) { .addErrback(function (e) {
j++; // only makes it to about 17 j++; // only makes it to about 17
puts("finish " + j); puts("finish " + j);

2
test/mjsunit/test-file-cat-noexist.js

@ -2,7 +2,7 @@ process.mixin(require("./common"));
var got_error = false; var got_error = false;
var filename = path.join(fixturesDir, "does_not_exist.txt"); var filename = path.join(fixturesDir, "does_not_exist.txt");
var promise = posix.cat(filename, "raw"); var promise = fs.cat(filename, "raw");
promise.addCallback(function (content) { promise.addCallback(function (content) {
debug("cat returned some content: " + content); debug("cat returned some content: " + content);

4
test/mjsunit/test-fs-stat.js

@ -4,7 +4,7 @@ var got_error = false;
var success_count = 0; var success_count = 0;
var stats; var stats;
var promise = posix.stat("."); var promise = fs.stat(".");
promise.addCallback(function (_stats) { promise.addCallback(function (_stats) {
stats = _stats; stats = _stats;
@ -17,7 +17,7 @@ promise.addErrback(function () {
}); });
puts("stating: " + __filename); puts("stating: " + __filename);
posix.stat(__filename).addCallback(function (s) { fs.stat(__filename).addCallback(function (s) {
p(s); p(s);
success_count++; success_count++;

10
test/mjsunit/test-fs-write.js

@ -4,12 +4,12 @@ var fn = path.join(fixturesDir, "write.txt");
var expected = "hello"; var expected = "hello";
var found; var found;
posix.open(fn, process.O_WRONLY | process.O_TRUNC | process.O_CREAT, 0644).addCallback(function (file) { fs.open(fn, process.O_WRONLY | process.O_TRUNC | process.O_CREAT, 0644).addCallback(function (file) {
posix.write(file, expected, 0, "utf8").addCallback(function() { fs.write(file, expected, 0, "utf8").addCallback(function() {
posix.close(file).addCallback(function() { fs.close(file).addCallback(function() {
posix.cat(fn, process.UTF8).addCallback(function(contents) { fs.cat(fn, process.UTF8).addCallback(function(contents) {
found = contents; found = contents;
posix.unlink(fn).wait(); fs.unlink(fn).wait();
}); });
}); });
}); });

6
test/mjsunit/test-http-tls.js

@ -21,9 +21,9 @@ var responses_sent = 0;
var responses_recvd = 0; var responses_recvd = 0;
var body0 = ""; var body0 = "";
var body1 = ""; var body1 = "";
var caPem = posix.cat(fixturesDir+"/test_ca.pem").wait(); var caPem = fs.cat(fixturesDir+"/test_ca.pem").wait();
var certPem = posix.cat(fixturesDir+"/test_cert.pem").wait(); var certPem = fs.cat(fixturesDir+"/test_cert.pem").wait();
var keyPem = posix.cat(fixturesDir+"/test_key.pem").wait(); var keyPem = fs.cat(fixturesDir+"/test_key.pem").wait();
var http_server=http.createServer(function (req, res) { var http_server=http.createServer(function (req, res) {

4
test/mjsunit/test-mkdir-rmdir.js

@ -7,10 +7,10 @@ var d = path.join(fixtures, "dir");
var mkdir_error = false; var mkdir_error = false;
var rmdir_error = false; var rmdir_error = false;
posix.mkdir(d, 0x666).addCallback(function () { fs.mkdir(d, 0x666).addCallback(function () {
puts("mkdir okay!"); puts("mkdir okay!");
posix.rmdir(d).addCallback(function () { fs.rmdir(d).addCallback(function () {
puts("rmdir okay!"); puts("rmdir okay!");
}).addErrback(function (e) { }).addErrback(function (e) {

2
test/mjsunit/test-readdir.js

@ -2,7 +2,7 @@ process.mixin(require("./common"));
var got_error = false; var got_error = false;
var promise = posix.readdir(fixturesDir); var promise = fs.readdir(fixturesDir);
puts("readdir " + fixturesDir); puts("readdir " + fixturesDir);
promise.addCallback(function (files) { promise.addCallback(function (files) {

2
test/mjsunit/test-sync-cat.js

@ -2,4 +2,4 @@ process.mixin(require('./common'));
var fixture = path.join(__dirname, "fixtures/x.txt"); var fixture = path.join(__dirname, "fixtures/x.txt");
assert.equal("xyz\n", posix.catSync(fixture)); assert.equal("xyz\n", fs.catSync(fixture));

8
test/mjsunit/test-tcp-tls.js

@ -1,6 +1,6 @@
process.mixin(require("./common")); process.mixin(require("./common"));
tcp = require("tcp"); tcp = require("tcp");
posix=require("posix"); fs=require("fs");
var tests_run = 0; var tests_run = 0;
@ -105,9 +105,9 @@ try {
} }
if (have_tls) { if (have_tls) {
var caPem = posix.cat(fixturesDir+"/test_ca.pem").wait(); var caPem = fs.cat(fixturesDir+"/test_ca.pem").wait();
var certPem = posix.cat(fixturesDir+"/test_cert.pem").wait(); var certPem = fs.cat(fixturesDir+"/test_cert.pem").wait();
var keyPem = posix.cat(fixturesDir+"/test_key.pem").wait(); var keyPem = fs.cat(fixturesDir+"/test_key.pem").wait();
/* All are run at once, so run on different ports */ /* All are run at once, so run on different ports */
tlsTest(20443, "localhost", caPem, keyPem, certPem); tlsTest(20443, "localhost", caPem, keyPem, certPem);

Loading…
Cancel
Save