Luce packages
LuceLuce BaseLuciaOS

dymokomi/luce-browser-engine

Source of release 0.6.0

0.6.0 / src / web / html / tests_toggle_event.lucb

#==============================================================================================
#
#   tests_toggle_event - ToggleEvent and the details toggle event task (P1 polish)
#
#   DESCRIPTION:
#       Ladybird tests ToggleEvent through Tests/LibWeb/Text (script), so these pin the C++:
#       ToggleEvent::create (a trusted Event with the init's states and source, the source
#       retargeted against the current target) and the details element's toggle task, which
#       Layout/input/details-open.html reaches: opening queues a task that fires a ToggleEvent
#       from "closed" to "open" at the element; toggling again before it runs replaces the task
#       and keeps the first old state. The helpers are tests_html_elements_2's and
#       tests_scenarios'.
#
#==============================================================================================

# mark: Helpers =================================================================================

## What a recording toggle listener saw: the number of calls and the last event's states.
struct TestToggleSeen:
    var calls: i32
    var event_type: ak.FlyString
    var old_state: ak.String
    var new_state: ak.String

## A native listener behaviour recording the ToggleEvent it gets into a TestToggleSeen.
func test_toggle_listener_call(context: void*?, vm: Vm*) -> JsValue!:
    let seen = (TestToggleSeen*)(context else trap("no captures"))
    let event = as_html_toggle_event((gc.Cell*)js_value_as_object(vm_argument(vm, 0)))
    seen.calls += 1
    seen.event_type = dom_event_type(event.dom_event())
    seen.old_state = html_toggle_event_old_state(event)
    seen.new_state = html_toggle_event_new_state(event)
    return js_undefined()

## An IDLEventListener over a native function recording into `seen`.
func test_toggle_listener(realm: Realm*, seen: TestToggleSeen*) -> DomIdlEventListener*:
    let function = js_native_function_create(realm, JsNativeFunctionBehaviour(call = test_toggle_listener_call, context = seen), 1, ak.utf16_fly_string_new(), realm)
    let callback = realm_create_idl_callback_type_realm(realm, (JsObject*)function, realm, IdlOperationReturnsPromise.no)
    return dom_idl_event_listener_create(realm, callback)

# mark: ToggleEvent =============================================================================

test "ToggleEvent::create: a trusted Event with its states; the source is retargeted":
    let (vm, realm, document) = test_elements_setup()
    defer web_test_destroy_vm(vm)
    let allocator: memory.Allocator = vm_heap(vm)
    with allocator:
        let source = test_elements_create(document, "button")
        var init = HtmlToggleEventInit()
        init.old_state = ak.string_from_str("closed")
        init.new_state = ak.string_from_str("open")
        init.source = source
        let event = html_toggle_event_create(realm, ak.fly_string_from_str("toggle"), init)
        assert(is_dom_event(event) and is_html_toggle_event(event) and not is_dom_custom_event(event))
        assert(dom_event_is_trusted(event.dom_event()))
        assert(not dom_event_bubbles(event.dom_event()) and not dom_event_cancelable(event.dom_event()))
        assert(test_fly_is(dom_event_type(event.dom_event()), "toggle"))
        assert(test_structure_is(html_toggle_event_old_state(event), "closed"))
        assert(test_structure_is(html_toggle_event_new_state(event), "open"))
        # No current target: retargeting returns the source itself.
        assert(html_toggle_event_source(event) == source)

        # The defaults: empty states, no source; construct_impl is create.
        let plain = html_toggle_event_construct_impl(realm, ak.fly_string_from_str("beforetoggle"), HtmlToggleEventInit(event_init = DomEventInit(cancelable = true))) else trap("construct_impl")
        assert(dom_event_cancelable(plain.dom_event()) and dom_event_is_trusted(plain.dom_event()))
        assert(test_structure_is(html_toggle_event_old_state(plain), "") and html_toggle_event_source(plain) == none)
        # A plain Event is not a ToggleEvent.
        assert(not is_html_toggle_event(dom_event_create(realm, ak.fly_string_from_str("toggle"))))

# mark: The details toggle task =================================================================

test "details: opening queues a task that fires a ToggleEvent from closed to open":
    let (vm, realm, document) = test_elements_setup()
    defer web_test_destroy_vm(vm)
    let allocator: memory.Allocator = vm_heap(vm)
    with allocator:
        let details = as_html_details_element(test_elements_create(document, "details"))
        var seen = TestToggleSeen()
        dom_event_target_add_event_listener(details.dom_event_target(), html_event_names_toggle, test_toggle_listener(realm, &seen), test_add_options())
        let queue = html_event_loop_task_queue(html_main_thread_event_loop())

        test_elements_set(details.dom_element(), html_attribute_names_open, "")
        let tracker = details.m_details_toggle_task_tracker else trap("a toggle task tracker")
        assert(test_structure_is(tracker.old_state, "closed"))
        let task = html_task_queue_last_added_task(queue) else trap("a queued task")
        assert(seen.calls == 0)
        html_task_execute(task)
        assert(seen.calls == 1 and test_fly_is(seen.event_type, "toggle"))
        assert(test_structure_is(seen.old_state, "closed") and test_structure_is(seen.new_state, "open"))
        assert(details.m_details_toggle_task_tracker == none)

        # Closing and reopening before the task runs: the second task replaces the first and keeps
        # the first old state ("open" to "open").
        dom_element_remove_attribute(details.dom_element(), html_attribute_names_open)
        test_elements_set(details.dom_element(), html_attribute_names_open, "")
        let replacement = html_task_queue_last_added_task(queue) else trap("a queued task")
        html_task_execute(replacement)
        assert(seen.calls == 2)
        assert(test_structure_is(seen.old_state, "open") and test_structure_is(seen.new_state, "open"))