@webjsdev/server 0.8.55 → 0.8.56

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/package.json +1 -1
  2. package/src/check.js +73 -0
  3. package/src/ssr.js +17 -8
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@webjsdev/server",
3
- "version": "0.8.55",
3
+ "version": "0.8.56",
4
4
  "type": "module",
5
5
  "description": "webjs dev/prod server: SSR, router, API, server actions, live reload",
6
6
  "main": "index.js",
package/src/check.js CHANGED
@@ -119,6 +119,11 @@ export const RULES = [
119
119
  description:
120
120
  'Flags genuinely browser-only APIs used in a WebComponent constructor, willUpdate, or render() method. The SSR pipeline instantiates the component, runs willUpdate plus controllers\' hostUpdate, reflects properties, and calls render() to produce HTML, on a server element shim that backs the attribute methods but has no real DOM. So a browser global (document, window, localStorage, sessionStorage, navigator, location, matchMedia, screen, history) or an unshimmed HTMLElement member on `this` (attachShadow, shadowRoot, classList, querySelector, querySelectorAll, getBoundingClientRect, focus, blur, scrollIntoView) touched there throws at SSR time (the isomorphic footgun). The attribute methods (getAttribute/setAttribute/hasAttribute/removeAttribute/toggleAttribute), the event methods (addEventListener/removeEventListener/dispatchEvent), and attachInternals are shim-backed and run server-side, so they are NOT flagged. The flagged APIs belong in connectedCallback() or a lifecycle hook (firstUpdated/updated), which SSR never calls; seed first-paint defaults in the constructor (or derive them in willUpdate) only from server-known inputs (attributes, props). Conservative: only the constructor, willUpdate, and render bodies are scanned, and only direct references, so helper indirection is not flagged (the runtime SSR error covers that case).',
121
121
  },
122
+ {
123
+ name: 'no-shadowed-native-member',
124
+ description:
125
+ 'Flags a WebComponent class method whose name collides with a native DOM mutation method that WebJs relies on and INSTRUMENTS on every light-DOM host for the slot API (#1021): append, prepend, before, after, replaceWith, replaceChildren, remove, appendChild, insertBefore, removeChild, replaceChild. A method of the same name is SHADOWED at runtime (the instrumented native method wins), so the component method silently never runs, while TypeScript stays green because a zero/one-arg override is assignable to the native signature. Found dogfooding the stream demo (#248): a component named its button handler `append()`, so clicking Append called the slot-append no-op instead of the handler. Rename the handler to a non-native name (appendRow / prependRow / removeItem). The `render` / lifecycle hooks are MEANT to be overridden and are not flagged; only the native DOM mutation members are.',
126
+ },
122
127
  {
123
128
  name: 'no-server-import-in-browser-module',
124
129
  description:
@@ -659,6 +664,74 @@ export async function checkConventions(appDir) {
659
664
  }
660
665
  }
661
666
 
667
+ // --- Rule: no-shadowed-native-member ---
668
+ // A WebComponent method named after a native DOM mutation method WebJs
669
+ // instruments on every light-DOM host for the slot API (#1021) is SHADOWED at
670
+ // runtime (the native/instrumented method wins), so the component method never
671
+ // runs, while TypeScript stays green (a shorter override is assignable). Rename
672
+ // the handler. The lifecycle hooks are meant to be overridden, so only the DOM
673
+ // mutation members are reserved.
674
+ {
675
+ const NATIVE_MEMBERS = [
676
+ 'append', 'prepend', 'before', 'after', 'replaceWith', 'replaceChildren', 'remove',
677
+ 'appendChild', 'insertBefore', 'removeChild', 'replaceChild',
678
+ ];
679
+ for (const { rel, scan } of files) {
680
+ if (!/class\s+\w+\s+extends\s+WebComponent/.test(scan)) continue;
681
+ for (const { body } of extractWebComponentClassBodies(scan)) {
682
+ // The slot interception installs only on LIGHT-DOM hosts (the shadow
683
+ // branch keeps the true native methods), so a shadow component's method
684
+ // is never shadowed. Skip the whole class.
685
+ if (/static\s+shadow\s*=\s*true/.test(body)) continue;
686
+ // Brace-depth map over the (already string/comment-masked) class body,
687
+ // so only TOP-LEVEL class members flag: a same-named object-literal
688
+ // shorthand or function expression nested inside a method body is a
689
+ // different object's property and shadows nothing.
690
+ const depth = new Int32Array(body.length);
691
+ {
692
+ let d = 0;
693
+ for (let i = 0; i < body.length; i++) {
694
+ if (body[i] === '{') { depth[i] = d; d++; }
695
+ else if (body[i] === '}') { d--; depth[i] = d; }
696
+ else depth[i] = d;
697
+ }
698
+ }
699
+ for (const name of NATIVE_MEMBERS) {
700
+ // Two shadowed-definition shapes, both instance-level: the method /
701
+ // accessor form (`remove() {`, `get remove() {`), and the class-field
702
+ // FUNCTION form (`remove = () => {}` / `= function () {}`), which the
703
+ // connect-time interception install overwrites just the same. A
704
+ // `static` member lives on the constructor and shadows nothing.
705
+ const methodRe = new RegExp(
706
+ `(?:^|[\\s;}])((?:static\\s+)?)(?:async\\s+)?(?:get\\s+|set\\s+)?(${name})\\s*\\([^)]*\\)\\s*(?::[^{]*)?\\{`,
707
+ 'g',
708
+ );
709
+ const fieldRe = new RegExp(
710
+ `(?:^|[\\s;}])((?:static\\s+)?)(${name})\\s*=\\s*(?:async\\s*)?(?:function\\b|\\([^)]*\\)\\s*(?::[^=]*)?=>|[\\w$]+\\s*=>)`,
711
+ 'g',
712
+ );
713
+ let flagged = false;
714
+ for (const re of [methodRe, fieldRe]) {
715
+ let m;
716
+ while (!flagged && (m = re.exec(body)) !== null) {
717
+ if (m[1]) continue; // static: not shadowed
718
+ const nameIdx = m.index + m[0].indexOf(m[2]);
719
+ if (depth[nameIdx] !== 0) continue; // nested: another object's property
720
+ flagged = true;
721
+ violations.push({
722
+ rule: 'no-shadowed-native-member',
723
+ file: rel,
724
+ message: `Component member \`${name}\` shadows the native DOM method WebJs instruments for the slot API, so it silently never runs (the native method wins) and TypeScript does not catch it.`,
725
+ fix: `Rename the member to a non-native name (e.g. \`${name}Row()\` / \`${name}Item()\`) and update its call sites.`,
726
+ });
727
+ }
728
+ if (flagged) break;
729
+ }
730
+ }
731
+ }
732
+ }
733
+ }
734
+
662
735
  // --- Rule: no-redirect-in-api-route ---
663
736
  // `redirect()` from `@webjsdev/core` throws a control-flow signal designed
664
737
  // for the SSR page renderer. In a `route.ts` API handler it goes uncaught
package/src/ssr.js CHANGED
@@ -1124,18 +1124,27 @@ function wrapInDocument(body, opts) {
1124
1124
  */
1125
1125
  function collectHoistedHeadTags(bodyHtml) {
1126
1126
  const tags = [];
1127
- // <script>…</script> and <style>…</style> are paired; <link …> is void.
1128
- // A plain HTML comment (<!-- … -->) is consumed but NOT hoisted, so a
1129
- // comment interleaved with head-bound tags (e.g. "<!-- Self-hosted fonts -->"
1127
+ // <script>…</script> and <style>…</style> are paired; <link …> and <meta …>
1128
+ // are void. A plain HTML comment (<!-- … -->) is consumed but NOT hoisted, so
1129
+ // a comment interleaved with head-bound tags (e.g. "<!-- Self-hosted fonts -->"
1130
1130
  // between a favicon <link> and the stylesheet <link>) does not terminate
1131
1131
  // the leading run and strand the stylesheet in <body>, which caused FOUC
1132
1132
  // because a <link rel="stylesheet"> in <body> is not reliably
1133
- // render-blocking (#406). The `(?!/?wj:)` guard exempts client-router
1134
- // markers (<!--wj:children:…-->, <!--/wj:children-->) so a layout that
1135
- // renders children directly after its head tags still terminates the run
1136
- // there rather than swallowing the nesting marker.
1133
+ // render-blocking (#406). A <meta …> is treated the same way for the same
1134
+ // reason: a <meta name="color-scheme"> between the theme <script> and the
1135
+ // stylesheet <link> would otherwise terminate the run and strand the
1136
+ // stylesheet AND a <link rel="icon"> in <body> (a favicon in <body> is
1137
+ // ignored by browsers, so the icon silently never renders). The `(?!/?wj:)`
1138
+ // guard exempts client-router markers (<!--wj:children:…-->,
1139
+ // <!--/wj:children-->) so a layout that renders children directly after its
1140
+ // head tags still terminates the run there rather than swallowing the marker.
1141
+ // The void-tag matchers are QUOTE-AWARE ((?:[^>"']|"[^"]*"|'[^']*')*): a `>`
1142
+ // inside a quoted attribute value (a description meta like
1143
+ // content="Guides > API") must not terminate the tag early, which would hoist
1144
+ // a truncated tag, leak the remainder as visible body text, and strand the
1145
+ // stylesheet (the #406 FOUC this hoist exists to prevent).
1137
1146
  const re =
1138
- /^\s*(<!--(?!\/?wj:)[\s\S]*?-->|<script[\s>][\s\S]*?<\/script>|<style[\s>][\s\S]*?<\/style>|<link\b[^>]*>)/i;
1147
+ /^\s*(<!--(?!\/?wj:)[\s\S]*?-->|<script[\s>][\s\S]*?<\/script>|<style[\s>][\s\S]*?<\/style>|<link\b(?:[^>"']|"[^"]*"|'[^']*')*>|<meta\b(?:[^>"']|"[^"]*"|'[^']*')*>)/i;
1139
1148
  let remaining = bodyHtml;
1140
1149
  // `body` only advances to just-past the LAST hoisted head tag. Comments
1141
1150
  // are scanned through (so they don't terminate the run) but a comment that