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

98.88% Statements 177/179
97.36% Branches 37/38
100% Functions 5/5
98.85% Lines 172/174

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 1752x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 37572x 37572x 37572x 37572x 37572x 37572x 37572x 37572x 2x 2x 2x 2x 2x 2x 2x 2x 23700x 23700x 23700x 23700x 23700x 23700x 18160x 18160x 23700x 23700x 23700x 2x 2x 2x 2x 2x 2x 2x 782x 782x 782x 782x 782x 782x 2x 2x 2x 2x 2x 2x 2x 2x 24274x     24274x 24274x 20879x 20879x 20879x 20879x 20879x 20879x 20879x 20879x 20879x 20879x 20879x 20879x 20879x 20879x 20879x 20879x 20879x 20879x 135x 20879x 99x 14x 14x 99x 85x 77x 85x 8x 8x 85x 99x 20879x 20879x 20879x 22x 22x 20879x 20879x 20879x 20879x 24274x 24274x 24274x 2x 2x 2x 2x 2x 2x 27083x 27083x 27083x 20107x 20107x 20107x 20107x 27083x 24613x 24613x 24613x 24613x 24613x 23133x 23133x 24613x 23027x 23027x 24613x 24x 24x 24x 23003x 23003x 23003x 23003x 24608x 22252x 6204x 22127x 16048x 16048x 22252x 24613x 27083x  
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
} 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 {import('#client').Source<V>}
 */
/*#__NO_SIDE_EFFECTS__*/
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} initial_value
 * @returns {import('#client').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 {import('#client').Value<V>} source
 * @param {V} value
 */
export function mutate(source, value) {
	set(
		source,
		untrack(() => get(source))
	);
	return value;
}
 
/**
 * @template V
 * @param {import('#client').Source<V>} source
 * @param {V} value
 * @returns {V}
 */
export function set(source, value) {
	if (current_reaction !== null && is_runes() && (current_reaction.f & DERIVED) !== 0) {
		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++)
		//
		// We additionally want to skip this logic when initialising store sources
		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 {import('#client').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 {import('#client').Derived} */ (reaction), MAYBE_DIRTY);
			} else {
				schedule_effect(/** @type {import('#client').Effect} */ (reaction));
			}
		}
	}
}