Update examples and their builds in CI (#2652)

- Remove agents example
- Agents example is replaced by web_worker_fib as they both serve the same purpose now that trunk 0.15 has been released
- Clean up CI setup and ensure that examples are deployed in publish-examples.yml as they're built in size-cmp.yml

.cargo/config → .cargo/config.toml

@@ -3,3 +3,4 @@ runner = 'wasm-bindgen-test-runner'
 
 [unstable]
 doctest-xcompile = true
+# [unstable] must be the last section -- ci/write-optimisation-flags.sh relies on it

.github/workflows/publish-examples.yml

@@ -12,62 +12,29 @@ jobs:
     env:
       # leave empty for /
       PUBLIC_URL_PREFIX: ""
+      RUSTUP_TOOLCHAIN: nightly
 
     steps:
       - uses: actions/checkout@v2
       - uses: actions-rs/toolchain@v1
         with:
-          toolchain: stable
+          toolchain: nightly
           target: wasm32-unknown-unknown
+          components: rust-src
           override: true
           profile: minimal
 
+      - name: Write optimisation flags
+        run: ./ci/write-optimisation-flags.sh
+
       - uses: Swatinem/rust-cache@v1
 
       - uses: jetli/trunk-action@v0.1.0
         with:
-          # Optional version of trunk to install(eg. 'v0.8.1', 'latest')
           version: 'latest'
 
-
-
       - name: Build examples
-        run: |
-          output="$(pwd)/dist"
-          mkdir "$output"
-
-          for path in examples/*; do
-            if [[ ! -d $path ]]; then
-              continue
-            fi
-
-            example=$(basename "$path")
-
-            # multi_thread doesn't work yet. See <https://github.com/thedodd/trunk/issues/40>.
-            if [[ "$example" == "agents" ]]; then
-              continue
-            fi
-
-            # web_worker_fib does not compile with trunk. See <https://github.com/thedodd/trunk/issues/46>.
-            if [[ "$example" == "web_worker_fib" ]]; then
-              continue
-            fi
-
-            # ssr does not need trunk
-            if [[ "$example" == "simple_ssr" ]]; then
-              continue
-            fi
-
-            echo "building: $example"
-            (
-              cd "$path"
-              dist_dir="$output/$example"
-
-              trunk build --release --dist "$dist_dir" --public-url "$PUBLIC_URL_PREFIX/$example"
-            )
-          done
-
-
+        run: ./ci/build-examples.sh
 
       - name: Deploy to Firebase
         uses: siku2/action-hosting-deploy@v0

.github/workflows/size-cmp.yml

@@ -56,35 +56,11 @@ jobs:
           version: 'latest'
 
       - name: Write optimisation flags for master
-        run: |
-          cat >> .cargo/config << EOF
-          [unstable]
-          build-std = ["std", "panic_abort"]
-          build-std-features = ["panic_immediate_abort"]
-          EOF
-          cat >> Cargo.toml << EOF
-          [profile.release]
-          lto = true
-          codegen-units = 1
-          panic = "abort"
-          opt-level = "z"
-          EOF
+        run: ./ci/write-optimisation-flags.sh
         working-directory: yew-master
 
       - name: Write optimisation flags for pull request
-        run: |
-          cat >> .cargo/config << EOF
-          [unstable]
-          build-std = ["std", "panic_abort"]
-          build-std-features = ["panic_immediate_abort"]
-          EOF
-          cat >> Cargo.toml << EOF
-          [profile.release]
-          lto = true
-          codegen-units = 1
-          panic = "abort"
-          opt-level = "z"
-          EOF
+        run: ./ci/write-optimisation-flags.sh
         working-directory: current-pr
 
       - name: Build master examples

Cargo.toml

@@ -8,7 +8,6 @@ members = [
   "packages/yew-router-macro",
 
   # Examples
-  "examples/agents",
   "examples/boids",
   "examples/contexts",
   "examples/counter",

ci/build-examples.sh

@@ -0,0 +1,28 @@
+# Must be run from root of the repo:
+# yew $ ./ci/build-examples.sh
+
+output="$(pwd)/dist"
+mkdir "$output"
+
+for path in examples/*; do
+  if [[ ! -d $path ]]; then
+    continue
+  fi
+
+  example=$(basename "$path")
+
+  # ssr does not need trunk
+  if [[ "$example" == "simple_ssr" || "$example" == "ssr_router" ]]; then
+    continue
+  fi
+
+  echo "building: $example"
+  (
+    # we are sure that $path exists
+    # shellcheck disable=SC2164
+    cd "$path"
+    dist_dir="$output/$example"
+
+    echo trunk build --release --dist "$dist_dir" --public-url "$PUBLIC_URL_PREFIX$example"
+  )
+done

ci/write-optimisation-flags.sh

@@ -0,0 +1,15 @@
+# Must be run from root of the repo:
+# yew $ ./ci/write-optimisation-flags.sh
+
+# this goes in [unstable] section
+cat >> .cargo/config << EOF
+build-std = ["std", "panic_abort"]
+build-std-features = ["panic_immediate_abort"]
+EOF
+cat >> Cargo.toml << EOF
+[profile.release]
+lto = true
+codegen-units = 1
+panic = "abort"
+opt-level = "z"
+EOF

examples/README.md

@@ -29,7 +29,6 @@ As an example, check out the TodoMVC example here: <https://examples.yew.rs/todo
 
 | Example                                            | CT | Description                                                                                                                        |
 | -------------------------------------------------- | -- | ---------------------------------------------------------------------------------------------------------------------------------- |
-| [agents](agents)                                   | S  | Cross-component communication using [Agents](https://yew.rs/docs/concepts/agents)                                                  |
 | [boids](boids)                                     | S  | Yew port of [Boids](https://en.wikipedia.org/wiki/Boids)                                                                           |
 | [contexts](contexts)                               | F  | A technical demonstration of Context API.                                                                                          |
 | [counter](counter)                                 | S  | Simple counter which can be incremented and decremented                                                                            |
@@ -40,7 +39,7 @@ As an example, check out the TodoMVC example here: <https://examples.yew.rs/todo
 | [futures](futures)                                 | S  | Demonstrates how you can use futures and async code with Yew. Features a Markdown renderer.                                        |
 | [game_of_life](game_of_life)                       | S  | Implementation of [Conway's Game of Life](https://en.wikipedia.org/wiki/Conway%27s_Game_of_Life)                                   |
 | [inner_html](inner_html)                           | S  | Embeds an external document as raw HTML by manually managing the element                                                           |
-| [js_callback](js_callback)                         | S  | Interacts with JavaScript code                                                                                                     |
+| [js_callback](js_callback)                         | F  | Interacts with JavaScript code                                                                                                     |
 | [keyed_list](keyed_list)                           | S  | Demonstrates how to use keys to improve the performance of lists                                                                   |
 | [mount_point](mount_point)                         | S  | Shows how to mount the root component to a custom element                                                                          |
 | [nested_list](nested_list)                         | S  | Renders a styled list which tracks hover events                                                                                    |
@@ -49,12 +48,12 @@ As an example, check out the TodoMVC example here: <https://examples.yew.rs/todo
 | [portals](portals)                                 | S  | Renders elements into out-of-tree nodes with the help of portals                                                                   |
 | [router](router)                                   | S  | The best yew blog built with `yew-router`                                                                                          |
 | [simple_ssr](simple_ssr)                           | F  | Demonstrates server-side rendering                                                                                                 |
-| [suspense](suspense)                               | F  | This is an example that demonstrates `<Suspense />` support                                                                          |
-| [function_memory_game](function_memory_game)       | F  | Implementation of [Memory Game](https://github.com/bradlygreen/Memory-Game)                                            |
+| [suspense](suspense)                               | F  | This is an example that demonstrates `<Suspense />` support                                                                        |
+| [function_memory_game](function_memory_game)       | F  | Implementation of [Memory Game](https://github.com/bradlygreen/Memory-Game)                                                        |
 | [timer](timer)                                     | S  | Demonstrates the use of the interval and timeout services                                                                          |
 | [todomvc](todomvc)                                 | S  | Implementation of [TodoMVC](http://todomvc.com/)                                                                                   |
 | [two_apps](two_apps)                               | S  | Runs two separate Yew apps which can communicate with each other                                                                   |
-| [web_worker_fib](web_worker_fib)                   | S  | Calculate fibonacci value of a number in a web worker thread                                                                       |
+| [web_worker_fib](web_worker_fib)                   | S  | Calculate fibonacci value of a number in a web worker thread using `gloo-worker`                                                   |
 | [webgl](webgl)                                     | S  | Controls a [WebGL canvas](https://developer.mozilla.org/en-US/docs/Web/API/WebGL_API/Tutorial/Getting_started_with_WebGL) from Yew |
 
 ## Next steps

examples/web_worker_fib/Cargo.toml

@@ -4,9 +4,6 @@ version = "0.1.0"
 edition = "2021"
 authors = ["Shrey Somaiya", "Zac Kologlu"]
 
-[lib]
-crate-type = ["cdylib"]
-
 [dependencies]
 yew = { path = "../../packages/yew", features = ["csr"] }
 yew-agent = { path = "../../packages/yew-agent" }