Skip to content

refactor: simplify Turnstile component and align with official API #143

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Jun 8, 2025
Merged

refactor: simplify Turnstile component and align with official API #143

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
55 changes: 29 additions & 26 deletions app/create/page.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -322,32 +322,35 @@ export default function CreateGistPage() {
</Card>

{/* Invisible Turnstile Verification */}
{turnstileSiteKey && (
<div className="hidden">
<Turnstile
sitekey={turnstileSiteKey}
onVerify={(token) => {
setTurnstileToken(token);
setIsTurnstileReady(true);
}}
onError={() => {
setError(
"🛡️ Security check failed. Please refresh the page and try again."
);
setIsTurnstileReady(false);
}}
onExpire={() => {
setTurnstileToken(null);
setIsTurnstileReady(false);
setError(
"⏰ Security verification expired. Please refresh the page to continue."
);
}}
theme="auto"
size="invisible"
/>
</div>
)}
{turnstileSiteKey &&
typeof turnstileSiteKey === "string" &&
turnstileSiteKey.length > 0 && (
<div className="hidden">
<Turnstile
sitekey={turnstileSiteKey}
action="create_gist"
onSuccess={(token) => {
setTurnstileToken(token);
setIsTurnstileReady(true);
}}
onError={() => {
setError(
"🛡️ Security check failed. Please refresh the page and try again."
);
setIsTurnstileReady(false);
}}
onExpire={() => {
setTurnstileToken(null);
setIsTurnstileReady(false);
setError(
"⏰ Security verification expired. Please refresh the page to continue."
);
}}
theme="auto"
appearance="interaction-only"
/>
</div>
)}

{/* Error Display */}
{(error || validationMessage) && (
Expand Down
106 changes: 19 additions & 87 deletions components/ui/turnstile.test.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,20 +2,11 @@ import { render, waitFor } from "@testing-library/react";
import { vi, describe, it, expect, beforeEach, afterEach } from "vitest";
import { Turnstile } from "./turnstile";

// Mock Next.js Script component
vi.mock("next/script", () => ({
default: ({ onLoad }: { onLoad: () => void }) => {
// Simulate script loading
setTimeout(() => onLoad(), 0);
return null;
},
}));

describe("Turnstile", () => {
const mockRender = vi.fn().mockReturnValue("widget-123");
const mockReset = vi.fn();
const mockRemove = vi.fn();
const mockOnVerify = vi.fn();
const mockOnSuccess = vi.fn();
const mockOnError = vi.fn();
const mockOnExpire = vi.fn();

Expand All @@ -39,7 +30,7 @@ describe("Turnstile", () => {
const { container } = render(
<Turnstile
sitekey="test-site-key"
onVerify={mockOnVerify}
onSuccess={mockOnSuccess}
onError={mockOnError}
onExpire={mockOnExpire}
/>
Expand All @@ -56,24 +47,27 @@ describe("Turnstile", () => {
"expired-callback": expect.any(Function),
theme: "auto",
size: "normal",
appearance: "interaction-only",
execution: "render",
language: "auto",
})
);
});

// Check container exists
const turnstileContainer = container.querySelector(".cf-turnstile");
const turnstileContainer = container.querySelector("div");
expect(turnstileContainer).toBeInTheDocument();

// Test that callbacks are properly forwarded
const renderCall = mockRender.mock.calls[0][1];

// Test onVerify callback
// Test onSuccess callback
renderCall.callback("test-token");
expect(mockOnVerify).toHaveBeenCalledWith("test-token");
expect(mockOnSuccess).toHaveBeenCalledWith("test-token");

// Test onError callback
renderCall["error-callback"]("test-error");
expect(mockOnError).toHaveBeenCalledWith("test-error");
renderCall["error-callback"]();
expect(mockOnError).toHaveBeenCalled();

// Test onExpire callback
renderCall["expired-callback"]();
Expand All @@ -84,7 +78,7 @@ describe("Turnstile", () => {
render(
<Turnstile
sitekey="test-site-key"
onVerify={mockOnVerify}
onSuccess={mockOnSuccess}
theme="dark"
size="compact"
/>
Expand All @@ -103,7 +97,7 @@ describe("Turnstile", () => {

it("cleans up widget on unmount", async () => {
const { unmount } = render(
<Turnstile sitekey="test-site-key" onVerify={mockOnVerify} />
<Turnstile sitekey="test-site-key" onSuccess={mockOnSuccess} />
);

await waitFor(() => {
Expand All @@ -115,76 +109,14 @@ describe("Turnstile", () => {
expect(mockRemove).toHaveBeenCalledWith("widget-123");
});

it("handles render errors gracefully", async () => {
mockRender.mockImplementationOnce(() => {
throw new Error("Render failed");
});

render(
<Turnstile
sitekey="test-site-key"
onVerify={mockOnVerify}
onError={mockOnError}
/>
);

await waitFor(() => {
expect(mockOnError).toHaveBeenCalledWith(
"Failed to load verification widget"
);
});
});

it("applies custom className", () => {
const { container } = render(
<Turnstile
sitekey="test-site-key"
onVerify={mockOnVerify}
className="custom-class"
/>
);

const turnstileContainer = container.querySelector(".cf-turnstile");
expect(turnstileContainer).toHaveClass("custom-class");
});

it("applies correct height classes based on size", () => {
const { container: container1 } = render(
<Turnstile
sitekey="test-site-key"
onVerify={mockOnVerify}
size="compact"
/>
);
expect(container1.querySelector(".cf-turnstile")).toHaveClass("h-[65px]");
it("checks script is loaded", async () => {
render(<Turnstile sitekey="test-site-key" onSuccess={mockOnSuccess} />);

const { container: container2 } = render(
<Turnstile
sitekey="test-site-key"
onVerify={mockOnVerify}
size="normal"
/>
);
expect(container2.querySelector(".cf-turnstile")).toHaveClass("h-[65px]");

const { container: container3 } = render(
<Turnstile
sitekey="test-site-key"
onVerify={mockOnVerify}
size="flexible"
/>
);
expect(container3.querySelector(".cf-turnstile")).toHaveClass(
"min-h-[65px]"
);

const { container: container4 } = render(
<Turnstile
sitekey="test-site-key"
onVerify={mockOnVerify}
size="invisible"
/>
// Check that script was added
const script = document.getElementById("cf-turnstile-script");
expect(script).toBeTruthy();
expect(script?.getAttribute("src")).toBe(
"https://challenges.cloudflare.com/turnstile/v0/api.js"
);
expect(container4.querySelector(".cf-turnstile")).toHaveClass("h-0");
});
});
Loading