-
-
Notifications
You must be signed in to change notification settings - Fork 13
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Port TreeView to use redux-toolkit (#2774)
- Loading branch information
1 parent
6b800c0
commit 1c1db26
Showing
10 changed files
with
135 additions
and
209 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,60 +1,57 @@ | ||
| import { Action, PayloadAction } from "@reduxjs/toolkit"; | ||
|
|
||
| import { SemanticDomain, SemanticDomainTreeNode } from "api/models"; | ||
| import { getSemanticDomainTreeNode } from "backend"; | ||
| import { | ||
| TreeActionType, | ||
| TreeViewAction, | ||
| } from "components/TreeView/Redux/TreeViewReduxTypes"; | ||
| resetTreeAction, | ||
| setCurrentDomainAction, | ||
| setDomainLanguageAction, | ||
| setTreeOpenAction, | ||
| } from "components/TreeView/Redux/TreeViewReducer"; | ||
| import { StoreState } from "types"; | ||
| import { StoreStateDispatch } from "types/Redux/actions"; | ||
|
|
||
| export function closeTreeAction(): TreeViewAction { | ||
| return { type: TreeActionType.CLOSE_TREE }; | ||
| // Action Creation Functions | ||
|
|
||
| export function closeTree(): PayloadAction { | ||
| return setTreeOpenAction(false); | ||
| } | ||
|
|
||
| export function openTreeAction(): TreeViewAction { | ||
| return { type: TreeActionType.OPEN_TREE }; | ||
| export function openTree(): PayloadAction { | ||
| return setTreeOpenAction(true); | ||
| } | ||
|
|
||
| export function setDomainAction( | ||
| domain: SemanticDomainTreeNode | ||
| ): TreeViewAction { | ||
| return { type: TreeActionType.SET_CURRENT_DOMAIN, domain }; | ||
| export function resetTree(): Action { | ||
| return resetTreeAction(); | ||
| } | ||
|
|
||
| export function setDomainLanguageAction(language: string): TreeViewAction { | ||
| return { type: TreeActionType.SET_DOMAIN_LANGUAGE, language }; | ||
| export function setCurrentDomain( | ||
| domain: SemanticDomainTreeNode | ||
| ): PayloadAction { | ||
| return setCurrentDomainAction(domain); | ||
| } | ||
|
|
||
| export function resetTreeAction(): TreeViewAction { | ||
| return { type: TreeActionType.RESET_TREE }; | ||
| export function setDomainLanguage(language: string): PayloadAction { | ||
| return setDomainLanguageAction(language); | ||
| } | ||
|
|
||
| // Dispatch Functions | ||
|
|
||
| export function traverseTree(domain: SemanticDomain) { | ||
| return async (dispatch: StoreStateDispatch) => { | ||
| if (domain) { | ||
| await getSemanticDomainTreeNode(domain.id, domain.lang).then( | ||
| (response) => { | ||
| if (response) { | ||
| dispatch(setDomainAction(response)); | ||
| } | ||
| } | ||
| ); | ||
| } | ||
| }; | ||
| } | ||
|
|
||
| export function updateTreeLanguage(language: string) { | ||
| return (dispatch: StoreStateDispatch) => { | ||
| if (language) { | ||
| dispatch(setDomainLanguageAction(language)); | ||
| if (domain.id) { | ||
| const dom = await getSemanticDomainTreeNode(domain.id, domain.lang); | ||
| if (dom) { | ||
| dispatch(setCurrentDomain(dom)); | ||
| } | ||
| } | ||
| }; | ||
| } | ||
|
|
||
| export function initTreeDomain(language = "") { | ||
| export function initTreeDomain(lang = "") { | ||
| return async (dispatch: StoreStateDispatch, getState: () => StoreState) => { | ||
| const currentDomain = getState().treeViewState.currentDomain; | ||
| currentDomain.lang = language; | ||
| await dispatch(traverseTree(currentDomain)); | ||
| await dispatch( | ||
| traverseTree({ ...getState().treeViewState.currentDomain, lang }) | ||
| ); | ||
| }; | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,39 +1,33 @@ | ||
| import { | ||
| TreeViewAction, | ||
| TreeActionType, | ||
| TreeViewState, | ||
| defaultState, | ||
| } from "components/TreeView/Redux/TreeViewReduxTypes"; | ||
| import { StoreAction, StoreActionTypes } from "rootActions"; | ||
| import { createSlice } from "@reduxjs/toolkit"; | ||
|
|
||
| export const treeViewReducer = ( | ||
| state: TreeViewState = defaultState, | ||
| action: StoreAction | TreeViewAction | ||
| ): TreeViewState => { | ||
| switch (action.type) { | ||
| case TreeActionType.CLOSE_TREE: | ||
| return { ...state, open: false }; | ||
| case TreeActionType.OPEN_TREE: | ||
| return { ...state, open: true }; | ||
| case TreeActionType.RESET_TREE: | ||
| return defaultState; | ||
| case TreeActionType.SET_DOMAIN_LANGUAGE: | ||
| if (!action.language) { | ||
| throw new Error("Cannot set domain language to undefined."); | ||
| } | ||
| return { | ||
| ...state, | ||
| currentDomain: { ...state.currentDomain, lang: action.language }, | ||
| language: action.language, | ||
| }; | ||
| case TreeActionType.SET_CURRENT_DOMAIN: | ||
| if (!action.domain) { | ||
| throw new Error("Cannot set the current domain to undefined."); | ||
| } | ||
| return { ...state, currentDomain: action.domain }; | ||
| case StoreActionTypes.RESET: | ||
| return defaultState; | ||
| default: | ||
| return state; | ||
| } | ||
| }; | ||
| import { defaultState } from "components/TreeView/Redux/TreeViewReduxTypes"; | ||
| import { StoreActionTypes } from "rootActions"; | ||
|
|
||
| const treeViewSlice = createSlice({ | ||
| name: "treeViewState", | ||
| initialState: defaultState, | ||
| reducers: { | ||
| resetTreeAction: () => defaultState, | ||
| setCurrentDomainAction: (state, action) => { | ||
| state.currentDomain = action.payload; | ||
| }, | ||
| setDomainLanguageAction: (state, action) => { | ||
| state.currentDomain.lang = action.payload; | ||
| state.language = action.payload; | ||
| }, | ||
| setTreeOpenAction: (state, action) => { | ||
| state.open = action.payload; | ||
| }, | ||
| }, | ||
| extraReducers: (builder) => | ||
| builder.addCase(StoreActionTypes.RESET, () => defaultState), | ||
| }); | ||
|
|
||
| export const { | ||
| resetTreeAction, | ||
| setCurrentDomainAction, | ||
| setDomainLanguageAction, | ||
| setTreeOpenAction, | ||
| } = treeViewSlice.actions; | ||
|
|
||
| export default treeViewSlice.reducer; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
99 changes: 58 additions & 41 deletions
99
src/components/TreeView/Redux/tests/TreeViewActions.test.tsx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,61 +1,78 @@ | ||
| import configureMockStore from "redux-mock-store"; | ||
| import thunk from "redux-thunk"; | ||
| import { PreloadedState } from "redux"; | ||
|
|
||
| import { defaultState } from "components/App/DefaultState"; | ||
| import { | ||
| setDomainLanguageAction, | ||
| initTreeDomain, | ||
| setDomainLanguage, | ||
| traverseTree, | ||
| } from "components/TreeView/Redux/TreeViewActions"; | ||
| import { RootState, setupStore } from "store"; | ||
| import { | ||
| defaultState, | ||
| TreeActionType, | ||
| } from "components/TreeView/Redux/TreeViewReduxTypes"; | ||
| import { newSemanticDomainTreeNode } from "types/semanticDomain"; | ||
| newSemanticDomain, | ||
| newSemanticDomainTreeNode, | ||
| } from "types/semanticDomain"; | ||
|
|
||
| jest.mock("backend", () => ({ | ||
| getSemanticDomainTreeNode: (id: string, lang: string) => | ||
| mockGetSemDomTreeNode(id, lang), | ||
| getSemanticDomainTreeNode: (...args: any[]) => mockGetSemDomTreeNode(...args), | ||
| })); | ||
|
|
||
| const mockGetSemDomTreeNode = jest.fn(); | ||
|
|
||
| // Mock the track and identify methods of segment analytics. | ||
| global.analytics = { identify: jest.fn(), track: jest.fn() } as any; | ||
|
|
||
| const createMockStore = configureMockStore([thunk]); | ||
| const mockState = defaultState; | ||
|
|
||
| describe("TraverseTreeAction", () => { | ||
| it("SetDomainLanguage returns correct action", async () => { | ||
| const language = "lang"; | ||
| const action = { | ||
| type: TreeActionType.SET_DOMAIN_LANGUAGE, | ||
| language, | ||
| }; | ||
| const mockStore = createMockStore(mockState); | ||
| await mockStore.dispatch<any>(setDomainLanguageAction("lang")); | ||
| expect(mockStore.getActions()).toEqual([action]); | ||
| }); | ||
| const mockId = "id"; | ||
| const mockLang = "lang"; | ||
|
|
||
| // Preloaded values for store when testing | ||
| const persistedDefaultState: PreloadedState<RootState> = { | ||
| ...defaultState, | ||
| _persist: { version: 1, rehydrated: false }, | ||
| }; | ||
|
|
||
| it("TraverseTreeAction dispatches on successful", async () => { | ||
| const mockDomainReturned = newSemanticDomainTreeNode("id", "name"); | ||
| mockGetSemDomTreeNode.mockResolvedValue(mockDomainReturned); | ||
| const domain = { id: "id", name: "name", guid: "", lang: "" }; | ||
| const action = { | ||
| type: TreeActionType.SET_CURRENT_DOMAIN, | ||
| domain: mockDomainReturned, | ||
| }; | ||
| const mockStore = createMockStore(mockState); | ||
|
|
||
| await mockStore.dispatch<any>(traverseTree(domain)); | ||
| expect(mockStore.getActions()).toEqual([action]); | ||
| describe("TreeViewActions", () => { | ||
| describe("setDomainLanguage", () => { | ||
| it("correctly affects state", async () => { | ||
| const store = setupStore(); | ||
| store.dispatch(setDomainLanguage(mockLang)); | ||
| const { currentDomain, language } = store.getState().treeViewState; | ||
| expect(currentDomain.lang).toEqual(mockLang); | ||
| expect(language).toEqual(mockLang); | ||
| }); | ||
| }); | ||
|
|
||
| it("TraverseTreeAction does not dispatch on null return", async () => { | ||
| mockGetSemDomTreeNode.mockResolvedValue(undefined); | ||
| const domain = { id: "id", name: "name", guid: "", lang: "" }; | ||
| const mockStore = createMockStore(mockState); | ||
| describe("traverseTree", () => { | ||
| it("dispatches on successful", async () => { | ||
| const store = setupStore(); | ||
| const dom = newSemanticDomain(mockId); | ||
| mockGetSemDomTreeNode.mockResolvedValue(dom); | ||
| await store.dispatch(traverseTree(dom)); | ||
| const { currentDomain } = store.getState().treeViewState; | ||
| expect(currentDomain.id).toEqual(mockId); | ||
| }); | ||
|
|
||
| it("does not dispatch on undefined", async () => { | ||
| const store = setupStore(); | ||
| mockGetSemDomTreeNode.mockResolvedValue(undefined); | ||
| await store.dispatch(traverseTree(newSemanticDomain(mockId))); | ||
| const { currentDomain } = store.getState().treeViewState; | ||
| expect(currentDomain.id).not.toEqual(mockId); | ||
| }); | ||
| }); | ||
|
|
||
| await mockStore.dispatch<any>(traverseTree(domain)); | ||
| expect(mockStore.getActions()).toEqual([]); | ||
| describe("initTreeDomain", () => { | ||
| it("changes domain lang but not id", async () => { | ||
| const nonDefaultState = { | ||
| currentDomain: newSemanticDomainTreeNode(mockId), | ||
| language: "", | ||
| open: true, | ||
| }; | ||
| const store = setupStore({ | ||
| ...persistedDefaultState, | ||
| treeViewState: nonDefaultState, | ||
| }); | ||
| await store.dispatch(initTreeDomain(mockLang)); | ||
| expect(mockGetSemDomTreeNode).toBeCalledWith(mockId, mockLang); | ||
| }); | ||
| }); | ||
| }); |
Oops, something went wrong.