feat: support nesting for composite color strip sources
Lint & Test / test (push) Successful in 2m17s
Lint & Test / test (push) Successful in 2m17s
Allow composite sources to reference other composite/mapped sources as layers. Adds cycle detection (via transitive dependency graph walk), depth limiting (MAX_COMPOSITE_DEPTH=4), and a runtime safety net in the stream manager. Frontend layer dropdown now shows all source types except the source being edited. 17 new tests covering cycles, depth limits, and valid nesting — all 715 tests passing.
This commit is contained in:
@@ -366,6 +366,20 @@ async def create_color_strip_source(
|
||||
"""Create a new color strip source."""
|
||||
try:
|
||||
kwargs = _extract_css_kwargs(data)
|
||||
|
||||
# Validate nesting for composite/mapped sources before creating
|
||||
if data.source_type == "composite" and kwargs.get("layers"):
|
||||
child_ids = [ly.get("source_id", "") for ly in kwargs["layers"] if ly.get("source_id")]
|
||||
# No parent_id yet (new source), just check depth
|
||||
from wled_controller.storage.color_strip_store import MAX_COMPOSITE_DEPTH
|
||||
|
||||
for cid in child_ids:
|
||||
depth = store.get_nesting_depth(cid)
|
||||
if 1 + depth > MAX_COMPOSITE_DEPTH:
|
||||
raise ValueError(
|
||||
f"Nesting depth {1 + depth} exceeds maximum of {MAX_COMPOSITE_DEPTH}"
|
||||
)
|
||||
|
||||
source = store.create_source(source_type=data.source_type, **kwargs)
|
||||
fire_entity_event("color_strip_source", "created", source.id)
|
||||
return _css_to_response(source)
|
||||
@@ -414,6 +428,12 @@ async def update_color_strip_source(
|
||||
"""Update a color strip source and hot-reload any running streams."""
|
||||
try:
|
||||
kwargs = _extract_css_kwargs(data)
|
||||
|
||||
# Validate nesting for composite sources before updating
|
||||
if data.source_type == "composite" and kwargs.get("layers") is not None:
|
||||
child_ids = [ly.get("source_id", "") for ly in kwargs["layers"] if ly.get("source_id")]
|
||||
store.validate_nesting(source_id, child_ids)
|
||||
|
||||
source = store.update_source(source_id=source_id, **kwargs)
|
||||
|
||||
# Hot-reload running stream (no restart needed for in-place param changes)
|
||||
|
||||
@@ -220,7 +220,7 @@ class ColorStripStreamManager:
|
||||
return composite
|
||||
return css_id
|
||||
|
||||
def acquire(self, css_id: str, consumer_id: str = "") -> ColorStripStream:
|
||||
def acquire(self, css_id: str, consumer_id: str = "", depth: int = 0) -> ColorStripStream:
|
||||
"""Get or create a ColorStripStream for the given ColorStripSource.
|
||||
|
||||
Sharable sources (picture) are shared — keyed by css_id, ref-counted.
|
||||
@@ -231,6 +231,8 @@ class ColorStripStreamManager:
|
||||
css_id: ID of the ColorStripSource config
|
||||
consumer_id: Unique consumer identifier (target_id) — used as
|
||||
registry key for non-sharable streams.
|
||||
depth: Current nesting depth (passed to composite streams for
|
||||
runtime depth guarding).
|
||||
|
||||
Returns:
|
||||
ColorStripStream instance
|
||||
@@ -259,7 +261,7 @@ class ColorStripStreamManager:
|
||||
)
|
||||
|
||||
css_stream = CompositeColorStripStream(
|
||||
source, self, self._value_stream_manager, self._cspt_store
|
||||
source, self, self._value_stream_manager, self._cspt_store, depth=depth
|
||||
)
|
||||
elif source.source_type == "mapped":
|
||||
from wled_controller.core.processing.mapped_stream import MappedColorStripStream
|
||||
|
||||
@@ -25,10 +25,16 @@ _BLEND_DIFFERENCE = "difference"
|
||||
_BLEND_EXCLUSION = "exclusion"
|
||||
|
||||
|
||||
_MAX_RUNTIME_DEPTH = 4
|
||||
|
||||
|
||||
class CompositeColorStripStream(ColorStripStream):
|
||||
"""Blends multiple ColorStripStreams as layers with blend modes and opacity.
|
||||
|
||||
Each layer references an existing (non-composite) ColorStripSource.
|
||||
Layers may reference any ColorStripSource, including other composites
|
||||
(nesting). Cycle detection and depth limits are enforced by the store
|
||||
at save time; a runtime depth guard provides a safety net.
|
||||
|
||||
Sub-streams are acquired from the ColorStripStreamManager so picture
|
||||
sources share their existing capture pipeline.
|
||||
|
||||
@@ -36,11 +42,14 @@ class CompositeColorStripStream(ColorStripStream):
|
||||
sub-stream's latest colors and blending bottom-to-top.
|
||||
"""
|
||||
|
||||
def __init__(self, source, css_manager, value_stream_manager=None, cspt_store=None):
|
||||
def __init__(
|
||||
self, source, css_manager, value_stream_manager=None, cspt_store=None, depth: int = 0
|
||||
):
|
||||
import uuid as _uuid
|
||||
|
||||
self._source_id: str = source.id
|
||||
self._instance_id: str = _uuid.uuid4().hex[:8] # unique per instance to avoid release races
|
||||
self._depth: int = depth
|
||||
self._layers: List[dict] = list(source.layers)
|
||||
self._led_count: int = source.led_count
|
||||
self._auto_size: bool = source.led_count == 0
|
||||
@@ -207,6 +216,12 @@ class CompositeColorStripStream(ColorStripStream):
|
||||
|
||||
def _acquire_sub_streams(self) -> None:
|
||||
self._sub_streams_version += 1
|
||||
if self._depth >= _MAX_RUNTIME_DEPTH:
|
||||
logger.warning(
|
||||
f"CompositeColorStripStream {self._source_id} at depth {self._depth} — "
|
||||
f"skipping sub-stream acquisition (max depth {_MAX_RUNTIME_DEPTH})"
|
||||
)
|
||||
return
|
||||
for i, layer in enumerate(self._layers):
|
||||
if not layer.get("enabled", True):
|
||||
continue
|
||||
@@ -215,7 +230,7 @@ class CompositeColorStripStream(ColorStripStream):
|
||||
continue
|
||||
consumer_id = f"{self._source_id}__{self._instance_id}__layer_{i}"
|
||||
try:
|
||||
stream = self._css_manager.acquire(src_id, consumer_id)
|
||||
stream = self._css_manager.acquire(src_id, consumer_id, depth=self._depth + 1)
|
||||
if hasattr(stream, "configure") and self._led_count > 0:
|
||||
# Configure with zone length if layer has a range, else full strip
|
||||
layer_start = layer.get("start", 0)
|
||||
|
||||
@@ -1432,7 +1432,7 @@ export async function showCSSEditor(cssId: any = null, cloneData: any = null, pr
|
||||
await valueSourcesCache.fetch().catch((): any[] => []);
|
||||
const allCssSources: any[] = await colorStripSourcesCache.fetch().catch((): any[] => []);
|
||||
compositeSetAvailableSources(allCssSources.filter(s =>
|
||||
s.source_type !== 'composite' && (!cssId || s.id !== cssId)
|
||||
!cssId || s.id !== cssId
|
||||
));
|
||||
mappedSetAvailableSources(allCssSources.filter(s =>
|
||||
s.source_type !== 'mapped' && (!cssId || s.id !== cssId)
|
||||
@@ -1484,7 +1484,7 @@ export async function showCSSEditor(cssId: any = null, cloneData: any = null, pr
|
||||
(document.getElementById('css-editor-name') as HTMLInputElement).value = css.name;
|
||||
if (css.source_type === 'composite') {
|
||||
compositeSetAvailableSources(allCssSources.filter(s =>
|
||||
s.source_type !== 'composite' && s.id !== css.id
|
||||
s.id !== css.id
|
||||
));
|
||||
} else if (css.source_type === 'mapped') {
|
||||
mappedSetAvailableSources(allCssSources.filter(s =>
|
||||
|
||||
@@ -17,6 +17,8 @@ from wled_controller.utils import get_logger
|
||||
|
||||
logger = get_logger(__name__)
|
||||
|
||||
MAX_COMPOSITE_DEPTH = 4
|
||||
|
||||
|
||||
class ColorStripStore(BaseSqliteStore[ColorStripSource]):
|
||||
"""Persistent storage for color strip sources."""
|
||||
@@ -35,8 +37,7 @@ class ColorStripStore(BaseSqliteStore[ColorStripSource]):
|
||||
"""Get a color strip source by ID (alias for get())."""
|
||||
return self.get(source_id)
|
||||
|
||||
def create_source(self, name: str, source_type: str = "picture",
|
||||
**kwargs) -> ColorStripSource:
|
||||
def create_source(self, name: str, source_type: str = "picture", **kwargs) -> ColorStripSource:
|
||||
"""Create a new color strip source.
|
||||
|
||||
All type-specific parameters are passed as keyword arguments and
|
||||
@@ -138,6 +139,111 @@ class ColorStripStore(BaseSqliteStore[ColorStripSource]):
|
||||
break
|
||||
return names
|
||||
|
||||
def get_transitive_dependencies(self, source_id: str) -> set[str]:
|
||||
"""Return the set of all source IDs that *source_id* transitively depends on.
|
||||
|
||||
Walks composite layers and mapped zones to build the full dependency graph.
|
||||
"""
|
||||
visited: set[str] = set()
|
||||
stack = [source_id]
|
||||
while stack:
|
||||
current = stack.pop()
|
||||
if current in visited:
|
||||
continue
|
||||
visited.add(current)
|
||||
source = self._items.get(current)
|
||||
if source is None:
|
||||
continue
|
||||
child_ids: list[str] = []
|
||||
if isinstance(source, CompositeColorStripSource):
|
||||
child_ids = [
|
||||
layer.get("source_id", "") for layer in source.layers if layer.get("source_id")
|
||||
]
|
||||
elif isinstance(source, MappedColorStripSource):
|
||||
child_ids = [
|
||||
zone.get("source_id", "") for zone in source.zones if zone.get("source_id")
|
||||
]
|
||||
elif isinstance(source, ProcessedColorStripSource):
|
||||
if source.input_source_id:
|
||||
child_ids = [source.input_source_id]
|
||||
stack.extend(cid for cid in child_ids if cid not in visited)
|
||||
visited.discard(source_id) # exclude self from dependency set
|
||||
return visited
|
||||
|
||||
def get_nesting_depth(self, source_id: str) -> int:
|
||||
"""Return the maximum nesting depth reachable from *source_id*.
|
||||
|
||||
Leaf sources have depth 0. A composite with only leaf layers has depth 1.
|
||||
"""
|
||||
cache: dict[str, int] = {}
|
||||
|
||||
def _depth(sid: str, path: frozenset[str]) -> int:
|
||||
if sid in cache:
|
||||
return cache[sid]
|
||||
source = self._items.get(sid)
|
||||
if source is None:
|
||||
return 0
|
||||
child_ids: list[str] = []
|
||||
if isinstance(source, CompositeColorStripSource):
|
||||
child_ids = [ly.get("source_id", "") for ly in source.layers if ly.get("source_id")]
|
||||
elif isinstance(source, MappedColorStripSource):
|
||||
child_ids = [z.get("source_id", "") for z in source.zones if z.get("source_id")]
|
||||
elif isinstance(source, ProcessedColorStripSource):
|
||||
if source.input_source_id:
|
||||
child_ids = [source.input_source_id]
|
||||
if not child_ids:
|
||||
cache[sid] = 0
|
||||
return 0
|
||||
max_child = 0
|
||||
for cid in child_ids:
|
||||
if cid in path:
|
||||
continue # skip cycles (validated separately)
|
||||
max_child = max(max_child, _depth(cid, path | {cid}))
|
||||
depth = 1 + max_child
|
||||
cache[sid] = depth
|
||||
return depth
|
||||
|
||||
return _depth(source_id, frozenset({source_id}))
|
||||
|
||||
def validate_nesting(
|
||||
self,
|
||||
parent_id: str,
|
||||
child_source_ids: list[str],
|
||||
) -> None:
|
||||
"""Validate that adding *child_source_ids* as layers/zones of *parent_id* is safe.
|
||||
|
||||
Raises ValueError if:
|
||||
- Any child is the parent itself (self-reference)
|
||||
- Any child transitively depends on the parent (would create a cycle)
|
||||
- The resulting nesting depth exceeds MAX_COMPOSITE_DEPTH
|
||||
"""
|
||||
for child_id in child_source_ids:
|
||||
if not child_id:
|
||||
continue
|
||||
if child_id == parent_id:
|
||||
child_name = getattr(self._items.get(child_id), "name", child_id)
|
||||
raise ValueError(f"Cannot add '{child_name}' as its own layer (self-reference)")
|
||||
child_deps = self.get_transitive_dependencies(child_id)
|
||||
if parent_id in child_deps:
|
||||
child_name = getattr(self._items.get(child_id), "name", child_id)
|
||||
parent_name = getattr(self._items.get(parent_id), "name", parent_id)
|
||||
raise ValueError(
|
||||
f"Cannot add '{child_name}' as a layer of '{parent_name}': "
|
||||
f"it would create a circular reference"
|
||||
)
|
||||
|
||||
# Check depth: temporarily compute what the depth would be
|
||||
max_child_depth = 0
|
||||
for child_id in child_source_ids:
|
||||
if not child_id:
|
||||
continue
|
||||
max_child_depth = max(max_child_depth, self.get_nesting_depth(child_id))
|
||||
resulting_depth = 1 + max_child_depth
|
||||
if resulting_depth > MAX_COMPOSITE_DEPTH:
|
||||
raise ValueError(
|
||||
f"Nesting depth {resulting_depth} exceeds maximum of {MAX_COMPOSITE_DEPTH}"
|
||||
)
|
||||
|
||||
def get_processed_referencing(self, source_id: str) -> List[str]:
|
||||
"""Return names of processed sources that reference a given source as input."""
|
||||
names = []
|
||||
|
||||
Reference in New Issue
Block a user