mirror of
https://github.com/nodejs/node.git
synced 2024-11-21 10:59:27 +00:00
7f2d61f82a
This is similar to the `queryObjects()` console API provided by the Chromium DevTools console. It can be used to search for objects that have the matching constructor on its prototype chain in the entire heap, which can be useful for memory leak regression tests. To avoid surprising results, users should avoid using this API on constructors whose implementation they don't control, or on constructors that can be invoked by other parties in the application. To avoid accidental leaks, this API does not return raw references to the objects found. By default, it returns the count of the objects found. If `options.format` is `'summary'`, it returns an array containing brief string representations for each object. The visibility provided in this API is similar to what the heap snapshot provides, while users can save the cost of serialization and parsing and directly filer the target objects during the search. We have been using this API internally for the test suite, which has been more stable than any other leak regression testing strategies in the CI. With a public implementation we can now use the public API instead. PR-URL: https://github.com/nodejs/node/pull/51927 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Stephen Belanger <admin@stephenbelanger.com> Reviewed-By: Vinícius Lourenço Claro Cardoso <contact@viniciusl.com.br> Reviewed-By: Gerhard Stöbich <deb2001-github@yahoo.de> Reviewed-By: Rafael Gonzaga <rafael.nunu@hotmail.com>
34 lines
987 B
JavaScript
34 lines
987 B
JavaScript
'use strict';
|
|
|
|
const {
|
|
Error,
|
|
StringPrototypeStartsWith,
|
|
globalThis,
|
|
} = primordials;
|
|
|
|
process.emitWarning(
|
|
'These APIs are for internal testing only. Do not use them.',
|
|
'internal/test/binding');
|
|
|
|
function filteredInternalBinding(id) {
|
|
// Disallows internal bindings with names that start with 'internal_only'
|
|
// which means it should not be exposed to users even with
|
|
// --expose-internals.
|
|
if (StringPrototypeStartsWith(id, 'internal_only')) {
|
|
// This code is only intended for internal errors and is not documented.
|
|
// Do not use the normal error system.
|
|
// eslint-disable-next-line no-restricted-syntax
|
|
const error = new Error(`No such binding: ${id}`);
|
|
error.code = 'ERR_INVALID_MODULE';
|
|
throw error;
|
|
}
|
|
return internalBinding(id);
|
|
}
|
|
|
|
if (module.isPreloading) {
|
|
globalThis.internalBinding = filteredInternalBinding;
|
|
globalThis.primordials = primordials;
|
|
}
|
|
|
|
module.exports = { internalBinding: filteredInternalBinding, primordials };
|