TanStack Router 单元测试中解决 window.scrollTo 未实现错误

在最新版本的 TanStack Router（v1.98.1 及以上）项目中运行单元测试时，开发者可能会遇到一个常见的控制台错误："Error: Not implemented: window.scrollTo"。虽然测试用例仍然能够通过，但这个错误信息会影响测试输出的整洁性，也可能掩盖其他潜在问题。

问题背景

这个错误源于测试环境中的一个技术限制。TanStack Router 在内部实现了滚动恢复功能，当路由变化时会自动调用 window.scrollTo 方法来恢复页面滚动位置。然而，在测试环境中使用的 jsdom（一个模拟浏览器环境的 JavaScript 实现）并没有完整实现所有浏览器 API，其中就包括 window.scrollTo 方法。

解决方案

解决这个问题的方法是在测试环境中手动模拟 window.scrollTo 方法。以下是几种实现方式：

1. 全局模拟方案

可以在测试设置文件中（如 vitest.setup.ts 或 jest.setup.js）添加以下代码：

Object.defineProperty(window, 'scrollTo', {
  value: () => {},
  writable: true
});

2. 单个测试文件模拟

如果只需要在特定测试文件中解决这个问题，可以在测试文件顶部添加：

beforeEach(() => {
  window.scrollTo = jest.fn();
});

3. 使用测试库的配置

某些测试框架提供了配置选项来预先设置这些模拟。例如在 Vitest 中：

// vitest.config.ts
export default defineConfig({
  test: {
    setupFiles: ['./test-setup.ts']
  }
});

然后在 test-setup.ts 中实现模拟。

技术原理

这个问题的本质是测试环境与浏览器环境的差异。jsdom 作为 Node.js 环境中的浏览器模拟器，出于性能和安全考虑，并没有实现所有浏览器 API。window.scrollTo 就是其中之一，因为它通常涉及实际的视图渲染和布局计算。

TanStack Router 的滚动恢复功能是一个重要的用户体验优化，它会在路由导航时：

1. 记住离开页面时的滚动位置
2. 在返回时恢复该位置
3. 在新页面导航时将页面滚动到顶部

在测试环境中，我们不需要实际的滚动行为，只需要确保这些方法被调用即可，因此简单的空函数模拟就足够了。

最佳实践

1. 建议在项目级别的测试配置中统一处理这类浏览器 API 的模拟，而不是在每个测试文件中重复

2. 对于需要验证滚动行为的特殊情况测试，可以扩展模拟实现来记录调用信息：

const scrollToMock = jest.fn();
window.scrollTo = scrollToMock;

// 在测试中验证
expect(scrollToMock).toHaveBeenCalledWith(0, 0);

3. 保持模拟的简单性，避免在测试中引入复杂的滚动逻辑，这应该属于端到端测试的范畴

通过以上方法，开发者可以消除测试中的干扰信息，同时确保 TanStack Router 的滚动功能在测试中得到适当的验证。