@shopify/shopify-api/lib/__test-helpers__/to-match-made-http-request.ts

Shopify API Library for Node - accelerate development with support for authentication, graphql proxy, webhooks

import type {MatcherFunction} from 'expect';

import {mockTestRequests} from '../../adapters/mock/mock_test_requests';
import {canonicalizeHeaders} from '../../runtime';

interface ExpectRequestParams {
  method: string;
  domain: string;
  path: string;
  query?: string;
  headers?: Record<string, any>;
  data?: string | Record<string, any> | null;
  attempts?: number;
}

export const toMatchMadeHttpRequest: MatcherFunction = ({
  method,
  domain,
  path,
  query = '',
  headers = {},
  data = undefined,
  attempts = 1,
}: ExpectRequestParams) => {
  const searchHeaders = canonicalizeHeaders(headers as any);
  const searchUrl = new URL(
    `https://${domain}${path}${query ? `?${query}` : ''}`,
  );

  // We compare the sorted query items, so we can expect arguments in a different order
  const searchQueryItems = Array.from(searchUrl.searchParams.entries()).sort();
  const cleanSearchUrl = searchUrl.toString().split('?')[0];

  for (let i = 0; i < attempts; i++) {
    const matchingRequest = mockTestRequests.getRequest();
    if (!matchingRequest) {
      throw new Error(
        `No request was made, but expected ${JSON.stringify(
          {method, domain, path},
          undefined,
          2,
        )}`,
      );
    }

    const requestUrl = new URL(matchingRequest!.url);
    const requestQueryItems = Array.from(
      requestUrl.searchParams.entries(),
    ).sort();
    const cleanRequestUrl = requestUrl.toString().split('?')[0];

    expect(matchingRequest).not.toBeNull();
    expect(matchingRequest!.method).toEqual(method);
    expect(matchingRequest!.headers).toMatchObject(searchHeaders);
    expect(cleanRequestUrl).toEqual(cleanSearchUrl);
    expect(requestQueryItems).toEqual(searchQueryItems);

    if (data) {
      if (
        typeof data === 'string' ||
        data.constructor.name === 'StringContaining'
      ) {
        expect(matchingRequest!.body).toEqual(data);
      } else {
        const requestBody =
          typeof matchingRequest!.body === 'string'
            ? JSON.parse(matchingRequest!.body)
            : matchingRequest!.body;
        expect(requestBody).toMatchObject(data);
      }
    } else {
      expect(matchingRequest!.body).toBeFalsy();
    }
  }

  return {
    message: () => '',
    pass: true,
  };
};