v8: make writeHeapSnapshot throw if fopen fails

If the file fails to be written (e.g. missing permissions, no space left
on device, etc), `writeHeapSnapshot` will now throw an exception.

This commit also adds error handling for the `fclose` call, returning
false if a non-zero value was returned.

Fixes: https://github.com/nodejs/node/issues/41346

PR-URL: https://github.com/nodejs/node/pull/41373
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Darshan Sen <raisinten@gmail.com>
Reviewed-By: Mohammed Keyvanzadeh <mohammadkeyvanzade94@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
pull/41496/head
Antonio Román 2022-01-12 09:39:49 +01:00 committed by GitHub
parent 36035e0657
commit 74b9baa426
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
5 changed files with 32 additions and 10 deletions

View File

@ -267,6 +267,10 @@ disk unless [`v8.stopCoverage()`][] is invoked before the process exits.
<!-- YAML
added: v11.13.0
changes:
- version: REPLACEME
pr-url: https://github.com/nodejs/node/pull/41373
description: An exception will now be thrown if the file could not be written.
-->
* `filename` {string} The file path where the V8 heap snapshot is to be

View File

@ -1643,7 +1643,7 @@ size_t Environment::NearHeapLimitCallback(void* data,
env->isolate()->RemoveNearHeapLimitCallback(NearHeapLimitCallback,
initial_heap_limit);
heap::WriteSnapshot(env->isolate(), filename.c_str());
heap::WriteSnapshot(env, filename.c_str());
env->heap_limit_snapshot_taken_ += 1;
// Don't take more snapshots than the number specified by

View File

@ -308,21 +308,26 @@ class HeapSnapshotStream : public AsyncWrap,
HeapSnapshotPointer snapshot_;
};
inline void TakeSnapshot(Isolate* isolate, v8::OutputStream* out) {
inline void TakeSnapshot(Environment* env, v8::OutputStream* out) {
HeapSnapshotPointer snapshot {
isolate->GetHeapProfiler()->TakeHeapSnapshot() };
env->isolate()->GetHeapProfiler()->TakeHeapSnapshot() };
snapshot->Serialize(out, HeapSnapshot::kJSON);
}
} // namespace
bool WriteSnapshot(Isolate* isolate, const char* filename) {
bool WriteSnapshot(Environment* env, const char* filename) {
FILE* fp = fopen(filename, "w");
if (fp == nullptr)
if (fp == nullptr) {
env->ThrowErrnoException(errno, "open");
return false;
}
FileOutputStream stream(fp);
TakeSnapshot(isolate, &stream);
fclose(fp);
TakeSnapshot(env, &stream);
if (fclose(fp) == EOF) {
env->ThrowErrnoException(errno, "close");
return false;
}
return true;
}
@ -374,7 +379,7 @@ void TriggerHeapSnapshot(const FunctionCallbackInfo<Value>& args) {
if (filename_v->IsUndefined()) {
DiagnosticFilename name(env, "Heap", "heapsnapshot");
if (!WriteSnapshot(isolate, *name))
if (!WriteSnapshot(env, *name))
return;
if (String::NewFromUtf8(isolate, *name).ToLocal(&filename_v)) {
args.GetReturnValue().Set(filename_v);
@ -384,7 +389,7 @@ void TriggerHeapSnapshot(const FunctionCallbackInfo<Value>& args) {
BufferValue path(isolate, filename_v);
CHECK_NOT_NULL(*path);
if (!WriteSnapshot(isolate, *path))
if (!WriteSnapshot(env, *path))
return;
return args.GetReturnValue().Set(filename_v);
}

View File

@ -379,7 +379,7 @@ class DiagnosticFilename {
};
namespace heap {
bool WriteSnapshot(v8::Isolate* isolate, const char* filename);
bool WriteSnapshot(Environment* env, const char* filename);
}
class TraceEventScope {

View File

@ -24,6 +24,19 @@ process.chdir(tmpdir.path);
fs.accessSync(heapdump);
}
{
const readonlyFile = 'ro';
fs.writeFileSync(readonlyFile, Buffer.alloc(0), { mode: 0o444 });
assert.throws(() => {
writeHeapSnapshot(readonlyFile);
}, (e) => {
assert.ok(e, 'writeHeapSnapshot should error');
assert.strictEqual(e.code, 'EACCES');
assert.strictEqual(e.syscall, 'open');
return true;
});
}
[1, true, {}, [], null, Infinity, NaN].forEach((i) => {
assert.throws(() => writeHeapSnapshot(i), {
code: 'ERR_INVALID_ARG_TYPE',