コンポーネントがuseRouterフックで正しくレンダリングされることを確認したいので(実際には、新しい動的ルーティングがどのように機能するかを理解しようとしています)、次のコードがあります。
import React from 'react';
import { NextPage } from 'next';
import { useRouter } from 'next/router';
const UserInfo : NextPage = () => {
const router = useRouter();
const { query } = router;
return <div>Hello {query.user}</div>;
};
export default UserInfo;
そして私が試しているのは:
// test
import { render, cleanup, waitForElement } from '@testing-library/react';
import UserInfo from './$user';
// somehow mock useRouter for $user component!!!
afterEach(cleanup);
it('Should render correctly on route: /users/nikita', async () => {
const { getByText } = render(<UserInfo />);
await waitForElement(() => getByText(/Hello nikita!/i));
});
しかし、 const router = useRouter();
行を指すエラーTypeError: Cannot read property 'query' of null
が発生します。
PSダイナミックルーティングは今のところカナリアバージョンで利用可能であり、変更される可能性があることを知っていますが、WIP機能ではなくルーターで問題が発生します(私ですか?)。
こんにちは、この機能はまだ実験段階ですが、 useRouter
はReact.useContext
を使用してnext-server/dist/lib/router-context
からコンテキストを消費します。 それをモックするには、この行と同様に、そこからコンテキストプロバイダーでラップする必要があります
@ijjkこんにちは、ありがとうございます!
正しくやっているかどうかはわかりませんが、テストは合格です😂
import { render, cleanup, waitForElement } from '@testing-library/react';
import { createRouter } from 'next/router';
import { RouterContext } from 'next-server/dist/lib/router-context';
const router = createRouter('', { user: 'nikita' }, '', {
initialProps: {},
pageLoader: jest.fn(),
App: jest.fn(),
Component: jest.fn(),
});
import UserInfo from './$user';
afterEach(cleanup);
it('Should render correctly on route: /users/nikita', async () => {
const { getByText } = render(
<RouterContext.Provider value={router}>
<UserInfo />
</RouterContext.Provider>,
);
await waitForElement(() => getByText(/Hello nikita!/i));
});
クエリパラメータをモックするより抽象的な方法がある場合は、実際のルート(たとえば、 /users/nikita
)を渡して、ファイルにパスを渡すことができますか? どう思いますか?
APIは内部にあり、いつでも変更できるため、 createRouter
を呼び出すので
import React from 'react'
import { render } from '@testing-library/react'
import { RouterContext } from 'next-server/dist/lib/router-context'
describe('Basic test', () => {
it('Renders current user value', async () => {
const router = {
pathname: '/users/$user',
route: '/users/$user',
query: { user: 'nikita' },
asPath: '/users/nikita',
}
const User = require('../pages/users/$user').default
const tree = render(
<RouterContext.Provider value={router}>
<User />
</RouterContext.Provider>
)
expect(tree.getByText('User: nikita')).toBeTruthy()
})
})
理にかなっている
Enzyme + Jestを使用してuseRouterをモックする方法はありますか? 私はオンラインで少し検索してきましたが、関連する結果はこの問題だけです。
私はなんとかそれをこのようにモックしました。
import * as nextRouter from 'next/router';
nextRouter.useRouter = jest.fn();
nextRouter.useRouter.mockImplementation(() => ({ route: '/' }));
jest.spyOn
は私にも役立ちます-
import React from 'react'
import { render } from '@testing-library/react'
import ResultsProductPage from 'pages/results/[product]'
const useRouter = jest.spyOn(require('next/router'), 'useRouter')
describe('ResultsProductPage', () => {
it('renders - display mode list', () => {
useRouter.mockImplementationOnce(() => ({
query: { product: 'coffee' },
}))
const { container } = render(
<ResultsProductPage items={[{ name: 'mocha' }]} />
)
expect(container).toMatchSnapshot()
})
})
私はこのようにそれをあざけることになりました、私はuseRouter
エクスポートだけを必要とするので、これは私の目的のために十分にうまくいきました:
jest.mock("next/router", () => ({
useRouter() {
return {
route: "/",
pathname: "",
query: "",
asPath: "",
};
},
}));
命令型のprefetch
からの干渉を避けるために、誰かがuseRouter
をモックしようとしている場合、この死んだ単純なモックは機能します
jest.mock("next/router", () => ({
useRouter() {
return {
prefetch: () => null
};
}
}));
ユースケースの例は、次のようなものを含むフォームコンポーネントです。
const router = useRouter();
useEffect(() => {
router.prefetch("/success");
if (confirmSuccess) {
doStuff();
router.push( {pathname: "/success" } )
}
}, [data]);
@ijjkその動作は最新バージョンで変更されましたか? next/dist/next-server/lib/router-context
からインポートする必要がありました。 next-server
個別にインストールした場合、コンテキストが認識されません。
私はまったく同じ問題を抱えています。
私たちは次の9の下にいます。 RouterContext.Provider
を使用するソリューションはどれも実際には機能しません。
私のテストパスの唯一の方法は、 @ aekscoソリューションをテストの上のグローバルオブジェクトとして使用することuseRouter
は常に未定義です。
テストに異なるパラメータを設定できないため、これは理想的ではありません。
これに関するアイデアはありますか?
編集
私はそれがのグローバルモックで働かせたnext/router
インポートおよびspyOn
私は呼び出すことができますモック、にmockImplementation(() => ({// whatever you want})
各テストで。
それは次のように見えます:
jest.mock("next/router", () => ({
useRouter() {
return {
route: "",
pathname: "",
query: "",
asPath: "",
};
},
}));
const useRouter = jest.spyOn(require("next/router"), "useRouter");
次に、テストで:
useRouter.mockImplementation(() => ({
route: "/yourRoute",
pathname: "/yourRoute",
query: "",
asPath: "",
}));
これは理想的ではありませんが、少なくとも私にとってはうまくいきます
FWIWこれは私が決めたものです:
import { RouterContext } from 'next/dist/next-server/lib/router-context'
import { action } from '@storybook/addon-actions'
import PropTypes from 'prop-types'
import { useState } from 'react'
import Router from 'next/router'
function RouterMock({ children }) {
const [pathname, setPathname] = useState('/')
const mockRouter = {
pathname,
prefetch: () => {},
push: async newPathname => {
action('Clicked link')(newPathname)
setPathname(newPathname)
}
}
Router.router = mockRouter
return (
<RouterContext.Provider value={mockRouter}>
{children}
</RouterContext.Provider>
)
}
RouterMock.propTypes = {
children: PropTypes.node.isRequired
}
export default RouterMock
StorybookとJestの両方で機能するものが必要でした。 これでうまくいくようです。コンポーネントツリーのどこかに<Routermock>
設定するだけです。 Router.router
常にオーバーライドするのは好きではないので、理想的ではありません。
私は公式のモックソリューションが素敵だと思います:)
@smasontstのメソッドは機能しましたが、 mockImplementationOnce()
注意してください...テスト中にコンポーネントを複数回レンダリングする必要がある場合は、2回目のレンダリングでモックルーターを使用していないことがわかります。テストは失敗します。 mockImplementationOnce()
を使用する特別な理由がない限り、代わりに常にmockImplementation()
使用するのがおそらく最善です。
テストごとに一意のuseRouter
状態が必要だったため、最初の実装を修正する必要がありました。 @ nterol24sによって提供された例からページを
// Mocks useRouter
const useRouter = jest.spyOn(require("next/router"), "useRouter");
/**
* mockNextUseRouter
* Mocks the useRouter React hook from Next.js on a test-case by test-case basis
*/
export function mockNextUseRouter(props: {
route: string;
pathname: string;
query: string;
asPath: string;
}) {
useRouter.mockImplementationOnce(() => ({
route: props.route,
pathname: props.pathname,
query: props.query,
asPath: props.asPath,
}));
}
私は今、次のようなことができます:
import { mockNextUseRouter } from "@src/test_util";
describe("Pricing Page", () => {
// Mocks Next.js route
mockNextUseRouter({
route: "/pricing",
pathname: "/pricing",
query: "",
asPath: `/pricing?error=${encodeURIComponent("Uh oh - something went wrong")}`,
});
test("render with error param", () => {
const tree: ReactTestRendererJSON = Renderer.create(
<ComponentThatDependsOnUseRouter />
).toJSON();
expect(tree).toMatchSnapshot();
});
});
@mbrowneによるコメントに注意してください。このアプローチでも同じ問題が発生しますが、必要にmockNextUseRouter
mockNextUseRouterOnce
関数と
また、BIG:+1:公式のモックソリューション@timneutkens
グローバルにモックされたRouter
インスタンスが必要な場合は、 __mocks__
フォルダーを任意の場所に配置し、次のようにnext/router
パッケージをターゲットにすることができます。
__mocks__/next/router/index.js
(このフォルダー構造パターンに従う必要があります!)
以下のこの例は、 Router.push
とRouter.replace
ます。
jest.mock("next/router", () => ({
// spread out all "Router" exports
...require.requireActual("next/router"),
// shallow merge the "default" exports with...
default: {
// all actual "default" exports...
...require.requireActual("next/router").default,
// and overwrite push and replace to be jest functions
push: jest.fn(),
replace: jest.fn(),
},
}));
// export the mocked instance above
module.exports = require.requireMock("next/router");
これで、 import Router from "next/router";
ところならどこでも、それはモックインスタンスになります。 また、グローバルにモックされるため、 mockImplementation
関数を追加することもできます。
テストごとにこのインスタンスをリセットする場合は、 jest.json
にclearMocksプロパティを追加します。
参考までに、特定のエクスポートをターゲットにする場合のRouter
構造は次のとおりです。
{
__esModule: true,
useRouter: [Function: useRouter],
makePublicRouterInstance: [Function: makePublicRouterInstance],
default: {
router: null,
readyCallbacks: [
[Function],
[Function],
[Function],
[Function],
[Function],
[Function]
],
ready: [Function: ready],
push: [Function],
replace: [Function],
reload: [Function],
back: [Function],
prefetch: [Function],
beforePopState: [Function] },
withRouter: [Function: withRouter],
createRouter: [Function: createRouter],
Router: {
[Function: Router]
events: {
on: [Function: on],
off: [Function: off],
emit: [Function: emit]
}
},
NextRouter: undefined
}
}
さらに、 withRouter
またはuseRouter
を使用するコンポーネントをmount
する必要があり、それらをモックしたくないが、それでも
import { createElement } from "react";
import { mount } from "enzyme";
import { RouterContext } from "next/dist/next-server/lib/router-context";
// Important note: The RouterContext import will vary based upon the next version you're using;
// in some versions, it's a part of the next package, in others, it's a separate package
/**
* Factory function to create a mounted RouterContext wrapper for a React component
*
* <strong i="33">@function</strong> withRouterContext
* <strong i="34">@param</strong> {node} Component - Component to be mounted
* <strong i="35">@param</strong> {object} initialProps - Component initial props for setup.
* <strong i="36">@param</strong> {object} state - Component initial state for setup.
* <strong i="37">@param</strong> {object} router - Initial route options for RouterContext.
* <strong i="38">@param</strong> {object} options - Optional options for enzyme's mount function.
* <strong i="39">@function</strong> createElement - Creates a wrapper around passed in component (now we can use wrapper.setProps on root)
* <strong i="40">@returns</strong> {wrapper} - a mounted React component with Router context.
*/
export const withRouterContext = (
Component,
initialProps = {},
state = null,
router = {
pathname: "/",
route: "/",
query: {},
asPath: "/",
},
options = {},
) => {
const wrapper = mount(
createElement(
props => (
<RouterContext.Provider value={router}>
<Component { ...props } />
</RouterContext.Provider>
),
initialProps,
),
options,
);
if (state) wrapper.find(Component).setState(state);
return wrapper;
};
使用例:
import React from "react";
import withRouterContext from "./path/to/reusable/test/utils"; // alternatively you can make this global
import ExampleComponent from "./index";
const initialProps = {
id: "0123456789",
firstName: "John",
lastName: "Smith"
};
const router = {
pathname: "/users/$user",
route: "/users/$user",
query: { user: "john" },
asPath: "/users/john",
};
const wrapper = withRouterContext(ExampleComponent, initialProps, null, router);
...etc
なぜこれを使うのですか? 再利用可能なマウントされたReactコンポーネントをルーターコンテキストでラップできるためです。 そして最も重要なことは、ルートコンポーネントでwrapper.setProps(..)
を呼び出すことができることです!
import { useRouter } from 'next/router'
jest.mock('next/router', () => ({
__esModule: true,
useRouter: jest.fn()
}))
describe('XXX', () => {
it('XXX', () => {
const mockRouter = {
push: jest.fn() // the component uses `router.push` only
}
;(useRouter as jest.Mock).mockReturnValue(mockRouter)
// ...
expect(mockRouter.push).toHaveBeenCalledWith('/hello/world')
})
})
これらの解決策はどれも私にはうまくいきませんでした。 「正しい」ワークフローについては、Jestのドキュメントでも説明されています:
しかし、私はモックを見ることができますが、それは通話を記録しません...
これが私の現在のtest-utils.tsx
です。 グローバルモックを使用するよりも、これがはるかに好きです。
import React from 'react';
import { render as defaultRender } from '@testing-library/react';
import { RouterContext } from 'next/dist/next-server/lib/router-context';
import { NextRouter } from 'next/router';
export * from '@testing-library/react';
// --------------------------------------------------
// Override the default test render with our own
//
// You can override the router mock like this:
//
// const { baseElement } = render(<MyComponent />, {
// router: { pathname: '/my-custom-pathname' },
// });
// --------------------------------------------------
type DefaultParams = Parameters<typeof defaultRender>;
type RenderUI = DefaultParams[0];
type RenderOptions = DefaultParams[1] & { router?: Partial<NextRouter> };
export function render(
ui: RenderUI,
{ wrapper, router, ...options }: RenderOptions = {},
) {
if (!wrapper) {
wrapper = ({ children }) => (
<RouterContext.Provider value={{ ...mockRouter, ...router }}>
{children}
</RouterContext.Provider>
);
}
return defaultRender(ui, { wrapper, ...options });
}
const mockRouter: NextRouter = {
basePath: '',
pathname: '/',
route: '/',
asPath: '/',
query: {},
push: jest.fn(),
replace: jest.fn(),
reload: jest.fn(),
back: jest.fn(),
prefetch: jest.fn(),
beforePopState: jest.fn(),
events: {
on: jest.fn(),
off: jest.fn(),
emit: jest.fn(),
},
isFallback: false,
};
@flybayerありがとう! よく働く!
@flybayerのソリューションは私にとっては
import { render as defaultRender, RenderResult } from '@testing-library/react'
...
export function render(
ui: RenderUI,
{ wrapper, router, ...options }: RenderOptions = {}
): RenderResult { ... }
グローバルにモックされた
Router
インスタンスが必要な場合は、__mocks__
フォルダーを任意の場所に配置し、次のようにnext/router
パッケージをターゲットにすることができます。
__mocks__/next/router/index.js
(このフォルダー構造パターンに従う必要があります!)以下のこの例は、
Router.push
とRouter.replace
ます。jest.mock("next/router", () => ({ // spread out all "Router" exports ...require.requireActual("next/router"), // shallow merge the "default" exports with... default: { // all actual "default" exports... ...require.requireActual("next/router").default, // and overwrite push and replace to be jest functions push: jest.fn(), replace: jest.fn(), }, })); // export the mocked instance above module.exports = require.requireMock("next/router");
これで、
import Router from "next/router";
ところならどこでも、それはモックインスタンスになります。 また、グローバルにモックされるため、mockImplementation
関数を追加することもできます。
テストごとにこのインスタンスをリセットする場合は、jest.json
にclearMocksプロパティを追加します。参考までに、特定のエクスポートをターゲットにする場合の
Router
構造は次のとおりです。{ __esModule: true, useRouter: [Function: useRouter], makePublicRouterInstance: [Function: makePublicRouterInstance], default: { router: null, readyCallbacks: [ [Function], [Function], [Function], [Function], [Function], [Function] ], ready: [Function: ready], push: [Function], replace: [Function], reload: [Function], back: [Function], prefetch: [Function], beforePopState: [Function] }, withRouter: [Function: withRouter], createRouter: [Function: createRouter], Router: { [Function: Router] events: { on: [Function: on], off: [Function: off], emit: [Function: emit] } }, NextRouter: undefined } }
さらに、
withRouter
またはuseRouter
を使用するコンポーネントをmount
する必要があり、それらをモックしたくないが、それでもimport { createElement } from "react"; import { mount } from "enzyme"; import { RouterContext } from "next/dist/next-server/lib/router-context"; // Important note: The RouterContext import will vary based upon the next version you're using; // in some versions, it's a part of the next package, in others, it's a separate package /** * Factory function to create a mounted RouterContext wrapper for a React component * * <strong i="33">@function</strong> withRouterContext * <strong i="34">@param</strong> {node} Component - Component to be mounted * <strong i="35">@param</strong> {object} initialProps - Component initial props for setup. * <strong i="36">@param</strong> {object} state - Component initial state for setup. * <strong i="37">@param</strong> {object} router - Initial route options for RouterContext. * <strong i="38">@param</strong> {object} options - Optional options for enzyme's mount function. * <strong i="39">@function</strong> createElement - Creates a wrapper around passed in component (now we can use wrapper.setProps on root) * <strong i="40">@returns</strong> {wrapper} - a mounted React component with Router context. */ export const withRouterContext = ( Component, initialProps = {}, state = null, router = { pathname: "/", route: "/", query: {}, asPath: "/", }, options = {}, ) => { const wrapper = mount( createElement( props => ( <RouterContext.Provider value={router}> <Component { ...props } /> </RouterContext.Provider> ), initialProps, ), options, ); if (state) wrapper.find(Component).setState(state); return wrapper; };
使用例:
import React from "react"; import withRouterContext from "./path/to/reusable/test/utils"; // alternatively you can make this global import ExampleComponent from "./index"; const initialProps = { id: "0123456789", firstName: "John", lastName: "Smith" }; const router = { pathname: "/users/$user", route: "/users/$user", query: { user: "john" }, asPath: "/users/john", }; const wrapper = withRouterContext(ExampleComponent, initialProps, null, router); ...etc
なぜこれを使うのですか? 再利用可能なマウントされたReactコンポーネントをルーターコンテキストでラップできるためです。 そして最も重要なことは、ルートコンポーネントで
wrapper.setProps(..)
を呼び出すことができることです!
こんにちは、私はこのエラーが発生しています:
TypeError:require.requireMockは関数ではありません
このソリューションの使用:
jest.mock("next/router", () => ({
// spread out all "Router" exports
...jest.requireActual("next/router"),
// shallow merge the "default" exports with...
default: {
// all actual "default" exports...
...jest.requireActual("next/router").default,
// and overwrite push and replace to be jest functions
push: jest.fn(),
replace: jest.fn(),
},
}));
// export the mocked instance above
module.exports = jest.requireMock("next/router");
最も参考になるコメント
私はこのようにそれをあざけることになりました、私は
useRouter
エクスポートだけを必要とするので、これは私の目的のために十分にうまくいきました: