From efedf2acd2b66ba3b8b28aa4796ef5942b1e7c2e Mon Sep 17 00:00:00 2001
From: Sebastian Malton <sebastian@malton.name>
Date: Fri, 7 May 2021 12:39:29 -0400
Subject: [PATCH] Refactor <Input> to be clearer. Add namespace name validator

Signed-off-by: Sebastian Malton <sebastian@malton.name>
---
 .../cluster-accessible-namespaces.tsx         |   2 +
 .../editable-list/editable-list.tsx           |   6 +-
 .../components/hotbar/hotbar-add-command.tsx  |   4 +-
 src/renderer/components/input/input.tsx       | 269 +++++++-----------
 .../components/input/input_validators.ts      |  26 +-
 5 files changed, 119 insertions(+), 188 deletions(-)

diff --git a/src/renderer/components/cluster-settings/components/cluster-accessible-namespaces.tsx b/src/renderer/components/cluster-settings/components/cluster-accessible-namespaces.tsx
index 0fb3e7e08f..63a13ab20d 100644
--- a/src/renderer/components/cluster-settings/components/cluster-accessible-namespaces.tsx
+++ b/src/renderer/components/cluster-settings/components/cluster-accessible-namespaces.tsx
@@ -4,6 +4,7 @@ import { Cluster } from "../../../../main/cluster";
 import { SubTitle } from "../../layout/sub-title";
 import { EditableList } from "../../editable-list";
 import { observable } from "mobx";
+import { namespaceValue } from "../../input/input_validators";
 
 interface Props {
   cluster: Cluster;
@@ -19,6 +20,7 @@ export class ClusterAccessibleNamespaces extends React.Component<Props> {
         <SubTitle title="Accessible Namespaces" id="accessible-namespaces" />
         <EditableList
           placeholder="Add new namespace..."
+          validator={namespaceValue}
           add={(newNamespace) => {
             this.namespaces.add(newNamespace);
             this.props.cluster.accessibleNamespaces = Array.from(this.namespaces);
diff --git a/src/renderer/components/editable-list/editable-list.tsx b/src/renderer/components/editable-list/editable-list.tsx
index 3c6309b344..5e062bedb0 100644
--- a/src/renderer/components/editable-list/editable-list.tsx
+++ b/src/renderer/components/editable-list/editable-list.tsx
@@ -2,7 +2,7 @@ import "./editable-list.scss";
 
 import React from "react";
 import { Icon } from "../icon";
-import { Input } from "../input";
+import { Input, InputValidator } from "../input";
 import { observable } from "mobx";
 import { observer } from "mobx-react";
 import { autobind } from "../../utils";
@@ -12,6 +12,7 @@ export interface Props<T> {
   add: (newItem: string) => void,
   remove: (info: { oldItem: T, index: number }) => void,
   placeholder?: string,
+  validator?: InputValidator,
 
   // An optional prop used to convert T to a displayable string
   // defaults to `String`
@@ -39,7 +40,7 @@ export class EditableList<T> extends React.Component<Props<T>> {
   }
 
   render() {
-    const { items, remove, renderItem, placeholder } = this.props;
+    const { items, remove, renderItem, placeholder, validator } = this.props;
 
     return (
       <div className="EditableList">
@@ -47,6 +48,7 @@ export class EditableList<T> extends React.Component<Props<T>> {
           <Input
             theme="round-black"
             value={this.currentNewItem}
+            validators={validator}
             onSubmit={this.onSubmit}
             placeholder={placeholder}
             onChange={val => this.currentNewItem = val}
diff --git a/src/renderer/components/hotbar/hotbar-add-command.tsx b/src/renderer/components/hotbar/hotbar-add-command.tsx
index 5ec5734219..f4a1fd162e 100644
--- a/src/renderer/components/hotbar/hotbar-add-command.tsx
+++ b/src/renderer/components/hotbar/hotbar-add-command.tsx
@@ -39,8 +39,8 @@ export class HotbarAddCommand extends React.Component {
           data-test-id="command-palette-hotbar-add-name"
           validators={[uniqueHotbarName]}
           onSubmit={(v) => this.onSubmit(v)}
-          dirty={true}
-          showValidationLine={true} />
+          showErrorInitially={true}
+        />
         <small className="hint">
           Please provide a new hotbar name (Press &quot;Enter&quot; to confirm or &quot;Escape&quot; to cancel)
         </small>
diff --git a/src/renderer/components/input/input.tsx b/src/renderer/components/input/input.tsx
index ad3b77c8e8..a9382c1c0f 100644
--- a/src/renderer/components/input/input.tsx
+++ b/src/renderer/components/input/input.tsx
@@ -1,15 +1,15 @@
 import "./input.scss";
 
 import React, { DOMAttributes, InputHTMLAttributes, TextareaHTMLAttributes } from "react";
-import { autobind, cssNames, debouncePromise, getRandId } from "../../utils";
+import { autobind, cssNames, getRandId } from "../../utils";
 import { Icon } from "../icon";
 import { Tooltip, TooltipProps } from "../tooltip";
 import * as Validators from "./input_validators";
 import { InputValidator } from "./input_validators";
 import isString from "lodash/isString";
-import isFunction from "lodash/isFunction";
-import isBoolean from "lodash/isBoolean";
-import uniqueId from "lodash/uniqueId";
+import { action, computed, observable } from "mobx";
+import { debounce } from "lodash";
+import { observer } from "mobx-react";
 
 const { conditionalValidators, ...InputValidators } = Validators;
 
@@ -25,8 +25,7 @@ export type InputProps<T = string> = Omit<InputElementProps, "onChange" | "onSub
   autoSelectOnFocus?: boolean
   multiLine?: boolean; // use text-area as input field
   maxRows?: number; // when multiLine={true} define max rows size
-  dirty?: boolean; // show validation errors even if the field wasn't touched yet
-  showValidationLine?: boolean; // show animated validation line for async validators
+  showErrorInitially?: boolean; // show validation errors even if the field wasn't touched yet
   showErrorsAsTooltip?: boolean | Omit<TooltipProps, "targetId">; // show validation errors as a tooltip :hover (instead of block below)
   iconLeft?: string | React.ReactNode; // material-icon name in case of string-type
   iconRight?: string | React.ReactNode;
@@ -36,46 +35,50 @@ export type InputProps<T = string> = Omit<InputElementProps, "onChange" | "onSub
   onSubmit?(value: T): void;
 };
 
-interface State {
-  focused?: boolean;
-  dirty?: boolean;
-  dirtyOnBlur?: boolean;
-  valid?: boolean;
-  validating?: boolean;
-  errors?: React.ReactNode[];
-}
-
 const defaultProps: Partial<InputProps> = {
   rows: 1,
   maxRows: 10000,
-  showValidationLine: true,
   validators: [],
+  showErrorInitially: false,
 };
 
-export class Input extends React.Component<InputProps, State> {
+@observer
+export class Input extends React.Component<InputProps> {
   static defaultProps = defaultProps as object;
 
-  public input: InputElement;
+  public inputRef = React.createRef<InputElement>();
   public validators: InputValidator[] = [];
 
-  public state: State = {
-    dirty: !!this.props.dirty,
-    valid: true,
-    errors: [],
-  };
+  @observable errors: React.ReactNode[] = [];
+  @observable dirty = Boolean(this.props.showErrorInitially);
+  @observable focused = false;
 
-  isValid() {
-    return this.state.valid;
+  @computed get isValid() {
+    return this.errors.length === 0;
+  }
+
+  componentDidMount() {
+    this.validators = conditionalValidators
+      // add conditional validators if matches input props
+      .filter(validator => validator.condition(this.props))
+      // add custom validators
+      .concat(this.props.validators);
+
+    if (this.props.showErrorInitially) {
+      this.runValidatorsRaw();
+    }
+
+    this.autoFitHeight();
   }
 
   setValue(value: string) {
     if (value !== this.getValue()) {
-      const nativeInputValueSetter = Object.getOwnPropertyDescriptor(this.input.constructor.prototype, "value").set;
+      const nativeInputValueSetter = Object.getOwnPropertyDescriptor(this.inputRef.constructor.prototype, "value").set;
 
-      nativeInputValueSetter.call(this.input, value);
+      nativeInputValueSetter.call(this.inputRef, value);
       const evt = new Event("input", { bubbles: true });
 
-      this.input.dispatchEvent(evt);
+      this.inputRef.current.dispatchEvent(evt);
     }
   }
 
@@ -83,21 +86,21 @@ export class Input extends React.Component<InputProps, State> {
     const { value, defaultValue = "" } = this.props;
 
     if (value !== undefined) return value; // controlled input
-    if (this.input) return this.input.value; // uncontrolled input
+    if (this.inputRef) return this.inputRef.current.value; // uncontrolled input
 
     return defaultValue as string;
   }
 
   focus() {
-    this.input.focus();
+    this.inputRef.current.focus();
   }
 
   blur() {
-    this.input.blur();
+    this.inputRef.current.blur();
   }
 
   select() {
-    this.input.select();
+    this.inputRef.current.select();
   }
 
   private autoFitHeight() {
@@ -106,7 +109,8 @@ export class Input extends React.Component<InputProps, State> {
     if (!multiLine) {
       return;
     }
-    const textArea = this.input;
+
+    const textArea = this.inputRef.current;
     const lineHeight = parseFloat(window.getComputedStyle(textArea).lineHeight);
     const rowsCount = (this.getValue().match(/\n/g) || []).length + 1;
     const height = lineHeight * Math.min(Math.max(rowsCount, rows), maxRows);
@@ -114,117 +118,62 @@ export class Input extends React.Component<InputProps, State> {
     textArea.style.height = `${height}px`;
   }
 
-  private validationId: string;
-
-  async validate(value = this.getValue()) {
-    let validationId = (this.validationId = ""); // reset every time for async validators
-    const asyncValidators: Promise<any>[] = [];
-    const errors: React.ReactNode[] = [];
+  @action
+  runValidatorsRaw() {
+    this.errors = [];
+    const value = this.getValue();
 
     // run validators
     for (const validator of this.validators) {
-      if (errors.length) {
-        // stop validation check if there is an error already
-        break;
-      }
-      const result = validator.validate(value, this.props);
+      const isValid = validator.validate(value, this.props);
 
-      if (isBoolean(result) && !result) {
-        errors.push(this.getValidatorError(value, validator));
-      } else if (result instanceof Promise) {
-        if (!validationId) {
-          this.validationId = validationId = uniqueId("validation_id_");
+      if (!isValid) {
+        if (typeof validator.message === "function") {
+          this.errors.push(validator.message(value, this.props));
+        } else {
+          this.errors.push(validator.message);
         }
-        asyncValidators.push(
-          result.then(
-            () => null, // don't consider any valid result from promise since we interested in errors only
-            error => this.getValidatorError(value, validator) || error
-          )
-        );
       }
     }
 
-    // save sync validators result first
-    this.setValidation(errors);
-
-    // handle async validators result
-    if (asyncValidators.length > 0) {
-      this.setState({ validating: true, valid: false });
-      const asyncErrors = await Promise.all(asyncValidators);
-
-      if (this.validationId === validationId) {
-        this.setValidation(errors.concat(...asyncErrors.filter(err => err)));
-      }
-    }
-
-    this.input.setCustomValidity(errors.length ? errors[0].toString() : "");
+    this.inputRef.current.setCustomValidity(this.errors.length ? this.errors[0].toString() : "");
   }
 
-  setValidation(errors: React.ReactNode[]) {
-    this.setState({
-      validating: false,
-      valid: !errors.length,
-      errors,
-    });
-  }
+  runValidators = debounce(() => this.runValidatorsRaw(), 500, {
+    trailing: true,
+    leading: false,
+  });
 
-  private getValidatorError(value: string, { message }: InputValidator) {
-    if (isFunction(message)) return message(value, this.props);
-
-    return message || "";
-  }
-
-  private setupValidators() {
-    this.validators = conditionalValidators
-      // add conditional validators if matches input props
-      .filter(validator => validator.condition(this.props))
-      // add custom validators
-      .concat(this.props.validators)
-      // debounce async validators
-      .map(({ debounce, ...validator }) => {
-        if (debounce) validator.validate = debouncePromise(validator.validate, debounce);
-
-        return validator;
-      });
-    // run validation
-    this.validate();
-  }
-
-  setDirty(dirty = true) {
-    if (this.state.dirty === dirty) return;
-    this.setState({ dirty });
+  validate() {
+    this.errors = [];
+    this.runValidators();
   }
 
   @autobind()
   onFocus(evt: React.FocusEvent<InputElement>) {
     const { onFocus, autoSelectOnFocus } = this.props;
 
-    if (onFocus) onFocus(evt);
-    if (autoSelectOnFocus) this.select();
-    this.setState({ focused: true });
+    onFocus?.(evt);
+
+    if (autoSelectOnFocus) {
+      this.select();
+    }
+
+    this.focused = true;
   }
 
   @autobind()
   onBlur(evt: React.FocusEvent<InputElement>) {
-    const { onBlur } = this.props;
-
-    if (onBlur) onBlur(evt);
-    if (this.state.dirtyOnBlur) this.setState({ dirty: true, dirtyOnBlur: false });
-    this.setState({ focused: false });
+    this.props.onBlur?.(evt);
+    this.focused = false;
   }
 
   @autobind()
-  onChange(evt: React.ChangeEvent<any>) {
-    if (this.props.onChange) {
-      this.props.onChange(evt.currentTarget.value, evt);
-    }
-
+  onChange(evt: React.ChangeEvent<InputElement>) {
+    this.props.onChange?.(evt.currentTarget.value, evt);
     this.validate();
     this.autoFitHeight();
 
-    // mark input as dirty for the first time only onBlur() to avoid immediate error-state show when start typing
-    if (!this.state.dirty) this.setState({ dirtyOnBlur: true });
-
     // re-render component when used as uncontrolled input
     // when used @defaultValue instead of @value changing real input.value doesn't call render()
     if (this.isUncontrolled && this.showMaxLenIndicator) {
@@ -233,19 +182,17 @@ export class Input extends React.Component<InputProps, State> {
   }
 
   @autobind()
-  onKeyDown(evt: React.KeyboardEvent<any>) {
+  onKeyDown(evt: React.KeyboardEvent<InputElement>) {
+    this.props.onKeyDown?.(evt);
+
     const modified = evt.shiftKey || evt.metaKey || evt.altKey || evt.ctrlKey;
 
-    if (this.props.onKeyDown) {
-      this.props.onKeyDown(evt);
-    }
+    if (!modified && evt.key === "Enter") {
+      this.runValidatorsRaw();
 
-    switch (evt.key) {
-      case "Enter":
-        if (this.props.onSubmit && !modified && !evt.repeat && this.isValid) {
-          this.props.onSubmit(this.getValue());
-        }
-        break;
+      if (this.isValid) {
+        this.props.onSubmit?.(this.getValue());
+      }
     }
   }
 
@@ -259,68 +206,33 @@ export class Input extends React.Component<InputProps, State> {
     return this.props.value === undefined;
   }
 
-  componentDidMount() {
-    this.setupValidators();
-    this.autoFitHeight();
-  }
-
-  componentDidUpdate(prevProps: InputProps) {
-    const { defaultValue, value, dirty, validators } = this.props;
-
-    if (prevProps.value !== value || defaultValue !== prevProps.defaultValue) {
-      this.validate();
-      this.autoFitHeight();
-    }
-
-    if (prevProps.dirty !== dirty) {
-      this.setDirty(dirty);
-    }
-
-    if (prevProps.validators !== validators) {
-      this.setupValidators();
-    }
-  }
-
-  @autobind()
-  bindRef(elem: InputElement) {
-    this.input = elem;
-  }
-
   render() {
     const {
-      multiLine, showValidationLine, validators, theme, maxRows, children, showErrorsAsTooltip,
+      multiLine, validators, theme, maxRows, children, showErrorsAsTooltip,
       maxLength, rows, disabled, autoSelectOnFocus, iconLeft, iconRight, contentRight, id,
-      dirty: _dirty, // excluded from passing to input-element
-      ...inputProps
+      onChange, onSubmit, showErrorInitially, ...inputPropsRaw
     } = this.props;
-    const { focused, dirty, valid, validating, errors } = this.state;
-
     const className = cssNames("Input", this.props.className, {
       [`theme ${theme}`]: theme,
-      focused,
+      focused: this.focused,
       disabled,
-      invalid: !valid,
-      dirty,
-      validating,
-      validatingLine: validating && showValidationLine,
+      invalid: !this.isValid,
+      dirty: this.dirty,
     });
-
-    // prepare input props
-    Object.assign(inputProps, {
+    const inputProps: InputElementProps = {
+      ...inputPropsRaw,
       className: "input box grow",
       onFocus: this.onFocus,
       onBlur: this.onBlur,
       onChange: this.onChange,
       onKeyDown: this.onKeyDown,
-      rows: multiLine ? (rows || 1) : null,
-      ref: this.bindRef,
       spellCheck: "false",
       disabled,
-    });
-    const showErrors = errors.length > 0 && !valid && dirty;
+    };
+    const showErrors = this.errors.length > 0;
     const errorsInfo = (
       <div className="errors box grow">
-        {errors.map((error, i) => <p key={i}>{error}</p>)}
+        {this.errors.map((error, i) => <p key={i}>{error}</p>)}
       </div>
     );
     const componentId = id || showErrorsAsTooltip ? getRandId({ prefix: "input_tooltip_id" }) : undefined;
@@ -345,7 +257,18 @@ export class Input extends React.Component<InputProps, State> {
         {tooltipError}
         <label className="input-area flex gaps align-center" id="">
           {isString(iconLeft) ? <Icon material={iconLeft}/> : iconLeft}
-          {multiLine ? <textarea {...inputProps as any} /> : <input {...inputProps as any} />}
+          {
+            multiLine
+              ? <textarea
+                ref={this.inputRef as React.RefObject<HTMLTextAreaElement>}
+                rows={rows || 1}
+                {...inputProps}
+              />
+              : <input
+                ref={this.inputRef as React.RefObject<HTMLInputElement>}
+                {...inputProps}
+              />
+          }
           {isString(iconRight) ? <Icon material={iconRight}/> : iconRight}
           {contentRight}
         </label>
diff --git a/src/renderer/components/input/input_validators.ts b/src/renderer/components/input/input_validators.ts
index c96d63a4c5..573fe8d885 100644
--- a/src/renderer/components/input/input_validators.ts
+++ b/src/renderer/components/input/input_validators.ts
@@ -3,27 +3,26 @@ import { ReactNode } from "react";
 import fse from "fs-extra";
 
 export interface InputValidator {
-  debounce?: number; // debounce for async validators in ms
   condition?(props: InputProps): boolean; // auto-bind condition depending on input props
-  message?: ReactNode | ((value: string, props?: InputProps) => ReactNode | string);
-  validate(value: string, props?: InputProps): boolean | Promise<any>; // promise can throw error message
+  message: ReactNode | ((value: string, props?: InputProps) => ReactNode | string);
+  validate(value: string, props?: InputProps): boolean;
 }
 
 export const isRequired: InputValidator = {
   condition: ({ required }) => required,
-  message: () => `This field is required`,
+  message: "This field is required",
   validate: value => !!value.trim(),
 };
 
 export const isEmail: InputValidator = {
   condition: ({ type }) => type === "email",
-  message: () => `Wrong email format`,
+  message: "Must be an email",
   validate: value => !!value.match(/^(([^<>()\[\]\\.,;:\s@"]+(\.[^<>()\[\]\\.,;:\s@"]+)*)|(".+"))@((\[[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}])|(([a-zA-Z\-0-9]+\.)+[a-zA-Z]{2,}))$/),
 };
 
 export const isNumber: InputValidator = {
   condition: ({ type }) => type === "number",
-  message: () => `Invalid number`,
+  message: "Must be a number",
   validate: (value, { min, max }) => {
     const numVal = +value;
 
@@ -37,7 +36,7 @@ export const isNumber: InputValidator = {
 
 export const isUrl: InputValidator = {
   condition: ({ type }) => type === "url",
-  message: () => `Wrong url format`,
+  message: "Must be a valid URL",
   validate: value => {
     try {
       return Boolean(new URL(value));
@@ -51,13 +50,13 @@ export const isExtensionNameInstallRegex = /^(?<name>(@[-\w]+\/)?[-\w]+)(@(?<ver
 
 export const isExtensionNameInstall: InputValidator = {
   condition: ({ type }) => type === "text",
-  message: () => "Not an extension name with optional version",
+  message: "Not an extension name with optional version",
   validate: value => value.match(isExtensionNameInstallRegex) !== null,
 };
 
 export const isPath: InputValidator = {
   condition: ({ type }) => type === "text",
-  message: () => `This field must be a valid path`,
+  message: "This field must be a path to an existing file.",
   validate: value => value && fse.pathExistsSync(value),
 };
 
@@ -76,12 +75,17 @@ export const maxLength: InputValidator = {
 const systemNameMatcher = /^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$/;
 
 export const systemName: InputValidator = {
-  message: () => `A System Name must be lowercase DNS labels separated by dots. DNS labels are alphanumerics and dashes enclosed by alphanumerics.`,
+  message: "A System Name must be lowercase DNS labels separated by dots. DNS labels are alphanumerics and dashes enclosed by alphanumerics.",
+  validate: value => !!value.match(systemNameMatcher),
+};
+
+export const namespaceValue: InputValidator = {
+  message: "A Namespace must be lowercase DNS labels separated by dots. DNS labels are alphanumerics and dashes enclosed by alphanumerics.",
   validate: value => !!value.match(systemNameMatcher),
 };
 
 export const accountId: InputValidator = {
-  message: () => `Invalid account ID`,
+  message: "Invalid account ID",
   validate: value => (isEmail.validate(value) || systemName.validate(value))
 };