時鐘

介紹

精確地模擬時間相關的行為對於驗證應用程式的正確性至關重要。利用 時鐘 功能，開發人員可以在測試中操作和控制時間，從而精確驗證諸如渲染時間、超時、排程任務等功能，而無需實時執行的延遲和變異性。

時鐘 API 提供了以下方法來控制時間

• setFixedTime：為 Date.now() 和 new Date() 設定固定時間。
• install：初始化時鐘，並允許您
  • pauseAt：在特定時間暫停時間。
  • fastForward：快轉時間。
  • runFor：將時間快轉特定持續時間。
  • resume：恢復時間。
• setSystemTime：設定目前的系統時間。

建議的方法是使用 setFixedTime 將時間設定為特定值。如果這不適用於您的用例，您可以使用 install，它允許您稍後暫停時間、快轉時間、滴答計時等。setSystemTime 僅建議用於進階用例。

注意

page.clock 會覆蓋與時間相關的原生全域類別和函式，允許手動控制它們

• Date
• setTimeout
• clearTimeout
• setInterval
• clearInterval
• requestAnimationFrame
• cancelAnimationFrame
• requestIdleCallback
• cancelIdleCallback
• performance
• Event.timeStamp

警告

如果您在測試中的任何時候調用 install，則必須在任何其他與時鐘相關的調用之前調用（請參閱上面的註釋以獲取列表）。不按順序調用這些方法將導致未定義的行為。例如，您不能先調用 setInterval，然後調用 install，再調用 clearInterval，因為 install 會覆蓋時鐘函式的原生定義。

使用預定義時間進行測試

通常您只需要偽造 Date.now，同時保持計時器運行。這樣時間就會自然流逝，但 Date.now 始終返回固定值。

<div id="current-time" data-testid="current-time"></div>
<script>
  const renderTime = () => {
    document.getElementById('current-time').textContent =
        new Date().toLocaleString();
  };
  setInterval(renderTime, 1000);
</script>

await page.clock.setFixedTime(new Date('2024-02-02T10:00:00'));
await page.goto('https://127.0.0.1:3333');
await expect(page.getByTestId('current-time')).toHaveText('2/2/2024, 10:00:00 AM');

await page.clock.setFixedTime(new Date('2024-02-02T10:30:00'));
// We know that the page has a timer that updates the time every second.
await expect(page.getByTestId('current-time')).toHaveText('2/2/2024, 10:30:00 AM');

一致的時間和計時器

有時您的計時器依賴於 Date.now，並且當 Date.now 值隨著時間推移不改變時會感到困惑。在這種情況下，您可以安裝時鐘並在測試時快轉到感興趣的時間。

<div id="current-time" data-testid="current-time"></div>
<script>
  const renderTime = () => {
    document.getElementById('current-time').textContent =
        new Date().toLocaleString();
  };
  setInterval(renderTime, 1000);
</script>

// Initialize clock with some time before the test time and let the page load
// naturally. `Date.now` will progress as the timers fire.
await page.clock.install({ time: new Date('2024-02-02T08:00:00') });
await page.goto('https://127.0.0.1:3333');

// Pretend that the user closed the laptop lid and opened it again at 10am,
// Pause the time once reached that point.
await page.clock.pauseAt(new Date('2024-02-02T10:00:00'));

// Assert the page state.
await expect(page.getByTestId('current-time')).toHaveText('2/2/2024, 10:00:00 AM');

// Close the laptop lid again and open it at 10:30am.
await page.clock.fastForward('30:00');
await expect(page.getByTestId('current-time')).toHaveText('2/2/2024, 10:30:00 AM');

測試閒置監控

閒置監控是 Web 應用程式中的常見功能，它會在使用者閒置一段時間後登出使用者。測試此功能可能很棘手，因為您需要等待很長時間才能看到效果。借助時鐘，您可以加速時間並快速測試此功能。

<div id="remaining-time" data-testid="remaining-time"></div>
<script>
  const endTime = Date.now() + 5 * 60_000;
  const renderTime = () => {
    const diffInSeconds = Math.round((endTime - Date.now()) / 1000);
    if (diffInSeconds <= 0) {
      document.getElementById('remaining-time').textContent =
        'You have been logged out due to inactivity.';
    } else {
      document.getElementById('remaining-time').textContent =
        `You will be logged out in ${diffInSeconds} seconds.`;
    }
    setTimeout(renderTime, 1000);
  };
  renderTime();
</script>
<button type="button">Interaction</button>

// Initial time does not matter for the test, so we can pick current time.
await page.clock.install();
await page.goto('https://127.0.0.1:3333');
// Interact with the page
await page.getByRole('button').click();

// Fast forward time 5 minutes as if the user did not do anything.
// Fast forward is like closing the laptop lid and opening it after 5 minutes.
// All the timers due will fire once immediately, as in the real browser.
await page.clock.fastForward('05:00');

// Check that the user was logged out automatically.
await expect(page.getByText('You have been logged out due to inactivity.')).toBeVisible();

手動滴答計時，一致地觸發所有計時器

在極少數情況下，您可能希望手動滴答計時，在此過程中觸發所有計時器和動畫幀，以實現對時間流逝的細粒度控制。

<div id="current-time" data-testid="current-time"></div>
<script>
  const renderTime = () => {
    document.getElementById('current-time').textContent =
        new Date().toLocaleString();
  };
  setInterval(renderTime, 1000);
</script>

// Initialize clock with a specific time, let the page load naturally.
await page.clock.install({ time: new Date('2024-02-02T08:00:00') });
await page.goto('https://127.0.0.1:3333');

// Pause the time flow, stop the timers, you now have manual control
// over the page time.
await page.clock.pauseAt(new Date('2024-02-02T10:00:00'));
await expect(page.getByTestId('current-time')).toHaveText('2/2/2024, 10:00:00 AM');

// Tick through time manually, firing all timers in the process.
// In this case, time will be updated in the screen 2 times.
await page.clock.runFor(2000);
await expect(page.getByTestId('current-time')).toHaveText('2/2/2024, 10:00:02 AM');

相關影片