taipy/tests/gui/server/ws/test_with.py

# Copyright 2021-2025 Avaiga Private Limited
#
# Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with
# the License. You may obtain a copy of the License at
#
#        http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on
# an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the
# specific language governing permissions and limitations under the License.

import inspect

import pytest

from taipy.gui import Gui, Markdown
from taipy.gui.data.data_scope import _DataScopes
from taipy.gui.servers.request import RequestAccessor


@pytest.mark.skip_if_not_server("flask")
def test_sending_messages_in_group(gui: Gui, helpers):
    name = "World!"  # noqa: F841
    btn_id = "button1"  # noqa: F841

    # set gui frame
    gui._set_frame(inspect.currentframe())

    gui.add_page("test", Markdown("<|Hello {name}|button|id={btn_id}|>"))
    gui.run(run_server=False, single_client=True)
    server_client = gui._server.test_client()
    # WS client and emit
    ws_client = gui._server._ws.test_client(gui._server.get_server_instance())
    cid = _DataScopes._GLOBAL_ID
    # Get the jsx once so that the page will be evaluated -> variable will be registered
    server_client.get(f"/taipy-jsx/test?client_id={cid}")
    assert gui._bindings()._get_all_scopes()[cid].name == "World!"  # type: ignore
    assert gui._bindings()._get_all_scopes()[cid].btn_id == "button1"  # type: ignore

    with gui._server.test_request_context(f"/taipy-jsx/test/?client_id={cid}", data={"client_id": cid}):
        with gui as aGui:
            aGui._Gui__state.name = "Monde!"
            aGui._Gui__state.btn_id = "button2"

    assert gui._bindings()._get_all_scopes()[cid].btn_id == "button2"  # type: ignore
    assert gui._bindings()._get_all_scopes()[cid].name == "Monde!"

    received_messages = ws_client.get_received()
    helpers.assert_outward_ws_multiple_message(received_messages[0], "MS", 2)


@pytest.mark.skip_if_not_server("fastapi")
@pytest.mark.teste2e
def test_sending_messages_in_group_fastapi(gui: Gui, helpers):
    name = "World!"  # noqa: F841
    btn_id = "button1"  # noqa: F841

    # set gui frame
    gui._set_frame(inspect.currentframe())

    gui.add_page("test", Markdown("<|Hello {name}|button|id={btn_id}|>"))
    helpers.run_e2e(gui)
    ws_client = helpers.get_socketio_test_client()
    RequestAccessor.set_sid(ws_client.get_sid())
    cid = _DataScopes._GLOBAL_ID
    ws_client.get(f"/taipy-jsx/test?client_id={cid}")
    try:
        assert gui._bindings()._get_all_scopes()[cid].name == "World!"  # type: ignore
        assert gui._bindings()._get_all_scopes()[cid].btn_id == "button1"  # type: ignore

        with gui._server.test_request_context(f"/taipy-jsx/test/?client_id={cid}", data={"client_id": cid}):
            with gui as aGui:
                aGui._Gui__state.name = "Monde!"
                aGui._Gui__state.btn_id = "button2"

        assert gui._bindings()._get_all_scopes()[cid].btn_id == "button2"  # type: ignore
        assert gui._bindings()._get_all_scopes()[cid].name == "Monde!"

        received_messages = ws_client.get_received()
        helpers.assert_outward_ws_multiple_message(received_messages[0], "MS", 2)
    finally:
        ws_client.disconnect()