ReviewOS

stacks/stx

@include can't forward a :for loop variable into a child component's <script client> scope

#1844
Closed glennmichael123 opened this 22 days ago · 1 comment
22 days ago

Summary

@include cannot forward a :for loop variable into a child component that has its own <script client> scope. The loop var stops at the child's scope boundary and its bindings render empty, so list-item components can't be composed — the markup must be duplicated into the parent instead.

Impact (real app)

In bench, the review-card component (resources/components/Bench/Feed.stx) was meant to be the reusable list item. Because the :for="review in reviews" variable can't cross into Feed's client scope, the entire card markup had to be inlined and duplicated into the parent (resources/components/Bench/ReviewsFeed.stx:354-439), and Feed.stx is now effectively dead code. The in-code comment documenting the boundary is at ReviewsFeed.stx:26-32.

This directly blocks adoption of defineProps / defineSlots for the most common UI pattern there is: rendering a list of item components.

Repro sketch

<!-- parent -->
<div :for="item in items">
  @include('ItemCard', { item: 'item' })   <!-- item is the loop var -->
</div>

<!-- ItemCard.stx has a <script client> scope -->
<article>{⁠{ item.title }}</article>        <!-- renders empty: item never crosses the scope boundary -->

Ask

Allow @include (or a first-class <ItemCard :item="item" /> component invocation) to forward the loop variable / props across a child component's client-scope boundary, so list items can be real components instead of duplicated markup.

22 days ago

Fixed in 16db857.

as-form in loop  | rows: ["Alpha","Beta"]     (was ["(empty)","(empty)"])
in-form in loop  | rows: ["Alpha","Beta"]
nested braces    | rows: ["Alpha","Beta"]

The cause is ordering, not scope

Worth correcting the title's framing: it has nothing to do with the child's <script client> scope. Includes are resolved at process.ts:1433, long after loops expand at :1325, and the data map is evaluated with safeEvaluateObject(varsString, context) against the page context — where the loop variable no longer exists.

Two checks that pin it, both of which rule out the scope explanation:

  • a partial with no client script, included inside a loop → still empty
  • a partial with a client script, included outside a loop → renders correctly

Steps 6 and 7 of the loop body already freeze :prop bindings and @component props to literals for exactly this reason. @include data maps had no equivalent; this adds step 8.

Your own suggested alternative (<Card __stx_item="eyJraW5kIjoiY29tbWVudCIsImF0IjoiU2F0IE9jdCAyNCAyMDI2IDIzOjIyOjQwIEdNVCswMDAwIChDb29yZGluYXRlZCBVbml2ZXJzYWwgVGltZSkiLCJjb21tZW50Ijp7ImlkIjoxNDA2ODEsImF1dGhvciI6ImdsZW5ubWljaGFlbDEyMyIsIndoZW4iOiIyMiBkYXlzIGFnbyIsImNyZWF0ZWRBdCI6IlNhdCBPY3QgMjQgMjAyNiAyMzoyMjo0MCBHTVQrMDAwMCAoQ29vcmRpbmF0ZWQgVW5pdmVyc2FsIFRpbWUpIiwiZWRpdGVkIjpmYWxzZSwiYm9keUh0bWwiOiI8cD5GaXhlZCBpbiA8YSBocmVmPVwiL3N0YWNrcy9zdHgvY29tbWl0cy8xNmRiODU3MzAyXCI+PGNvZGU+MTZkYjg1NzwvY29kZT48L2E+LjwvcD48cHJlPjxjb2RlPmFzLWZvcm0gaW4gbG9vcCAgfCByb3dzOiBbXCJBbHBoYVwiLFwiQmV0YVwiXSAgICAgKHdhcyBbXCIoZW1wdHkpXCIsXCIoZW1wdHkpXCJdKVxuaW4tZm9ybSBpbiBsb29wICB8IHJvd3M6IFtcIkFscGhhXCIsXCJCZXRhXCJdXG5uZXN0ZWQgYnJhY2VzICAgIHwgcm93czogW1wiQWxwaGFcIixcIkJldGFcIl08L2NvZGU+PC9wcmU+PGgyIGlkPVwidXNlci1jb250ZW50LXRoZS1jYXVzZS1pcy1vcmRlcmluZy1ub3Qtc2NvcGVcIj5UaGUgY2F1c2UgaXMgb3JkZXJpbmcsIG5vdCBzY29wZTwvaDI+PHA+V29ydGggY29ycmVjdGluZyB0aGUgdGl0bGUncyBmcmFtaW5nOiBpdCBoYXMgbm90aGluZyB0byBkbyB3aXRoIHRoZSBjaGlsZCdzIDxjb2RlPiZsdDtzY3JpcHQgY2xpZW50Jmd0OzwvY29kZT4gc2NvcGUuIEluY2x1ZGVzIGFyZSByZXNvbHZlZCBhdCA8Y29kZT5wcm9jZXNzLnRzOjE0MzM8L2NvZGU+LCBsb25nIGFmdGVyIGxvb3BzIGV4cGFuZCBhdCA8Y29kZT46MTMyNTwvY29kZT4sIGFuZCB0aGUgZGF0YSBtYXAgaXMgZXZhbHVhdGVkIHdpdGggPGNvZGU+c2FmZUV2YWx1YXRlT2JqZWN0KHZhcnNTdHJpbmcsIGNvbnRleHQpPC9jb2RlPiBhZ2FpbnN0IHRoZSA8c3Ryb25nPnBhZ2U8L3N0cm9uZz4gY29udGV4dCDigJQgd2hlcmUgdGhlIGxvb3AgdmFyaWFibGUgbm8gbG9uZ2VyIGV4aXN0cy48L3A+PHA+VHdvIGNoZWNrcyB0aGF0IHBpbiBpdCwgYm90aCBvZiB3aGljaCBydWxlIG91dCB0aGUgc2NvcGUgZXhwbGFuYXRpb246PC9wPjx1bD48bGk+YSBwYXJ0aWFsIHdpdGggPHN0cm9uZz5ubzwvc3Ryb25nPiBjbGllbnQgc2NyaXB0LCBpbmNsdWRlZCBpbnNpZGUgYSBsb29wIOKGkiBzdGlsbCBlbXB0eTwvbGk+PGxpPmEgcGFydGlhbCA8c3Ryb25nPndpdGg8L3N0cm9uZz4gYSBjbGllbnQgc2NyaXB0LCBpbmNsdWRlZCA8c3Ryb25nPm91dHNpZGU8L3N0cm9uZz4gYSBsb29wIOKGkiByZW5kZXJzIGNvcnJlY3RseTwvbGk+PC91bD48cD5TdGVwcyA2IGFuZCA3IG9mIHRoZSBsb29wIGJvZHkgYWxyZWFkeSBmcmVlemUgPGNvZGU+OnByb3A8L2NvZGU+IGJpbmRpbmdzIGFuZCA8Y29kZT5AY29tcG9uZW50PC9jb2RlPiBwcm9wcyB0byBsaXRlcmFscyBmb3IgZXhhY3RseSB0aGlzIHJlYXNvbi4gPGNvZGU+QGluY2x1ZGU8L2NvZGU+IGRhdGEgbWFwcyBoYWQgbm8gZXF1aXZhbGVudDsgdGhpcyBhZGRzIHN0ZXAgOC48L3A+PHA+WW91ciBvd24gc3VnZ2VzdGVkIGFsdGVybmF0aXZlICg8Y29kZT4mbHQ7Q2FyZCA6aXRlbT1cIml0ZW1cIi8mZ3Q7PC9jb2RlPikgd29ya3MgdG9kYXksIHdoaWNoIGlzIGNvbnNpc3RlbnQg4oCUIHRoYXQgcGF0aCBnb2VzIHRocm91Z2ggc3RlcCA2LjwvcD48aDIgaWQ9XCJ1c2VyLWNvbnRlbnQtZGVsaWJlcmF0ZWx5LW5hcnJvd1wiPkRlbGliZXJhdGVseSBuYXJyb3c8L2gyPjxwPkEgbWFwIHRoYXQgcmVhZHMgbm90aGluZyBmcm9tIHRoZSBpdGVyYXRpb24ga2VlcHMgdGhlIGF1dGhvcidzIGV4cHJlc3Npb24gdmVyYmF0aW0sIHNvIGFuIGluY2x1ZGUgb3V0c2lkZSBhIGxvb3AsIG9yIG9uZSBwYXNzaW5nIG9ubHkgcGFnZS1sZXZlbCB2YWx1ZXMsIGlzIGV2YWx1YXRlZCBsYXRlciBleGFjdGx5IGFzIGJlZm9yZS4gVGhlcmUgYXJlIHRlc3RzIGZvciBib3RoLCBzaW5jZSBmcmVlemluZyBldmVyeXRoaW5nIHdvdWxkIGhhdmUgYmVlbiB0aGUgZWFzeSBvdmVyLXJlYWNoLjwvcD48cD5CYWxhbmNlZC1wYXJlbiBtYXRjaGluZyByYXRoZXIgdGhhbiBhIGxhenkgcmVnZXgsIGJlY2F1c2UgYSBkYXRhIG1hcCBjYW4gbmVzdDogPGNvZGU+eyBpdGVtOiB7IGxhYmVsOiBpdGVtLmxhYmVsIH0gfTwvY29kZT4uPC9wPjxoMiBpZD1cInVzZXItY29udGVudC1zaWRlLWZpbmRpbmdcIj5TaWRlIGZpbmRpbmc8L2gyPjxwPlRoZSBmYWlsdXJlIHdhcyA8ZW0+c3RydWN0dXJhbGx5PC9lbT4gY29ycmVjdCDigJQgTiBhcnRpY2xlcywgYWxsIGJsYW5rIOKAlCBzbyBhIGNvdW50LWJhc2VkIGFzc2VydGlvbiB3b3VsZCBub3QgaGF2ZSBjYXVnaHQgaXQuIFRoZSB0ZXN0cyBhc3NlcnQgZGlzdGluY3QgdmFsdWVzIHBlciBpdGVyYXRpb24gZm9yIHRoYXQgcmVhc29uLjwvcD48cD5BbHNvIHdvcnRoIGZsYWdnaW5nIHdoaWxlIGFkamFjZW50OiA8c3Ryb25nPkNMQVVERS5tZCBub3RlIDMwPC9zdHJvbmc+IChcIktub3duIExpbWl0YXRpb246IFNlcnZlci1TaWRlIENvbXBvbmVudCBQcm9wcyBpbiBMb29wc1wiKSBpcyBzdGFsZS4gPGNvZGU+Jmx0O1BsYWluQ2FyZCA6aXRlbT1cIml0ZW1cIi8mZ3Q7PC9jb2RlPiBpbnNpZGUgPGNvZGU+QGZvcmVhY2g8L2NvZGU+IHJlbmRlcnMgY29ycmVjdGx5LCBzbyB0aGF0IG5vdGUgaXMgYWN0aXZlbHkgc3RlZXJpbmcgcGVvcGxlIHRvd2FyZCB0aGUgd3Jvbmcgd29ya2Fyb3VuZCBmb3IgdGhpcyBpc3N1ZS4gSSBoYXZlIGxlZnQgaXQgZm9yIGEgc2VwYXJhdGUgZG9jcyBwYXNzIHJhdGhlciB0aGFuIGVkaXRpbmcgaXQgaW5zaWRlIGEgZml4IGNvbW1pdC48L3A+PHA+Rm91ciBvZiB0aGUgc2V2ZW4gdGVzdHMgZmFpbCBhdCB0aGUgcGFyZW50IGNvbW1pdDsgdGhlIHRocmVlIHRoYXQgcGFzcyB0aGVyZSBhcmUgdGhlIG11c3Qtbm90LWNoYW5nZSBndWFyZHMuIEZ1bGwgc3VpdGUgMTA4NDAgcGFzcy48L3A+IiwicmVhY3Rpb25zIjpbXSwicmVhY3Rpb25GaWVsZHMiOlt7Im5hbWUiOiJvd25lciIsInZhbHVlIjoic3RhY2tzIn0seyJuYW1lIjoicmVwbyIsInZhbHVlIjoic3R4In0seyJuYW1lIjoibnVtYmVyIiwidmFsdWUiOjE4NDR9LHsibmFtZSI6ImNvbW1lbnRfaWQiLCJ2YWx1ZSI6MTQwNjgxfV0sInBpY2tpbmciOmZhbHNlLCJwaWNrZXJIcmVmIjoiP2NvbnZlcnNhdGlvbl9wYWdlPTEmcmVhY3Q9MTQwNjgxI3JlYWN0aW9ucy0xNDA2ODEifSwiZXZlbnQiOm51bGx9"/>) works today, which is consistent — that path goes through step 6.

Deliberately narrow

A map that reads nothing from the iteration keeps the author's expression verbatim, so an include outside a loop, or one passing only page-level values, is evaluated later exactly as before. There are tests for both, since freezing everything would have been the easy over-reach.

Balanced-paren matching rather than a lazy regex, because a data map can nest: { item: { label: item.label } }.

Side finding

The failure was structurally correct — N articles, all blank — so a count-based assertion would not have caught it. The tests assert distinct values per iteration for that reason.

Also worth flagging while adjacent: CLAUDE.md note 30 ("Known Limitation: Server-Side Component Props in Loops") is stale. <PlainCard __stx_item="eyJraW5kIjoiY29tbWVudCIsImF0IjoiU2F0IE9jdCAyNCAyMDI2IDIzOjIyOjQwIEdNVCswMDAwIChDb29yZGluYXRlZCBVbml2ZXJzYWwgVGltZSkiLCJjb21tZW50Ijp7ImlkIjoxNDA2ODEsImF1dGhvciI6ImdsZW5ubWljaGFlbDEyMyIsIndoZW4iOiIyMiBkYXlzIGFnbyIsImNyZWF0ZWRBdCI6IlNhdCBPY3QgMjQgMjAyNiAyMzoyMjo0MCBHTVQrMDAwMCAoQ29vcmRpbmF0ZWQgVW5pdmVyc2FsIFRpbWUpIiwiZWRpdGVkIjpmYWxzZSwiYm9keUh0bWwiOiI8cD5GaXhlZCBpbiA8YSBocmVmPVwiL3N0YWNrcy9zdHgvY29tbWl0cy8xNmRiODU3MzAyXCI+PGNvZGU+MTZkYjg1NzwvY29kZT48L2E+LjwvcD48cHJlPjxjb2RlPmFzLWZvcm0gaW4gbG9vcCAgfCByb3dzOiBbXCJBbHBoYVwiLFwiQmV0YVwiXSAgICAgKHdhcyBbXCIoZW1wdHkpXCIsXCIoZW1wdHkpXCJdKVxuaW4tZm9ybSBpbiBsb29wICB8IHJvd3M6IFtcIkFscGhhXCIsXCJCZXRhXCJdXG5uZXN0ZWQgYnJhY2VzICAgIHwgcm93czogW1wiQWxwaGFcIixcIkJldGFcIl08L2NvZGU+PC9wcmU+PGgyIGlkPVwidXNlci1jb250ZW50LXRoZS1jYXVzZS1pcy1vcmRlcmluZy1ub3Qtc2NvcGVcIj5UaGUgY2F1c2UgaXMgb3JkZXJpbmcsIG5vdCBzY29wZTwvaDI+PHA+V29ydGggY29ycmVjdGluZyB0aGUgdGl0bGUncyBmcmFtaW5nOiBpdCBoYXMgbm90aGluZyB0byBkbyB3aXRoIHRoZSBjaGlsZCdzIDxjb2RlPiZsdDtzY3JpcHQgY2xpZW50Jmd0OzwvY29kZT4gc2NvcGUuIEluY2x1ZGVzIGFyZSByZXNvbHZlZCBhdCA8Y29kZT5wcm9jZXNzLnRzOjE0MzM8L2NvZGU+LCBsb25nIGFmdGVyIGxvb3BzIGV4cGFuZCBhdCA8Y29kZT46MTMyNTwvY29kZT4sIGFuZCB0aGUgZGF0YSBtYXAgaXMgZXZhbHVhdGVkIHdpdGggPGNvZGU+c2FmZUV2YWx1YXRlT2JqZWN0KHZhcnNTdHJpbmcsIGNvbnRleHQpPC9jb2RlPiBhZ2FpbnN0IHRoZSA8c3Ryb25nPnBhZ2U8L3N0cm9uZz4gY29udGV4dCDigJQgd2hlcmUgdGhlIGxvb3AgdmFyaWFibGUgbm8gbG9uZ2VyIGV4aXN0cy48L3A+PHA+VHdvIGNoZWNrcyB0aGF0IHBpbiBpdCwgYm90aCBvZiB3aGljaCBydWxlIG91dCB0aGUgc2NvcGUgZXhwbGFuYXRpb246PC9wPjx1bD48bGk+YSBwYXJ0aWFsIHdpdGggPHN0cm9uZz5ubzwvc3Ryb25nPiBjbGllbnQgc2NyaXB0LCBpbmNsdWRlZCBpbnNpZGUgYSBsb29wIOKGkiBzdGlsbCBlbXB0eTwvbGk+PGxpPmEgcGFydGlhbCA8c3Ryb25nPndpdGg8L3N0cm9uZz4gYSBjbGllbnQgc2NyaXB0LCBpbmNsdWRlZCA8c3Ryb25nPm91dHNpZGU8L3N0cm9uZz4gYSBsb29wIOKGkiByZW5kZXJzIGNvcnJlY3RseTwvbGk+PC91bD48cD5TdGVwcyA2IGFuZCA3IG9mIHRoZSBsb29wIGJvZHkgYWxyZWFkeSBmcmVlemUgPGNvZGU+OnByb3A8L2NvZGU+IGJpbmRpbmdzIGFuZCA8Y29kZT5AY29tcG9uZW50PC9jb2RlPiBwcm9wcyB0byBsaXRlcmFscyBmb3IgZXhhY3RseSB0aGlzIHJlYXNvbi4gPGNvZGU+QGluY2x1ZGU8L2NvZGU+IGRhdGEgbWFwcyBoYWQgbm8gZXF1aXZhbGVudDsgdGhpcyBhZGRzIHN0ZXAgOC48L3A+PHA+WW91ciBvd24gc3VnZ2VzdGVkIGFsdGVybmF0aXZlICg8Y29kZT4mbHQ7Q2FyZCA6aXRlbT1cIml0ZW1cIi8mZ3Q7PC9jb2RlPikgd29ya3MgdG9kYXksIHdoaWNoIGlzIGNvbnNpc3RlbnQg4oCUIHRoYXQgcGF0aCBnb2VzIHRocm91Z2ggc3RlcCA2LjwvcD48aDIgaWQ9XCJ1c2VyLWNvbnRlbnQtZGVsaWJlcmF0ZWx5LW5hcnJvd1wiPkRlbGliZXJhdGVseSBuYXJyb3c8L2gyPjxwPkEgbWFwIHRoYXQgcmVhZHMgbm90aGluZyBmcm9tIHRoZSBpdGVyYXRpb24ga2VlcHMgdGhlIGF1dGhvcidzIGV4cHJlc3Npb24gdmVyYmF0aW0sIHNvIGFuIGluY2x1ZGUgb3V0c2lkZSBhIGxvb3AsIG9yIG9uZSBwYXNzaW5nIG9ubHkgcGFnZS1sZXZlbCB2YWx1ZXMsIGlzIGV2YWx1YXRlZCBsYXRlciBleGFjdGx5IGFzIGJlZm9yZS4gVGhlcmUgYXJlIHRlc3RzIGZvciBib3RoLCBzaW5jZSBmcmVlemluZyBldmVyeXRoaW5nIHdvdWxkIGhhdmUgYmVlbiB0aGUgZWFzeSBvdmVyLXJlYWNoLjwvcD48cD5CYWxhbmNlZC1wYXJlbiBtYXRjaGluZyByYXRoZXIgdGhhbiBhIGxhenkgcmVnZXgsIGJlY2F1c2UgYSBkYXRhIG1hcCBjYW4gbmVzdDogPGNvZGU+eyBpdGVtOiB7IGxhYmVsOiBpdGVtLmxhYmVsIH0gfTwvY29kZT4uPC9wPjxoMiBpZD1cInVzZXItY29udGVudC1zaWRlLWZpbmRpbmdcIj5TaWRlIGZpbmRpbmc8L2gyPjxwPlRoZSBmYWlsdXJlIHdhcyA8ZW0+c3RydWN0dXJhbGx5PC9lbT4gY29ycmVjdCDigJQgTiBhcnRpY2xlcywgYWxsIGJsYW5rIOKAlCBzbyBhIGNvdW50LWJhc2VkIGFzc2VydGlvbiB3b3VsZCBub3QgaGF2ZSBjYXVnaHQgaXQuIFRoZSB0ZXN0cyBhc3NlcnQgZGlzdGluY3QgdmFsdWVzIHBlciBpdGVyYXRpb24gZm9yIHRoYXQgcmVhc29uLjwvcD48cD5BbHNvIHdvcnRoIGZsYWdnaW5nIHdoaWxlIGFkamFjZW50OiA8c3Ryb25nPkNMQVVERS5tZCBub3RlIDMwPC9zdHJvbmc+IChcIktub3duIExpbWl0YXRpb246IFNlcnZlci1TaWRlIENvbXBvbmVudCBQcm9wcyBpbiBMb29wc1wiKSBpcyBzdGFsZS4gPGNvZGU+Jmx0O1BsYWluQ2FyZCA6aXRlbT1cIml0ZW1cIi8mZ3Q7PC9jb2RlPiBpbnNpZGUgPGNvZGU+QGZvcmVhY2g8L2NvZGU+IHJlbmRlcnMgY29ycmVjdGx5LCBzbyB0aGF0IG5vdGUgaXMgYWN0aXZlbHkgc3RlZXJpbmcgcGVvcGxlIHRvd2FyZCB0aGUgd3Jvbmcgd29ya2Fyb3VuZCBmb3IgdGhpcyBpc3N1ZS4gSSBoYXZlIGxlZnQgaXQgZm9yIGEgc2VwYXJhdGUgZG9jcyBwYXNzIHJhdGhlciB0aGFuIGVkaXRpbmcgaXQgaW5zaWRlIGEgZml4IGNvbW1pdC48L3A+PHA+Rm91ciBvZiB0aGUgc2V2ZW4gdGVzdHMgZmFpbCBhdCB0aGUgcGFyZW50IGNvbW1pdDsgdGhlIHRocmVlIHRoYXQgcGFzcyB0aGVyZSBhcmUgdGhlIG11c3Qtbm90LWNoYW5nZSBndWFyZHMuIEZ1bGwgc3VpdGUgMTA4NDAgcGFzcy48L3A+IiwicmVhY3Rpb25zIjpbXSwicmVhY3Rpb25GaWVsZHMiOlt7Im5hbWUiOiJvd25lciIsInZhbHVlIjoic3RhY2tzIn0seyJuYW1lIjoicmVwbyIsInZhbHVlIjoic3R4In0seyJuYW1lIjoibnVtYmVyIiwidmFsdWUiOjE4NDR9LHsibmFtZSI6ImNvbW1lbnRfaWQiLCJ2YWx1ZSI6MTQwNjgxfV0sInBpY2tpbmciOmZhbHNlLCJwaWNrZXJIcmVmIjoiP2NvbnZlcnNhdGlvbl9wYWdlPTEmcmVhY3Q9MTQwNjgxI3JlYWN0aW9ucy0xNDA2ODEifSwiZXZlbnQiOm51bGx9"/> inside @foreach renders correctly, so that note is actively steering people toward the wrong workaround for this issue. I have left it for a separate docs pass rather than editing it inside a fix commit.

Four of the seven tests fail at the parent commit; the three that pass there are the must-not-change guards. Full suite 10840 pass.

Sign in to comment on this issue.