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.

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

Refactoring: Remove type assertions in remaining components #642

Merged
merged 1 commit into from
Apr 17, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
20 changes: 16 additions & 4 deletions services/frontend-service/src/setupTests.ts
Original file line number Diff line number Diff line change
Expand Up @@ -22,21 +22,33 @@ global.nextTick = (): Promise<void> => new Promise((resolve) => setTimeout(resol
export const documentQuerySelectorSafe = (selectors: string): HTMLElement => {
const result = document.querySelector(selectors);
if (!result) {
throw new Error('did not find in selector in document ' + selectors);
throw new Error('documentQuerySelectorSafe: did not find in selector in document ' + selectors);
}
if (!(result instanceof HTMLElement)) {
throw new Error('did find element in selector but it is not an html element: ' + selectors);
throw new Error(
'documentQuerySelectorSafe: did find element in selector but it is not an html element: ' + selectors
);
}
return result;
};

export const elementQuerySelectorSafe = (element: HTMLElement, selectors: string): HTMLElement => {
const result = element.querySelector(selectors);
if (!result) {
throw new Error('did not find in selector in document ' + selectors);
throw new Error('elementQuerySelectorSafe: did not find in selector in document ' + selectors);
}
if (!(result instanceof HTMLElement)) {
throw new Error('did find element in selector but it is not an html element: ' + selectors);
throw new Error(
'elementQuerySelectorSafe: did find element in selector but it is not an html element: ' + selectors
);
}
return result;
};

export const getElementsByClassNameSafe = (element: HTMLElement, selectors: string): HTMLCollectionOf<Element> => {
const result = element.getElementsByClassName(selectors);
if (!result || result.length === 0) {
throw new Error('getElementsByClassNameSafe: did not find in selector in element ' + selectors);
}
return result;
};
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ import {
DisplayLock,
} from '../../utils/store';
import { ActionDetails, ActionTypes, getActionDetails, SideBar } from './SideBar';
import { elementQuerySelectorSafe } from '../../../setupTests';

describe('Show and Hide Sidebar', () => {
interface dataT {
Expand All @@ -44,8 +45,7 @@ describe('Show and Hide Sidebar', () => {
{
name: 'Sidebar is displayed',
expect: (container) => {
// eslint-disable-next-line no-type-assertion/no-type-assertion
const result = container.querySelector('.mdc-show-button')! as HTMLElement;
const result = elementQuerySelectorSafe(container, '.mdc-show-button');
act(() => {
result.click();
});
Expand All @@ -54,7 +54,7 @@ describe('Show and Hide Sidebar', () => {
},
];

const getNode = (overrides?: {}): JSX.Element | any => {
const getNode = (overrides?: {}): JSX.Element => {
// given
const defaultProps: any = {
children: null,
Expand Down Expand Up @@ -145,8 +145,7 @@ describe('Sidebar shows list of actions', () => {
updateActions(testcase.actions);
// when
const { container } = getWrapper({});
// eslint-disable-next-line no-type-assertion/no-type-assertion
const result = container.querySelector('.mdc-show-button')! as HTMLElement;
const result = elementQuerySelectorSafe(container, '.mdc-show-button');
act(() => {
result.click();
});
Expand Down Expand Up @@ -209,8 +208,7 @@ describe('Sidebar test deletebutton', () => {
updateActions(testcase.actions);
// when
const { container } = getWrapper({});
// eslint-disable-next-line no-type-assertion/no-type-assertion
const result = container.querySelector('.mdc-show-button')! as HTMLElement;
const result = elementQuerySelectorSafe(container, '.mdc-show-button');
act(() => {
result.click();
});
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,18 +34,19 @@ export const Snackbar = (): JSX.Element => {

useEffect(() => {
if (show) {
if (!MDComponent.current) {
throw new Error('snackbar: mdcomponent.current not set');
}
// open the snackbar and then set show to false. the snackbar will remain opened 5s
if (status === SnackbarStatus.WARN) {
// Warn is used for connection errors
// when you can't connect, always show a warning
// eslint-disable-next-line no-type-assertion/no-type-assertion
MDComponent.current!.timeoutMs = -1;
MDComponent.current.timeoutMs = -1;
} else {
// snackbar closes after 5s
// eslint-disable-next-line no-type-assertion/no-type-assertion
MDComponent.current!.timeoutMs = 5000;
MDComponent.current.timeoutMs = 5000;
}
MDComponent.current?.open();
MDComponent.current.open();
UpdateSnackbar.set({ show: false });
}
}, [show, status]);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ import { Textfield } from './textfield';
import { render } from '@testing-library/react';
import React from 'react';
import { MemoryRouter } from 'react-router-dom';
import { getElementsByClassNameSafe } from '../../../setupTests';

describe('Textfield', () => {
it('renders correctly using Snapshot', () => {
Expand Down Expand Up @@ -99,8 +100,7 @@ describe('Verify textfield content', () => {
floatingLabel: 'Search',
value: 'test-search',
expect: (container) => {
// eslint-disable-next-line no-type-assertion/no-type-assertion
const input = container.getElementsByClassName('mdc-text-field__input')[0] as HTMLElement;
const input = getElementsByClassNameSafe(container, 'mdc-text-field__input')[0];
input.nodeValue = 'test-search';
return expect(container.getElementsByClassName('mdc-text-field__input')[0]).toHaveDisplayValue(
'test-search'
Expand Down