All files / src/internal/client/reactivity sources.js

98.96% Statements 192/194
97.87% Branches 46/47
100% Functions 8/8
98.94% Lines 187/189

Press n or j to go to the next uncovered block, b, p or k for the previous block.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 2142x 2x                                 2x 2x                 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 30526x 30526x 30526x 30526x 30526x 30526x 30526x 30526x 2x 2x 2x 2x 2x 2x 760x 760x 2x 2x 2x 2x 2x 2x 2x 2x 21198x 21198x 21198x 21198x 21198x 21198x 15910x 15910x 21198x 21198x 21198x 2x 2x 2x 2x 2x 2x 2x 4849x 4849x 2x 2x 2x 2x 2x 2x 5609x 5609x 12x 8x 12x 4x 4x 12x 5609x 5609x 5609x 2x 2x 2x 2x 2x 2x 2x 778x 778x 778x 778x 778x 778x 2x 2x 2x 2x 2x 2x 2x 2x 24210x 24210x 24210x 24210x 4x 4x 4x 24210x     24210x 24210x 20881x 20881x 20881x 20881x 20881x 20881x 20881x 20881x 20881x 20881x 20881x 20881x 20881x 20881x 160x 20881x 103x 14x 14x 103x 89x 79x 89x 10x 10x 89x 103x 20881x 20881x 20881x 28x 28x 20881x 20881x 20881x 20881x 24210x 24210x 24210x 2x 2x 2x 2x 2x 2x 27169x 27169x 27169x 20340x 20340x 20340x 20340x 27156x 26770x 26770x 26770x 26770x 26770x 24274x 24274x 26770x 24116x 24116x 26770x 29x 29x 29x 24087x 24087x 24087x 24087x 26764x 22476x 6288x 22351x 16188x 16188x 22476x 26770x 27169x  
/** @import { Derived, Effect, Reaction, Source, Value } from '#client' */
import { DEV } from 'esm-env';
import {
	current_component_context,
	current_reaction,
	new_deps,
	current_effect,
	current_untracked_writes,
	get,
	is_runes,
	schedule_effect,
	set_current_untracked_writes,
	set_signal_status,
	untrack,
	increment_version,
	update_effect,
	derived_sources,
	set_derived_sources
} from '../runtime.js';
import { equals, safe_equals } from './equality.js';
import {
	CLEAN,
	DERIVED,
	DIRTY,
	BRANCH_EFFECT,
	INSPECT_EFFECT,
	UNOWNED,
	MAYBE_DIRTY
} from '../constants.js';
import * as e from '../errors.js';
 
let inspect_effects = new Set();
 
/**
 * @template V
 * @param {V} v
 * @returns {Source<V>}
 */
export function source(v) {
	return {
		f: 0, // TODO ideally we could skip this altogether, but it causes type errors
		v,
		reactions: null,
		equals,
		version: 0
	};
}
 
/**
 * @template V
 * @param {V} v
 */
export function state(v) {
	return push_derived_source(source(v));
}
 
/**
 * @template V
 * @param {V} initial_value
 * @returns {Source<V>}
 */
/*#__NO_SIDE_EFFECTS__*/
export function mutable_source(initial_value) {
	const s = source(initial_value);
	s.equals = safe_equals;
 
	// bind the signal to the component context, in case we need to
	// track updates to trigger beforeUpdate/afterUpdate callbacks
	if (current_component_context !== null && current_component_context.l !== null) {
		(current_component_context.l.s ??= []).push(s);
	}
 
	return s;
}
 
/**
 * @template V
 * @param {V} v
 * @returns {Source<V>}
 */
export function mutable_state(v) {
	return push_derived_source(mutable_source(v));
}
 
/**
 * @template V
 * @param {Source<V>} source
 */
/*#__NO_SIDE_EFFECTS__*/
function push_derived_source(source) {
	if (current_reaction !== null && (current_reaction.f & DERIVED) !== 0) {
		if (derived_sources === null) {
			set_derived_sources([source]);
		} else {
			derived_sources.push(source);
		}
	}
 
	return source;
}
 
/**
 * @template V
 * @param {Value<V>} source
 * @param {V} value
 */
export function mutate(source, value) {
	set(
		source,
		untrack(() => get(source))
	);
	return value;
}
 
/**
 * @template V
 * @param {Source<V>} source
 * @param {V} value
 * @returns {V}
 */
export function set(source, value) {
	if (
		current_reaction !== null &&
		is_runes() &&
		(current_reaction.f & DERIVED) !== 0 &&
		// If the source was created locally within the current derived, then
		// we allow the mutation.
		(derived_sources === null || !derived_sources.includes(source))
	) {
		e.state_unsafe_mutation();
	}
 
	if (!source.equals(value)) {
		source.v = value;
		source.version = increment_version();
 
		mark_reactions(source, DIRTY);
 
		// If the current signal is running for the first time, it won't have any
		// reactions as we only allocate and assign the reactions after the signal
		// has fully executed. So in the case of ensuring it registers the reaction
		// properly for itself, we need to ensure the current effect actually gets
		// scheduled. i.e: `$effect(() => x++)`
		if (
			is_runes() &&
			current_effect !== null &&
			(current_effect.f & CLEAN) !== 0 &&
			(current_effect.f & BRANCH_EFFECT) === 0
		) {
			if (new_deps !== null && new_deps.includes(source)) {
				set_signal_status(current_effect, DIRTY);
				schedule_effect(current_effect);
			} else {
				if (current_untracked_writes === null) {
					set_current_untracked_writes([source]);
				} else {
					current_untracked_writes.push(source);
				}
			}
		}
 
		if (DEV) {
			for (const effect of inspect_effects) {
				update_effect(effect);
			}
 
			inspect_effects.clear();
		}
	}
 
	return value;
}
 
/**
 * @param {Value} signal
 * @param {number} status should be DIRTY or MAYBE_DIRTY
 * @returns {void}
 */
function mark_reactions(signal, status) {
	var reactions = signal.reactions;
	if (reactions === null) return;
 
	var runes = is_runes();
	var length = reactions.length;
 
	for (var i = 0; i < length; i++) {
		var reaction = reactions[i];
		var flags = reaction.f;
 
		// Skip any effects that are already dirty
		if ((flags & DIRTY) !== 0) continue;
 
		// In legacy mode, skip the current effect to prevent infinite loops
		if (!runes && reaction === current_effect) continue;
 
		// Inspect effects need to run immediately, so that the stack trace makes sense
		if (DEV && (flags & INSPECT_EFFECT) !== 0) {
			inspect_effects.add(reaction);
			continue;
		}
 
		set_signal_status(reaction, status);
 
		// If the signal a) was previously clean or b) is an unowned derived, then mark it
		if ((flags & (CLEAN | UNOWNED)) !== 0) {
			if ((flags & DERIVED) !== 0) {
				mark_reactions(/** @type {Derived} */ (reaction), MAYBE_DIRTY);
			} else {
				schedule_effect(/** @type {Effect} */ (reaction));
			}
		}
	}
}