Skip to content
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

Jump to bottom

[I18n] Migrate enzyme helpers to TypeScript #25108

Merged
merged 4 commits into from
Nov 6, 2018
+99 −46
Merged

[I18n] Migrate enzyme helpers to TypeScript #25108

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
6e2e97b
[I18n] Migrate enzyme helpers to TypeScript
LeanidShutau Nov 5, 2018
754ed5d
Migrate src enzyme helpers
LeanidShutau Nov 5, 2018
dae50e6
Remove eslint comments
LeanidShutau Nov 5, 2018
cae734d
Resolve comments
LeanidShutau Nov 6, 2018
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
72 changes: 49 additions & 23 deletions src/test_utils/public/enzyme_helpers.js → src/test_utils/public/enzyme_helpers.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,15 +24,20 @@
* intl context around them.
*/

import React from 'react';
import { I18nProvider, intlShape } from '@kbn/i18n/react';
import { mount, shallow, render } from 'enzyme';
import { I18nProvider, InjectedIntl, intlShape } from '@kbn/i18n/react';
import { mount, ReactWrapper, render, shallow } from 'enzyme';
import React, { ReactElement, ValidationMap } from 'react';

// Use fake component to extract `intl` property to use in tests.
const { intl } = mount(<I18nProvider><br /></I18nProvider>)
.find('IntlProvider').instance().getChildContext();
const { intl } = (mount(
<I18nProvider>
<br />
</I18nProvider>
).find('IntlProvider') as ReactWrapper<{}, {}, import('react-intl').IntlProvider>)
.instance()
.getChildContext();

function getOptions(context = {}, childContextTypes = {}, props = []) {
function getOptions(context = {}, childContextTypes: ValidationMap<any> = {}, props = {}) {
return {
context: {
...context,
Expand All @@ -49,8 +54,8 @@ function getOptions(context = {}, childContextTypes = {}, props = []) {
/**
* When using React-Intl `injectIntl` on components, props.intl is required.
*/
function nodeWithIntlProp(node) {
return React.cloneElement(node, { intl });
function nodeWithIntlProp<T>(node: ReactElement<T>): ReactElement<T & { intl: InjectedIntl }> {
return React.cloneElement<any>(node, { intl });
}

/**
Expand All @@ -60,13 +65,20 @@ function nodeWithIntlProp(node) {
* @param options properties to pass into shallow wrapper
* @return The wrapper instance around the rendered output with intl object in context
*/
export function shallowWithIntl(node, { context, childContextTypes, ...props } = {}) {
export function shallowWithIntl<T>(
node: ReactElement<T>,
{
context,
childContextTypes,
...props
}: {
context?: any;
childContextTypes?: ValidationMap<any>;
} = {}
) {
const options = getOptions(context, childContextTypes, props);

return shallow(
nodeWithIntlProp(node),
options,
);
return shallow(nodeWithIntlProp(node), options);
}

/**
Expand All @@ -76,13 +88,20 @@ export function shallowWithIntl(node, { context, childContextTypes, ...props } =
* @param options properties to pass into mount wrapper
* @return The wrapper instance around the rendered output with intl object in context
*/
export function mountWithIntl(node, { context, childContextTypes, ...props } = {}) {
export function mountWithIntl<T>(
node: ReactElement<T>,
{
context,
childContextTypes,
...props
}: {
context?: any;
childContextTypes?: ValidationMap<any>;
} = {}
) {
const options = getOptions(context, childContextTypes, props);

return mount(
nodeWithIntlProp(node),
options,
);
return mount(nodeWithIntlProp(node), options);
}

/**
Expand All @@ -92,11 +111,18 @@ export function mountWithIntl(node, { context, childContextTypes, ...props } = {
* @param options properties to pass into render wrapper
* @return The wrapper instance around the rendered output with intl object in context
*/
export function renderWithIntl(node, { context, childContextTypes, ...props } = {}) {
export function renderWithIntl<T>(
node: ReactElement<T>,
{
context,
childContextTypes,
...props
}: {
context?: any;
childContextTypes?: ValidationMap<any>;
} = {}
) {
const options = getOptions(context, childContextTypes, props);

return render(
nodeWithIntlProp(node),
options,
);
return render(nodeWithIntlProp(node), options);
}
72 changes: 49 additions & 23 deletions x-pack/test_utils/enzyme_helpers.js → x-pack/test_utils/enzyme_helpers.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,15 +11,20 @@
* intl context around them.
*/

import React from 'react';
import { I18nProvider, intlShape } from '@kbn/i18n/react';
import { mount, shallow, render } from 'enzyme'; // eslint-disable-line import/no-extraneous-dependencies
import { I18nProvider, InjectedIntl, intlShape } from '@kbn/i18n/react';
LeanidShutau marked this conversation as resolved.
Show resolved Hide resolved
import { mount, ReactWrapper, render, shallow } from 'enzyme';
import React, { ReactElement, ValidationMap } from 'react';

// Use fake component to extract `intl` property to use in tests.
const { intl } = mount(<I18nProvider><br /></I18nProvider>)
.find('IntlProvider').instance().getChildContext();
const { intl } = (mount(
<I18nProvider>
<br />
</I18nProvider>
).find('IntlProvider') as ReactWrapper<{}, {}, import('react-intl').IntlProvider>)
.instance()
.getChildContext();

function getOptions(context = {}, childContextTypes = {}, props = []) {
function getOptions(context = {}, childContextTypes = {}, props = {}) {
LeanidShutau marked this conversation as resolved.
Show resolved Hide resolved
return {
context: {
...context,
Expand All @@ -36,8 +41,8 @@ function getOptions(context = {}, childContextTypes = {}, props = []) {
/**
* When using React-Intl `injectIntl` on components, props.intl is required.
*/
function nodeWithIntlProp(node) {
return React.cloneElement(node, { intl });
function nodeWithIntlProp<T>(node: ReactElement<T>): ReactElement<T & { intl: InjectedIntl }> {
return React.cloneElement<any>(node, { intl });
}

/**
Expand All @@ -47,13 +52,20 @@ function nodeWithIntlProp(node) {
* @param options properties to pass into shallow wrapper
* @return The wrapper instance around the rendered output with intl object in context
*/
export function shallowWithIntl(node, { context, childContextTypes, ...props } = {}) {
export function shallowWithIntl<T>(
node: ReactElement<T>,
{
context,
childContextTypes,
...props
}: {
context?: any;
childContextTypes?: ValidationMap<any>;
} = {}
) {
const options = getOptions(context, childContextTypes, props);

return shallow(
nodeWithIntlProp(node),
options,
);
return shallow(nodeWithIntlProp(node), options);
}

/**
Expand All @@ -63,13 +75,20 @@ export function shallowWithIntl(node, { context, childContextTypes, ...props } =
* @param options properties to pass into mount wrapper
* @return The wrapper instance around the rendered output with intl object in context
*/
export function mountWithIntl(node, { context, childContextTypes, ...props } = {}) {
export function mountWithIntl<T>(
node: ReactElement<T>,
{
context,
childContextTypes,
...props
}: {
context?: any;
childContextTypes?: ValidationMap<any>;
} = {}
) {
const options = getOptions(context, childContextTypes, props);

return mount(
nodeWithIntlProp(node),
options,
);
return mount(nodeWithIntlProp(node), options);
}

/**
Expand All @@ -79,11 +98,18 @@ export function mountWithIntl(node, { context, childContextTypes, ...props } = {
* @param options properties to pass into render wrapper
* @return The wrapper instance around the rendered output with intl object in context
*/
export function renderWithIntl(node, { context, childContextTypes, ...props } = {}) {
export function renderWithIntl<T>(
node: ReactElement<T>,
{
context,
childContextTypes,
...props
}: {
context?: any;
childContextTypes?: ValidationMap<any>;
} = {}
) {
const options = getOptions(context, childContextTypes, props);

return render(
nodeWithIntlProp(node),
options,
);
return render(nodeWithIntlProp(node), options);
}
1 change: 1 addition & 0 deletions x-pack/tsconfig.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
"common/**/*",
"server/**/*",
"plugins/**/*",
"test_utils/**/*"
],
"exclude": [
"test/**/*"
Expand Down