Rework `sdk-router` tests

[ChiTimesChi]

A few things to tackle there:

• [ ] Stop using tests with forked chains. These are too unreliable to be run in the CI workflows.
  • The solution probably involves a fair bit of mocking.
  • I don't think spinning up a few anvil instances is actually required there, but that could be a potential approach as well.
• [ ] Increase the scope of the tests.
  • [ ] Get the coverage to that tasty 100%.
  • [ ] Introduce more generic test cases, which don't increase the code coverage per se, but should increase our expectations that everything is working as it should.
• [ ] Make the tests easier to read/write. There's still some code duplication, and I'm quite confident that not all "best TypeScript practices" were followed in the test codebase ;)

[greptile-apps[bot]]

Steps to Rework sdk-router Tests

1. Stop Using Tests with Forked Chains:

   • Replace forked chain tests with mocks.
   • Example: In synapseRouter.test.ts, replace getTestProvider with a mocked provider.

     import { mock } from 'jest-mock-extended';
     const ethProvider = mock<Provider>();

   • Apply similar changes in fastBridgeRouter.test.ts and synapseCCTPRouter.test.ts.

2. Increase Test Coverage:

   • Add tests for untested branches and edge cases.
   • Example: In synapseRouter.test.ts, add tests for error cases in bridge method.

     it('throws error on invalid recipient', async () => {
     await expect(synapseRouter.bridge('', ...)).rejects.toThrow('Invalid recipient');
     });

   • Ensure all methods in synapseRouter.ts, fastBridgeRouter.ts, and synapseCCTPRouter.ts are fully tested.

3. Introduce More Generic Test Cases:

   • Add parameterized tests to cover a wider range of inputs.
   • Example: In query.test.ts, use test.each for applySlippageToQuery.

     test.each([
     [0, 10000, 1000000],
     [50, 10000, 995000],
     [10, 100, 900000],
     ])('applies %i%% slippage', (slippage, denominator, expected) => {
     const newQuery = applySlippageToQuery(query, slippage, denominator);
     expect(newQuery.minAmountOut).toEqual(BigNumber.from(expected));
     });

4. Make Tests Easier to Read/Write:

   • Refactor to remove duplication and follow best TypeScript practices.
   • Example: Extract common setup code into helper functions.

     const createSynapseRouter = () => new SynapseRouter(SupportedChainId.ETH, ethProvider, ethAddress);

   • Apply similar refactoring in fastBridgeRouter.test.ts and synapseCCTPRouter.test.ts.

5. Follow Best TypeScript Practices:

   • Ensure type safety and avoid any type.
   • Example: In ticker.test.ts, use specific types for test data.

     const arbUSDC: ChainToken = { chainId: 42161, token: '0xaf88d065e77c8cC2239327C5EDb3A432268e5831' };

Files to Modify

• /packages/sdk-router/src/router/synapseRouter.test.ts
• /packages/sdk-router/src/rfq/fastBridgeRouter.test.ts
• /packages/sdk-router/src/router/synapseCCTPRouter.test.ts
• /packages/sdk-router/src/module/query.test.ts
• /packages/sdk-router/src/rfq/ticker.test.ts
• /packages/sdk-router/src/rfq/api.integration.test.ts
• /packages/sdk-router/src/rfq/quote.test.ts
• /packages/sdk-router/src/entities/ether.test.ts
• /packages/sdk-router/src/utils/computePriceImpact.test.ts

References

/packages/sdk-router/src/router/synapseRouter.test.ts /packages/sdk-router/src/rfq/fastBridgeRouter.test.ts /packages/sdk-router/src/module/query.test.ts /packages/sdk-router/src/rfq/ticker.test.ts /packages/sdk-router/src/rfq/api.integration.test.ts /packages/sdk-router/src/rfq/quote.test.ts /packages/sdk-router/src/router/synapseCCTPRouter.test.ts /packages/sdk-router/src/entities/ether.test.ts /packages/sdk-router/src/utils/computePriceImpact.test.ts /packages/sdk-router/src/constants /packages/sdk-router/src/router /packages/sdk-router/src/utils

Ask Greptile