@looker/api-explorer 0.9.35 → 0.9.37

package/src/scenes/utils/hooks/tagStoreSync.ts

@@ -0,0 +1,68 @@
+/*
+
+ MIT License
+
+ Copyright (c) 2022 Looker Data Sciences, Inc.
+
+ Permission is hereby granted, free of charge, to any person obtaining a copy
+ of this software and associated documentation files (the "Software"), to deal
+ in the Software without restriction, including without limitation the rights
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ copies of the Software, and to permit persons to whom the Software is
+ furnished to do so, subject to the following conditions:
+
+ The above copyright notice and this permission notice shall be included in all
+ copies or substantial portions of the Software.
+
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ SOFTWARE.
+
+ */
+import { useLocation } from 'react-router-dom'
+import { useSelector } from 'react-redux'
+import { useEffect } from 'react'
+import {
+  selectTagFilter,
+  useSettingActions,
+  useSettingStoreState,
+} from '../../../state'
+import { isValidFilter, useNavigation } from '../../../utils'
+
+/**
+ * Hook for syncing tag scene URL params with the Redux store
+ *
+ * Tag scene specific search parameters: 't'
+ */
+export const useTagStoreSync = () => {
+  const location = useLocation()
+  const { navigate } = useNavigation()
+  const { setTagFilterAction } = useSettingActions()
+  const { initialized } = useSettingStoreState()
+  const selectedTagFilter = useSelector(selectTagFilter)
+
+  useEffect(() => {
+    if (initialized) {
+      const params = new URLSearchParams(location.search)
+
+      // syncing verb filter on tag scene page
+      const verbParam = params.get('t') || 'ALL'
+      const validVerbParam = isValidFilter(location.pathname, verbParam)
+      if (validVerbParam) {
+        setTagFilterAction({ tagFilter: verbParam.toUpperCase() })
+      } else {
+        // must confirm store tag filter param is valid for tag type before updating
+        const verb = isValidFilter(location.pathname, selectedTagFilter)
+          ? selectedTagFilter
+          : 'ALL'
+        navigate(location.pathname, {
+          t: verb === 'ALL' ? null : verb.toLowerCase(),
+        })
+      }
+    }
+  }, [initialized])
+}

package/src/scenes/utils/index.ts

@@ -0,0 +1,27 @@
+/*
+
+ MIT License
+
+ Copyright (c) 2021 Looker Data Sciences, Inc.
+
+ Permission is hereby granted, free of charge, to any person obtaining a copy
+ of this software and associated documentation files (the "Software"), to deal
+ in the Software without restriction, including without limitation the rights
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ copies of the Software, and to permit persons to whom the Software is
+ furnished to do so, subject to the following conditions:
+
+ The above copyright notice and this permission notice shall be included in all
+ copies or substantial portions of the Software.
+
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ SOFTWARE.
+
+ */
+
+export { useTagStoreSync } from './hooks'

package/src/state/settings/selectors.spec.ts

@@ -24,7 +24,7 @@
 
  */
 import { createTestStore, preloadedState } from '../../test-utils'
-import { selectSdkLanguage, isInitialized } from './selectors'
+import { selectSdkLanguage, isInitialized, selectTagFilter } from './selectors'
 
 const testStore = createTestStore()
 
@@ -37,6 +37,10 @@ describe('Settings selectors', () => {
     )
   })
 
+  test('selectTagFilter selects', () => {
+    expect(selectTagFilter(state)).toEqual(preloadedState.settings.tagFilter)
+  })
+
   test('isInitialized selects', () => {
     expect(isInitialized(state)).toEqual(preloadedState.settings.initialized)
   })

package/src/state/settings/selectors.ts

@@ -36,5 +36,8 @@ export const selectSearchPattern = (state: RootState) =>
 export const selectSearchCriteria = (state: RootState) =>
   selectSettingsState(state).searchCriteria
 
+export const selectTagFilter = (state: RootState) =>
+  selectSettingsState(state).tagFilter
+
 export const isInitialized = (state: RootState) =>
   selectSettingsState(state).initialized

package/src/state/settings/slice.ts

@@ -38,6 +38,7 @@ export interface UserDefinedSettings {
 export interface SettingState extends UserDefinedSettings {
   searchPattern: string
   searchCriteria: SearchCriterionTerm[]
+  tagFilter: string
   initialized: boolean
   error?: Error
 }
@@ -46,6 +47,7 @@ export const defaultSettings = {
   sdkLanguage: 'Python',
   searchPattern: '',
   searchCriteria: setToCriteria(SearchAll) as SearchCriterionTerm[],
+  tagFilter: 'ALL',
 }
 
 export const defaultSettingsState: SettingState = {
@@ -55,6 +57,7 @@ export const defaultSettingsState: SettingState = {
 
 type SetSearchPatternAction = Pick<SettingState, 'searchPattern'>
 type SetSdkLanguageAction = Pick<SettingState, 'sdkLanguage'>
+type SetTagFilterAction = Pick<SettingState, 'tagFilter'>
 
 export type InitSuccessPayload = UserDefinedSettings
 
@@ -84,6 +87,9 @@ export const settingsSlice = createSlice({
     ) {
       state.searchPattern = action.payload.searchPattern
     },
+    setTagFilterAction(state, action: PayloadAction<SetTagFilterAction>) {
+      state.tagFilter = action.payload.tagFilter
+    },
   },
 })
 

package/src/test-data/index.ts

@@ -26,3 +26,4 @@
 export * from './specs'
 export { examples } from './examples'
 export * from './declarations'
+export * from './sdkLanguages'

package/src/test-data/sdkLanguages.ts

@@ -0,0 +1,36 @@
+/*
+
+ MIT License
+
+ Copyright (c) 2022 Looker Data Sciences, Inc.
+
+ Permission is hereby granted, free of charge, to any person obtaining a copy
+ of this software and associated documentation files (the "Software"), to deal
+ in the Software without restriction, including without limitation the rights
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ copies of the Software, and to permit persons to whom the Software is
+ furnished to do so, subject to the following conditions:
+
+ The above copyright notice and this permission notice shall be included in all
+ copies or substantial portions of the Software.
+
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ SOFTWARE.
+
+ */
+export const sdkLanguageMapping = {
+  py: 'Python',
+  ts: 'TypeScript',
+  cs: 'C#',
+  kt: 'Kotlin',
+  swift: 'Swift',
+  go: 'Go',
+  all: 'All',
+}
+
+export const languages = Object.values(sdkLanguageMapping)

package/src/utils/hooks/globalStoreSync.spec.tsx

@@ -0,0 +1,146 @@
+/*
+
+ MIT License
+
+ Copyright (c) 2022 Looker Data Sciences, Inc.
+
+ Permission is hereby granted, free of charge, to any person obtaining a copy
+ of this software and associated documentation files (the "Software"), to deal
+ in the Software without restriction, including without limitation the rights
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ copies of the Software, and to permit persons to whom the Software is
+ furnished to do so, subject to the following conditions:
+
+ The above copyright notice and this permission notice shall be included in all
+ copies or substantial portions of the Software.
+
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ SOFTWARE.
+
+ */
+import { renderHook } from '@testing-library/react-hooks'
+import { useHistory } from 'react-router-dom'
+import type { Location } from 'history'
+import * as reactRedux from 'react-redux'
+import * as routerLocation from 'react-router-dom'
+import { createTestStore, withReduxProvider } from '../../test-utils'
+import { useGlobalStoreSync } from './globalStoreSync'
+
+jest.mock('react-router', () => {
+  const ReactRouterDOM = jest.requireActual('react-router-dom')
+  return {
+    ...ReactRouterDOM,
+    useHistory: jest.fn().mockReturnValue({ push: jest.fn(), location }),
+    useLocation: jest.fn().mockReturnValue({ pathname: '/', search: '' }),
+  }
+})
+
+describe('useGlobalStoreSync', () => {
+  const mockDispatch = jest.fn()
+
+  afterEach(() => {
+    jest.clearAllMocks()
+  })
+
+  test('does nothing if uninitialized', () => {
+    const { push } = useHistory()
+    const wrapper = ({ children }: any) => withReduxProvider(children)
+    renderHook(() => useGlobalStoreSync(), { wrapper })
+    expect(push).not.toHaveBeenCalled()
+  })
+
+  describe('search', () => {
+    test('updates store search pattern with url search pattern if present', () => {
+      const { push } = useHistory()
+      const store = createTestStore({
+        settings: {
+          initialized: true,
+        },
+      })
+      jest.spyOn(routerLocation, 'useLocation').mockReturnValue({
+        pathname: '/',
+        search: `s=patternFromUrl`,
+      } as unknown as Location)
+      jest.spyOn(reactRedux, 'useDispatch').mockReturnValue(mockDispatch)
+      const wrapper = ({ children }: any) => withReduxProvider(children, store)
+      renderHook(() => useGlobalStoreSync(), { wrapper })
+      expect(mockDispatch).toHaveBeenCalledWith({
+        payload: { searchPattern: 'patternFromUrl' },
+        type: 'settings/setSearchPatternAction',
+      })
+      expect(push).toHaveBeenCalledWith({ pathname: '/', search: 'sdk=py' })
+    })
+  })
+
+  describe('sdk', () => {
+    test('syncs url sdk param with sdk in store', () => {
+      const { push } = useHistory()
+      const store = createTestStore({
+        settings: {
+          initialized: true,
+          sdkLanguage: 'Kotlin',
+        },
+      })
+      const wrapper = ({ children }: any) => withReduxProvider(children, store)
+      renderHook(() => useGlobalStoreSync(), { wrapper })
+      expect(push).toHaveBeenCalledWith({
+        pathname: '/',
+        search: 'sdk=kt',
+      })
+    })
+
+    test.each([
+      ['alias', 'kt'],
+      ['language', 'kotlin'],
+    ])(
+      'overrides store with sdk full name given valid url sdk %s',
+      (_, param) => {
+        const { push } = useHistory()
+        const store = createTestStore({
+          settings: {
+            initialized: true,
+          },
+        })
+        jest.spyOn(routerLocation, 'useLocation').mockReturnValue({
+          pathname: '/',
+          search: `sdk=${param}`,
+        } as unknown as Location)
+        jest.spyOn(reactRedux, 'useDispatch').mockReturnValue(mockDispatch)
+        const wrapper = ({ children }: any) =>
+          withReduxProvider(children, store)
+        renderHook(() => useGlobalStoreSync(), { wrapper })
+        expect(push).not.toHaveBeenCalled()
+        expect(mockDispatch).toHaveBeenLastCalledWith({
+          payload: { sdkLanguage: 'Kotlin' },
+          type: 'settings/setSdkLanguageAction',
+        })
+      }
+    )
+
+    test('updates url sdk param with store sdk for invalid url sdk param', () => {
+      const { push } = useHistory()
+      const store = createTestStore({
+        settings: {
+          initialized: true,
+        },
+      })
+      jest.spyOn(routerLocation, 'useLocation').mockReturnValue({
+        pathname: '/',
+        search: `sdk=invalid`,
+      } as unknown as Location)
+      jest.spyOn(reactRedux, 'useDispatch').mockReturnValue(mockDispatch)
+      const wrapper = ({ children }: any) => withReduxProvider(children, store)
+      renderHook(() => useGlobalStoreSync(), { wrapper })
+      expect(mockDispatch).not.toHaveBeenCalled()
+      expect(push).toHaveBeenCalledWith({
+        pathname: '/',
+        search: `sdk=py`,
+      })
+    })
+  })
+})

package/src/utils/hooks/globalStoreSync.ts

@@ -0,0 +1,77 @@
+/*
+
+ MIT License
+
+ Copyright (c) 2022 Looker Data Sciences, Inc.
+
+ Permission is hereby granted, free of charge, to any person obtaining a copy
+ of this software and associated documentation files (the "Software"), to deal
+ in the Software without restriction, including without limitation the rights
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ copies of the Software, and to permit persons to whom the Software is
+ furnished to do so, subject to the following conditions:
+
+ The above copyright notice and this permission notice shall be included in all
+ copies or substantial portions of the Software.
+
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ SOFTWARE.
+
+ */
+import { useLocation } from 'react-router-dom'
+import { useEffect } from 'react'
+import { useSelector } from 'react-redux'
+import { allAlias, findSdk, useNavigation } from '../index'
+import {
+  selectSdkLanguage,
+  useSettingActions,
+  useSettingStoreState,
+} from '../../state'
+
+/**
+ * Hook for syncing global URL params with the Redux store
+ * Global search parameters: 's', 'sdk'
+ */
+export const useGlobalStoreSync = () => {
+  const location = useLocation()
+  const { navigate } = useNavigation()
+  const { setSdkLanguageAction, setSearchPatternAction } = useSettingActions()
+  const { initialized } = useSettingStoreState()
+  const selectedSdkLanguage = useSelector(selectSdkLanguage)
+
+  useEffect(() => {
+    if (initialized) {
+      const params = new URLSearchParams(location.search)
+
+      // syncing search query
+      const searchParam = params.get('s')
+      if (searchParam) {
+        setSearchPatternAction({
+          searchPattern: searchParam,
+        })
+      }
+
+      // syncing SDK language selection
+      const sdkParam = params.get('sdk') || ''
+      const sdk = findSdk(sdkParam)
+      const validSdkParam =
+        !sdkParam.localeCompare(sdk.alias, 'en', { sensitivity: 'base' }) ||
+        !sdkParam.localeCompare(sdk.language, 'en', { sensitivity: 'base' })
+      if (validSdkParam) {
+        setSdkLanguageAction({
+          sdkLanguage: sdk.language,
+        })
+      } else {
+        const { alias } = findSdk(selectedSdkLanguage)
+        navigate(location.pathname, {
+          sdk: alias === allAlias ? null : alias,
+        })
+      }
+    }
+  }, [initialized])
+}

package/src/utils/hooks/index.ts

@@ -0,0 +1,28 @@
+/*
+
+ MIT License
+
+ Copyright (c) 2021 Looker Data Sciences, Inc.
+
+ Permission is hereby granted, free of charge, to any person obtaining a copy
+ of this software and associated documentation files (the "Software"), to deal
+ in the Software without restriction, including without limitation the rights
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ copies of the Software, and to permit persons to whom the Software is
+ furnished to do so, subject to the following conditions:
+
+ The above copyright notice and this permission notice shall be included in all
+ copies or substantial portions of the Software.
+
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ SOFTWARE.
+
+ */
+export { useNavigation } from './navigation'
+export { useGlobalStoreSync } from './globalStoreSync'
+export { useQuery } from './useQuery'

package/src/utils/hooks/navigation.spec.ts

@@ -0,0 +1,118 @@
+/*
+
+ MIT License
+
+ Copyright (c) 2022 Looker Data Sciences, Inc.
+
+ Permission is hereby granted, free of charge, to any person obtaining a copy
+ of this software and associated documentation files (the "Software"), to deal
+ in the Software without restriction, including without limitation the rights
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ copies of the Software, and to permit persons to whom the Software is
+ furnished to do so, subject to the following conditions:
+
+ The above copyright notice and this permission notice shall be included in all
+ copies or substantial portions of the Software.
+
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ SOFTWARE.
+
+ */
+import { useHistory } from 'react-router-dom'
+import { useNavigation } from './navigation'
+
+const mockHistoryPush = jest.fn()
+jest.mock('react-router-dom', () => {
+  const ReactRouterDOM = jest.requireActual('react-router-dom')
+  return {
+    ...ReactRouterDOM,
+    useHistory: () => ({
+      push: mockHistoryPush,
+      location: {
+        pathname: '/3.1/methods/Auth',
+        search: 's=test&sdk=py&t=get',
+      },
+    }),
+  }
+})
+
+describe('useNavigation', () => {
+  const history = useHistory()
+  const { navigate, navigateWithGlobalParams, buildPathWithGlobalParams } =
+    useNavigation()
+  const curParams = new URLSearchParams(history.location.search)
+  const route = `/3.1`
+
+  describe('navigate', () => {
+    test('preserves existing query params when given params are undefined', () => {
+      navigate(route)
+      expect(curParams.get('s')).toBe('test')
+      expect(curParams.get('sdk')).toBe('py')
+      expect(curParams.get('t')).toBe('get')
+      expect(mockHistoryPush).lastCalledWith({
+        pathname: route,
+        search: curParams.toString(),
+      })
+    })
+
+    test('clears existing params when given params are null', () => {
+      navigate(route, null)
+      expect(mockHistoryPush).lastCalledWith({
+        pathname: route,
+      })
+    })
+
+    test('removes null query params while persisting undefined params if in URL', () => {
+      navigate(route, { s: null, sdk: 'test' })
+      expect(mockHistoryPush).lastCalledWith({
+        pathname: route,
+        search: 'sdk=test&t=get',
+      })
+    })
+
+    test('sets query parameters when given a populated query params object', () => {
+      const newParams = new URLSearchParams()
+      newParams.set('s', 'newTest')
+      newParams.set('sdk', 'kt')
+      newParams.set('t', 'post')
+      navigate(route, {
+        s: newParams.get('s'),
+        sdk: newParams.get('sdk'),
+        t: newParams.get('t'),
+      })
+      expect(mockHistoryPush).lastCalledWith({
+        pathname: route,
+        search: newParams.toString(),
+      })
+    })
+  })
+
+  describe('buildPathWithGlobalParams', () => {
+    test('creates path with global parameters excluding scene specific parameters', () => {
+      curParams.delete('t')
+      expect(buildPathWithGlobalParams(route)).toEqual(
+        `${route}?${curParams.toString()}`
+      )
+    })
+
+    test('adds other parameters if present', () => {
+      curParams.delete('t')
+      const actual = buildPathWithGlobalParams(route, { e: 400 })
+      expect(actual).toEqual(`${route}?${curParams.toString()}&e=400`)
+    })
+  })
+
+  describe('navigateWithGlobalParams', () => {
+    test('preserves global query params and removes scene specific parameters', () => {
+      curParams.delete('t')
+      navigateWithGlobalParams(route)
+      expect(curParams.get('s')).toEqual('test')
+      expect(mockHistoryPush).lastCalledWith(`${route}?${curParams.toString()}`)
+    })
+  })
+})