Skip to content

Fix for the Kapa widget not working with SSR #2170

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

Merged
merged 3 commits into from
Jun 12, 2025
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
165 changes: 79 additions & 86 deletions apps/webapp/app/components/AskAI.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -7,24 +7,21 @@ import {
} from "@heroicons/react/20/solid";
import { type FeedbackComment, KapaProvider, type QA, useChat } from "@kapaai/react-sdk";
import { useSearchParams } from "@remix-run/react";
import DOMPurify from "dompurify";
import { motion } from "framer-motion";
import { marked } from "marked";
import {
createContext,
type ReactNode,
useCallback,
useContext,
useEffect,
useRef,
useState,
} from "react";
import { useCallback, useEffect, useRef, useState } from "react";
import { useTypedRouteLoaderData } from "remix-typedjson";
import { AISparkleIcon } from "~/assets/icons/AISparkleIcon";
import { SparkleListIcon } from "~/assets/icons/SparkleListIcon";
import { useFeatures } from "~/hooks/useFeatures";
import { type loader } from "~/root";
import { Button } from "./primitives/Buttons";
import { Callout } from "./primitives/Callout";
import { Dialog, DialogContent, DialogHeader, DialogTitle } from "./primitives/Dialog";
import { Header2 } from "./primitives/Headers";
import { Paragraph } from "./primitives/Paragraph";
import { ShortcutKey } from "./primitives/ShortcutKey";
import { Spinner } from "./primitives/Spinner";
import {
SimpleTooltip,
Expand All @@ -33,31 +30,45 @@ import {
TooltipProvider,
TooltipTrigger,
} from "./primitives/Tooltip";
import DOMPurify from "dompurify";
import { ClientOnly } from "remix-utils/client-only";

type AskAIContextType = {
isOpen: boolean;
openAskAI: (question?: string) => void;
closeAskAI: () => void;
websiteId: string | null;
};
function useKapaWebsiteId() {
const routeMatch = useTypedRouteLoaderData<typeof loader>("root");
return routeMatch?.kapa.websiteId;
}

const AskAIContext = createContext<AskAIContextType | null>(null);
export function AskAI() {
const { isManagedCloud } = useFeatures();
const websiteId = useKapaWebsiteId();

export function useAskAI() {
const context = useContext(AskAIContext);
if (!context) {
throw new Error("useAskAI must be used within an AskAIProvider");
if (!isManagedCloud || !websiteId) {
return null;
}
return context;

return (
<ClientOnly
fallback={
<Button
variant="small-menu-item"
data-action="ask-ai"
hideShortcutKey
data-modal-override-open-class-ask-ai="true"
disabled
>
<AISparkleIcon className="size-5" />
</Button>
}
>
{() => <AskAIProvider websiteId={websiteId} />}
</ClientOnly>
);
}

type AskAIProviderProps = {
children: ReactNode;
websiteId: string | null;
websiteId: string;
};

export function AskAIProvider({ children, websiteId }: AskAIProviderProps) {
function AskAIProvider({ websiteId }: AskAIProviderProps) {
const [isOpen, setIsOpen] = useState(false);
const [initialQuery, setInitialQuery] = useState<string | undefined>();
const [searchParams, setSearchParams] = useSearchParams();
Expand All @@ -80,59 +91,67 @@ export function AskAIProvider({ children, websiteId }: AskAIProviderProps) {
useEffect(() => {
const aiHelp = searchParams.get("aiHelp");
if (aiHelp) {
const decodedAiHelp = decodeURIComponent(aiHelp);

// Delay to avoid hCaptcha bot detection
const timeoutId = window.setTimeout(() => openAskAI(decodedAiHelp), 1000);
window.setTimeout(() => openAskAI(aiHelp), 1000);

// Clone instead of mutating in place
const next = new URLSearchParams(searchParams);
next.delete("aiHelp");
setSearchParams(next);

return () => clearTimeout(timeoutId);
}
}, [searchParams.toString(), openAskAI]);

const contextValue: AskAIContextType = {
isOpen,
openAskAI,
closeAskAI,
websiteId,
};

if (!websiteId) {
return <AskAIContext.Provider value={contextValue}>{children}</AskAIContext.Provider>;
}
}, [searchParams, openAskAI]);

return (
<AskAIContext.Provider value={contextValue}>
<KapaProvider
integrationId={websiteId}
callbacks={{
askAI: {
onQuerySubmit: () => openAskAI(),
onAnswerGenerationCompleted: () => openAskAI(),
},
}}
botProtectionMechanism="hcaptcha"
>
{children}
<AskAIDialog initialQuery={initialQuery} isOpen={isOpen} onOpenChange={setIsOpen} />
</KapaProvider>
</AskAIContext.Provider>
<KapaProvider
integrationId={websiteId}
callbacks={{
askAI: {
onQuerySubmit: () => openAskAI(),
onAnswerGenerationCompleted: () => openAskAI(),
},
}}
botProtectionMechanism="hcaptcha"
>
<TooltipProvider disableHoverableContent>
<Tooltip>
<TooltipTrigger asChild>
<div className="inline-flex">
<Button
variant="small-menu-item"
data-action="ask-ai"
shortcut={{ modifiers: ["mod"], key: "/", enabledOnInputElements: true }}
hideShortcutKey
data-modal-override-open-class-ask-ai="true"
onClick={() => openAskAI()}
>
<AISparkleIcon className="size-5" />
</Button>
</div>
</TooltipTrigger>
<TooltipContent side="top" className="flex items-center gap-1 py-1.5 pl-2.5 pr-2 text-xs">
Ask AI
<ShortcutKey shortcut={{ modifiers: ["mod"], key: "/" }} variant="medium/bright" />
</TooltipContent>
</Tooltip>
</TooltipProvider>
<AskAIDialog
initialQuery={initialQuery}
isOpen={isOpen}
onOpenChange={setIsOpen}
closeAskAI={closeAskAI}
/>
</KapaProvider>
);
}

type AskAIDialogProps = {
initialQuery?: string;
isOpen: boolean;
onOpenChange: (open: boolean) => void;
closeAskAI: () => void;
};

function AskAIDialog({ initialQuery, isOpen, onOpenChange }: AskAIDialogProps) {
const { closeAskAI } = useAskAI();

function AskAIDialog({ initialQuery, isOpen, onOpenChange, closeAskAI }: AskAIDialogProps) {
const handleOpenChange = (open: boolean) => {
if (!open) {
closeAskAI();
Expand Down Expand Up @@ -514,29 +533,3 @@ function GradientSpinnerBackground({
</div>
);
}

export function AskAIButton({ question }: { question?: string }) {
const { openAskAI } = useAskAI();

return (
<TooltipProvider disableHoverableContent>
<Tooltip>
<TooltipTrigger asChild>
<div className="inline-flex">
<Button
variant="minimal/small"
onClick={() => openAskAI(question)}
className="pl-0.5 pr-1"
data-action="ask-ai"
>
<AISparkleIcon className="size-5" />
</Button>
</div>
</TooltipTrigger>
<TooltipContent side="top" className="flex items-center gap-1 px-2 py-1.5 text-xs">
Ask AI
</TooltipContent>
</Tooltip>
</TooltipProvider>
);
}
34 changes: 2 additions & 32 deletions apps/webapp/app/components/navigation/SideMenu.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,6 @@ import {
import { useNavigation } from "@remix-run/react";
import { useEffect, useRef, useState, type ReactNode } from "react";
import simplur from "simplur";
import { AISparkleIcon } from "~/assets/icons/AISparkleIcon";
import { BranchEnvironmentIconSmall } from "~/assets/icons/EnvironmentIcons";
import { RunsIconExtraSmall } from "~/assets/icons/RunsIcon";
import { TaskIconSmall } from "~/assets/icons/TaskIcon";
Expand Down Expand Up @@ -63,7 +62,7 @@ import {
v3UsagePath,
v3WaitpointTokensPath,
} from "~/utils/pathBuilder";
import { useAskAI } from "../AskAI";
import { AskAI } from "../AskAI";
import { FreePlanUsage } from "../billing/FreePlanUsage";
import { ConnectionIcon, DevPresencePanel, useDevPresence } from "../DevPresence";
import { ImpersonationBanner } from "../ImpersonationBanner";
Expand All @@ -77,7 +76,6 @@ import {
PopoverMenuItem,
PopoverTrigger,
} from "../primitives/Popover";
import { ShortcutKey } from "../primitives/ShortcutKey";
import { TextLink } from "../primitives/TextLink";
import { Tooltip, TooltipContent, TooltipProvider, TooltipTrigger } from "../primitives/Tooltip";
import { ShortcutsAutoOpen } from "../Shortcuts";
Expand Down Expand Up @@ -587,40 +585,12 @@ function SelectorDivider() {

function HelpAndAI() {
const features = useFeatures();
const { openAskAI, websiteId } = useAskAI();
const isKapaEnabled = features.isManagedCloud && websiteId;

return (
<>
<ShortcutsAutoOpen />
<HelpAndFeedback />
{isKapaEnabled && (
<TooltipProvider disableHoverableContent>
<Tooltip>
<TooltipTrigger asChild>
<div className="inline-flex">
<Button
variant="small-menu-item"
data-action="ask-ai"
shortcut={{ modifiers: ["mod"], key: "/", enabledOnInputElements: true }}
hideShortcutKey
data-modal-override-open-class-ask-ai="true"
onClick={() => openAskAI()}
>
<AISparkleIcon className="size-5" />
</Button>
</div>
</TooltipTrigger>
<TooltipContent
side="top"
className="flex items-center gap-1 py-1.5 pl-2.5 pr-2 text-xs"
>
Ask AI
<ShortcutKey shortcut={{ modifiers: ["mod"], key: "/" }} variant="medium/bright" />
</TooltipContent>
</Tooltip>
</TooltipProvider>
)}
<AskAI />
</>
);
}
11 changes: 4 additions & 7 deletions apps/webapp/app/root.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,6 @@ import { ExternalScripts } from "remix-utils/external-scripts";
import type { ToastMessage } from "~/models/message.server";
import { commitSession, getSession } from "~/models/message.server";
import tailwindStylesheetUrl from "~/tailwind.css";
import { AskAIProvider } from "./components/AskAI";
import { RouteErrorDisplay } from "./components/ErrorDisplay";
import { AppContainer, MainCenteredContainer } from "./components/layout/AppLayout";
import { ShortcutsProvider } from "./components/primitives/ShortcutsProvider";
Expand Down Expand Up @@ -108,12 +107,10 @@ export default function App() {
<Links />
</head>
<body className="h-full overflow-hidden bg-background-dimmed">
<AskAIProvider websiteId={kapa.websiteId || null}>
<ShortcutsProvider>
<Outlet />
<Toast />
</ShortcutsProvider>
</AskAIProvider>
<ShortcutsProvider>
<Outlet />
<Toast />
</ShortcutsProvider>
<ScrollRestoration />
<ExternalScripts />
<Scripts />
Expand Down
Loading