Configurable Runtime

.github/workflows/benchmark-ssr.yml

@@ -0,0 +1,65 @@
+---
+name: Benchmark - SSR
+
+on:
+  pull_request:
+    branches: [master]
+    paths:
+      - .github/workflows/benchmark-ssr.yml
+      - "packages/yew"
+      - "examples/function_router"
+      - "tools/benchmark-ssr"
+
+jobs:
+  benchmark-ssr:
+    name: Benchmark - SSR
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout master
+        uses: actions/checkout@v3
+        with:
+          repository: 'yewstack/yew'
+          ref: master
+          path: yew-master
+
+      - name: Checkout pull request
+        uses: actions/checkout@v3
+        with:
+          path: current-pr
+
+      - name: Setup toolchain
+        uses: actions-rs/toolchain@v1
+        with:
+          toolchain: stable
+          target: wasm32-unknown-unknown
+          profile: minimal
+
+      - name: Restore Rust cache for master
+        uses: Swatinem/rust-cache@v1
+        with:
+          working-directory: yew-master
+          key: master
+
+      - name: Restore Rust cache for current pull request
+        uses: Swatinem/rust-cache@v1
+        with:
+          working-directory: current-pr
+          key: pr
+
+      - name: Build master examples
+        run: cargo run --profile=bench --bin benchmark-ssr -- --output-path ./output.json
+        working-directory: yew-master
+
+      - name: Build pull request examples
+        run: cargo run --profile=bench --bin benchmark-ssr -- --output-path ./output.json
+        working-directory: current-pr
+
+      - name: Upload Artifact
+        uses: actions/upload-artifact@v2
+        with:
+          name: benchmark-ssr
+          path:
+            - "yew-master/output.json"
+            - "current-pr/output.json"
+          retention-days: 1

.github/workflows/post-benchmark-ssr.yml

@@ -0,0 +1,74 @@
+---
+name: Post Comment for Benchmark - SSR
+
+on:
+  workflow_run:
+    workflows: ["Benchmark - SSR"]
+    types:
+      - completed
+
+jobs:
+  post-benchmark-ssr:
+    name: Post Comment on Pull Request
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Download Repository
+        uses: actions/checkout@v2
+
+      - if: github.event.workflow_run.event == 'pull_request'
+        name: Download Artifact
+        uses: Legit-Labs/action-download-artifact@v2
+        with:
+          github_token: "${{ secrets.GITHUB_TOKEN }}"
+          workflow: benchmark-ssr.yml
+          run_id: ${{ github.event.workflow_run.id }}
+          name: benchmark-ssr
+          path: "benchmark-ssr/"
+
+      - name: Make pull request comment
+        run: python3 ci/make_benchmark_ssr_cmt.py
+
+      - name: Post Comment
+        uses: actions/github-script@v6
+        with:
+          script: |
+            const commentInfo = {
+              ...context.repo,
+              issue_number: ${{ env.PR_NUMBER }},
+            };
+
+            const comment = {
+              ...commentInfo,
+              body: JSON.parse(process.env.YEW_BENCH_SSR),
+            };
+
+            function isCommentByBot(comment) {
+              return comment.user.type === "Bot" && comment.body.includes("### Benchmark - SSR");
+            }
+
+            let commentId = null;
+            const comments = (await github.rest.issues.listComments(commentInfo)).data;
+            for (let i = comments.length; i--; ) {
+              const c = comments[i];
+              if (isCommentByBot(c)) {
+                commentId = c.id;
+                break;
+              }
+            }
+
+            if (commentId) {
+              try {
+                await github.rest.issues.updateComment({
+                  ...context.repo,
+                  comment_id: commentId,
+                  body: comment.body,
+                });
+              } catch (e) {
+                commentId = null;
+              }
+            }
+
+            if (!commentId) {
+              await github.rest.issues.createComment(comment);
+            }

.github/workflows/post-size-cmp.yml

@@ -8,7 +8,7 @@ on:
       - completed
 
 jobs:
-  size-cmp:
+  post-size-cmp:
     name: Post Comment on Pull Request
     runs-on: ubuntu-latest
 

Cargo.toml

@@ -41,8 +41,15 @@ members = [
   # Tools
   "tools/benchmark-struct",
   "tools/benchmark-hooks",
+  "tools/benchmark-ssr",
   "tools/changelog",
   "tools/process-benchmark-results",
   "tools/website-test",
 ]
 resolver = "2"
+
+[profile.bench]
+lto = true
+codegen-units = 1
+panic = "abort"
+opt-level = 3

ci/make_benchmark_ssr_cmt.py

@@ -0,0 +1,56 @@
+from typing import Dict, List, Optional, Tuple
+
+import os
+import json
+
+
+header = "| Benchmark | Round | Min (ms) | Max (ms) | Mean (ms) | Standard Deviation |"
+sep = "| --- | --- | --- | --- | --- | --- |"
+
+
+def write_benchmark(lines: List[str], content: List[Dict[str, str]]) -> None:
+    lines.append("<details>")
+    lines.append("")
+    lines.append(header)
+    lines.append(sep)
+
+    for i in content:
+        lines.append(
+            "| {i.name} | {i.round} | {i.min} | {i.max} | {i.mean} | {i.std_dev} |"
+        )
+
+    lines.append("")
+    lines.append("</details>")
+
+
+def main() -> None:
+    with open("benchmark-ssr/yew-master/output.json") as f:
+        master_content = json.loads(f.read())
+
+    with open("benchmark-ssr/current-pr/output.json") as f:
+        pr_content = json.loads(f.read())
+
+    lines: List[str] = []
+
+    lines.append("### Benchmark - SSR")
+    lines.append("")
+
+    lines.append("#### Yew Master")
+    lines.append("")
+
+    write_benchmark(lines, master_content)
+
+    lines.append("#### Pull Request")
+    lines.append("")
+
+    write_benchmark(lines, pr_content)
+
+    output = "\n".join(lines)
+
+    with open(os.environ["GITHUB_ENV"], "a+") as f:
+        f.write(f"YEW_BENCH_SSR={json.dumps(output)}\n")
+        f.write(f"PR_NUMBER={issue_number}\n")
+
+
+if __name__ == "__main__":
+    main()

packages/yew/Cargo.toml

@@ -18,15 +18,15 @@ rust-version = "1.60.0"
 
 [dependencies]
 console_error_panic_hook = "0.1"
-gloo = "0.8"
+gloo = { version = "0.8", features = ["futures"] }
 gloo-utils = "0.1.0"
 indexmap = { version = "1", features = ["std"] }
 js-sys = "0.3"
 slab = "0.4"
 wasm-bindgen = "0.2"
 yew-macro = { version = "^0.19.0", path = "../yew-macro" }
 thiserror = "1.0"
-futures = { version = "0.3", optional = true }
+futures = "0.3"
 html-escape = { version = "0.2.9", optional = true }
 implicit-clone = { version = "0.3", features = ["map"] }
 base64ct = { version = "1.5.0", features = ["std"], optional = true }
@@ -96,7 +96,7 @@ features = [
 
 [features]
 tokio = ["tokio/rt", "dep:num_cpus", "dep:tokio-util"]
-ssr = ["dep:futures", "dep:html-escape", "dep:base64ct", "dep:bincode"]
+ssr = ["dep:html-escape", "dep:base64ct", "dep:bincode"]
 csr = []
 hydration = ["csr", "dep:bincode"]
 nightly = ["yew-macro/nightly"]

packages/yew/src/platform/io.rs

@@ -24,7 +24,8 @@ pub(crate) fn buffer(capacity: usize) -> (BufWriter, impl Stream<Item = String>)
     let (tx, rx) = mpsc::unbounded_channel::<String>();
 
     let tx = BufWriter {
-        buf: String::with_capacity(capacity),
+        // We start without allocation so empty strings will not be allocated.
+        buf: String::new(),
         tx,
         capacity,
     };
@@ -59,9 +60,18 @@ impl BufWriter {
         self.capacity
     }
 
+    #[inline]
     fn drain(&mut self) {
-        let _ = self.tx.send(self.buf.drain(..).collect());
-        self.buf.reserve(self.capacity);
+        if !self.buf.is_empty() {
+            let _ = self.tx.send(self.buf.split_off(0));
+        }
+    }
+
+    #[inline]
+    fn reserve(&mut self) {
+        if self.buf.is_empty() {
+            self.buf.reserve(self.capacity);
+        }
     }
 
     /// Returns `True` if the internal buffer has capacity to fit a string of certain length.
@@ -72,6 +82,9 @@ impl BufWriter {
 
     /// Writes a string into the buffer, optionally drains the buffer.
     pub fn write(&mut self, s: Cow<'_, str>) {
+        // Try to reserve the capacity first.
+        self.reserve();
+
         if !self.has_capacity_of(s.len()) {
             // There isn't enough capacity, we drain the buffer.
             self.drain();