dfir_lang 0.16.0

Hydro's Dataflow Intermediate Representation (DFIR) implementation
Documentation
use quote::quote_spanned;

use super::{
    DelayType, OpInstGenerics, OperatorCategory, OperatorConstraints, OperatorInstance,
    OperatorWriteOutput, Persistence, RANGE_0, RANGE_1, WriteContextArgs,
};
use crate::diagnostic::{Diagnostic, Level};

/// `persist_mut_keyed()` is similar to `persist_mut()` except that it also enables key-based deletions
/// `persist_mut()` expects an input of type [`PersistenceKeyed<T>`](https://docs.rs/dfir_rs/latest/dfir_rs/util/enum.PersistenceKeyed.html),
/// and it is this enumeration that enables the user to communicate deletion.
/// Deletions/persists happen in the order they are received in the stream.
/// For example, `[Persist(1), Delete(1), Persist(1)]` will result in a a single `1` value being stored.
///
/// ```dfir
/// use dfir_rs::util::PersistenceKeyed;
///
/// source_iter([
///         PersistenceKeyed::Persist(0, 1),
///         PersistenceKeyed::Persist(1, 1),
///         PersistenceKeyed::Delete(1),
///     ])
///     -> persist_mut_keyed::<'mutable>()
///     -> assert_eq([(0, 1)]);
/// ```
pub const PERSIST_MUT_KEYED: OperatorConstraints = OperatorConstraints {
    name: "persist_mut_keyed",
    categories: &[OperatorCategory::Persistence],
    hard_range_inn: RANGE_1,
    soft_range_inn: RANGE_1,
    hard_range_out: RANGE_1,
    soft_range_out: RANGE_1,
    num_args: 0,
    persistence_args: RANGE_1,
    type_args: RANGE_0,
    is_external_input: false,
    // If this is set to true, the state will need to be cleared using `#context.set_state_lifespan_hook`
    // to prevent reading uncleared data if this subgraph doesn't run.
    // https://github.com/hydro-project/hydro/issues/1298
    // If `'tick` lifetimes are added.
    has_singleton_output: false,
    flo_type: None,
    ports_inn: None,
    ports_out: None,
    input_delaytype_fn: |_| Some(DelayType::Stratum),
    write_fn: |wc @ &WriteContextArgs {
                   root,
                   context,
                   df_ident,
                   op_span,
                   work_fn_async,
                   ident,
                   inputs,
                   is_pull,
                   op_name,
                   op_inst:
                       OperatorInstance {
                           generics:
                               OpInstGenerics {
                                   persistence_args, ..
                               },
                           ..
                       },
                   ..
               },
               diagnostics| {
        assert!(is_pull);

        if [Persistence::Mutable] != persistence_args[..] {
            diagnostics.push(Diagnostic::spanned(
                op_span,
                Level::Error,
                format!(
                    "{} only supports `'{}`.",
                    op_name,
                    Persistence::Mutable.to_str_lowercase()
                ),
            ));
        }

        let persistdata_ident = wc.make_ident("persistdata");
        let map_ident = wc.make_ident("persistmap");
        let write_prologue = quote_spanned! {op_span=>
            let #persistdata_ident = #df_ident.add_state(::std::cell::RefCell::new(
                #root::rustc_hash::FxHashMap::<_, #root::util::sparse_vec::SparseVec<_>>::default()
            ));
        };

        let write_iterator = {
            let input = &inputs[0];
            quote_spanned! {op_span=>
                let mut #map_ident = unsafe {
                    // SAFETY: handle from `#df_ident.add_state(..)`.
                    #context.state_ref_unchecked(#persistdata_ident)
                }.borrow_mut();

                let #ident = {
                    #[inline(always)]
                    fn check_pull<Prev, K, V>(prev: Prev)
                        -> impl #root::dfir_pipes::pull::Pull<Item = #root::util::PersistenceKeyed::<K, V>, Meta = Prev::Meta, CanPend = Prev::CanPend, CanEnd = Prev::CanEnd>
                    where
                        Prev: #root::dfir_pipes::pull::Pull<Item = #root::util::PersistenceKeyed::<K, V>>,
                    {
                        prev
                    }

                    let iter = if context.is_first_run_this_tick() {
                        let fut = #root::dfir_pipes::pull::Pull::for_each(check_pull(#input), |item| {
                            match item {
                                #root::util::PersistenceKeyed::Persist(k, v) => {
                                    #map_ident.entry(k).or_default().push(v);
                                },
                                #root::util::PersistenceKeyed::Delete(k) => {
                                    #map_ident.remove(&k);
                                }
                            }
                        });
                        let () = #work_fn_async(fut).await;

                        #[allow(clippy::clone_on_copy)]
                        #[allow(clippy::disallowed_methods, reason = "FxHasher is deterministic")]
                        Some(
                            #map_ident
                                .iter()
                                .flat_map(|(k, v)| v.iter().map(move |v| (k.clone(), v.clone())))
                        )
                        .into_iter()
                        .flatten()
                    } else {
                        None.into_iter().flatten()
                    };
                    #root::dfir_pipes::pull::iter(iter)
                };
            }
        };

        let write_iterator_after = quote_spanned! {op_span=>
            #context.schedule_subgraph(#context.current_subgraph(), false);
        };

        Ok(OperatorWriteOutput {
            write_prologue,
            write_iterator,
            write_iterator_after,
            ..Default::default()
        })
    },
};