Closed
Description
Below is a state table of our current public APIs. Notably, start() and startBuffering() will throw if replay is already started and flush() is a no-op if replay is currently inactive.
We should change to not throw, and instead use a debug level log if replay has already been started. We want to warn users when they do this, but not throw errors since nothing will break as it can be a no-op when this happens.
Additionally, flush() should start a session replay if it is called when replay is not enabled because if they call flush() we can assume they want a replay.
Current behavior
| Stopped | Started (session) | Started (buffering) | |
|---|---|---|---|
start() |
Start session recording | throws ("already in progress") | throws ("buffering in progress") |
startBuffering() |
Start buffering | throws ("already in progress") | throws ("already in progress") |
flush() |
noop | Flushes the current segment immediately | Flushes buffered replay immediately + changes to "session" type |
stop() |
noop | Stops recording + forces a flush + clears session | Stops buffering + clears session |
Proposed behavior
| Stopped | Started (session) | Started (buffering) | |
|---|---|---|---|
start() |
Start session recording | debug log ("already in progress") | debug log ("buffering in progress") |
startBuffering() |
Start buffering | debug log ("already in progress") | debug log ("already in progress") |
flush() |
Start session recording | Flushes the current segment immediately | Flushes buffered replay immediately + changes to "session" type |
stop() |
noop | Stops recording + forces a flush + clears session | Stops buffering + clears session |