🪢 Open source agent evals & observability: Trace, evaluate, and improve LLM applications with one open platform.
TypeScript analyticsautogenevaluationlangchainlarge-language-modelsllama-indexllmllm-evaluationllm-observabilityllmopsmonitoringobservabilityopen-sourceopenaiplaygroundprompt-engineeringprompt-managementself-hostedycombinator
/* eslint-disable @typescript-eslint/no-use-before-define */
import capitalize from "lodash/capitalize";
import router from "next/router";
import { useState, useEffect, useMemo, useRef } from "react";
import { useForm } from "react-hook-form";
import { Button } from "@/src/components/ui/button";
import { Checkbox } from "@/src/components/design-system/Checkbox/Checkbox";
import {
Form,
FormControl,
FormDescription,
FormField,
FormItem,
FormLabel,
FormMessage,
} from "@/src/components/ui/form";
import { Tabs } from "@/src/components/design-system/Tabs/Tabs";
import { Textarea } from "@/src/components/ui/textarea";
import useProjectIdFromURL from "@/src/hooks/useProjectIdFromURL";
import { api, reportTrpcErrorWithoutToast } from "@/src/utils/api";
import { zodResolver } from "@hookform/resolvers/zod";
import {
type CreatePromptTRPCType,
PRODUCTION_LABEL,
type Prompt,
PromptType,
extractVariables,
getIsCharOrUnderscore,
} from "@langfuse/shared";
import { PromptChatMessages } from "./PromptChatMessages";
import { ReviewPromptDialogController } from "./ReviewPromptDialogController";
import {
NewPromptFormSchema,
type NewPromptFormSchemaType,
PromptVariantSchema,
type PromptVariant,
} from "./validation";
import { Input } from "@/src/components/ui/input";
import Link from "next/link";
import { SquareArrowOutUpRight } from "@langfuse/icons";
import { PromptVariableListPreview } from "@/src/features/prompts/components/PromptVariableListPreview";
import { CodeMirrorEditor } from "@/src/components/editor/CodeMirrorEditor";
import { PromptLinkingEditor } from "@/src/components/editor/PromptLinkingEditor";
import { usePostHogClientCapture } from "@/src/features/posthog-analytics/usePostHogClientCapture";
import { default as usePlaygroundCache } from "@/src/features/playground/page/hooks/usePlaygroundCache";
import { useQueryParam } from "use-query-params";
import { usePromptNameValidation } from "@/src/features/prompts/hooks/usePromptNameValidation";
import { getPromptDetailHref } from "@/src/features/prompts/utils";
import { useFormPersistence } from "@/src/hooks/useFormPersistence";
type NewPromptFormProps = {
initialPrompt?: Prompt | null;
onFormSuccess?: () => void;
};
export const NewPromptForm: React.FC<NewPromptFormProps> = (props) => {
const { onFormSuccess, initialPrompt } = props;
const projectId = useProjectIdFromURL();
const [shouldLoadPlaygroundCache] = useQueryParam("loadPlaygroundCache");
const [folderPath] = useQueryParam("folder");
const [formError, setFormError] = useState<string | null>(null);
const { playgroundCache } = usePlaygroundCache();
const [initialMessages, setInitialMessages] = useState<unknown>([]);
const utils = api.useUtils();
const capture = usePostHogClientCapture();
const initialPromptVariant = useMemo<PromptVariant | null>(() => {
try {
return PromptVariantSchema.parse({
type: initialPrompt?.type,
prompt: initialPrompt?.prompt?.valueOf(),
});
} catch (_err) {
return null;
}
}, [initialPrompt]);
const defaultValues = {
type: initialPromptVariant?.type ?? PromptType.Text,
chatPrompt:
initialPromptVariant?.type === PromptType.Chat
? initialPromptVariant?.prompt
: [],
textPrompt:
initialPromptVariant?.type === PromptType.Text
? initialPromptVariant?.prompt
: "",
name: initialPrompt?.name ?? (folderPath ? `${folderPath}/` : ""),
config: JSON.stringify(initialPrompt?.config?.valueOf(), null, 2) || "{}",
isActive: !Boolean(initialPrompt),
commitMessage: undefined,
};
const form = useForm({
resolver: zodResolver(NewPromptFormSchema),
mode: "onTouched",
defaultValues,
});
const currentName = form.watch("name");
const currentType = form.watch("type");
const currentExtractedVariables = extractVariables(
currentType === PromptType.Text
? form.watch("textPrompt")
: JSON.stringify(form.watch("chatPrompt"), null, 2),
).filter(getIsCharOrUnderscore);
const createPromptMutation = api.prompts.create.useMutation({
onSuccess: () => utils.prompts.invalidate(),
onError: (error) => setFormError(error.message),
});
const allPrompts = api.prompts.filterOptions.useQuery(
{
projectId: projectId as string, // Typecast as query is enabled only when projectId is present
},
{
enabled: Boolean(projectId),
refetchOnMount: false,
refetchOnWindowFocus: false,
refetchOnReconnect: false,
staleTime: Infinity,
},
).data?.name;
function onSubmit(values: NewPromptFormSchemaType) {
capture(
initialPrompt ? "prompts:update_form_submit" : "prompts:new_form_submit",
{
type: values.type,
active: values.isActive,
hasConfig: values.config !== "{}",
countVariables: currentExtractedVariables.length,
},
);
if (!projectId) throw Error("Project ID is not defined.");
const { type, textPrompt, chatPrompt } = values;
// TS does not narrow down type of 'prompt' property given the type of 'type' property in ternary operator
let newPrompt: CreatePromptTRPCType;
if (type === PromptType.Chat) {
newPrompt = {
...values,
projectId,
type,
prompt: chatPrompt,
config: JSON.parse(values.config),
labels: values.isActive ? [PRODUCTION_LABEL] : [],
};
} else {
newPrompt = {
...values,
projectId,
type,
prompt: textPrompt,
config: JSON.parse(values.config),
labels: values.isActive ? [PRODUCTION_LABEL] : [],
};
}
createPromptMutation
.mutateAsync(newPrompt)
.then((newPrompt) => {
clearDraft();
onFormSuccess?.();
form.reset();
if ("name" in newPrompt) {
router.push(getPromptDetailHref(projectId, newPrompt.name));
}
})
.catch((error) => reportTrpcErrorWithoutToast(error, "prompts"));
}
const hasInitializedMessages = useRef(false);
useEffect(() => {
if (hasInitializedMessages.current) return;
hasInitializedMessages.current = true;
if (shouldLoadPlaygroundCache && playgroundCache) {
form.setValue("type", PromptType.Chat);
setInitialMessages(playgroundCache.messages);
} else if (initialPrompt?.type === PromptType.Chat) {
setInitialMessages(initialPrompt.prompt);
}
}, [playgroundCache, initialPrompt, form, shouldLoadPlaygroundCache]);
usePromptNameValidation({
currentName,
allPrompts,
form,
});
const formId = initialPrompt
? `prompt-edit:${initialPrompt.id}`
: "prompt-new";
const { hadDraft, clearDraft } = useFormPersistence({
formId,
projectId: projectId ?? "",
form,
enabled: Boolean(projectId) && !shouldLoadPlaygroundCache,
onDraftRestored: (draft) => {
// Restore chat messages if present
if (
draft.chatPrompt &&
Array.isArray(draft.chatPrompt) &&
draft.chatPrompt.length > 0
) {
setInitialMessages(draft.chatPrompt);
}
if (folderPath && !initialPrompt) {
form.setValue("name", `${folderPath}/`);
}
},
});
return (
<Form {...form}>
<form
onSubmit={form.handleSubmit(onSubmit)}
className="flex flex-col gap-6"
>
{/* Prompt name field - text vs. chat only for new prompts */}
{!initialPrompt ? (
<FormField
control={form.control}
name="name"
render={({ field }) => {
const errorMessage = form.getFieldState("name").error?.message;
return (
<div>
<FormItem>
<FormLabel>Name</FormLabel>
<FormDescription>
Use slashes '/' in prompt names to organize them
into{" "}
<a
target="_blank"
rel="noopener noreferrer"
href="https://langfuse.com/docs/prompt-management/get-started#prompt-folders-for-organization"
>
<i>folders</i>
</a>
.
</FormDescription>
<FormControl>
<Input placeholder="Name your prompt" {...field} />
</FormControl>
{/* Custom form message to include a link to the already existing prompt */}
{form.getFieldState("name").error ? (
<div className="text-destructive flex flex-row space-x-1 text-sm font-bold">
<p className="text-destructive text-sm font-bold">
{errorMessage}
</p>
{errorMessage?.includes("already exist") &&
projectId ? (
<Link
href={getPromptDetailHref(
projectId,
currentName.trim(),
)}
className="flex flex-row items-center"
>
Create a new version for it here.
<SquareArrowOutUpRight
size="sm"
__rawClassName="ml-1"
/>
</Link>
) : null}
</div>
) : null}
</FormItem>
</div>
);
}}
/>
) : null}
{/* Prompt content field - text vs. chat */}
<FormItem>
<FormLabel>Prompt</FormLabel>
<FormDescription>
Define your prompt template. You can use{" "}
<code className="text-xs">{"{{variable}}"}</code> to insert
variables into your prompt.
<b className="font-bold"> Note:</b> Variables must be alphabetical
characters or underscores. You can also link other text prompts
using the plus button.
</FormDescription>
<Tabs
value={form.watch("type")}
onValueChange={(e) => {
form.setValue("type", e as PromptType);
}}
>
{!initialPrompt ? (
<Tabs.List variant="inset" size="md" layout="full">
<span className="flex-1">
<Tabs.Trigger
disabled={
Boolean(initialPromptVariant) &&
initialPromptVariant?.type !== PromptType.Text
}
value={PromptType.Text}
label={capitalize(PromptType.Text)}
/>
</span>
<span className="flex-1">
<Tabs.Trigger
disabled={
Boolean(initialPromptVariant) &&
initialPromptVariant?.type !== PromptType.Chat
}
value={PromptType.Chat}
label={capitalize(PromptType.Chat)}
/>
</span>
</Tabs.List>
) : null}
{hadDraft && (
<p
className={`text-muted-foreground mb-1 text-right text-xs ${initialPrompt ? "-mt-2" : "mt-1"}`}
>
Draft restored.{" "}
<button
type="button"
className="hover:text-foreground underline"
onClick={() => {
clearDraft();
form.reset(defaultValues);
setInitialMessages(
initialPrompt?.type === PromptType.Chat
? initialPrompt.prompt
: [],
);
}}
>
Discard
</button>
</p>
)}
<div className="mt-2">
<Tabs.Content value={PromptType.Text}>
<FormField
control={form.control}
name="textPrompt"
render={({ field }) => (
<>
<FormControl>
<PromptLinkingEditor
value={field.value}
onChange={field.onChange}
onBlur={field.onBlur}
minHeight={200}
/>
</FormControl>
<FormMessage />
</>
)}
/>
</Tabs.Content>
</div>
<div className="mt-2">
<Tabs.Content value={PromptType.Chat}>
<FormField
control={form.control}
name="chatPrompt"
render={({ field }) => (
<>
<PromptChatMessages
{...field}
initialMessages={initialMessages}
projectId={projectId}
/>
<FormMessage />
</>
)}
/>
</Tabs.Content>
</div>
</Tabs>
</FormItem>
{currentExtractedVariables.length > 0 && (
<PromptVariableListPreview variables={currentExtractedVariables} />
)}
{/* Prompt Config field */}
<FormField
control={form.control}
name="config"
render={({ field }) => (
<FormItem>
<FormLabel>Config</FormLabel>
<FormDescription>
Arbitrary JSON configuration that is available on the prompt.
Use this to track LLM parameters, function definitions, or any
other metadata.
</FormDescription>
<CodeMirrorEditor
value={field.value}
onChange={field.onChange}
onBlur={field.onBlur}
editable
mode="json"
/>
<FormMessage />
</FormItem>
)}
/>
{/* Activate prompt field */}
<FormField
control={form.control}
name="isActive"
render={({ field }) => (
<FormItem>
<div className="flex flex-row items-center space-y-0 space-x-3 rounded-md border p-3">
<FormControl>
<Checkbox
checked={field.value}
onCheckedChange={field.onChange}
/>
</FormControl>
<div className="space-y-1 leading-none">
<FormLabel>Set the "production" label</FormLabel>
</div>
</div>
</FormItem>
)}
/>
<FormField
control={form.control}
name="commitMessage"
render={({ field }) => (
<FormItem className="relative">
<FormLabel>Commit message</FormLabel>
<FormDescription>
Provide information about the changes made in this version.
Helps maintain a clear history of prompt iterations.
</FormDescription>
<FormControl>
<Textarea
placeholder="Add commit message..."
{...field}
className="rounded-md border text-sm focus:ring-0 focus:outline-hidden focus-visible:ring-0 focus-visible:ring-offset-0 active:ring-0"
/>
</FormControl>
<FormMessage />
</FormItem>
)}
/>
{initialPrompt ? (
<div className="flex flex-col gap-2">
<ReviewPromptDialogController
initialPrompt={initialPrompt}
getNewPromptValues={form.getValues}
isLoading={createPromptMutation.isPending}
onConfirm={form.handleSubmit(onSubmit)}
>
{({ openDialog }) => (
<Button
type="button"
disabled={!form.formState.isValid}
variant="secondary"
className="w-full"
onClick={openDialog}
>
Review changes
</Button>
)}
</ReviewPromptDialogController>
<Button
type="submit"
loading={createPromptMutation.isPending}
className="w-full"
disabled={!form.formState.isValid}
>
Save new prompt version
</Button>
</div>
) : (
<Button
type="submit"
loading={createPromptMutation.isPending}
className="w-full"
disabled={Boolean(
!initialPrompt && form.formState.errors.name?.message,
)} // Disable button if prompt name already exists. Check is dynamic and not part of zod schema
>
Create prompt
</Button>
)}
</form>
{formError && (
<p className="text-center">
<span className="font-bold">Error:</span> {formError}
</p>
)}
</Form>
);
};