Skip to content

[Enterprise Search] Add Kea test helper for directly accessing listeners #89061

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Jan 25, 2021
Merged

[Enterprise Search] Add Kea test helper for directly accessing listeners #89061

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
b9a5a15
Add getListeners to Kea test helpers
cee-chen Jan 22, 2021
f18af00
Update TelemetryLogic to use new getListeners helper
cee-chen Jan 22, 2021
2ac2774
Merge branch 'master' into kea-get-listeners-helper
kibanamachine Jan 25, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 25 additions & 0 deletions x-pack/plugins/enterprise_search/public/applications/__mocks__/kea.mock.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -120,4 +120,29 @@ export class LogicMounter {
public unmount = () => {
this.unmountFn();
};

/**
* Some tests (e.g. async tests, tests that expect thrown errors) need to access
* listener functions directly instead of calling `SomeLogic.actions.someListener`,
* due to how Kea invokes/wraps action fns by design.
*
* Example usage:
*
* const { mount, getListeners } = new LogicMounter(SomeLogic);
*
* it('some test', async () => {
* mount();
* const { someListener } = getListeners({ values: { someMockValue: false } });
*
* const mockBreakpoint = jest.fn();
* await someListener({ someMockArgument: true }, mockBreakpoint);
* });
*/
public getListeners = (listenersArgs: object = {}) => {
const { listeners } = this.logicFile.inputs[0];

return typeof listeners === 'function'
? (listeners as Function)(listenersArgs) // e.g., listeners({ values, actions, props }) => ({ ... })
: listeners; // handles simpler logic files that just define listeners: { ... }
};
}
16 changes: 5 additions & 11 deletions ...ck/plugins/enterprise_search/public/applications/shared/telemetry/telemetry_logic.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,20 +4,18 @@
* you may not use this file except in compliance with the Elastic License.
*/

import { resetContext } from 'kea';

import { JSON_HEADER as headers } from '../../../../common/constants';
import { mockHttpValues } from '../../__mocks__/http_logic.mock';
import { LogicMounter, mockHttpValues } from '../../__mocks__';

import { TelemetryLogic } from './';
import { TelemetryLogic } from './telemetry_logic';

describe('Telemetry logic', () => {
const { mount, getListeners } = new LogicMounter(TelemetryLogic);
const { http } = mockHttpValues;

beforeEach(() => {
jest.clearAllMocks();
resetContext({});
TelemetryLogic.mount();
mount();
});

describe('sendTelemetry', () => {
Expand All @@ -36,11 +34,7 @@ describe('Telemetry logic', () => {

it('throws an error if the telemetry endpoint fails', async () => {
http.put.mockImplementationOnce(() => Promise.reject());

// To capture thrown errors, we have to call the listener fn directly
// instead of using `TelemetryLogic.actions.sendTelemetry` - this is
// due to how Kea invokes/wraps action fns by design.
const { sendTelemetry } = (TelemetryLogic.inputs[0] as any).listeners({ actions: {} });
const { sendTelemetry } = getListeners();

await expect(sendTelemetry({ action: '', metric: '', product: '' })).rejects.toThrow(
'Unable to send telemetry'
Expand Down