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 🙏

© 2026 – Pkg Stats / Ryan Hefner

@deployagram/vitest

v1.0.0

Published

Vitest helpers that instrument service tests with Deployagram: start or reuse the environment, post proxy configuration before each test, and mark each test's end. The Node.js equivalent of deployagram-annotations-junit5.

Readme

@deployagram/vitest

Vitest helpers that instrument service tests with Deployagram. It is the Node.js equivalent of the Java deployagram-annotations-junit5 module.

npm install --save-dev @deployagram/vitest
import { describe, expect, it } from 'vitest';
import { useDeployagram } from '@deployagram/vitest';

const APP_URL = 'http://host.docker.internal:8080';

describe('ReceiveEmailTest', () => {
  const deployagram = useDeployagram({
    name: 'ReceiveEmailTest',
    proxyConfig: {
      'proxy.namesOfSourceApps.Emailer/email': 'EmailClient',
      'proxy.proxiedAppNames.Emailer/email': 'Emailer',
      'proxy.proxiedApps.Emailer/email': `${APP_URL}/Emailer/email`,
    },
  });

  it('acceptsAnEmailRequest', async () => {
    const response = await fetch(`${deployagram.proxyUrl}/Emailer/email`, {
      method: 'POST',
      headers: { 'Content-Type': 'application/json' },
      body: JSON.stringify({ email: '[email protected]', subject: 'Hi', body: 'Hello' }),
    });
    expect(response.status).toBe(204);
  });
});

useDeployagram registers four hooks, as the Java annotations do:

| Hook | What it does | Java equivalent | |---|---|---| | beforeAll | Finds, reuses or starts the environment (@deployagram/environment) | @Deployagram(startEnvironment) | | beforeEach | Posts proxyConfig to the Proxy, if there is any | @DeployagramConfig | | afterEach | Marks the test's end as <name>.<test name> on the Collector | DeployagramExtension.afterEach | | afterAll | Stops the containers this suite started. A Collector that was already running, or started by a global setup, is left alone | `` teardown |

Call useDeployagram inside describe, once per suite. Read deployagram.proxyUrl, deployagram.collectorUrl and deployagram.logger inside tests, not outside them.

Options

| Option | Default | Meaning | |---|---|---| | name | required | Suite name used in the test marks | | proxyConfig | none | Proxy settings, posted before each test | | markEnd | true | Mark each test's end on the Collector | | environment | none | Options for @deployagram/environment, such as loggerUrl |

Running the tests

Run the suites one at a time (fileParallelism: false in vitest.config.ts). Each suite resolves the environment, and two suites starting containers at the same moment could collide.

To start the environment once per run, and stop it at the end, add a globalSetup file:

// test/deployagram.global-setup.ts
import { deployagramGlobalSetup } from '@deployagram/vitest';
export default deployagramGlobalSetup();
// vitest.config.ts
export default defineConfig({
  test: { globalSetup: ['test/deployagram.global-setup.ts'], fileParallelism: false },
});

Differences from the Java module

  • Config is plain code. The Java ${variable} substitution is not needed, because template strings do the same job.
  • Config is set per suite, not per test. The Java @DeployagramConfig on a method is not supported.
  • The logger is read as deployagram.logger, not injected as a method parameter, which is how Java's DiagramLogger parameter works.
  • useDeployagram always resolves the environment. There is no startEnvironment = false switch: a running environment is reused, and a missing one is started.

Testing

npm test

The tests use fake dependencies and an MSW stub. They need no Docker and start no containers. The Emailer demo exercises the real Docker path.