servo_constellation_traits/

from_script_message.rs

/* This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at https://mozilla.org/MPL/2.0/. */

//! Messages send from the ScriptThread to the Constellation.

use std::fmt;
use std::sync::Arc;

use content_security_policy::sandboxing_directive::SandboxingFlagSet;
#[cfg(feature = "devtools")]
use devtools_traits::{DevtoolScriptControlMsg, ScriptToDevtoolsControlMsg};
use embedder_traits::user_contents::UserContentManagerId;
use embedder_traits::{
    AnimationState, FocusSequenceNumber, JSValue, JavaScriptEvaluationError,
    JavaScriptEvaluationId, MediaSessionEvent, ScriptToEmbedderChan, ViewportDetails, WakeLockType,
};
use encoding_rs::Encoding;
use euclid::default::Size2D as UntypedSize2D;
use fonts_traits::SystemFontServiceProxySender;
use http::{HeaderMap, Method};
use malloc_size_of_derive::MallocSizeOf;
use net_traits::policy_container::PolicyContainer;
use net_traits::request::{Destination, InsecureRequestsPolicy, Referrer, RequestBody};
use net_traits::{ReferrerPolicy, ResourceThreads};
use paint_api::CrossProcessPaintApi;
use profile_traits::mem::MemoryReportResult;
use profile_traits::{mem, time as profile_time};
use rustc_hash::FxHashMap;
use serde::{Deserialize, Serialize};
use servo_base::Epoch;
use servo_base::generic_channel::{GenericCallback, GenericReceiver, GenericSender, SendResult};
use servo_base::id::{
    BroadcastChannelRouterId, BrowsingContextId, HistoryStateId, MessagePortId,
    MessagePortRouterId, PipelineId, ScriptEventLoopId, ServiceWorkerId,
    ServiceWorkerRegistrationId, WebViewId, WorkerId,
};
use servo_canvas_traits::canvas::{CanvasId, CanvasMsg};
#[cfg(feature = "webgl")]
use servo_canvas_traits::webgl::WebGLChan;
use servo_url::{ImmutableOrigin, OriginSnapshot, ServoUrl};
use storage_traits::StorageThreads;
use storage_traits::webstorage_thread::WebStorageType;
use strum::IntoStaticStr;
#[cfg(feature = "webgpu")]
use webgpu_traits::{WebGPU, WebGPUAdapterResponse};

use crate::structured_data::{BroadcastChannelMsg, StructuredSerializedData};
use crate::{
    LogEntry, MessagePortMsg, PortMessageTask, PortTransferInfo, SessionHistoryTraversalRequest,
    WindowSizeType,
};

pub type ScriptToConstellationSender =
    GenericSender<(WebViewId, PipelineId, ScriptToConstellationMessage)>;

/// A Script to Constellation channel.
#[derive(Clone, Debug, Deserialize, MallocSizeOf, Serialize)]
pub struct ScriptToConstellationChan {
    /// Sender for communicating with constellation thread.
    pub sender: ScriptToConstellationSender,
    /// Used to identify the origin `WebView` of the message.
    pub webview_id: WebViewId,
    /// Used to identify the origin `Pipeline` of the message.
    pub pipeline_id: PipelineId,
}

impl ScriptToConstellationChan {
    /// Send ScriptMsg and attach the pipeline_id to the message.
    pub fn send(&self, msg: ScriptToConstellationMessage) -> SendResult {
        self.sender.send((self.webview_id, self.pipeline_id, msg))
    }
}

/// The origin where a given load was initiated.
/// Useful for origin checks, for example before evaluation a JS URL.
#[derive(Clone, Debug, Deserialize, Serialize)]
pub enum LoadOrigin {
    /// A load originating in the constellation.
    Constellation,
    /// A load originating in webdriver.
    WebDriver,
    /// A load originating in script.
    Script(OriginSnapshot),
}

/// Messages sent from the service worker manager to the constellation.
#[derive(Debug, Deserialize, Serialize)]
pub enum ServiceWorkerManagerMsg {
    /// <https://w3c.github.io/ServiceWorker/#update-worker-state>
    UpdateWorkerState {
        /// The identity of the service worker.
        worker_id: ServiceWorkerId,
        /// The new state of the service worker.
        state: ServiceWorkerState,
        /// The script url origin.
        origin: ImmutableOrigin,
    },
}

/// <https://w3c.github.io/ServiceWorker/#dfn-state>
/// A service worker has an associated state, which is one of:
#[derive(Clone, Debug, Deserialize, Serialize)]
pub enum ServiceWorkerState {
    /// "parsed".
    /// It is initially "parsed".
    Parsed,
    /// "installing".
    Installing,
    /// "installed".
    Installed,
    /// "activating".
    Activating,
    /// "activated".
    Activated,
    /// "redundant".
    Redundant,
}

/// can be passed to `LoadUrl` to load a page with GET/POST
/// parameters or headers
#[derive(Clone, Debug, Deserialize, Serialize)]
pub struct LoadData {
    /// The origin where the load started.
    pub load_origin: LoadOrigin,
    /// The URL.
    pub url: ServoUrl,
    /// <https://html.spec.whatwg.org/multipage/#concept-document-about-base-url>
    pub about_base_url: Option<ServoUrl>,
    /// The creator pipeline id if this is an about:blank load.
    pub creator_pipeline_id: Option<PipelineId>,
    /// The method.
    #[serde(
        deserialize_with = "::hyper_serde::deserialize",
        serialize_with = "::hyper_serde::serialize"
    )]
    pub method: Method,
    /// The headers.
    #[serde(
        deserialize_with = "::hyper_serde::deserialize",
        serialize_with = "::hyper_serde::serialize"
    )]
    pub headers: HeaderMap,
    /// The data that will be used as the body of the request.
    pub data: Option<RequestBody>,
    /// <https://fetch.spec.whatwg.org/#concept-request-reload-navigation-flag>
    /// A request has an associated reload-navigation flag. Unless stated otherwise, it is unset.
    pub reload_navigation: bool,
    /// <https://fetch.spec.whatwg.org/#concept-request-history-navigation-flag>
    /// A request has an associated history-navigation flag. Unless stated otherwise, it is unset.
    pub history_navigation: bool,
    /// The result of evaluating a javascript scheme url.
    pub js_eval_result: Option<String>,
    /// The referrer.
    pub referrer: Referrer,
    /// The referrer policy.
    pub referrer_policy: ReferrerPolicy,
    /// The policy container.
    pub policy_container: Option<Arc<PolicyContainer>>,

    /// The source to use instead of a network response for a srcdoc document.
    pub srcdoc: String,
    /// The inherited context is Secure, None if not inherited
    pub inherited_secure_context: Option<bool>,
    /// The inherited policy for upgrading insecure requests; None if not inherited.
    pub inherited_insecure_requests_policy: Option<InsecureRequestsPolicy>,
    /// Whether the page's ancestors have potentially trustworthy origin
    pub has_trustworthy_ancestor_origin: bool,
    /// Servo internal: if crash details are present, trigger a crash error page with these details.
    pub crash: Option<String>,
    /// Destination, used for CSP checks
    pub destination: Destination,
    /// The "creation sandboxing flag set" that this Pipeline should use when it is created.
    /// See <https://html.spec.whatwg.org/multipage/#determining-the-creation-sandboxing-flags>.
    pub creation_sandboxing_flag_set: SandboxingFlagSet,
    /// If this is a load operation for an `<iframe>` whose origin is same-origin with its
    /// container documents origin then this is the encoding of the container document.
    pub container_document_encoding: Option<&'static Encoding>,

    /// If this request is for the initial about:blank document.
    pub is_initial_about_blank: bool,
}

impl LoadData {
    /// Create a new `LoadData` object.
    #[expect(clippy::too_many_arguments)]
    pub fn new(
        load_origin: LoadOrigin,
        url: ServoUrl,
        about_base_url: Option<ServoUrl>,
        creator_pipeline_id: Option<PipelineId>,
        referrer: Referrer,
        referrer_policy: ReferrerPolicy,
        inherited_secure_context: Option<bool>,
        inherited_insecure_requests_policy: Option<InsecureRequestsPolicy>,
        has_trustworthy_ancestor_origin: bool,
        creation_sandboxing_flag_set: SandboxingFlagSet,
    ) -> Self {
        Self {
            load_origin,
            url,
            about_base_url,
            creator_pipeline_id,
            method: Method::GET,
            headers: HeaderMap::new(),
            data: None,
            reload_navigation: false,
            history_navigation: false,
            js_eval_result: None,
            referrer,
            referrer_policy,
            policy_container: None,
            srcdoc: String::new(),
            inherited_secure_context,
            crash: None,
            inherited_insecure_requests_policy,
            has_trustworthy_ancestor_origin,
            destination: Destination::Document,
            creation_sandboxing_flag_set,
            container_document_encoding: None,
            is_initial_about_blank: false,
        }
    }

    /// Create a new [`LoadData`] for a completely new top-level `WebView` that isn't created
    /// via APIs like `window.open`. This is for `WebView`s completely unrelated to others.
    pub fn new_for_new_unrelated_webview(url: ServoUrl) -> Self {
        Self::new(
            LoadOrigin::Constellation,
            url,
            None,
            None,
            Referrer::NoReferrer,
            ReferrerPolicy::EmptyString,
            None,
            None,
            false,
            SandboxingFlagSet::empty(),
        )
    }
}

/// <https://html.spec.whatwg.org/multipage/#navigation-supporting-concepts:navigationhistorybehavior>
#[derive(Debug, Default, Deserialize, PartialEq, Serialize)]
pub enum NavigationHistoryBehavior {
    /// The default value, which will be converted very early in the navigate algorithm into "push"
    /// or "replace". Usually it becomes "push", but under certain circumstances it becomes
    /// "replace" instead.
    #[default]
    Auto,
    /// A regular navigation which adds a new session history entry, and will clear the forward
    /// session history.
    Push,
    /// A navigation that will replace the active session history entry.
    Replace,
}

/// Entities required to spawn service workers
#[derive(Clone, Debug, Deserialize, MallocSizeOf, Serialize)]
pub struct ScopeThings {
    /// script resource url
    pub script_url: ServoUrl,
    /// network load origin of the resource
    pub worker_load_origin: WorkerScriptLoadOrigin,
    /// base resources required to create worker global scopes
    pub init: WorkerGlobalScopeInit,
    /// the port to receive devtools message from
    #[cfg(feature = "devtools")]
    pub devtools_chan: Option<GenericCallback<ScriptToDevtoolsControlMsg>>,
    /// service worker id
    #[cfg(feature = "devtools")]
    pub worker_id: WorkerId,
    /// the browsing context id of the page that registered the service worker
    pub browsing_context_id: BrowsingContextId,
    /// the webview id of the page that registered the service worker
    pub webview_id: WebViewId,
}

/// Message that gets passed to service worker scope on postMessage
#[derive(Debug, Deserialize, Serialize)]
pub struct DOMMessage {
    /// The origin of the message
    pub origin: ImmutableOrigin,
    pub pipeline_id: PipelineId,
    /// The payload of the message
    pub data: StructuredSerializedData,
}

/// Channels to allow service worker manager to communicate with constellation and resource thread
#[derive(Deserialize, Serialize)]
pub struct SWManagerSenders {
    /// Sender of messages to the constellation.
    pub constellation_sender: GenericSender<ServiceWorkerManagerMsg>,
    /// [`ResourceThreads`] for initating fetches or using i/o.
    pub resource_threads: ResourceThreads,
    /// [`CrossProcessPaintApi`] for communicating with `Paint`.
    pub paint_api: CrossProcessPaintApi,
    /// The [`SystemFontServiceProxy`] used to communicate with the `SystemFontService`.
    pub system_font_service_sender: SystemFontServiceProxySender,
    /// Sender of messages to the manager.
    pub own_sender: GenericSender<ServiceWorkerMsg>,
    /// Receiver of messages from the constellation.
    pub receiver: GenericReceiver<ServiceWorkerMsg>,
}

/// Messages sent to Service Worker Manager thread
#[derive(Debug, Deserialize, Serialize)]
pub enum ServiceWorkerMsg {
    /// Timeout message sent by active service workers
    Timeout(ServoUrl),
    /// Message sent by constellation to forward to a running service worker
    ForwardDOMMessage(DOMMessage, ServoUrl),
    ForwardWorkerMessage {
        data: StructuredSerializedData,
        url: ServoUrl,
        source: ServiceWorkerId,
        origin: ImmutableOrigin,
    },
    /// <https://w3c.github.io/ServiceWorker/#algorithms>
    HandleAlgorithm(ServiceWorkerAlgorithm),
    SetNetworkOnlineState(bool),
    /// Exit the service worker manager
    Exit,
}

#[derive(Clone, Debug, Deserialize, MallocSizeOf, PartialEq, Serialize)]
/// <https://w3c.github.io/ServiceWorker/#dfn-job-type>
pub enum JobType {
    /// <https://w3c.github.io/ServiceWorker/#register>
    Register,
    /// <https://w3c.github.io/ServiceWorker/#unregister-algorithm>
    Unregister,
    /// <https://w3c.github.io/ServiceWorker/#update-algorithm>
    Update,
}

#[derive(Clone, Debug, Deserialize, MallocSizeOf, Serialize)]
/// The kind of error the job promise should be rejected with.
pub enum JobError {
    /// <https://w3c.github.io/ServiceWorker/#reject-job-promise>
    TypeError,
    /// <https://w3c.github.io/ServiceWorker/#reject-job-promise>
    SecurityError,
}

#[derive(Clone, Debug, Deserialize, MallocSizeOf, Serialize)]
/// Messages sent from Job algorithms steps running in the SW manager,
/// in order to resolve or reject the job promise.
pub enum JobResult {
    /// <https://w3c.github.io/ServiceWorker/#reject-job-promise>
    RejectPromise(JobError),
    /// <https://w3c.github.io/ServiceWorker/#resolve-job-promise>
    ResolvePromise(JobResultValue),
}

#[derive(Clone, Debug, Deserialize, MallocSizeOf, Serialize)]
/// Jobs are resolved with the help of various values.
pub enum JobResultValue {
    Register(ServiceWorkerRegistrationInfo),
    Unregister(bool),
}

/// <https://w3c.github.io/ServiceWorker/#dfn-service-worker-registration>
#[derive(Clone, Debug, Deserialize, MallocSizeOf, Serialize)]
pub struct ServiceWorkerRegistrationInfo {
    /// The Id of the registration.
    pub id: ServiceWorkerRegistrationId,
    /// <https://w3c.github.io/ServiceWorker/#dfn-installing-worker>
    pub installing_worker: Option<ServiceWorkerId>,
    /// <https://w3c.github.io/ServiceWorker/#dfn-waiting-worker>
    pub waiting_worker: Option<ServiceWorkerId>,
    /// <https://w3c.github.io/ServiceWorker/#dfn-active-worker>
    pub active_worker: Option<ServiceWorkerId>,
    /// <https://w3c.github.io/ServiceWorker/#service-worker-registration-storage-key>
    pub storage_key: ImmutableOrigin,
    /// <https://w3c.github.io/ServiceWorker/#dfn-scope-url>
    pub scope_url: ServoUrl,
    /// <https://w3c.github.io/ServiceWorker/#dfn-job-script-url>
    pub script_url: ServoUrl,
}

/// <https://w3c.github.io/ServiceWorker/#algorithms>
#[derive(Debug, Deserialize, Serialize)]
pub enum ServiceWorkerAlgorithm {
    /// <https://w3c.github.io/ServiceWorker/#start-register>
    StartRegister(Job),
    /// <https://w3c.github.io/ServiceWorker/#unregister>
    Unregister(Job),
    /// <https://w3c.github.io/ServiceWorker/#match-service-worker-registration>
    MatchServiceWorkerRegistration {
        storage_key: ImmutableOrigin,
        client_url: ServoUrl,
        result_handler: GenericCallback<ServiceWorkerAlgorithmResult>,
    },
}

/// <https://w3c.github.io/ServiceWorker/#algorithms>
#[allow(clippy::large_enum_variant)]
#[derive(Debug, Deserialize, MallocSizeOf, Serialize)]
pub enum ServiceWorkerAlgorithmResult {
    /// <https://w3c.github.io/ServiceWorker/#resolve-job-promise-algorithm>
    /// <https://w3c.github.io/ServiceWorker/#reject-job-promise-algorithm>
    Job(JobResult),

    /// <https://w3c.github.io/ServiceWorker/#match-service-worker-registration>
    MatchServiceWorkerRegistration(Option<ServiceWorkerRegistrationInfo>),

    /// <https://w3c.github.io/ServiceWorker/#dom-client-postmessage-message-options>
    /// Note: this is not algorithm; re-using algo channel for convenience.
    MessageFromWorker {
        message: StructuredSerializedData,
        source: ServiceWorkerId,
        scope_url: ServoUrl,
        script_url: ServoUrl,
        origin: ImmutableOrigin,
    },
}

#[derive(Clone, Debug, Deserialize, MallocSizeOf, Serialize)]
/// <https://w3c.github.io/ServiceWorker/#dfn-job>
pub struct Job {
    /// <https://w3c.github.io/ServiceWorker/#dfn-job-type>
    pub job_type: JobType,
    /// <https://w3c.github.io/ServiceWorker/#dfn-job-scope-url>
    pub scope_url: ServoUrl,
    /// <https://w3c.github.io/ServiceWorker/#dfn-job-script-url>
    pub script_url: ServoUrl,
    /// <https://w3c.github.io/ServiceWorker/#dfn-job-client>
    pub client: GenericCallback<ServiceWorkerAlgorithmResult>,
    /// <https://w3c.github.io/ServiceWorker/#job-referrer>
    pub referrer: ServoUrl,
    /// Various data needed to process job.
    pub scope_things: Option<ScopeThings>,
    /// <https://w3c.github.io/ServiceWorker/#job-storage-key>
    pub storage_key: ImmutableOrigin,
}

impl Job {
    /// <https://w3c.github.io/ServiceWorker/#create-job-algorithm>
    pub fn create_job(
        job_type: JobType,
        scope_url: ServoUrl,
        script_url: ServoUrl,
        client: GenericCallback<ServiceWorkerAlgorithmResult>,
        referrer: ServoUrl,
        scope_things: Option<ScopeThings>,
        storage_key: ImmutableOrigin,
    ) -> Job {
        Job {
            job_type,
            scope_url,
            script_url,
            client,
            referrer,
            scope_things,
            storage_key,
        }
    }
}

impl PartialEq for Job {
    /// Equality criteria as described in <https://w3c.github.io/ServiceWorker/#dfn-job-equivalent>
    fn eq(&self, other: &Self) -> bool {
        // TODO: match on job type, take worker type and `update_via_cache_mode` into account.
        let same_job = self.job_type == other.job_type;
        if same_job {
            match self.job_type {
                JobType::Register | JobType::Update => {
                    self.scope_url == other.scope_url && self.script_url == other.script_url
                },
                JobType::Unregister => self.scope_url == other.scope_url,
            }
        } else {
            false
        }
    }
}

/// This trait allows creating a `ServiceWorkerManager` without depending on the `script`
/// crate.
pub trait ServiceWorkerManagerFactory {
    /// Create a `ServiceWorkerManager`.
    fn create(sw_senders: SWManagerSenders, origin: ImmutableOrigin);
}

/// Specifies the information required to load an auxiliary browsing context.
#[derive(Debug, Deserialize, Serialize)]
pub struct AuxiliaryWebViewCreationRequest {
    /// Load data containing the url to load
    pub load_data: LoadData,
    /// The webview that caused this request.
    pub opener_webview_id: WebViewId,
    /// The pipeline opener browsing context.
    pub opener_pipeline_id: PipelineId,
    /// Sender for the constellation’s response to our request.
    pub response_sender: GenericSender<Option<AuxiliaryWebViewCreationResponse>>,
}

/// Constellation’s response to auxiliary browsing context creation requests.
#[derive(Debug, Deserialize, Serialize)]
pub struct AuxiliaryWebViewCreationResponse {
    /// The new webview ID.
    pub new_webview_id: WebViewId,
    /// The new pipeline ID.
    pub new_pipeline_id: PipelineId,
    /// The [`UserContentManagerId`] for this new auxiliary browsing context.
    pub user_content_manager_id: Option<UserContentManagerId>,
}

/// Specifies the information required to load an iframe.
#[derive(Debug, Deserialize, Serialize)]
pub struct IFrameLoadInfo {
    /// Pipeline ID of the parent of this iframe
    pub parent_pipeline_id: PipelineId,
    /// The ID for this iframe's nested browsing context.
    pub browsing_context_id: BrowsingContextId,
    /// The ID for the top-level ancestor browsing context of this iframe's nested browsing context.
    pub webview_id: WebViewId,
    /// The new pipeline ID that the iframe has generated.
    pub new_pipeline_id: PipelineId,
    ///  Whether this iframe should be considered private
    pub is_private: bool,
    ///  Whether this iframe should be considered secure
    pub inherited_secure_context: Option<bool>,
    /// Whether this load should replace the current entry (reload). If true, the current
    /// entry will be replaced instead of a new entry being added.
    pub history_handling: NavigationHistoryBehavior,
    /// A snapshot of the navigation-related parameters of the target
    /// of this navigation.
    pub target_snapshot_params: TargetSnapshotParams,
    /// Name of this iframe, if any
    pub name: Option<String>,
}

/// Specifies the information required to load a URL in an iframe.
#[derive(Debug, Deserialize, Serialize)]
pub struct IFrameLoadInfoWithData {
    /// The information required to load an iframe.
    pub info: IFrameLoadInfo,
    /// Load data containing the url to load
    pub load_data: LoadData,
    /// The old pipeline ID for this iframe, if a page was previously loaded.
    pub old_pipeline_id: Option<PipelineId>,
    /// The initial viewport size for this iframe.
    pub viewport_details: ViewportDetails,
}

/// Resources required by workerglobalscopes
#[derive(Clone, Debug, Deserialize, MallocSizeOf, Serialize)]
pub struct WorkerGlobalScopeInit {
    /// Chan to a resource thread
    pub resource_threads: ResourceThreads,
    /// Chan to a storage thread
    pub storage_threads: StorageThreads,
    /// Chan to the memory profiler
    pub mem_profiler_chan: mem::ProfilerChan,
    /// Chan to the time profiler
    pub time_profiler_chan: profile_time::ProfilerChan,
    /// To devtools sender
    #[cfg(feature = "devtools")]
    pub to_devtools_sender: Option<GenericCallback<ScriptToDevtoolsControlMsg>>,
    /// From devtools sender
    #[cfg(feature = "devtools")]
    pub from_devtools_sender: Option<GenericSender<DevtoolScriptControlMsg>>,
    /// Messages to send to constellation
    pub script_to_constellation_chan: ScriptToConstellationSender,
    /// Messages to send to the Embedder
    pub script_to_embedder_chan: ScriptToEmbedderChan,
    /// The worker id
    pub worker_id: WorkerId,
    /// Whether this worker's `AnimationFrameProvider` is supported.
    pub animation_frame_provider_supported: bool,
    /// The pipeline id
    pub pipeline_id: PipelineId,
    /// The origin
    pub origin: ImmutableOrigin,
    /// True if secure context
    pub inherited_secure_context: Option<bool>,
    /// Unminify Javascript.
    pub unminify_js: bool,
    /// Handle for communicating messages to the WebGL thread, if available.
    #[cfg(feature = "webgl")]
    pub webgl_chan: Option<WebGLChan>,
    /// Whether or not Servo is online.
    pub online: bool,
}

/// Message delivered to a worker event loop to run animation frame callbacks.
#[derive(Clone, Copy, Debug, Deserialize, Serialize)]
pub struct WorkerAnimationFrameTick;

/// Common entities representing a network load origin
#[derive(Clone, Debug, Deserialize, MallocSizeOf, Serialize)]
pub struct WorkerScriptLoadOrigin {
    /// referrer url
    pub referrer_url: Option<ServoUrl>,
    /// the referrer policy which is used
    pub referrer_policy: ReferrerPolicy,
    /// the pipeline id of the entity requesting the load
    pub pipeline_id: PipelineId,
}

/// An iframe sizing operation.
#[derive(Clone, Copy, Debug, Deserialize, Serialize)]
pub struct IFrameSizeMsg {
    /// The child browsing context for this iframe.
    pub browsing_context_id: BrowsingContextId,
    /// The size and scale factor of the iframe.
    pub size: ViewportDetails,
    /// The kind of sizing operation.
    pub type_: WindowSizeType,
}

/// An enum that describe a type of keyboard scroll.
#[derive(Clone, Copy, Debug, Deserialize, Serialize)]
pub enum KeyboardScroll {
    /// Scroll the container one line up.
    Up,
    /// Scroll the container one line down.
    Down,
    /// Scroll the container one "line" left.
    Left,
    /// Scroll the container one "line" right.
    Right,
    /// Scroll the container one page up.
    PageUp,
    /// Scroll the container one page down.
    PageDown,
    /// Scroll the container to the vertical start.
    Home,
    /// Scroll the container to the vertical end.
    End,
}

#[derive(Debug, Deserialize, Serialize)]
pub enum ScreenshotReadinessResponse {
    /// The Pipeline associated with this response, is ready for a screenshot at the
    /// provided [`Epoch`].
    Ready(Epoch),
    /// The Pipeline associated with this response is no longer active and should be
    /// ignored for the purposes of the screenshot.
    NoLongerActive,
}

/// Identifies a category of events/notifications that a pipeline can register
/// interest in with the constellation. When a pipeline has active listeners for
/// events in a given category, it registers interest so the constellation only
/// sends notifications to pipelines that care.
#[derive(Clone, Copy, Debug, Deserialize, Eq, Hash, MallocSizeOf, PartialEq, Serialize)]
pub enum ConstellationInterest {
    /// Interest in `storage` events (fired when another same-origin pipeline modifies storage).
    StorageEvent,
}

/// Messages from the script to the constellation.
#[derive(Deserialize, IntoStaticStr, Serialize)]
pub enum ScriptToConstellationMessage {
    ServiceWorkerAlgorithm(ServiceWorkerAlgorithm),
    /// Request to complete the transfer of a set of ports to a router.
    CompleteMessagePortTransfer(MessagePortRouterId, Vec<MessagePortId>),
    /// The results of attempting to complete the transfer of a batch of ports.
    MessagePortTransferResult(
        /* The router whose transfer of ports succeeded, if any */
        Option<MessagePortRouterId>,
        /* The ids of ports transferred successfully */
        Vec<MessagePortId>,
        /* The ids, and buffers, of ports whose transfer failed */
        FxHashMap<MessagePortId, PortTransferInfo>,
    ),
    /// A new message-port was created or transferred, with corresponding control-sender.
    NewMessagePort(MessagePortRouterId, MessagePortId),
    /// A global has started managing message-ports
    NewMessagePortRouter(MessagePortRouterId, GenericCallback<MessagePortMsg>),
    /// A global has stopped managing message-ports
    RemoveMessagePortRouter(MessagePortRouterId),
    /// A task requires re-routing to an already shipped message-port.
    RerouteMessagePort(MessagePortId, PortMessageTask),
    /// A message-port was shipped, let the entangled port know.
    MessagePortShipped(MessagePortId),
    /// Entangle two message-ports.
    EntanglePorts(MessagePortId, MessagePortId),
    /// Disentangle two message-ports.
    /// The first is the initiator, the second the other port,
    /// unless the message is sent to complete a disentanglement,
    /// in which case the first one is the other port,
    /// and the second is none.
    DisentanglePorts(MessagePortId, Option<MessagePortId>),
    /// A global has started managing broadcast-channels.
    NewBroadcastChannelRouter(
        BroadcastChannelRouterId,
        GenericCallback<BroadcastChannelMsg>,
        ImmutableOrigin,
    ),
    /// A global has stopped managing broadcast-channels.
    RemoveBroadcastChannelRouter(BroadcastChannelRouterId, ImmutableOrigin),
    /// A global started managing broadcast channels for a given channel-name.
    NewBroadcastChannelNameInRouter(BroadcastChannelRouterId, String, ImmutableOrigin),
    /// A global stopped managing broadcast channels for a given channel-name.
    RemoveBroadcastChannelNameInRouter(BroadcastChannelRouterId, String, ImmutableOrigin),
    /// Broadcast a message to all same-origin broadcast channels,
    /// excluding the source of the broadcast.
    ScheduleBroadcast(BroadcastChannelRouterId, BroadcastChannelMsg),
    /// Register this pipeline's interest in a category of notifications.
    /// The constellation will only send notifications in this category to
    /// pipelines that have registered interest.
    RegisterInterest(ConstellationInterest),
    /// Unregister this pipeline's interest in a category of notifications.
    UnregisterInterest(ConstellationInterest),
    /// Broadcast a storage event to every same-origin pipeline.
    /// The strings are key, old value and new value.
    BroadcastStorageEvent(
        WebStorageType,
        ServoUrl,
        Option<String>,
        Option<String>,
        Option<String>,
    ),
    /// Indicates whether this pipeline is currently running animations.
    ChangeRunningAnimationsState(AnimationState),
    /// Register a dedicated worker that can receive animation frame ticks.
    RegisterWorkerAnimationFrameProvider(WorkerId, GenericSender<WorkerAnimationFrameTick>),
    /// Unregister a dedicated worker animation frame provider.
    UnregisterWorkerAnimationFrameProvider(WorkerId),
    /// Indicates whether a dedicated worker has pending animation frame callbacks.
    ChangeWorkerAnimationFrameProviderState(WorkerId, bool),
    /// Requests that a new 2D canvas thread be created. (This is done in the constellation because
    /// 2D canvases may use the GPU and we don't want to give untrusted content access to the GPU.)
    CreateCanvasPaintThread(
        UntypedSize2D<u64>,
        GenericSender<Option<(GenericSender<CanvasMsg>, CanvasId)>>,
    ),
    /// Notifies the constellation that this pipeline is requesting focus.
    ///
    /// When this message is sent, the sender pipeline has already its local
    /// focus state updated. The constellation, after receiving this message,
    /// will broadcast messages to other pipelines that are affected by this
    /// focus operation.
    ///
    /// The first field contains the browsing context ID of the container
    /// element if one was focused.
    ///
    /// The second field is a sequence number that the constellation should use
    /// when sending a focus-related message to the sender pipeline next time.
    FocusAncestorBrowsingContextsForFocusingSteps(Option<BrowsingContextId>, FocusSequenceNumber),
    /// Focus a remote `BrowsingContext` and run the focusing steps. This is used in two situations:
    /// - When calling the DOM `focus()` API on a remote `Window` as well as from
    ///   WebDriver. The difference between this and `FocusDocumentAsPartOfFocusingSteps` is that this
    ///   version actually does run the focusing steps and may result in blur and focus events firing
    ///   up the frame tree.
    /// - When doing sequential focus navigation into and out of frames.
    FocusRemoteBrowsingContext(BrowsingContextId, RemoteFocusOperation),
    /// Get the top-level browsing context info for a given browsing context.
    GetTopForBrowsingContext(BrowsingContextId, GenericSender<Option<WebViewId>>),
    /// Get the browsing context id of the browsing context in which pipeline is
    /// embedded and the parent pipeline id of that browsing context.
    GetBrowsingContextInfo(
        PipelineId,
        GenericSender<Option<(BrowsingContextId, Option<PipelineId>)>>,
    ),
    /// Get the count of child browsing contexts for a given browsing context.
    GetChildBrowsingContextCount(BrowsingContextId, GenericSender<usize>),
    /// Get the nth child browsing context ID for a given browsing context, when sorted in
    /// insertion order.
    GetChildBrowsingContextId(
        BrowsingContextId,
        usize,
        GenericSender<Option<BrowsingContextId>>,
    ),
    /// Get the origin of the document corresponding to the given pipeline
    GetDocumentOrigin(PipelineId, GenericSender<Option<OriginSnapshot>>),
    /// If the document corresponding to the given pipeline is fully active
    IsCurrentlyFullyActive(PipelineId, GenericSender<bool>),
    /// Get the origin and internal ancestor origin objects list of the `Document`
    /// corresponding to the given `PipelineId`.
    GetDocumentOriginDetails(
        PipelineId,
        GenericSender<Option<(OriginSnapshot, Vec<ImmutableOrigin>)>>,
    ),
    /// All pending loads are complete, and the `load` event for this pipeline
    /// has been dispatched.
    LoadComplete,
    /// A new load has been requested, with an option to replace the current entry once loaded
    /// instead of adding a new entry.
    LoadUrl(LoadData, NavigationHistoryBehavior, TargetSnapshotParams),
    /// Abort loading after sending a LoadUrl message.
    AbortLoadUrl,
    /// Post a message to the currently active window of a given browsing context.
    PostMessage {
        /// The target of the posted message.
        target: BrowsingContextId,
        /// The source of the posted message.
        source: PipelineId,
        /// The expected origin of the target.
        target_origin: Option<ImmutableOrigin>,
        /// The source origin of the message.
        /// <https://html.spec.whatwg.org/multipage/#dom-messageevent-origin>
        source_origin: ImmutableOrigin,
        /// The data to be posted.
        data: StructuredSerializedData,
    },
    /// Inform the constellation that a fragment was navigated to and whether or not it was a replacement navigation.
    NavigatedToFragment(ServoUrl, NavigationHistoryBehavior),
    /// HTMLIFrameElement Forward or Back traversal.
    TraverseHistory(SessionHistoryTraversalRequest),
    /// Inform the constellation of a pushed history state.
    PushHistoryState(HistoryStateId, ServoUrl),
    /// Inform the constellation of a replaced history state.
    ReplaceHistoryState(HistoryStateId, ServoUrl),
    /// Gets the length of the joint session history from the constellation.
    JointSessionHistoryLength(GenericSender<u32>),
    /// Notification that this iframe should be removed.
    /// Returns a list of pipelines which were closed.
    RemoveIFrame(BrowsingContextId, GenericSender<Vec<PipelineId>>),
    /// A load has been requested in an IFrame.
    ScriptLoadedURLInIFrame(IFrameLoadInfoWithData),
    /// A load of the initial `about:blank` has been completed in an IFrame.
    ScriptNewIFrame(IFrameLoadInfoWithData),
    /// Script has opened a new auxiliary browsing context.
    CreateAuxiliaryWebView(AuxiliaryWebViewCreationRequest),
    /// Mark a new document as active
    ActivateDocument,
    /// Update the pipeline Url, which can change after redirections.
    SetFinalUrl(ServoUrl),
    /// A log entry, with the top-level browsing context id and thread name
    LogEntry(Option<ScriptEventLoopId>, Option<String>, LogEntry),
    /// Discard the document.
    DiscardDocument,
    /// Discard the browsing context.
    DiscardTopLevelBrowsingContext,
    /// Notifies the constellation that this pipeline has exited.
    PipelineExited,
    /// Send messages from postMessage calls from serviceworker
    /// to constellation for storing in service worker manager
    ForwardDOMMessage(DOMMessage, ServoUrl),
    /// Notifies the constellation about media session events
    /// (i.e. when there is metadata for the active media session, playback state changes...).
    MediaSessionEvent(PipelineId, MediaSessionEvent),
    #[cfg(feature = "webgpu")]
    /// Create a WebGPU Adapter instance
    RequestAdapter(
        GenericCallback<WebGPUAdapterResponse>,
        wgpu_core::instance::RequestAdapterOptions,
        wgpu_core::id::AdapterId,
    ),
    #[cfg(feature = "webgpu")]
    /// Get WebGPU channel
    GetWebGPUChan(GenericSender<Option<WebGPU>>),
    /// Notify the constellation of a pipeline's document's title.
    TitleChanged(PipelineId, String),
    /// Notify the constellation that the size of some `<iframe>`s has changed.
    IFrameSizes(Vec<IFrameSizeMsg>),
    /// Request results from the memory reporter.
    ReportMemory(GenericCallback<MemoryReportResult>),
    /// Return the result of the evaluated JavaScript with the given [`JavaScriptEvaluationId`].
    FinishJavaScriptEvaluation(
        JavaScriptEvaluationId,
        Result<JSValue, JavaScriptEvaluationError>,
    ),
    /// Forward a keyboard scroll operation from an `<iframe>` to a parent pipeline.
    ForwardKeyboardScroll(PipelineId, KeyboardScroll),
    /// Notify the Constellation of the screenshot readiness of a given pipeline.
    RespondToScreenshotReadinessRequest(ScreenshotReadinessResponse),
    /// Request the constellation to force garbage collection in all `ScriptThread`'s.
    TriggerGarbageCollection,
    /// Request to acquire a wake lock of the given type. The constellation will track the
    /// aggregate lock count and notify the provider only when the count transitions from 0 to 1.
    /// <https://w3c.github.io/screen-wake-lock/#dfn-acquire-wake-lock>
    AcquireWakeLock(WakeLockType),
    /// Request to release a wake lock of the given type. The constellation will track the
    /// aggregate lock count and notify the provider only when the count transitions from N to 0.
    /// <https://w3c.github.io/screen-wake-lock/#dfn-release-wake-lock>
    ReleaseWakeLock(WakeLockType),
}

impl fmt::Debug for ScriptToConstellationMessage {
    fn fmt(&self, formatter: &mut fmt::Formatter) -> fmt::Result {
        let variant_string: &'static str = self.into();
        write!(formatter, "ScriptMsg::{variant_string}")
    }
}

/// <https://html.spec.whatwg.org/multipage/#target-snapshot-params>
#[derive(Clone, Copy, Debug, Deserialize, Serialize)]
pub struct TargetSnapshotParams {
    /// <https://html.spec.whatwg.org/multipage/#target-snapshot-params-sandbox>
    pub sandboxing_flags: SandboxingFlagSet,
    /// <https://html.spec.whatwg.org/multipage/#target-snapshot-params-iframe-referrer-policy>
    pub iframe_element_referrer_policy: ReferrerPolicy,
}

impl Default for TargetSnapshotParams {
    fn default() -> Self {
        Self {
            sandboxing_flags: SandboxingFlagSet::empty(),
            iframe_element_referrer_policy: ReferrerPolicy::EmptyString,
        }
    }
}

/// <https://html.spec.whatwg.org/multipage/#sequential-focus-direction>
///
/// > A sequential focus direction is one of two possible values: "forward", or "backward". They are
/// > used in the below algorithms to describe the direction in which sequential focus travels at the
/// > user's request.
#[derive(Clone, Copy, Debug, Deserialize, PartialEq, Serialize)]
pub enum SequentialFocusDirection {
    Forward,
    Backward,
}

/// The type of focus operation to do on a remote document.
#[derive(Deserialize, Serialize)]
pub enum RemoteFocusOperation {
    /// Focus the entire viewport of the remote document.
    Viewport,
    /// Do sequential focus navigation using the `<iframe>` element with the given
    /// [`BrowsingContextId`] as the starting point and in the given direction.
    Sequential(SequentialFocusDirection, Option<BrowsingContextId>),
}