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

wildcard-mock-link

v2.0.4

Published

apollo client mocking

Downloads

39,774

Readme

wildcard-mock-link

build status Known Vulnerabilities Renovate

WildcardMockLink is a replacement for MockLink which can:

  • Match requests with arbitrary variables.
  • Provide mocks that match more than one request.
  • Mock subscriptions and send subscription responses after setting up the MockedProvider in a test via method calls.
  • Grab the mutation/query/subscription requests for use in test assertions.

Documentation

Wildcard queries

The MockLink provided with apollo requires the variables for every matching query to be specified ahead of time. In certain circumstances this is not convenient, i.e. using the MockedProvider in storybook stories. WildcardMockLink allows mocks to be specified that match a query with any variables, and these mocks can be configured to match more than once.

import { act } from '@testing-library/react'

const CAT_QUALITIES_QUERY = gql`
  query ($catName: String!) {
    qualities(cats: $catName) {
      loveliness
    }
  }
`

const link = new WildcardMockLink(
  [
    {
      request: {
        query: CAT_QUALITIES_QUERY,
        variables: MATCH_ANY_PARAMETERS,
      },
      result: { data },
      nMatches: 2,
    },
  ],
  { addTypename: true, act },
)

return (
  <MockedProvider link={link}>
    <MyCatComponent />
  </MockedProvider>
)

The above mocked provider will match two requests for CAT_QUALITIES_QUERY no matter what the variables are. Here nMatches is used to restrict the mock to the first two requests that match, when nMatches is omitted the mock will match one request. Number.POSITIVE_INFINITY can be used to allow an inifinite number of matchs.

The instantiation of WildcardMockLink also shows the options, addTypename which works the same as apollo's MockLink and act which can be used to ensure all operations that emit data to components are wrapped in an act function. suppressMissingMockWarnings will disable the console.warn about missing mocks, defaults to false.

Asserting against the latest request/mutation/subscription.

The following returns true if the last query matches CAT_QUALITIES_QUERY.

link.lastQueryMatches(CAT_QUALITIES_QUERY)

There are also lastMutationMatches and lastSubscriptionMatches. The arrays queries, mutations and subscriptions contain all of the corresponding requests.

Waiting for responses to return data

These methods can be used to ensure updates don't happen outside of act.

await link.waitForLastResponse()

This waits for the last response to complete.

await link.waitForAllResponses()

This waits for all pending responses to complete.

await link.waitForAllResponsesRecursively()

This can be used when a component makes a new request based on data received from another response. It waits until there are no more pending responses.

Testing components with mock data

This library provides a utility function withApolloMocks which can be used to created a component tree with access to mocked data. It returns the react element at the head of the component tree and a WildcardMockLink object and can be used in conjunction with the functionality mentioned above to create a test like this:

import { useQuery } from '@apollo/client'
import { render, act } from '@testing-library/react'
import gql from 'graphql-tag'
import React, { FC } from 'react'
import {
  MATCH_ANY_PARAMETERS,
  hookWrapperWithApolloMocks,
} from 'wildcard-mock-link'

const CAT_QUALITIES_QUERY = gql`
  query ($catName: String!) {
    qualities(cats: $catName) {
      loveliness
    }
  }
`

it('can be used to mock data for a component tree', async () => {
  const data = {
    qualities: {
      __typename: 'Qualities',
      loveliness: 'very',
    },
  }

  const { element, link } = withApolloMocks(
    () => <MyCatComponent catName="mr bad actor face" />,
    [
      {
        request: {
          query: CAT_QUALITIES_QUERY,
          variables: MATCH_ANY_PARAMETERS,
        },
        result: { data },
      },
    ],
  )
  const { getByRole } = render(element)
  await link.waitForLastResponse()

  expect(link.lastQueryMatches(CAT_QUALITIES_QUERY)).toBeTruthy()
  expect(link.lastQuery?.variables).toEqual({ catName: 'mr bad actor face' })
  const mainContent = getByRole('main')
  expect(mainContent?.textContent).toEqual('Loveliness: very')
})

Testing hooks with mock data

This library provides a utility function hookWrapperWithApolloMocks for creating a wrapper object which can be used with @testing-library/react-hooks. It returns a WildcardMockLink and a wrapper and can be used in conjunction with the functionality mentioned above to create a test like this:

import { useQuery } from '@apollo/client'
import { renderHook, act as actHook } from '@testing-library/react-hooks'
import gql from 'graphql-tag'
import {
  MATCH_ANY_PARAMETERS,
  hookWrapperWithApolloMocks,
} from 'wildcard-mock-link'

const CAT_QUALITIES_QUERY = gql`
  query ($catName: String!) {
    qualities(cats: $catName) {
      loveliness
    }
  }
`

it('can be used to mock data for a hook', async () => {
  const useQueryOnce = (catName: string) => {
    const { data } = useQuery(CAT_QUALITIES_QUERY, { variables: { catName } })
    return data
  }

  const data = {
    qualities: {
      __typename: 'Qualities',
      loveliness: 'very',
    },
  }
  const { wrapper, link } = hookWrapperWithApolloMocks([
    {
      request: {
        query: CAT_QUALITIES_QUERY,
        variables: MATCH_ANY_PARAMETERS,
      },
      result: { data },
    },
  ])
  const { result } = renderHook(() => useQueryOnce('tortand'), { wrapper })
  await link.waitForLastResponse()
  expect(link.lastQueryMatches(CAT_QUALITIES_QUERY)).toBeTruthy()
  expect(link.lastQuery!.variables).toEqual({ catName: 'tortand' })
  expect(result.current).toEqual(data)
})

Testing subscriptions with multiple responses

The WildcardMockLink provides a way to push new responses out to subscriptions. This can be used during tests to make it easier to test how components respond to subscription updates. The sendWildcardSubscriptionResult method can be used to send a new response which matches a wildcard mock, otherwise sendSubscriptionResult can be used. Here is an example:

import { useQuery } from '@apollo/client'
import { waitFor } from '@testing-library/react'
import { renderHook, act as actHook } from '@testing-library/react-hooks'
import gql from 'graphql-tag'
import {
  MATCH_ANY_PARAMETERS,
  hookWrapperWithApolloMocks,
} from 'wildcard-mock-link'

const MISCHIEF_SUBSCRIPTION = gql`
  subscription ($catName: String!) {
    actsOfMischief(cats: $catName) {
      description
      severity
    }
  }
`

it('can push updates using the API', async () => {
  const useActsOfMischief = (catName: string) => {
    const { data } = useSubscription(MISCHIEF_SUBSCRIPTION, {
      variables: { catName },
    })
    return data
  }

  const initialData = {
    actsOfMischief: {
      __typename: 'ActsOfMischief',
      description: 'did not stay away from my bins',
      severity: 'extreme',
    },
  }
  const { wrapper, link } = hookWrapperWithApolloMocks(
    [
      {
        request: {
          query: MISCHIEF_SUBSCRIPTION,
          variables: MATCH_ANY_PARAMETERS,
        },
        result: { data: initialData },
      },
    ],
    undefined,
    { act: actHook },
  )
  const rendered = renderHook(() => useActsOfMischief('la don'), { wrapper })
  expect(link.lastSubscriptionMatches(MISCHIEF_SUBSCRIPTION)).toBeTruthy()
  expect(link.lastSubscription?.variables).toEqual({ catName: 'la don' })

  await waitFor(() => {
    expect(rendered.result.current).toEqual(initialData)
  })

  const updateData = {
    actsOfMischief: {
      __typename: 'ActsOfMischief',
      description: 'pushed that button',
      severity: 'mild',
    },
  }
  link.sendWildcardSubscriptionResult(MISCHIEF_SUBSCRIPTION, {
    data: updateData,
  })
  await waitFor(() => {
    expect(rendered.result.current).toEqual(updateData)
  })
})