Class: Playwright::Clock

Inherits:
PlaywrightApi show all
Defined in:
lib/playwright_api/clock.rb,
sig/playwright.rbs

Overview

Accurately simulating time-dependent behavior is essential for verifying the correctness of applications. Learn more about clock emulation.

Note that clock is installed for the entire BrowserContext, so the time in all the pages and iframes is controlled by the same clock.

Instance Method Summary collapse

Methods inherited from PlaywrightApi

#initialize, unwrap, wrap

Constructor Details

This class inherits a constructor from Playwright::PlaywrightApi

Instance Method Details

#fast_forward(ticks) ⇒ void

This method returns an undefined value.

Advance the clock by jumping forward in time. Only fires due timers at most once. This is equivalent to user closing the laptop lid for a while and reopening it later, after given time.

Usage

page.clock.fast_forward(1000)
page.clock.fast_forward("30:00")

Parameters:

  • ticks (Integer, String) 


19
20
21
 
# File 'lib/playwright_api/clock.rb', line 19

def fast_forward(ticks)
  wrap_impl(@impl.fast_forward(unwrap_impl(ticks)))
end

#install(time: nil) ⇒ void

This method returns an undefined value.

Install fake implementations for the following time-related functions:

  • Date
  • setTimeout
  • clearTimeout
  • setInterval
  • clearInterval
  • requestAnimationFrame
  • cancelAnimationFrame
  • requestIdleCallback
  • cancelIdleCallback
  • performance

Fake timers are used to manually control the flow of time in tests. They allow you to advance time, fire timers, and control the behavior of time-dependent functions. See [method: Clock.runFor] and [method: Clock.fastForward] for more information.

Parameters:

  • time: (Float, String, Time) (defaults to: nil) 


37
38
39
 
# File 'lib/playwright_api/clock.rb', line 37

def install(time: nil)
  wrap_impl(@impl.install(time: unwrap_impl(time)))
end

#pause_at(time) ⇒ void

This method returns an undefined value.

Advance the clock by jumping forward in time and pause the time. Once this method is called, no timers are fired unless [method: Clock.runFor], [method: Clock.fastForward], [method: Clock.pauseAt] or [method: Clock.resume] is called.

Only fires due timers at most once. This is equivalent to user closing the laptop lid for a while and reopening it at the specified time and pausing.

Usage

page.clock.pause_at(datetime.datetime(2020, 2, 2))
page.clock.pause_at("2020-02-02")

For best results, install the clock before navigating the page and set it to a time slightly before the intended test time. This ensures that all timers run normally during page loading, preventing the page from getting stuck. Once the page has fully loaded, you can safely use [method: Clock.pauseAt] to pause the clock.

# Initialize clock with some time before the test time and let the page load
# naturally. `Date.now` will progress as the timers fire.
page.clock.install(time=datetime.datetime(2024, 12, 10, 8, 0, 0))
page.goto("http://localhost:3333")
page.clock.pause_at(datetime.datetime(2024, 12, 10, 10, 0, 0))

Parameters:

  • time (Float, String, Time) 


78
79
80
 
# File 'lib/playwright_api/clock.rb', line 78

def pause_at(time)
  wrap_impl(@impl.pause_at(unwrap_impl(time)))
end

#resume ⇒ void

This method returns an undefined value.

Resumes timers. Once this method is called, time resumes flowing, timers are fired as usual.



84
85
86
 
# File 'lib/playwright_api/clock.rb', line 84

def resume
  wrap_impl(@impl.resume)
end

#run_for(ticks) ⇒ void

This method returns an undefined value.

Advance the clock, firing all the time-related callbacks.

Usage

page.clock.run_for(1000);
page.clock.run_for("30:00")

Parameters:

  • ticks (Integer, String) 


50
51
52
 
# File 'lib/playwright_api/clock.rb', line 50

def run_for(ticks)
  wrap_impl(@impl.run_for(unwrap_impl(ticks)))
end

#set_fixed_time(time) ⇒ void Also known as: fixed_time=

This method returns an undefined value.

Makes Date.now and new Date() return fixed fake time at all times, keeps all the timers running.

Use this method for simple scenarios where you only need to test with a predefined time. For more advanced scenarios, use [method: Clock.install] instead. Read docs on clock emulation to learn more.

Usage

page.clock.set_fixed_time(datetime.datetime.now())
page.clock.set_fixed_time(datetime.datetime(2020, 2, 2))
page.clock.set_fixed_time("2020-02-02")

Parameters:

  • time (Float, String, Time) 


101
102
103
 
# File 'lib/playwright_api/clock.rb', line 101

def set_fixed_time(time)
  wrap_impl(@impl.set_fixed_time(unwrap_impl(time)))
end

#set_system_time(time) ⇒ void Also known as: system_time=

This method returns an undefined value.

Sets system time, but does not trigger any timers. Use this to test how the web page reacts to a time shift, for example switching from summer to winter time, or changing time zones.

Usage

page.clock.set_system_time(datetime.datetime.now())
page.clock.set_system_time(datetime.datetime(2020, 2, 2))
page.clock.set_system_time("2020-02-02")

Parameters:

  • time (Float, String, Time) 


116
117
118
 
# File 'lib/playwright_api/clock.rb', line 116

def set_system_time(time)
  wrap_impl(@impl.set_system_time(unwrap_impl(time)))
end