use std::path::PathBuf;
use std::str::FromStr;
use std::sync::Arc;
use std::sync::Mutex;
use std::time::SystemTime;

use base64::prelude::BASE64_STANDARD;
use base64::prelude::BASE64_STANDARD_NO_PAD;
use base64::prelude::BASE64_URL_SAFE;
use base64::prelude::BASE64_URL_SAFE_NO_PAD;
use base64::Engine as _;
use bytes::Bytes;
use http::header::InvalidHeaderName;
use http::uri::Authority;
use http::uri::Parts;
use http::uri::PathAndQuery;
use http::HeaderMap;
use http::Method;
use http::StatusCode;
use http::Uri;
use rhai::module_resolvers::FileModuleResolver;
use rhai::plugin::*;
use rhai::serde::from_dynamic;
use rhai::serde::to_dynamic;
use rhai::Array;
use rhai::Dynamic;
use rhai::Engine;
use rhai::EvalAltResult;
use rhai::FnPtr;
use rhai::Instant;
use rhai::Map;
use rhai::Scope;
use rhai::AST;
use tower::BoxError;
use uuid::Uuid;

use super::execution;
use super::router;
use super::subgraph;
use super::supergraph;
use super::Rhai;
use super::ServiceStep;
use crate::configuration::expansion;
use crate::graphql::Request;
use crate::graphql::Response;
use crate::http_ext;
use crate::plugins::authentication::APOLLO_AUTHENTICATION_JWT_CLAIMS;
use crate::plugins::cache::entity::CONTEXT_CACHE_KEY;
use crate::plugins::subscription::SUBSCRIPTION_WS_CUSTOM_CONNECTION_PARAMS;
use crate::query_planner::APOLLO_OPERATION_ID;
use crate::Context;

const CANNOT_ACCESS_HEADERS_ON_A_DEFERRED_RESPONSE: &str =
    "cannot access headers on a deferred response";

const CANNOT_ACCESS_STATUS_CODE_ON_A_DEFERRED_RESPONSE: &str =
    "cannot access status_code on a deferred response";

const CANNOT_GET_ENVIRONMENT_VARIABLE: &str = "environment variable not found";

pub(super) trait OptionDance<T> {
    fn with_mut<R>(&self, f: impl FnOnce(&mut T) -> R) -> R;

    fn replace(&self, f: impl FnOnce(T) -> T);

    fn take_unwrap(self) -> T;
}

pub(super) type SharedMut<T> = rhai::Shared<Mutex<Option<T>>>;

impl<T> OptionDance<T> for SharedMut<T> {
    fn with_mut<R>(&self, f: impl FnOnce(&mut T) -> R) -> R {
        let mut guard = self.lock().expect("poisoned mutex");
        f(guard.as_mut().expect("re-entrant option dance"))
    }

    fn replace(&self, f: impl FnOnce(T) -> T) {
        let mut guard = self.lock().expect("poisoned mutex");
        *guard = Some(f(guard.take().expect("re-entrant option dance")))
    }

    fn take_unwrap(self) -> T {
        match Arc::try_unwrap(self) {
            Ok(mutex) => mutex.into_inner().expect("poisoned mutex"),

            // TODO: Should we assume the Arc refcount is 1
            // and use `try_unwrap().expect("shared ownership")` instead of this fallback ?
            Err(arc) => arc.lock().expect("poisoned mutex").take(),
        }
        .expect("re-entrant option dance")
    }
}

#[derive(Clone)]
#[allow(unreachable_pub)]
pub enum Base64Alphabet {
    Standard,
    StandardNoPad,
    UrlSafe,
    UrlSafeNoPad,
}

fn get_engine(alphabet: &Base64Alphabet) -> base64::engine::GeneralPurpose {
    match alphabet {
        Base64Alphabet::Standard => BASE64_STANDARD,
        Base64Alphabet::StandardNoPad => BASE64_STANDARD_NO_PAD,
        Base64Alphabet::UrlSafe => BASE64_URL_SAFE,
        Base64Alphabet::UrlSafeNoPad => BASE64_URL_SAFE_NO_PAD,
    }
}

// We have to keep the modules that we export using `export_module` inline because
// error[E0658]: non-inline modules in proc macro input are unstable
#[export_module]
#[allow(unreachable_pub)]
mod router_base64 {
    pub type Alphabet = Base64Alphabet;
    pub const STANDARD: Alphabet = Alphabet::Standard;
    pub const STANDARD_NO_PAD: Alphabet = Alphabet::StandardNoPad;
    pub const URL_SAFE: Alphabet = Alphabet::UrlSafe;
    pub const URL_SAFE_NO_PAD: Alphabet = Alphabet::UrlSafeNoPad;

    #[rhai_fn(pure, return_raw)]
    pub(crate) fn decode(input: &mut ImmutableString) -> Result<String, Box<EvalAltResult>> {
        String::from_utf8(
            BASE64_STANDARD
                .decode(input.as_bytes())
                .map_err(|e| e.to_string())?,
        )
        .map_err(|e| e.to_string().into())
    }

    #[rhai_fn(pure, name = "decode", return_raw)]
    pub(crate) fn decode_alphabet(
        input: &mut ImmutableString,
        alphabet: Alphabet,
    ) -> Result<String, Box<EvalAltResult>> {
        let engine = get_engine(&alphabet);
        String::from_utf8(engine.decode(input.as_bytes()).map_err(|e| e.to_string())?)
            .map_err(|e| e.to_string().into())
    }

    #[rhai_fn(pure)]
    pub(crate) fn encode(input: &mut ImmutableString) -> String {
        BASE64_STANDARD.encode(input.as_bytes())
    }

    #[rhai_fn(pure, name = "encode")]
    pub(crate) fn encode_alphabet(input: &mut ImmutableString, alphabet: Alphabet) -> String {
        let engine = get_engine(&alphabet);
        engine.encode(input.as_bytes())
    }
}

#[export_module]
mod router_json {
    pub(crate) type Object = crate::json_ext::Object;
    pub(crate) type Value = crate::json_ext::Value;

    #[rhai_fn(name = "to_string", pure)]
    pub(crate) fn object_to_string(x: &mut Object) -> String {
        format!("{x:?}")
    }

    #[rhai_fn(name = "to_string", pure)]
    pub(crate) fn value_to_string(x: &mut Value) -> String {
        format!("{x:?}")
    }

    #[rhai_fn(pure, return_raw)]
    pub(crate) fn encode(input: &mut Dynamic) -> Result<String, Box<EvalAltResult>> {
        serde_json::to_string(input).map_err(|e| e.to_string().into())
    }

    #[rhai_fn(pure, return_raw)]
    pub(crate) fn decode(input: &mut ImmutableString) -> Result<Dynamic, Box<EvalAltResult>> {
        serde_json::from_str(input).map_err(|e| e.to_string().into())
    }
}

#[export_module]
mod router_sha256 {
    use sha2::Digest;

    #[rhai_fn(pure)]
    pub(crate) fn digest(input: &mut ImmutableString) -> String {
        let hash = sha2::Sha256::digest(input.as_bytes());
        hex::encode(hash)
    }
}

#[export_module]
mod router_expansion {
    pub(crate) type Expansion = expansion::Expansion;

    #[rhai_fn(name = "get", return_raw)]
    pub(crate) fn expansion_env(key: &str) -> Result<String, Box<EvalAltResult>> {
        let expander = Expansion::default_rhai().map_err(|e| e.to_string())?;
        expander
            .expand_env(key)
            .map_err(|e| e.to_string())?
            .ok_or(CANNOT_GET_ENVIRONMENT_VARIABLE.into())
    }
}

#[export_module]
mod router_method {
    pub(crate) type Method = http::Method;

    #[rhai_fn(name = "to_string", pure)]
    pub(crate) fn method_to_string(method: &mut Method) -> String {
        method.as_str().to_string()
    }

    #[rhai_fn(name = "==", pure)]
    pub(crate) fn method_equal_comparator(method: &mut Method, other: &str) -> bool {
        method.as_str().to_uppercase() == other.to_uppercase()
    }

    #[rhai_fn(name = "!=", pure)]
    pub(crate) fn method_not_equal_comparator(method: &mut Method, other: &str) -> bool {
        method.as_str().to_uppercase() != other.to_uppercase()
    }
}

#[export_module]
mod status_code {
    use rhai::INT;

    pub(crate) type StatusCode = http::StatusCode;

    #[rhai_fn(return_raw)]
    pub(crate) fn status_code_from_int(number: INT) -> Result<StatusCode, Box<EvalAltResult>> {
        let code = StatusCode::from_u16(number as u16).map_err(|e| e.to_string())?;
        Ok(code)
    }

    #[rhai_fn(name = "to_string", pure)]
    pub(crate) fn status_code_to_string(status_code: &mut StatusCode) -> String {
        status_code.as_str().to_string()
    }

    #[rhai_fn(name = "==", pure)]
    pub(crate) fn status_code_equal_comparator(
        status_code: &mut StatusCode,
        other: StatusCode,
    ) -> bool {
        status_code == &other
    }

    #[rhai_fn(name = "!=", pure)]
    pub(crate) fn status_code_not_equal_comparator(
        status_code: &mut StatusCode,
        other: StatusCode,
    ) -> bool {
        status_code != &other
    }
}

#[export_module]
mod router_header_map {
    pub(crate) type HeaderMap = http::HeaderMap;
    pub(crate) type OptionalHeaderName = Option<http::header::HeaderName>;
    pub(crate) type HeaderName = http::header::HeaderName;
    pub(crate) type HeaderValue = http::header::HeaderValue;
    pub(crate) type HeaderPair = (OptionalHeaderName, http::header::HeaderValue);

    // Register get for Header Name/Value from a tuple pair
    #[rhai_fn(get = "name", pure)]
    pub(crate) fn header_name_get(x: &mut HeaderPair) -> OptionalHeaderName {
        x.0.clone()
    }
    #[rhai_fn(get = "value", pure)]
    pub(crate) fn header_value_get(x: &mut HeaderPair) -> HeaderValue {
        x.1.clone()
    }

    // Register a contains function for HeaderMap so that "in" works
    #[rhai_fn(name = "contains", pure)]
    pub(crate) fn header_map_contains(x: &mut HeaderMap, key: &str) -> bool {
        match HeaderName::from_str(key) {
            Ok(hn) => x.contains_key(hn),
            Err(_e) => false,
        }
    }

    // Register a remove function for HeaderMap
    #[rhai_fn(name = "remove", pure, return_raw)]
    pub(crate) fn header_map_remove(
        x: &mut HeaderMap,
        key: &str,
    ) -> Result<String, Box<EvalAltResult>> {
        Ok(x.remove(key)
            .ok_or("")?
            .to_str()
            .map_err(|e| e.to_string())?
            .to_string())
    }

    // Register a HeaderMap indexer so we can get/set headers
    #[rhai_fn(index_get, pure, return_raw)]
    pub(crate) fn header_map_get(
        x: &mut HeaderMap,
        key: &str,
    ) -> Result<String, Box<EvalAltResult>> {
        let search_name =
            HeaderName::from_str(key).map_err(|e: InvalidHeaderName| e.to_string())?;
        Ok(x.get(search_name)
            .ok_or("")?
            .to_str()
            .map_err(|e| e.to_string())?
            .to_string())
    }

    #[rhai_fn(index_set, return_raw)]
    pub(crate) fn header_map_set_string(
        x: &mut HeaderMap,
        key: &str,
        value: &str,
    ) -> Result<(), Box<EvalAltResult>> {
        x.insert(
            HeaderName::from_str(key).map_err(|e| e.to_string())?,
            HeaderValue::from_str(value).map_err(|e| e.to_string())?,
        );
        Ok(())
    }

    // Register an additional setter which allows us to set multiple values for the same
    // key.
    #[rhai_fn(index_set, return_raw)]
    pub(crate) fn header_map_set_array(
        x: &mut HeaderMap,
        key: &str,
        value: Array,
    ) -> Result<(), Box<EvalAltResult>> {
        let h_key = HeaderName::from_str(key).map_err(|e| e.to_string())?;
        for v in value {
            x.append(
                h_key.clone(),
                HeaderValue::from_str(&v.into_string()?).map_err(|e| e.to_string())?,
            );
        }
        Ok(())
    }

    // Register an additional getter which allows us to get multiple values for the same
    // key.
    // Note: We can't register this as an indexer, because that would simply override the
    // existing one, which would break code. When router 2.0 is released, we should replace
    // the existing indexer_get for HeaderMap with this function and mark it as an
    // incompatible change.
    #[rhai_fn(name = "values", pure, return_raw)]
    pub(crate) fn header_map_values(
        x: &mut HeaderMap,
        key: &str,
    ) -> Result<Array, Box<EvalAltResult>> {
        let search_name =
            HeaderName::from_str(key).map_err(|e: InvalidHeaderName| e.to_string())?;
        let mut response = Array::new();
        for value in x.get_all(search_name).iter() {
            response.push(
                value
                    .to_str()
                    .map_err(|e| e.to_string())?
                    .to_string()
                    .into(),
            )
        }
        Ok(response)
    }

    #[rhai_fn(name = "to_string", pure)]
    pub(crate) fn optional_header_name_to_string(x: &mut OptionalHeaderName) -> String {
        match x {
            Some(v) => v.to_string(),
            None => "None".to_string(),
        }
    }

    #[rhai_fn(name = "to_string", pure)]
    pub(crate) fn header_name_to_string(x: &mut HeaderName) -> String {
        x.to_string()
    }

    #[rhai_fn(name = "to_string", pure)]
    pub(crate) fn header_value_to_string(x: &mut HeaderValue) -> String {
        x.to_str().map_or("".to_string(), |v| v.to_string())
    }

    #[rhai_fn(name = "to_string", pure)]
    pub(crate) fn header_map_to_string(x: &mut HeaderMap) -> String {
        let mut msg = String::new();
        for pair in x.iter() {
            let line = format!(
                "{}: {}",
                pair.0,
                pair.1.to_str().map_or("".to_string(), |v| v.to_string())
            );
            msg.push_str(line.as_ref());
            msg.push('\n');
        }
        msg
    }

    #[rhai_fn(name = "to_string", pure)]
    pub(crate) fn header_pair_to_string(x: &mut HeaderPair) -> String {
        format!(
            "{}: {}",
            match &x.0 {
                Some(v) => v.to_string(),
                None => "None".to_string(),
            },
            x.1.to_str().map_or("".to_string(), |v| v.to_string())
        )
    }
}

#[export_module]
mod router_context {
    pub(crate) type Context = crate::Context;

    // Register a contains function for Context so that "in" works
    #[rhai_fn(name = "contains", pure)]
    pub(crate) fn context_contains(x: &mut Context, key: &str) -> bool {
        x.get(key).map_or(false, |v: Option<Dynamic>| v.is_some())
    }

    // Register a Context indexer so we can get/set context
    #[rhai_fn(index_get, pure, return_raw)]
    pub(crate) fn context_get(x: &mut Context, key: &str) -> Result<Dynamic, Box<EvalAltResult>> {
        x.get(key)
            .map(|v: Option<Dynamic>| v.unwrap_or(Dynamic::UNIT))
            .map_err(|e: BoxError| e.to_string().into())
    }

    #[rhai_fn(index_set, return_raw)]
    pub(crate) fn context_set(
        x: &mut Context,
        key: &str,
        value: Dynamic,
    ) -> Result<(), Box<EvalAltResult>> {
        let _ = x
            .insert(key, value)
            .map(|v: Option<Dynamic>| v.unwrap_or(Dynamic::UNIT))
            .map_err(|e: BoxError| e.to_string())?;
        Ok(())
    }

    //Register Context.upsert()
    #[rhai_fn(name = "upsert", return_raw)]
    pub(crate) fn context_upsert(
        context: NativeCallContext,
        x: &mut Context,
        key: &str,
        callback: FnPtr,
    ) -> Result<(), Box<EvalAltResult>> {
        x.upsert(key, |v: Dynamic| -> Dynamic {
            // Note: Context::upsert() does not allow the callback to fail, although it
            // can. If call_within_context() fails, return the original provided
            // value.
            callback
                .call_within_context(&context, (v.clone(),))
                .unwrap_or(v)
        })
        .map_err(|e: BoxError| e.to_string().into())
    }

    #[rhai_fn(name = "to_string", pure)]
    pub(crate) fn context_to_string(x: &mut Context) -> String {
        format!("{x:?}")
    }

    #[rhai_fn(get = "context", pure, return_raw)]
    pub(crate) fn router_first_response_context_get(
        obj: &mut SharedMut<router::FirstResponse>,
    ) -> Result<Context, Box<EvalAltResult>> {
        Ok(obj.with_mut(|response| response.context.clone()))
    }
    #[rhai_fn(get = "id", pure)]
    pub(crate) fn router_first_response_id_get(
        obj: &mut SharedMut<router::FirstResponse>,
    ) -> String {
        obj.with_mut(|response| response.context.id.clone())
    }
    #[rhai_fn(set = "context", return_raw)]
    pub(crate) fn router_first_response_context_set(
        obj: &mut SharedMut<router::FirstResponse>,
        context: Context,
    ) -> Result<(), Box<EvalAltResult>> {
        obj.with_mut(|response| response.context = context);
        Ok(())
    }
    #[rhai_fn(get = "status_code", pure)]
    pub(crate) fn router_first_response_status_code_get(
        obj: &mut SharedMut<router::FirstResponse>,
    ) -> status_code::StatusCode {
        obj.with_mut(|response| response.response.status())
    }

    #[rhai_fn(get = "context", pure, return_raw)]
    pub(crate) fn supergraph_first_response_context_get(
        obj: &mut SharedMut<supergraph::FirstResponse>,
    ) -> Result<Context, Box<EvalAltResult>> {
        Ok(obj.with_mut(|response| response.context.clone()))
    }
    #[rhai_fn(get = "id", pure)]
    pub(crate) fn supergraph_first_response_id_get(
        obj: &mut SharedMut<supergraph::FirstResponse>,
    ) -> String {
        obj.with_mut(|response| response.context.id.clone())
    }
    #[rhai_fn(set = "context", return_raw)]
    pub(crate) fn supergraph_first_response_context_set(
        obj: &mut SharedMut<supergraph::FirstResponse>,
        context: Context,
    ) -> Result<(), Box<EvalAltResult>> {
        obj.with_mut(|response| response.context = context);
        Ok(())
    }

    #[rhai_fn(get = "context", pure, return_raw)]
    pub(crate) fn execution_first_response_context_get(
        obj: &mut SharedMut<execution::FirstResponse>,
    ) -> Result<Context, Box<EvalAltResult>> {
        Ok(obj.with_mut(|response| response.context.clone()))
    }
    #[rhai_fn(get = "id", pure)]
    pub(crate) fn execution_first_response_id_get(
        obj: &mut SharedMut<execution::FirstResponse>,
    ) -> String {
        obj.with_mut(|response| response.context.id.clone())
    }
    #[rhai_fn(set = "context", return_raw)]
    pub(crate) fn execution_first_response_context_set(
        obj: &mut SharedMut<execution::FirstResponse>,
        context: Context,
    ) -> Result<(), Box<EvalAltResult>> {
        obj.with_mut(|response| response.context = context);
        Ok(())
    }

    // Add context getter/setters for deferred responses
    #[rhai_fn(get = "context", pure, return_raw)]
    pub(crate) fn router_deferred_response_context_get(
        obj: &mut SharedMut<router::DeferredResponse>,
    ) -> Result<Context, Box<EvalAltResult>> {
        Ok(obj.with_mut(|response| response.context.clone()))
    }
    #[rhai_fn(get = "id", pure)]
    pub(crate) fn router_deferred_response_id_get(
        obj: &mut SharedMut<router::DeferredResponse>,
    ) -> String {
        obj.with_mut(|response| response.context.id.clone())
    }
    #[rhai_fn(set = "context", return_raw)]
    pub(crate) fn router_deferred_response_context_set(
        obj: &mut SharedMut<router::DeferredResponse>,
        context: Context,
    ) -> Result<(), Box<EvalAltResult>> {
        obj.with_mut(|response| response.context = context);
        Ok(())
    }

    #[rhai_fn(get = "context", pure, return_raw)]
    pub(crate) fn supergraph_deferred_response_context_get(
        obj: &mut SharedMut<supergraph::DeferredResponse>,
    ) -> Result<Context, Box<EvalAltResult>> {
        Ok(obj.with_mut(|response| response.context.clone()))
    }
    #[rhai_fn(get = "id", pure)]
    pub(crate) fn supergraph_deferred_response_id_get(
        obj: &mut SharedMut<supergraph::DeferredResponse>,
    ) -> String {
        obj.with_mut(|response| response.context.id.clone())
    }
    #[rhai_fn(set = "context", return_raw)]
    pub(crate) fn supergraph_deferred_response_context_set(
        obj: &mut SharedMut<supergraph::DeferredResponse>,
        context: Context,
    ) -> Result<(), Box<EvalAltResult>> {
        obj.with_mut(|response| response.context = context);
        Ok(())
    }

    #[rhai_fn(get = "context", pure, return_raw)]
    pub(crate) fn execution_deferred_response_context_get(
        obj: &mut SharedMut<execution::DeferredResponse>,
    ) -> Result<Context, Box<EvalAltResult>> {
        Ok(obj.with_mut(|response| response.context.clone()))
    }
    #[rhai_fn(get = "id", pure)]
    pub(crate) fn execution_deferred_response_id_get(
        obj: &mut SharedMut<execution::DeferredResponse>,
    ) -> String {
        obj.with_mut(|response| response.context.id.clone())
    }
    #[rhai_fn(set = "context", return_raw)]
    pub(crate) fn execution_deferred_response_context_set(
        obj: &mut SharedMut<execution::DeferredResponse>,
        context: Context,
    ) -> Result<(), Box<EvalAltResult>> {
        obj.with_mut(|response| response.context = context);
        Ok(())
    }
}

// We have to keep the modules that we export using `export_module` inline because
// error[E0658]: non-inline modules in proc macro input are unstable
#[export_module]
mod router_plugin {
    pub(crate) type HeaderMap = http::HeaderMap;
    pub(crate) type Request = crate::graphql::Request;
    pub(crate) type Response = crate::graphql::Response;
    pub(crate) type Error = crate::error::Error;
    pub(crate) type Uri = http::Uri;
    pub(crate) type TraceId = crate::tracer::TraceId;

    // It would be nice to generate get_originating_headers and
    // set_originating_headers for all response types.
    // However, variations in the composition
    // of <Type>Response means this isn't currently possible.
    // We could revisit this later if these structures are re-shaped.

    // The next group of functions are specifically for interacting
    // with the subgraph_request on a SubgraphRequest.
    #[rhai_fn(get = "subgraph", pure, return_raw)]
    pub(crate) fn get_subgraph(
        obj: &mut SharedMut<subgraph::Request>,
    ) -> Result<http_ext::Request<Request>, Box<EvalAltResult>> {
        Ok(obj.with_mut(|request| (&request.subgraph_request).into()))
    }

    #[rhai_fn(set = "subgraph", return_raw)]
    pub(crate) fn set_subgraph(
        obj: &mut SharedMut<subgraph::Request>,
        sub: http_ext::Request<Request>,
    ) -> Result<(), Box<EvalAltResult>> {
        obj.with_mut(|request| {
            request.subgraph_request = sub.inner;
            Ok(())
        })
    }

    #[rhai_fn(get = "headers", pure, return_raw)]
    pub(crate) fn get_subgraph_headers(
        obj: &mut http_ext::Request<Request>,
    ) -> Result<HeaderMap, Box<EvalAltResult>> {
        Ok(obj.headers().clone())
    }

    #[rhai_fn(set = "headers", return_raw)]
    pub(crate) fn set_subgraph_headers(
        obj: &mut http_ext::Request<Request>,
        headers: HeaderMap,
    ) -> Result<(), Box<EvalAltResult>> {
        *obj.headers_mut() = headers;
        Ok(())
    }

    #[rhai_fn(get = "body", pure, return_raw)]
    pub(crate) fn get_subgraph_body(
        obj: &mut http_ext::Request<Request>,
    ) -> Result<Request, Box<EvalAltResult>> {
        Ok(obj.body().clone())
    }

    #[rhai_fn(set = "body", return_raw)]
    pub(crate) fn set_subgraph_body(
        obj: &mut http_ext::Request<Request>,
        body: Request,
    ) -> Result<(), Box<EvalAltResult>> {
        *obj.body_mut() = body;
        Ok(())
    }

    #[rhai_fn(get = "uri", pure, return_raw)]
    pub(crate) fn get_subgraph_uri(
        obj: &mut http_ext::Request<Request>,
    ) -> Result<Uri, Box<EvalAltResult>> {
        Ok(obj.uri().clone())
    }

    #[rhai_fn(set = "uri", return_raw)]
    pub(crate) fn set_subgraph_uri(
        obj: &mut http_ext::Request<Request>,
        uri: Uri,
    ) -> Result<(), Box<EvalAltResult>> {
        *obj.uri_mut() = uri;
        Ok(())
    }
    // End of SubgraphRequest specific section

    #[rhai_fn(get = "headers", pure, return_raw)]
    pub(crate) fn get_originating_headers_router_response(
        obj: &mut SharedMut<router::FirstResponse>,
    ) -> Result<HeaderMap, Box<EvalAltResult>> {
        Ok(obj.with_mut(|response| response.response.headers().clone()))
    }

    #[rhai_fn(name = "is_primary", pure)]
    pub(crate) fn router_response_is_primary(_obj: &mut SharedMut<router::FirstResponse>) -> bool {
        true
    }

    #[rhai_fn(get = "headers", pure, return_raw)]
    pub(crate) fn get_originating_headers_router_deferred_response(
        _obj: &mut SharedMut<router::DeferredResponse>,
    ) -> Result<HeaderMap, Box<EvalAltResult>> {
        Err(CANNOT_ACCESS_HEADERS_ON_A_DEFERRED_RESPONSE.into())
    }

    #[rhai_fn(get = "status_code", pure, return_raw)]
    pub(crate) fn get_status_code_router_deferred_response(
        _obj: &mut SharedMut<router::DeferredResponse>,
    ) -> Result<HeaderMap, Box<EvalAltResult>> {
        Err(CANNOT_ACCESS_STATUS_CODE_ON_A_DEFERRED_RESPONSE.into())
    }

    #[rhai_fn(name = "is_primary", pure)]
    pub(crate) fn router_deferred_response_is_primary(
        _obj: &mut SharedMut<router::DeferredResponse>,
    ) -> bool {
        false
    }

    #[rhai_fn(get = "headers", pure, return_raw)]
    pub(crate) fn get_originating_headers_supergraph_response(
        obj: &mut SharedMut<supergraph::FirstResponse>,
    ) -> Result<HeaderMap, Box<EvalAltResult>> {
        Ok(obj.with_mut(|response| response.response.headers().clone()))
    }

    #[rhai_fn(name = "is_primary", pure)]
    pub(crate) fn supergraph_response_is_primary(
        _obj: &mut SharedMut<supergraph::FirstResponse>,
    ) -> bool {
        true
    }

    #[rhai_fn(get = "headers", pure, return_raw)]
    pub(crate) fn get_originating_headers_supergraph_deferred_response(
        _obj: &mut SharedMut<supergraph::DeferredResponse>,
    ) -> Result<HeaderMap, Box<EvalAltResult>> {
        Err(CANNOT_ACCESS_HEADERS_ON_A_DEFERRED_RESPONSE.into())
    }

    #[rhai_fn(name = "is_primary", pure)]
    pub(crate) fn supergraph_deferred_response_is_primary(
        _obj: &mut SharedMut<supergraph::DeferredResponse>,
    ) -> bool {
        false
    }

    #[rhai_fn(get = "headers", pure, return_raw)]
    pub(crate) fn get_originating_headers_execution_response(
        obj: &mut SharedMut<execution::FirstResponse>,
    ) -> Result<HeaderMap, Box<EvalAltResult>> {
        Ok(obj.with_mut(|response| response.response.headers().clone()))
    }

    #[rhai_fn(name = "is_primary", pure)]
    pub(crate) fn execution_response_is_primary(
        _obj: &mut SharedMut<execution::FirstResponse>,
    ) -> bool {
        true
    }

    #[rhai_fn(get = "headers", pure, return_raw)]
    pub(crate) fn get_originating_headers_execution_deferred_response(
        _obj: &mut SharedMut<execution::DeferredResponse>,
    ) -> Result<HeaderMap, Box<EvalAltResult>> {
        Err(CANNOT_ACCESS_HEADERS_ON_A_DEFERRED_RESPONSE.into())
    }

    #[rhai_fn(name = "is_primary", pure)]
    pub(crate) fn execution_deferred_response_is_primary(
        _obj: &mut SharedMut<execution::DeferredResponse>,
    ) -> bool {
        false
    }

    #[rhai_fn(get = "headers", pure, return_raw)]
    pub(crate) fn get_originating_headers_subgraph_response(
        obj: &mut SharedMut<subgraph::Response>,
    ) -> Result<HeaderMap, Box<EvalAltResult>> {
        Ok(obj.with_mut(|response| response.response.headers().clone()))
    }

    /*TODO: reenable when https://github.com/apollographql/router/issues/3642 is decided
    #[rhai_fn(get = "body", pure, return_raw)]
    pub(crate) fn get_originating_body_router_response(
        obj: &mut SharedMut<router::FirstResponse>,
    ) -> Result<Vec<u8>, Box<EvalAltResult>> {
        Ok(obj.with_mut(|response| response.response.body().to_vec()))
    }*/

    #[rhai_fn(get = "body", pure, return_raw)]
    pub(crate) fn get_originating_body_supergraph_response(
        obj: &mut SharedMut<supergraph::FirstResponse>,
    ) -> Result<Response, Box<EvalAltResult>> {
        Ok(obj.with_mut(|response| response.response.body().clone()))
    }

    #[rhai_fn(get = "body", pure, return_raw)]
    pub(crate) fn get_originating_body_execution_response(
        obj: &mut SharedMut<execution::FirstResponse>,
    ) -> Result<Response, Box<EvalAltResult>> {
        Ok(obj.with_mut(|response| response.response.body().clone()))
    }

    #[rhai_fn(get = "body", pure, return_raw)]
    pub(crate) fn get_originating_body_subgraph_response(
        obj: &mut SharedMut<subgraph::Response>,
    ) -> Result<Response, Box<EvalAltResult>> {
        Ok(obj.with_mut(|response| response.response.body().clone()))
    }

    /*TODO: reenable when https://github.com/apollographql/router/issues/3642 is decided
    #[rhai_fn(get = "body", pure, return_raw)]
    pub(crate) fn get_originating_body_router_deferred_response(
        obj: &mut SharedMut<router::DeferredResponse>,
    ) -> Result<String, Box<EvalAltResult>> {
        // Get the body
        let bytes = obj.with_mut(|response| {
            let bytes = std::mem::take(&mut response.response);
            // Copy back the response so it can continue to be used
            response.response = bytes.clone();
            Ok::<Bytes, Box<EvalAltResult>>(bytes)
        })?;

        String::from_utf8(bytes.to_vec()).map_err(|err| err.to_string().into())
    }*/

    #[rhai_fn(get = "body", pure, return_raw)]
    pub(crate) fn get_originating_body_supergraph_deferred_response(
        obj: &mut SharedMut<supergraph::DeferredResponse>,
    ) -> Result<Response, Box<EvalAltResult>> {
        Ok(obj.with_mut(|response| response.response.clone()))
    }

    #[rhai_fn(get = "body", pure, return_raw)]
    pub(crate) fn get_originating_body_execution_deferred_response(
        obj: &mut SharedMut<execution::DeferredResponse>,
    ) -> Result<Response, Box<EvalAltResult>> {
        Ok(obj.with_mut(|response| response.response.clone()))
    }

    #[rhai_fn(set = "headers", return_raw)]
    pub(crate) fn set_originating_headers_router_response(
        obj: &mut SharedMut<router::FirstResponse>,
        headers: HeaderMap,
    ) -> Result<(), Box<EvalAltResult>> {
        obj.with_mut(|response| *response.response.headers_mut() = headers);
        Ok(())
    }

    #[rhai_fn(set = "headers", return_raw)]
    pub(crate) fn set_originating_headers_router_deferred_response(
        _obj: &mut SharedMut<router::DeferredResponse>,
        _headers: HeaderMap,
    ) -> Result<(), Box<EvalAltResult>> {
        Err(CANNOT_ACCESS_HEADERS_ON_A_DEFERRED_RESPONSE.into())
    }

    #[rhai_fn(set = "headers", return_raw)]
    pub(crate) fn set_originating_headers_supergraph_response(
        obj: &mut SharedMut<supergraph::FirstResponse>,
        headers: HeaderMap,
    ) -> Result<(), Box<EvalAltResult>> {
        obj.with_mut(|response| *response.response.headers_mut() = headers);
        Ok(())
    }

    #[rhai_fn(set = "headers", return_raw)]
    pub(crate) fn set_originating_headers_supergraph_deferred_response(
        _obj: &mut SharedMut<supergraph::DeferredResponse>,
        _headers: HeaderMap,
    ) -> Result<(), Box<EvalAltResult>> {
        Err(CANNOT_ACCESS_HEADERS_ON_A_DEFERRED_RESPONSE.into())
    }

    #[rhai_fn(set = "headers", return_raw)]
    pub(crate) fn set_originating_headers_execution_response(
        obj: &mut SharedMut<execution::FirstResponse>,
        headers: HeaderMap,
    ) -> Result<(), Box<EvalAltResult>> {
        obj.with_mut(|response| *response.response.headers_mut() = headers);
        Ok(())
    }

    #[rhai_fn(set = "headers", return_raw)]
    pub(crate) fn set_originating_headers_execution_deferred_response(
        _obj: &mut SharedMut<execution::DeferredResponse>,
        _headers: HeaderMap,
    ) -> Result<(), Box<EvalAltResult>> {
        Err(CANNOT_ACCESS_HEADERS_ON_A_DEFERRED_RESPONSE.into())
    }

    #[rhai_fn(set = "headers", return_raw)]
    pub(crate) fn set_originating_headers_subgraph_response(
        obj: &mut SharedMut<subgraph::Response>,
        headers: HeaderMap,
    ) -> Result<(), Box<EvalAltResult>> {
        obj.with_mut(|response| *response.response.headers_mut() = headers);
        Ok(())
    }

    /*TODO: reenable when https://github.com/apollographql/router/issues/3642 is decided
    #[rhai_fn(set = "body", return_raw)]
    pub(crate) fn set_originating_body_router_response(
        obj: &mut SharedMut<router::FirstResponse>,
        body: String,
    ) -> Result<(), Box<EvalAltResult>> {
        let bytes = Bytes::from(body);
        obj.with_mut(|response| *response.response.body_mut() = bytes);
        Ok(())
    }*/

    #[rhai_fn(set = "body", return_raw)]
    pub(crate) fn set_originating_body_supergraph_response(
        obj: &mut SharedMut<supergraph::FirstResponse>,
        body: Response,
    ) -> Result<(), Box<EvalAltResult>> {
        obj.with_mut(|response| *response.response.body_mut() = body);
        Ok(())
    }

    #[rhai_fn(set = "body", return_raw)]
    pub(crate) fn set_originating_body_execution_response(
        obj: &mut SharedMut<execution::FirstResponse>,
        body: Response,
    ) -> Result<(), Box<EvalAltResult>> {
        obj.with_mut(|response| *response.response.body_mut() = body);
        Ok(())
    }

    #[rhai_fn(set = "body", return_raw)]
    pub(crate) fn set_originating_body_subraph_response(
        obj: &mut SharedMut<subgraph::Response>,
        body: Response,
    ) -> Result<(), Box<EvalAltResult>> {
        obj.with_mut(|response| *response.response.body_mut() = body);
        Ok(())
    }

    /*TODO: reenable when https://github.com/apollographql/router/issues/3642 is decided
    #[rhai_fn(set = "body", return_raw)]
    pub(crate) fn set_originating_body_router_deferred_response(
        obj: &mut SharedMut<router::DeferredResponse>,
        body: String,
    ) -> Result<(), Box<EvalAltResult>> {
        let bytes = Bytes::from(body);
        obj.with_mut(|response| response.response = bytes);
        Ok(())
    }*/

    #[rhai_fn(set = "body", return_raw)]
    pub(crate) fn set_originating_body_supergraph_deferred_response(
        obj: &mut SharedMut<supergraph::DeferredResponse>,
        body: Response,
    ) -> Result<(), Box<EvalAltResult>> {
        obj.with_mut(|response| response.response = body);
        Ok(())
    }

    #[rhai_fn(set = "body", return_raw)]
    pub(crate) fn set_originating_body_execution_deferred_response(
        obj: &mut SharedMut<execution::DeferredResponse>,
        body: Response,
    ) -> Result<(), Box<EvalAltResult>> {
        obj.with_mut(|response| response.response = body);
        Ok(())
    }

    pub(crate) fn map_request(rhai_service: &mut RhaiService, callback: FnPtr) {
        rhai_service
            .service
            .map_request(rhai_service.clone(), callback)
    }

    pub(crate) fn map_response(rhai_service: &mut RhaiService, callback: FnPtr) {
        rhai_service
            .service
            .map_response(rhai_service.clone(), callback)
    }

    // Register urlencode/decode functions
    #[rhai_fn(pure)]
    pub(crate) fn urlencode(x: &mut ImmutableString) -> String {
        urlencoding::encode(x).into_owned()
    }

    #[rhai_fn(pure, return_raw)]
    pub(crate) fn urldecode(x: &mut ImmutableString) -> Result<String, Box<EvalAltResult>> {
        Ok(urlencoding::decode(x)
            .map_err(|e| e.to_string())?
            .into_owned())
    }

    #[rhai_fn(name = "headers_are_available", pure)]
    pub(crate) fn router_response(_: &mut SharedMut<router::FirstResponse>) -> bool {
        true
    }

    /*TODO: reenable when https://github.com/apollographql/router/issues/3642 is decided
    #[rhai_fn(name = "headers_are_available", pure)]
    pub(crate) fn router_deferred_response(_: &mut SharedMut<router::DeferredResponse>) -> bool {
        false
    }*/

    #[rhai_fn(name = "headers_are_available", pure)]
    pub(crate) fn supergraph_response(_: &mut SharedMut<supergraph::FirstResponse>) -> bool {
        true
    }

    #[rhai_fn(name = "headers_are_available", pure)]
    pub(crate) fn supergraph_deferred_response(
        _: &mut SharedMut<supergraph::DeferredResponse>,
    ) -> bool {
        false
    }

    #[rhai_fn(name = "headers_are_available", pure)]
    pub(crate) fn execution_response(_: &mut SharedMut<execution::FirstResponse>) -> bool {
        true
    }

    #[rhai_fn(name = "headers_are_available", pure)]
    pub(crate) fn execution_deferred_response(
        _: &mut SharedMut<execution::DeferredResponse>,
    ) -> bool {
        false
    }

    // Request.query
    #[rhai_fn(get = "query", pure)]
    pub(crate) fn request_query_get(x: &mut Request) -> Dynamic {
        x.query.clone().map_or(Dynamic::UNIT, Dynamic::from)
    }

    #[rhai_fn(set = "query")]
    pub(crate) fn request_query_set(x: &mut Request, value: &str) {
        x.query = Some(value.to_string());
    }

    // Request.operation_name
    #[rhai_fn(get = "operation_name", pure)]
    pub(crate) fn request_operation_name_get(x: &mut Request) -> Dynamic {
        x.operation_name
            .clone()
            .map_or(Dynamic::UNIT, Dynamic::from)
    }

    #[rhai_fn(set = "operation_name")]
    pub(crate) fn request_operation_name_set(x: &mut Request, value: &str) {
        x.operation_name = Some(value.to_string());
    }

    // Request.variables
    #[rhai_fn(get = "variables", pure, return_raw)]
    pub(crate) fn request_variables_get(x: &mut Request) -> Result<Dynamic, Box<EvalAltResult>> {
        to_dynamic(x.variables.clone())
    }

    #[rhai_fn(set = "variables", return_raw)]
    pub(crate) fn request_variables_set(
        x: &mut Request,
        om: Map,
    ) -> Result<(), Box<EvalAltResult>> {
        x.variables = from_dynamic(&om.into())?;
        Ok(())
    }

    // Request.extensions
    #[rhai_fn(get = "extensions", pure, return_raw)]
    pub(crate) fn request_extensions_get(x: &mut Request) -> Result<Dynamic, Box<EvalAltResult>> {
        to_dynamic(x.extensions.clone())
    }

    #[rhai_fn(set = "extensions", return_raw)]
    pub(crate) fn request_extensions_set(
        x: &mut Request,
        om: Map,
    ) -> Result<(), Box<EvalAltResult>> {
        x.extensions = from_dynamic(&om.into())?;
        Ok(())
    }

    // Uri.path
    #[rhai_fn(get = "path", pure, return_raw)]
    pub(crate) fn uri_path_get(x: &mut Uri) -> Result<Dynamic, Box<EvalAltResult>> {
        to_dynamic(x.path())
    }

    #[rhai_fn(set = "path", return_raw)]
    pub(crate) fn uri_path_set(x: &mut Uri, value: &str) -> Result<(), Box<EvalAltResult>> {
        // Because there is no simple way to update parts on an existing
        // Uri (no parts_mut()), then we need to create a new Uri from our
        // existing parts, preserving any query, and update our existing
        // Uri.
        let mut parts: Parts = x.clone().into_parts();
        parts.path_and_query = match parts
            .path_and_query
            .ok_or("path and query are missing")?
            .query()
        {
            Some(query) => Some(
                PathAndQuery::from_maybe_shared(format!("{value}?{query}"))
                    .map_err(|e| e.to_string())?,
            ),
            None => Some(PathAndQuery::from_str(value).map_err(|e| e.to_string())?),
        };
        *x = Uri::from_parts(parts).map_err(|e| e.to_string())?;
        Ok(())
    }

    // Uri.host
    #[rhai_fn(get = "host", pure, return_raw)]
    pub(crate) fn uri_host_get(x: &mut Uri) -> Result<Dynamic, Box<EvalAltResult>> {
        to_dynamic(x.host())
    }

    #[rhai_fn(set = "host", return_raw)]
    pub(crate) fn uri_host_set(x: &mut Uri, value: &str) -> Result<(), Box<EvalAltResult>> {
        // Because there is no simple way to update parts on an existing
        // Uri (no parts_mut()), then we need to create a new Uri from our
        // existing parts, preserving any port, and update our existing
        // Uri.
        let mut parts: Parts = x.clone().into_parts();
        let new_authority = match parts.authority {
            Some(old_authority) => {
                if let Some(port) = old_authority.port() {
                    Authority::from_maybe_shared(format!("{value}:{port}"))
                        .map_err(|e| e.to_string())?
                } else {
                    Authority::from_str(value).map_err(|e| e.to_string())?
                }
            }
            None => Authority::from_str(value).map_err(|e| e.to_string())?,
        };
        parts.authority = Some(new_authority);
        *x = Uri::from_parts(parts).map_err(|e| e.to_string())?;
        Ok(())
    }

    // Response.label
    #[rhai_fn(get = "label", pure)]
    pub(crate) fn response_label_get(x: &mut Response) -> Dynamic {
        x.label.clone().map_or(Dynamic::UNIT, Dynamic::from)
    }

    #[rhai_fn(set = "label")]
    pub(crate) fn response_label_set(x: &mut Response, value: &str) {
        x.label = Some(value.to_string());
    }

    // Response.data
    #[rhai_fn(get = "data", pure, return_raw)]
    pub(crate) fn response_data_get(x: &mut Response) -> Result<Dynamic, Box<EvalAltResult>> {
        to_dynamic(x.data.clone())
    }

    #[rhai_fn(set = "data", return_raw)]
    pub(crate) fn response_data_set(x: &mut Response, om: Map) -> Result<(), Box<EvalAltResult>> {
        x.data = from_dynamic(&om.into())?;
        Ok(())
    }

    // Response.path (Not Implemented)
    // Response.errors
    #[rhai_fn(get = "errors", pure, return_raw)]
    pub(crate) fn response_errors_get(x: &mut Response) -> Result<Dynamic, Box<EvalAltResult>> {
        to_dynamic(x.errors.clone())
    }

    #[rhai_fn(set = "errors", return_raw)]
    pub(crate) fn response_errors_set(
        x: &mut Response,
        value: Dynamic,
    ) -> Result<(), Box<EvalAltResult>> {
        x.errors = from_dynamic(&value)?;
        Ok(())
    }

    // Response.extensions
    #[rhai_fn(get = "extensions", pure, return_raw)]
    pub(crate) fn response_extensions_get(x: &mut Response) -> Result<Dynamic, Box<EvalAltResult>> {
        to_dynamic(x.extensions.clone())
    }

    #[rhai_fn(set = "extensions", return_raw)]
    pub(crate) fn response_extensions_set(
        x: &mut Response,
        om: Map,
    ) -> Result<(), Box<EvalAltResult>> {
        x.extensions = from_dynamic(&om.into())?;
        Ok(())
    }

    // TraceId support
    #[rhai_fn(return_raw)]
    pub(crate) fn traceid() -> Result<TraceId, Box<EvalAltResult>> {
        TraceId::maybe_new()
            .or_else(TraceId::current)
            .ok_or_else(|| "trace unavailable".into())
    }

    #[rhai_fn(name = "to_string")]
    pub(crate) fn traceid_to_string(id: &mut TraceId) -> String {
        id.to_string()
    }

    // Register a function for printing to stderr
    pub(crate) fn eprint(x: &str) {
        eprintln!("{x}");
    }

    // Default representation in rhai is the "type", so
    // we need to register a to_string function for all our registered
    // types so we can interact meaningfully with them.

    #[rhai_fn(name = "to_string")]
    pub(crate) fn request_to_string(x: &mut Request) -> String {
        format!("{x:?}")
    }

    #[rhai_fn(name = "to_string")]
    pub(crate) fn response_to_string(x: &mut Response) -> String {
        format!("{x:?}")
    }

    #[rhai_fn(name = "to_string")]
    pub(crate) fn error_to_string(x: &mut Error) -> String {
        format!("{x:?}")
    }

    #[rhai_fn(name = "to_string")]
    pub(crate) fn uri_to_string(x: &mut Uri) -> String {
        format!("{x:?}")
    }

    pub(crate) fn uuid_v4() -> String {
        Uuid::new_v4().to_string()
    }

    #[rhai_fn(return_raw)]
    pub(crate) fn unix_now() -> Result<i64, Box<EvalAltResult>> {
        SystemTime::now()
            .duration_since(SystemTime::UNIX_EPOCH)
            .map_err(|e| e.to_string().into())
            .map(|x| x.as_secs() as i64)
    }

    #[rhai_fn(return_raw)]
    pub(crate) fn unix_ms_now() -> Result<i64, Box<EvalAltResult>> {
        SystemTime::now()
            .duration_since(SystemTime::UNIX_EPOCH)
            .map_err(|e| e.to_string().into())
            .map(|x| x.as_millis() as i64)
    }

    // Add query plan getter to execution request
    #[rhai_fn(get = "query_plan")]
    pub(crate) fn execution_request_query_plan_get(
        obj: &mut SharedMut<execution::Request>,
    ) -> String {
        obj.with_mut(|request| {
            request
                .query_plan
                .formatted_query_plan
                .as_deref()
                .cloned()
                .unwrap_or_default()
        })
    }
}

#[derive(Default)]
pub(crate) struct RhaiRouterFirstRequest {
    pub(crate) context: Context,
    pub(crate) request: http::Request<()>,
}

#[allow(dead_code)]
#[derive(Default)]
pub(crate) struct RhaiRouterChunkedRequest {
    pub(crate) context: Context,
    pub(crate) request: Bytes,
}

#[derive(Default)]
pub(crate) struct RhaiRouterResponse {
    pub(crate) context: Context,
    pub(crate) response: http::Response<()>,
}

#[allow(dead_code)]
#[derive(Default)]
pub(crate) struct RhaiRouterChunkedResponse {
    pub(crate) context: Context,
    pub(crate) response: Bytes,
}

#[derive(Default)]
pub(crate) struct RhaiSupergraphResponse {
    pub(crate) context: Context,
    pub(crate) response: http_ext::Response<Response>,
}

#[derive(Default)]
pub(crate) struct RhaiSupergraphDeferredResponse {
    pub(crate) context: Context,
    pub(crate) response: Response,
}

#[derive(Default)]
pub(crate) struct RhaiExecutionResponse {
    pub(crate) context: Context,
    pub(crate) response: http_ext::Response<Response>,
}

#[derive(Default)]
pub(crate) struct RhaiExecutionDeferredResponse {
    pub(crate) context: Context,
    pub(crate) response: Response,
}

macro_rules! if_subgraph {
    ( subgraph => $subgraph: block else $not_subgraph: block ) => {
        $subgraph
    };
    ( $base: ident => $subgraph: block else $not_subgraph: block ) => {
        $not_subgraph
    };
}

macro_rules! register_rhai_router_interface {
    ($engine: ident, $($base: ident), *) => {
        $(
            // Context stuff
            $engine.register_get(
                "context",
                |obj: &mut SharedMut<$base::FirstRequest>| -> Result<Context, Box<EvalAltResult>> {
                    Ok(obj.with_mut(|request| request.context.clone()))
                }
            )
            .register_get(
                "context",
                |obj: &mut SharedMut<$base::ChunkedRequest>| -> Result<Context, Box<EvalAltResult>> {
                    Ok(obj.with_mut(|request| request.context.clone()))
                }
            ).register_get(
                "context",
                |obj: &mut SharedMut<$base::Response>| -> Result<Context, Box<EvalAltResult>> {
                    Ok(obj.with_mut(|response| response.context.clone()))
                }
            )
            .register_get(
                "context",
                |obj: &mut SharedMut<$base::DeferredResponse>| -> Result<Context, Box<EvalAltResult>> {
                    Ok(obj.with_mut(|response| response.context.clone()))
                }
            );

            $engine.register_set(
                "context",
                |obj: &mut SharedMut<$base::FirstRequest>, context: Context| {
                    obj.with_mut(|request| request.context = context);
                    Ok(())
                }
            )
            .register_set(
                "context",
                |obj: &mut SharedMut<$base::ChunkedRequest>, context: Context| {
                    obj.with_mut(|request| request.context = context);
                    Ok(())
                }
            )
            .register_set(
                "context",
                |obj: &mut SharedMut<$base::Response>, context: Context| {
                    obj.with_mut(|response| response.context = context);
                    Ok(())
                }
            ).register_set(
                "context",
                |obj: &mut SharedMut<$base::DeferredResponse>, context: Context| {
                    obj.with_mut(|response| response.context = context);
                    Ok(())
                }
            );

            // Id
            $engine.register_get(
                "id",
                |obj: &mut SharedMut<$base::FirstRequest>| -> String {
                    obj.with_mut(|request| request.context.id.clone())
                }
            )
            .register_get(
                "id",
                |obj: &mut SharedMut<$base::ChunkedRequest>| -> String {
                    obj.with_mut(|request| request.context.id.clone())
                }
            )
            .register_get(
                "id",
                |obj: &mut SharedMut<$base::Response>| -> String {
                    obj.with_mut(|response| response.context.id.clone())
                }
            )
            .register_get(
                "id",
                |obj: &mut SharedMut<$base::DeferredResponse>| -> String {
                    obj.with_mut(|response| response.context.id.clone())
                }
            );

            // Originating Request
            $engine.register_get(
                "headers",
                |obj: &mut SharedMut<$base::FirstRequest>| -> Result<HeaderMap, Box<EvalAltResult>> {
                    Ok(obj.with_mut(|request| request.request.headers().clone()))
                }
            ).register_get(
                "headers",
                |obj: &mut SharedMut<$base::Response>| -> Result<HeaderMap, Box<EvalAltResult>> {
                    Ok(obj.with_mut(|response| response.response.headers().clone()))
                }
            );

            $engine.register_set(
                "headers",
                |obj: &mut SharedMut<$base::FirstRequest>, headers: HeaderMap| {
                    if_subgraph! {
                        $base => {
                            let _unused = (obj, headers);
                            Err("cannot mutate originating request on a subgraph".into())
                        } else {
                            obj.with_mut(|request| *request.request.headers_mut() = headers);
                            Ok(())
                        }
                    }
                }
            ).register_set(
                "headers",
                |obj: &mut SharedMut<$base::Response>, headers: HeaderMap| {
                    if_subgraph! {
                        $base => {
                            let _unused = (obj, headers);
                            Err("cannot mutate originating request on a subgraph".into())
                        } else {
                            obj.with_mut(|response| *response.response.headers_mut() = headers);
                            Ok(())
                        }
                    }
                }
            );

            /*TODO: reenable when https://github.com/apollographql/router/issues/3642 is decided
            $engine.register_get(
                "body",
                |obj: &mut SharedMut<$base::ChunkedRequest>| -> Result<Vec<u8>, Box<EvalAltResult>> {
                    Ok( obj.with_mut(|request| { request.request.to_vec()}))
                }
            );

            $engine.register_set(
                "body",
                |obj: &mut SharedMut<$base::ChunkedRequest>, body: Vec<u8>| {
                    if_subgraph! {
                        $base => {
                            let _unused = (obj, body);
                            Err("cannot mutate originating request on a subgraph".into())
                        } else {
                            let bytes = Bytes::from(body);
                            obj.with_mut(|request| request.request = bytes);
                            Ok(())
                        }
                    }
                }
            );*/

            $engine.register_get(
                "uri",
                |obj: &mut SharedMut<$base::Request>| -> Result<Uri, Box<EvalAltResult>> {
                    Ok(obj.with_mut(|request| request.router_request.uri().clone()))
                }
            );
            $engine.register_set(
                "uri",
                |obj: &mut SharedMut<$base::Request>, uri: Uri| {
                    if_subgraph! {
                        $base => {
                            let _unused = (obj, uri);
                            Err("cannot mutate originating request on a subgraph".into())
                        } else {
                            obj.with_mut(|request| *request.router_request.uri_mut() = uri);
                            Ok(())
                        }
                    }
                }
            );
        )*
    };
}

macro_rules! register_rhai_interface {
    ($engine: ident, $($base: ident), *) => {
        $(
            // Context stuff
            $engine.register_get(
                "context",
                |obj: &mut SharedMut<$base::Request>| -> Result<Context, Box<EvalAltResult>> {
                    Ok(obj.with_mut(|request| request.context.clone()))
                }
            )
            .register_get(
                "context",
                |obj: &mut SharedMut<$base::Response>| -> Result<Context, Box<EvalAltResult>> {
                    Ok(obj.with_mut(|response| response.context.clone()))
                }
            );

            $engine.register_get(
                "status_code",
                |obj: &mut SharedMut<$base::Response>| -> Result<StatusCode, Box<EvalAltResult>> {
                    Ok(obj.with_mut(|response| response.response.status()))
                }
            );

            $engine.register_set(
                "context",
                |obj: &mut SharedMut<$base::Request>, context: Context| {
                    obj.with_mut(|request| request.context = context);
                    Ok(())
                }
            )
            .register_set(
                "context",
                |obj: &mut SharedMut<$base::Response>, context: Context| {
                    obj.with_mut(|response| response.context = context);
                    Ok(())
                }
            );

            // Id
            $engine.register_get(
                "id",
                |obj: &mut SharedMut<$base::Request>| -> String {
                    obj.with_mut(|request| request.context.id.clone())
                }
            )
            .register_get(
                "id",
                |obj: &mut SharedMut<$base::Response>| -> String {
                    obj.with_mut(|response| response.context.id.clone())
                }
            );

            // Originating Request
            $engine.register_get(
                "headers",
                |obj: &mut SharedMut<$base::Request>| -> Result<HeaderMap, Box<EvalAltResult>> {
                    Ok(obj.with_mut(|request| request.supergraph_request.headers().clone()))
                }
            );

            $engine.register_set(
                "headers",
                |obj: &mut SharedMut<$base::Request>, headers: HeaderMap| {
                    if_subgraph! {
                        $base => {
                            let _unused = (obj, headers);
                            Err("cannot mutate originating request on a subgraph".into())
                        } else {
                            obj.with_mut(|request| *request.supergraph_request.headers_mut() = headers);
                            Ok(())
                        }
                    }
                }
            );

            $engine.register_get(
                "method",
                |obj: &mut SharedMut<$base::Request>| -> Result<Method, Box<EvalAltResult>> {
                    Ok(obj.with_mut(|request| request.supergraph_request.method().clone()))
                }
            );

            $engine.register_get(
                "body",
                |obj: &mut SharedMut<$base::Request>| -> Result<Request, Box<EvalAltResult>> {
                    Ok(obj.with_mut(|request| request.supergraph_request.body().clone()))
                }
            );

            $engine.register_set(
                "body",
                |obj: &mut SharedMut<$base::Request>, body: Request| {
                    if_subgraph! {
                        $base => {
                            let _unused = (obj, body);
                            Err("cannot mutate originating request on a subgraph".into())
                        } else {
                            obj.with_mut(|request| *request.supergraph_request.body_mut() = body);
                            Ok(())
                        }
                    }
                }
            );

            $engine.register_get(
                "uri",
                |obj: &mut SharedMut<$base::Request>| -> Result<Uri, Box<EvalAltResult>> {
                    Ok(obj.with_mut(|request| request.supergraph_request.uri().clone()))
                }
            );

            $engine.register_set(
                "uri",
                |obj: &mut SharedMut<$base::Request>, uri: Uri| {
                    if_subgraph! {
                        $base => {
                            let _unused = (obj, uri);
                            Err("cannot mutate originating request on a subgraph".into())
                        } else {
                            obj.with_mut(|request| *request.supergraph_request.uri_mut() = uri);
                            Ok(())
                        }
                    }
                }
            );
        )*
    };
}

#[derive(Clone, Debug)]
pub(crate) struct RhaiService {
    pub(super) scope: Arc<Mutex<Scope<'static>>>,
    pub(super) service: ServiceStep,
    pub(super) engine: Arc<Engine>,
    pub(super) ast: AST,
}

impl Rhai {
    pub(super) fn run_rhai_service(
        &self,
        function_name: &str,
        subgraph: Option<&str>,
        service: ServiceStep,
        scope: Arc<Mutex<Scope<'static>>>,
    ) -> Result<(), String> {
        let block = self.block.load();
        let rhai_service = RhaiService {
            scope: scope.clone(),
            service,
            engine: block.engine.clone(),
            ast: block.ast.clone(),
        };
        let mut guard = scope.lock().unwrap();
        // Note: We don't use `process_error()` here, because this code executes in the context of
        // the pipeline processing. We can't return an HTTP error, we can only return a boxed
        // service which represents the next stage of the pipeline.
        // We could have an error pipeline which always returns results, but that's a big
        // change and one that requires more thought in the future.
        match subgraph {
            Some(name) => {
                block
                    .engine
                    .call_fn(
                        &mut guard,
                        &block.ast,
                        function_name,
                        (rhai_service, name.to_string()),
                    )
                    .map_err(|err| err.to_string())?;
            }
            None => {
                block
                    .engine
                    .call_fn(&mut guard, &block.ast, function_name, (rhai_service,))
                    .map_err(|err| err.to_string())?;
            }
        }

        Ok(())
    }

    pub(super) fn new_rhai_engine(path: Option<PathBuf>, sdl: String, main: PathBuf) -> Engine {
        let mut engine = Engine::new();
        // If we pass in a path, use it to configure our engine
        // with a FileModuleResolver which allows import to work
        // in scripts.
        if let Some(scripts) = path {
            let resolver = FileModuleResolver::new_with_path(scripts);
            engine.set_module_resolver(resolver);
        }

        // The macro call creates a Rhai module from the plugin module.
        let mut module = exported_module!(router_plugin);
        combine_with_exported_module!(&mut module, "header", router_header_map);
        combine_with_exported_module!(&mut module, "method", router_method);
        combine_with_exported_module!(&mut module, "status_code", status_code);
        combine_with_exported_module!(&mut module, "context", router_context);

        let base64_module = exported_module!(router_base64);
        let json_module = exported_module!(router_json);
        let sha256_module = exported_module!(router_sha256);

        let expansion_module = exported_module!(router_expansion);

        // Share main so we can move copies into each closure as required for logging
        let shared_main = Arc::new(main.display().to_string());

        let trace_main = shared_main.clone();
        let debug_main = shared_main.clone();
        let info_main = shared_main.clone();
        let warn_main = shared_main.clone();
        let error_main = shared_main.clone();

        let print_main = shared_main;

        // Configure our engine for execution
        engine
            .set_max_expr_depths(0, 0)
            .on_print(move |message| {
                tracing::info!(%message, target = %print_main);
            })
            // Register our plugin module
            .register_global_module(module.into())
            // Register our base64 module (not global)
            .register_static_module("base64", base64_module.into())
            // Register our json module (not global)
            .register_static_module("json", json_module.into())
            // Register our SHA256 module (not global)
            .register_static_module("sha256", sha256_module.into())
            // Register our expansion module (not global)
            // Hide the fact that it is an expansion module by calling it "env"
            .register_static_module("env", expansion_module.into())
            // Register HeaderMap as an iterator so we can loop over contents
            .register_iterator::<HeaderMap>()
            // Register a series of logging functions
            .register_fn("log_trace", move |message: Dynamic| {
                tracing::trace!(%message, target = %trace_main);
            })
            .register_fn("log_debug", move |message: Dynamic| {
                tracing::debug!(%message, target = %debug_main);
            })
            .register_fn("log_info", move |message: Dynamic| {
                tracing::info!(%message, target = %info_main);
            })
            .register_fn("log_warn", move |message: Dynamic| {
                tracing::warn!(%message, target = %warn_main);
            })
            .register_fn("log_error", move |message: Dynamic| {
                tracing::error!(%message, target = %error_main);
            });
        // Add common getter/setters for different types
        register_rhai_router_interface!(engine, router);
        // Add common getter/setters for different types
        register_rhai_interface!(engine, supergraph, execution, subgraph);

        // Since constants in Rhai don't give us the behaviour we expect, let's create some global
        // variables which we use in a variable resolver when we create our engine.
        // Note: We keep the constants for now, since they are documented.
        let mut global_variables = Map::new();
        global_variables.insert("APOLLO_SDL".into(), sdl.into());
        global_variables.insert("APOLLO_START".into(), Instant::now().into());
        global_variables.insert(
            "APOLLO_AUTHENTICATION_JWT_CLAIMS".into(),
            APOLLO_AUTHENTICATION_JWT_CLAIMS.to_string().into(),
        );
        global_variables.insert(
            "APOLLO_SUBSCRIPTION_WS_CUSTOM_CONNECTION_PARAMS".into(),
            SUBSCRIPTION_WS_CUSTOM_CONNECTION_PARAMS.to_string().into(),
        );
        global_variables.insert("APOLLO_ENTITY_CACHE_KEY".into(), CONTEXT_CACHE_KEY.into());
        global_variables.insert("APOLLO_OPERATION_ID".into(), APOLLO_OPERATION_ID.into());

        let shared_globals = Arc::new(global_variables);

        // Register a variable resolver.
        // Note: This API is NOT deprecated, but it is considered volatile and may change in the future.
        #[allow(deprecated)]
        engine.on_var(move |name, _index, _context| {
            match name {
                // Intercept attempts to find "Router" variables and return our "global variables"
                // Note: Wrapped in an Arc to lighten the load of cloning.
                "Router" => Ok(Some((*shared_globals).clone().into())),
                // Return Ok(None) to continue with the normal variable resolution process.
                _ => Ok(None),
            }
        });
        engine
    }

    pub(super) fn ast_has_function(&self, name: &str) -> bool {
        self.block
            .load()
            .ast
            .iter_fn_def()
            .any(|fn_def| fn_def.name == name)
    }
}