Skip to content
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
5 changes: 5 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -446,6 +446,11 @@ Usage of SOARCA-GUI is described here: https://cossas.github.io/SOARCA/docs/
- The read-only diagram supports panning and step details. Use its zoom buttons to change the zoom.
- Leaving the visual editor with unsaved changes asks for confirmation, including in-app navigation, reloads and closing the tab.

### JSON playbook editor

- "Edit JSON", next to "Edit" on a playbook page or in a playbook card's menu, opens the raw playbook JSON in a text editor.
- The GUI checks that the text is valid JSON with the CACAO playbook fields it needs before it saves. SOARCA checks the rest when it receives the playbook.

## Acknowledgements

The visual playbook editor was written from scratch for SOARCA-GUI, using these projects as a reference for CACAO concepts:
Expand Down
5 changes: 5 additions & 0 deletions src/App.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ import { SettingsPage } from "./pages/main-page/SettingsPage";
import { ExecutionDetailPage } from "./pages/main-page/monitoring-page/ExecutionDetailPage";
import { MonitoringPage } from "./pages/main-page/monitoring-page/MonitoringPage";
import { PlaybookCreatePage } from "./pages/main-page/playbooks-page/PlaybookCreatePage";
import { PlaybookJsonEditPage } from "./pages/main-page/playbooks-page/PlaybookJsonEditPage";
import { PlaybooksPage } from "./pages/main-page/playbooks-page/PlaybooksPage";
import { PlaybookDetailPage } from "./pages/main-page/playbooks-page/playbook-detail-page/PlaybookDetailPage";
import { PATHS } from "./utils";
Expand Down Expand Up @@ -90,6 +91,10 @@ function App() {
path={PATHS.PLAYBOOKS.EDIT}
element={withSuspense(<PlaybookVisualEditPage />)}
/>
<Route
path={PATHS.PLAYBOOKS.EDIT_JSON}
element={<PlaybookJsonEditPage />}
/>
</Route>
<Route path={PATHS.SETTINGS} element={<SettingsPage />} />
</Route>
Expand Down
11 changes: 11 additions & 0 deletions src/pages/main-page/playbooks-page/PlaybookActionsMenu.tsx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
import { useMutation, useQueryClient } from "@tanstack/react-query";
import {
IconBraces,
IconDotsVertical,
IconFileCode,
IconPencil,
Expand Down Expand Up @@ -130,6 +131,16 @@ export const PlaybookActionsMenu: React.FC<PlaybookActionsMenuProps> = ({
<Icon $icon={IconPencil} />
Edit
</PopoverItem>
<PopoverItem
onClick={() =>
navigate(
PATHS.PLAYBOOKS.EDIT_JSON.replace(":playbookId", playbook.id),
)
}
>
<Icon $icon={IconBraces} />
Edit JSON
</PopoverItem>
</RequirePermission>
<PlaybookActionItem
$variant={ThemeVariant.Accent}
Expand Down
150 changes: 150 additions & 0 deletions src/pages/main-page/playbooks-page/PlaybookJsonEditPage.tsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,150 @@
import { useMutation, useQuery, useQueryClient } from "@tanstack/react-query";
import { IconArrowLeft } from "@tabler/icons-react";
import React, { useMemo, useState } from "react";
import toast from "react-hot-toast";
import { useNavigate, useParams } from "react-router";

import { getPlaybookById, updatePlaybook } from "@/api/playbooks";
import { formatErrorForToast, getErrorFromApiResponse } from "@/api/utils";
import {
Button,
CardBody,
CardContainer,
CardHeader,
CardTitle,
CenteredCardContent,
Icon,
Link,
Spacer,
Spinner,
Text,
ThemeSize,
ThemeVariant,
} from "@/components";
import CodeEditor from "@/components/CodeEditor";
import { Playbook } from "@/types";
import { PATHS } from "@/utils";

import { ActionButtons, ErrorMessage } from "./shared.styles";
import { validatePlaybookJson } from "./utils";

export const PlaybookJsonEditPage: React.FC = () => {
const navigate = useNavigate();
const queryClient = useQueryClient();
const { playbookId = "" } = useParams();
const detailPath = PATHS.PLAYBOOKS.DETAIL.replace(":playbookId", playbookId);
const [jsonContent, setJsonContent] = useState<string | null>(null);
const [error, setError] = useState<string>("");

const {
data: playbook,
isLoading,
isError,
error: queryError,
} = useQuery({
queryKey: ["playbook", playbookId],
queryFn: () => getPlaybookById(playbookId),
enabled: !!playbookId,
refetchOnWindowFocus: false,
});

const updateMutation = useMutation({
mutationFn: (data: Playbook) => updatePlaybook(playbookId, data),
onSuccess: () => {
toast.success("Playbook updated successfully!");
queryClient.invalidateQueries({ queryKey: ["playbook", playbookId] });
queryClient.invalidateQueries({ queryKey: ["playbooks"] });
navigate(detailPath);
},
onError: (err: Error) => {
setError(err.message || "Failed to update playbook");
toast.error(formatErrorForToast(err, "Failed to update playbook"));
},
});

const initialJsonContent = useMemo(
() => (playbook ? JSON.stringify(playbook, null, 2) : ""),
[playbook],
);
const currentContent = jsonContent ?? initialJsonContent;

const handleChange = (value: string) => {
setJsonContent(value);
const validation = validatePlaybookJson(value);
setError(validation.valid ? "" : validation.error || "Invalid JSON");
};

const handleSubmit = () => {
const validation = validatePlaybookJson(currentContent);
if (!validation.valid || !validation.data) {
setError(validation.error || "Invalid JSON");
return;
}
setError("");
updateMutation.mutate(validation.data);
};

const hasChanges = currentContent.trim() !== initialJsonContent.trim();
const canSubmit = hasChanges && !error && !updateMutation.isPending;

return (
<Spacer $direction="vertical" $gap="lg" $align="start">
<Link $to={detailPath}>
<Icon $icon={IconArrowLeft} />
Back to playbook
</Link>

<CardContainer>
<CardHeader>
<CardTitle>Edit playbook JSON: {playbook?.name ?? "..."}</CardTitle>
</CardHeader>
<CardBody>
{isLoading ? (
<CenteredCardContent>
<Spinner $size={ThemeSize.Medium} />
</CenteredCardContent>
) : isError || !playbook ? (
<Text>
{isError
? getErrorFromApiResponse(queryError)?.message ||
"Could not load playbook"
: "Playbook not found"}
</Text>
) : (
<>
<Text>
Edit the playbook JSON below. The GUI checks it before saving.
</Text>
<CodeEditor
$value={currentContent}
$onChange={handleChange}
placeholder="Edit your CACAO playbook JSON here..."
disabled={updateMutation.isPending}
$hasError={!!error}
$minHeight="500px"
/>
{error && <ErrorMessage>{error}</ErrorMessage>}
<ActionButtons>
<Button
$variant={ThemeVariant.Primary}
$ghost
onClick={() => navigate(detailPath)}
disabled={updateMutation.isPending}
>
Cancel
</Button>
<Button
$variant={ThemeVariant.Success}
onClick={handleSubmit}
disabled={!canSubmit}
>
Save
</Button>
</ActionButtons>
</>
)}
</CardBody>
</CardContainer>
</Spacer>
);
};
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
import { useMutation, useQuery } from "@tanstack/react-query";
import {
IconArrowLeft,
IconBraces,
IconFileCode,
IconPencil,
IconPlayerPlay,
Expand Down Expand Up @@ -152,6 +153,18 @@ export const PlaybookDetailPage: React.FC = () => {
<Icon $icon={IconPencil} />
Edit
</Button>
<Button
$variant={ThemeVariant.Primary}
$ghost
onClick={() =>
navigate(
PATHS.PLAYBOOKS.EDIT_JSON.replace(":playbookId", playbookId!),
)
}
>
<Icon $icon={IconBraces} />
Edit JSON
</Button>
<Button
$variant={ThemeVariant.Error}
$ghost
Expand Down
1 change: 1 addition & 0 deletions src/utils.ts
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ export const PATHS = {
BASE: "/playbooks",
DETAIL: "/playbooks/:playbookId",
EDIT: "/playbooks/:playbookId/edit",
EDIT_JSON: "/playbooks/:playbookId/edit-json",
NEW: "/playbooks/new",
UPLOAD: "/playbooks/upload",
},
Expand Down
Loading