Refactor options to const #1044
Commits on Sep 21, 2023
-
Add a WaitForEventOptions type
This is where the options or predicate function will be parsed. This aligns with how we're parsing options in other APIs.
-
Add the implementation to parse the options
This copies the parsing logic from the existing browserContext.waitFor Event() into the new WaitForEventOptions type's parse method. It also modifies it so that the data that is parsed is updated in the type and during parsing it will return an error instead of panicking.
-
Refactor WaitForEvent to work with its parser
This commit refactors the code so that it works with the new WaitForEventOptions type.
-
Fix browserContext.waitForEvent's timeout
This now defaults to the browserContext's default timeout. This should fix the confusion of mixing seconds and milliseconds when working with the timeouts in this API. NOTE though that there is a default timeout of 30 seconds now, whereas in PW there is no timeout unless one is set explicitly in browserContext using SetDefaultTimeout.
-
Update waitForEvent to clarify page support
At the moment we only support working with the new page creation event (i.e. "page" event) when waitForEvent is used. This commit helps clarify this to users.
-
Update messaging around the other cases
When working with waitForEvent we now notify the user if the timeout was reached, or whether the context is closed (i.e. the test iteration has ended).
-
Refactor waitForEvent to work with errors
Instead of panicking when an error occurs, this commit refactors waitForEvent to return an error back to the mapping layer where it can do what it needs with the error.
-
Fix parsing of waitForEvent options
This new way of working allows us to test the code with integration tests, and it still works as expected when we run the API through a test script. Before it seemed overly complex to try to create a goja object that required reflection.
-
Update to allow nil predicate function
It's valid for a user not to pass anything but the event. A change needed to be made to allow for a nil predicate to allow for this.
-
Refactor duplicate code into defer
When a return occurs from runWaitForEventHandler it needs to perform the same steps for all returns out of the method. This refactors those duplicate steps into a defer function.
-
Update mapping to promisify waitForEvent
waitForEvent is useless without it being promisified. This changes that so that waitForEvent returns a promise, allowing the user to set a waitForEvent and then call further APIs which will unblock the waitForEvent when possible (only for new page creations and if the predicate function is set and returns a truthy value).
-
-
-
-
Add a new waitForEventType type
This helps make things more maintainable and reduces the risk of typos when working with the event types for waitForEvent. Co-authored-by: İnanç Gümüş <inanc.gumus@grafana.com>
-
Refactor error message for incorrect event
Co-authored-by: İnanç Gümüş <inanc.gumus@grafana.com>
-
Update log message with correct method name
Co-authored-by: İnanç Gümüş <inanc.gumus@grafana.com>
-
This helps tidy up the code and keeps the happy path more left aligned. Co-authored-by: İnanç Gümüş <inanc.gumus@grafana.com>
-
-
-
Refactor to early exit if opts doesn't exist
Co-authored-by: İnanç Gümüş <inanc.gumus@grafana.com>
-
Refactor comments to align with 80 chars line len
This just helps make the line lengths of comments consistent.
-
Refactor test names to be less verbose
This not only use a more concise naming convention it also adds '_' to the names, which makes it easier to find tests if they fail. Co-authored-by: İnanç Gümüş <inanc.gumus@grafana.com>
-
-
Add a const for the timeout option
This will help avoid typo issues and make the code more maintainable.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
