Programmable interface to Clinic.js Heap Profiler. 

Programmable interface to Clinic.js Heap Profiler

matteo.collina

jasnell

simoneb

rafaelgss

@clinic/heap-profiler

Error

Ignore

Warn

License

Maintenance

Miscellaneous

Quality

Supply chain risk

Vulnerability

Admins only

Organization members

Dashboard

<upgradeLink>Upgrade</upgradeLink> to access this feature

About

Blog

Socket CLI

Customers

Socket Dependency Search

Docs

Socket for GitHub

Love

Impersonation Mode Active

Update your browser to the latest version for the best experience.

Your web browser is outdated

Use another browser for the best experience.

Your web browser is unsupported

{{count, number}} commits last two months

{{count, number}} critical severity alert

{{count, number}} critical severity alerts

{{count, number}} dependency vulnerability

{{count, number}} dependency vulnerabilities

{{count, number}} development dependencies

{{count, number}} transitive dependencies

{{count, number}} version published last month

{{count, number}} versions published last month

{{count, number}} version published in last two months

{{count, number}} versions published in last two months

{{count, number}} version published last week

{{count, number}} versions published last week

{{count, number}} version published last year

{{count, number}} versions published last year

Socket undergoes annual SOC2 Type II audits. Socket customers can request a copy of the full SOC2 Type II report.

Allows organization owners and admins to access detailed records of actions taken by members of their organization, complete with timestamps.

Prevent compromised packages from infiltrating your supply chain by monitoring for changes in real-time.

Join our Discord community to get help from Socket engineers and other Socket users.

Compare millions of open source packages on socket.dev

Detect malicious code and risky behavior (e.g. network) in your dependencies using "deep package inspection"

All data is encrypted in transit and at rest using industry standard encryption algorithms.

Get a dedicated Socket account manager and access to Socket’s Customer Success team.

Get dedicated support from Socket engineers via email and Slack.

"Shift left" with the Socket Chrome extension and give intervene early, before developers choose risky or low quality dependencies.

Catch developers using risky dependencies and give them a "speed bump" to encourage good behavior

Install the Socket GitHub app to receive real-time dependency scanning and reports with every pull request.

Integrate Socket into your GitHub SCM to prevent risky dependencies from being installed.

Socket scans for vulnerabilities in your dependencies, including CVEs, security advisories, and more.

Socket supports dependencies in many languages, with most popular ecosystems coming in 2024. We've got you covered no matter what languages you use.

Enforce license policies across your organization

Receive a Microsoft Teams message to the channel of your choice anytime Socket runs a new analysis, has a new finding, or a policy has changed.

Get help migrating from Socket's free plan to Socket's paid plans.

Run Socket on-premises or in your own cloud environment.

Query for any dependency (at any version) across your entire organization

Integrate Socket into your CI/CD pipeline to prevent risky dependencies from being deployed to production.

Analyze an entire project to find supply chain risks

Tag projects to organize and filter your projects

Restrict access based on the roles of individual users within an organization.

Receive a Slack message to the channel of your choice anytime Socket runs a new analysis, has a new finding, or a policy has changed.

Socket is SOC2 Type II compliant and undergoes annual audits.

The Socket CLI allows teams to prevent risky dependencies from being installed, and to get dependency insights from the command line.

Socket supports SAML SSO for single sign-on and identity management.

Integrate Socket into your VS Code IDE to prevent risky dependencies from being installed.

Get a POST request anytime Socket runs a new analysis, has a new finding, or a policy has changed.

Socket will analyzed your SBOMs up to a maximum number of dependencies.

API that allows you to analyze a project, lookup package scores and alerts, and more.

Create API tokens to authenticate with the Socket API and CLI.

The number of developers in your team. A developer is someone who made a commit to your organization's repositories scanned by Socket in the past month.

Use Socket to protect your private repositories.

Socket is always free for open source projects.

Socket retains all reporting data for 3 months, 1 year, or a custom term of your choice.

Access the threat feed that powers Socket.

Unlimited scale, self-hosting, and priority support for large teams.

For open-source projects, individuals, and small teams.

For growing teams with enhanced scale, security, and support.

There is a package with a similar name that is downloaded much more often.

There are packages with similar names that are downloaded much more often.

This may not be the package you want!

Instance

Alert Locations

Package

The {{ecosystem}} package {{- packageName}} receives a total of <strong>{{numWeeklyDownloadCount, number}}</strong> weekly downloads. As such, {{- packageName}} popularity was classified as <strong>{{popularity}}</strong>.

Is {{- packageName}} popular?

Is {{- packageName}} safe to use?

Is {{- packageName}} well maintained?

What is {{- packageName}}?

{{packageDescription}}Version: {{versionString}} was published by {{publisherName}}. Start using Socket to analyze {{- packageName}} and its {{dependencyCount, number}} dependencies to secure your app from supply chain attacks.

Sorry, it seems this package was removed from the registry

Package was removed

This package version has been unpublished, mostly likely due to security reasons

Package version was removed

Provide a detailed description of the malware...

Socket fights vulnerabilities and provides visibility, defense-in-depth, and proactive supply chain protection for JavaScript, Python, and Go dependencies.

Socket - Secure your dependencies. Ship with confidence.

Compare versions

{{- packageName}} - npm Package Compare versions

  "description": "Programmable interface to Clinic.js Heap Profiler",

  "repository": "https://github.com/clinicjs/node-clinic-heap-profiler",

    "visualize-watch": "node debug/visualize-watch.js",

    "visualize-all": "node debug/visualize-all.js",

    "test:file": "standard | snazzy && tap --no-cov",

      "--exclude=visualizer/data-tree.js",

      "--exclude=visualizer/no-data-node.js"

[![npm version][npm-version]][npm-url] [![Stability Stable][stability-stable]][stability-docs] [![Github Actions build status][actions-status]][actions-url]

[![Downloads][npm-downloads]][npm-url] [![Code style][lint-standard]][lint-standard-url]

Programmable interface to [Clinic.js][clinic-url] Heap Profiler. Learn more about Clinic.js: https://clinicjs.org/

![screenshot](https://user-images.githubusercontent.com/26234614/143886238-481abe39-4cc7-470a-a1cd-144a73a070b9.png)

To open an issue, please use the [main repository](https://github.com/clinicjs/node-clinic) with the `heapprofiler` label.

const ClinicHeapProfiler = require('@clinic/heap-profiler')

const heapProfiler = new ClinicHeapProfiler()

heapProfiler.collect(['node', './path-to-script.js'], function (err, filepath) {

  heapProfiler.visualize(filepath, filepath + '.html', function (err) {

  - detectPort [`<boolean>`][] **Default**: false

  - collectOnFailure [`<boolean>`][] If set to true, the collected data will be returned even if the process exits with non-zero code.

  - debug [`<boolean>`][] If set to true, the generated html will not be minified.

  - dest [`<String>`][] The file where the collected data is stored.

    **Default**: `./.clinic/<process.pid>.clinic-heapprofile`

#### `heapProfiler.collect(args, callback)`

Starts a process by using [@nearform/heap-profiler](https://github.com/nearform/heap-profiler).

The process sampling is started as soon as the process starts. The filepath with collected data will be the value in the callback.

`stdout`, `stderr`, and `stdin` will be relayed to the calling process.

The sampling is stopped and data collected right before the process exits.

If you want to collect data earlier, you can send the process a `SIGINT` or, if `detectPort` is `true`, you can call `heapProfiler.stopViaIPC()`.

#### `heapProfiler.visualize(dataFilename, outputFilename, callback)`

Will consume the datafile specified by `dataFilename`, this datafile will be

produced by the sampler using `heapProfiler.collect`.

`heapProfiler.visualize` will then output a standalone HTML file to `outputFilename`.

When completed the `callback` will be called with no extra arguments, except a

When the profiler is started with `detectPort=true`, the profiler establish a TCP based IPC communication.

This method can therefore be called to collect the data at any time.

If no TCP channel is opened or available, the method will perform no operation so it is safe to call at all times.

See the `examples` folder. All example should be run from the repository main folder:

Each `index.js` will contain any specific setup step required by the example, if any.

[stability-stable]: https://img.shields.io/badge/stability-stable-green.svg?style=flat-square

[stability-docs]: https://nodejs.org/api/documentation.html#documentation_stability_index

[npm-version]: https://img.shields.io/npm/v/@clinic/heap-profiler.svg?style=flat-square

[npm-url]: https://www.npmjs.org/@clinic/heap-profiler

[npm-downloads]: http://img.shields.io/npm/dm/@clinic/heap-profiler.svg?style=flat-square

[lint-standard]: https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat-square

[lint-standard-url]: https://github.com/feross/standard

[clinic-url]: https://github.com/clinicjs/node-clinic

[`<object>`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object

[`<number>`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number

[`<boolean>`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type

[`<string>`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String

[actions-status]: https://github.com/clinicjs/node-clinic-flame/workflows/CI/badge.svg

[actions-url]: https://github.com/clinicjs/node-clinic-flame/actions

const { spawn } = require('child_process')

const { ensureDir } = require('fs-extra')

const { createConnection, createServer } = require('net')

const buildJs = require('@clinic/clinic-common/scripts/build-js')

const buildCss = require('@clinic/clinic-common/scripts/build-css')

const mainTemplate = require('@clinic/clinic-common/templates/main')

const { analyse } = require('./analysis/index.js')

function execute (instance, args, env, nodeOptions, cb) {

  ensureDir(path.dirname(instance.dest), err => {

      By default spawn creates a process in the same process group of the current one.

      This means that SIGINT are received both from the parent and child processes.

      We handle SIGINT in the child, so we want to ignore in the parent.

    instance.process = spawn(args[0], args.slice(1), { stdio: ['ignore', 'inherit', 'inherit'], env })

    instance.process.once('exit', (code, signal) => {

      process.removeListener('SIGINT', noop)

      if (code && !instance.collectOnFailure) {

        cb(new Error(`Child process exited with code ${code}.`))

function writeHtml (data, outputFilename, debug, cb) {

  const fakeDataPath = path.join(__dirname, 'visualizer', 'data.json')

  const stylePath = path.join(__dirname, 'visualizer', 'style.css')

  const scriptPath = path.join(__dirname, 'visualizer', 'main.js')

  const logoPath = path.join(__dirname, 'visualizer/assets', 'heap-profiler-logo.svg')

  const clinicFaviconPath = path.join(__dirname, 'visualizer', 'clinic-favicon.png.b64')

  const logoFile = fs.createReadStream(logoPath)

  const clinicFaviconBase64 = fs.createReadStream(clinicFaviconPath)

  const version = require('../package.json').version

      b.require({ source: JSON.stringify(data), file: fakeDataPath })

      PRESENTATION_MODE: process.env.PRESENTATION_MODE

  const styleFile = buildCss({ stylePath, debug })

    headerLogoUrl: 'https://clinicjs.org/heap-profiler/',

    headerLogoTitle: 'Clinic Heap Profiler on Clinicjs.org',

    uploadId: outputFilename.split('/').pop().split('.html').shift(),

  pump(outputFile, fs.createWriteStream(outputFilename), cb)

class ClinicHeapProfiler extends events.EventEmitter {

    const nodeOptions = ` -r ${path.join(__dirname, './injects/ipc.js')}`

    let preloadPath = path.join(__dirname, './injects/ipc.js')

      preloadPath = preloadPath.replace(/\\/g, '\\\\')

    const nodeOptions = `-r "${preloadPath}"`

      HEAP_PROFILER_DESTINATION: this.dest,

      HEAP_PROFILER_PRELOADER_DISABLED: 'true',

		{
		"name": "@clinic/heap-profiler",
		"version": "4.1.0",
		"version": "4.1.1",
		"description": "Programmable interface to Clinic.js Heap Profiler",
		@@ -5,0 +5,0 @@ "repository": "https://github.com/clinicjs/node-clinic-heap-profiler",

		@@ -10,2 +10,6 @@ # Clinic.js Heap Profiler

		## Issues

		To open an issue, please use the [main repository](https://github.com/clinicjs/node-clinic) with the `heapprofiler` label.

		## Installation
		@@ -12,0 +16,0 @@

		@@ -119,4 +119,9 @@ 'use strict'
		collect (args, cb) {
		const nodeOptions = ` -r ${path.join(__dirname, './injects/ipc.js')}`
		let preloadPath = path.join(__dirname, './injects/ipc.js')
		if (process.platform === 'win32') {
		preloadPath = preloadPath.replace(/\\/g, '\\\\')
		}

		const nodeOptions = `-r "${preloadPath}"`

		const env = {
		@@ -123,0 +128,0 @@ ...process.env,

		'use strict'

		const { spawn } = require('child_process')
		const fs = require('fs')
		@@ -76,2 +77,23 @@ const path = require('path')

		test('child_process - test spawn - filepath with spaces should be preloaded', t => {
		const env = process.env

		// double quotes are required for paths with spaces
		env.NODE_OPTIONS = `-r "${path.join(__dirname, 'fixtures', 'file with space.js')}"`
		if (process.platform === 'win32') {
		env.NODE_OPTIONS = env.NODE_OPTIONS.replace(/\\/g, '\\\\')
		}

		this.process = spawn(
		process.execPath,
		[path.join('test', 'fixtures', 'randomHashes.js')],
		{ stdio: ['ignore', 'inherit', 'inherit'], env }
		)

		this.process.once('exit', (code) => {
		t.equal(code, 0)
		t.end()
		})
		})

		test('cmd - test visualization - missing data', t => {
		@@ -78,0 +100,0 @@ const tool = new ClinicHeapProfiler({ debug: true })

New alerts

Fixed alerts

Improved metrics

Worsened metrics