forked_react_compiler_hir 0.1.4

// Copyright (c) Meta Platforms, Inc. and affiliates.
//
// This source code is licensed under the MIT license found in the
// LICENSE file in the root directory of this source tree.

//! Environment configuration, ported from EnvironmentConfigSchema in Environment.ts.
//!
//! Contains feature flags and custom hook definitions that control compiler behavior.

use std::collections::HashMap;

use serde::{Deserialize, Serialize};

use crate::type_config::{TypeConfig, ValueKind};
use crate::Effect;

/// External function reference (source module + import name).
/// Corresponds to TS `ExternalFunction`.
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct ExternalFunctionConfig {
    pub source: String,
    pub import_specifier_name: String,
}

/// Instrumentation configuration.
/// Corresponds to TS `InstrumentationSchema`.
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct InstrumentationConfig {
    #[serde(rename = "fn")]
    pub fn_: ExternalFunctionConfig,
    #[serde(default)]
    pub gating: Option<ExternalFunctionConfig>,
    #[serde(default)]
    pub global_gating: Option<String>,
}

/// Custom hook configuration, ported from TS `HookSchema`.
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct HookConfig {
    pub effect_kind: Effect,
    pub value_kind: ValueKind,
    #[serde(default)]
    pub no_alias: bool,
    #[serde(default)]
    pub transitive_mixed_data: bool,
}

#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
pub enum ExhaustiveEffectDepsMode {
    #[serde(rename = "off")]
    Off,
    #[serde(rename = "all")]
    All,
    #[serde(rename = "missing-only")]
    MissingOnly,
    #[serde(rename = "extra-only")]
    ExtraOnly,
}

impl Default for ExhaustiveEffectDepsMode {
    fn default() -> Self {
        Self::Off
    }
}

fn default_true() -> bool {
    true
}

/// Compiler environment configuration. Contains feature flags and settings.
///
/// Fields that would require passing JS functions across the JS/Rust boundary
/// are omitted with TODO comments. The Rust port uses hardcoded defaults for
/// these (e.g., `defaultModuleTypeProvider`).
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct EnvironmentConfig {
    /// Custom hook type definitions, keyed by hook name.
    #[serde(default)]
    pub custom_hooks: HashMap<String, HookConfig>,

    /// Pre-resolved module type provider results.
    /// Map from module name to TypeConfig, computed by the JS shim.
    #[serde(default)]
    pub module_type_provider: Option<indexmap::IndexMap<String, TypeConfig>>,

    /// Custom macro-like function names that should have their operands
    /// memoized in the same scope (similar to fbt).
    #[serde(default)]
    pub custom_macros: Option<Vec<String>>,

    /// If true, emit code to reset the memo cache on source file changes (HMR/fast refresh).
    /// If null (None), HMR detection is conditionally enabled based on NODE_ENV/__DEV__.
    #[serde(default)]
    pub enable_reset_cache_on_source_file_changes: Option<bool>,

    #[serde(default = "default_true")]
    pub enable_preserve_existing_memoization_guarantees: bool,
    #[serde(default = "default_true")]
    pub validate_preserve_existing_memoization_guarantees: bool,
    #[serde(default = "default_true")]
    pub validate_exhaustive_memoization_dependencies: bool,
    #[serde(default)]
    pub validate_exhaustive_effect_dependencies: ExhaustiveEffectDepsMode,

    // TODO: flowTypeProvider — requires JS function callback.

    #[serde(default = "default_true")]
    pub enable_optional_dependencies: bool,
    #[serde(default)]
    pub enable_name_anonymous_functions: bool,
    #[serde(default = "default_true")]
    pub validate_hooks_usage: bool,
    #[serde(default = "default_true")]
    pub validate_ref_access_during_render: bool,
    #[serde(default = "default_true")]
    pub validate_no_set_state_in_render: bool,
    #[serde(default)]
    pub enable_use_keyed_state: bool,
    #[serde(default)]
    pub validate_no_set_state_in_effects: bool,
    #[serde(default)]
    pub validate_no_derived_computations_in_effects: bool,
    #[serde(default)]
    #[serde(alias = "validateNoDerivedComputationsInEffects_exp")]
    pub validate_no_derived_computations_in_effects_exp: bool,
    #[serde(default)]
    #[serde(alias = "validateNoJSXInTryStatements")]
    pub validate_no_jsx_in_try_statements: bool,
    #[serde(default)]
    pub validate_static_components: bool,
    #[serde(default)]
    pub validate_no_capitalized_calls: Option<Vec<String>>,
    #[serde(default)]
    #[serde(alias = "restrictedImports")]
    pub validate_blocklisted_imports: Option<Vec<String>>,
    #[serde(default)]
    pub validate_source_locations: bool,
    #[serde(default)]
    pub validate_no_impure_functions_in_render: bool,
    #[serde(default)]
    pub validate_no_freezing_known_mutable_functions: bool,
    #[serde(default = "default_true")]
    pub enable_assume_hooks_follow_rules_of_react: bool,
    #[serde(default = "default_true")]
    pub enable_transitively_freeze_function_expressions: bool,

    /// Hook guard configuration. When set, wraps hook calls with dispatcher guard calls.
    #[serde(default)]
    pub enable_emit_hook_guards: Option<ExternalFunctionConfig>,

    /// Instrumentation configuration. When set, emits calls to instrument functions.
    #[serde(default)]
    pub enable_emit_instrument_forget: Option<InstrumentationConfig>,

    #[serde(default = "default_true")]
    pub enable_function_outlining: bool,
    #[serde(default)]
    pub enable_jsx_outlining: bool,
    #[serde(default)]
    pub assert_valid_mutable_ranges: bool,
    #[serde(default)]
    #[serde(alias = "throwUnknownException__testonly")]
    pub throw_unknown_exception_testonly: bool,
    #[serde(default)]
    pub enable_custom_type_definition_for_reanimated: bool,
    #[serde(default = "default_true")]
    pub enable_treat_ref_like_identifiers_as_refs: bool,
    #[serde(default)]
    pub enable_treat_set_identifiers_as_state_setters: bool,
    #[serde(default = "default_true")]
    pub validate_no_void_use_memo: bool,
    #[serde(default = "default_true")]
    pub enable_allow_set_state_from_refs_in_effects: bool,
    #[serde(default)]
    pub enable_verbose_no_set_state_in_effect: bool,

    // 🌲
    #[serde(default)]
    pub enable_forest: bool,
}

impl Default for EnvironmentConfig {
    fn default() -> Self {
        Self {
            custom_hooks: HashMap::new(),
            enable_reset_cache_on_source_file_changes: None,
            module_type_provider: None,
            enable_preserve_existing_memoization_guarantees: true,
            validate_preserve_existing_memoization_guarantees: true,
            validate_exhaustive_memoization_dependencies: true,
            validate_exhaustive_effect_dependencies: ExhaustiveEffectDepsMode::Off,
            enable_optional_dependencies: true,
            enable_name_anonymous_functions: false,
            validate_hooks_usage: true,
            validate_ref_access_during_render: true,
            validate_no_set_state_in_render: true,
            enable_use_keyed_state: false,
            validate_no_set_state_in_effects: false,
            validate_no_derived_computations_in_effects: false,
            validate_no_derived_computations_in_effects_exp: false,
            validate_no_jsx_in_try_statements: false,
            validate_static_components: false,
            validate_no_capitalized_calls: None,
            validate_blocklisted_imports: None,
            validate_source_locations: false,
            validate_no_impure_functions_in_render: false,
            validate_no_freezing_known_mutable_functions: false,
            enable_assume_hooks_follow_rules_of_react: true,
            enable_transitively_freeze_function_expressions: true,
            enable_emit_hook_guards: None,
            enable_emit_instrument_forget: None,
            enable_function_outlining: true,
            enable_jsx_outlining: false,
            assert_valid_mutable_ranges: false,
            throw_unknown_exception_testonly: false,
            enable_custom_type_definition_for_reanimated: false,
            enable_treat_ref_like_identifiers_as_refs: true,
            enable_treat_set_identifiers_as_state_setters: false,
            validate_no_void_use_memo: true,
            enable_allow_set_state_from_refs_in_effects: true,
            enable_verbose_no_set_state_in_effect: false,
            enable_forest: false,
            custom_macros: None,
        }
    }
}