Return type duplicate infinite amount: | boolean

[rubiesonthesky]

🐛 Bug Report

• TypeStat version: 0.7.3
• TypeScript version: 4.9.5
• Node version: 20.11

Actual Behavior

declare function navigateByUrl(url: string): Promise<boolean>;

export class exampleDirective {
  async navigateTo(id: number): Promise<boolean> | boolean | boolean | boolean | boolean | boolean {
    return await navigateByUrl(`/page/${id}`);
  }
}

Expected Behavior

There is no need to change this the return type. This is async function and Promise<boolean> should cover that. But also, it should not add boolean infinite amount to return types union.

declare function navigateByUrl(url: string): Promise<boolean>;

export class exampleDirective {
  async navigateTo(id: number): Promise<boolean> {
    return await navigateByUrl(`/page/${id}`);
  }
}

Reproduction

Original code

declare function navigateByUrl(url: string): Promise<boolean>;

export class exampleDirective {
  async navigateTo(id: number): Promise<boolean> {
    return await navigateByUrl(`/page/${id}`);
  }
}

---

I cloned this repo and added this test case to test/cases/fixes/incompleteTypes/returnTypes/original.ts file, and I can see same behavior there.

    function navigateByUrl(url: string): Promise<boolean>;

    async function navigateTo(id: number): Promise<boolean> {
        return await navigateByUrl(`/page/${id}`);
    }

After using command yarn run test:mutation --accept, I see this in excepted.ts and actual.ts:

    function navigateByUrl(url: string): Promise<boolean>;

    async function navigateTo(id: number): Promise<boolean> | boolean | boolean | boolean | boolean | boolean | boolean | boolean | boolean | boolean | boolean | boolean | boolean | boolean | boolean | boolean | boolean | boolean | boolean | boolean | boolean {
        return await navigateByUrl(`/page/${id}`);
    }

[JoshuaKGoldberg]

@all-contributors please add @rubiesonthesky for bug.

🤖 Beep boop! This comment was added automatically by all-contributors-auto-action.
Not all contributions can be detected from Git & GitHub alone. Please comment any missing contribution types this bot missed.
...and of course, thank you for contributing! 💙

[allcontributors]

@JoshuaKGoldberg

I've put up a pull request to add @rubiesonthesky! 🎉

I couldn't determine any contributions to add, did you specify any contributions?
Please make sure to use valid contribution names.

[rubiesonthesky]

This problem comes from react type fixes!

I did two changes that fix this problem.

In fillOutRawOptions, I set hints.react.propTypes to ReactPropTypesHint.Ignore if rawOptions.hints?.react?.propTypes is not set.

Then, in fixIncompleteReturnTypes, I set the function to return empty array, if request.options.hints.react.propTypes is ReactPropTypesHint.Ignore. This will skip all react related checkings.

I think it would be better default option to not assume that project uses React, if that is not otherwise gathered. For example, project should have React installed or jsx: react set in tsconfig.

edit: Now I lost it... it was working for a second. 🤯

---

edit: Yeah, no. That did not help really. But here are some test cases

	function navigateByUrl(url: string): Promise<boolean>;
        // this mutates to infinite "| boolean"
	async function navigateTo(): Promise<boolean> {
		return await navigateByUrl("");
	}
        // this mutates to infinite "| boolean"
	async function navigateTo2(): Promise<boolean> {
		const navigated = await navigateByUrl("");
		return navigated;
	}
        // this stays same
	async function returnSame(): Promise<boolean> {
		return navigateByUrl("");
	}
        // this stays same
	async function returnPromise(): Promise<string> {
		return Promise.resolve("");
	}