From f848f251e45ab518cde3fa2be197d5694e4dac11 Mon Sep 17 00:00:00 2001
From: Dong Zhang <dong.zhang@bmw.de>
Date: Tue, 24 Jan 2023 15:23:04 +0100
Subject: Zuul-Web: Filter input validation for "Change"

User sometimes tends to copy the value from the "Change" column as a input
for filtering, which would cause a 500 error in API.

To fix this we do a input validation to indicate that the change must be
a integer for example a PR bumber. So that make it clear any other fomat
like a ref or a string with "," is not supported.

Change-Id: Ia25a60429acc48c5773c808be6a900ba9bdf608e
---
 web/src/containers/FilterToolbar.jsx | 17 ++++++++++++++---
 web/src/pages/Builds.jsx             | 23 +++++++++++++++++++++++
 web/src/pages/Buildsets.jsx          | 23 +++++++++++++++++++++++
 3 files changed, 60 insertions(+), 3 deletions(-)

diff --git a/web/src/containers/FilterToolbar.jsx b/web/src/containers/FilterToolbar.jsx
index 328d60d85..bcf74c062 100644
--- a/web/src/containers/FilterToolbar.jsx
+++ b/web/src/containers/FilterToolbar.jsx
@@ -13,6 +13,7 @@
 // under the License.
 
 import React, { useState } from 'react'
+import { useDispatch } from 'react-redux'
 import PropTypes from 'prop-types'
 import {
   Button,
@@ -32,12 +33,14 @@ import {
 } from '@patternfly/react-core'
 import { FilterIcon, SearchIcon } from '@patternfly/react-icons'
 
+import { addNotification } from '../actions/notifications'
 import { FilterSelect } from './filters/Select'
 import { FilterTernarySelect } from './filters/TernarySelect'
 import { FilterCheckbox } from './filters/Checkbox'
 
 
 function FilterToolbar(props) {
+  const dispatch = useDispatch()
   const [isCategoryDropdownOpen, setIsCategoryDropdownOpen] = useState(false)
   const [currentCategory, setCurrentCategory] = useState(
     props.filterCategories[0].title
@@ -58,15 +61,22 @@ function FilterToolbar(props) {
   }
 
   function handleInputSend(event, category) {
-    const { onFilterChange, filters } = props
+    const { onFilterChange, filters, filterInputValidation } = props
 
     // In case the event comes from a key press, only accept "Enter"
     if (event.key && event.key !== 'Enter') {
       return
     }
 
-    // Ignore empty values
-    if (!inputValue) {
+    const validationResult = filterInputValidation(category.key, inputValue)
+    if (!validationResult.success) {
+      dispatch(addNotification(
+        {
+          text: validationResult.message,
+          type: 'error',
+          status: '',
+          url: '',
+        }))
       return
     }
 
@@ -250,6 +260,7 @@ FilterToolbar.propTypes = {
   onFilterChange: PropTypes.func.isRequired,
   filters: PropTypes.object.isRequired,
   filterCategories: PropTypes.array.isRequired,
+  filterInputValidation: PropTypes.func.isRequired,
 }
 
 function getChipsFromFilters(filters, category) {
diff --git a/web/src/pages/Builds.jsx b/web/src/pages/Builds.jsx
index b89bcd678..f1c449ec0 100644
--- a/web/src/pages/Builds.jsx
+++ b/web/src/pages/Builds.jsx
@@ -195,6 +195,28 @@ class BuildsPage extends React.Component {
       this.updateData(filters)
     }
   }
+  
+  filterInputValidation = (filterKey, filterValue) => {
+    // Input value should not be empty for all cases
+    if (!filterValue) {
+      return {
+        success: false,
+        message: 'Input should not be empty'
+      }
+    }
+
+    // For change filter, it must be an integer
+    if (filterKey === 'change' && isNaN(filterValue)) {
+      return {
+        success: false,
+        message: 'Change must be an integer (do not include revision)'
+      }
+    }
+
+    return {
+      success: true
+    }
+  }
 
   handleFilterChange = (newFilters) => {
     const { location, history } = this.props
@@ -261,6 +283,7 @@ class BuildsPage extends React.Component {
           filterCategories={this.filterCategories}
           onFilterChange={this.handleFilterChange}
           filters={filters}
+          filterInputValidation={this.filterInputValidation}
         />
         <Pagination
           toggleTemplate={({ firstIndex, lastIndex, itemCount }) => (
diff --git a/web/src/pages/Buildsets.jsx b/web/src/pages/Buildsets.jsx
index 98d86d640..938309034 100644
--- a/web/src/pages/Buildsets.jsx
+++ b/web/src/pages/Buildsets.jsx
@@ -148,6 +148,28 @@ class BuildsetsPage extends React.Component {
     }
   }
 
+  filterInputValidation = (filterKey, filterValue) => {
+    // Input value should not be empty for all cases
+    if (!filterValue) {
+      return {
+        success: false,
+        message: 'Input should not be empty'
+      }
+    }
+
+    // For change filter, it must be an integer
+    if (filterKey === 'change' && isNaN(filterValue)) {
+      return {
+        success: false,
+        message: 'Change must be an integer (do not include revision)'
+      }
+    }
+
+    return {
+      success: true
+    }
+  }
+
   handleFilterChange = (newFilters) => {
     const { location, history } = this.props
     const { filters, itemCount } = this.state
@@ -213,6 +235,7 @@ class BuildsetsPage extends React.Component {
           filterCategories={this.filterCategories}
           onFilterChange={this.handleFilterChange}
           filters={filters}
+          filterInputValidation={this.filterInputValidation}
         />
         <Pagination
           toggleTemplate={({ firstIndex, lastIndex, itemCount }) => (
-- 
cgit v1.2.1