-
Notifications
You must be signed in to change notification settings - Fork 40
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: add *BySomeTags and *ByEveryTag hooks
- Loading branch information
1 parent
c02a557
commit 7faa6b3
Showing
6 changed files
with
360 additions
and
24 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,145 @@ | ||
| /* 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, useAllPrismicDocumentsBySomeTags } 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 IDs", async (t) => { | ||
| const client = createClient(t); | ||
| const wrapper = createWrapper(client); | ||
| const repositoryResponse = createRepositoryResponse(); | ||
| const queryResponsePages = createQueryResponsePages(); | ||
| const documents = queryResponsePages.flatMap((page) => page.results); | ||
| const tags = documents[0].tags; | ||
| const ref = getMasterRef(repositoryResponse); | ||
|
|
||
| server.use( | ||
| createMockRepositoryHandler(t, repositoryResponse), | ||
| createMockQueryHandler(t, queryResponsePages, { | ||
| ref, | ||
| q: `[${prismic.predicate.any("document.tags", tags)}]`, | ||
| pageSize: 100, | ||
| }), | ||
| ); | ||
|
|
||
| const { result, waitForValueToChange } = renderHook( | ||
| () => useAllPrismicDocumentsBySomeTags(tags), | ||
| { 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 tags = documents[0].tags; | ||
| const ref = getMasterRef(repositoryResponse); | ||
|
|
||
| const params = { | ||
| pageSize: 2, | ||
| }; | ||
|
|
||
| server.use( | ||
| createMockRepositoryHandler(t, repositoryResponse), | ||
| createMockQueryHandler(t, queryResponsePages, { | ||
| ref, | ||
| q: `[${prismic.predicate.any("document.tags", tags)}]`, | ||
| pageSize: params.pageSize.toString(), | ||
| }), | ||
| ); | ||
|
|
||
| const { result, waitForValueToChange } = renderHook( | ||
| () => useAllPrismicDocumentsBySomeTags(tags, 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 tags = documents[0].tags; | ||
| const ref = getMasterRef(repositoryResponse); | ||
|
|
||
| server.use( | ||
| createMockRepositoryHandler(t, repositoryResponse), | ||
| createMockQueryHandler(t, queryResponsePages, { | ||
| ref, | ||
| q: `[${prismic.predicate.any("document.tags", tags)}]`, | ||
| pageSize: 100, | ||
| }), | ||
| ); | ||
|
|
||
| const { result, waitForValueToChange } = renderHook(() => | ||
| useAllPrismicDocumentsBySomeTags(tags, { 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( | ||
| () => useAllPrismicDocumentsBySomeTags(["tag", "tag2"]), | ||
| { wrapper }, | ||
| ); | ||
|
|
||
| await waitForValueToChange(() => result.current[1].state === "failed"); | ||
|
|
||
| t.true(result.current[1].error instanceof prismic.ForbiddenError); | ||
| t.is(result.current[0], undefined); | ||
| }); |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.