-
Notifications
You must be signed in to change notification settings - Fork 8.3k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'master' into alerting/restructure-docs-1
- Loading branch information
Showing
34 changed files
with
862 additions
and
147 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
165 changes: 165 additions & 0 deletions
165
src/plugins/share/common/url_service/__tests__/locators.test.ts
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,165 @@ | ||
| /* | ||
| * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one | ||
| * or more contributor license agreements. Licensed under the Elastic License | ||
| * 2.0 and the Server Side Public License, v 1; you may not use this file except | ||
| * in compliance with, at your election, the Elastic License 2.0 or the Server | ||
| * Side Public License, v 1. | ||
| */ | ||
|
|
||
| import { of } from 'src/plugins/kibana_utils/common'; | ||
| import { testLocator, TestLocatorState, urlServiceTestSetup } from './setup'; | ||
|
|
||
| describe('locators', () => { | ||
| test('can start locators service', () => { | ||
| const { | ||
| service: { locators }, | ||
| } = urlServiceTestSetup(); | ||
|
|
||
| expect(typeof locators).toBe('object'); | ||
| expect(typeof locators.create).toBe('function'); | ||
| expect(typeof locators.get).toBe('function'); | ||
| }); | ||
|
|
||
| test('returns "undefined" for unregistered locator', () => { | ||
| const { | ||
| service: { locators }, | ||
| } = urlServiceTestSetup(); | ||
|
|
||
| expect(locators.get(testLocator.id)).toBe(undefined); | ||
| }); | ||
|
|
||
| test('can register a locator', () => { | ||
| const { | ||
| service: { locators }, | ||
| } = urlServiceTestSetup(); | ||
|
|
||
| locators.create(testLocator); | ||
| expect(typeof locators.get(testLocator.id)).toBe('object'); | ||
| }); | ||
|
|
||
| test('getLocation() returns KibanaLocation generated by the locator', async () => { | ||
| const { | ||
| service: { locators }, | ||
| } = urlServiceTestSetup(); | ||
|
|
||
| locators.create(testLocator); | ||
|
|
||
| const locator = locators.get<TestLocatorState>(testLocator.id); | ||
| const location = await locator?.getLocation({ | ||
| savedObjectId: 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx', | ||
| pageNumber: 21, | ||
| showFlyout: true, | ||
| }); | ||
|
|
||
| expect(location).toEqual({ | ||
| app: 'test_app', | ||
| route: '/my-object/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx?page=21', | ||
| state: { isFlyoutOpen: true }, | ||
| }); | ||
| }); | ||
|
|
||
| describe('.navigate()', () => { | ||
| test('throws if navigation method is not implemented', async () => { | ||
| const { | ||
| service: { locators }, | ||
| } = urlServiceTestSetup(); | ||
| const locator = locators.create(testLocator); | ||
| const [, error] = await of( | ||
| locator.navigate({ | ||
| pageNumber: 1, | ||
| savedObjectId: 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx', | ||
| showFlyout: false, | ||
| }) | ||
| ); | ||
|
|
||
| expect(error).toBeInstanceOf(Error); | ||
| expect(error.message).toBe('not implemented'); | ||
| }); | ||
|
|
||
| test('navigates user when .navigate() method is called', async () => { | ||
| const { | ||
| service: { locators }, | ||
| deps, | ||
| } = urlServiceTestSetup({ | ||
| navigate: jest.fn(async () => {}), | ||
| }); | ||
| const locator = locators.create(testLocator); | ||
| const [, error] = await of( | ||
| locator.navigate({ | ||
| pageNumber: 1, | ||
| savedObjectId: 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx', | ||
| showFlyout: false, | ||
| }) | ||
| ); | ||
|
|
||
| expect(error).toBe(undefined); | ||
| expect(deps.navigate).toHaveBeenCalledTimes(1); | ||
| expect(deps.navigate).toHaveBeenCalledWith( | ||
| { | ||
| app: 'test_app', | ||
| route: '/my-object/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx?page=1', | ||
| state: { | ||
| isFlyoutOpen: false, | ||
| }, | ||
| }, | ||
| { replace: false } | ||
| ); | ||
| }); | ||
|
|
||
| test('can specify "replace" navigation parameter', async () => { | ||
| const { | ||
| service: { locators }, | ||
| deps, | ||
| } = urlServiceTestSetup({ | ||
| navigate: jest.fn(async () => {}), | ||
| }); | ||
| const locator = locators.create(testLocator); | ||
|
|
||
| await locator.navigate( | ||
| { | ||
| pageNumber: 1, | ||
| savedObjectId: 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx', | ||
| showFlyout: false, | ||
| }, | ||
| { | ||
| replace: false, | ||
| } | ||
| ); | ||
|
|
||
| expect(deps.navigate).toHaveBeenCalledTimes(1); | ||
| expect(deps.navigate).toHaveBeenCalledWith( | ||
| { | ||
| app: 'test_app', | ||
| route: '/my-object/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx?page=1', | ||
| state: { | ||
| isFlyoutOpen: false, | ||
| }, | ||
| }, | ||
| { replace: false } | ||
| ); | ||
|
|
||
| await locator.navigate( | ||
| { | ||
| pageNumber: 2, | ||
| savedObjectId: 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx', | ||
| showFlyout: false, | ||
| }, | ||
| { | ||
| replace: true, | ||
| } | ||
| ); | ||
|
|
||
| expect(deps.navigate).toHaveBeenCalledTimes(2); | ||
| expect(deps.navigate).toHaveBeenCalledWith( | ||
| { | ||
| app: 'test_app', | ||
| route: '/my-object/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx?page=2', | ||
| state: { | ||
| isFlyoutOpen: false, | ||
| }, | ||
| }, | ||
| { replace: true } | ||
| ); | ||
| }); | ||
| }); | ||
| }); |
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,42 @@ | ||
| /* | ||
| * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one | ||
| * or more contributor license agreements. Licensed under the Elastic License | ||
| * 2.0 and the Server Side Public License, v 1; you may not use this file except | ||
| * in compliance with, at your election, the Elastic License 2.0 or the Server | ||
| * Side Public License, v 1. | ||
| */ | ||
|
|
||
| import type { SerializableState } from 'src/plugins/kibana_utils/common'; | ||
| import { LocatorDefinition } from '../locators'; | ||
| import { UrlService, UrlServiceDependencies } from '../url_service'; | ||
|
|
||
| export interface TestLocatorState extends SerializableState { | ||
| savedObjectId: string; | ||
| showFlyout: boolean; | ||
| pageNumber: number; | ||
| } | ||
|
|
||
| export const testLocator: LocatorDefinition<TestLocatorState> = { | ||
| id: 'TEST_LOCATOR', | ||
| getLocation: async ({ savedObjectId, pageNumber, showFlyout }) => { | ||
| return { | ||
| app: 'test_app', | ||
| route: `/my-object/${savedObjectId}?page=${pageNumber}`, | ||
| state: { | ||
| isFlyoutOpen: showFlyout, | ||
| }, | ||
| }; | ||
| }, | ||
| }; | ||
|
|
||
| export const urlServiceTestSetup = (partialDeps: Partial<UrlServiceDependencies> = {}) => { | ||
| const deps: UrlServiceDependencies = { | ||
| navigate: async () => { | ||
| throw new Error('not implemented'); | ||
| }, | ||
| ...partialDeps, | ||
| }; | ||
| const service = new UrlService(deps); | ||
|
|
||
| return { service, deps }; | ||
| }; |
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,10 @@ | ||
| /* | ||
| * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one | ||
| * or more contributor license agreements. Licensed under the Elastic License | ||
| * 2.0 and the Server Side Public License, v 1; you may not use this file except | ||
| * in compliance with, at your election, the Elastic License 2.0 or the Server | ||
| * Side Public License, v 1. | ||
| */ | ||
|
|
||
| export * from './url_service'; | ||
| export * from './locators'; |
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,11 @@ | ||
| /* | ||
| * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one | ||
| * or more contributor license agreements. Licensed under the Elastic License | ||
| * 2.0 and the Server Side Public License, v 1; you may not use this file except | ||
| * in compliance with, at your election, the Elastic License 2.0 or the Server | ||
| * Side Public License, v 1. | ||
| */ | ||
|
|
||
| export * from './types'; | ||
| export * from './locator'; | ||
| export * from './locator_client'; |
Oops, something went wrong.