support for malformed automations

This commit is contained in:
ari committed 2022-05-17 20:48:43 -04:00
1 parent 6c57408f27
commit a19db93c37
35 files changed
+683 -161

No files matched your search

@@ -5,6 +5,12 @@
height: 100%;
}
.automation-editor-failures {
display: flex;
flex-direction: column;
padding: 1em;
}
.automation-editor--flow-wrapper {
flex: 1;
padding: 0 0.5em 0 0.5em;
@@ -111,3 +111,63 @@ EmptyStart.args = {
sequence: []
}
}
export const BadAutomationInvalidMetadata = Template.bind({})
BadAutomationInvalidMetadata.args = {
...BadAutomationInvalidMetadata.args,
automation: {
condition: [],
tags: {},
metadata: {
} as any,
trigger: [
],
sequence: []
}
}
export const BadAutomationInvalidTriggers = Template.bind({})
BadAutomationInvalidTriggers.args = {
...BadAutomationInvalidTriggers.args,
automation: {
condition: [],
tags: {},
metadata: {
id: "random",
alias: "Random",
description: "Example Metadata",
trigger_variables: {
'wowo': '!'
},
mode: 'single',
},
trigger: [
"haha I am a string"
] as any,
sequence: []
}
}
export const BadAutomationInvalidSequence = Template.bind({})
BadAutomationInvalidSequence.args = {
...BadAutomationInvalidSequence.args,
automation: {
condition: [],
tags: {},
metadata: {
id: "random",
alias: "Bad Choose Sequence",
description: "Example Metadata",
trigger_variables: {
'wowo': '!'
},
mode: 'single',
},
trigger: [],
sequence: [
{
choose: {}
}
] as any
}
}
@@ -5,9 +5,11 @@ import { AutomationData } from "types/automations";
import { AutoInfoBox } from "./AutoInfoBox";
import { ButtonIcon } from "components/Icons/ButtonIcons";
import { Button } from "components/Inputs/Button";
import { useAutomatioEditorState } from "./state";
import { DAGAutomationFlow } from "components/DAGFlow";
import { useAutomatioEditorState, EditorData } from './state';
import { SafeDAGAutomationFlow } from "components/DAGFlow/safe";
import { DAGAutomationFlowDims } from "components/DAGFlow/types";
import { MiniFailure } from 'types/validators/helper';
import InputYaml from "components/Inputs/InputYaml";
interface Props {
automation?: AutomationData;
@@ -26,7 +28,9 @@ export const AutomationEditor: FC<Props> = ({
updateTrigger,
updateMetadata,
updateCondition,
validate,
save,
saveAndUpdate,
} = useAutomatioEditorState(propsAutos, propsOnUpdate);
const [closeInfo, setCloseInfo] = useState(false);
@@ -37,6 +41,14 @@ export const AutomationEditor: FC<Props> = ({
Loading...
</div>
}
if (state.status === 'invalid') {
return <ValidationBox
failures={state.failures}
data={state.data}
validate={validate}
onSave={saveAndUpdate}
/>
}
return <div className="automation-editor">
<AutoInfoBox
className={closeInfo ? "hide" : "show"}
@@ -61,7 +73,7 @@ export const AutomationEditor: FC<Props> = ({
Save <CheckMarkIcon color="#bf4" />
</Button>
</div>
<DAGAutomationFlow
<SafeDAGAutomationFlow
className="automation-editor--flow-wrapper--flow"
sequence={state.data.sequence}
trigger={state.data.trigger}
@@ -74,3 +86,58 @@ export const AutomationEditor: FC<Props> = ({
</div>
</div>
}
export const ValidationBox: FC<{
failures: MiniFailure[]
validate: (d: any) => MiniFailure[] | null,
data: EditorData,
onSave: (d: EditorData) => void,
}> = props => {
const [{ failures, data }, setState] = useState({
failures: props.failures,
data: props.data,
});
const makeSave = <K extends keyof EditorData>(k: K) => (d: EditorData[K]) => {
const newData = {
...data,
[k]: d,
}
const newFails = props.validate(newData);
if (newFails) {
setState({
failures: newFails,
data: newData,
})
} else {
setState({
failures: [],
data: newData,
})
}
}
return <div className="automation-editor-failures">
<ul>
{failures.map((f, i) => <>
<li key={i}>
<b>{f.path}</b>:
<ul>
{f.message.map((m, j) => <li key={j}>
{m}
</li>)}
</ul>
</li>
</>)}
</ul>
<span>Please correct the automation file manually and then continue!</span>
<InputYaml label="Metadata" value={data.metadata} onChange={makeSave('metadata')} resizable />
<InputYaml label="Tags" value={data.tags} onChange={makeSave('tags')} resizable />
<InputYaml label="Trigger" value={data.trigger} onChange={makeSave('trigger')} resizable />
<InputYaml label="Condition" value={data.condition} onChange={makeSave('condition')} resizable />
<InputYaml label="Actions" value={data.sequence} onChange={makeSave('sequence')} resizable />
<Button disabled={failures.length > 0} onClick={() => props.onSave(data)}>Save</Button>
</div>
}
+39 -18
View File
@@ -1,6 +1,8 @@
import { useState, useEffect } from 'react';
import { AutomationData, AutomationMetadata } from "types/automations";
import * as v from "types/validators/autmation";
import { getFailures } from "types/validators/helper";
import { MiniFailure } from '../../types/validators/helper';
export type EditorData = ReturnType<typeof genEditorData>;
export type EditorState = {
@@ -8,6 +10,10 @@ export type EditorState = {
data: EditorData
} | {
status: 'loading'
} | {
status: 'invalid',
failures: MiniFailure[],
data: EditorData,
}
export type EditorStatus = EditorState['status'];
@@ -20,7 +26,7 @@ export const useAutomatioEditorState = (
});
const makeUpdate = <K extends keyof EditorData, D extends EditorData[K]>(name: K) => (
data: D
) => state.status !== 'loading' && update({
) => ((state.status === 'changed') || (state.status === 'unchanged')) && update({
status: 'changed',
data: {
...state.data,
@@ -28,21 +34,46 @@ export const useAutomatioEditorState = (
}
})
const saveAndUpdate = (data: EditorData) => {
const cleanData = {
...data,
tags: data.tags.reduce((all, [tagName, tagValue]) => ({
...all,
[tagName.trim()]: tagValue.trim(),
}), {})
};
update({
status: "loading",
})
onSave(cleanData);
}
useEffect(() => {
if (automation) {
update({
status: 'unchanged',
data: genEditorData(automation),
})
const failures = getFailures(automation, v.AutomationData);
if (failures) {
update({
status: 'invalid',
failures,
data: genEditorData(automation),
})
} else {
update({
status: 'unchanged',
data: genEditorData(automation),
})
}
}
}, [automation]);
return {
validate: (data: any) => getFailures(data, v.AutomationData),
updateTrigger: makeUpdate('trigger'),
updateSequence: makeUpdate('sequence'),
updateCondition: makeUpdate('condition'),
saveAndUpdate,
updateMetadata: (metadata: AutomationMetadata, tags: Array<[string, string]>) => {
if (state.status !== 'loading') {
if ((state.status === 'changed') || (state.status === 'unchanged')) {
update({
status: 'changed',
data: {
@@ -55,17 +86,7 @@ export const useAutomatioEditorState = (
},
save: () => {
if (state.status !== 'loading') {
const data = {
...state.data,
tags: state.data.tags.reduce((all, [tagName, tagValue]) => ({
...all,
[tagName]: tagValue,
}), {})
};
update({
status: "loading",
})
onSave(data);
saveAndUpdate(state.data)
}
},
get state() {
@@ -64,3 +64,57 @@ FewAutos.args = {
createMockAuto(),
],
}
export const BadAutmations = Template.bind({})
BadAutmations.args = {
...BadAutmations.args,
automations: [
{
condition: [],
tags: {},
metadata: {
id: "Bad Choose Sequence",
alias: "Bad Choose",
description: "Example Metadata",
trigger_variables: {
'wowo': '!'
},
mode: 'single',
},
trigger: [],
sequence: [
{
choose: {}
}
] as any
},
{
condition: [],
tags: {},
metadata: {
id: "random",
alias: "Bad Trigger",
description: "Example Metadata",
trigger_variables: {
'wowo': '!'
},
mode: 'single',
},
trigger: [
"haha I am a string"
] as any,
sequence: []
},
{
condition: [],
tags: {},
metadata: {
} as any,
trigger: [
],
sequence: []
}
],
}
@@ -1,6 +1,6 @@
import "./AutomationListBox.css";
import { FC, useState } from 'react';
import { AutomationData } from "types/automations";
import { AutomationData, AutomationMetadata } from "types/automations";
import InputMultiSelect from "components/Inputs/InputMultiSelect";
import InputText from "components/Inputs/InputText";
import { Button } from "components/Inputs/Button";
@@ -65,6 +65,9 @@ export const getTagList = (autos: AutomationData[]): string[] => Object.keys(aut
}, {}))
const filterAutomations = (autos: AutomationData[], searchText: string, selected: number[], tags: string[]): Array<[AutomationData, number]> => autos.map<[AutomationData, number]>((a, i) => [a, i]).filter(([a, i]) => {
if (!a.metadata) {
return true
}
if (searchText.length > 0) {
if (
!(
@@ -130,25 +133,17 @@ const convertGroupsToItems = (
if (Array.isArray(groups)) {
return groups.map(i => {
const [auto, autoIndex] = autos[i];
let title = "BadAuto<<Missing Metadata>>"
if (auto.metadata) {
title = `Name = ${auto.metadata.alias}\nID = ${auto.metadata.id}\nDescription = ${auto.metadata.description}`
}
return <div
key={i}
className={["automation-list-box--body--item", selected === autoIndex ? 'selected' : ''].join(' ')}
title={`Name = ${auto.metadata.alias}\nID = ${auto.metadata.id}\nDescription = ${auto.metadata.description}`}
title={title}
onClick={() => onSelectAutomation(autoIndex)}
>
<div
className="automation-list-box--body--item--title"
>
<b>{auto.metadata.alias.slice(0, 15)} <span>({auto.metadata.id.slice(0, 5)})</span></b>
<span>{auto.metadata.description.slice(0, 25)}</span>
<div
className="automation-list-box--body--item--tags"
>
{Object.keys(auto.tags).map(tagName => <span key={tagName}>
<b>{tagName}:</b> {auto.tags[tagName]}
</span>)}
</div>
</div>
<MetadataBox metadata={auto.metadata} tags={auto.tags} />
<Button onClick={() => onRemove(autoIndex)}><TrashIcon /></Button>
</div>
})
@@ -167,6 +162,31 @@ const convertGroupsToItems = (
}
}
export const MetadataBox: FC<{
metadata: AutomationMetadata,
tags: Record<string, string>,
}> = (auto) => {
let title = <span>{"BadAuto<<Missing Metadata>>"}</span>
if (auto.metadata) {
title = <>
<b>{String(auto.metadata.alias).slice(0, 15)} <span>({String(auto.metadata.id).slice(0, 5)})</span></b>
<span>{String(auto.metadata.description).slice(0, 25)}</span>
</>
}
return <div
className="automation-list-box--body--item--title"
>
{title}
<div
className="automation-list-box--body--item--tags"
>
{Object.keys(auto.tags).map(tagName => <span key={tagName}>
<b>{tagName}:</b> {auto.tags[tagName]}
</span>)}
</div>
</div>
}
const AutomationListBoxGroup: FC<{
groupName: string,
+1 -1
View File
@@ -1,5 +1,5 @@
import { FC } from "react";
import { AddIcon, PencilIcon, TrashIcon } from '../Icons/index';
import { AddIcon, TrashIcon } from '../Icons/index';
import { useCircleStyles } from './styles';
import { Handle, Position, XYPosition } from 'react-flow-renderer';
@@ -1,5 +1,5 @@
import { makeFlowCircle } from "./DAGCircle"
import { DAGAutomationFlowDims, FlowData } from "./types"
import { DAGAutomationFlowDims } from "./types"
import { XYPosition } from 'react-flow-renderer';
export const makeAddButton = (
+13 -13
View File
@@ -20,7 +20,18 @@ const nodeTypes = {
'dagcircle': DAGCircle,
}
interface Props {
const makeOnEditAutomationConditions = (
conditions: AutomationCondition[],
updateConditions: (c: AutomationCondition[]) => void,
openModal: UpdateModalState,
) => () => openModal({
single: false,
node: conditions,
allowedTypes: ['condition'],
update: c => updateConditions(c as any),
})
export interface DAGAutomationFlowProps {
className?: string;
trigger: AutomationTrigger[];
condition: AutomationCondition[];
@@ -31,7 +42,7 @@ interface Props {
onConditionUpdate: (s: AutomationCondition[]) => void;
}
export const DAGAutomationFlow: FC<Props> = ({
export const DAGAutomationFlow: FC<DAGAutomationFlowProps> = ({
className,
trigger,
condition,
@@ -131,14 +142,3 @@ export const DAGAutomationFlow: FC<Props> = ({
</ReactFlow>
</>;
}
const makeOnEditAutomationConditions = (
conditions: AutomationCondition[],
updateConditions: (c: AutomationCondition[]) => void,
openModal: UpdateModalState,
) => () => openModal({
single: false,
node: conditions,
allowedTypes: ['condition'],
update: c => updateConditions(c as any),
})
+4
View File
@@ -0,0 +1,4 @@
.dag-flow-safe {
height: 100%;
overflow: scroll;
}
+84
View File
@@ -0,0 +1,84 @@
import "./safe.css";
import { Component, ErrorInfo } from "react";
import { DAGAutomationFlow, DAGAutomationFlowProps } from ".";
import { AutomationSequenceNode } from "types/automations";
import { AutomationCondition } from "types/automations/conditions";
import { AutomationTrigger } from 'types/automations/triggers';
import InputYaml from "components/Inputs/InputYaml";
import { Button } from "components/Inputs/Button";
type GoodState = {
hasError: false;
}
type FailedStateData = {
sequence: AutomationSequenceNode[],
condition: AutomationCondition[],
trigger: AutomationTrigger[],
}
type FailedState = {
hasError: true,
error: any,
errorInfo?: ErrorInfo,
} & FailedStateData
type State = GoodState | FailedState
export class SafeDAGAutomationFlow extends Component<DAGAutomationFlowProps, State> {
state: State = {
hasError: false
}
componentDidCatch(error: Error, errorInfo: ErrorInfo) {
this.setState({
hasError: true,
error,
errorInfo,
sequence: this.props.sequence,
condition: this.props.condition,
trigger: this.props.trigger,
})
}
render() {
if (this.state.hasError) {
const makeSet = <K extends keyof FailedStateData>(k: K) => (d: FailedStateData[K]) => this.setState({
...this.state,
[k]: d,
});
const makeSave = <K extends keyof FailedStateData>(k: K) => () => {
if (!this.state.hasError) {
return
}
if (k === 'condition') {
this.props.onConditionUpdate(this.state.condition)
} else if (k === 'sequence') {
this.props.onSequenceUpdate(this.state.sequence)
} else if (k === 'trigger') {
this.props.onTriggerUpdate(this.state.trigger)
}
}
return <div className="dag-flow-safe">
<h1>An Error has occured.</h1>
<h1>Failed to Open Autmation!</h1>
Something is likely not configured in your automation properly.
<hr />
<h2>Error:</h2>
<h2>{String(this.state.error)}</h2>
<br />
{JSON.stringify(this.state.error, null, 4)}
{this.state.errorInfo && this.state.errorInfo.componentStack.split('\n').map((s, i) => <>
<span key={i}>{s}</span><br key={`br-${i}`} />
</>)}
<h2>Automation YAML</h2>
<InputYaml resizable label="Trigger" value={this.state.trigger} onChange={makeSet('trigger')} />
<Button onClick={makeSave('trigger')}>Save Triggers</Button>
<InputYaml resizable label="Condition" value={this.state.condition} onChange={makeSet('condition')} />
<Button onClick={makeSave('condition')}>Save Conditions</Button>
<InputYaml resizable label="Action" value={this.state.sequence} onChange={makeSet('sequence')} />
<Button onClick={makeSave('sequence')}>Save Actions</Button>
</div>
}
return <DAGAutomationFlow {...this.props} />;
}
}
@@ -1,6 +1,5 @@
import { AutomationTrigger } from 'types/automations/triggers';
import { DAGAutomationFlowDims, FlowData, TriggerMakerOptions } from './types';
import { makeFlowCircle } from './DAGCircle';
import { makeAddButton } from './flowDataMods';
export const triggerToFlow = (
@@ -14,7 +13,6 @@ export const triggerToFlow = (
distanceFactor,
nodeHeight,
nodeWidth,
circleSize,
padding,
conditionHeight,
} = dims;
@@ -1,5 +1,4 @@
import "./InputBoolean.css";
import InputWrapper from "./InputWrapper";
export interface Props {
label: string;
+1 -1
View File
@@ -1,7 +1,7 @@
import * as yaml from "js-yaml";
import { useState } from "react";
import InputTextArea from "./InputTextArea";
import { useDelayedFunction, useDelayEffect } from 'utils/useDelay';
import { useDelayEffect } from 'utils/useDelay';
export interface Props<T extends {}> {
label: string;
@@ -8,10 +8,6 @@ import InputYaml from 'components/Inputs/InputYaml';
type UseState = <S>(s: S) => [S, Dispatch<SetStateAction<S>>]
const mockUseState: UseState = s => {
return [s, () => { }]
}
export const useEditorNodeState = (originalNode: AutomationNode, uState: UseState = useState) => {
const [allState, setAllState] = uState({
node: originalNode,
@@ -1,5 +1,4 @@
import { AutomationNodeSubtype, AutomationNodeTypes } from "types/automations";
import { ActionType } from "types/automations/actions";
import { AutomationNode } from '../../types/automations/index';