Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: [app dir bootstrapping 8] useParamsWithFallback hook and add tests #12041

Merged
merged 3 commits into from
Nov 7, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
63 changes: 63 additions & 0 deletions packages/lib/hooks/useParamsWithFallback.test.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
import { renderHook } from "@testing-library/react-hooks";
import { vi } from "vitest";
import { describe, expect, it } from "vitest";

import { useParamsWithFallback } from "./useParamsWithFallback";

describe("useParamsWithFallback hook", () => {
it("should return router.query when param is null", () => {
vi.mock("next/navigation", () => ({
useParams: vi.fn().mockReturnValue(null),
}));

vi.mock("next/compat/router", () => ({
useRouter: vi.fn().mockReturnValue({ query: { id: 1 } }),
}));

const { result } = renderHook(() => useParamsWithFallback());

expect(result.current).toEqual({ id: 1 });
});

it("should return router.query when param is undefined", () => {
vi.mock("next/navigation", () => ({
useParams: vi.fn().mockReturnValue(undefined),
}));

vi.mock("next/compat/router", () => ({
useRouter: vi.fn().mockReturnValue({ query: { id: 1 } }),
}));

const { result } = renderHook(() => useParamsWithFallback());

expect(result.current).toEqual({ id: 1 });
});

it("should return useParams() if it exists", () => {
vi.mock("next/navigation", () => ({
useParams: vi.fn().mockReturnValue({ id: 1 }),
}));

vi.mock("next/compat/router", () => ({
useRouter: vi.fn().mockReturnValue(null),
}));

const { result } = renderHook(() => useParamsWithFallback());

expect(result.current).toEqual({ id: 1 });
});

it("should return useParams() if it exists", () => {
vi.mock("next/navigation", () => ({
useParams: vi.fn().mockReturnValue({ id: 1 }),
}));

vi.mock("next/compat/router", () => ({
useRouter: vi.fn().mockReturnValue({ query: { id: 2 } }),
}));

const { result } = renderHook(() => useParamsWithFallback());

expect(result.current).toEqual({ id: 1 });
});
});
15 changes: 10 additions & 5 deletions packages/lib/hooks/useParamsWithFallback.ts
Original file line number Diff line number Diff line change
@@ -1,13 +1,18 @@
"use client";

import { useRouter as useCompatRouter } from "next/compat/router";
import { useParams } from "next/navigation";
import { useRouter } from "next/router";
import type { ParsedUrlQuery } from "querystring";

interface Params {
[key: string]: string | string[];
}

/**
* This hook is a workaround until pages are migrated to app directory.
*/
export function useParamsWithFallback() {
const router = useRouter();
const params = useParams();
return params || router.query;
export function useParamsWithFallback(): Params | ParsedUrlQuery {
const params = useParams(); // always `null` in pages router
const router = useCompatRouter(); // always `null` in app router
return params ?? router?.query ?? {};
}
9 changes: 8 additions & 1 deletion vitest.workspace.ts
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ const workspaces = packagedEmbedTestsOnly
test: {
include: ["packages/**/*.{test,spec}.{ts,js}", "apps/**/*.{test,spec}.{ts,js}"],
// TODO: Ignore the api until tests are fixed
exclude: ["**/node_modules/**/*", "packages/embeds/**/*"],
exclude: ["**/node_modules/**/*", "packages/embeds/**/*", "packages/lib/hooks/**/*"],
setupFiles: ["setupVitest.ts"],
},
},
Expand Down Expand Up @@ -67,6 +67,13 @@ const workspaces = packagedEmbedTestsOnly
setupFiles: ["packages/app-store/test-setup.ts"],
},
},
{
test: {
name: "@calcom/packages/lib/hooks",
include: ["packages/lib/hooks/**/*.{test,spec}.{ts,js}"],
environment: "jsdom",
},
},
];

export default defineWorkspace(workspaces);