sentry/static/app/components/forms/fields/selectField.tsx

import {Component} from 'react';
import {OptionsType, OptionTypeBase, ValueType} from 'react-select';

import {openConfirmModal} from 'sentry/components/confirm';
import SelectControl, {
  ControlProps,
} from 'sentry/components/forms/controls/selectControl';
import FormField from 'sentry/components/forms/formField';
import {t} from 'sentry/locale';
import {Choices, SelectValue} from 'sentry/types';

// XXX(epurkhiser): This is wrong, it should not be inheriting these props
import {InputFieldProps} from './inputField';

export interface SelectFieldProps<OptionType extends OptionTypeBase>
  extends InputFieldProps,
    Omit<ControlProps<OptionType>, 'onChange'> {
  /**
   * Should the select be clearable?
   */
  allowClear?: boolean;
  /**
   * Should the select allow empty values?
   */
  allowEmpty?: boolean;
  /**
   * Allow specific options to be 'confirmed' with a confirmation message.
   *
   * The key is the value that should be confirmed, the value is the message
   * to display in the confirmation modal.
   *
   * XXX: This only works when using the new-style options format, and _only_
   * if the value object has a `value` attribute in the option. The types do
   * not correctly reflect this so be careful!
   */
  confirm?: Record<string, React.ReactNode>;
  /**
   * A label that is shown inside the select control.
   */
  inFieldLabel?: string;
}

function getChoices<T extends OptionTypeBase>(props: SelectFieldProps<T>): Choices {
  const choices = props.choices;
  if (typeof choices === 'function') {
    return choices(props);
  }
  if (choices === undefined) {
    return [];
  }

  return choices;
}

/**
 * Required to type guard for OptionsType<T> which is a readonly Array
 */
function isArray<T extends OptionTypeBase>(
  maybe: T | OptionsType<T>
): maybe is OptionsType<T> {
  return Array.isArray(maybe);
}

export default class SelectField<OptionType extends SelectValue<any>> extends Component<
  SelectFieldProps<OptionType>
> {
  static defaultProps = {
    allowClear: false,
    allowEmpty: false,
    placeholder: '--',
    escapeMarkup: true,
    multiple: false,
    small: false,
    formatMessageValue: (value, props) =>
      (getChoices(props).find(choice => choice[0] === value) || [null, value])[1],
  };

  handleChange = (
    onBlur: InputFieldProps['onBlur'],
    onChange: InputFieldProps['onChange'],
    optionObj: ValueType<OptionType, boolean>
  ) => {
    let value: any = undefined;

    // If optionObj is empty, then it probably means that the field was "cleared"
    if (!optionObj) {
      value = optionObj;
    } else if (this.props.multiple && isArray(optionObj)) {
      // List of optionObjs
      value = optionObj.map(({value: val}) => val);
    } else if (!isArray(optionObj)) {
      value = optionObj.value;
    }

    onChange?.(value, {});
    onBlur?.(value, {});
  };

  render() {
    const {allowClear, confirm, multiple, ...otherProps} = this.props;
    return (
      <FormField {...otherProps}>
        {({id, onChange, onBlur, required: _required, children: _children, ...props}) => (
          <SelectControl
            {...props}
            inputId={id}
            clearable={allowClear}
            multiple={multiple}
            styles={{
              control: provided => ({
                ...provided,
                height: 'auto',
              }),
              ...props.styles,
            }}
            onChange={val => {
              try {
                if (!confirm) {
                  this.handleChange(onBlur, onChange, val);
                  return;
                }

                // Support 'confirming' selections. This only works with
                // `val` objects that use the new-style options format
                const previousValue = props.value?.toString();
                // `val` may be null if clearing the select for an optional field
                const newValue = val?.value?.toString();

                // Value not marked for confirmation, or hasn't changed
                if (!confirm[newValue] || previousValue === newValue) {
                  this.handleChange(onBlur, onChange, val);
                  return;
                }

                openConfirmModal({
                  onConfirm: () => this.handleChange(onBlur, onChange, val),
                  message: confirm[val?.value] ?? t('Continue with these changes?'),
                });
              } catch (e) {
                // Swallow expected error to prevent bubbling up.
                if (e.message === 'Invalid selection. Field cannot be empty.') {
                  return;
                }
                throw e;
              }
            }}
          />
        )}
      </FormField>
    );
  }
}