fix: Metadata UI improvements (#4327)

Flagsmith · Jul 30, 2024 · d4006c0 · d4006c0
1 parent 8e2db7c
commit d4006c0
Show file tree

Hide file tree

Showing 11 changed files with 127 additions and 93 deletions.
diff --git a/frontend/common/stores/feature-list-store.ts b/frontend/common/stores/feature-list-store.ts
@@ -161,6 +161,10 @@ const controller = {
     })
       .then((res) => {
         // onComplete calls back preserving the order of multivariate_options with their updated ids
+        if (res.error) {
+          store.saved({ error: res.error })
+          return
+        }
         if (onComplete) {
           onComplete(res)
         }

diff --git a/frontend/common/stores/project-store.js b/frontend/common/stores/project-store.js
@@ -84,15 +84,30 @@ const controller = {
 
   editEnv: (env) => {
     API.trackEvent(Constants.events.EDIT_ENVIRONMENT)
-    data.put(`${Project.api}environments/${env.api_key}/`, env).then((res) => {
-      const index = _.findIndex(store.model.environments, { id: env.id })
-      store.model.environments[index] = res
-      store.saved()
-      getStore().dispatch(
-        environmentService.util.invalidateTags(['Environment']),
-      )
-      AppActions.refreshOrganisation()
-    })
+    data
+      .put(`${Project.api}environments/${env.api_key}/`, env)
+      .then((res) => {
+        const index = _.findIndex(store.model.environments, { id: env.id })
+        store.model.environments[index] = res
+        store.saved()
+        getStore().dispatch(
+          environmentService.util.invalidateTags(['Environment']),
+        )
+        AppActions.refreshOrganisation()
+      })
+      .catch((e) => {
+        e.json()
+          .then((result) => {
+            if (result?.metadata?.[0]) {
+              toast(result.metadata[0], 'danger')
+            } else {
+              toast('Error updating the environment', 'danger')
+            }
+          })
+          .catch((e) => {
+            API.ajaxHandler(store, e)
+          })
+      })
   },
   editProject: (project) => {
     store.saving()

diff --git a/frontend/common/utils/utils.tsx b/frontend/common/utils/utils.tsx
@@ -383,6 +383,10 @@ const Utils = Object.assign({}, require('./base/_utils'), {
         valid = isEnterprise
         break
       }
+      case 'METADATA': {
+        valid = isEnterprise
+        break
+      }
       default:
         valid = true
         break
@@ -536,16 +540,8 @@ const Utils = Object.assign({}, require('./base/_utils'), {
     return /^-?\d*\.?\d+$/.test(`${value}`)
   },
   isValidURL(value: any) {
-    const pattern = new RegExp(
-      '^(https?:\\/\\/)?' + // protocol
-        '((([a-z\\d]([a-z\\d-]*[a-z\\d])*)\\.)+[a-z]{2,}|' + // domain name
-        '((\\d{1,3}\\.){3}\\d{1,3}))' + // OR ip (v4) address
-        '(\\:\\d+)?(\\/[-a-z\\d%_.~+]*)*' + // port and path
-        '(\\?[;&a-z\\d%_.~+=-]*)?' + // query string
-        '(\\#[-a-z\\d_]*)?$',
-      'i',
-    )
-    return !!pattern.test(value)
+    const regex = /^(https?|ftp):\/\/[^\s/$.?#].[^\s]*$/i
+    return regex.test(value)
   },
   loadScriptPromise(url: string) {
     return new Promise((resolve) => {

diff --git a/frontend/web/components/base/forms/InputGroup.js b/frontend/web/components/base/forms/InputGroup.js
@@ -22,9 +22,9 @@ const InputGroup = class extends Component {
     const { inputProps, size } = this.props
     return (
       <div
-        className={`${
-          this.props.className ? this.props.className : ''
-        } form-group ${this.props.isInvalid ? 'invalid' : ''}`}
+        className={`${this.props.className ? this.props.className : ''} ${
+          this.props.noMargin ? '' : 'form-group'
+        }  ${this.props.isInvalid ? 'invalid' : ''}`}
       >
         {this.props.tooltip ? (
           <Tooltip
@@ -83,6 +83,7 @@ const InputGroup = class extends Component {
                   type={props.type || 'text'}
                   id={id}
                   placeholder={props.placeholder}
+                  onBlur={props.onBlur}
                 />
               ) : (
                 <Input
@@ -96,6 +97,7 @@ const InputGroup = class extends Component {
                   onChange={props.onChange}
                   type={props.type || 'text'}
                   id={id}
+                  onBlur={props.onBlur}
                   placeholder={props.placeholder}
                   size={size}
                 />

diff --git a/frontend/web/components/metadata/AddMetadataToEntity.tsx b/frontend/web/components/metadata/AddMetadataToEntity.tsx
@@ -9,12 +9,11 @@ import {
   useUpdateEnvironmentMutation,
 } from 'common/services/useEnvironment'
 import { MetadataField, Metadata } from 'common/types/responses'
-import Input from 'components/base/forms/Input'
 import Utils from 'common/utils/utils'
 import { useGetProjectFlagQuery } from 'common/services/useProjectFlag'
-import Tooltip from 'components/Tooltip'
 import { sortBy } from 'lodash'
 import Switch from 'components/Switch'
+import InputGroup from 'components/base/forms/InputGroup'
 
 export type CustomMetadataField = MetadataField & {
   metadataModelFieldId: number | string | null
@@ -247,8 +246,8 @@ const AddMetadataToEntity: FC<AddMetadataToEntityType> = ({
           }}
           renderNoResults={
             <FormGroup>
-              No custom fields configured for {entity} entity. Add custom fields in
-              your{' '}
+              No custom fields configured for {entity} entity. Add custom fields
+              in your{' '}
               <a
                 href={`/project/${projectId}/settings?tab=metadata`}
                 target='_blank'
@@ -334,32 +333,7 @@ const MetadataRow: FC<MetadataRowType> = ({
       <Flex className='table-column'>{`${metadata?.name} ${
         metadata?.isRequiredFor ? '*' : ''
       }`}</Flex>
-      {metadata?.type !== 'bool' ? (
-        <Flex className='flex-row' style={{ minWidth: '300px' }}>
-          <Tooltip
-            title={
-              <Input
-                value={metadataValue}
-                onBlur={saveMetadata}
-                onChange={(e: InputEvent) => {
-                  setMetadataValue(Utils.safeParseEventValue(e))
-                  setMetadataValueChanged(true)
-                }}
-                className='mr-2'
-                style={{ width: '250px' }}
-                placeholder='Field Value'
-                isValid={Utils.validateMetadataType(
-                  metadata?.type,
-                  metadataValue,
-                )}
-              />
-            }
-            place='top'
-          >
-            {`This value has to be of type ${metadata?.type}`}
-          </Tooltip>
-        </Flex>
-      ) : (
+      {metadata?.type === 'bool' ? (
         <Flex className='flex-row'>
           <Switch
             checked={!!metadataValue}
@@ -370,6 +344,27 @@ const MetadataRow: FC<MetadataRowType> = ({
             }}
           />
         </Flex>
+      ) : (
+        <Flex className='flex-row mt-1' style={{ minWidth: '300px' }}>
+          <InputGroup
+            textarea={metadata?.type === 'multiline_str'}
+            onBlur={saveMetadata}
+            value={metadataValue}
+            inputProps={{
+              style: {
+                height: metadata?.type === 'multiline_str' ? '65px' : '44px',
+                width: '250px',
+              },
+            }}
+            noMargin
+            isValid={Utils.validateMetadataType(metadata?.type, metadataValue)}
+            onChange={(e: InputEvent) => {
+              setMetadataValue(Utils.safeParseEventValue(e))
+              setMetadataValueChanged(true)
+            }}
+            type='text'
+          />
+        </Flex>
       )}
     </Row>
   )

diff --git a/frontend/web/components/modals/CreateFlag.js b/frontend/web/components/modals/CreateFlag.js
@@ -40,7 +40,6 @@ import { getSupportedContentType } from 'common/services/useSupportedContentType
 import { getGithubIntegration } from 'common/services/useGithubIntegration'
 import { removeUserOverride } from 'components/RemoveUserOverride'
 import ExternalResourcesLinkTab from 'components/ExternalResourcesLinkTab'
-import MetadataTitle from 'components/metadata/MetadataTitle'
 import { saveFeatureWithValidation } from 'components/saveFeatureWithValidation'
 
 const CreateFlag = class extends Component {
@@ -182,7 +181,10 @@ const CreateFlag = class extends Component {
     ) {
       this.getFeatureUsage()
     }
-    if (Utils.getFlagsmithHasFeature('enable_metadata')) {
+    if (
+      Utils.getPlansPermission('METADATA') &&
+      Utils.getFlagsmithHasFeature('enable_metadata')
+    ) {
       getSupportedContentType(getStore(), {
         organisation_id: AccountStore.getOrganisation().id,
       }).then((res) => {
@@ -550,7 +552,9 @@ const CreateFlag = class extends Component {
     const hideIdentityOverridesTab = Utils.getShouldHideIdentityOverridesTab()
     const noPermissions = this.props.noPermissions
     let regexValid = true
-    const metadataEnable = Utils.getFlagsmithHasFeature('enable_metadata')
+    const metadataEnable =
+      Utils.getPlansPermission('METADATA') &&
+      Utils.getFlagsmithHasFeature('enable_metadata')
     try {
       if (!isEdit && name && regex) {
         regexValid = name.match(new RegExp(regex))
@@ -580,32 +584,24 @@ const CreateFlag = class extends Component {
         )}
         {metadataEnable && featureContentType?.id && (
           <>
-            <MetadataTitle
-              visible={this.state.visible}
-              onVisibleChange={(v) => {
-                this.setState({ visible: v })
+            <label className='mt-1'>Custom Fields</label>
+            <AddMetadataToEntity
+              organisationId={AccountStore.getOrganisation().id}
+              projectId={this.props.projectId}
+              entityId={projectFlag?.id}
+              entityContentType={featureContentType?.id}
+              entity={featureContentType?.model}
+              setHasMetadataRequired={(b) => {
+                this.setState({
+                  hasMetadataRequired: b,
+                })
+              }}
+              onChange={(m) => {
+                this.setState({
+                  metadata: m,
+                })
               }}
-              hasRequiredMetadata={this.state.hasMetadataRequired}
             />
-            {(this.state.hasMetadataRequired || this.state.visible) && (
-              <AddMetadataToEntity
-                organisationId={AccountStore.getOrganisation().id}
-                projectId={this.props.projectId}
-                entityId={projectFlag?.id}
-                entityContentType={featureContentType?.id}
-                entity={featureContentType?.model}
-                setHasMetadataRequired={(b) => {
-                  this.setState({
-                    hasMetadataRequired: b,
-                  })
-                }}
-                onChange={(m) => {
-                  this.setState({
-                    metadata: m,
-                  })
-                }}
-              />
-            )}
           </>
         )}
         {!identity && projectFlag && (
@@ -1971,12 +1967,23 @@ const FeatureProvider = (WrappedComponent) => {
       this.listenTo(
         FeatureListStore,
         'saved',
-        ({ changeRequest, createdFlag, isCreate } = {}) => {
-          toast(
-            `${createdFlag || isCreate ? 'Created' : 'Updated'} ${
-              changeRequest ? 'Change Request' : 'Feature'
-            }`,
-          )
+        ({ changeRequest, createdFlag, error, isCreate } = {}) => {
+          if (error?.data?.metadata) {
+            error.data.metadata?.forEach((m) => {
+              if (Object.keys(m).length > 0) {
+                toast(m.non_field_errors[0], 'danger')
+              }
+            })
+          } else if (error?.data) {
+            toast('Error updating the Flag', 'danger')
+            return
+          } else {
+            toast(
+              `${createdFlag || isCreate ? 'Created' : 'Updated'} ${
+                changeRequest ? 'Change Request' : 'Feature'
+              }`,
+            )
+          }
           const envFlags = FeatureListStore.getEnvironmentFlags()
 
           if (createdFlag) {

diff --git a/frontend/web/components/modals/CreateSegment.tsx b/frontend/web/components/modals/CreateSegment.tsx
@@ -154,7 +154,9 @@ const CreateSegment: FC<CreateSegmentType> = ({
   const [metadata, setMetadata] = useState<CustomMetadataField[]>(
     segment.metadata,
   )
-  const metadataEnable = Utils.getFlagsmithHasFeature('enable_metadata')
+  const metadataEnable =
+    Utils.getPlansPermission('METADATA') &&
+    Utils.getFlagsmithHasFeature('enable_metadata')
 
   const error = createError || updateError
   const totalSegments = ProjectStore.getTotalSegments() ?? 0
@@ -763,7 +765,9 @@ const CreateSegment: FC<CreateSegmentType> = ({
           </TabItem>
           <TabItem
             tabLabelString='Custom Fields'
-            tabLabel={<Row className='justify-content-center'>Custom Fields</Row>}
+            tabLabel={
+              <Row className='justify-content-center'>Custom Fields</Row>
+            }
           >
             <div className={className || 'my-3 mx-4'}>{MetadataTab}</div>
           </TabItem>

diff --git a/frontend/web/components/pages/CreateEnvironmentPage.js b/frontend/web/components/pages/CreateEnvironmentPage.js
@@ -33,7 +33,10 @@ const CreateEnvironmentPage = class extends Component {
   componentDidMount = () => {
     API.trackPage(Constants.pages.CREATE_ENVIRONMENT)
 
-    if (Utils.getFlagsmithHasFeature('enable_metadata')) {
+    if (
+      Utils.getPlansPermission('METADATA') &&
+      Utils.getFlagsmithHasFeature('enable_metadata')
+    ) {
       getSupportedContentType(getStore(), {
         organisation_id: AccountStore.getOrganisation().id,
       }).then((res) => {
@@ -196,7 +199,8 @@ const CreateEnvironmentPage = class extends Component {
                                 </CondensedRow>
                               )}
                             </div>
-                            {Utils.getFlagsmithHasFeature('enable_metadata') &&
+                            {Utils.getPlansPermission('METADATA') &&
+                              Utils.getFlagsmithHasFeature('enable_metadata') &&
                               envContentType?.id && (
                                 <CondensedRow>
                                   <FormGroup className='mt-5 setting'>

diff --git a/frontend/web/components/pages/EnvironmentSettingsPage.js b/frontend/web/components/pages/EnvironmentSettingsPage.js
@@ -82,7 +82,10 @@ const EnvironmentSettingsPage = class extends Component {
       })
     })
 
-    if (Utils.getFlagsmithHasFeature('enable_metadata')) {
+    if (
+      Utils.getPlansPermission('METADATA') &&
+      Utils.getFlagsmithHasFeature('enable_metadata')
+    ) {
       getSupportedContentType(getStore(), {
         organisation_id: AccountStore.getOrganisation().id,
       }).then((res) => {
@@ -260,7 +263,9 @@ const EnvironmentSettingsPage = class extends Component {
       },
     } = this
     const has4EyesPermission = Utils.getPlansPermission('4_EYES')
-    const metadataEnable = Utils.getFlagsmithHasFeature('enable_metadata')
+    const metadataEnable =
+      Utils.getPlansPermission('METADATA') &&
+      Utils.getFlagsmithHasFeature('enable_metadata')
 
     return (
       <div className='app-container container'>

diff --git a/frontend/web/components/pages/ProjectSettingsPage.js b/frontend/web/components/pages/ProjectSettingsPage.js
@@ -167,7 +167,9 @@ const ProjectSettingsPage = class extends Component {
     const { name, stale_flags_limit_days } = this.state
     const hasStaleFlagsPermission = Utils.getPlansPermission('STALE_FLAGS')
 
-    const metadataEnable = Utils.getFlagsmithHasFeature('enable_metadata')
+    const metadataEnable =
+      Utils.getPlansPermission('METADATA') &&
+      Utils.getFlagsmithHasFeature('enable_metadata')
 
     return (
       <div className='app-container container'>

diff --git a/frontend/web/components/pages/SegmentsPage.tsx b/frontend/web/components/pages/SegmentsPage.tsx
@@ -24,7 +24,7 @@ import PageTitle from 'components/PageTitle'
 import Switch from 'components/Switch'
 import { setModalTitle } from 'components/modals/base/ModalDefault'
 import classNames from 'classnames'
-import InfoMessage from 'components/InfoMessage';
+import InfoMessage from 'components/InfoMessage'
 
 const CodeHelp = require('../../components/CodeHelp')
 type SegmentsPageType = {