React renderIntoDocument

Clean Code Report False-positive / False-negative...
1

I am getting several (what I believe to be) false-positives for React unit testing using the renderIntoDocument() function, using SonarQube 7.6.0.21501 and SonarScanner 3.2.0.1227-windows.

it('will render with assign icon ', async () => {
        const document: any = ReactTestUtils.renderIntoDocument(<AssignButtonField {...props} {...reduxProps} />);
        const icon = ReactTestUtils.scryRenderedDOMComponentsWithClass(document, 'fa fa-sign-out-alt');
        expect(icon.length).toEqual(1);
    });

Rule being triggered: typescript:S3699

2

Hi @GreenDavidA,

From its type definition, it looks like renderIntoDocument may return void

export function renderIntoDocument<P>( element: ReactElement<P>): Component<P> | Element | void;

Inside our rule implementation, we are using the TypeScript compiler API to determine what is the return type of renderIntoDocument, so I suspect TypeScript compiler itself is inferring that document may have type void.

I’d suggest to remove the any type declaration, and verify what is the type inferred by the compiler.

Andrea.