feat: ability to share a preconfigured diff scene #1158
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 |
|---|---|---|
| @@ -0,0 +1,147 @@ | ||
| /* | ||
|
|
||
| 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. | ||
|
|
||
| */ | ||
| import React from 'react' | ||
| import { screen, waitFor } from '@testing-library/react' | ||
| import userEvent from '@testing-library/user-event' | ||
|
|
||
| import type { SpecItem } from '@looker/sdk-codegen' | ||
| import { useHistory } from 'react-router-dom' | ||
| import * as routerLocation from 'react-router-dom' | ||
| import type { Location } from 'history' | ||
| import * as reactRedux from 'react-redux' | ||
| import { getLoadedSpecs } from '../../test-data' | ||
| import { | ||
| createTestStore, | ||
| renderWithRouterAndReduxProvider, | ||
| } from '../../test-utils' | ||
| import { getApixAdaptor } from '../../utils' | ||
| import { DiffScene } from './DiffScene' | ||
|
|
||
| jest.mock('react-router', () => { | ||
| const ReactRouter = jest.requireActual('react-router') | ||
| return { | ||
| ...ReactRouter, | ||
| useHistory: jest.fn().mockReturnValue({ push: jest.fn(), location }), | ||
| useLocation: jest.fn().mockReturnValue({ pathname: '/', search: '' }), | ||
| } | ||
| }) | ||
|
|
||
| const specs = getLoadedSpecs() | ||
| class MockApixAdaptor { | ||
| async fetchSpec(spec: SpecItem) { | ||
| return new Promise(() => specs[spec.key]) | ||
| } | ||
| } | ||
|
|
||
| const mockApixAdaptor = new MockApixAdaptor() | ||
| jest.mock('../../utils/apixAdaptor', () => { | ||
| const apixAdaptor = jest.requireActual('../../utils/apixAdaptor') | ||
| return { | ||
| ...apixAdaptor, | ||
| getApixAdaptor: jest.fn(), | ||
| } | ||
| }) | ||
|
|
||
| describe('DiffScene', () => { | ||
| const mockDispatch = jest.fn() | ||
|
|
||
| afterEach(() => { | ||
| jest.clearAllMocks() | ||
| }) | ||
| ;(getApixAdaptor as jest.Mock).mockReturnValue(mockApixAdaptor) | ||
| Element.prototype.scrollTo = jest.fn() | ||
| Element.prototype.scrollIntoView = jest.fn() | ||
|
|
||
| const toggleNavigation = () => false | ||
| test('toggling comparison option pushes param to url', async () => { | ||
| const { push } = useHistory() | ||
| const store = createTestStore({ | ||
| specs: { specs, currentSpecKey: '3.1' }, | ||
| settings: { initialized: true }, | ||
| }) | ||
| renderWithRouterAndReduxProvider( | ||
| <DiffScene specs={specs} toggleNavigation={toggleNavigation} />, | ||
| ['/diff/3.1'], | ||
| store | ||
| ) | ||
| userEvent.click(screen.getByPlaceholderText('Comparison options')) | ||
| userEvent.click( | ||
| screen.getByRole('option', { | ||
| name: 'Missing', | ||
| }) | ||
| ) | ||
| await waitFor(() => { | ||
| expect(push).toHaveBeenCalledWith({ | ||
| pathname: '/', | ||
| search: 'opts=missing', | ||
| }) | ||
| }) | ||
| // TODO: test URL change leads to store dispatch? - change mock history push implementation to change our location | ||
| // TODO: test that toggling another will push both options to store/url | ||
| }) | ||
|
|
||
| test.todo( | ||
| 'rendering scene with opts param in url sets selected options in selector', | ||
| async () => { | ||
| jest.spyOn(routerLocation, 'useLocation').mockReturnValue({ | ||
| pathname: `/`, | ||
| search: `opts=missing%2Ctype%2Cresponse`, | ||
| } as unknown as Location) | ||
| const store = createTestStore({ | ||
| specs: { specs, currentSpecKey: '3.1' }, | ||
| settings: { initialized: true, diffOptions: [] }, | ||
| }) | ||
| jest.spyOn(reactRedux, 'useDispatch').mockReturnValue(mockDispatch) | ||
| renderWithRouterAndReduxProvider( | ||
| <DiffScene specs={specs} toggleNavigation={toggleNavigation} />, | ||
| ['/diff/3.1'], | ||
| store | ||
| ) | ||
| expect(mockDispatch).toHaveBeenLastCalledWith({ | ||
| payload: { diffOptions: ['missing', 'type', 'response'] }, | ||
| type: 'settings/setDiffOptionsAction', | ||
| }) | ||
| expect( | ||
| screen.getByRole('option', { | ||
| name: 'Missing', | ||
| }) | ||
| ).toBeInTheDocument() | ||
| expect( | ||
| screen.getByRole('option', { | ||
| name: 'Type', | ||
| }) | ||
| ).toBeInTheDocument() | ||
| expect( | ||
| screen.getByRole('option', { | ||
| name: 'Response', | ||
| }) | ||
| ).toBeInTheDocument() | ||
| } | ||
| ) | ||
|
|
||
| test.todo('unselecting comparison option will remove it from url opts param') | ||
| test.todo('selecting clear option will remove all params from url opts param') | ||
| }) |
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
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The scenario to consider here (and with the same change in
SideNavTypes): we are in a diff scene with selected options, andoptsparam in the url. When we open the sideNav and open a method/tag scene, this opts parameter should no longer persist. The reason we don't usenavigateWithGlobalParamsto remove this parameter is because if we started at a tag scene with a filter selected and want to select another tag, this filter should still persist when we open the new tag scene.So, technically, the purpose of this line in plain english is more like "navigate to the tag scene and ONLY keep the tag filter variable if we have one in the URL"
This makes me reconsider what we initially had proposed where we have a specific
navigateTomethods. I think in the long term there will be 2 cases:navigateWithGlobalParams, etc)To better account for case 2, I think having custom navigate methods makes the most sense. Here we'd explicitly have a
navigateToTagSceneinstead of having to explicitly nullify any extra parameters that could persist when navigating to a tag scene from the SideNav.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@josephaxisa