Fix misaligned mock eth query types in controller tests

[MajorLift]

Explanation

Fixes // @ts-expect-error Mock eth query does not fulfill type requirements annotations throughout core repo.

References

• Builds upon
  • Align types with @metamask/eth-json-rpc-provider eth-query#21
  • Align NetworkController provider type w/ eth-query #2028
• Related Fix provider type errors in NetworkController and its downstream packages #1823
• Closes Fix misaligned mock eth query types in controller tests #2036

Changelog

N/A

Checklist

• I've updated the test suite for new or updated code as appropriate
• I've updated documentation (JSDoc, Markdown, etc.) for new or updated code as appropriate
• I've highlighted breaking changes using the "BREAKING" category above as appropriate

[mcmire]

These tests aren't set up very well :( I'm curious whether jest.mock would be a better approach to mock eth-query rather than making fake versions. That would be a bigger refactor though, so for now I've tried to suggest changes that I hope wouldn't take too long to resolve.

[mcmire]

Hmm. Now that we have a fake provider, I'm wondering if a better way to achieve this without the type assertion would be something like this:

Suggested change

	class MockEthQuery extends EthQuery {
	getBlockByHash(blockId: any, cb: any) {
	cb(null, { id: blockId });
	}
	}
	// @ts-expect-error Mock eth query does not fulfill type requirements
	const result = await util.query(new EthQuery(), 'getBlockByHash', [
	'0x1234',
	]);
	const result = await util.query(
	new MockEthQuery({} as Provider),
	const ethQuery = new EthQuery(new FakeProvider());
	jest.spyOn(ethQuery, 'getBlockByHash').mockResolvedValue({ id: '0x1234' });
	const result = await util.query(
	ethQuery,

(We'll have to import FakeProvider at the top of course)

[MajorLift]

Is this the FakeProvider in network-controller? I'm getting this error:

error TS2345: Argument of type 'FakeProvider' is not assignable to parameter of type 'Provider'.

It's also currently not exported from network-controller so ideally we'd need to create a new release to add the export.

[MajorLift]

Here's my attempt at applying FakeProvider: 0a03684
Errors: https://github.com/MetaMask/core/actions/runs/6868532345/job/18679337496?pr=2037

[mcmire]

I had thought that FakeProvider was defined at the top level like FakeBlockTracker. We'd have to pull it out to use it like this, so never mind :(

The way you had it is probably fine for now, and we can refactor it later.

[MajorLift]

We could keep this PR open until that's done. FakeProvider seems like a definite improvement over {} as Provider.

[mcmire]

Okay, new PR created here: #2039

[MajorLift]

Didn't realize it would be that simple.😅 Just added a review.

[mcmire]

I've merged #2039 so these changes should now work.

[MajorLift]

Fixed all of the mock eth queries to use FakeProvider: 687d3eb

[socket-security]

No dependency changes detected. Learn more about Socket for GitHub ↗︎

👍 No dependency changes detected in pull request

[mcmire]

Looks good!