|
| 1 | +import * as assert from 'node:assert/strict'; |
| 2 | +import { beforeEach, describe, it } from 'node:test'; |
| 3 | +import { isPromise } from 'node:util/types'; |
| 4 | +import * as cheerio from 'cheerio'; |
| 5 | +import { |
| 6 | + HTMLString, |
| 7 | + createComponent, |
| 8 | + renderComponent, |
| 9 | + renderTemplate, |
| 10 | +} from '../../../dist/runtime/server/index.js'; |
| 11 | + |
| 12 | +describe('rendering', () => { |
| 13 | + const evaluated = []; |
| 14 | + |
| 15 | + const Scalar = createComponent((_result, props) => { |
| 16 | + evaluated.push(props.id); |
| 17 | + return renderTemplate`<scalar id="${props.id}"></scalar>`; |
| 18 | + }); |
| 19 | + |
| 20 | + beforeEach(() => { |
| 21 | + evaluated.length = 0; |
| 22 | + }); |
| 23 | + |
| 24 | + it('components are evaluated and rendered depth-first', async () => { |
| 25 | + const Root = createComponent((result, props) => { |
| 26 | + evaluated.push(props.id); |
| 27 | + return renderTemplate`<root id="${props.id}"> |
| 28 | + ${renderComponent(result, '', Scalar, { id: `${props.id}/scalar_1` })} |
| 29 | + ${renderComponent(result, '', Nested, { id: `${props.id}/nested` })} |
| 30 | + ${renderComponent(result, '', Scalar, { id: `${props.id}/scalar_2` })} |
| 31 | + </root>`; |
| 32 | + }); |
| 33 | + |
| 34 | + const Nested = createComponent((result, props) => { |
| 35 | + evaluated.push(props.id); |
| 36 | + return renderTemplate`<nested id="${props.id}"> |
| 37 | + ${renderComponent(result, '', Scalar, { id: `${props.id}/scalar` })} |
| 38 | + </nested>`; |
| 39 | + }); |
| 40 | + |
| 41 | + const result = await renderToString(Root({}, { id: 'root' }, {})); |
| 42 | + const rendered = getRenderedIds(result); |
| 43 | + |
| 44 | + assert.deepEqual(evaluated, [ |
| 45 | + 'root', |
| 46 | + 'root/scalar_1', |
| 47 | + 'root/nested', |
| 48 | + 'root/nested/scalar', |
| 49 | + 'root/scalar_2', |
| 50 | + ]); |
| 51 | + |
| 52 | + assert.deepEqual(rendered, [ |
| 53 | + 'root', |
| 54 | + 'root/scalar_1', |
| 55 | + 'root/nested', |
| 56 | + 'root/nested/scalar', |
| 57 | + 'root/scalar_2', |
| 58 | + ]); |
| 59 | + }); |
| 60 | + |
| 61 | + it('synchronous component trees are rendered without promises', () => { |
| 62 | + const Root = createComponent((result, props) => { |
| 63 | + evaluated.push(props.id); |
| 64 | + return renderTemplate`<root id="${props.id}"> |
| 65 | + ${() => renderComponent(result, '', Scalar, { id: `${props.id}/scalar_1` })} |
| 66 | + ${function* () { |
| 67 | + yield renderComponent(result, '', Scalar, { id: `${props.id}/scalar_2` }); |
| 68 | + }} |
| 69 | + ${[renderComponent(result, '', Scalar, { id: `${props.id}/scalar_3` })]} |
| 70 | + ${renderComponent(result, '', Scalar, { id: `${props.id}/scalar_4` })} |
| 71 | + </root>`; |
| 72 | + }); |
| 73 | + |
| 74 | + const result = renderToString(Root({}, { id: 'root' }, {})); |
| 75 | + assert.ok(!isPromise(result)); |
| 76 | + |
| 77 | + const rendered = getRenderedIds(result); |
| 78 | + |
| 79 | + assert.deepEqual(evaluated, [ |
| 80 | + 'root', |
| 81 | + 'root/scalar_1', |
| 82 | + 'root/scalar_2', |
| 83 | + 'root/scalar_3', |
| 84 | + 'root/scalar_4', |
| 85 | + ]); |
| 86 | + |
| 87 | + assert.deepEqual(rendered, [ |
| 88 | + 'root', |
| 89 | + 'root/scalar_1', |
| 90 | + 'root/scalar_2', |
| 91 | + 'root/scalar_3', |
| 92 | + 'root/scalar_4', |
| 93 | + ]); |
| 94 | + }); |
| 95 | + |
| 96 | + it('async component children are deferred', async () => { |
| 97 | + const Root = createComponent((result, props) => { |
| 98 | + evaluated.push(props.id); |
| 99 | + return renderTemplate`<root id="${props.id}"> |
| 100 | + ${renderComponent(result, '', AsyncNested, { id: `${props.id}/asyncnested` })} |
| 101 | + ${renderComponent(result, '', Scalar, { id: `${props.id}/scalar` })} |
| 102 | + </root>`; |
| 103 | + }); |
| 104 | + |
| 105 | + const AsyncNested = createComponent(async (result, props) => { |
| 106 | + evaluated.push(props.id); |
| 107 | + await new Promise((resolve) => setTimeout(resolve, 0)); |
| 108 | + return renderTemplate`<asyncnested id="${props.id}"> |
| 109 | + ${renderComponent(result, '', Scalar, { id: `${props.id}/scalar` })} |
| 110 | + </asyncnested>`; |
| 111 | + }); |
| 112 | + |
| 113 | + const result = await renderToString(Root({}, { id: 'root' }, {})); |
| 114 | + |
| 115 | + const rendered = getRenderedIds(result); |
| 116 | + |
| 117 | + assert.deepEqual(evaluated, [ |
| 118 | + 'root', |
| 119 | + 'root/asyncnested', |
| 120 | + 'root/scalar', |
| 121 | + 'root/asyncnested/scalar', |
| 122 | + ]); |
| 123 | + |
| 124 | + assert.deepEqual(rendered, [ |
| 125 | + 'root', |
| 126 | + 'root/asyncnested', |
| 127 | + 'root/asyncnested/scalar', |
| 128 | + 'root/scalar', |
| 129 | + ]); |
| 130 | + }); |
| 131 | + |
| 132 | + it('adjacent async components are evaluated eagerly', async () => { |
| 133 | + const resetEvent = new ManualResetEvent(); |
| 134 | + |
| 135 | + const Root = createComponent((result, props) => { |
| 136 | + evaluated.push(props.id); |
| 137 | + return renderTemplate`<root id="${props.id}"> |
| 138 | + ${renderComponent(result, '', AsyncNested, { id: `${props.id}/asyncnested_1` })} |
| 139 | + ${renderComponent(result, '', AsyncNested, { id: `${props.id}/asyncnested_2` })} |
| 140 | + </root>`; |
| 141 | + }); |
| 142 | + |
| 143 | + const AsyncNested = createComponent(async (result, props) => { |
| 144 | + evaluated.push(props.id); |
| 145 | + await resetEvent.wait(); |
| 146 | + return renderTemplate`<asyncnested id="${props.id}"> |
| 147 | + ${renderComponent(result, '', Scalar, { id: `${props.id}/scalar` })} |
| 148 | + </asyncnested>`; |
| 149 | + }); |
| 150 | + |
| 151 | + const awaitableResult = renderToString(Root({}, { id: 'root' }, {})); |
| 152 | + |
| 153 | + assert.deepEqual(evaluated, ['root', 'root/asyncnested_1', 'root/asyncnested_2']); |
| 154 | + |
| 155 | + resetEvent.release(); |
| 156 | + |
| 157 | + // relinquish control after release |
| 158 | + await new Promise((resolve) => setTimeout(resolve, 0)); |
| 159 | + |
| 160 | + assert.deepEqual(evaluated, [ |
| 161 | + 'root', |
| 162 | + 'root/asyncnested_1', |
| 163 | + 'root/asyncnested_2', |
| 164 | + 'root/asyncnested_1/scalar', |
| 165 | + 'root/asyncnested_2/scalar', |
| 166 | + ]); |
| 167 | + |
| 168 | + const result = await awaitableResult; |
| 169 | + const rendered = getRenderedIds(result); |
| 170 | + |
| 171 | + assert.deepEqual(rendered, [ |
| 172 | + 'root', |
| 173 | + 'root/asyncnested_1', |
| 174 | + 'root/asyncnested_1/scalar', |
| 175 | + 'root/asyncnested_2', |
| 176 | + 'root/asyncnested_2/scalar', |
| 177 | + ]); |
| 178 | + }); |
| 179 | + |
| 180 | + it('skip rendering blank html fragments', async () => { |
| 181 | + const Root = createComponent(() => { |
| 182 | + const message = 'hello world'; |
| 183 | + return renderTemplate`${message}`; |
| 184 | + }); |
| 185 | + |
| 186 | + const renderInstance = await renderComponent({}, '', Root, {}); |
| 187 | + |
| 188 | + const chunks = []; |
| 189 | + const destination = { |
| 190 | + write: (chunk) => { |
| 191 | + chunks.push(chunk); |
| 192 | + }, |
| 193 | + }; |
| 194 | + |
| 195 | + await renderInstance.render(destination); |
| 196 | + |
| 197 | + assert.deepEqual(chunks, [new HTMLString('hello world')]); |
| 198 | + }); |
| 199 | + |
| 200 | + it('all primitives are rendered in order', async () => { |
| 201 | + const Root = createComponent((result, props) => { |
| 202 | + evaluated.push(props.id); |
| 203 | + return renderTemplate`<root id="${props.id}"> |
| 204 | + ${renderComponent(result, '', Scalar, { id: `${props.id}/first` })} |
| 205 | + ${() => renderComponent(result, '', Scalar, { id: `${props.id}/func` })} |
| 206 | + ${new Promise((resolve) => { |
| 207 | + setTimeout(() => { |
| 208 | + resolve(renderComponent(result, '', Scalar, { id: `${props.id}/promise` })); |
| 209 | + }, 0); |
| 210 | + })} |
| 211 | + ${[ |
| 212 | + () => renderComponent(result, '', Scalar, { id: `${props.id}/array_func` }), |
| 213 | + renderComponent(result, '', Scalar, { id: `${props.id}/array_scalar` }), |
| 214 | + ]} |
| 215 | + ${async function* () { |
| 216 | + yield await new Promise((resolve) => { |
| 217 | + setTimeout(() => { |
| 218 | + resolve(renderComponent(result, '', Scalar, { id: `${props.id}/async_generator` })); |
| 219 | + }, 0); |
| 220 | + }); |
| 221 | + }} |
| 222 | + ${function* () { |
| 223 | + yield renderComponent(result, '', Scalar, { id: `${props.id}/generator` }); |
| 224 | + }} |
| 225 | + ${renderComponent(result, '', Scalar, { id: `${props.id}/last` })} |
| 226 | + </root>`; |
| 227 | + }); |
| 228 | + |
| 229 | + const result = await renderToString(Root({}, { id: 'root' }, {})); |
| 230 | + |
| 231 | + const rendered = getRenderedIds(result); |
| 232 | + |
| 233 | + assert.deepEqual(rendered, [ |
| 234 | + 'root', |
| 235 | + 'root/first', |
| 236 | + 'root/func', |
| 237 | + 'root/promise', |
| 238 | + 'root/array_func', |
| 239 | + 'root/array_scalar', |
| 240 | + 'root/async_generator', |
| 241 | + 'root/generator', |
| 242 | + 'root/last', |
| 243 | + ]); |
| 244 | + }); |
| 245 | +}); |
| 246 | + |
| 247 | +function renderToString(item) { |
| 248 | + if (isPromise(item)) { |
| 249 | + return item.then(renderToString); |
| 250 | + } |
| 251 | + |
| 252 | + let result = ''; |
| 253 | + |
| 254 | + const destination = { |
| 255 | + write: (chunk) => { |
| 256 | + result += chunk.toString(); |
| 257 | + }, |
| 258 | + }; |
| 259 | + |
| 260 | + const renderResult = item.render(destination); |
| 261 | + |
| 262 | + if (isPromise(renderResult)) { |
| 263 | + return renderResult.then(() => result); |
| 264 | + } |
| 265 | + |
| 266 | + return result; |
| 267 | +} |
| 268 | + |
| 269 | +function getRenderedIds(html) { |
| 270 | + return cheerio |
| 271 | + .load( |
| 272 | + html, |
| 273 | + null, |
| 274 | + false, |
| 275 | + )('*') |
| 276 | + .map((_, node) => node.attribs['id']) |
| 277 | + .toArray(); |
| 278 | +} |
| 279 | + |
| 280 | +class ManualResetEvent { |
| 281 | + #resolve; |
| 282 | + #promise; |
| 283 | + #done = false; |
| 284 | + |
| 285 | + release() { |
| 286 | + if (this.#done) { |
| 287 | + return; |
| 288 | + } |
| 289 | + |
| 290 | + this.#done = true; |
| 291 | + |
| 292 | + if (this.#resolve) { |
| 293 | + this.#resolve(); |
| 294 | + } |
| 295 | + } |
| 296 | + |
| 297 | + wait() { |
| 298 | + // Promise constructor callbacks are called immediately |
| 299 | + // so retrieving the value of "resolve" should |
| 300 | + // be safe to do. |
| 301 | + |
| 302 | + if (!this.#promise) { |
| 303 | + this.#promise = this.#done |
| 304 | + ? Promise.resolve() |
| 305 | + : new Promise((resolve) => { |
| 306 | + this.#resolve = resolve; |
| 307 | + }); |
| 308 | + } |
| 309 | + |
| 310 | + return this.#promise; |
| 311 | + } |
| 312 | +} |
0 commit comments