#RI-5004 - add geoshape resisearch option (#2705)

AmirAllayarovSofteq · web-flow · commit 2fc7ad6d818d · 2023-10-23T14:08:40.000+04:00
* #RI-5004 - add geoshape resisearch option
diff --git a/redisinsight/api/src/modules/browser/dto/redisearch.ts b/redisinsight/api/src/modules/browser/dto/redisearch.ts
@@ -16,6 +16,7 @@ export enum RedisearchIndexDataType {
   TAG = 'tag',
   NUMERIC = 'numeric',
   GEO = 'geo',
+  GEOSHAPE = 'geoshape',
   VECTOR = 'vector',
 }
 
diff --git a/redisinsight/ui/src/constants/index.ts b/redisinsight/ui/src/constants/index.ts
@@ -30,4 +30,5 @@ export * from './featureFlags'
 export * from './serverVersions'
 export * from './customErrorCodes'
 export * from './securityField'
+export * from './redisearch'
 export { ApiEndpoints, BrowserStorageItem, ApiStatusCode, apiErrors }
diff --git a/redisinsight/ui/src/constants/redisearch.ts b/redisinsight/ui/src/constants/redisearch.ts
@@ -0,0 +1,3 @@
+export const REDISEARCH_GEOSHAPE_SEMANTIC_VERSION = '2.8.4'
+
+export const REDISEARCH_GEOSHAPE_VERSION = 20804
diff --git a/redisinsight/ui/src/pages/browser/components/create-redisearch-index/CreateRedisearchIndex.tsx b/redisinsight/ui/src/pages/browser/components/create-redisearch-index/CreateRedisearchIndex.tsx
@@ -14,6 +14,7 @@ import {
   EuiLink,
   EuiPopover,
   EuiButtonIcon,
+  EuiSuperSelectOption,
 } from '@elastic/eui'
 import { EuiComboBoxOptionOption } from '@elastic/eui/src/components/combo_box/types'
 import cx from 'classnames'
@@ -27,9 +28,10 @@ import { stringToBuffer } from 'uiSrc/utils'
 import { sendEventTelemetry, TelemetryEvent } from 'uiSrc/telemetry'
 import { keysSelector } from 'uiSrc/slices/browser/keys'
 import { connectedInstanceSelector } from 'uiSrc/slices/instances/instances'
+import { getFieldTypeOptions } from 'uiSrc/utils/redisearch'
 import { CreateRedisearchIndexDto } from 'apiSrc/modules/browser/dto/redisearch'
 
-import { FIELD_TYPE_OPTIONS, KEY_TYPE_OPTIONS, RedisearchIndexKeyType } from './constants'
+import { KEY_TYPE_OPTIONS, RedisearchIndexKeyType } from './constants'
 
 import styles from './styles.module.scss'
 
@@ -50,22 +52,19 @@ const keyTypeOptions = KEY_TYPE_OPTIONS.map((item) => {
   }
 })
 
-const fieldTypeOptions = FIELD_TYPE_OPTIONS.map(({ value, text }) => ({
-  value,
-  inputDisplay: text,
-}))
-
-const initialFieldValue = (id = 0) => ({ id, identifier: '', fieldType: fieldTypeOptions[0].value })
+const initialFieldValue = (fieldTypeOptions: EuiSuperSelectOption<string>[], id = 0) => ({ id, identifier: '', fieldType: fieldTypeOptions[0].value })
 
 const CreateRedisearchIndex = ({ onClosePanel, onCreateIndex }: Props) => {
   const { viewType } = useSelector(keysSelector)
   const { loading } = useSelector(createIndexStateSelector)
-  const { id: instanceId } = useSelector(connectedInstanceSelector)
+  const { id: instanceId, modules } = useSelector(connectedInstanceSelector)
 
   const [keyTypeSelected, setKeyTypeSelected] = useState<RedisearchIndexKeyType>(keyTypeOptions[0].value)
   const [prefixes, setPrefixes] = useState<EuiComboBoxOptionOption[]>([])
   const [indexName, setIndexName] = useState<string>('')
-  const [fields, setFields] = useState<any[]>([initialFieldValue()])
+  const [fieldTypeOptions, setFieldTypeOptions] = useState<EuiSuperSelectOption<string>[]>(getFieldTypeOptions(modules))
+  const [fields, setFields] = useState<any[]>([initialFieldValue(fieldTypeOptions)])
+
   const [isInfoPopoverOpen, setIsInfoPopoverOpen] = useState<boolean>(false)
 
   const lastAddedIdentifier = useRef<HTMLInputElement>(null)
@@ -80,17 +79,21 @@ const CreateRedisearchIndex = ({ onClosePanel, onCreateIndex }: Props) => {
     prevCountFields.current = fields.length
   }, [fields.length])
 
+  useEffect(() => {
+    setFieldTypeOptions(getFieldTypeOptions(modules))
+  }, [modules])
+
   const addField = () => {
     const lastFieldId = fields[fields.length - 1].id
-    setFields([...fields, initialFieldValue(lastFieldId + 1)])
+    setFields([...fields, initialFieldValue(fieldTypeOptions, lastFieldId + 1)])
   }
 
   const removeField = (id: number) => {
     setFields((fields) => fields.filter((item) => item.id !== id))
   }
 
   const clearFieldsValues = (id: number) => {
-    setFields((fields) => fields.map((item) => (item.id === id ? initialFieldValue(id) : item)))
+    setFields((fields) => fields.map((item) => (item.id === id ? initialFieldValue(fieldTypeOptions, id) : item)))
   }
 
   const handleFieldChange = (formField: string, id: number, value: string) => {
diff --git a/redisinsight/ui/src/pages/browser/components/create-redisearch-index/CreateRedisearchIndexWrapper.spec.tsx b/redisinsight/ui/src/pages/browser/components/create-redisearch-index/CreateRedisearchIndexWrapper.spec.tsx
@@ -1,10 +1,19 @@
 import { cloneDeep } from 'lodash'
 import React from 'react'
 import { createIndex } from 'uiSrc/slices/browser/redisearch'
+import { connectedInstanceSelector } from 'uiSrc/slices/instances/instances'
 import { render, screen, fireEvent, cleanup, mockedStore } from 'uiSrc/utils/test-utils'
 
 import CreateRedisearchIndexWrapper from './CreateRedisearchIndexWrapper'
 
+jest.mock('uiSrc/slices/instances/instances', () => ({
+  ...jest.requireActual('uiSrc/slices/instances/instances'),
+  connectedInstanceSelector: jest.fn().mockReturnValue({
+    id: '1',
+    modules: [],
+  }),
+}))
+
 const onClose = jest.fn()
 
 let store: typeof mockedStore
@@ -106,4 +115,25 @@ describe('CreateRedisearchIndexWrapper', () => {
 
     expect(screen.getByTestId('identifier-info-icon')).toBeInTheDocument()
   })
+
+  it('should not have geoshape option ', () => {
+    const { queryByText } = render(<CreateRedisearchIndexWrapper onClosePanel={onClose} />)
+
+    fireEvent.click(screen.getByTestId('field-type-0'))
+
+    expect(queryByText('GEOSHAPE')).not.toBeInTheDocument()
+  })
+
+  it('should have geoshape option ', () => {
+    const connectedInstanceSelectorMock = jest.fn().mockReturnValueOnce({
+      id: '1',
+      modules: [{ name: 'search', semanticVersion: '2.8.4' }]
+    })
+    connectedInstanceSelector.mockImplementation(connectedInstanceSelectorMock)
+
+    const { queryByText } = render(<CreateRedisearchIndexWrapper onClosePanel={onClose} />)
+    fireEvent.click(screen.getByTestId('field-type-0'))
+
+    expect(queryByText('GEOSHAPE')).toBeInTheDocument()
+  })
 })
diff --git a/redisinsight/ui/src/pages/browser/components/create-redisearch-index/constants.ts b/redisinsight/ui/src/pages/browser/components/create-redisearch-index/constants.ts
@@ -6,6 +6,7 @@ export enum FieldTypes {
   NUMERIC = 'numeric',
   GEO = 'geo',
   VECTOR = 'vector',
+  GEOSHAPE = 'geoshape',
 }
 
 export enum RedisearchIndexKeyType {
@@ -43,6 +44,10 @@ export const FIELD_TYPE_OPTIONS = [
     text: 'GEO',
     value: FieldTypes.GEO,
   },
+  {
+    text: 'GEOSHAPE',
+    value: FieldTypes.GEOSHAPE,
+  },
   {
     text: 'VECTOR',
     value: FieldTypes.VECTOR,
diff --git a/redisinsight/ui/src/utils/index.ts b/redisinsight/ui/src/utils/index.ts
@@ -27,6 +27,7 @@ export * from './modules'
 export * from './events'
 export * from './telemetry'
 export * from './oauth'
+export * from './redisearch'
 
 export {
   Maybe,
diff --git a/redisinsight/ui/src/utils/redisearch.ts b/redisinsight/ui/src/utils/redisearch.ts
@@ -0,0 +1,24 @@
+import { REDISEARCH_MODULES } from 'uiSrc/slices/interfaces'
+import { isVersionHigherOrEquals } from 'uiSrc/utils'
+import {
+  REDISEARCH_GEOSHAPE_SEMANTIC_VERSION,
+  REDISEARCH_GEOSHAPE_VERSION,
+} from 'uiSrc/constants'
+import { FIELD_TYPE_OPTIONS, FieldTypes } from 'uiSrc/pages/browser/components/create-redisearch-index/constants'
+import { AdditionalRedisModule } from 'apiSrc/modules/database/models/additional.redis.module'
+
+const isGeoshapeOptionAvailable = (modules: AdditionalRedisModule[]): boolean =>
+  modules?.some(({ name, semanticVersion, version }) =>
+    REDISEARCH_MODULES
+      .some((search) => (
+        name === search && (
+          isVersionHigherOrEquals(semanticVersion, REDISEARCH_GEOSHAPE_SEMANTIC_VERSION)
+          || (version && version >= REDISEARCH_GEOSHAPE_VERSION)
+        ))))
+
+export const getFieldTypeOptions = (modules: AdditionalRedisModule[] = []) => FIELD_TYPE_OPTIONS
+  .filter((option) => option.value !== FieldTypes.GEOSHAPE || isGeoshapeOptionAvailable(modules))
+  .map(({ value, text }) => ({
+    value,
+    inputDisplay: text,
+  }))
diff --git a/redisinsight/ui/src/utils/tests/modules.spec.ts b/redisinsight/ui/src/utils/tests/modules.spec.ts
@@ -71,7 +71,7 @@ const getOutputForReJSONAvailable: any[] = [
   [['1', 'json', RedisDefaultModules.SearchLight, RedisDefaultModules.ReJSON].map(nameToModule), true],
 ]
 
-describe('isRedisearchAvailable', () => {
+describe('isContainJSONModule', () => {
   it.each(getOutputForReJSONAvailable)('for input: %s (reply), should be output: %s',
     (reply, expected) => {
       const result = isContainJSONModule(reply)
diff --git a/redisinsight/ui/src/utils/tests/redisearch.spec.ts b/redisinsight/ui/src/utils/tests/redisearch.spec.ts
@@ -0,0 +1,49 @@
+import { getFieldTypeOptions } from 'uiSrc/utils'
+import { RedisDefaultModules } from 'uiSrc/slices/interfaces'
+import { FIELD_TYPE_OPTIONS, FieldTypes } from
+  'uiSrc/pages/browser/components/create-redisearch-index/constants'
+
+const nameAndVersionToModule = ([name, semanticVersion, version]: any[]) => (
+  { name, semanticVersion, version }
+)
+
+const ALL_OPTIONS = FIELD_TYPE_OPTIONS.map(({ value, text }) => ({
+  value,
+  inputDisplay: text,
+}))
+
+const WITHOUT_GEOSHAPE_OPTIONS = ALL_OPTIONS.filter(({ value }) => value !== FieldTypes.GEOSHAPE)
+
+const getFieldTypeOptionsTests: any[] = [
+  [[['1', '2.8.4'], [RedisDefaultModules.Search, '2.8.4']].map(nameAndVersionToModule), ALL_OPTIONS],
+  [[['1', '2.8.4'], [RedisDefaultModules.Search, '2.8.3']].map(nameAndVersionToModule), WITHOUT_GEOSHAPE_OPTIONS],
+  [[['1', '2.8.3'], [RedisDefaultModules.SearchLight, '2.8.4']].map(nameAndVersionToModule), ALL_OPTIONS],
+  [[['1', '2.8.4'], [RedisDefaultModules.SearchLight, '2.8.3']].map(nameAndVersionToModule), WITHOUT_GEOSHAPE_OPTIONS],
+  [[['1', '2.8.3'], [RedisDefaultModules.FT, '2.8.4']].map(nameAndVersionToModule), ALL_OPTIONS],
+  [[['1', '2.8.4'], [RedisDefaultModules.FT, '2.8.3']].map(nameAndVersionToModule), WITHOUT_GEOSHAPE_OPTIONS],
+  [[['1', '2.8.3'], [RedisDefaultModules.FTL, '2.8.4']].map(nameAndVersionToModule), ALL_OPTIONS],
+  [[['1', '2.8.4'], [RedisDefaultModules.FTL, '2.8.3']].map(nameAndVersionToModule), WITHOUT_GEOSHAPE_OPTIONS],
+  [[['1', '2.8.4'], [RedisDefaultModules.Gears, '2.8.4']].map(nameAndVersionToModule), WITHOUT_GEOSHAPE_OPTIONS],
+  [[['1', '2.8.4'], [RedisDefaultModules.Search, undefined, 20804]].map(nameAndVersionToModule), ALL_OPTIONS],
+  [[['1', '2.8.4'], [RedisDefaultModules.Search, undefined, 20803]].map(nameAndVersionToModule), WITHOUT_GEOSHAPE_OPTIONS],
+  [[['1', '2.8.4'], [RedisDefaultModules.SearchLight, undefined, 20804]].map(nameAndVersionToModule), ALL_OPTIONS],
+  [[['1', '2.8.4'], [RedisDefaultModules.SearchLight, undefined, 20803]].map(nameAndVersionToModule), WITHOUT_GEOSHAPE_OPTIONS],
+  [[['1', '2.8.4'], [RedisDefaultModules.SearchLight, undefined, 20804]].map(nameAndVersionToModule), ALL_OPTIONS],
+  [[['1', '2.8.4'], [RedisDefaultModules.SearchLight, undefined, 20803]].map(nameAndVersionToModule), WITHOUT_GEOSHAPE_OPTIONS],
+  [[['1', '2.8.4'], [RedisDefaultModules.FT, undefined, 20804]].map(nameAndVersionToModule), ALL_OPTIONS],
+  [[['1', '2.8.4'], [RedisDefaultModules.FT, undefined, 20803]].map(nameAndVersionToModule), WITHOUT_GEOSHAPE_OPTIONS],
+  [[['1', '2.8.4'], [RedisDefaultModules.FTL, undefined, 20804]].map(nameAndVersionToModule), ALL_OPTIONS],
+  [[['1', '2.8.4'], [RedisDefaultModules.FTL, undefined, 20803]].map(nameAndVersionToModule), WITHOUT_GEOSHAPE_OPTIONS],
+  [[['1', '2.8.4'], [RedisDefaultModules.Gears, undefined, 20804]].map(nameAndVersionToModule), WITHOUT_GEOSHAPE_OPTIONS],
+  [[['1', '2.8.4'], [RedisDefaultModules.Gears, undefined, 20803]].map(nameAndVersionToModule), WITHOUT_GEOSHAPE_OPTIONS],
+  [[['1', '2.8.4'], [RedisDefaultModules.FTL, '2.8.3', 20803]].map(nameAndVersionToModule), WITHOUT_GEOSHAPE_OPTIONS],
+  [[['1', '2.8.4'], [RedisDefaultModules.FTL, '2.8.4', 20804]].map(nameAndVersionToModule), ALL_OPTIONS],
+]
+
+describe('getFieldTypeOptions', () => {
+  it.each(getFieldTypeOptionsTests)('for input: %s (type), should be output: %s',
+    (type, expected) => {
+      const result = getFieldTypeOptions(type)
+      expect(result).toEqual(expected)
+    })
+})

Original file line number	Diff line number	Diff line change
`@@ -16,6 +16,7 @@ export enum RedisearchIndexDataType {`
`16`	`16`	`TAG = 'tag',`
`17`	`17`	`NUMERIC = 'numeric',`
`18`	`18`	`GEO = 'geo',`
	`19`	`+ GEOSHAPE = 'geoshape',`
`19`	`20`	`VECTOR = 'vector',`
`20`	`21`	`}`
`21`	`22`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+export const REDISEARCH_GEOSHAPE_SEMANTIC_VERSION = '2.8.4'`
	`2`	`+`
	`3`	`+export const REDISEARCH_GEOSHAPE_VERSION = 20804`
Original file line number	Diff line number	Diff line change
`@@ -71,7 +71,7 @@ const getOutputForReJSONAvailable: any[] = [`
`71`	`71`	`[['1', 'json', RedisDefaultModules.SearchLight, RedisDefaultModules.ReJSON].map(nameToModule), true],`
`72`	`72`	`]`
`73`	`73`
`74`		`-describe('isRedisearchAvailable', () => {`
	`74`	`+describe('isContainJSONModule', () => {`
`75`	`75`	`it.each(getOutputForReJSONAvailable)('for input: %s (reply), should be output: %s',`
`76`	`76`	`(reply, expected) => {`
`77`	`77`	`const result = isContainJSONModule(reply)`