Feature: SSR Shared State #34

sgammon · 2022-07-18T05:23:56Z

This changeset introduces the concept of shared state, which is computed during a PageController execution, and shared with the render context.

State is shared with the frontend via an injected JSON blob which the framework can decode on behalf of the developer, similar to how getServerSideProps works in Next.js.

VM-side, state is exported for guest language use, allowing access to context/state within SSR bundles.

Changelog

Introduce new PageWithProps controller, and props() extension point, where the developer provides shared state for a given request/response cycle
Support basic for state sharing with SSR scripts
Serialize and inject server-side props for frontend use
Provide boot entrypoint for frontend apps, which accounts for server-injected state, + SSR vs. CSR mode
Fix for double-render / double-compute of state
Fix support for VM inspection via -Delide.vm.inspect
Fix for runBlocking call during HTML rendering
Testsuite amendments / fixes
General cleanup (quite a mess)

sonarcloud · 2022-07-18T05:31:37Z

SonarCloud Quality Gate failed.

1 Bug
0 Vulnerabilities
0 Security Hotspots
3 Code Smells

7.9% Coverage
0.0% Duplication

codecov · 2022-07-18T05:31:53Z

Codecov Report

Merging #34 (0075e45) into v3 (c5fdf89) will increase coverage by 4.78%.
The diff coverage is 14.51%.

@@             Coverage Diff              @@
##                 v3      #34      +/-   ##
============================================
+ Coverage     59.02%   63.81%   +4.78%     
- Complexity      350      356       +6     
============================================
  Files            69       70       +1     
  Lines          2726     2556     -170     
  Branches        248      228      -20     
============================================
+ Hits           1609     1631      +22     
+ Misses         1056      862     -194     
- Partials         61       63       +2

Impacted Files	Coverage Δ
...src/main/kotlin/elide/runtime/graalvm/JsRuntime.kt	`0.00% <0.00%> (ø)`
...alvm/src/main/kotlin/elide/server/SSRExtensions.kt	`0.00% <0.00%> (ø)`
.../main/kotlin/elide/server/ssr/ServerSSRRenderer.kt	`0.00% <0.00%> (ø)`
...server/src/main/kotlin/elide/server/Application.kt	`0.00% <0.00%> (ø)`
...in/kotlin/elide/server/controller/PageWithProps.kt	`0.00% <0.00%> (ø)`
...ide/server/controller/builtin/BuiltinController.kt	`100.00% <ø> (ø)`
...rc/main/kotlin/elide/server/runtime/AppExecutor.kt	`82.75% <ø> (+25.18%)`	⬆️
.../src/main/kotlin/elide/server/type/RequestState.kt	`0.00% <0.00%> (ø)`
...er/src/main/kotlin/elide/server/util/ServerFlag.kt	`0.00% <0.00%> (ø)`
...ges/server/src/main/kotlin/kotlinx/html/api.ext.kt	`0.00% <0.00%> (ø)`
... and 9 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update c5fdf89...0075e45. Read the comment docs.

This changeset introduces the concept of shared state, which is computed during a `PageController` execution, and shared with the render context. State is shared with the frontend via an injected JSON blob which the framework can decode on behalf of the developer, similar to how `getServerSideProps` works in Next.js. VM-side, state is exported for guest language use, allowing access to context/state within SSR bundles. Changes enclosed: - Introduce new `PageWithProps` controller, and `props()` extension point, where the developer provides shared state for a given cycle - Support basic for state sharing with SSR scripts - Serialize and inject server-side props for frontend use - Provide `boot` entrypoint for frontend apps, which accounts for server-injected state, + SSR vs. CSR mode - Fix for double-render / double-compute of state - Fix support for VM inspection via `-Delide.vm.inspect` - Fix for `runBlocking` call during HTML rendering