From 83ee3035f587c9c9d7a87b799ffcbbb296215fae Mon Sep 17 00:00:00 2001
From: Raphael Schweikert <Raphael.Schweikert1@swisscom.com>
Date: Thu, 10 Oct 2024 19:42:39 +0200
Subject: [PATCH] feat(editor): use a fancy editor for fallback hop editing

---
 package-lock.json                             | 14 +++++
 package.json                                  |  1 +
 src/main/frontend/App.tsx                     |  6 ++
 src/main/frontend/sections/RunControls.tsx    | 11 ++--
 .../sections/editor/types/FallbackStep.tsx    | 38 ++++--------
 src/main/frontend/widgets/CodeEditor.tsx      | 59 +++++++++++++++++++
 src/main/frontend/widgets/StepEditor.tsx      | 36 ++++++-----
 7 files changed, 113 insertions(+), 52 deletions(-)
 create mode 100644 src/main/frontend/widgets/CodeEditor.tsx

diff --git a/package-lock.json b/package-lock.json
index c2088ee..89986a6 100644
--- a/package-lock.json
+++ b/package-lock.json
@@ -19,6 +19,7 @@
 				"@types/react-dom": "^18.3.0",
 				"@typescript-eslint/eslint-plugin": "^8.8.0",
 				"@typescript-eslint/parser": "^8.8.0",
+				"@uidotdev/usehooks": "^2.4.1",
 				"concurrently": "^9.0.1",
 				"eslint": "^8.57.1",
 				"eslint-config-prettier": "^9.1.0",
@@ -8152,6 +8153,19 @@
 				"url": "https://opencollective.com/typescript-eslint"
 			}
 		},
+		"node_modules/@uidotdev/usehooks": {
+			"version": "2.4.1",
+			"resolved": "https://registry.npmjs.org/@uidotdev/usehooks/-/usehooks-2.4.1.tgz",
+			"integrity": "sha512-1I+RwWyS+kdv3Mv0Vmc+p0dPYH0DTRAo04HLyXReYBL9AeseDWUJyi4THuksBJcu9F0Pih69Ak150VDnqbVnXg==",
+			"dev": true,
+			"engines": {
+				"node": ">=16"
+			},
+			"peerDependencies": {
+				"react": ">=18.0.0",
+				"react-dom": ">=18.0.0"
+			}
+		},
 		"node_modules/@ungap/structured-clone": {
 			"version": "1.2.0",
 			"resolved": "https://registry.npmjs.org/@ungap/structured-clone/-/structured-clone-1.2.0.tgz",
diff --git a/package.json b/package.json
index ac8893c..f3092d2 100644
--- a/package.json
+++ b/package.json
@@ -24,6 +24,7 @@
 		"@types/react-dom": "^18.3.0",
 		"@typescript-eslint/eslint-plugin": "^8.8.0",
 		"@typescript-eslint/parser": "^8.8.0",
+		"@uidotdev/usehooks": "^2.4.1",
 		"concurrently": "^9.0.1",
 		"eslint": "^8.57.1",
 		"eslint-config-prettier": "^9.1.0",
diff --git a/src/main/frontend/App.tsx b/src/main/frontend/App.tsx
index ce8021c..dfb5f79 100644
--- a/src/main/frontend/App.tsx
+++ b/src/main/frontend/App.tsx
@@ -48,6 +48,12 @@ const RootElement = styled('div')`
 	> .output {
 		grid-area: output;
 	}
+
+	label:not(coral-checkbox label) {
+		display: inline-flex;
+		align-items: baseline;
+		gap: 6px;
+	}
 `;
 
 export const App: FC<{ runEndpoint: string }> = props => {
diff --git a/src/main/frontend/sections/RunControls.tsx b/src/main/frontend/sections/RunControls.tsx
index e2d7f0d..7a00829 100644
--- a/src/main/frontend/sections/RunControls.tsx
+++ b/src/main/frontend/sections/RunControls.tsx
@@ -1,4 +1,4 @@
-import React, { FC, FormEvent, useContext, useId, useRef } from 'react';
+import React, { FC, FormEvent, useContext, useRef } from 'react';
 
 import { styled } from 'goober';
 import { RunEndpointContext, ScriptContext } from '../App';
@@ -32,18 +32,17 @@ export const RunControls: FC<{ runWith: (data: FormData) => Promise<void> }> = (
 		await runWith(data);
 	}
 
-	const id = useId();
-
 	return (
 		<Elm className="run-controls" ref={formRef} method="POST" action={endpoint} encType="multipart/form-data" onSubmit={run}>
 			{script.parameters.length ? (
 				<fieldset>
 					<legend>Arguments</legend>
 					<div className="arguments">
-						{script.parameters.map(({ name, type }, i) => (
+						{script.parameters.map(({ name, type }) => (
 							<React.Fragment key={name}>
-								<label htmlFor={`${id}_${i}`}>{name}: </label>
-								<input id={`${id}_${i}`} is="coral-textfield" type={type} name={name} />
+								<label>
+									{name}:<input is="coral-textfield" type={type} name={name} />
+								</label>
 							</React.Fragment>
 						))}
 					</div>
diff --git a/src/main/frontend/sections/editor/types/FallbackStep.tsx b/src/main/frontend/sections/editor/types/FallbackStep.tsx
index 69e4698..1af1d51 100644
--- a/src/main/frontend/sections/editor/types/FallbackStep.tsx
+++ b/src/main/frontend/sections/editor/types/FallbackStep.tsx
@@ -1,48 +1,32 @@
-import React, { FC, useContext, useEffect, useRef, useState } from 'react';
+import React, { FC, useContext } from 'react';
 
 import { AnyHop, Hop } from '../../../model/hops';
 import { StepEditor } from '../../../widgets/StepEditor';
 import { ScriptContext } from '../../../App';
+import { CodeEditor } from '../../../widgets/CodeEditor';
 
 export const FallbackStep: FC<{ parentHops: Hop[]; hop: AnyHop }> = ({ parentHops, hop }) => {
 	const scriptContext = useContext(ScriptContext);
 
-	const { type: _, ...hopWithoutType } = hop;
-	const cleaned = JSON.stringify(hopWithoutType, null, '  ');
-
-	const [code, setCode] = useState(cleaned);
-	const updated = useRef(false);
-
-	useEffect(() => {
-		setCode(cleaned);
-		updated.current = false;
-	}, [hop]);
+	const { type: hopType, ...hopWithoutType } = hop;
+	const code = JSON.stringify(hopWithoutType, null, '  ');
 
 	return (
-		<StepEditor parentHops={parentHops} hop={hop} title={`Unknown hop type ${hop.type}`}>
-			<textarea
-				cols={120}
-				rows={10}
-				onInput={e => {
-					updated.current = true;
-					setCode(e.currentTarget.value);
-				}}
+		<StepEditor parentHops={parentHops} hop={hop} title={`Unknown Hop (${hopType})`}>
+			<CodeEditor
 				value={code}
-				onBlur={() => {
-					if (!updated.current) {
-						// No change since last set
+				changed={(value, hasError) => {
+					if (hasError) {
 						return;
 					}
 					try {
-						const editedSettings = JSON.parse(code);
-
-						Object.assign(hop, editedSettings, { type: hop.type });
+						Object.assign(hop, JSON.parse(value), { type: hopType });
 						scriptContext.commit();
 					} catch (e) {
-						// Not currently valid JSON
+						// Invalid JSON
 					}
 				}}
-				style={{ fontFamily: 'monospace' }}
+				language="json"
 			/>
 		</StepEditor>
 	);
diff --git a/src/main/frontend/widgets/CodeEditor.tsx b/src/main/frontend/widgets/CodeEditor.tsx
new file mode 100644
index 0000000..d46677d
--- /dev/null
+++ b/src/main/frontend/widgets/CodeEditor.tsx
@@ -0,0 +1,59 @@
+import React, { useEffect, useId, useRef, useState } from 'react';
+
+import { useDebounce } from '@uidotdev/usehooks';
+
+import { Editor } from '@monaco-editor/react';
+import type * as monaco from 'monaco-editor';
+
+export const CodeEditor: React.FC<{
+	value: string;
+	changed(val: string, hasErrors: boolean): void;
+	language: 'json' | 'groovy' | 'jexl';
+}> = ({ value: outsideValue, changed, language }) => {
+	const editorRef = useRef<monaco.editor.IStandaloneCodeEditor | null>(null);
+
+	const hasError = useRef(false);
+	const [value, setValue] = useState(outsideValue);
+	const prevValue = useRef<string>(outsideValue);
+	const debouncedValue = useDebounce(prevValue.current, 600);
+
+	// Call the change listener when the debounced value changes
+	useEffect(() => {
+		if (outsideValue !== debouncedValue) {
+			changed(debouncedValue, hasError.current);
+		}
+	}, [debouncedValue, hasError.current]);
+
+	// Allow value updates from outside
+	useEffect(() => {
+		if (editorRef.current && outsideValue !== prevValue.current) {
+			prevValue.current = outsideValue;
+			editorRef.current.setValue(outsideValue);
+		}
+	}, [outsideValue]);
+
+	return (
+		<Editor
+			onMount={ed => (editorRef.current = ed)}
+			defaultValue={value}
+			defaultLanguage={language}
+			defaultPath={`inmemory://model/${useId()}.${language}`}
+			theme="light"
+			options={{
+				formatOnType: true,
+				scrollBeyondLastLine: false,
+				minimap: {
+					enabled: false,
+				},
+			}}
+			height={250}
+			onValidate={markers => {
+				hasError.current = markers.length > 0;
+			}}
+			onChange={val => {
+				prevValue.current = val ?? '';
+				setValue(val ?? '');
+			}}
+		/>
+	);
+};
diff --git a/src/main/frontend/widgets/StepEditor.tsx b/src/main/frontend/widgets/StepEditor.tsx
index 115ce83..e870a64 100644
--- a/src/main/frontend/widgets/StepEditor.tsx
+++ b/src/main/frontend/widgets/StepEditor.tsx
@@ -72,37 +72,36 @@ const Elm = styled('div')`
 
 		summary {
 			display: grid;
-			grid-template-columns: auto 1fr auto auto auto;
+			grid-template-columns: auto 1fr auto;
 			color: var(--contrast-color);
 			cursor: pointer;
 
+			font-size: 18px;
+			> * {
+				font-size: inherit;
+			}
+
 			&::-webkit-details-marker {
 				display: none;
 			}
 
 			&::before {
-				font-weight: 600;
 				display: inline-block;
+				align-self: center;
 				content: counter(steps);
 				color: var(--contrast-color);
 				min-width: 2em;
-				align-self: center;
 				text-align: center;
 			}
 
-			h3 {
-				display: flex;
-				flex-direction: column;
-				justify-content: center;
+			h2 {
+				display: inline-block;
+				font-weight: normal;
+				align-self: center;
 				padding: 2px 5px;
-				margin: 0;
 				overflow: hidden;
-
-				span {
-					white-space: nowrap;
-					text-overflow: ellipsis;
-					overflow: hidden;
-				}
+				margin: 0;
+				text-overflow: ellipsis;
 			}
 
 			.menu {
@@ -114,8 +113,9 @@ const Elm = styled('div')`
 		}
 		.edit {
 			margin-left: 4px;
-			background-color: rgba(255, 255, 255, 0.9);
 			padding: 10px;
+			padding-right: 10%;
+			background: #ffffffce;
 		}
 
 		&[open] {
@@ -186,11 +186,9 @@ export const StepEditor: FC<{ parentHops: Hop[]; hop: AnyHop; title: string; chi
 
 	return (
 		<Elm className={`hop-config ${hop.type}`}>
-			<details>
+			<details open={false}>
 				<summary draggable="true">
-					<h3>
-						<span>{title}</span>
-					</h3>
+					<h2>{title}</h2>
 					<div className="menu">
 						<button
 							is="coral-button"