Commit 50791fa

Browse files
hkleungaiaduh95
hkleungai
authored and
aduh95
committed
doc,test: widen fsPromises.appendFile()'s data type, add missing tests
From lib/internal/fs/promises.js, one can see fsPromises.appendFile() is simply a wrapper on fsPromises.writeFile(). Hence if writeFile() can take non-buffer data argument, so can appendFile() too. To justify the doc change, I have also restuctured the relevant tests, to enhance the test coverage. They now includes the below test cases consistently. - await do(Append|Write)Buffer(); - await do(Append|Write)BufferAndCancel(); - await do(Append|Write)String(); - await do(Append|Write)Stream(); - await do(Append|Write)StreamWithCancel(); - await do(Append|Write)Iterable(); - await do(Append|Write)InvalidIterable(); - await do(Append|Write)IterableWithEncoding(); - await do(Append|Write)BufferIterable(); - await do(Append|Write)AsyncIterable(); - await do(Append|Write)LargeIterable(); - await do(Append|Write)InvalidValues(); - await do(Append|Write)TypedArrays(); Note that test/parallel/test-fs-promises-writefile-typedarray.js is subsumed by test/parallel/test-fs-promises-file-handle-writeFile.js, and test/parallel/test-fs-promises-writefile-with-fd.js becomes a subcase in test/parallel/test-fs-promises-file-handle-writeFile.js. Refs: #41677 Signed-off-by: Jimmy Leung <mingfamily@hotmail.com.hk> PR-URL: #64279 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: René <contact.9a5d6388@renegade334.me.uk>
1 parent 6b09d30 commit 50791fa

7 files changed

Lines changed: 542 additions & 134 deletions

‎doc/api/fs.md‎

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -196,7 +196,7 @@ changes:
196196
strings anymore.
197197
-->
198198

199-
*`data` {string|Buffer|TypedArray|DataView|AsyncIterable|Iterable|Stream}
199+
*`data` {string|Buffer|TypedArray|DataView|AsyncIterable|Iterable}
200200
*`options` {Object|string}
201201
*`encoding` {string|null} **Default:**`'utf8'`
202202
*`signal` {AbortSignal|undefined} allows aborting an in-progress writeFile. **Default:**`undefined`
@@ -1003,7 +1003,7 @@ changes:
10031003
strings anymore.
10041004
-->
10051005
1006-
* `data` {string|Buffer|TypedArray|DataView|AsyncIterable|Iterable|Stream}
1006+
* `data` {string|Buffer|TypedArray|DataView|AsyncIterable|Iterable}
10071007
* `options` {Object|string}
10081008
* `encoding` {string|null} The expected character encoding when `data` is a
10091009
string. **Default:** `'utf8'`
@@ -1233,10 +1233,15 @@ changes:
12331233
- v20.10.0
12341234
pr-url: https://github.com/nodejs/node/pull/50095
12351235
description: The `flush` option is now supported.
1236+
- version:
1237+
- v15.14.0
1238+
- v14.18.0
1239+
pr-url: https://github.com/nodejs/node/pull/37490
1240+
description: The `data` argument supports `AsyncIterable`, `Iterable`, and `Stream`.
12361241
-->
12371242
12381243
* `path` {string|Buffer|URL|FileHandle} filename or {FileHandle}
1239-
* `data` {string|Buffer}
1244+
* `data` {string|Buffer|TypedArray|DataView|AsyncIterable|Iterable}
12401245
* `options` {Object|string}
12411246
* `encoding` {string|null} **Default:** `'utf8'`
12421247
* `mode` {integer} **Default:** `0o666`
@@ -1246,7 +1251,7 @@ changes:
12461251
* Returns: {Promise} Fulfills with `undefined` upon success.
12471252
12481253
Asynchronously append data to a file, creating the file if it does not yet
1249-
exist. `data` can be a stringor a {Buffer}.
1254+
`data` can be a string, a buffer, an {AsyncIterable}, or an {Iterable} object.
12501255
12511256
If `options` is a string, then it specifies the `encoding`.
12521257
@@ -2255,7 +2260,7 @@ changes:
22552260
-->
22562261
22572262
* `file` {string|Buffer|URL|FileHandle} filename or `FileHandle`
2258-
* `data` {string|Buffer|TypedArray|DataView|AsyncIterable|Iterable|Stream}
2263+
* `data` {string|Buffer|TypedArray|DataView|AsyncIterable|Iterable}
22592264
* `options` {Object|string}
22602265
* `encoding` {string|null} **Default:** `'utf8'`
22612266
* `mode` {integer} **Default:** `0o666`

‎test/parallel/test-fs-promises-appendfile.js‎

Lines changed: 191 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,191 @@
1+
'use strict';
2+
3+
constcommon=require('../common');
4+
constfs=require('fs');
5+
constfsPromises=fs.promises;
6+
constpath=require('path');
7+
consttmpdir=require('../common/tmpdir');
8+
constassert=require('assert');
9+
consttmpDir=tmpdir.path;
10+
const{ Readable }=require('stream');
11+
12+
tmpdir.refresh();
13+
14+
constbuffer=Buffer.from('abc'.repeat(1000));
15+
conststream=Readable.from(['a','b','c']);
16+
conststream2=Readable.from(['ümlaut',' ','sechzig']);
17+
constiterable={
18+
expected: 'abc',
19+
*[Symbol.iterator](){
20+
yield'a';
21+
yield'b';
22+
yield'c';
23+
}
24+
};
25+
26+
constveryLargeIterable={
27+
expected: 'dogs running'.repeat(512*1024),
28+
*[Symbol.iterator](){
29+
yieldBuffer.from('dogs running'.repeat(512*1024),'utf8');
30+
}
31+
};
32+
33+
functioniterableWith(value){
34+
return{
35+
*[Symbol.iterator](){
36+
yieldvalue;
37+
}
38+
};
39+
}
40+
constbufferIterable={
41+
expected: 'abc',
42+
*[Symbol.iterator](){
43+
yieldBuffer.from('a');
44+
yieldBuffer.from('b');
45+
yieldBuffer.from('c');
46+
}
47+
};
48+
constasyncIterable={
49+
expected: 'abc',
50+
async*[Symbol.asyncIterator](){
51+
yield'a';
52+
yield'b';
53+
yield'c';
54+
}
55+
};
56+
57+
letcounter=0;
58+
59+
asyncfunctiondoAppendString(){
60+
conststring='x~yz'.repeat(100);
61+
constdest=path.resolve(tmpDir,`tmp-${counter++}.txt`);
62+
awaitfsPromises.appendFile(dest,string);
63+
constdata=fs.readFileSync(dest);
64+
conststringAsBuffer=Buffer.from(string,'utf8');
65+
assert.deepStrictEqual(stringAsBuffer,data);
66+
}
67+
68+
asyncfunctiondoAppendBuffer(){
69+
constdest=path.resolve(tmpDir,`tmp-${counter++}.txt`);
70+
awaitfsPromises.appendFile(dest,buffer);
71+
constdata=fs.readFileSync(dest);
72+
assert.deepStrictEqual(data,buffer);
73+
}
74+
75+
asyncfunctiondoAppendStream(){
76+
constdest=path.resolve(tmpDir,`tmp-${counter++}.txt`);
77+
awaitfsPromises.appendFile(dest,stream);
78+
constexpected='abc';
79+
constdata=fs.readFileSync(dest,'utf-8');
80+
assert.deepStrictEqual(data,expected);
81+
}
82+
83+
asyncfunctiondoAppendStreamWithCancel(){
84+
constdest=path.resolve(tmpDir,`tmp-${counter++}.txt`);
85+
constcontroller=newAbortController();
86+
const{ signal }=controller;
87+
process.nextTick(()=>controller.abort());
88+
awaitassert.rejects(
89+
fsPromises.appendFile(dest,stream,{ signal }),
90+
{name: 'AbortError'}
91+
);
92+
}
93+
94+
asyncfunctiondoAppendIterable(){
95+
constdest=path.resolve(tmpDir,`tmp-${counter++}.txt`);
96+
awaitfsPromises.appendFile(dest,iterable);
97+
constdata=fs.readFileSync(dest,'utf-8');
98+
assert.deepStrictEqual(data,iterable.expected);
99+
}
100+
101+
asyncfunctiondoAppendInvalidIterable(){
102+
constdest=path.resolve(tmpDir,`tmp-${counter++}.txt`);
103+
awaitPromise.all(
104+
[42,42n,{},Symbol('42'),true,undefined,null,NaN].map((value)=>
105+
assert.rejects(fsPromises.appendFile(dest,iterableWith(value)),{
106+
code: 'ERR_INVALID_ARG_TYPE',
107+
})
108+
)
109+
);
110+
}
111+
112+
asyncfunctiondoAppendIterableWithEncoding(){
113+
constdest=path.resolve(tmpDir,`tmp-${counter++}.txt`);
114+
awaitfsPromises.appendFile(dest,stream2,'latin1');
115+
constexpected='ümlaut sechzig';
116+
constdata=fs.readFileSync(dest,'latin1');
117+
assert.deepStrictEqual(data,expected);
118+
}
119+
120+
asyncfunctiondoAppendBufferIterable(){
121+
constdest=path.resolve(tmpDir,`tmp-${counter++}.txt`);
122+
awaitfsPromises.appendFile(dest,bufferIterable);
123+
constdata=fs.readFileSync(dest,'utf-8');
124+
assert.deepStrictEqual(data,bufferIterable.expected);
125+
}
126+
127+
asyncfunctiondoAppendAsyncIterable(){
128+
constdest=path.resolve(tmpDir,`tmp-${counter++}.txt`);
129+
awaitfsPromises.appendFile(dest,asyncIterable);
130+
constdata=fs.readFileSync(dest,'utf-8');
131+
assert.deepStrictEqual(data,asyncIterable.expected);
132+
}
133+
134+
asyncfunctiondoAppendLargeIterable(){
135+
constdest=path.resolve(tmpDir,`tmp-${counter++}.txt`);
136+
awaitfsPromises.appendFile(dest,veryLargeIterable);
137+
constdata=fs.readFileSync(dest,'utf-8');
138+
assert.deepStrictEqual(data,veryLargeIterable.expected);
139+
}
140+
141+
asyncfunctiondoAppendInvalidValues(){
142+
constdest=path.resolve(tmpDir,`tmp-${counter++}.txt`);
143+
awaitPromise.all(
144+
[42,42n,{},Symbol('42'),true,undefined,null,NaN].map((value)=>
145+
assert.rejects(fsPromises.appendFile(dest,value),{
146+
code: 'ERR_INVALID_ARG_TYPE',
147+
})
148+
)
149+
);
150+
}
151+
152+
asyncfunctiondoAppendBufferAndCancel(){
153+
constdest=path.resolve(tmpDir,`tmp-${counter++}.txt`);
154+
constcontroller=newAbortController();
155+
const{ signal }=controller;
156+
process.nextTick(()=>controller.abort());
157+
awaitassert.rejects(
158+
fsPromises.appendFile(dest,buffer,{ signal }),
159+
{name: 'AbortError'}
160+
);
161+
}
162+
163+
asyncfunctiondoAppendTypedArrays(){
164+
for(constConstructorof[Uint8Array,Uint16Array,Uint32Array]){
165+
constdest=path.resolve(tmpDir,`tmp-${counter++}.txt`);
166+
167+
// Use a file size larger than `kReadFileMaxChunkSize`.
168+
constbuffer=Buffer.from('012'.repeat(2**14));
169+
170+
constarray=newConstructor(buffer.buffer);
171+
awaitfsPromises.appendFile(dest,array);
172+
constdata=awaitfsPromises.readFile(dest);
173+
assert.deepStrictEqual(data,buffer);
174+
}
175+
}
176+
177+
(async()=>{
178+
awaitdoAppendBuffer();
179+
awaitdoAppendBufferAndCancel();
180+
awaitdoAppendString();
181+
awaitdoAppendStream();
182+
awaitdoAppendStreamWithCancel();
183+
awaitdoAppendIterable();
184+
awaitdoAppendInvalidIterable();
185+
awaitdoAppendIterableWithEncoding();
186+
awaitdoAppendBufferIterable();
187+
awaitdoAppendAsyncIterable();
188+
awaitdoAppendLargeIterable();
189+
awaitdoAppendInvalidValues();
190+
awaitdoAppendTypedArrays();
191+
})().then(common.mustCall());

0 commit comments

Comments
 (0)
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all 
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

Skip to content
Commit 50791fa
Browse files
hkleungaiaduh95
hkleungai
authored and
aduh95
committed
doc,test: widen fsPromises.appendFile()'s data type, add missing tests
From lib/internal/fs/promises.js, one can see fsPromises.appendFile() is
simply a wrapper on fsPromises.writeFile(). Hence if writeFile() can
take non-buffer data argument, so can appendFile() too.
To justify the doc change, I have also restuctured the relevant tests,
to enhance the test coverage. They now includes the below test cases
consistently.
- await do(Append|Write)Buffer();
- await do(Append|Write)BufferAndCancel();
- await do(Append|Write)String();
- await do(Append|Write)Stream();
- await do(Append|Write)StreamWithCancel();
- await do(Append|Write)Iterable();
- await do(Append|Write)InvalidIterable();
- await do(Append|Write)IterableWithEncoding();
- await do(Append|Write)BufferIterable();
- await do(Append|Write)AsyncIterable();
- await do(Append|Write)LargeIterable();
- await do(Append|Write)InvalidValues();
- await do(Append|Write)TypedArrays();
Note that test/parallel/test-fs-promises-writefile-typedarray.js is
subsumed by test/parallel/test-fs-promises-file-handle-writeFile.js, and
test/parallel/test-fs-promises-writefile-with-fd.js becomes a subcase in
test/parallel/test-fs-promises-file-handle-writeFile.js.
Refs: #41677
Signed-off-by: Jimmy Leung <mingfamily@hotmail.com.hk>
PR-URL: #64279
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: René <contact.9a5d6388@renegade334.me.uk>
1 parent 6b09d30 commit 50791fa
7 files changed
Lines changed: 542 additions & 134 deletions
‎doc/api/fs.md‎
Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -196,7 +196,7 @@ changes:
196196
 strings anymore.
197197
-->
198198

199-
*`data` {string|Buffer|TypedArray|DataView|AsyncIterable|Iterable|Stream}
199+
*`data` {string|Buffer|TypedArray|DataView|AsyncIterable|Iterable}
200200
*`options` {Object|string}
201201
*`encoding` {string|null} **Default:**`'utf8'`
202202
*`signal` {AbortSignal|undefined} allows aborting an in-progress writeFile. **Default:**`undefined`
@@ -1003,7 +1003,7 @@ changes:
10031003
 strings anymore.
10041004
-->
10051005
1006-
* `data` {string|Buffer|TypedArray|DataView|AsyncIterable|Iterable|Stream}
1006+
* `data` {string|Buffer|TypedArray|DataView|AsyncIterable|Iterable}
10071007
* `options` {Object|string}
10081008
 * `encoding` {string|null} The expected character encoding when `data` is a
10091009
 string. **Default:** `'utf8'`
@@ -1233,10 +1233,15 @@ changes:
12331233
 - v20.10.0
12341234
 pr-url: https://github.com/nodejs/node/pull/50095
12351235
 description: The `flush` option is now supported.
1236+
 - version:
1237+
 - v15.14.0
1238+
 - v14.18.0
1239+
 pr-url: https://github.com/nodejs/node/pull/37490
1240+
 description: The `data` argument supports `AsyncIterable`, `Iterable`, and `Stream`.
12361241
-->
12371242
12381243
* `path` {string|Buffer|URL|FileHandle} filename or {FileHandle}
1239-
* `data` {string|Buffer}
1244+
* `data` {string|Buffer|TypedArray|DataView|AsyncIterable|Iterable}
12401245
* `options` {Object|string}
12411246
 * `encoding` {string|null} **Default:** `'utf8'`
12421247
 * `mode` {integer} **Default:** `0o666`
@@ -1246,7 +1251,7 @@ changes:
12461251
* Returns: {Promise} Fulfills with `undefined` upon success.
12471252
12481253
Asynchronously append data to a file, creating the file if it does not yet
1249-
exist. `data` can be a stringor a {Buffer}.
1254+
`data` can be a string, a buffer, an {AsyncIterable}, or an {Iterable} object.
12501255
12511256
If `options` is a string, then it specifies the `encoding`.
12521257
@@ -2255,7 +2260,7 @@ changes:
22552260
-->
22562261
22572262
* `file` {string|Buffer|URL|FileHandle} filename or `FileHandle`
2258-
* `data` {string|Buffer|TypedArray|DataView|AsyncIterable|Iterable|Stream}
2263+
* `data` {string|Buffer|TypedArray|DataView|AsyncIterable|Iterable}
22592264
* `options` {Object|string}
22602265
 * `encoding` {string|null} **Default:** `'utf8'`
22612266
 * `mode` {integer} **Default:** `0o666`
‎test/parallel/test-fs-promises-appendfile.js‎
Lines changed: 191 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,191 @@
1+
'use strict';
2+
3+
constcommon=require('../common');
4+
constfs=require('fs');
5+
constfsPromises=fs.promises;
6+
constpath=require('path');
7+
consttmpdir=require('../common/tmpdir');
8+
constassert=require('assert');
9+
consttmpDir=tmpdir.path;
10+
const{ Readable }=require('stream');
11+
12+
tmpdir.refresh();
13+
14+
constbuffer=Buffer.from('abc'.repeat(1000));
15+
conststream=Readable.from(['a','b','c']);
16+
conststream2=Readable.from(['ümlaut',' ','sechzig']);
17+
constiterable={
18+
expected: 'abc',
19+
*[Symbol.iterator](){
20+
yield'a';
21+
yield'b';
22+
yield'c';
23+
}
24+
};
25+
26+
constveryLargeIterable={
27+
expected: 'dogs running'.repeat(512*1024),
28+
*[Symbol.iterator](){
29+
yieldBuffer.from('dogs running'.repeat(512*1024),'utf8');
30+
}
31+
};
32+
33+
functioniterableWith(value){
34+
return{
35+
*[Symbol.iterator](){
36+
yieldvalue;
37+
}
38+
};
39+
}
40+
constbufferIterable={
41+
expected: 'abc',
42+
*[Symbol.iterator](){
43+
yieldBuffer.from('a');
44+
yieldBuffer.from('b');
45+
yieldBuffer.from('c');
46+
}
47+
};
48+
constasyncIterable={
49+
expected: 'abc',
50+
async*[Symbol.asyncIterator](){
51+
yield'a';
52+
yield'b';
53+
yield'c';
54+
}
55+
};
56+
57+
letcounter=0;
58+
59+
asyncfunctiondoAppendString(){
60+
conststring='x~yz'.repeat(100);
61+
constdest=path.resolve(tmpDir,`tmp-${counter++}.txt`);
62+
awaitfsPromises.appendFile(dest,string);
63+
constdata=fs.readFileSync(dest);
64+
conststringAsBuffer=Buffer.from(string,'utf8');
65+
assert.deepStrictEqual(stringAsBuffer,data);
66+
}
67+
68+
asyncfunctiondoAppendBuffer(){
69+
constdest=path.resolve(tmpDir,`tmp-${counter++}.txt`);
70+
awaitfsPromises.appendFile(dest,buffer);
71+
constdata=fs.readFileSync(dest);
72+
assert.deepStrictEqual(data,buffer);
73+
}
74+
75+
asyncfunctiondoAppendStream(){
76+
constdest=path.resolve(tmpDir,`tmp-${counter++}.txt`);
77+
awaitfsPromises.appendFile(dest,stream);
78+
constexpected='abc';
79+
constdata=fs.readFileSync(dest,'utf-8');
80+
assert.deepStrictEqual(data,expected);
81+
}
82+
83+
asyncfunctiondoAppendStreamWithCancel(){
84+
constdest=path.resolve(tmpDir,`tmp-${counter++}.txt`);
85+
constcontroller=newAbortController();
86+
const{ signal }=controller;
87+
process.nextTick(()=>controller.abort());
88+
awaitassert.rejects(
89+
fsPromises.appendFile(dest,stream,{ signal }),
90+
{name: 'AbortError'}
91+
);
92+
}
93+
94+
asyncfunctiondoAppendIterable(){
95+
constdest=path.resolve(tmpDir,`tmp-${counter++}.txt`);
96+
awaitfsPromises.appendFile(dest,iterable);
97+
constdata=fs.readFileSync(dest,'utf-8');
98+
assert.deepStrictEqual(data,iterable.expected);
99+
}
100+
101+
asyncfunctiondoAppendInvalidIterable(){
102+
constdest=path.resolve(tmpDir,`tmp-${counter++}.txt`);
103+
awaitPromise.all(
104+
[42,42n,{},Symbol('42'),true,undefined,null,NaN].map((value)=>
105+
assert.rejects(fsPromises.appendFile(dest,iterableWith(value)),{
106+
code: 'ERR_INVALID_ARG_TYPE',
107+
})
108+
)
109+
);
110+
}
111+
112+
asyncfunctiondoAppendIterableWithEncoding(){
113+
constdest=path.resolve(tmpDir,`tmp-${counter++}.txt`);
114+
awaitfsPromises.appendFile(dest,stream2,'latin1');
115+
constexpected='ümlaut sechzig';
116+
constdata=fs.readFileSync(dest,'latin1');
117+
assert.deepStrictEqual(data,expected);
118+
}
119+
120+
asyncfunctiondoAppendBufferIterable(){
121+
constdest=path.resolve(tmpDir,`tmp-${counter++}.txt`);
122+
awaitfsPromises.appendFile(dest,bufferIterable);
123+
constdata=fs.readFileSync(dest,'utf-8');
124+
assert.deepStrictEqual(data,bufferIterable.expected);
125+
}
126+
127+
asyncfunctiondoAppendAsyncIterable(){
128+
constdest=path.resolve(tmpDir,`tmp-${counter++}.txt`);
129+
awaitfsPromises.appendFile(dest,asyncIterable);
130+
constdata=fs.readFileSync(dest,'utf-8');
131+
assert.deepStrictEqual(data,asyncIterable.expected);
132+
}
133+
134+
asyncfunctiondoAppendLargeIterable(){
135+
constdest=path.resolve(tmpDir,`tmp-${counter++}.txt`);
136+
awaitfsPromises.appendFile(dest,veryLargeIterable);
137+
constdata=fs.readFileSync(dest,'utf-8');
138+
assert.deepStrictEqual(data,veryLargeIterable.expected);
139+
}
140+
141+
asyncfunctiondoAppendInvalidValues(){
142+
constdest=path.resolve(tmpDir,`tmp-${counter++}.txt`);
143+
awaitPromise.all(
144+
[42,42n,{},Symbol('42'),true,undefined,null,NaN].map((value)=>
145+
assert.rejects(fsPromises.appendFile(dest,value),{
146+
code: 'ERR_INVALID_ARG_TYPE',
147+
})
148+
)
149+
);
150+
}
151+
152+
asyncfunctiondoAppendBufferAndCancel(){
153+
constdest=path.resolve(tmpDir,`tmp-${counter++}.txt`);
154+
constcontroller=newAbortController();
155+
const{ signal }=controller;
156+
process.nextTick(()=>controller.abort());
157+
awaitassert.rejects(
158+
fsPromises.appendFile(dest,buffer,{ signal }),
159+
{name: 'AbortError'}
160+
);
161+
}
162+
163+
asyncfunctiondoAppendTypedArrays(){
164+
for(constConstructorof[Uint8Array,Uint16Array,Uint32Array]){
165+
constdest=path.resolve(tmpDir,`tmp-${counter++}.txt`);
166+
167+
// Use a file size larger than `kReadFileMaxChunkSize`.
168+
constbuffer=Buffer.from('012'.repeat(2**14));
169+
170+
constarray=newConstructor(buffer.buffer);
171+
awaitfsPromises.appendFile(dest,array);
172+
constdata=awaitfsPromises.readFile(dest);
173+
assert.deepStrictEqual(data,buffer);
174+
}
175+
}
176+
177+
(async()=>{
178+
awaitdoAppendBuffer();
179+
awaitdoAppendBufferAndCancel();
180+
awaitdoAppendString();
181+
awaitdoAppendStream();
182+
awaitdoAppendStreamWithCancel();
183+
awaitdoAppendIterable();
184+
awaitdoAppendInvalidIterable();
185+
awaitdoAppendIterableWithEncoding();
186+
awaitdoAppendBufferIterable();
187+
awaitdoAppendAsyncIterable();
188+
awaitdoAppendLargeIterable();
189+
awaitdoAppendInvalidValues();
190+
awaitdoAppendTypedArrays();
191+
})().then(common.mustCall());
0 commit comments
Comments
 (0)

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix");
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Commit 50791fa
Browse files
hkleungaiaduh95
hkleungai
authored and
aduh95
committed
doc,test: widen fsPromises.appendFile()'s data type, add missing tests
From lib/internal/fs/promises.js, one can see fsPromises.appendFile() is
simply a wrapper on fsPromises.writeFile(). Hence if writeFile() can
take non-buffer data argument, so can appendFile() too.
To justify the doc change, I have also restuctured the relevant tests,
to enhance the test coverage. They now includes the below test cases
consistently.
- await do(Append|Write)Buffer();
- await do(Append|Write)BufferAndCancel();
- await do(Append|Write)String();
- await do(Append|Write)Stream();
- await do(Append|Write)StreamWithCancel();
- await do(Append|Write)Iterable();
- await do(Append|Write)InvalidIterable();
- await do(Append|Write)IterableWithEncoding();
- await do(Append|Write)BufferIterable();
- await do(Append|Write)AsyncIterable();
- await do(Append|Write)LargeIterable();
- await do(Append|Write)InvalidValues();
- await do(Append|Write)TypedArrays();
Note that test/parallel/test-fs-promises-writefile-typedarray.js is
subsumed by test/parallel/test-fs-promises-file-handle-writeFile.js, and
test/parallel/test-fs-promises-writefile-with-fd.js becomes a subcase in
test/parallel/test-fs-promises-file-handle-writeFile.js.
Refs: #41677
Signed-off-by: Jimmy Leung <mingfamily@hotmail.com.hk>
PR-URL: #64279
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: René <contact.9a5d6388@renegade334.me.uk>
1 parent 6b09d30 commit 50791fa
7 files changed
Lines changed: 542 additions & 134 deletions
‎doc/api/fs.md‎
Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -196,7 +196,7 @@ changes:
196196
 strings anymore.
197197
-->
198198

199-
*`data` {string|Buffer|TypedArray|DataView|AsyncIterable|Iterable|Stream}
199+
*`data` {string|Buffer|TypedArray|DataView|AsyncIterable|Iterable}
200200
*`options` {Object|string}
201201
*`encoding` {string|null} **Default:**`'utf8'`
202202
*`signal` {AbortSignal|undefined} allows aborting an in-progress writeFile. **Default:**`undefined`
@@ -1003,7 +1003,7 @@ changes:
10031003
 strings anymore.
10041004
-->
10051005
1006-
* `data` {string|Buffer|TypedArray|DataView|AsyncIterable|Iterable|Stream}
1006+
* `data` {string|Buffer|TypedArray|DataView|AsyncIterable|Iterable}
10071007
* `options` {Object|string}
10081008
 * `encoding` {string|null} The expected character encoding when `data` is a
10091009
 string. **Default:** `'utf8'`
@@ -1233,10 +1233,15 @@ changes:
12331233
 - v20.10.0
12341234
 pr-url: https://github.com/nodejs/node/pull/50095
12351235
 description: The `flush` option is now supported.
1236+
 - version:
1237+
 - v15.14.0
1238+
 - v14.18.0
1239+
 pr-url: https://github.com/nodejs/node/pull/37490
1240+
 description: The `data` argument supports `AsyncIterable`, `Iterable`, and `Stream`.
12361241
-->
12371242
12381243
* `path` {string|Buffer|URL|FileHandle} filename or {FileHandle}
1239-
* `data` {string|Buffer}
1244+
* `data` {string|Buffer|TypedArray|DataView|AsyncIterable|Iterable}
12401245
* `options` {Object|string}
12411246
 * `encoding` {string|null} **Default:** `'utf8'`
12421247
 * `mode` {integer} **Default:** `0o666`
@@ -1246,7 +1251,7 @@ changes:
12461251
* Returns: {Promise} Fulfills with `undefined` upon success.
12471252
12481253
Asynchronously append data to a file, creating the file if it does not yet
1249-
exist. `data` can be a stringor a {Buffer}.
1254+
`data` can be a string, a buffer, an {AsyncIterable}, or an {Iterable} object.
12501255
12511256
If `options` is a string, then it specifies the `encoding`.
12521257
@@ -2255,7 +2260,7 @@ changes:
22552260
-->
22562261
22572262
* `file` {string|Buffer|URL|FileHandle} filename or `FileHandle`
2258-
* `data` {string|Buffer|TypedArray|DataView|AsyncIterable|Iterable|Stream}
2263+
* `data` {string|Buffer|TypedArray|DataView|AsyncIterable|Iterable}
22592264
* `options` {Object|string}
22602265
 * `encoding` {string|null} **Default:** `'utf8'`
22612266
 * `mode` {integer} **Default:** `0o666`
‎test/parallel/test-fs-promises-appendfile.js‎
Lines changed: 191 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,191 @@
1+
'use strict';
2+
3+
constcommon=require('../common');
4+
constfs=require('fs');
5+
constfsPromises=fs.promises;
6+
constpath=require('path');
7+
consttmpdir=require('../common/tmpdir');
8+
constassert=require('assert');
9+
consttmpDir=tmpdir.path;
10+
const{ Readable }=require('stream');
11+
12+
tmpdir.refresh();
13+
14+
constbuffer=Buffer.from('abc'.repeat(1000));
15+
conststream=Readable.from(['a','b','c']);
16+
conststream2=Readable.from(['ümlaut',' ','sechzig']);
17+
constiterable={
18+
expected: 'abc',
19+
*[Symbol.iterator](){
20+
yield'a';
21+
yield'b';
22+
yield'c';
23+
}
24+
};
25+
26+
constveryLargeIterable={
27+
expected: 'dogs running'.repeat(512*1024),
28+
*[Symbol.iterator](){
29+
yieldBuffer.from('dogs running'.repeat(512*1024),'utf8');
30+
}
31+
};
32+
33+
functioniterableWith(value){
34+
return{
35+
*[Symbol.iterator](){
36+
yieldvalue;
37+
}
38+
};
39+
}
40+
constbufferIterable={
41+
expected: 'abc',
42+
*[Symbol.iterator](){
43+
yieldBuffer.from('a');
44+
yieldBuffer.from('b');
45+
yieldBuffer.from('c');
46+
}
47+
};
48+
constasyncIterable={
49+
expected: 'abc',
50+
async*[Symbol.asyncIterator](){
51+
yield'a';
52+
yield'b';
53+
yield'c';
54+
}
55+
};
56+
57+
letcounter=0;
58+
59+
asyncfunctiondoAppendString(){
60+
conststring='x~yz'.repeat(100);
61+
constdest=path.resolve(tmpDir,`tmp-${counter++}.txt`);
62+
awaitfsPromises.appendFile(dest,string);
63+
constdata=fs.readFileSync(dest);
64+
conststringAsBuffer=Buffer.from(string,'utf8');
65+
assert.deepStrictEqual(stringAsBuffer,data);
66+
}
67+
68+
asyncfunctiondoAppendBuffer(){
69+
constdest=path.resolve(tmpDir,`tmp-${counter++}.txt`);
70+
awaitfsPromises.appendFile(dest,buffer);
71+
constdata=fs.readFileSync(dest);
72+
assert.deepStrictEqual(data,buffer);
73+
}
74+
75+
asyncfunctiondoAppendStream(){
76+
constdest=path.resolve(tmpDir,`tmp-${counter++}.txt`);
77+
awaitfsPromises.appendFile(dest,stream);
78+
constexpected='abc';
79+
constdata=fs.readFileSync(dest,'utf-8');
80+
assert.deepStrictEqual(data,expected);
81+
}
82+
83+
asyncfunctiondoAppendStreamWithCancel(){
84+
constdest=path.resolve(tmpDir,`tmp-${counter++}.txt`);
85+
constcontroller=newAbortController();
86+
const{ signal }=controller;
87+
process.nextTick(()=>controller.abort());
88+
awaitassert.rejects(
89+
fsPromises.appendFile(dest,stream,{ signal }),
90+
{name: 'AbortError'}
91+
);
92+
}
93+
94+
asyncfunctiondoAppendIterable(){
95+
constdest=path.resolve(tmpDir,`tmp-${counter++}.txt`);
96+
awaitfsPromises.appendFile(dest,iterable);
97+
constdata=fs.readFileSync(dest,'utf-8');
98+
assert.deepStrictEqual(data,iterable.expected);
99+
}
100+
101+
asyncfunctiondoAppendInvalidIterable(){
102+
constdest=path.resolve(tmpDir,`tmp-${counter++}.txt`);
103+
awaitPromise.all(
104+
[42,42n,{},Symbol('42'),true,undefined,null,NaN].map((value)=>
105+
assert.rejects(fsPromises.appendFile(dest,iterableWith(value)),{
106+
code: 'ERR_INVALID_ARG_TYPE',
107+
})
108+
)
109+
);
110+
}
111+
112+
asyncfunctiondoAppendIterableWithEncoding(){
113+
constdest=path.resolve(tmpDir,`tmp-${counter++}.txt`);
114+
awaitfsPromises.appendFile(dest,stream2,'latin1');
115+
constexpected='ümlaut sechzig';
116+
constdata=fs.readFileSync(dest,'latin1');
117+
assert.deepStrictEqual(data,expected);
118+
}
119+
120+
asyncfunctiondoAppendBufferIterable(){
121+
constdest=path.resolve(tmpDir,`tmp-${counter++}.txt`);
122+
awaitfsPromises.appendFile(dest,bufferIterable);
123+
constdata=fs.readFileSync(dest,'utf-8');
124+
assert.deepStrictEqual(data,bufferIterable.expected);
125+
}
126+
127+
asyncfunctiondoAppendAsyncIterable(){
128+
constdest=path.resolve(tmpDir,`tmp-${counter++}.txt`);
129+
awaitfsPromises.appendFile(dest,asyncIterable);
130+
constdata=fs.readFileSync(dest,'utf-8');
131+
assert.deepStrictEqual(data,asyncIterable.expected);
132+
}
133+
134+
asyncfunctiondoAppendLargeIterable(){
135+
constdest=path.resolve(tmpDir,`tmp-${counter++}.txt`);
136+
awaitfsPromises.appendFile(dest,veryLargeIterable);
137+
constdata=fs.readFileSync(dest,'utf-8');
138+
assert.deepStrictEqual(data,veryLargeIterable.expected);
139+
}
140+
141+
asyncfunctiondoAppendInvalidValues(){
142+
constdest=path.resolve(tmpDir,`tmp-${counter++}.txt`);
143+
awaitPromise.all(
144+
[42,42n,{},Symbol('42'),true,undefined,null,NaN].map((value)=>
145+
assert.rejects(fsPromises.appendFile(dest,value),{
146+
code: 'ERR_INVALID_ARG_TYPE',
147+
})
148+
)
149+
);
150+
}
151+
152+
asyncfunctiondoAppendBufferAndCancel(){
153+
constdest=path.resolve(tmpDir,`tmp-${counter++}.txt`);
154+
constcontroller=newAbortController();
155+
const{ signal }=controller;
156+
process.nextTick(()=>controller.abort());
157+
awaitassert.rejects(
158+
fsPromises.appendFile(dest,buffer,{ signal }),
159+
{name: 'AbortError'}
160+
);
161+
}
162+
163+
asyncfunctiondoAppendTypedArrays(){
164+
for(constConstructorof[Uint8Array,Uint16Array,Uint32Array]){
165+
constdest=path.resolve(tmpDir,`tmp-${counter++}.txt`);
166+
167+
// Use a file size larger than `kReadFileMaxChunkSize`.
168+
constbuffer=Buffer.from('012'.repeat(2**14));
169+
170+
constarray=newConstructor(buffer.buffer);
171+
awaitfsPromises.appendFile(dest,array);
172+
constdata=awaitfsPromises.readFile(dest);
173+
assert.deepStrictEqual(data,buffer);
174+
}
175+
}
176+
177+
(async()=>{
178+
awaitdoAppendBuffer();
179+
awaitdoAppendBufferAndCancel();
180+
awaitdoAppendString();
181+
awaitdoAppendStream();
182+
awaitdoAppendStreamWithCancel();
183+
awaitdoAppendIterable();
184+
awaitdoAppendInvalidIterable();
185+
awaitdoAppendIterableWithEncoding();
186+
awaitdoAppendBufferIterable();
187+
awaitdoAppendAsyncIterable();
188+
awaitdoAppendLargeIterable();
189+
awaitdoAppendInvalidValues();
190+
awaitdoAppendTypedArrays();
191+
})().then(common.mustCall());
0 commit comments
Comments
 (0)

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms");
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Commit 50791fa
Browse files
hkleungaiaduh95
hkleungai
authored and
aduh95
committed
doc,test: widen fsPromises.appendFile()'s data type, add missing tests
From lib/internal/fs/promises.js, one can see fsPromises.appendFile() is
simply a wrapper on fsPromises.writeFile(). Hence if writeFile() can
take non-buffer data argument, so can appendFile() too.
To justify the doc change, I have also restuctured the relevant tests,
to enhance the test coverage. They now includes the below test cases
consistently.
- await do(Append|Write)Buffer();
- await do(Append|Write)BufferAndCancel();
- await do(Append|Write)String();
- await do(Append|Write)Stream();
- await do(Append|Write)StreamWithCancel();
- await do(Append|Write)Iterable();
- await do(Append|Write)InvalidIterable();
- await do(Append|Write)IterableWithEncoding();
- await do(Append|Write)BufferIterable();
- await do(Append|Write)AsyncIterable();
- await do(Append|Write)LargeIterable();
- await do(Append|Write)InvalidValues();
- await do(Append|Write)TypedArrays();
Note that test/parallel/test-fs-promises-writefile-typedarray.js is
subsumed by test/parallel/test-fs-promises-file-handle-writeFile.js, and
test/parallel/test-fs-promises-writefile-with-fd.js becomes a subcase in
test/parallel/test-fs-promises-file-handle-writeFile.js.
Refs: #41677
Signed-off-by: Jimmy Leung <mingfamily@hotmail.com.hk>
PR-URL: #64279
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: René <contact.9a5d6388@renegade334.me.uk>
1 parent 6b09d30 commit 50791fa
7 files changed
Lines changed: 542 additions & 134 deletions
‎doc/api/fs.md‎
Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -196,7 +196,7 @@ changes:
196196
 strings anymore.
197197
-->
198198

199-
*`data` {string|Buffer|TypedArray|DataView|AsyncIterable|Iterable|Stream}
199+
*`data` {string|Buffer|TypedArray|DataView|AsyncIterable|Iterable}
200200
*`options` {Object|string}
201201
*`encoding` {string|null} **Default:**`'utf8'`
202202
*`signal` {AbortSignal|undefined} allows aborting an in-progress writeFile. **Default:**`undefined`
@@ -1003,7 +1003,7 @@ changes:
10031003
 strings anymore.
10041004
-->
10051005
1006-
* `data` {string|Buffer|TypedArray|DataView|AsyncIterable|Iterable|Stream}
1006+
* `data` {string|Buffer|TypedArray|DataView|AsyncIterable|Iterable}
10071007
* `options` {Object|string}
10081008
 * `encoding` {string|null} The expected character encoding when `data` is a
10091009
 string. **Default:** `'utf8'`
@@ -1233,10 +1233,15 @@ changes:
12331233
 - v20.10.0
12341234
 pr-url: https://github.com/nodejs/node/pull/50095
12351235
 description: The `flush` option is now supported.
1236+
 - version:
1237+
 - v15.14.0
1238+
 - v14.18.0
1239+
 pr-url: https://github.com/nodejs/node/pull/37490
1240+
 description: The `data` argument supports `AsyncIterable`, `Iterable`, and `Stream`.
12361241
-->
12371242
12381243
* `path` {string|Buffer|URL|FileHandle} filename or {FileHandle}
1239-
* `data` {string|Buffer}
1244+
* `data` {string|Buffer|TypedArray|DataView|AsyncIterable|Iterable}
12401245
* `options` {Object|string}
12411246
 * `encoding` {string|null} **Default:** `'utf8'`
12421247
 * `mode` {integer} **Default:** `0o666`
@@ -1246,7 +1251,7 @@ changes:
12461251
* Returns: {Promise} Fulfills with `undefined` upon success.
12471252
12481253
Asynchronously append data to a file, creating the file if it does not yet
1249-
exist. `data` can be a stringor a {Buffer}.
1254+
`data` can be a string, a buffer, an {AsyncIterable}, or an {Iterable} object.
12501255
12511256
If `options` is a string, then it specifies the `encoding`.
12521257
@@ -2255,7 +2260,7 @@ changes:
22552260
-->
22562261
22572262
* `file` {string|Buffer|URL|FileHandle} filename or `FileHandle`
2258-
* `data` {string|Buffer|TypedArray|DataView|AsyncIterable|Iterable|Stream}
2263+
* `data` {string|Buffer|TypedArray|DataView|AsyncIterable|Iterable}
22592264
* `options` {Object|string}
22602265
 * `encoding` {string|null} **Default:** `'utf8'`
22612266
 * `mode` {integer} **Default:** `0o666`
‎test/parallel/test-fs-promises-appendfile.js‎
Lines changed: 191 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,191 @@
1+
'use strict';
2+
3+
constcommon=require('../common');
4+
constfs=require('fs');
5+
constfsPromises=fs.promises;
6+
constpath=require('path');
7+
consttmpdir=require('../common/tmpdir');
8+
constassert=require('assert');
9+
consttmpDir=tmpdir.path;
10+
const{ Readable }=require('stream');
11+
12+
tmpdir.refresh();
13+
14+
constbuffer=Buffer.from('abc'.repeat(1000));
15+
conststream=Readable.from(['a','b','c']);
16+
conststream2=Readable.from(['ümlaut',' ','sechzig']);
17+
constiterable={
18+
expected: 'abc',
19+
*[Symbol.iterator](){
20+
yield'a';
21+
yield'b';
22+
yield'c';
23+
}
24+
};
25+
26+
constveryLargeIterable={
27+
expected: 'dogs running'.repeat(512*1024),
28+
*[Symbol.iterator](){
29+
yieldBuffer.from('dogs running'.repeat(512*1024),'utf8');
30+
}
31+
};
32+
33+
functioniterableWith(value){
34+
return{
35+
*[Symbol.iterator](){
36+
yieldvalue;
37+
}
38+
};
39+
}
40+
constbufferIterable={
41+
expected: 'abc',
42+
*[Symbol.iterator](){
43+
yieldBuffer.from('a');
44+
yieldBuffer.from('b');
45+
yieldBuffer.from('c');
46+
}
47+
};
48+
constasyncIterable={
49+
expected: 'abc',
50+
async*[Symbol.asyncIterator](){
51+
yield'a';
52+
yield'b';
53+
yield'c';
54+
}
55+
};
56+
57+
letcounter=0;
58+
59+
asyncfunctiondoAppendString(){
60+
conststring='x~yz'.repeat(100);
61+
constdest=path.resolve(tmpDir,`tmp-${counter++}.txt`);
62+
awaitfsPromises.appendFile(dest,string);
63+
constdata=fs.readFileSync(dest);
64+
conststringAsBuffer=Buffer.from(string,'utf8');
65+
assert.deepStrictEqual(stringAsBuffer,data);
66+
}
67+
68+
asyncfunctiondoAppendBuffer(){
69+
constdest=path.resolve(tmpDir,`tmp-${counter++}.txt`);
70+
awaitfsPromises.appendFile(dest,buffer);
71+
constdata=fs.readFileSync(dest);
72+
assert.deepStrictEqual(data,buffer);
73+
}
74+
75+
asyncfunctiondoAppendStream(){
76+
constdest=path.resolve(tmpDir,`tmp-${counter++}.txt`);
77+
awaitfsPromises.appendFile(dest,stream);
78+
constexpected='abc';
79+
constdata=fs.readFileSync(dest,'utf-8');
80+
assert.deepStrictEqual(data,expected);
81+
}
82+
83+
asyncfunctiondoAppendStreamWithCancel(){
84+
constdest=path.resolve(tmpDir,`tmp-${counter++}.txt`);
85+
constcontroller=newAbortController();
86+
const{ signal }=controller;
87+
process.nextTick(()=>controller.abort());
88+
awaitassert.rejects(
89+
fsPromises.appendFile(dest,stream,{ signal }),
90+
{name: 'AbortError'}
91+
);
92+
}
93+
94+
asyncfunctiondoAppendIterable(){
95+
constdest=path.resolve(tmpDir,`tmp-${counter++}.txt`);
96+
awaitfsPromises.appendFile(dest,iterable);
97+
constdata=fs.readFileSync(dest,'utf-8');
98+
assert.deepStrictEqual(data,iterable.expected);
99+
}
100+
101+
asyncfunctiondoAppendInvalidIterable(){
102+
constdest=path.resolve(tmpDir,`tmp-${counter++}.txt`);
103+
awaitPromise.all(
104+
[42,42n,{},Symbol('42'),true,undefined,null,NaN].map((value)=>
105+
assert.rejects(fsPromises.appendFile(dest,iterableWith(value)),{
106+
code: 'ERR_INVALID_ARG_TYPE',
107+
})
108+
)
109+
);
110+
}
111+
112+
asyncfunctiondoAppendIterableWithEncoding(){
113+
constdest=path.resolve(tmpDir,`tmp-${counter++}.txt`);
114+
awaitfsPromises.appendFile(dest,stream2,'latin1');
115+
constexpected='ümlaut sechzig';
116+
constdata=fs.readFileSync(dest,'latin1');
117+
assert.deepStrictEqual(data,expected);
118+
}
119+
120+
asyncfunctiondoAppendBufferIterable(){
121+
constdest=path.resolve(tmpDir,`tmp-${counter++}.txt`);
122+
awaitfsPromises.appendFile(dest,bufferIterable);
123+
constdata=fs.readFileSync(dest,'utf-8');
124+
assert.deepStrictEqual(data,bufferIterable.expected);
125+
}
126+
127+
asyncfunctiondoAppendAsyncIterable(){
128+
constdest=path.resolve(tmpDir,`tmp-${counter++}.txt`);
129+
awaitfsPromises.appendFile(dest,asyncIterable);
130+
constdata=fs.readFileSync(dest,'utf-8');
131+
assert.deepStrictEqual(data,asyncIterable.expected);
132+
}
133+
134+
asyncfunctiondoAppendLargeIterable(){
135+
constdest=path.resolve(tmpDir,`tmp-${counter++}.txt`);
136+
awaitfsPromises.appendFile(dest,veryLargeIterable);
137+
constdata=fs.readFileSync(dest,'utf-8');
138+
assert.deepStrictEqual(data,veryLargeIterable.expected);
139+
}
140+
141+
asyncfunctiondoAppendInvalidValues(){
142+
constdest=path.resolve(tmpDir,`tmp-${counter++}.txt`);
143+
awaitPromise.all(
144+
[42,42n,{},Symbol('42'),true,undefined,null,NaN].map((value)=>
145+
assert.rejects(fsPromises.appendFile(dest,value),{
146+
code: 'ERR_INVALID_ARG_TYPE',
147+
})
148+
)
149+
);
150+
}
151+
152+
asyncfunctiondoAppendBufferAndCancel(){
153+
constdest=path.resolve(tmpDir,`tmp-${counter++}.txt`);
154+
constcontroller=newAbortController();
155+
const{ signal }=controller;
156+
process.nextTick(()=>controller.abort());
157+
awaitassert.rejects(
158+
fsPromises.appendFile(dest,buffer,{ signal }),
159+
{name: 'AbortError'}
160+
);
161+
}
162+
163+
asyncfunctiondoAppendTypedArrays(){
164+
for(constConstructorof[Uint8Array,Uint16Array,Uint32Array]){
165+
constdest=path.resolve(tmpDir,`tmp-${counter++}.txt`);
166+
167+
// Use a file size larger than `kReadFileMaxChunkSize`.
168+
constbuffer=Buffer.from('012'.repeat(2**14));
169+
170+
constarray=newConstructor(buffer.buffer);
171+
awaitfsPromises.appendFile(dest,array);
172+
constdata=awaitfsPromises.readFile(dest);
173+
assert.deepStrictEqual(data,buffer);
174+
}
175+
}
176+
177+
(async()=>{
178+
awaitdoAppendBuffer();
179+
awaitdoAppendBufferAndCancel();
180+
awaitdoAppendString();
181+
awaitdoAppendStream();
182+
awaitdoAppendStreamWithCancel();
183+
awaitdoAppendIterable();
184+
awaitdoAppendInvalidIterable();
185+
awaitdoAppendIterableWithEncoding();
186+
awaitdoAppendBufferIterable();
187+
awaitdoAppendAsyncIterable();
188+
awaitdoAppendLargeIterable();
189+
awaitdoAppendInvalidValues();
190+
awaitdoAppendTypedArrays();
191+
})().then(common.mustCall());
0 commit comments
Comments
 (0)

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links");
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '

Skip to content
Commit 50791fa
Browse files
hkleungaiaduh95
hkleungai
authored and
aduh95
committed
doc,test: widen fsPromises.appendFile()'s data type, add missing tests
From lib/internal/fs/promises.js, one can see fsPromises.appendFile() is
simply a wrapper on fsPromises.writeFile(). Hence if writeFile() can
take non-buffer data argument, so can appendFile() too.
To justify the doc change, I have also restuctured the relevant tests,
to enhance the test coverage. They now includes the below test cases
consistently.
- await do(Append|Write)Buffer();
- await do(Append|Write)BufferAndCancel();
- await do(Append|Write)String();
- await do(Append|Write)Stream();
- await do(Append|Write)StreamWithCancel();
- await do(Append|Write)Iterable();
- await do(Append|Write)InvalidIterable();
- await do(Append|Write)IterableWithEncoding();
- await do(Append|Write)BufferIterable();
- await do(Append|Write)AsyncIterable();
- await do(Append|Write)LargeIterable();
- await do(Append|Write)InvalidValues();
- await do(Append|Write)TypedArrays();
Note that test/parallel/test-fs-promises-writefile-typedarray.js is
subsumed by test/parallel/test-fs-promises-file-handle-writeFile.js, and
test/parallel/test-fs-promises-writefile-with-fd.js becomes a subcase in
test/parallel/test-fs-promises-file-handle-writeFile.js.
Refs: #41677
Signed-off-by: Jimmy Leung <mingfamily@hotmail.com.hk>
PR-URL: #64279
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: René <contact.9a5d6388@renegade334.me.uk>
1 parent 6b09d30 commit 50791fa
7 files changed
Lines changed: 542 additions & 134 deletions
‎doc/api/fs.md‎
Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -196,7 +196,7 @@ changes:
196196
 strings anymore.
197197
-->
198198

199-
*`data` {string|Buffer|TypedArray|DataView|AsyncIterable|Iterable|Stream}
199+
*`data` {string|Buffer|TypedArray|DataView|AsyncIterable|Iterable}
200200
*`options` {Object|string}
201201
*`encoding` {string|null} **Default:**`'utf8'`
202202
*`signal` {AbortSignal|undefined} allows aborting an in-progress writeFile. **Default:**`undefined`
@@ -1003,7 +1003,7 @@ changes:
10031003
 strings anymore.
10041004
-->
10051005
1006-
* `data` {string|Buffer|TypedArray|DataView|AsyncIterable|Iterable|Stream}
1006+
* `data` {string|Buffer|TypedArray|DataView|AsyncIterable|Iterable}
10071007
* `options` {Object|string}
10081008
 * `encoding` {string|null} The expected character encoding when `data` is a
10091009
 string. **Default:** `'utf8'`
@@ -1233,10 +1233,15 @@ changes:
12331233
 - v20.10.0
12341234
 pr-url: https://github.com/nodejs/node/pull/50095
12351235
 description: The `flush` option is now supported.
1236+
 - version:
1237+
 - v15.14.0
1238+
 - v14.18.0
1239+
 pr-url: https://github.com/nodejs/node/pull/37490
1240+
 description: The `data` argument supports `AsyncIterable`, `Iterable`, and `Stream`.
12361241
-->
12371242
12381243
* `path` {string|Buffer|URL|FileHandle} filename or {FileHandle}
1239-
* `data` {string|Buffer}
1244+
* `data` {string|Buffer|TypedArray|DataView|AsyncIterable|Iterable}
12401245
* `options` {Object|string}
12411246
 * `encoding` {string|null} **Default:** `'utf8'`
12421247
 * `mode` {integer} **Default:** `0o666`
@@ -1246,7 +1251,7 @@ changes:
12461251
* Returns: {Promise} Fulfills with `undefined` upon success.
12471252
12481253
Asynchronously append data to a file, creating the file if it does not yet
1249-
exist. `data` can be a stringor a {Buffer}.
1254+
`data` can be a string, a buffer, an {AsyncIterable}, or an {Iterable} object.
12501255
12511256
If `options` is a string, then it specifies the `encoding`.
12521257
@@ -2255,7 +2260,7 @@ changes:
22552260
-->
22562261
22572262
* `file` {string|Buffer|URL|FileHandle} filename or `FileHandle`
2258-
* `data` {string|Buffer|TypedArray|DataView|AsyncIterable|Iterable|Stream}
2263+
* `data` {string|Buffer|TypedArray|DataView|AsyncIterable|Iterable}
22592264
* `options` {Object|string}
22602265
 * `encoding` {string|null} **Default:** `'utf8'`
22612266
 * `mode` {integer} **Default:** `0o666`
‎test/parallel/test-fs-promises-appendfile.js‎
Lines changed: 191 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,191 @@
1+
'use strict';
2+
3+
constcommon=require('../common');
4+
constfs=require('fs');
5+
constfsPromises=fs.promises;
6+
constpath=require('path');
7+
consttmpdir=require('../common/tmpdir');
8+
constassert=require('assert');
9+
consttmpDir=tmpdir.path;
10+
const{ Readable }=require('stream');
11+
12+
tmpdir.refresh();
13+
14+
constbuffer=Buffer.from('abc'.repeat(1000));
15+
conststream=Readable.from(['a','b','c']);
16+
conststream2=Readable.from(['ümlaut',' ','sechzig']);
17+
constiterable={
18+
expected: 'abc',
19+
*[Symbol.iterator](){
20+
yield'a';
21+
yield'b';
22+
yield'c';
23+
}
24+
};
25+
26+
constveryLargeIterable={
27+
expected: 'dogs running'.repeat(512*1024),
28+
*[Symbol.iterator](){
29+
yieldBuffer.from('dogs running'.repeat(512*1024),'utf8');
30+
}
31+
};
32+
33+
functioniterableWith(value){
34+
return{
35+
*[Symbol.iterator](){
36+
yieldvalue;
37+
}
38+
};
39+
}
40+
constbufferIterable={
41+
expected: 'abc',
42+
*[Symbol.iterator](){
43+
yieldBuffer.from('a');
44+
yieldBuffer.from('b');
45+
yieldBuffer.from('c');
46+
}
47+
};
48+
constasyncIterable={
49+
expected: 'abc',
50+
async*[Symbol.asyncIterator](){
51+
yield'a';
52+
yield'b';
53+
yield'c';
54+
}
55+
};
56+
57+
letcounter=0;
58+
59+
asyncfunctiondoAppendString(){
60+
conststring='x~yz'.repeat(100);
61+
constdest=path.resolve(tmpDir,`tmp-${counter++}.txt`);
62+
awaitfsPromises.appendFile(dest,string);
63+
constdata=fs.readFileSync(dest);
64+
conststringAsBuffer=Buffer.from(string,'utf8');
65+
assert.deepStrictEqual(stringAsBuffer,data);
66+
}
67+
68+
asyncfunctiondoAppendBuffer(){
69+
constdest=path.resolve(tmpDir,`tmp-${counter++}.txt`);
70+
awaitfsPromises.appendFile(dest,buffer);
71+
constdata=fs.readFileSync(dest);
72+
assert.deepStrictEqual(data,buffer);
73+
}
74+
75+
asyncfunctiondoAppendStream(){
76+
constdest=path.resolve(tmpDir,`tmp-${counter++}.txt`);
77+
awaitfsPromises.appendFile(dest,stream);
78+
constexpected='abc';
79+
constdata=fs.readFileSync(dest,'utf-8');
80+
assert.deepStrictEqual(data,expected);
81+
}
82+
83+
asyncfunctiondoAppendStreamWithCancel(){
84+
constdest=path.resolve(tmpDir,`tmp-${counter++}.txt`);
85+
constcontroller=newAbortController();
86+
const{ signal }=controller;
87+
process.nextTick(()=>controller.abort());
88+
awaitassert.rejects(
89+
fsPromises.appendFile(dest,stream,{ signal }),
90+
{name: 'AbortError'}
91+
);
92+
}
93+
94+
asyncfunctiondoAppendIterable(){
95+
constdest=path.resolve(tmpDir,`tmp-${counter++}.txt`);
96+
awaitfsPromises.appendFile(dest,iterable);
97+
constdata=fs.readFileSync(dest,'utf-8');
98+
assert.deepStrictEqual(data,iterable.expected);
99+
}
100+
101+
asyncfunctiondoAppendInvalidIterable(){
102+
constdest=path.resolve(tmpDir,`tmp-${counter++}.txt`);
103+
awaitPromise.all(
104+
[42,42n,{},Symbol('42'),true,undefined,null,NaN].map((value)=>
105+
assert.rejects(fsPromises.appendFile(dest,iterableWith(value)),{
106+
code: 'ERR_INVALID_ARG_TYPE',
107+
})
108+
)
109+
);
110+
}
111+
112+
asyncfunctiondoAppendIterableWithEncoding(){
113+
constdest=path.resolve(tmpDir,`tmp-${counter++}.txt`);
114+
awaitfsPromises.appendFile(dest,stream2,'latin1');
115+
constexpected='ümlaut sechzig';
116+
constdata=fs.readFileSync(dest,'latin1');
117+
assert.deepStrictEqual(data,expected);
118+
}
119+
120+
asyncfunctiondoAppendBufferIterable(){
121+
constdest=path.resolve(tmpDir,`tmp-${counter++}.txt`);
122+
awaitfsPromises.appendFile(dest,bufferIterable);
123+
constdata=fs.readFileSync(dest,'utf-8');
124+
assert.deepStrictEqual(data,bufferIterable.expected);
125+
}
126+
127+
asyncfunctiondoAppendAsyncIterable(){
128+
constdest=path.resolve(tmpDir,`tmp-${counter++}.txt`);
129+
awaitfsPromises.appendFile(dest,asyncIterable);
130+
constdata=fs.readFileSync(dest,'utf-8');
131+
assert.deepStrictEqual(data,asyncIterable.expected);
132+
}
133+
134+
asyncfunctiondoAppendLargeIterable(){
135+
constdest=path.resolve(tmpDir,`tmp-${counter++}.txt`);
136+
awaitfsPromises.appendFile(dest,veryLargeIterable);
137+
constdata=fs.readFileSync(dest,'utf-8');
138+
assert.deepStrictEqual(data,veryLargeIterable.expected);
139+
}
140+
141+
asyncfunctiondoAppendInvalidValues(){
142+
constdest=path.resolve(tmpDir,`tmp-${counter++}.txt`);
143+
awaitPromise.all(
144+
[42,42n,{},Symbol('42'),true,undefined,null,NaN].map((value)=>
145+
assert.rejects(fsPromises.appendFile(dest,value),{
146+
code: 'ERR_INVALID_ARG_TYPE',
147+
})
148+
)
149+
);
150+
}
151+
152+
asyncfunctiondoAppendBufferAndCancel(){
153+
constdest=path.resolve(tmpDir,`tmp-${counter++}.txt`);
154+
constcontroller=newAbortController();
155+
const{ signal }=controller;
156+
process.nextTick(()=>controller.abort());
157+
awaitassert.rejects(
158+
fsPromises.appendFile(dest,buffer,{ signal }),
159+
{name: 'AbortError'}
160+
);
161+
}
162+
163+
asyncfunctiondoAppendTypedArrays(){
164+
for(constConstructorof[Uint8Array,Uint16Array,Uint32Array]){
165+
constdest=path.resolve(tmpDir,`tmp-${counter++}.txt`);
166+
167+
// Use a file size larger than `kReadFileMaxChunkSize`.
168+
constbuffer=Buffer.from('012'.repeat(2**14));
169+
170+
constarray=newConstructor(buffer.buffer);
171+
awaitfsPromises.appendFile(dest,array);
172+
constdata=awaitfsPromises.readFile(dest);
173+
assert.deepStrictEqual(data,buffer);
174+
}
175+
}
176+
177+
(async()=>{
178+
awaitdoAppendBuffer();
179+
awaitdoAppendBufferAndCancel();
180+
awaitdoAppendString();
181+
awaitdoAppendStream();
182+
awaitdoAppendStreamWithCancel();
183+
awaitdoAppendIterable();
184+
awaitdoAppendInvalidIterable();
185+
awaitdoAppendIterableWithEncoding();
186+
awaitdoAppendBufferIterable();
187+
awaitdoAppendAsyncIterable();
188+
awaitdoAppendLargeIterable();
189+
awaitdoAppendInvalidValues();
190+
awaitdoAppendTypedArrays();
191+
})().then(common.mustCall());
0 commit comments
Comments
 (0)

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default");
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Commit 50791fa
Browse files
hkleungaiaduh95
hkleungai
authored and
aduh95
committed
doc,test: widen fsPromises.appendFile()'s data type, add missing tests
From lib/internal/fs/promises.js, one can see fsPromises.appendFile() is
simply a wrapper on fsPromises.writeFile(). Hence if writeFile() can
take non-buffer data argument, so can appendFile() too.
To justify the doc change, I have also restuctured the relevant tests,
to enhance the test coverage. They now includes the below test cases
consistently.
- await do(Append|Write)Buffer();
- await do(Append|Write)BufferAndCancel();
- await do(Append|Write)String();
- await do(Append|Write)Stream();
- await do(Append|Write)StreamWithCancel();
- await do(Append|Write)Iterable();
- await do(Append|Write)InvalidIterable();
- await do(Append|Write)IterableWithEncoding();
- await do(Append|Write)BufferIterable();
- await do(Append|Write)AsyncIterable();
- await do(Append|Write)LargeIterable();
- await do(Append|Write)InvalidValues();
- await do(Append|Write)TypedArrays();
Note that test/parallel/test-fs-promises-writefile-typedarray.js is
subsumed by test/parallel/test-fs-promises-file-handle-writeFile.js, and
test/parallel/test-fs-promises-writefile-with-fd.js becomes a subcase in
test/parallel/test-fs-promises-file-handle-writeFile.js.
Refs: #41677
Signed-off-by: Jimmy Leung <mingfamily@hotmail.com.hk>
PR-URL: #64279
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: René <contact.9a5d6388@renegade334.me.uk>
1 parent 6b09d30 commit 50791fa
7 files changed
Lines changed: 542 additions & 134 deletions
‎doc/api/fs.md‎
Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -196,7 +196,7 @@ changes:
196196
 strings anymore.
197197
-->
198198

199-
*`data` {string|Buffer|TypedArray|DataView|AsyncIterable|Iterable|Stream}
199+
*`data` {string|Buffer|TypedArray|DataView|AsyncIterable|Iterable}
200200
*`options` {Object|string}
201201
*`encoding` {string|null} **Default:**`'utf8'`
202202
*`signal` {AbortSignal|undefined} allows aborting an in-progress writeFile. **Default:**`undefined`
@@ -1003,7 +1003,7 @@ changes:
10031003
 strings anymore.
10041004
-->
10051005
1006-
* `data` {string|Buffer|TypedArray|DataView|AsyncIterable|Iterable|Stream}
1006+
* `data` {string|Buffer|TypedArray|DataView|AsyncIterable|Iterable}
10071007
* `options` {Object|string}
10081008
 * `encoding` {string|null} The expected character encoding when `data` is a
10091009
 string. **Default:** `'utf8'`
@@ -1233,10 +1233,15 @@ changes:
12331233
 - v20.10.0
12341234
 pr-url: https://github.com/nodejs/node/pull/50095
12351235
 description: The `flush` option is now supported.
1236+
 - version:
1237+
 - v15.14.0
1238+
 - v14.18.0
1239+
 pr-url: https://github.com/nodejs/node/pull/37490
1240+
 description: The `data` argument supports `AsyncIterable`, `Iterable`, and `Stream`.
12361241
-->
12371242
12381243
* `path` {string|Buffer|URL|FileHandle} filename or {FileHandle}
1239-
* `data` {string|Buffer}
1244+
* `data` {string|Buffer|TypedArray|DataView|AsyncIterable|Iterable}
12401245
* `options` {Object|string}
12411246
 * `encoding` {string|null} **Default:** `'utf8'`
12421247
 * `mode` {integer} **Default:** `0o666`
@@ -1246,7 +1251,7 @@ changes:
12461251
* Returns: {Promise} Fulfills with `undefined` upon success.
12471252
12481253
Asynchronously append data to a file, creating the file if it does not yet
1249-
exist. `data` can be a stringor a {Buffer}.
1254+
`data` can be a string, a buffer, an {AsyncIterable}, or an {Iterable} object.
12501255
12511256
If `options` is a string, then it specifies the `encoding`.
12521257
@@ -2255,7 +2260,7 @@ changes:
22552260
-->
22562261
22572262
* `file` {string|Buffer|URL|FileHandle} filename or `FileHandle`
2258-
* `data` {string|Buffer|TypedArray|DataView|AsyncIterable|Iterable|Stream}
2263+
* `data` {string|Buffer|TypedArray|DataView|AsyncIterable|Iterable}
22592264
* `options` {Object|string}
22602265
 * `encoding` {string|null} **Default:** `'utf8'`
22612266
 * `mode` {integer} **Default:** `0o666`
‎test/parallel/test-fs-promises-appendfile.js‎
Lines changed: 191 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,191 @@
1+
'use strict';
2+
3+
constcommon=require('../common');
4+
constfs=require('fs');
5+
constfsPromises=fs.promises;
6+
constpath=require('path');
7+
consttmpdir=require('../common/tmpdir');
8+
constassert=require('assert');
9+
consttmpDir=tmpdir.path;
10+
const{ Readable }=require('stream');
11+
12+
tmpdir.refresh();
13+
14+
constbuffer=Buffer.from('abc'.repeat(1000));
15+
conststream=Readable.from(['a','b','c']);
16+
conststream2=Readable.from(['ümlaut',' ','sechzig']);
17+
constiterable={
18+
expected: 'abc',
19+
*[Symbol.iterator](){
20+
yield'a';
21+
yield'b';
22+
yield'c';
23+
}
24+
};
25+
26+
constveryLargeIterable={
27+
expected: 'dogs running'.repeat(512*1024),
28+
*[Symbol.iterator](){
29+
yieldBuffer.from('dogs running'.repeat(512*1024),'utf8');
30+
}
31+
};
32+
33+
functioniterableWith(value){
34+
return{
35+
*[Symbol.iterator](){
36+
yieldvalue;
37+
}
38+
};
39+
}
40+
constbufferIterable={
41+
expected: 'abc',
42+
*[Symbol.iterator](){
43+
yieldBuffer.from('a');
44+
yieldBuffer.from('b');
45+
yieldBuffer.from('c');
46+
}
47+
};
48+
constasyncIterable={
49+
expected: 'abc',
50+
async*[Symbol.asyncIterator](){
51+
yield'a';
52+
yield'b';
53+
yield'c';
54+
}
55+
};
56+
57+
letcounter=0;
58+
59+
asyncfunctiondoAppendString(){
60+
conststring='x~yz'.repeat(100);
61+
constdest=path.resolve(tmpDir,`tmp-${counter++}.txt`);
62+
awaitfsPromises.appendFile(dest,string);
63+
constdata=fs.readFileSync(dest);
64+
conststringAsBuffer=Buffer.from(string,'utf8');
65+
assert.deepStrictEqual(stringAsBuffer,data);
66+
}
67+
68+
asyncfunctiondoAppendBuffer(){
69+
constdest=path.resolve(tmpDir,`tmp-${counter++}.txt`);
70+
awaitfsPromises.appendFile(dest,buffer);
71+
constdata=fs.readFileSync(dest);
72+
assert.deepStrictEqual(data,buffer);
73+
}
74+
75+
asyncfunctiondoAppendStream(){
76+
constdest=path.resolve(tmpDir,`tmp-${counter++}.txt`);
77+
awaitfsPromises.appendFile(dest,stream);
78+
constexpected='abc';
79+
constdata=fs.readFileSync(dest,'utf-8');
80+
assert.deepStrictEqual(data,expected);
81+
}
82+
83+
asyncfunctiondoAppendStreamWithCancel(){
84+
constdest=path.resolve(tmpDir,`tmp-${counter++}.txt`);
85+
constcontroller=newAbortController();
86+
const{ signal }=controller;
87+
process.nextTick(()=>controller.abort());
88+
awaitassert.rejects(
89+
fsPromises.appendFile(dest,stream,{ signal }),
90+
{name: 'AbortError'}
91+
);
92+
}
93+
94+
asyncfunctiondoAppendIterable(){
95+
constdest=path.resolve(tmpDir,`tmp-${counter++}.txt`);
96+
awaitfsPromises.appendFile(dest,iterable);
97+
constdata=fs.readFileSync(dest,'utf-8');
98+
assert.deepStrictEqual(data,iterable.expected);
99+
}
100+
101+
asyncfunctiondoAppendInvalidIterable(){
102+
constdest=path.resolve(tmpDir,`tmp-${counter++}.txt`);
103+
awaitPromise.all(
104+
[42,42n,{},Symbol('42'),true,undefined,null,NaN].map((value)=>
105+
assert.rejects(fsPromises.appendFile(dest,iterableWith(value)),{
106+
code: 'ERR_INVALID_ARG_TYPE',
107+
})
108+
)
109+
);
110+
}
111+
112+
asyncfunctiondoAppendIterableWithEncoding(){
113+
constdest=path.resolve(tmpDir,`tmp-${counter++}.txt`);
114+
awaitfsPromises.appendFile(dest,stream2,'latin1');
115+
constexpected='ümlaut sechzig';
116+
constdata=fs.readFileSync(dest,'latin1');
117+
assert.deepStrictEqual(data,expected);
118+
}
119+
120+
asyncfunctiondoAppendBufferIterable(){
121+
constdest=path.resolve(tmpDir,`tmp-${counter++}.txt`);
122+
awaitfsPromises.appendFile(dest,bufferIterable);
123+
constdata=fs.readFileSync(dest,'utf-8');
124+
assert.deepStrictEqual(data,bufferIterable.expected);
125+
}
126+
127+
asyncfunctiondoAppendAsyncIterable(){
128+
constdest=path.resolve(tmpDir,`tmp-${counter++}.txt`);
129+
awaitfsPromises.appendFile(dest,asyncIterable);
130+
constdata=fs.readFileSync(dest,'utf-8');
131+
assert.deepStrictEqual(data,asyncIterable.expected);
132+
}
133+
134+
asyncfunctiondoAppendLargeIterable(){
135+
constdest=path.resolve(tmpDir,`tmp-${counter++}.txt`);
136+
awaitfsPromises.appendFile(dest,veryLargeIterable);
137+
constdata=fs.readFileSync(dest,'utf-8');
138+
assert.deepStrictEqual(data,veryLargeIterable.expected);
139+
}
140+
141+
asyncfunctiondoAppendInvalidValues(){
142+
constdest=path.resolve(tmpDir,`tmp-${counter++}.txt`);
143+
awaitPromise.all(
144+
[42,42n,{},Symbol('42'),true,undefined,null,NaN].map((value)=>
145+
assert.rejects(fsPromises.appendFile(dest,value),{
146+
code: 'ERR_INVALID_ARG_TYPE',
147+
})
148+
)
149+
);
150+
}
151+
152+
asyncfunctiondoAppendBufferAndCancel(){
153+
constdest=path.resolve(tmpDir,`tmp-${counter++}.txt`);
154+
constcontroller=newAbortController();
155+
const{ signal }=controller;
156+
process.nextTick(()=>controller.abort());
157+
awaitassert.rejects(
158+
fsPromises.appendFile(dest,buffer,{ signal }),
159+
{name: 'AbortError'}
160+
);
161+
}
162+
163+
asyncfunctiondoAppendTypedArrays(){
164+
for(constConstructorof[Uint8Array,Uint16Array,Uint32Array]){
165+
constdest=path.resolve(tmpDir,`tmp-${counter++}.txt`);
166+
167+
// Use a file size larger than `kReadFileMaxChunkSize`.
168+
constbuffer=Buffer.from('012'.repeat(2**14));
169+
170+
constarray=newConstructor(buffer.buffer);
171+
awaitfsPromises.appendFile(dest,array);
172+
constdata=awaitfsPromises.readFile(dest);
173+
assert.deepStrictEqual(data,buffer);
174+
}
175+
}
176+
177+
(async()=>{
178+
awaitdoAppendBuffer();
179+
awaitdoAppendBufferAndCancel();
180+
awaitdoAppendString();
181+
awaitdoAppendStream();
182+
awaitdoAppendStreamWithCancel();
183+
awaitdoAppendIterable();
184+
awaitdoAppendInvalidIterable();
185+
awaitdoAppendIterableWithEncoding();
186+
awaitdoAppendBufferIterable();
187+
awaitdoAppendAsyncIterable();
188+
awaitdoAppendLargeIterable();
189+
awaitdoAppendInvalidValues();
190+
awaitdoAppendTypedArrays();
191+
})().then(common.mustCall());
0 commit comments
Comments
 (0)

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers");
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Commit 50791fa
Browse files
hkleungaiaduh95
hkleungai
authored and
aduh95
committed
doc,test: widen fsPromises.appendFile()'s data type, add missing tests
From lib/internal/fs/promises.js, one can see fsPromises.appendFile() is
simply a wrapper on fsPromises.writeFile(). Hence if writeFile() can
take non-buffer data argument, so can appendFile() too.
To justify the doc change, I have also restuctured the relevant tests,
to enhance the test coverage. They now includes the below test cases
consistently.
- await do(Append|Write)Buffer();
- await do(Append|Write)BufferAndCancel();
- await do(Append|Write)String();
- await do(Append|Write)Stream();
- await do(Append|Write)StreamWithCancel();
- await do(Append|Write)Iterable();
- await do(Append|Write)InvalidIterable();
- await do(Append|Write)IterableWithEncoding();
- await do(Append|Write)BufferIterable();
- await do(Append|Write)AsyncIterable();
- await do(Append|Write)LargeIterable();
- await do(Append|Write)InvalidValues();
- await do(Append|Write)TypedArrays();
Note that test/parallel/test-fs-promises-writefile-typedarray.js is
subsumed by test/parallel/test-fs-promises-file-handle-writeFile.js, and
test/parallel/test-fs-promises-writefile-with-fd.js becomes a subcase in
test/parallel/test-fs-promises-file-handle-writeFile.js.
Refs: #41677
Signed-off-by: Jimmy Leung <mingfamily@hotmail.com.hk>
PR-URL: #64279
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: René <contact.9a5d6388@renegade334.me.uk>
1 parent 6b09d30 commit 50791fa
7 files changed
Lines changed: 542 additions & 134 deletions
‎doc/api/fs.md‎
Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -196,7 +196,7 @@ changes:
196196
 strings anymore.
197197
-->
198198

199-
*`data` {string|Buffer|TypedArray|DataView|AsyncIterable|Iterable|Stream}
199+
*`data` {string|Buffer|TypedArray|DataView|AsyncIterable|Iterable}
200200
*`options` {Object|string}
201201
*`encoding` {string|null} **Default:**`'utf8'`
202202
*`signal` {AbortSignal|undefined} allows aborting an in-progress writeFile. **Default:**`undefined`
@@ -1003,7 +1003,7 @@ changes:
10031003
 strings anymore.
10041004
-->
10051005
1006-
* `data` {string|Buffer|TypedArray|DataView|AsyncIterable|Iterable|Stream}
1006+
* `data` {string|Buffer|TypedArray|DataView|AsyncIterable|Iterable}
10071007
* `options` {Object|string}
10081008
 * `encoding` {string|null} The expected character encoding when `data` is a
10091009
 string. **Default:** `'utf8'`
@@ -1233,10 +1233,15 @@ changes:
12331233
 - v20.10.0
12341234
 pr-url: https://github.com/nodejs/node/pull/50095
12351235
 description: The `flush` option is now supported.
1236+
 - version:
1237+
 - v15.14.0
1238+
 - v14.18.0
1239+
 pr-url: https://github.com/nodejs/node/pull/37490
1240+
 description: The `data` argument supports `AsyncIterable`, `Iterable`, and `Stream`.
12361241
-->
12371242
12381243
* `path` {string|Buffer|URL|FileHandle} filename or {FileHandle}
1239-
* `data` {string|Buffer}
1244+
* `data` {string|Buffer|TypedArray|DataView|AsyncIterable|Iterable}
12401245
* `options` {Object|string}
12411246
 * `encoding` {string|null} **Default:** `'utf8'`
12421247
 * `mode` {integer} **Default:** `0o666`
@@ -1246,7 +1251,7 @@ changes:
12461251
* Returns: {Promise} Fulfills with `undefined` upon success.
12471252
12481253
Asynchronously append data to a file, creating the file if it does not yet
1249-
exist. `data` can be a stringor a {Buffer}.
1254+
`data` can be a string, a buffer, an {AsyncIterable}, or an {Iterable} object.
12501255
12511256
If `options` is a string, then it specifies the `encoding`.
12521257
@@ -2255,7 +2260,7 @@ changes:
22552260
-->
22562261
22572262
* `file` {string|Buffer|URL|FileHandle} filename or `FileHandle`
2258-
* `data` {string|Buffer|TypedArray|DataView|AsyncIterable|Iterable|Stream}
2263+
* `data` {string|Buffer|TypedArray|DataView|AsyncIterable|Iterable}
22592264
* `options` {Object|string}
22602265
 * `encoding` {string|null} **Default:** `'utf8'`
22612266
 * `mode` {integer} **Default:** `0o666`
‎test/parallel/test-fs-promises-appendfile.js‎
Lines changed: 191 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,191 @@
1+
'use strict';
2+
3+
constcommon=require('../common');
4+
constfs=require('fs');
5+
constfsPromises=fs.promises;
6+
constpath=require('path');
7+
consttmpdir=require('../common/tmpdir');
8+
constassert=require('assert');
9+
consttmpDir=tmpdir.path;
10+
const{ Readable }=require('stream');
11+
12+
tmpdir.refresh();
13+
14+
constbuffer=Buffer.from('abc'.repeat(1000));
15+
conststream=Readable.from(['a','b','c']);
16+
conststream2=Readable.from(['ümlaut',' ','sechzig']);
17+
constiterable={
18+
expected: 'abc',
19+
*[Symbol.iterator](){
20+
yield'a';
21+
yield'b';
22+
yield'c';
23+
}
24+
};
25+
26+
constveryLargeIterable={
27+
expected: 'dogs running'.repeat(512*1024),
28+
*[Symbol.iterator](){
29+
yieldBuffer.from('dogs running'.repeat(512*1024),'utf8');
30+
}
31+
};
32+
33+
functioniterableWith(value){
34+
return{
35+
*[Symbol.iterator](){
36+
yieldvalue;
37+
}
38+
};
39+
}
40+
constbufferIterable={
41+
expected: 'abc',
42+
*[Symbol.iterator](){
43+
yieldBuffer.from('a');
44+
yieldBuffer.from('b');
45+
yieldBuffer.from('c');
46+
}
47+
};
48+
constasyncIterable={
49+
expected: 'abc',
50+
async*[Symbol.asyncIterator](){
51+
yield'a';
52+
yield'b';
53+
yield'c';
54+
}
55+
};
56+
57+
letcounter=0;
58+
59+
asyncfunctiondoAppendString(){
60+
conststring='x~yz'.repeat(100);
61+
constdest=path.resolve(tmpDir,`tmp-${counter++}.txt`);
62+
awaitfsPromises.appendFile(dest,string);
63+
constdata=fs.readFileSync(dest);
64+
conststringAsBuffer=Buffer.from(string,'utf8');
65+
assert.deepStrictEqual(stringAsBuffer,data);
66+
}
67+
68+
asyncfunctiondoAppendBuffer(){
69+
constdest=path.resolve(tmpDir,`tmp-${counter++}.txt`);
70+
awaitfsPromises.appendFile(dest,buffer);
71+
constdata=fs.readFileSync(dest);
72+
assert.deepStrictEqual(data,buffer);
73+
}
74+
75+
asyncfunctiondoAppendStream(){
76+
constdest=path.resolve(tmpDir,`tmp-${counter++}.txt`);
77+
awaitfsPromises.appendFile(dest,stream);
78+
constexpected='abc';
79+
constdata=fs.readFileSync(dest,'utf-8');
80+
assert.deepStrictEqual(data,expected);
81+
}
82+
83+
asyncfunctiondoAppendStreamWithCancel(){
84+
constdest=path.resolve(tmpDir,`tmp-${counter++}.txt`);
85+
constcontroller=newAbortController();
86+
const{ signal }=controller;
87+
process.nextTick(()=>controller.abort());
88+
awaitassert.rejects(
89+
fsPromises.appendFile(dest,stream,{ signal }),
90+
{name: 'AbortError'}
91+
);
92+
}
93+
94+
asyncfunctiondoAppendIterable(){
95+
constdest=path.resolve(tmpDir,`tmp-${counter++}.txt`);
96+
awaitfsPromises.appendFile(dest,iterable);
97+
constdata=fs.readFileSync(dest,'utf-8');
98+
assert.deepStrictEqual(data,iterable.expected);
99+
}
100+
101+
asyncfunctiondoAppendInvalidIterable(){
102+
constdest=path.resolve(tmpDir,`tmp-${counter++}.txt`);
103+
awaitPromise.all(
104+
[42,42n,{},Symbol('42'),true,undefined,null,NaN].map((value)=>
105+
assert.rejects(fsPromises.appendFile(dest,iterableWith(value)),{
106+
code: 'ERR_INVALID_ARG_TYPE',
107+
})
108+
)
109+
);
110+
}
111+
112+
asyncfunctiondoAppendIterableWithEncoding(){
113+
constdest=path.resolve(tmpDir,`tmp-${counter++}.txt`);
114+
awaitfsPromises.appendFile(dest,stream2,'latin1');
115+
constexpected='ümlaut sechzig';
116+
constdata=fs.readFileSync(dest,'latin1');
117+
assert.deepStrictEqual(data,expected);
118+
}
119+
120+
asyncfunctiondoAppendBufferIterable(){
121+
constdest=path.resolve(tmpDir,`tmp-${counter++}.txt`);
122+
awaitfsPromises.appendFile(dest,bufferIterable);
123+
constdata=fs.readFileSync(dest,'utf-8');
124+
assert.deepStrictEqual(data,bufferIterable.expected);
125+
}
126+
127+
asyncfunctiondoAppendAsyncIterable(){
128+
constdest=path.resolve(tmpDir,`tmp-${counter++}.txt`);
129+
awaitfsPromises.appendFile(dest,asyncIterable);
130+
constdata=fs.readFileSync(dest,'utf-8');
131+
assert.deepStrictEqual(data,asyncIterable.expected);
132+
}
133+
134+
asyncfunctiondoAppendLargeIterable(){
135+
constdest=path.resolve(tmpDir,`tmp-${counter++}.txt`);
136+
awaitfsPromises.appendFile(dest,veryLargeIterable);
137+
constdata=fs.readFileSync(dest,'utf-8');
138+
assert.deepStrictEqual(data,veryLargeIterable.expected);
139+
}
140+
141+
asyncfunctiondoAppendInvalidValues(){
142+
constdest=path.resolve(tmpDir,`tmp-${counter++}.txt`);
143+
awaitPromise.all(
144+
[42,42n,{},Symbol('42'),true,undefined,null,NaN].map((value)=>
145+
assert.rejects(fsPromises.appendFile(dest,value),{
146+
code: 'ERR_INVALID_ARG_TYPE',
147+
})
148+
)
149+
);
150+
}
151+
152+
asyncfunctiondoAppendBufferAndCancel(){
153+
constdest=path.resolve(tmpDir,`tmp-${counter++}.txt`);
154+
constcontroller=newAbortController();
155+
const{ signal }=controller;
156+
process.nextTick(()=>controller.abort());
157+
awaitassert.rejects(
158+
fsPromises.appendFile(dest,buffer,{ signal }),
159+
{name: 'AbortError'}
160+
);
161+
}
162+
163+
asyncfunctiondoAppendTypedArrays(){
164+
for(constConstructorof[Uint8Array,Uint16Array,Uint32Array]){
165+
constdest=path.resolve(tmpDir,`tmp-${counter++}.txt`);
166+
167+
// Use a file size larger than `kReadFileMaxChunkSize`.
168+
constbuffer=Buffer.from('012'.repeat(2**14));
169+
170+
constarray=newConstructor(buffer.buffer);
171+
awaitfsPromises.appendFile(dest,array);
172+
constdata=awaitfsPromises.readFile(dest);
173+
assert.deepStrictEqual(data,buffer);
174+
}
175+
}
176+
177+
(async()=>{
178+
awaitdoAppendBuffer();
179+
awaitdoAppendBufferAndCancel();
180+
awaitdoAppendString();
181+
awaitdoAppendStream();
182+
awaitdoAppendStreamWithCancel();
183+
awaitdoAppendIterable();
184+
awaitdoAppendInvalidIterable();
185+
awaitdoAppendIterableWithEncoding();
186+
awaitdoAppendBufferIterable();
187+
awaitdoAppendAsyncIterable();
188+
awaitdoAppendLargeIterable();
189+
awaitdoAppendInvalidValues();
190+
awaitdoAppendTypedArrays();
191+
})().then(common.mustCall());
0 commit comments
Comments
 (0)

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode");
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();

Skip to content
Commit 50791fa
Browse files
hkleungaiaduh95
hkleungai
authored and
aduh95
committed
doc,test: widen fsPromises.appendFile()'s data type, add missing tests
From lib/internal/fs/promises.js, one can see fsPromises.appendFile() is
simply a wrapper on fsPromises.writeFile(). Hence if writeFile() can
take non-buffer data argument, so can appendFile() too.
To justify the doc change, I have also restuctured the relevant tests,
to enhance the test coverage. They now includes the below test cases
consistently.
- await do(Append|Write)Buffer();
- await do(Append|Write)BufferAndCancel();
- await do(Append|Write)String();
- await do(Append|Write)Stream();
- await do(Append|Write)StreamWithCancel();
- await do(Append|Write)Iterable();
- await do(Append|Write)InvalidIterable();
- await do(Append|Write)IterableWithEncoding();
- await do(Append|Write)BufferIterable();
- await do(Append|Write)AsyncIterable();
- await do(Append|Write)LargeIterable();
- await do(Append|Write)InvalidValues();
- await do(Append|Write)TypedArrays();
Note that test/parallel/test-fs-promises-writefile-typedarray.js is
subsumed by test/parallel/test-fs-promises-file-handle-writeFile.js, and
test/parallel/test-fs-promises-writefile-with-fd.js becomes a subcase in
test/parallel/test-fs-promises-file-handle-writeFile.js.
Refs: #41677
Signed-off-by: Jimmy Leung <mingfamily@hotmail.com.hk>
PR-URL: #64279
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: René <contact.9a5d6388@renegade334.me.uk>
1 parent 6b09d30 commit 50791fa
7 files changed
Lines changed: 542 additions & 134 deletions
‎doc/api/fs.md‎
Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -196,7 +196,7 @@ changes:
196196
 strings anymore.
197197
-->
198198

199-
*`data` {string|Buffer|TypedArray|DataView|AsyncIterable|Iterable|Stream}
199+
*`data` {string|Buffer|TypedArray|DataView|AsyncIterable|Iterable}
200200
*`options` {Object|string}
201201
*`encoding` {string|null} **Default:**`'utf8'`
202202
*`signal` {AbortSignal|undefined} allows aborting an in-progress writeFile. **Default:**`undefined`
@@ -1003,7 +1003,7 @@ changes:
10031003
 strings anymore.
10041004
-->
10051005
1006-
* `data` {string|Buffer|TypedArray|DataView|AsyncIterable|Iterable|Stream}
1006+
* `data` {string|Buffer|TypedArray|DataView|AsyncIterable|Iterable}
10071007
* `options` {Object|string}
10081008
 * `encoding` {string|null} The expected character encoding when `data` is a
10091009
 string. **Default:** `'utf8'`
@@ -1233,10 +1233,15 @@ changes:
12331233
 - v20.10.0
12341234
 pr-url: https://github.com/nodejs/node/pull/50095
12351235
 description: The `flush` option is now supported.
1236+
 - version:
1237+
 - v15.14.0
1238+
 - v14.18.0
1239+
 pr-url: https://github.com/nodejs/node/pull/37490
1240+
 description: The `data` argument supports `AsyncIterable`, `Iterable`, and `Stream`.
12361241
-->
12371242
12381243
* `path` {string|Buffer|URL|FileHandle} filename or {FileHandle}
1239-
* `data` {string|Buffer}
1244+
* `data` {string|Buffer|TypedArray|DataView|AsyncIterable|Iterable}
12401245
* `options` {Object|string}
12411246
 * `encoding` {string|null} **Default:** `'utf8'`
12421247
 * `mode` {integer} **Default:** `0o666`
@@ -1246,7 +1251,7 @@ changes:
12461251
* Returns: {Promise} Fulfills with `undefined` upon success.
12471252
12481253
Asynchronously append data to a file, creating the file if it does not yet
1249-
exist. `data` can be a stringor a {Buffer}.
1254+
`data` can be a string, a buffer, an {AsyncIterable}, or an {Iterable} object.
12501255
12511256
If `options` is a string, then it specifies the `encoding`.
12521257
@@ -2255,7 +2260,7 @@ changes:
22552260
-->
22562261
22572262
* `file` {string|Buffer|URL|FileHandle} filename or `FileHandle`
2258-
* `data` {string|Buffer|TypedArray|DataView|AsyncIterable|Iterable|Stream}
2263+
* `data` {string|Buffer|TypedArray|DataView|AsyncIterable|Iterable}
22592264
* `options` {Object|string}
22602265
 * `encoding` {string|null} **Default:** `'utf8'`
22612266
 * `mode` {integer} **Default:** `0o666`
‎test/parallel/test-fs-promises-appendfile.js‎
Lines changed: 191 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,191 @@
1+
'use strict';
2+
3+
constcommon=require('../common');
4+
constfs=require('fs');
5+
constfsPromises=fs.promises;
6+
constpath=require('path');
7+
consttmpdir=require('../common/tmpdir');
8+
constassert=require('assert');
9+
consttmpDir=tmpdir.path;
10+
const{ Readable }=require('stream');
11+
12+
tmpdir.refresh();
13+
14+
constbuffer=Buffer.from('abc'.repeat(1000));
15+
conststream=Readable.from(['a','b','c']);
16+
conststream2=Readable.from(['ümlaut',' ','sechzig']);
17+
constiterable={
18+
expected: 'abc',
19+
*[Symbol.iterator](){
20+
yield'a';
21+
yield'b';
22+
yield'c';
23+
}
24+
};
25+
26+
constveryLargeIterable={
27+
expected: 'dogs running'.repeat(512*1024),
28+
*[Symbol.iterator](){
29+
yieldBuffer.from('dogs running'.repeat(512*1024),'utf8');
30+
}
31+
};
32+
33+
functioniterableWith(value){
34+
return{
35+
*[Symbol.iterator](){
36+
yieldvalue;
37+
}
38+
};
39+
}
40+
constbufferIterable={
41+
expected: 'abc',
42+
*[Symbol.iterator](){
43+
yieldBuffer.from('a');
44+
yieldBuffer.from('b');
45+
yieldBuffer.from('c');
46+
}
47+
};
48+
constasyncIterable={
49+
expected: 'abc',
50+
async*[Symbol.asyncIterator](){
51+
yield'a';
52+
yield'b';
53+
yield'c';
54+
}
55+
};
56+
57+
letcounter=0;
58+
59+
asyncfunctiondoAppendString(){
60+
conststring='x~yz'.repeat(100);
61+
constdest=path.resolve(tmpDir,`tmp-${counter++}.txt`);
62+
awaitfsPromises.appendFile(dest,string);
63+
constdata=fs.readFileSync(dest);
64+
conststringAsBuffer=Buffer.from(string,'utf8');
65+
assert.deepStrictEqual(stringAsBuffer,data);
66+
}
67+
68+
asyncfunctiondoAppendBuffer(){
69+
constdest=path.resolve(tmpDir,`tmp-${counter++}.txt`);
70+
awaitfsPromises.appendFile(dest,buffer);
71+
constdata=fs.readFileSync(dest);
72+
assert.deepStrictEqual(data,buffer);
73+
}
74+
75+
asyncfunctiondoAppendStream(){
76+
constdest=path.resolve(tmpDir,`tmp-${counter++}.txt`);
77+
awaitfsPromises.appendFile(dest,stream);
78+
constexpected='abc';
79+
constdata=fs.readFileSync(dest,'utf-8');
80+
assert.deepStrictEqual(data,expected);
81+
}
82+
83+
asyncfunctiondoAppendStreamWithCancel(){
84+
constdest=path.resolve(tmpDir,`tmp-${counter++}.txt`);
85+
constcontroller=newAbortController();
86+
const{ signal }=controller;
87+
process.nextTick(()=>controller.abort());
88+
awaitassert.rejects(
89+
fsPromises.appendFile(dest,stream,{ signal }),
90+
{name: 'AbortError'}
91+
);
92+
}
93+
94+
asyncfunctiondoAppendIterable(){
95+
constdest=path.resolve(tmpDir,`tmp-${counter++}.txt`);
96+
awaitfsPromises.appendFile(dest,iterable);
97+
constdata=fs.readFileSync(dest,'utf-8');
98+
assert.deepStrictEqual(data,iterable.expected);
99+
}
100+
101+
asyncfunctiondoAppendInvalidIterable(){
102+
constdest=path.resolve(tmpDir,`tmp-${counter++}.txt`);
103+
awaitPromise.all(
104+
[42,42n,{},Symbol('42'),true,undefined,null,NaN].map((value)=>
105+
assert.rejects(fsPromises.appendFile(dest,iterableWith(value)),{
106+
code: 'ERR_INVALID_ARG_TYPE',
107+
})
108+
)
109+
);
110+
}
111+
112+
asyncfunctiondoAppendIterableWithEncoding(){
113+
constdest=path.resolve(tmpDir,`tmp-${counter++}.txt`);
114+
awaitfsPromises.appendFile(dest,stream2,'latin1');
115+
constexpected='ümlaut sechzig';
116+
constdata=fs.readFileSync(dest,'latin1');
117+
assert.deepStrictEqual(data,expected);
118+
}
119+
120+
asyncfunctiondoAppendBufferIterable(){
121+
constdest=path.resolve(tmpDir,`tmp-${counter++}.txt`);
122+
awaitfsPromises.appendFile(dest,bufferIterable);
123+
constdata=fs.readFileSync(dest,'utf-8');
124+
assert.deepStrictEqual(data,bufferIterable.expected);
125+
}
126+
127+
asyncfunctiondoAppendAsyncIterable(){
128+
constdest=path.resolve(tmpDir,`tmp-${counter++}.txt`);
129+
awaitfsPromises.appendFile(dest,asyncIterable);
130+
constdata=fs.readFileSync(dest,'utf-8');
131+
assert.deepStrictEqual(data,asyncIterable.expected);
132+
}
133+
134+
asyncfunctiondoAppendLargeIterable(){
135+
constdest=path.resolve(tmpDir,`tmp-${counter++}.txt`);
136+
awaitfsPromises.appendFile(dest,veryLargeIterable);
137+
constdata=fs.readFileSync(dest,'utf-8');
138+
assert.deepStrictEqual(data,veryLargeIterable.expected);
139+
}
140+
141+
asyncfunctiondoAppendInvalidValues(){
142+
constdest=path.resolve(tmpDir,`tmp-${counter++}.txt`);
143+
awaitPromise.all(
144+
[42,42n,{},Symbol('42'),true,undefined,null,NaN].map((value)=>
145+
assert.rejects(fsPromises.appendFile(dest,value),{
146+
code: 'ERR_INVALID_ARG_TYPE',
147+
})
148+
)
149+
);
150+
}
151+
152+
asyncfunctiondoAppendBufferAndCancel(){
153+
constdest=path.resolve(tmpDir,`tmp-${counter++}.txt`);
154+
constcontroller=newAbortController();
155+
const{ signal }=controller;
156+
process.nextTick(()=>controller.abort());
157+
awaitassert.rejects(
158+
fsPromises.appendFile(dest,buffer,{ signal }),
159+
{name: 'AbortError'}
160+
);
161+
}
162+
163+
asyncfunctiondoAppendTypedArrays(){
164+
for(constConstructorof[Uint8Array,Uint16Array,Uint32Array]){
165+
constdest=path.resolve(tmpDir,`tmp-${counter++}.txt`);
166+
167+
// Use a file size larger than `kReadFileMaxChunkSize`.
168+
constbuffer=Buffer.from('012'.repeat(2**14));
169+
170+
constarray=newConstructor(buffer.buffer);
171+
awaitfsPromises.appendFile(dest,array);
172+
constdata=awaitfsPromises.readFile(dest);
173+
assert.deepStrictEqual(data,buffer);
174+
}
175+
}
176+
177+
(async()=>{
178+
awaitdoAppendBuffer();
179+
awaitdoAppendBufferAndCancel();
180+
awaitdoAppendString();
181+
awaitdoAppendStream();
182+
awaitdoAppendStreamWithCancel();
183+
awaitdoAppendIterable();
184+
awaitdoAppendInvalidIterable();
185+
awaitdoAppendIterableWithEncoding();
186+
awaitdoAppendBufferIterable();
187+
awaitdoAppendAsyncIterable();
188+
awaitdoAppendLargeIterable();
189+
awaitdoAppendInvalidValues();
190+
awaitdoAppendTypedArrays();
191+
})().then(common.mustCall());
0 commit comments
Comments
 (0)