npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@vercel/devlow-bench

v0.3.4

Published

Benchmarking tool for the developer workflow

Downloads

9,418

Readme

devlow-bench

DEVeloper workfLOW BENCHmarking tool

Installation

npm install devlow-bench

Usage

Usage: devlow-bench [options] <scenario files>
## Selecting scenarios
  --scenario=<filter>, -s=<filter>   Only run the scenario with the given name
  --interactive, -i                  Select scenarios and variants interactively
  --<prop>=<value>                   Filter by any variant property defined in scenarios
## Output
  --json=<path>, -j=<path>           Write the results to the given path as JSON
  --console                          Print the results to the console
  --datadog[=<hostname>]             Upload the results to Datadog
                                     (requires DATADOG_API_KEY environment variables)
## Help
  --help, -h, -?                     Show this help

Scenarios

A scenario file is similar to a test case file. It can contain one or multiple scenarios by using the describe() method to define them.

import { describe } from "devlow-bench";

describe(
  "my scenario",
  {
    /* property options */
  },
  async (
    {
      /* property values */
    }
  ) => {
    // run the scenario
  }
);

The describe() method takes three arguments:

  • name: The name of the scenario
  • props: An object with possible property values for the scenario.
  • fn: The function that runs the scenario. It is passed an object with the property values as the first argument.

The props object can contain any number of properties. The key is the name of the property. The value must either be an array of possible values (number, string, boolean), or it can be true as shortcut for [true, false] resp. false for [false, true]. The scenario will run for every possible combination of the property values, if not specified otherwise.

Example

import { describe } from "devlow-bench";

describe(
  "my scenario",
  {
    myProperty: [1, 2, 3],
    myOtherProperty: true,
  },
  async ({ myProperty, myOtherProperty }) => {
    console.log(myProperty, myOtherProperty);
  }
);

// will print:
// 1 true
// 2 true
// 3 true
// 1 false
// 2 false
// 3 false

Reporting measurements

import { measureTime, reportMeasurement } from "devlow-bench";

// Measure a time
await measureTime("name of the timing", {
  /* optional options */
});

// Report some other measurement
await reportMeasurement("name of the measurement", value, unit, {
  /* optional options */
});

Options:

  • relativeTo: measure time/value relative to some other measurement.
  • scenario: override the reported scenario name (to make measurement independent of scenario name)
  • props: override the reported scenario properties (to make measurement independent of scenario properties, object is merged with original props, to remove a prop use null value)

Browser operations

The devlow-bench package provides a few helper functions to run operations in the browser.

import { newBrowserSession } from "devlow-bench/browser";

const session = await newBrowserSession({
  // options
});
await session.hardNavigation("metric name", "https://example.com");
await session.reload("metric name");
await session.softNavigationByClick("metric name", ".selector-to-click");
await session.close();

Run with BROWSER_OUTPUT=1 to show the output of the browser.

Run with HEADLESS=false to show the actual browser window.

Shell operations

The devlow-bench package provides a few helper functions to run operations in the shell.

import { command } from 'devlow-bench/shell';

const shell = await command("pnpm", ["run", "build"], {
  env: { /* optional env vars */ }
  cwd: "/optional/path/to/directory"
});

// Wait for successful exit
await shell.ok();

// Wait for exit
const exitCode = await shell.end();

// Wait for specific output
const [match, world] = await shell.waitForOutput(/hello (world)/);

// Report memory usage or the process tree as metric
await shell.reportMemUsage("metric name", { /* optional options */ });

shell.stdout, shell.stderr

// merged output
shell.output

// Kill the process tree
await shell.kill();

Run with SHELL_OUTPUT=1 to show the output of the shell commands.

File operations

The devlow-bench package provides a few helper functions to run operations on the file system.

import { waitForFile } from "devlow-bench/file";

// wait for file to exist
await waitForFile("/path/to/file", /* timeout = */ 30000);