test: useAllPrismicDocumentsByUIDs and usePrismicDocumentsByUIDs

test/useAllPrismicDocumentsByUIDs.test.tsx

@@ -0,0 +1,157 @@
+/* eslint-disable react/display-name  */
+/* eslint-disable react/prop-types */
+
+import test from "ava";
+import * as React from "react";
+import * as msw from "msw";
+import * as mswNode from "msw/node";
+import * as prismic from "@prismicio/client";
+import { renderHook, cleanup } from "@testing-library/react-hooks";
+
+import { createClient } from "./__testutils__/createClient";
+import { createMockQueryHandler } from "./__testutils__/createMockQueryHandler";
+import { createMockRepositoryHandler } from "./__testutils__/createMockRepositoryHandler";
+import { createQueryResponsePages } from "./__testutils__/createQueryResponsePages";
+import { createRepositoryResponse } from "./__testutils__/createRepositoryResponse";
+import { getMasterRef } from "./__testutils__/getMasterRef";
+import { md5 } from "./__testutils__/md5";
+
+import { PrismicProvider, useAllPrismicDocumentsByUIDs } from "../src";
+
+const server = mswNode.setupServer();
+test.before(() => server.listen({ onUnhandledRequest: "error" }));
+test.after(() => server.close());
+
+// We must clean up after each test. We also must run each test serially to
+// ensure the clean up process only occurs between tests.
+test.afterEach(() => {
+	cleanup();
+});
+
+const createWrapper = (client: prismic.Client): React.ComponentType => {
+	return (props) => <PrismicProvider client={client} {...props} />;
+};
+
+test.serial("returns documents with matching UIDs", async (t) => {
+	const client = createClient(t);
+	const wrapper = createWrapper(client);
+	const repositoryResponse = createRepositoryResponse();
+	const queryResponsePages = createQueryResponsePages();
+	const documents = queryResponsePages.flatMap((page) => page.results);
+	const documentUIDs = documents.map((doc) => doc.uid as string);
+	const documentType = documents[0].uid as string;
+	const ref = getMasterRef(repositoryResponse);
+
+	server.use(
+		createMockRepositoryHandler(t, repositoryResponse),
+		createMockQueryHandler(t, queryResponsePages, {
+			ref,
+			q: [
+				`[${prismic.predicate.at("document.type", documentType)}]`,
+				`[${prismic.predicate.in(`my.${documentType}.uid`, documentUIDs)}]`,
+			],
+			pageSize: 100,
+		}),
+	);
+
+	const { result, waitForValueToChange } = renderHook(
+		() => useAllPrismicDocumentsByUIDs(documentType, documentUIDs),
+		{ wrapper },
+	);
+
+	await waitForValueToChange(() => result.current[1].state === "loaded");
+
+	t.deepEqual(result.current[0], documents);
+});
+
+test.serial("supports params", async (t) => {
+	const client = createClient(t);
+	const wrapper = createWrapper(client);
+	const repositoryResponse = createRepositoryResponse();
+	const queryResponsePages = createQueryResponsePages();
+	const documents = queryResponsePages.flatMap((page) => page.results);
+	const documentUIDs = documents.map((doc) => doc.uid as string);
+	const documentType = documents[0].uid as string;
+	const ref = getMasterRef(repositoryResponse);
+
+	const params = {
+		pageSize: 2,
+	};
+
+	server.use(
+		createMockRepositoryHandler(t, repositoryResponse),
+		createMockQueryHandler(t, queryResponsePages, {
+			ref,
+			q: [
+				`[${prismic.predicate.at("document.type", documentType)}]`,
+				`[${prismic.predicate.in(`my.${documentType}.uid`, documentUIDs)}]`,
+			],
+			pageSize: params.pageSize.toString(),
+		}),
+	);
+
+	const { result, waitForValueToChange } = renderHook(
+		() => useAllPrismicDocumentsByUIDs(documentType, documentUIDs, params),
+		{ wrapper },
+	);
+
+	await waitForValueToChange(() => result.current[1].state === "loaded");
+
+	t.deepEqual(result.current[0], documents);
+});
+
+test.serial("supports explicit client", async (t) => {
+	const client = createClient(t);
+	const repositoryResponse = createRepositoryResponse();
+	const queryResponsePages = createQueryResponsePages();
+	const documents = queryResponsePages.flatMap((page) => page.results);
+	const documentUIDs = documents.map((doc) => doc.uid as string);
+	const documentType = documents[0].uid as string;
+	const ref = getMasterRef(repositoryResponse);
+
+	server.use(
+		createMockRepositoryHandler(t, repositoryResponse),
+		createMockQueryHandler(t, queryResponsePages, {
+			ref,
+			q: [
+				`[${prismic.predicate.at("document.type", documentType)}]`,
+				`[${prismic.predicate.in(`my.${documentType}.uid`, documentUIDs)}]`,
+			],
+			pageSize: 100,
+		}),
+	);
+
+	const { result, waitForValueToChange } = renderHook(() =>
+		useAllPrismicDocumentsByUIDs(documentType, documentUIDs, { client }),
+	);
+
+	await waitForValueToChange(() => result.current[1].state === "loaded");
+
+	t.deepEqual(result.current[0], documents);
+});
+
+test.serial("returns failed state on error", async (t) => {
+	const client = createClient(t);
+	const wrapper = createWrapper(client);
+	const repositoryResponse = {
+		message: "invalid access token",
+		oauth_initiate: "oauth_initiate",
+		oauth_token: "oauth_token",
+	};
+
+	server.use(
+		msw.rest.get(prismic.getEndpoint(md5(t.title)), (_req, res, ctx) => {
+			return res(ctx.status(403), ctx.json(repositoryResponse));
+		}),
+	);
+
+	const { result, waitForValueToChange } = renderHook(
+		() => useAllPrismicDocumentsByUIDs("type", ["uid1", "uid2"]),
+		{ wrapper },
+	);
+
+	await waitForValueToChange(() => result.current[1].state === "failed");
+
+	t.true(result.current[1].error instanceof prismic.ForbiddenError);
+	t.is(result.current[0], undefined);
+});

test/usePrismicDocumentsByUIDs.test.tsx

@@ -0,0 +1,155 @@
+/* eslint-disable react/display-name  */
+/* eslint-disable react/prop-types */
+
+import test from "ava";
+import * as React from "react";
+import * as msw from "msw";
+import * as mswNode from "msw/node";
+import * as prismic from "@prismicio/client";
+import { renderHook, cleanup } from "@testing-library/react-hooks";
+
+import { createClient } from "./__testutils__/createClient";
+import { createMockQueryHandler } from "./__testutils__/createMockQueryHandler";
+import { createMockRepositoryHandler } from "./__testutils__/createMockRepositoryHandler";
+import { createQueryResponsePages } from "./__testutils__/createQueryResponsePages";
+import { createRepositoryResponse } from "./__testutils__/createRepositoryResponse";
+import { getMasterRef } from "./__testutils__/getMasterRef";
+import { md5 } from "./__testutils__/md5";
+
+import { PrismicProvider, usePrismicDocumentsByUIDs } from "../src";
+
+const server = mswNode.setupServer();
+test.before(() => server.listen({ onUnhandledRequest: "error" }));
+test.after(() => server.close());
+
+// We must clean up after each test. We also must run each test serially to
+// ensure the clean up process only occurs between tests.
+test.afterEach(() => {
+	cleanup();
+});
+
+const createWrapper = (client: prismic.Client): React.ComponentType => {
+	return (props) => <PrismicProvider client={client} {...props} />;
+};
+
+test.serial("returns documents with matching UIDs", async (t) => {
+	const client = createClient(t);
+	const wrapper = createWrapper(client);
+	const repositoryResponse = createRepositoryResponse();
+	const queryResponsePages = createQueryResponsePages();
+	const documents = queryResponsePages[0].results;
+	const documentUIDs = documents.map((doc) => doc.uid as string);
+	const documentType = documents[0].uid as string;
+	const ref = getMasterRef(repositoryResponse);
+
+	server.use(
+		createMockRepositoryHandler(t, repositoryResponse),
+		createMockQueryHandler(t, queryResponsePages, {
+			ref,
+			q: [
+				`[${prismic.predicate.at("document.type", documentType)}]`,
+				`[${prismic.predicate.in(`my.${documentType}.uid`, documentUIDs)}]`,
+			],
+		}),
+	);
+
+	const { result, waitForValueToChange } = renderHook(
+		() => usePrismicDocumentsByUIDs(documentType, documentUIDs),
+		{ wrapper },
+	);
+
+	await waitForValueToChange(() => result.current[1].state === "loaded");
+
+	t.deepEqual(result.current[0], queryResponsePages[0]);
+});
+
+test.serial("supports params", async (t) => {
+	const client = createClient(t);
+	const wrapper = createWrapper(client);
+	const repositoryResponse = createRepositoryResponse();
+	const queryResponsePages = createQueryResponsePages();
+	const documents = queryResponsePages[0].results;
+	const documentUIDs = documents.map((doc) => doc.uid as string);
+	const documentType = documents[0].uid as string;
+	const ref = getMasterRef(repositoryResponse);
+
+	const params = {
+		pageSize: 2,
+	};
+
+	server.use(
+		createMockRepositoryHandler(t, repositoryResponse),
+		createMockQueryHandler(t, queryResponsePages, {
+			ref,
+			q: [
+				`[${prismic.predicate.at("document.type", documentType)}]`,
+				`[${prismic.predicate.in(`my.${documentType}.uid`, documentUIDs)}]`,
+			],
+			pageSize: params.pageSize.toString(),
+		}),
+	);
+
+	const { result, waitForValueToChange } = renderHook(
+		() => usePrismicDocumentsByUIDs(documentType, documentUIDs, params),
+		{ wrapper },
+	);
+
+	await waitForValueToChange(() => result.current[1].state === "loaded");
+
+	t.deepEqual(result.current[0], queryResponsePages[0]);
+});
+
+test.serial("supports explicit client", async (t) => {
+	const client = createClient(t);
+	const repositoryResponse = createRepositoryResponse();
+	const queryResponsePages = createQueryResponsePages();
+	const documents = queryResponsePages[0].results;
+	const documentUIDs = documents.map((doc) => doc.uid as string);
+	const documentType = documents[0].uid as string;
+	const ref = getMasterRef(repositoryResponse);
+
+	server.use(
+		createMockRepositoryHandler(t, repositoryResponse),
+		createMockQueryHandler(t, queryResponsePages, {
+			ref,
+			q: [
+				`[${prismic.predicate.at("document.type", documentType)}]`,
+				`[${prismic.predicate.in(`my.${documentType}.uid`, documentUIDs)}]`,
+			],
+		}),
+	);
+
+	const { result, waitForValueToChange } = renderHook(() =>
+		usePrismicDocumentsByUIDs(documentType, documentUIDs, { client }),
+	);
+
+	await waitForValueToChange(() => result.current[1].state === "loaded");
+
+	t.deepEqual(result.current[0], queryResponsePages[0]);
+});
+
+test.serial("returns failed state on error", async (t) => {
+	const client = createClient(t);
+	const wrapper = createWrapper(client);
+	const repositoryResponse = {
+		message: "invalid access token",
+		oauth_initiate: "oauth_initiate",
+		oauth_token: "oauth_token",
+	};
+
+	server.use(
+		msw.rest.get(prismic.getEndpoint(md5(t.title)), (_req, res, ctx) => {
+			return res(ctx.status(403), ctx.json(repositoryResponse));
+		}),
+	);
+
+	const { result, waitForValueToChange } = renderHook(
+		() => usePrismicDocumentsByUIDs("type", ["uid1", "uid2"]),
+		{ wrapper },
+	);
+
+	await waitForValueToChange(() => result.current[1].state === "failed");
+
+	t.true(result.current[1].error instanceof prismic.ForbiddenError);
+	t.is(result.current[0], undefined);
+});