/* * SPDX-License-Identifier: Apache-2.0 * * The OpenSearch Contributors require contributions made to * this file be licensed under the Apache-2.0 license or a * compatible open source license. * * Any modifications Copyright OpenSearch Contributors. See * GitHub history for details. */ /* * Licensed to Elasticsearch B.V. under one or more contributor * license agreements. See the NOTICE file distributed with * this work for additional information regarding copyright * ownership. Elasticsearch B.V. licenses this file to you under * the Apache License, Version 2.0 (the "License"); you may * not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. */ import * as React from 'react'; import * as ReactDOM from 'react-dom'; import { act, Simulate } from 'react-dom/test-utils'; import { useUiSetting$ } from './use_ui_setting'; import { createOpenSearchDashboardsReactContext } from '../context'; import { OpenSearchDashboardsServices } from '../context/types'; import { Subject } from 'rxjs'; import { coreMock } from '../../../../core/public/mocks'; import useObservable from 'react-use/lib/useObservable'; jest.mock('react-use/lib/useObservable'); const useObservableSpy = (useObservable as any) as jest.SpyInstance; useObservableSpy.mockImplementation((observable, def) => def); const mock = (): [OpenSearchDashboardsServices, Subject] => { const core = coreMock.createStart(); const get = core.uiSettings.get; const get$ = core.uiSettings.get$; const subject = new Subject(); get.mockImplementation(() => 'bar'); get$.mockImplementation(() => subject); return [core, subject]; }; let container: HTMLDivElement | null; beforeEach(() => { container = document.createElement('div'); document.body.appendChild(container); useObservableSpy.mockClear(); }); afterEach(() => { document.body.removeChild(container!); container = null; }); describe('useUiSetting', () => { const TestConsumer: React.FC<{ setting: string; newValue?: string; }> = ({ setting, newValue = '' }) => { const [value, set] = useUiSetting$(setting, 'DEFAULT'); return (
{setting}: {value}
); }; test('returns setting value', async () => { const [core] = mock(); const { Provider } = createOpenSearchDashboardsReactContext(core); ReactDOM.render( , container ); const strong = container!.querySelector('strong'); expect(strong!.textContent).toBe('bar'); expect(core.uiSettings!.get).toHaveBeenCalledTimes(1); expect((core.uiSettings!.get as any).mock.calls[0][0]).toBe('foo'); }); test('calls uiSettings.get() method with correct key and default value', async () => { const [core] = mock(); const { Provider } = createOpenSearchDashboardsReactContext(core); ReactDOM.render( , container ); expect(core.uiSettings!.get).toHaveBeenCalledTimes(1); expect((core.uiSettings!.get as any).mock.calls[0][0]).toBe('foo'); expect((core.uiSettings!.get as any).mock.calls[0][1]).toBe('DEFAULT'); }); }); describe('useUiSetting$', () => { const TestConsumerX: React.FC<{ setting: string; newValue?: string; }> = ({ setting, newValue = '' }) => { const [value, set] = useUiSetting$(setting, 'DEFAULT'); return (
{setting}: {value}
); }; test('synchronously renders setting value', async () => { const [core] = mock(); const { Provider } = createOpenSearchDashboardsReactContext(core); ReactDOM.render( , container ); const strong = container!.querySelector('strong'); expect(strong!.textContent).toBe('bar'); expect(core.uiSettings!.get).toHaveBeenCalledTimes(1); expect((core.uiSettings!.get as any).mock.calls[0][0]).toBe('foo'); }); test('calls Core with correct arguments', async () => { const core = coreMock.createStart(); const { Provider } = createOpenSearchDashboardsReactContext(core); ReactDOM.render( , container ); expect(core.uiSettings!.get).toHaveBeenCalledWith('non_existing', 'DEFAULT'); }); test('subscribes to observable using useObservable', async () => { const [core, subject] = mock(); const { Provider } = createOpenSearchDashboardsReactContext(core); expect(useObservableSpy).toHaveBeenCalledTimes(0); ReactDOM.render( , container ); expect(useObservableSpy).toHaveBeenCalledTimes(1); expect(useObservableSpy.mock.calls[0][0]).toBe(subject); }); test('can set new hook value', async () => { const [core] = mock(); const { Provider } = createOpenSearchDashboardsReactContext(core); ReactDOM.render( , container ); expect(core.uiSettings!.set).toHaveBeenCalledTimes(0); act(() => { Simulate.click(container!.querySelector('button')!, {}); }); expect(core.uiSettings!.set).toHaveBeenCalledTimes(1); expect(core.uiSettings!.set).toHaveBeenCalledWith('a', 'c'); }); });