Add test for checking WebAuthn signal apis are called

Author: Stormheg

tests/e2e/test_webauthn_signals.py

@@ -0,0 +1,69 @@
+import pytest
+from playwright.sync_api import expect
+
+from tests.factories import WebAuthnCredentialFactory
+
+
+def test_webauthn_signals_triggered(
+    live_server,
+    django_db_serialized_rollback,
+    page,
+    playwright_force_login,
+    playwright_manipulate_session,
+    user,
+    wait_for_console_message,
+):
+    """Verify the ``PublicKeyCredential.signalCurrentUserDetails`` and
+    ``PublicKeyCredential.signalAllAcceptedCredentials`` browser signals are
+    triggered.
+    """
+
+    playwright_force_login(user)
+    playwright_manipulate_session(
+        lambda session: session.update({"otp_webauthn_sync_needed": True})
+    )
+
+    # Create some credentials for the user
+    WebAuthnCredentialFactory(user=user)
+    WebAuthnCredentialFactory(user=user)
+
+    # Set up signal waiters
+    await_signal_accepted_credentials = wait_for_console_message(
+        r"Signaled accepted credentials to the browser."
+    )
+    await_signal_user_details = wait_for_console_message(
+        r"Signaled current user details to the browser."
+    )
+
+    page.goto(live_server.url)
+
+    # Double check that PublicKeyCredential.signalCurrentUserDetails and
+    # PublicKeyCredential.signalAllAcceptedCredentials apis are available in this browser
+    # otherwise the result won't be meaningful.
+    if not page.evaluate("() => 'signalCurrentUserDetails' in PublicKeyCredential"):
+        pytest.skip(
+            "PublicKeyCredential.signalCurrentUserDetails does not exist in this browser, cannot test this feature!",
+        )
+    if not page.evaluate("() => 'signalAllAcceptedCredentials' in PublicKeyCredential"):
+        pytest.skip(
+            "PublicKeyCredential.signalAllAcceptedCredentials does not exist in this browser, cannot test this feature!",
+        )
+
+    # Wait for the signals to be sent
+    try:
+        await_signal_accepted_credentials()
+    except TimeoutError:
+        pytest.fail(
+            "sync_signals.ts did not post console message indicating PublicKeyCredential.signalAllAcceptedCredentials was called."
+        )
+    try:
+        await_signal_user_details()
+    except TimeoutError:
+        pytest.fail(
+            "sync_signals.ts did not post console message indicating PublicKeyCredential.signalCurrentUserDetails was called."
+        )
+
+    # Verify that the config script tag has been removed from the DOM
+    expect(page.locator("script[id='otp_webauthn_sync_signals_config']")).to_have_count(
+        0
+    )