Skip to content

πŸ™Œ OpenHands: AI-Driven Development

7.5 KB
Raw Blame
import React from "react";
import { useTranslation } from "react-i18next";
import { I18nKey } from "#/i18n/declaration";
import { ModalBackdrop } from "#/components/shared/modals/modal-backdrop";
import { ModalBody } from "#/components/shared/modals/modal-body";
import { ModalCloseButton } from "#/components/shared/modals/modal-close-button";
import {
  BaseModalDescription,
  BaseModalTitle,
} from "#/components/shared/modals/confirmation-modals/base-modal";
import { BrandButton } from "#/components/features/settings/brand-button";
import { downloadBlob } from "#/utils/utils";
import {
  eventsToHtml,
  eventsToMarkdown,
  type TranscriptExportFormat,
} from "#/utils/transcript-export";
import { useTracking } from "#/hooks/use-tracking";
import { useEventStore } from "#/stores/use-event-store";
import EventService from "#/api/event-service/event-service.api";
import { loadCompleteTranscriptEvents } from "#/utils/transcript-export/load-complete-events";
import { displayErrorToast } from "#/utils/custom-toast-handlers";

const TRANSCRIPT_FORMAT_RADIO_NAME = "transcript-export-format";

interface TranscriptExportModalProps {
  conversationId: string;
  conversationUrl?: string | null;
  sessionApiKey?: string | null;
  conversationTitle?: string | null;
  model?: string | null;
  onClose: () => void;
}

export function TranscriptExportModal({
  conversationId,
  conversationUrl,
  sessionApiKey,
  conversationTitle,
  model,
  onClose,
}: TranscriptExportModalProps) {
  const { t } = useTranslation("openhands");
  const { trackConversationExported } = useTracking();
  const [format, setFormat] =
    React.useState<TranscriptExportFormat>("markdown");
  const [includeToolDetails, setIncludeToolDetails] = React.useState(true);
  const [includeTimestamps, setIncludeTimestamps] = React.useState(true);
  const [isExporting, setIsExporting] = React.useState(false);
  const isExportingRef = React.useRef(false);
  const isCancelledRef = React.useRef(false);
  const isMountedRef = React.useRef(true);

  React.useEffect(() => {
    isMountedRef.current = true;
    return () => {
      isMountedRef.current = false;
      isCancelledRef.current = true;
    };
  }, []);

  const handleClose = () => {
    if (isExportingRef.current) isCancelledRef.current = true;
    onClose();
  };

  const handleExport = async () => {
    if (isExportingRef.current) return;

    isCancelledRef.current = false;
    isExportingRef.current = true;
    setIsExporting(true);
    try {
      // The count lets us reject silently truncated pagination. Archived cloud
      // runtimes may no longer expose this endpoint, while their persisted
      // App API history remains exportable, so treat the check as best-effort.
      const expectedEventCount = await EventService.getEventCount(
        conversationId,
        conversationUrl ?? "",
        sessionApiKey,
      ).catch(() => undefined);
      if (isCancelledRef.current) return;

      const eventStore = useEventStore.getState();
      const loadedEvents =
        eventStore.loadedConversationId === conversationId
          ? eventStore.events
          : [];
      const events = await loadCompleteTranscriptEvents(
        loadedEvents,
        (searchOptions) =>
          EventService.searchEvents(
            conversationId,
            conversationUrl,
            sessionApiKey,
            searchOptions,
          ),
        expectedEventCount,
      );
      if (isCancelledRef.current) return;

      const options = {
        includeToolDetails,
        includeTimestamps,
        title: conversationTitle,
        model,
      };
      const isMarkdown = format === "markdown";
      const content = isMarkdown
        ? eventsToMarkdown(events, options)
        : eventsToHtml(events, options);
      const extension = isMarkdown ? "md" : "html";
      const mimeType = isMarkdown
        ? "text/markdown;charset=utf-8"
        : "text/html;charset=utf-8";

      downloadBlob(
        new Blob([content], { type: mimeType }),
        `conversation-${conversationId}.${extension}`,
      );
      trackConversationExported(format);
      onClose();
    } catch {
      if (!isCancelledRef.current) {
        displayErrorToast(t(I18nKey.ERROR$GENERIC));
      }
    } finally {
      isExportingRef.current = false;
      if (isMountedRef.current) setIsExporting(false);
    }
  };

  return (
    <ModalBackdrop
      onClose={handleClose}
      aria-label={t(I18nKey.TRANSCRIPT_EXPORT$TITLE)}
    >
      <ModalBody
        testID="transcript-export-modal"
        className="relative items-start border border-border"
      >
        <ModalCloseButton
          onClose={handleClose}
          testId="close-transcript-export-modal"
          className="absolute right-4 top-4"
        />
        <div className="flex flex-col gap-2 pr-8">
          <BaseModalTitle title={t(I18nKey.TRANSCRIPT_EXPORT$TITLE)} />
          <BaseModalDescription
            description={t(I18nKey.TRANSCRIPT_EXPORT$DESCRIPTION)}
          />
        </div>

        <fieldset className="flex w-full flex-col gap-2">
          <legend className="mb-2 text-sm font-medium text-contrast">
            {t(I18nKey.TRANSCRIPT_EXPORT$FORMAT)}
          </legend>
          <label className="flex cursor-pointer items-center gap-3 rounded-md border border-border px-3 py-2 text-sm text-contrast">
            <input
              type="radio"
              name={TRANSCRIPT_FORMAT_RADIO_NAME}
              value="markdown"
              disabled={isExporting}
              checked={format === "markdown"}
              onChange={() => setFormat("markdown")}
            />
            {t(I18nKey.TRANSCRIPT_EXPORT$MARKDOWN)}
          </label>
          <label className="flex cursor-pointer items-center gap-3 rounded-md border border-border px-3 py-2 text-sm text-contrast">
            <input
              type="radio"
              name={TRANSCRIPT_FORMAT_RADIO_NAME}
              value="html"
              disabled={isExporting}
              checked={format === "html"}
              onChange={() => setFormat("html")}
            />
            {t(I18nKey.TRANSCRIPT_EXPORT$HTML)}
          </label>
        </fieldset>

        <div className="flex w-full flex-col gap-3 text-sm text-contrast">
          <label className="flex cursor-pointer items-center gap-3">
            <input
              type="checkbox"
              disabled={isExporting}
              checked={includeToolDetails}
              onChange={(event) => setIncludeToolDetails(event.target.checked)}
            />
            {t(I18nKey.TRANSCRIPT_EXPORT$INCLUDE_TOOL_DETAILS)}
          </label>
          <label className="flex cursor-pointer items-center gap-3">
            <input
              type="checkbox"
              disabled={isExporting}
              checked={includeTimestamps}
              onChange={(event) => setIncludeTimestamps(event.target.checked)}
            />
            {t(I18nKey.TRANSCRIPT_EXPORT$INCLUDE_TIMESTAMPS)}
          </label>
        </div>

        <div className="flex w-full justify-end gap-2">
          <BrandButton
            type="button"
            variant="secondary"
            onClick={handleClose}
            testId="cancel-transcript-export"
          >
            {t(I18nKey.BUTTON$CANCEL)}
          </BrandButton>
          <BrandButton
            type="button"
            variant="primary"
            onClick={handleExport}
            testId="confirm-transcript-export"
            isDisabled={isExporting}
            aria-busy={isExporting}
          >
            {t(I18nKey.BUTTON$EXPORT_CONVERSATION)}
          </BrandButton>
        </div>
      </ModalBody>
    </ModalBackdrop>
  );
}