Class: Playwright::Tracing
- Inherits:
-
PlaywrightApi
- Object
- PlaywrightApi
- Playwright::Tracing
- Defined in:
- lib/playwright_api/tracing.rb
Overview
API for collecting and saving Playwright traces. Playwright traces can be opened in [Trace Viewer](../trace-viewer.md) after Playwright script runs.
Start recording a trace before performing actions. At the end, stop tracing and save it to a file.
“‘python sync browser = chromium.launch() context = browser.new_context() context.tracing.start(screenshots=True, snapshots=True) page = context.new_page() page.goto(“playwright.dev”) context.tracing.stop(path = “trace.zip”) “`
Instance Method Summary collapse
-
#off(event, callback) ⇒ Object
– inherited from EventEmitter –.
-
#on(event, callback) ⇒ Object
– inherited from EventEmitter –.
-
#once(event, callback) ⇒ Object
– inherited from EventEmitter –.
-
#start(name: nil, screenshots: nil, snapshots: nil, sources: nil, title: nil) ⇒ Object
Start tracing.
-
#start_chunk(name: nil, title: nil) ⇒ Object
Start a new trace chunk.
-
#stop(path: nil) ⇒ Object
Stop tracing.
-
#stop_chunk(path: nil) ⇒ Object
Stop the trace chunk.
Methods inherited from PlaywrightApi
Constructor Details
This class inherits a constructor from Playwright::PlaywrightApi
Instance Method Details
#off(event, callback) ⇒ Object
– inherited from EventEmitter –
81 82 83 |
# File 'lib/playwright_api/tracing.rb', line 81 def off(event, callback) event_emitter_proxy.off(event, callback) end |
#on(event, callback) ⇒ Object
– inherited from EventEmitter –
75 76 77 |
# File 'lib/playwright_api/tracing.rb', line 75 def on(event, callback) event_emitter_proxy.on(event, callback) end |
#once(event, callback) ⇒ Object
– inherited from EventEmitter –
87 88 89 |
# File 'lib/playwright_api/tracing.rb', line 87 def once(event, callback) event_emitter_proxy.once(event, callback) end |
#start(name: nil, screenshots: nil, snapshots: nil, sources: nil, title: nil) ⇒ Object
Start tracing.
Usage
“‘python sync context.tracing.start(screenshots=True, snapshots=True) page = context.new_page() page.goto(“playwright.dev”) context.tracing.stop(path = “trace.zip”) “`
28 29 30 31 32 33 34 35 |
# File 'lib/playwright_api/tracing.rb', line 28 def start( name: nil, screenshots: nil, snapshots: nil, sources: nil, title: nil) wrap_impl(@impl.start(name: unwrap_impl(name), screenshots: unwrap_impl(screenshots), snapshots: unwrap_impl(snapshots), sources: unwrap_impl(sources), title: unwrap_impl(title))) end |
#start_chunk(name: nil, title: nil) ⇒ Object
Start a new trace chunk. If you’d like to record multiple traces on the same ‘BrowserContext`, use [`method: Tracing.start`] once, and then create multiple trace chunks with [`method: Tracing.startChunk`] and [`method: Tracing.stopChunk`].
Usage
“‘python sync context.tracing.start(screenshots=True, snapshots=True) page = context.new_page() page.goto(“playwright.dev”)
context.tracing.start_chunk() page.get_by_text(“Get Started”).click() # Everything between start_chunk and stop_chunk will be recorded in the trace. context.tracing.stop_chunk(path = “trace1.zip”)
context.tracing.start_chunk() page.goto(“example.com”) # Save a second trace file with different actions. context.tracing.stop_chunk(path = “trace2.zip”) “‘
57 58 59 |
# File 'lib/playwright_api/tracing.rb', line 57 def start_chunk(name: nil, title: nil) wrap_impl(@impl.start_chunk(name: unwrap_impl(name), title: unwrap_impl(title))) end |
#stop(path: nil) ⇒ Object
Stop tracing.
63 64 65 |
# File 'lib/playwright_api/tracing.rb', line 63 def stop(path: nil) wrap_impl(@impl.stop(path: unwrap_impl(path))) end |
#stop_chunk(path: nil) ⇒ Object
Stop the trace chunk. See [‘method: Tracing.startChunk`] for more details about multiple trace chunks.
69 70 71 |
# File 'lib/playwright_api/tracing.rb', line 69 def stop_chunk(path: nil) wrap_impl(@impl.stop_chunk(path: unwrap_impl(path))) end |