fix: Validate feature values before saving (#4043)

Flagsmith · May 30, 2024 · fef9f8f · fef9f8f
1 parent f0c3e07
commit fef9f8f
Show file tree

Hide file tree

Showing 5 changed files with 48 additions and 33 deletions.
diff --git a/frontend/web/components/ValueEditor.js b/frontend/web/components/ValueEditor.js
@@ -4,6 +4,8 @@ import Highlight from './Highlight'
 import ConfigProvider from 'common/providers/ConfigProvider'
 import { Clipboard } from 'polyfill-react-native'
 import Icon from './Icon'
+import { IonIcon } from '@ionic/react'
+import { checkmarkCircle, warning } from 'ionicons/icons'
 
 const toml = require('toml')
 const yaml = require('yaml')
@@ -91,24 +93,25 @@ class Validation extends Component {
   render() {
     const displayLanguage =
       this.props.language === 'ini' ? 'toml' : this.props.language
-    return (
+    return this.state.error ? (
       <Tooltip
         position='top'
         title={
-          !this.state.error ? (
-            <span className='language-icon ion-ios-checkmark-circle' />
-          ) : (
-            <span
-              id='language-validation-error'
-              className='language-icon ion-ios-warning'
-            />
-          )
+          <IonIcon
+            id='language-validation-error'
+            className='language-icon text-danger'
+            icon={warning}
+          />
         }
       >
-        {!this.state.error
-          ? `${displayLanguage} validation passed`
-          : `${displayLanguage} validation error, please check your value.<br/>Error: ${this.state.error}`}
+        {`${displayLanguage} validation error, please check your value.<br/>Error: ${this.state.error}`}
       </Tooltip>
+    ) : (
+      <IonIcon
+        id='language-validation-success'
+        className='language-icon text-success'
+        icon={checkmarkCircle}
+      />
     )
   }
 }
@@ -127,7 +130,11 @@ class ValueEditor extends Component {
   }
 
   renderValidation = () => (
-    <Validation language={this.state.language} value={this.props.value} />
+    <Validation
+      key={this.state.language}
+      language={this.state.language}
+      value={this.props.value}
+    />
   )
 
   render() {

diff --git a/frontend/web/components/modals/AssociatedSegmentOverrides.js b/frontend/web/components/modals/AssociatedSegmentOverrides.js
@@ -12,6 +12,7 @@ import EnvironmentSelect from 'components/EnvironmentSelect'
 import SegmentOverrideLimit from 'components/SegmentOverrideLimit'
 import { getStore } from 'common/store'
 import { getEnvironment } from 'common/services/useEnvironment'
+import { saveFeatureWithValidation } from 'components/saveFeatureWithValidation'
 
 class TheComponent extends Component {
   state = {
@@ -306,7 +307,7 @@ export default class SegmentOverridesInner extends Component {
     return (
       <FeatureListProvider>
         {({}, { editFeatureSegments, isSaving }) => {
-          const save = () => {
+          const save = saveFeatureWithValidation(() => {
             FeatureListStore.isSaving = true
             FeatureListStore.trigger('change')
             !isSaving &&
@@ -324,7 +325,7 @@ export default class SegmentOverridesInner extends Component {
                 },
               )
             this.setState({ isSaving: true })
-          }
+          })
           const segmentOverride =
             segmentOverrides && segmentOverrides.filter((v) => v.segment === id)
           if (!segmentOverrides) return null

diff --git a/frontend/web/components/modals/CreateFlag.js b/frontend/web/components/modals/CreateFlag.js
@@ -40,6 +40,7 @@ import { getSupportedContentType } from 'common/services/useSupportedContentType
 import { getGithubIntegration } from 'common/services/useGithubIntegration'
 import { removeUserOverride } from 'components/RemoveUserOverride'
 import ExternalResourcesLinkTab from 'components/ExternalResourcesLinkTab'
+import { saveFeatureWithValidation } from 'components/saveFeatureWithValidation'
 
 const CreateFlag = class extends Component {
   static displayName = 'CreateFlag'
@@ -855,7 +856,7 @@ const CreateFlag = class extends Component {
                 editFeatureValue,
               },
             ) => {
-              const saveFeatureValue = (schedule) => {
+              const saveFeatureValue = saveFeatureWithValidation((schedule) => {
                 this.setState({ valueChanged: false })
                 if ((is4Eyes || schedule) && !identity) {
                   openModal2(
@@ -926,29 +927,17 @@ const CreateFlag = class extends Component {
                       }}
                     />,
                   )
-                } else if (
-                  document.getElementById('language-validation-error')
-                ) {
-                  openConfirm({
-                    body: 'Your remote config value does not pass validation for the language you have selected. Are you sure you wish to save?',
-                    noText: 'Cancel',
-                    onYes: () => {
-                      this.save(editFeatureValue, isSaving)
-                    },
-                    title: 'Validation error',
-                    yesText: 'Save',
-                  })
                 } else {
                   this.save(editFeatureValue, isSaving)
                 }
-              }
+              })
 
               const saveSettings = () => {
                 this.setState({ settingsChanged: false })
                 this.save(editFeatureSettings, isSaving)
               }
 
-              const saveFeatureSegments = () => {
+              const saveFeatureSegments = saveFeatureWithValidation(() => {
                 this.setState({ segmentsChanged: false })
 
                 if (is4Eyes && isVersioned && !identity) {
@@ -1021,11 +1010,11 @@ const CreateFlag = class extends Component {
                 } else {
                   this.save(editFeatureSegments, isSaving)
                 }
-              }
+              })
 
-              const onCreateFeature = () => {
+              const onCreateFeature = saveFeatureWithValidation(() => {
                 this.save(createFlag, isSaving)
-              }
+              })
 
               const featureLimitAlert =
                 Utils.calculateRemainingLimitsPercentage(

diff --git a/frontend/web/components/saveFeatureWithValidation.ts b/frontend/web/components/saveFeatureWithValidation.ts
@@ -0,0 +1,15 @@
+export const saveFeatureWithValidation = (cb: () => void) => {
+  return () => {
+    if (document.getElementById('language-validation-error')) {
+      openConfirm({
+        body: 'Your remote config value does not pass validation for the language you have selected. Are you sure you wish to save?',
+        noText: 'Cancel',
+        onYes: () => cb(),
+        title: 'Validation error',
+        yesText: 'Save',
+      })
+    } else {
+      cb()
+    }
+  }
+}
diff --git a/frontend/web/styles/3rdParty/_hljs.scss b/frontend/web/styles/3rdParty/_hljs.scss
@@ -69,6 +69,9 @@
       }
     }
     span {
+      display: flex;
+      align-items: center;
+      gap: 2px;
       color: $text-icon-light-grey;
       cursor: pointer;
       font-size: $font-caption-sm;