Consolidate use of input box validation (#3049)

* use positive integer validator for set nax table head depth

* move other input validation into input box file

* update naming

Author: mattseddon

extension/src/experiments/model/filterBy/quickPick.ts

@@ -1,7 +1,6 @@
 import { FilterDefinition, getFilterId, isDateOperator, Operator } from '.'
 import { definedAndNonEmpty } from '../../../util/array'
-import { getIsoDate, isFreeTextDate } from '../../../util/date'
-import { getInput, getValidInput } from '../../../vscode/inputBox'
+import { getInput, getValidDateInput } from '../../../vscode/inputBox'
 import { quickPickManyValues, quickPickValue } from '../../../vscode/quickPick'
 import { Title } from '../../../vscode/title'
 import { Toast } from '../../../vscode/toast'
@@ -92,14 +91,7 @@ export const OPERATORS = [
 
 const getValue = (operator: Operator): Thenable<string | undefined> => {
   if (isDateOperator(operator)) {
-    return getValidInput(
-      Title.ENTER_FILTER_VALUE,
-      (text?: string): null | string =>
-        isFreeTextDate(text)
-          ? null
-          : 'please enter a valid date of the form yyyy-mm-dd',
-      { value: getIsoDate() }
-    )
+    return getValidDateInput(Title.ENTER_FILTER_VALUE)
   }
   return getInput(Title.ENTER_FILTER_VALUE)
 }

extension/src/experiments/webview/messages.ts

@@ -18,7 +18,7 @@ import { splitColumnPath } from '../columns/paths'
 import { ExperimentsModel } from '../model'
 import { SortDefinition } from '../model/sortBy'
 import { CheckpointsModel } from '../checkpoints/model'
-import { getValidInput } from '../../vscode/inputBox'
+import { getPositiveIntegerInput } from '../../vscode/inputBox'
 import { Title } from '../../vscode/title'
 import { ConfigKey, setConfigValue } from '../../vscode/config'
 
@@ -174,12 +174,10 @@ export class WebviewMessages {
   }
 
   private async setMaxTableHeadDepth() {
-    const newValue = await getValidInput(
+    const newValue = await getPositiveIntegerInput(
       Title.SET_EXPERIMENTS_HEADER_HEIGHT,
-      val => {
-        return Number.isNaN(Number(val)) ? 'Input needs to be a number' : ''
-      },
-      { prompt: 'Use 0 for infinite height.' }
+      { prompt: 'Use 0 for infinite height.', value: '0' },
+      true
     )
 
     if (!newValue) {

extension/src/vscode/inputBox.ts

@@ -1,37 +1,58 @@
 import { window } from 'vscode'
 import { Title } from './title'
 import { isValidStringInteger } from '../util/number'
+import { getIsoDate, isFreeTextDate } from '../util/date'
 
-export const getInput = (title: Title, value?: string) =>
+export const getInput = (
+  title: Title,
+  value?: string
+): Thenable<string | undefined> =>
   window.showInputBox({
     title,
     value
   })
 
-export const getValidInput = (
+const getValidInput = (
   title: Title,
   validateInput: (text?: string) => null | string,
   options?: { prompt?: string; value?: string }
-) =>
+): Thenable<string | undefined> =>
   window.showInputBox({
     prompt: options?.prompt,
     title,
     validateInput,
     value: options?.value
   })
 
+const isPositiveInteger = (
+  input: string | undefined,
+  includeZero: boolean | undefined
+): boolean => {
+  if (!isValidStringInteger(input)) {
+    return false
+  }
+
+  const number = Number(input)
+
+  if (!includeZero) {
+    return number > 0
+  }
+  return number >= 0
+}
+
 export const getPositiveIntegerInput = async (
   title: Title,
-  options: { prompt: string; value: string }
-) => {
+  options: { prompt: string; value: string },
+  includeZero?: boolean
+): Promise<string | undefined> => {
   const input = await getValidInput(
     title,
-    val => {
-      if (isValidStringInteger(val) && Number(val) > 0) {
+    input => {
+      if (isPositiveInteger(input, includeZero)) {
         return ''
       }
 
-      return 'Input needs to be a positive integer'
+      return `please enter a positive integer${includeZero ? ' or 0' : ''}`
     },
     options
   )
@@ -41,3 +62,13 @@ export const getPositiveIntegerInput = async (
   }
   return Number.parseInt(input).toString()
 }
+
+export const getValidDateInput = (title: Title): Thenable<string | undefined> =>
+  getValidInput(
+    title,
+    (text?: string): null | string =>
+      isFreeTextDate(text)
+        ? null
+        : 'please enter a valid date of the form yyyy-mm-dd',
+    { value: getIsoDate() }
+  )