Skip to content

Commit f567ab4

Browse files
AmirAllayarovSofteqAmirAllayarovSofteq
committed
#RI-2450- replace guide with item in Workbench context
1 parent e3aa9e4 commit f567ab4

File tree

6 files changed

+49
-49
lines changed

6 files changed

+49
-49
lines changed

‎redisinsight/ui/src/constants/api.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ enum ApiEndpoints {
5151
PLUGINS = 'plugins',
5252
STATE = 'state',
5353
CONTENT_CREATE_DATABASE = 'static/content/create-redis.json',
54-
ENABLEMENT_AREA_PATH = 'static/workbench/guides',
54+
ENABLEMENT_AREA_PATH = 'static/workbench',
5555
}
5656

5757
export const DEFAULT_SEARCH_MATCH = '*'

‎redisinsight/ui/src/pages/workbench/components/enablement-area/EnablementArea/EnablementArea.tsx‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ import cx from 'classnames'
55
import { EuiListGroup, EuiLoadingContent } from '@elastic/eui'
66
import { EnablementAreaComponent, IEnablementAreaItem } from 'uiSrc/slices/interfaces'
77
import { EnablementAreaProvider, IInternalPage } from 'uiSrc/pages/workbench/contexts/enablementAreaContext'
8-
import { appContextWorkbenchEA, resetWorkbenchEAGuide } from 'uiSrc/slices/app/context'
8+
import { appContextWorkbenchEA, resetWorkbenchEAItem } from 'uiSrc/slices/app/context'
99
import { ApiEndpoints } from 'uiSrc/constants'
1010
import {
1111
CodeButton,
@@ -32,7 +32,7 @@ const EnablementArea = ({ items, openScript, loading, onOpenInternalPage, isCode
3232
const { search } = useLocation()
3333
const history = useHistory()
3434
const dispatch = useDispatch()
35-
const { guidePath: guideFromContext } = useSelector(appContextWorkbenchEA)
35+
const { itemPath: itemFromContext } = useSelector(appContextWorkbenchEA)
3636
const [isInternalPageVisible, setIsInternalPageVisible] = useState(false)
3737
const [internalPage, setInternalPage] = useState<IInternalPage>({ path: '' })
3838

@@ -44,8 +44,8 @@ const EnablementArea = ({ items, openScript, loading, onOpenInternalPage, isCode
4444

4545
return
4646
}
47-
if (guideFromContext) {
48-
handleOpenInternalPage({ path: `${ApiEndpoints.ENABLEMENT_AREA_PATH}/${guideFromContext}` })
47+
if (itemFromContext) {
48+
handleOpenInternalPage({ path: `${ApiEndpoints.ENABLEMENT_AREA_PATH}/${itemFromContext}` })
4949
return
5050
}
5151
setIsInternalPageVisible(false)
@@ -59,7 +59,7 @@ const EnablementArea = ({ items, openScript, loading, onOpenInternalPage, isCode
5959
}
6060

6161
const handleCloseInternalPage = () => {
62-
dispatch(resetWorkbenchEAGuide())
62+
dispatch(resetWorkbenchEAItem())
6363
history.push({
6464
// TODO: better to use query-string parser and update only one parameter (instead of replacing all)
6565
search: ''

‎redisinsight/ui/src/pages/workbench/components/enablement-area/EnablementArea/components/LazyInternalPage/LazyInternalPage.tsx‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,10 @@ import { getApiErrorMessage, isStatusSuccessful } from 'uiSrc/utils'
88
import { resourcesService } from 'uiSrc/services'
99
import { IS_ABSOLUTE_PATH } from 'uiSrc/constants/regex'
1010
import {
11-
setWorkbenchEAGuide,
12-
resetWorkbenchEAGuide,
11+
setWorkbenchEAItem,
12+
resetWorkbenchEAItem,
1313
appContextWorkbenchEA,
14-
setWorkbenchEAGuideScrollTop
14+
setWorkbenchEAItemScrollTop
1515
} from 'uiSrc/slices/app/context'
1616
import { IEnablementAreaItem } from 'uiSrc/slices/interfaces'
1717
import { workbenchGuidesSelector } from 'uiSrc/slices/workbench/wb-guides'
@@ -34,7 +34,7 @@ export interface Props {
3434

3535
const LazyInternalPage = ({ onClose, title, path }: Props) => {
3636
const history = useHistory()
37-
const { guideScrollTop } = useSelector(appContextWorkbenchEA)
37+
const { ItemScrollTop } = useSelector(appContextWorkbenchEA)
3838
const guides = useSelector(workbenchGuidesSelector)
3939
const [isLoading, setLoading] = useState<boolean>(false)
4040
const [error, setError] = useState<string>('')
@@ -52,15 +52,15 @@ const LazyInternalPage = ({ onClose, title, path }: Props) => {
5252
const formatter = FormatSelector.selectFor(pageInfo.extension)
5353
const { data, status } = await fetchService.get<string>(path)
5454
if (isStatusSuccessful(status)) {
55-
dispatch(setWorkbenchEAGuide(path))
55+
dispatch(setWorkbenchEAItem(path))
5656
const contentData = await formatter.format(data, { history })
5757
setPageData((prevState) => ({ ...prevState, content: contentData }))
5858
setLoading(false)
5959
}
6060
} catch (error) {
6161
setLoading(false)
6262
const errorMessage: string = getApiErrorMessage(error)
63-
dispatch(resetWorkbenchEAGuide())
63+
dispatch(resetWorkbenchEAItem())
6464
setError(errorMessage)
6565
}
6666
}
@@ -74,7 +74,7 @@ const LazyInternalPage = ({ onClose, title, path }: Props) => {
7474
}, [path, guides.loading])
7575

7676
const handlePageScroll = (top: number) => {
77-
dispatch(setWorkbenchEAGuideScrollTop(top))
77+
dispatch(setWorkbenchEAItemScrollTop(top))
7878
}
7979

8080
return (
@@ -88,7 +88,7 @@ const LazyInternalPage = ({ onClose, title, path }: Props) => {
8888
content={pageData.content}
8989
error={error}
9090
onScroll={handlePageScroll}
91-
scrollTop={guideScrollTop}
91+
scrollTop={ItemScrollTop}
9292
pagination={pageData.relatedPages}
9393
/>
9494
)

‎redisinsight/ui/src/slices/app/context.ts‎

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -22,8 +22,8 @@ export const initialState: StateAppContext = {
2222
workbench: {
2323
script: '',
2424
enablementArea: {
25-
guidePath: '',
26-
guideScrollTop: 0,
25+
ItemPath: '',
26+
ItemScrollTop: 0,
2727
},
2828
panelSizes: {
2929
vertical: {}
@@ -71,19 +71,19 @@ const appContextSlice = createSlice({
7171
setLastPageContext: (state, { payload }: { payload: string }) => {
7272
state.lastPage = payload
7373
},
74-
setWorkbenchEAGuide: (state, { payload }: { payload: any }) => {
75-
const prevValue = state.workbench.enablementArea.guidePath
76-
state.workbench.enablementArea.guidePath = payload
74+
setWorkbenchEAItem: (state, { payload }: { payload: any }) => {
75+
const prevValue = state.workbench.enablementArea.ItemPath
76+
state.workbench.enablementArea.ItemPath = payload
7777
if (prevValue !== payload) {
78-
state.workbench.enablementArea.guideScrollTop = 0
78+
state.workbench.enablementArea.ItemScrollTop = 0
7979
}
8080
},
81-
setWorkbenchEAGuideScrollTop: (state, { payload }: { payload: any }) => {
82-
state.workbench.enablementArea.guideScrollTop = payload || 0
81+
setWorkbenchEAItemScrollTop: (state, { payload }: { payload: any }) => {
82+
state.workbench.enablementArea.ItemScrollTop = payload || 0
8383
},
84-
resetWorkbenchEAGuide: (state) => {
85-
state.workbench.enablementArea.guidePath = ''
86-
state.workbench.enablementArea.guideScrollTop = 0
84+
resetWorkbenchEAItem: (state) => {
85+
state.workbench.enablementArea.ItemPath = ''
86+
state.workbench.enablementArea.ItemScrollTop = 0
8787
},
8888
resetBrowserTree: (state) => {
8989
state.browser.tree.selectedLeaf = {}
@@ -107,9 +107,9 @@ export const {
107107
setWorkbenchScript,
108108
setWorkbenchVerticalPanelSizes,
109109
setLastPageContext,
110-
setWorkbenchEAGuide,
111-
resetWorkbenchEAGuide,
112-
setWorkbenchEAGuideScrollTop,
110+
setWorkbenchEAItem,
111+
resetWorkbenchEAItem,
112+
setWorkbenchEAItemScrollTop,
113113
} = appContextSlice.actions
114114

115115
// Selectors

‎redisinsight/ui/src/slices/interfaces/app.ts‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -59,8 +59,8 @@ export interface StateAppContext {
5959
workbench: {
6060
script: string;
6161
enablementArea: {
62-
guidePath: string;
63-
guideScrollTop: number;
62+
ItemPath: string;
63+
ItemScrollTop: number;
6464
},
6565
panelSizes: {
6666
vertical: {

‎redisinsight/ui/src/slices/tests/app/context.spec.ts‎

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -20,10 +20,10 @@ import reducer, {
2020
appContextSelector,
2121
appContextBrowser,
2222
appContextWorkbench,
23-
setWorkbenchEAGuide,
23+
setWorkbenchEAItem,
2424
appContextWorkbenchEA,
25-
setWorkbenchEAGuideScrollTop,
26-
resetWorkbenchEAGuide,
25+
setWorkbenchEAItemScrollTop,
26+
resetWorkbenchEAItem
2727
setBrowserTreeNodesOpen,
2828
setBrowserTreePanelSizes,
2929
resetBrowserTree,
@@ -216,28 +216,28 @@ describe('slices', () => {
216216
})
217217
})
218218

219-
describe('setWorkbenchEAGuide', () => {
219+
describe('setWorkbenchEAItem', () => {
220220
it('should properly set path to opened guide page', () => {
221221
// Arrange
222222
const prevState = {
223223
...initialState,
224224
workbench: {
225225
...initialState.workbench,
226226
enablementArea: {
227-
guidePath: 'static/enablement-area/guides/guide1.html',
228-
guideScrollTop: 200,
227+
ItemPath: 'static/enablement-area/guides/guide1.html',
228+
ItemScrollTop: 200,
229229
}
230230
},
231231
}
232-
const guidePath = 'static/enablement-area/guides/guide2.html'
232+
const ItemPath = 'static/enablement-area/guides/guide2.html'
233233
const state = {
234234
...initialState.workbench.enablementArea,
235-
guidePath,
236-
guideScrollTop: 0,
235+
ItemPath,
236+
ItemScrollTop: 0,
237237
}
238238

239239
// Act
240-
const nextState = reducer(prevState, setWorkbenchEAGuide(guidePath))
240+
const nextState = reducer(prevState, setWorkbenchEAItem(ItemPath))
241241

242242
// Assert
243243
const rootState = Object.assign(initialStateDefault, {
@@ -248,16 +248,16 @@ describe('slices', () => {
248248
})
249249
})
250250

251-
describe('setWorkbenchEAGuideScrollTop', () => {
251+
describe('setWorkbenchEAItemScrollTop', () => {
252252
it('should properly set state', () => {
253253
// Arrange
254254
const state = {
255255
...initialState.workbench.enablementArea,
256-
guideScrollTop: 200,
256+
ItemScrollTop: 200,
257257
}
258258

259259
// Act
260-
const nextState = reducer(initialState, setWorkbenchEAGuideScrollTop(200))
260+
const nextState = reducer(initialState, setWorkbenchEAItemScrollTop(200))
261261

262262
// Assert
263263
const rootState = Object.assign(initialStateDefault, {
@@ -268,27 +268,27 @@ describe('slices', () => {
268268
})
269269
})
270270

271-
describe('resetWorkbenchEAGuide', () => {
271+
describe('resetWorkbenchEAItem', () => {
272272
it('should properly reset enablement-area context', () => {
273273
// Arrange
274274
const prevState = {
275275
...initialState,
276276
workbench: {
277277
...initialState.workbench,
278278
enablementArea: {
279-
guidePath: 'static/enablement-area/guides/guide1.html',
280-
guideScrollTop: 200,
279+
ItemPath: 'static/enablement-area/guides/guide1.html',
280+
ItemScrollTop: 200,
281281
}
282282
},
283283
}
284284
const state = {
285285
...initialState.workbench.enablementArea,
286-
guidePath: '',
287-
guideScrollTop: 0,
286+
ItemPath: '',
287+
ItemScrollTop: 0,
288288
}
289289

290290
// Act
291-
const nextState = reducer(prevState, resetWorkbenchEAGuide())
291+
const nextState = reducer(prevState, resetWorkbenchEAItem())
292292

293293
// Assert
294294
const rootState = Object.assign(initialStateDefault, {

0 commit comments

Comments
 (0)