ferrijs-std 0.1.0

// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
// SPDX-License-Identifier: Apache-2.0
#![allow(
    clippy::mutable_key_type,
    clippy::for_kv_map,
    clippy::new_without_default
)]
use std::{
    rc::Rc,
    sync::{Arc, RwLock},
};

use crate::utils::{
    error::ErrorExtensions, module::ModuleInfo, object::ObjectExt, result::ResultExt,
};
use rquickjs::{
    class::{JsClass, Trace, Tracer},
    module::{Declarations, Exports, ModuleDef},
    prelude::{Func, Opt, Rest, This},
    CatchResultExt, Class, Ctx, Function, JsLifetime, Object, Result, String as JsString, Symbol,
    Value,
};
use tracing::trace;

use self::{custom_event::CustomEvent, event::Event, event_target::EventTarget};

pub mod custom_event;
pub mod event;
pub mod event_target;

#[derive(Clone, Debug)]
pub enum EventKey<'js> {
    Symbol(Symbol<'js>),
    String(Rc<str>),
}

impl<'js> EventKey<'js> {
    fn from_value(ctx: &Ctx, value: Value<'js>) -> Result<Self> {
        if value.is_string() {
            let key: String = value.get()?;
            Ok(EventKey::String(key.into()))
        } else {
            let sym = value.into_symbol().ok_or("Not a symbol").or_throw(ctx)?;
            Ok(EventKey::Symbol(sym))
        }
    }
}

impl Eq for EventKey<'_> {}

impl PartialEq for EventKey<'_> {
    fn eq(&self, other: &Self) -> bool {
        match (self, other) {
            (EventKey::Symbol(symbol1), EventKey::Symbol(symbol2)) => symbol1 == symbol2,
            (EventKey::String(str1), EventKey::String(str2)) => str1 == str2,
            _ => false,
        }
    }
}

pub struct EventItem<'js> {
    callback: Function<'js>,
    once: bool,
}

pub type EventList<'js> = Vec<(EventKey<'js>, Vec<EventItem<'js>>)>;
pub type Events<'js> = Arc<RwLock<EventList<'js>>>;

/// Get the hidden symbol used to store the event list on JS objects.
fn events_symbol<'js>(ctx: &Ctx<'js>) -> Result<Symbol<'js>> {
    Symbol::new_global(ctx.clone(), "__ee")
}

/// Convert a Class into an Object for use with Emitter methods.
fn class_to_obj<'js, C: JsClass<'js>>(class: Class<'js, C>) -> Result<Object<'js>> {
    Object::from_value(class.into_value())
}

/// Resolve the event list from a JS object. For native Emitter classes,
/// reads from the native struct. For plain JS objects (e.g. stream.js Readable),
/// lazily creates and stores a native EventEmitter as a hidden property.
#[allow(clippy::arc_with_non_send_sync)]
pub fn resolve_events<'js>(ctx: &Ctx<'js>, obj: &Object<'js>) -> Result<Events<'js>> {
    // Try native EventEmitter first
    if let Some(class) = Class::<EventEmitter>::from_object(obj) {
        return Ok(class.borrow().events.clone());
    }
    let sym = events_symbol(ctx)?;
    // Check for hidden property
    if let Some(ee) = obj.get::<_, Option<Class<'js, EventEmitter<'js>>>>(sym.clone())? {
        return Ok(ee.borrow().events.clone());
    }
    // Create and store a new one
    let events: Events<'js> = Arc::new(RwLock::new(Vec::new()));
    let ee = Class::instance(
        ctx.clone(),
        EventEmitter {
            events: events.clone(),
        },
    )?;
    obj.set(sym, ee)?;
    Ok(events)
}

#[rquickjs::class]
#[derive(Clone)]
pub struct EventEmitter<'js> {
    pub events: Events<'js>,
}

unsafe impl<'js> JsLifetime<'js> for EventEmitter<'js> {
    type Changed<'to> = EventEmitter<'to>;
}

impl<'js> Emitter<'js> for EventEmitter<'js> {
    fn get_event_list(&self) -> Arc<RwLock<EventList<'js>>> {
        self.events.clone()
    }
}

impl<'js> Trace<'js> for EventEmitter<'js> {
    fn trace<'a>(&self, tracer: Tracer<'a, 'js>) {
        self.trace_event_emitter(tracer);
    }
}

#[rquickjs::methods]
impl<'js> EventEmitter<'js> {
    #[qjs(constructor)]
    pub fn new() -> Self {
        Self {
            #[allow(clippy::arc_with_non_send_sync)]
            events: Arc::new(RwLock::new(Vec::new())),
        }
    }
}

pub trait EmitError<'js> {
    fn emit_error<C>(self, id: &'static str, ctx: &Ctx<'js>, this: Class<'js, C>) -> Result<bool>
    where
        C: Emitter<'js>;
}

impl<'js, T> EmitError<'js> for Result<T> {
    fn emit_error<C>(self, id: &'static str, ctx: &Ctx<'js>, this: Class<'js, C>) -> Result<bool>
    where
        C: Emitter<'js>,
    {
        if let Err(err) = self.catch(ctx) {
            trace!("Error caught in: {}", id);
            if this.borrow().has_listener_str("error") {
                let error_value = err.into_value(ctx)?;
                C::emit_str(this, ctx, "error", vec![error_value], false)?;
                return Ok(true);
            }
            return Err(err.throw(ctx));
        }
        Ok(false)
    }
}

pub trait Emitter<'js>
where
    Self: JsClass<'js> + Sized + 'js,
{
    fn get_event_list(&self) -> Arc<RwLock<EventList<'js>>>;

    fn on_event_changed(&mut self, _event: EventKey<'js>, _added: bool) -> Result<()> {
        Ok(())
    }

    /// Resolve the event list from a `this` object. For native classes,
    /// extracts from the class data. For plain JS objects, uses the hidden property.
    fn resolve_events_from(ctx: &Ctx<'js>, this: &Object<'js>) -> Result<Events<'js>> {
        if let Some(class) = Class::<Self>::from_object(this) {
            return Ok(class.borrow().get_event_list());
        }
        resolve_events(ctx, this)
    }

    fn add_event_emitter_prototype(ctx: &Ctx<'js>) -> Result<Object<'js>> {
        let proto = Class::<Self>::prototype(ctx)?
            .or_throw_msg(ctx, "Prototype for EventEmitter not found")?;

        let on = Function::new(ctx.clone(), Self::on)?;
        let off = Function::new(ctx.clone(), Self::remove_event_listener)?;

        proto.set("once", Func::from(Self::once))?;
        proto.set("on", on.clone())?;
        proto.set("emit", Func::from(Self::emit))?;
        proto.set("prependListener", Func::from(Self::prepend_listener))?;
        proto.set(
            "prependOnceListener",
            Func::from(Self::prepend_once_listener),
        )?;
        proto.set("off", off.clone())?;
        proto.set("eventNames", Func::from(Self::event_names))?;
        proto.set("addListener", on)?;
        proto.set("removeListener", off)?;
        proto.set("listenerCount", Func::from(Self::listener_count))?;
        proto.set("removeAllListeners", Func::from(Self::remove_all_listeners))?;

        Ok(proto)
    }

    fn add_event_target_prototype(ctx: &Ctx<'js>) -> Result<Object<'js>> {
        let proto = Class::<Self>::prototype(ctx)?
            .or_throw_msg(ctx, "Prototype for EventTarget not found")?;

        let on = Function::new(ctx.clone(), Self::evt_add_event_listener)?;
        let off = Function::new(ctx.clone(), Self::remove_event_listener)?;

        proto.set("dispatchEvent", Func::from(Self::evt_dispatch_event))?;
        proto.set("addEventListener", on)?;
        proto.set("removeEventListener", off)?;

        Ok(proto)
    }

    fn trace_event_emitter<'a>(&self, tracer: Tracer<'a, 'js>) {
        let events = self.get_event_list();
        let events = events.read().unwrap();
        for (key, items) in events.iter() {
            if let EventKey::Symbol(sym) = &key {
                tracer.mark(sym);
            }

            for item in items {
                tracer.mark(&item.callback);
            }
        }
    }

    fn remove_event_listener_str(
        this: Class<'js, Self>,
        ctx: &Ctx<'js>,
        event: &str,
        listener: Function<'js>,
    ) -> Result<Object<'js>> {
        let event = to_event(ctx, event)?;
        Self::remove_event_listener(This(class_to_obj(this)?), ctx.clone(), event, listener)
    }

    fn remove_event_listener(
        this: This<Object<'js>>,
        ctx: Ctx<'js>,
        event: Value<'js>,
        listener: Function<'js>,
    ) -> Result<Object<'js>> {
        let events = Self::resolve_events_from(&ctx, &this)?;
        let mut events = events.write().or_throw(&ctx)?;

        let key = EventKey::from_value(&ctx, event)?;
        if let Some(index) = events.iter_mut().position(|(k, _)| k == &key) {
            let items = &mut events[index].1;
            if let Some(pos) = items.iter().position(|item| item.callback == listener) {
                items.remove(pos);
                if items.is_empty() {
                    events.remove(index);
                }
            }
        };

        Ok(this.0)
    }

    fn add_event_listener_str(
        this: Class<'js, Self>,
        ctx: &Ctx<'js>,
        event: &str,
        listener: Function<'js>,
        prepend: bool,
        once: bool,
    ) -> Result<Object<'js>> {
        let event = to_event(ctx, event)?;
        Self::add_event_listener(
            This(class_to_obj(this)?),
            ctx.clone(),
            event,
            listener,
            prepend,
            once,
        )
    }

    fn once(
        this: This<Object<'js>>,
        ctx: Ctx<'js>,
        event: Value<'js>,
        listener: Function<'js>,
    ) -> Result<Object<'js>> {
        Self::add_event_listener(this, ctx, event, listener, false, true)
    }

    fn on(
        this: This<Object<'js>>,
        ctx: Ctx<'js>,
        event: Value<'js>,
        listener: Function<'js>,
    ) -> Result<Object<'js>> {
        Self::add_event_listener(this, ctx, event, listener, false, false)
    }

    fn prepend_listener(
        this: This<Object<'js>>,
        ctx: Ctx<'js>,
        event: Value<'js>,
        listener: Function<'js>,
    ) -> Result<Object<'js>> {
        Self::add_event_listener(this, ctx, event, listener, true, false)
    }

    fn prepend_once_listener(
        this: This<Object<'js>>,
        ctx: Ctx<'js>,
        event: Value<'js>,
        listener: Function<'js>,
    ) -> Result<Object<'js>> {
        Self::add_event_listener(this, ctx, event, listener, true, true)
    }

    fn evt_add_event_listener(
        this: This<Object<'js>>,
        ctx: Ctx<'js>,
        event: Value<'js>,
        listener: Function<'js>,
        options: Opt<Object<'js>>,
    ) -> Result<Object<'js>> {
        let mut once = false;
        if let Some(opt) = options.0 {
            if let Some(once_opt) = opt.get("once")? {
                once = once_opt;
            }
        }
        Self::add_event_listener(this, ctx, event, listener, false, once)
    }

    fn add_event_listener(
        this: This<Object<'js>>,
        ctx: Ctx<'js>,
        event: Value<'js>,
        listener: Function<'js>,
        prepend: bool,
        once: bool,
    ) -> Result<Object<'js>> {
        let events = Self::resolve_events_from(&ctx, &this)?;
        let mut events = events.write().or_throw(&ctx)?;
        let key = EventKey::from_value(&ctx, event)?;
        let mut is_new = false;

        let items = match events.iter_mut().find(|(k, _)| k == &key) {
            Some((_, entry_items)) => entry_items,
            None => {
                is_new = true;
                events.push((key.clone(), Vec::new()));
                &mut events.last_mut().unwrap().1
            },
        };

        let item = EventItem {
            callback: listener,
            once,
        };
        if !prepend {
            items.push(item);
        } else {
            items.insert(0, item);
        }
        if is_new {
            if let Some(class) = Class::<Self>::from_object(&this.0) {
                class.borrow_mut().on_event_changed(key, true)?;
            }
        }
        Ok(this.0)
    }

    fn has_listener_str(&self, event: &str) -> bool {
        let key = EventKey::String(event.into());
        has_key(self.get_event_list(), key)
    }

    #[allow(dead_code)]
    fn has_listener(&self, ctx: Ctx<'js>, event: Value<'js>) -> Result<bool> {
        let key = EventKey::from_value(&ctx, event)?;
        Ok(has_key(self.get_event_list(), key))
    }

    #[allow(dead_code)]
    fn get_listeners(&self, ctx: &Ctx<'js>, event: Value<'js>) -> Result<Vec<Function<'js>>> {
        let key = EventKey::from_value(ctx, event)?;
        Ok(find_all_listeners(self.get_event_list(), key))
    }

    fn get_listeners_str(&self, event: &str) -> Vec<Function<'js>> {
        let key = EventKey::String(event.into());
        find_all_listeners(self.get_event_list(), key)
    }

    fn do_emit(
        event: Value<'js>,
        this: This<Object<'js>>,
        ctx: &Ctx<'js>,
        args: Rest<Value<'js>>,
        defer: bool,
    ) -> Result<bool> {
        let events = Self::resolve_events_from(ctx, &this)?;
        let mut events = events.write().or_throw(ctx)?;
        let key = EventKey::from_value(ctx, event)?;

        if let Some(index) = events.iter_mut().position(|(k, _)| k == &key) {
            let items = &mut events[index].1;
            let mut callbacks = Vec::with_capacity(items.len());
            items.retain(|item: &EventItem<'_>| {
                callbacks.push(item.callback.clone());
                !item.once
            });
            if items.is_empty() {
                events.remove(index);
                if let Some(class) = Class::<Self>::from_object(&this.0) {
                    class.borrow_mut().on_event_changed(key, false)?;
                }
            }
            drop(events);
            for callback in callbacks {
                let args: Vec<Value<'js>> = args.iter().map(|arg| arg.to_owned()).collect();
                let args = Rest(args);
                let this_val = This(this.0.clone().into_value());
                if defer {
                    callback.defer((this_val, args))?;
                } else {
                    callback.call::<_, ()>((this_val, args))?;
                }
            }
            Ok(true)
        } else {
            Ok(false)
        }
    }

    fn emit_str(
        this: Class<'js, Self>,
        ctx: &Ctx<'js>,
        event: &str,
        args: Vec<Value<'js>>,
        defer: bool,
    ) -> Result<()> {
        let event = to_event(ctx, event)?;
        Self::do_emit(event, This(class_to_obj(this)?), ctx, args.into(), defer)?;
        Ok(())
    }

    fn emit(
        this: This<Object<'js>>,
        ctx: Ctx<'js>,
        event: Value<'js>,
        args: Rest<Value<'js>>,
    ) -> Result<bool> {
        Self::do_emit(event, this, &ctx, args, false)
    }

    fn evt_dispatch_event(
        this: This<Object<'js>>,
        ctx: Ctx<'js>,
        event: Value<'js>,
    ) -> Result<bool> {
        let event_type = event.get_optional("type")?.unwrap();
        Self::do_emit(event_type, this, &ctx, Rest(vec![event]), false)
    }

    fn event_names(this: This<Object<'js>>, ctx: Ctx<'js>) -> Result<Vec<Value<'js>>> {
        let events = Self::resolve_events_from(&ctx, &this)?;
        let events = events.read().or_throw(&ctx)?;

        let mut names = Vec::with_capacity(events.len());
        for (key, _entry) in events.iter() {
            let value = match key {
                EventKey::Symbol(symbol) => symbol.clone().into_value(),
                EventKey::String(str) => JsString::from_str(ctx.clone(), str)?.into(),
            };

            names.push(value)
        }

        Ok(names)
    }

    fn listener_count(this: This<Object<'js>>, ctx: Ctx<'js>, event: Value<'js>) -> Result<usize> {
        let events = Self::resolve_events_from(&ctx, &this)?;
        let key = EventKey::from_value(&ctx, event)?;
        let events = events.read().or_throw(&ctx)?;
        Ok(events
            .iter()
            .find(|(k, _)| k == &key)
            .map_or(0, |(_, items)| items.len()))
    }

    fn remove_all_listeners(
        this: This<Object<'js>>,
        ctx: Ctx<'js>,
        event: Opt<Value<'js>>,
    ) -> Result<Object<'js>> {
        let events = Self::resolve_events_from(&ctx, &this)?;
        let mut events = events.write().or_throw(&ctx)?;
        match event.0 {
            Some(event) if !event.is_undefined() => {
                let key = EventKey::from_value(&ctx, event)?;
                events.retain(|(k, _)| k != &key);
            },
            _ => events.clear(),
        }
        Ok(this.0)
    }
}

fn find_all_listeners<'js>(
    events: Arc<RwLock<EventList<'js>>>,
    key: EventKey<'js>,
) -> Vec<Function<'js>> {
    let events = events.read().unwrap();
    let items = events.iter().find(|(k, _)| k == &key);
    if let Some((_, callbacks)) = items {
        callbacks.iter().map(|item| item.callback.clone()).collect()
    } else {
        vec![]
    }
}

fn has_key<'js>(event_list: Arc<RwLock<EventList<'js>>>, key: EventKey<'js>) -> bool {
    event_list.read().unwrap().iter().any(|(k, _)| k == &key)
}

fn to_event<'js>(ctx: &Ctx<'js>, event: &str) -> Result<Value<'js>> {
    let event = JsString::from_str(ctx.clone(), event)?;
    Ok(event.into_value())
}

pub struct EventsModule;

impl ModuleDef for EventsModule {
    fn declare(declare: &Declarations) -> Result<()> {
        declare.declare(stringify!(EventEmitter))?;
        declare.declare("default")?;

        Ok(())
    }

    fn evaluate<'js>(ctx: &Ctx<'js>, exports: &Exports<'js>) -> Result<()> {
        let ctor = Class::<EventEmitter>::create_constructor(ctx)?
            .expect("Can't create EventEmitter constructor");
        ctor.set(stringify!(EventEmitter), ctor.clone())?;
        exports.export(stringify!(EventEmitter), ctor.clone())?;
        exports.export("default", ctor)?;

        EventEmitter::add_event_emitter_prototype(ctx)?;

        Ok(())
    }
}

impl From<EventsModule> for ModuleInfo<EventsModule> {
    fn from(val: EventsModule) -> Self {
        ModuleInfo {
            name: "events",
            module: val,
        }
    }
}

pub fn init(ctx: &Ctx<'_>) -> Result<()> {
    let globals = ctx.globals();

    Class::<EventTarget>::define(&globals)?;
    Class::<CustomEvent>::define(&globals)?;
    Class::<Event>::define(&globals)?;

    EventTarget::add_event_target_prototype(ctx)?;

    Ok(())
}