@dhau/msw-builders@0.0.35

Built and signed on GitHub Actions

Built and signed on GitHub Actions

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363
import {
  http,
  type DefaultBodyType,
  type ResponseResolver,
  type PathParams,
  type ResponseResolverReturnType,
  type RequestHandlerOptions,
  StrictRequest,
  HttpHandler,
} from "npm:msw@^2.0.4";
import isEqual from "npm:lodash-es@^4.17.21/isEqual.js";
import partial from "npm:lodash-es@^4.17.21/partial.js";
import isMatch from "npm:lodash-es@^4.17.21/isMatch.js";
import mapKeys from "npm:lodash-es@^4.17.21/mapKeys.js";
import trimEnd from "npm:lodash-es@^4.17.21/trimEnd.js";
import trimStart from "npm:lodash-es@^4.17.21/trimStart.js";
import { diff } from "npm:jest-diff@^29.3.1";
import { consoleDebugLog, nullLogger } from "./debug.ts";
import { extractBodyContent } from "./utils.ts";

// Can't use this import, so duplicating
// import { ResponseResolverInfo } from "msw/lib/core/handlers/RequestHandler";
type ResponseResolverInfo<
  ResolverExtraInfo extends Record<string, unknown>,
  RequestBodyType extends DefaultBodyType = DefaultBodyType,
> = {
  request: StrictRequest<RequestBodyType>;
  requestId: string;
} & ResolverExtraInfo;

// Not exported by msw
type HttpRequestResolverExtras<Params extends PathParams> = {
  params: Params;
  cookies: Record<string, string>;
};

// NotFunction didn't work for me, maybe look into in future
// type NotFunction<T> = T extends Function ? never : T;
// type Matcher<T> = NotFunction<T> | ((value: T) => boolean);

type MatcherFunction = (value: unknown) => boolean;

type Matcher<T> = T | MatcherFunction;

type MatcherOptions<
  TSearchParams extends Record<string, string>,
  THeaders extends Record<string, string>,
> = {
  readonly searchParams?: Matcher<TSearchParams>;
  readonly headers?: Matcher<THeaders>;
};

type WithBodyMatcherOptions<
  TSearchParams extends Record<string, string>,
  THeaders extends Record<string, string>,
  RequestBodyType extends DefaultBodyType = DefaultBodyType,
> = MatcherOptions<TSearchParams, THeaders> & {
  readonly body?: Matcher<RequestBodyType>;
};

type HandlerOptions = {
  readonly onCalled?: () => void;
};

type Options = {
  readonly url: string;
  readonly debug?: boolean;
  readonly defaultRequestHandlerOptions?: RequestHandlerOptions;
};

function matchMessage(
  type: string,
  method: string,
  url: string,
  expected: Matcher<unknown>,
  actual: unknown,
) {
  const difference =
    typeof expected === "function"
      ? `doesn't match function matcher`
      : diff(expected, actual);
  return `${method} ${url} ${type} differ\n${difference ?? ""}`;
}

function createFullUrl(baseUrl: string, path: string) {
  if (path === "") {
    return baseUrl;
  }
  return trimEnd(baseUrl, "/") + "/" + trimStart(path, "/");
}

function searchParamsToObject(searchParams: URLSearchParams) {
  const obj: Record<string, string> = {};
  searchParams.forEach((value, key) => {
    obj[key] = value;
  });
  return obj;
}

function passesMatcherContains<T>(matcher: Matcher<T>, value: object) {
  if (
    typeof matcher === "function" &&
    !(matcher as unknown as MatcherFunction)(value)
  ) {
    return false;
  }

  if (!!matcher && typeof matcher === "object" && !isMatch(value, matcher)) {
    return false;
  }

  return true;
}

function passesMatcherEqual<T>(matcher: Matcher<T>, value: unknown) {
  switch (typeof matcher) {
    case "function":
      return (matcher as unknown as MatcherFunction)(value);
    case "object":
      return isEqual(matcher, value);
    default:
      return true;
  }
}

function runMatchers<
  TSearchParams extends Record<string, string>,
  THeaders extends Record<string, string>,
  Params extends PathParams<keyof Params> = PathParams,
  // RequestBodyType extends DefaultBodyType = DefaultBodyType
>(
  { headers, searchParams }: MatcherOptions<TSearchParams, THeaders>,
  fullUrl: string,
  req: Request,
  debugLog: (message: string) => void,
) {
  // Headers. We want to allow other random headers, so we only do a contains match
  // We also want to match case-insensitively
  const actualHeaders = Object.fromEntries(req.headers.entries());
  if (
    headers !== undefined &&
    !passesMatcherContains(
      typeof headers === "object"
        ? mapKeys(headers, (_, k) => k.toLowerCase())
        : headers,
      mapKeys(actualHeaders, (_, k) => k.toLowerCase()),
    )
  ) {
    debugLog(matchMessage("headers", "POST", fullUrl, headers, actualHeaders));
    return false;
  }

  // Search params
  const actualSearchParams = searchParamsToObject(
    new URL(req.url).searchParams,
  );
  if (
    searchParams !== undefined &&
    !passesMatcherEqual(searchParams, actualSearchParams)
  ) {
    debugLog(
      matchMessage(
        "searchParams",
        "POST",
        fullUrl,
        searchParams,
        actualSearchParams,
      ),
    );
    return false;
  }

  return true;
}

type RestHandlersFactory = {
  post: <
    TSearchParams extends Record<string, string>,
    THeaders extends Record<string, string>,
    RequestBodyType extends DefaultBodyType = DefaultBodyType,
    Params extends PathParams<keyof Params> = PathParams,
    ResponseBody extends DefaultBodyType = DefaultBodyType,
  >(
    path: string,
    matchers: WithBodyMatcherOptions<TSearchParams, THeaders, RequestBodyType>,
    response: (
      info: ResponseResolverInfo<
        HttpRequestResolverExtras<Params>,
        RequestBodyType
      >,
    ) =>
      | ResponseResolverReturnType<ResponseBody>
      | Promise<ResponseResolverReturnType<ResponseBody>>,
    options?: HandlerOptions,
  ) => HttpHandler;
  get: <
    TSearchParams extends Record<string, string>,
    THeaders extends Record<string, string>,
    Params extends PathParams<keyof Params> = PathParams,
    ResponseBody extends DefaultBodyType = DefaultBodyType,
  >(
    path: string,
    matchers: MatcherOptions<TSearchParams, THeaders>,
    response: ResponseResolver<
      HttpRequestResolverExtras<Params>,
      never,
      ResponseBody
    >,
    options?: HandlerOptions,
  ) => HttpHandler;
  options: <
    TSearchParams extends Record<string, string>,
    THeaders extends Record<string, string>,
    Params extends PathParams<keyof Params> = PathParams,
    ResponseBody extends DefaultBodyType = DefaultBodyType,
  >(
    path: string,
    matchers: MatcherOptions<TSearchParams, THeaders>,
    response: ResponseResolver<
      HttpRequestResolverExtras<Params>,
      never,
      ResponseBody
    >,
    options?: HandlerOptions,
  ) => HttpHandler;
};

function createRestHandlersFactory({
  url,
  debug,
  defaultRequestHandlerOptions,
}: Options): RestHandlersFactory {
  const debugLog = debug ? partial(consoleDebugLog, url) : nullLogger;
  return {
    options: <
      TSearchParams extends Record<string, string>,
      THeaders extends Record<string, string>,
      Params extends PathParams<keyof Params> = PathParams,
      ResponseBody extends DefaultBodyType = DefaultBodyType,
    >(
      path: string,
      matchers: MatcherOptions<TSearchParams, THeaders>,
      response: ResponseResolver<
        HttpRequestResolverExtras<Params>,
        never,
        ResponseBody
      >,
      options?: HandlerOptions,
    ) => {
      const { onCalled, ...rest } = {
        ...defaultRequestHandlerOptions,
        ...options,
      };
      const fullUrl = createFullUrl(url, path);
      return http.options<Params, never, ResponseBody>(
        fullUrl,
        (info) => {
          if (!runMatchers(matchers, fullUrl, info.request, debugLog)) {
            return;
          }

          onCalled?.();
          return response(info);
        },
        rest,
      );
    },
    get: <
      TSearchParams extends Record<string, string>,
      THeaders extends Record<string, string>,
      Params extends PathParams<keyof Params> = PathParams,
      ResponseBody extends DefaultBodyType = DefaultBodyType,
    >(
      path: string,
      matchers: MatcherOptions<TSearchParams, THeaders>,
      response: ResponseResolver<
        HttpRequestResolverExtras<Params>,
        never,
        ResponseBody
      >,
      options?: HandlerOptions,
    ) => {
      const { onCalled, ...rest } = {
        ...defaultRequestHandlerOptions,
        ...options,
      };
      const fullUrl = createFullUrl(url, path);
      return http.get<Params, never, ResponseBody>(
        fullUrl,
        (info) => {
          if (!runMatchers(matchers, fullUrl, info.request, debugLog)) {
            return;
          }

          onCalled?.();
          return response(info);
        },
        rest,
      );
    },
    post: <
      TSearchParams extends Record<string, string>,
      THeaders extends Record<string, string>,
      RequestBodyType extends DefaultBodyType = DefaultBodyType,
      Params extends PathParams<keyof Params> = PathParams,
      ResponseBody extends DefaultBodyType = DefaultBodyType,
    >(
      path: string,
      matchers: WithBodyMatcherOptions<
        TSearchParams,
        THeaders,
        RequestBodyType
      >,
      response: (
        info: ResponseResolverInfo<
          HttpRequestResolverExtras<Params>,
          RequestBodyType
        >,
        // Parameters<
        //   ResponseResolver<
        //     HttpRequestResolverExtras<Params>,
        //     RequestBodyType,
        //     ResponseBody
        //   >
        // >[0],
      ) =>
        | ResponseResolverReturnType<ResponseBody>
        | Promise<ResponseResolverReturnType<ResponseBody>>,
      options?: HandlerOptions,
    ) => {
      const { onCalled, ...rest } = {
        ...defaultRequestHandlerOptions,
        ...options,
      };
      const fullUrl = createFullUrl(url, path);
      return http.post<Params, RequestBodyType, ResponseBody>(
        fullUrl,
        async (info) => {
          const { request } = info;
          const { body } = matchers;

          if (!runMatchers(matchers, fullUrl, request, debugLog)) {
            return undefined;
          }

          // Body. Cloning important because multiple handlers may read body
          const actualBody = await extractBodyContent(request.clone());
          if (body !== undefined && !passesMatcherEqual(body, actualBody)) {
            debugLog(matchMessage("body", "POST", fullUrl, body, actualBody));
            return undefined;
          }

          onCalled?.();
          return response(info);
        },
        rest,
      );
    },
  };
}

export type { RestHandlersFactory };
export { createRestHandlersFactory };