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

jest-environment-nock-axios

v1.1.1

Published

Jest environment that disables all network connectivity via nock

Downloads

139

Readme

jest-environment-nock-axios

Mock all network requests in tests using nock.

Purpose

This environment ensures that no unmocked network requests are made (by calling nock's disableNetConnect). It also takes care of some additional setup required to support axios.

Installation

Install as usual with npm install -D jest-environment-nock-axios (or the yarn equivalent). Both nock and axios are required as peer dependencies.

To run a test in this environment set the testEnvironment option.

Gotchas

Jest by design doesn't implement the require cache. This means that the nock module configured by the environment is different from the module your tests get. To solve this that instance is injected into the global scope (see the example below).

Tips

It's a good idea to verify test that no mocked requests are pending. One way to do that is to run the following code after each test (e.g. using Jest's setupFilesAfterEnv) config option:

const nock = global.nock; // See the 'Gotcha' section above

afterEach(function () {
    const pendingMocks = nock.pendingMocks();

    if (pendingMocks.length > 0) {
        throw new Error(`There are still ${pendingMocks.length} pending mocks: ${pendingMocks.join()}`);
    }
});

Example

/**
 * @jest-environment nock-axios
 */
import axios from 'axios';

describe('This test', function () {
    const nock = global.nock; // See the 'Gotcha' section above

    it('will pass', async function () {
        nock('http://test.invalid')
            .get('/data.json')
            .reply(200, { name: 'Hairy Potter' });
        
        const result = await axios.get('http://test.invalid/data.json');
        expect(result.data).toEqual({ name: 'Hairy Potter' });
    });

    it('will fail', async function () {
        // ...because the host is not mocked
        await axios.get('http://news.ycombinator.com');
    });
    
    it('will fail if the above "setupFilesAfterEnv" hook is configured', async function () {
        await nock('http://test.invalid')
            .get('/no-data.json')
            .reply(200, {});

        // The mocked endpoint is never requested.
    }); 
})