Merge branch 'master' into changelog-migration-addition

Author: Madoshakalaka

.cargo/config.toml

@@ -1,7 +1,8 @@
-[target.'cfg(target_arch = "wasm32")']
+[target.'cfg(all(target_arch = "wasm32", not(target_os = "wasi")))']
 runner = 'wasm-bindgen-test-runner'
 
-# This section needs to be last.
-# GitHub Actions modifies this section.
-[unstable]
-doctest-xcompile = true
+[target.'cfg(all(target_arch = "wasm32", target_os = "wasi"))']
+runner = 'wasmtime -W unknown-imports-trap=y'
+
+[target.wasm32-unknown-unknown]
+rustflags = ['--cfg', 'getrandom_backend="wasm_js"']

.gitattributes

@@ -0,0 +1 @@
+*.mdx linguist-detectable=false

.github/ISSUE_TEMPLATE/documentation.md

@@ -11,7 +11,7 @@ assignees: ''
 
 This is about:
 - [ ] A typo 
-- [ ] Innaccurate/misleading documentation (e.g. technically incorrect advice)
+- [ ] Inaccurate/misleading documentation (e.g. technically incorrect advice)
 - [ ] Undocumented code
 - [ ] Outdated documentation
 - [ ] Other

.github/workflows/auto-approve-maintainer-pr.yml

@@ -16,14 +16,14 @@ jobs:
     steps:
       - name: Check if organization member
         id: is_organization_member
-        uses: JamesSingleton/is-organization-member@1.0.1
+        uses: JamesSingleton/is-organization-member@1.1.0
         with:
           organization: "yewstack"
           username: ${{ github.event.pull_request.user.login }}
           token: ${{ secrets.GITHUB_TOKEN }}
 
       - name: Auto approve
-        uses: hmarr/auto-approve-action@v3
+        uses: hmarr/auto-approve-action@v4
         if: ${{ steps.is_organization_member.outputs.result == 'true' || github.actor == 'dependabot[bot]' }}
         with:
           github-token: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/benchmark-core.yml

@@ -0,0 +1,62 @@
+name: Benchmark - core
+
+on:
+  pull_request:
+    branches: [master]
+    paths:
+      - .github/workflows/benchmark-core.yml
+      - "packages/yew/**"
+      - "tools/benchmark-core/**"
+
+jobs:
+  benchmark-core:
+    name: Benchmark - core
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout master
+        uses: actions/checkout@v6
+        with:
+          repository: "yewstack/yew"
+          ref: master
+          path: yew-master
+
+      - name: Checkout pull request
+        uses: actions/checkout@v6
+        with:
+          path: current-pr
+
+      - name: Setup toolchain
+        uses: dtolnay/rust-toolchain@master
+        with:
+          toolchain: stable
+
+      - name: Restore Rust cache for yew packages
+        uses: Swatinem/rust-cache@v2
+        with:
+          workspaces: |
+            yew-master
+            current-pr
+
+      - name: Run pull request benchmark
+        working-directory: current-pr/tools/benchmark-core
+        run: cargo bench -q > ../output.log
+
+      - name: Run master benchmark
+        working-directory: yew-master/tools/benchmark-core
+        run: cargo bench -q > ../output.log
+
+      - name: Write Pull Request ID
+        run: |
+          echo "${{ github.event.number }}" > .PR_NUMBER
+
+      - name: Upload Artifact
+        uses: actions/upload-artifact@v7
+        with:
+          name: benchmark-core
+          include-hidden-files: true
+          path: |
+            .PR_NUMBER
+            yew-master/tools/output.log
+            current-pr/tools/output.log
+          retention-days: 1

.github/workflows/benchmark-ssr.yml

@@ -1,4 +1,3 @@
----
 name: Benchmark - SSR
 
 on:
@@ -20,14 +19,14 @@ jobs:
 
     steps:
       - name: Checkout master
-        uses: actions/checkout@v4
+        uses: actions/checkout@v6
         with:
           repository: "yewstack/yew"
           ref: master
           path: yew-master
 
       - name: Checkout pull request
-        uses: actions/checkout@v4
+        uses: actions/checkout@v6
         with:
           path: current-pr
 
@@ -37,34 +36,30 @@ jobs:
           toolchain: stable
           targets: wasm32-unknown-unknown
 
-      - name: Restore Rust cache for master
+      - name: Restore Rust cache for yew packages
         uses: Swatinem/rust-cache@v2
         with:
-          working-directory: yew-master
-          key: master
-
-      - name: Restore Rust cache for current pull request
-        uses: Swatinem/rust-cache@v2
-        with:
-          working-directory: current-pr
-          key: pr
+          workspaces: |
+            yew-master
+            current-pr
 
       - name: Run pull request benchmark
-        run: cargo run --profile=bench -- --output-path ../output.json
         working-directory: current-pr/tools/benchmark-ssr
+        run: cargo run --profile=bench -- --output-path ../output.json
 
       - name: Run master benchmark
-        run: cargo run --profile=bench -- --output-path ../output.json
         working-directory: yew-master/tools/benchmark-ssr
+        run: cargo run --profile=bench -- --output-path ../output.json
 
       - name: Write Pull Request ID
         run: |
           echo "${{ github.event.number }}" > .PR_NUMBER
 
       - name: Upload Artifact
-        uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@v7
         with:
           name: benchmark-ssr
+          include-hidden-files: true
           path: |
             .PR_NUMBER
             yew-master/tools/output.json

.github/workflows/benchmark.yml

@@ -11,22 +11,23 @@ on:
       - "website/**"
     types: [labeled, synchronize, opened, reopened]
 
-permissions:
-  # deployments permission to deploy GitHub pages website
-  deployments: write
-  # contents permission to update benchmark contents in gh-pages branch
-  contents: write
+# Cancel outstanding benchmarks on pull requests
+# https://docs.github.com/en/actions/writing-workflows/workflow-syntax-for-github-actions#example-using-a-fallback-value
+concurrency:
+  group: ${{ github.head_ref || github.run_id }}
+  cancel-in-progress: true
 
 jobs:
   benchmark:
+    if: github.event_name != 'pull_request' || contains(github.event.pull_request.labels.*.name, 'performance')
     runs-on: ubuntu-latest
 
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v6
         with:
           path: "yew"
 
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v6
         with:
           repository: krausest/js-framework-benchmark
           path: "js-framework-benchmark"
@@ -37,91 +38,108 @@ jobs:
           toolchain: stable
           targets: wasm32-unknown-unknown
 
-      - uses: jetli/wasm-pack-action@v0.4.0
-        with:
-          version: "latest"
+      - name: Setup wasm-pack
+        uses: jetli/wasm-pack-action@v0.4.0
 
       - name: Setup Node
-        uses: actions/setup-node@v3
+        uses: actions/setup-node@v6
         with:
-          node-version: 18
+          node-version: "lts/Jod"
           cache: "npm"
           cache-dependency-path: js-framework-benchmark/package-lock.json
 
-      - uses: Swatinem/rust-cache@v2
+      - name: Restore Rust cache for yew packages
+        uses: Swatinem/rust-cache@v2
+        with:
+          save-if: ${{ github.ref == 'refs/heads/master' }}
+          workspaces: |
+            yew
+
+      - name: Setup chrome
+        id: setup-chrome
+        uses: browser-actions/setup-chrome@v2
+        with:
+          install-chromedriver: true
 
-      - name: setup js-framework-benchmark
+      - name: Setup js-framework-benchmark
         working-directory: js-framework-benchmark
         run: |
           npm ci
           npm run install-server
           npm run install-webdriver-ts
 
-      - name: setup benchmark-struct benchmark
+      - name: Setup benchmark-struct benchmark
         run: |
           ls -lauh
           rm *.js
           rm *.wasm
           echo "STRUCT_BUILD_DIR=$PWD" >> $GITHUB_ENV
         working-directory: js-framework-benchmark/frameworks/keyed/yew/bundled-dist/
 
-      - name: build benchmark-struct app
+      - name: Build benchmark-struct app
         working-directory: yew/tools/benchmark-struct
         run: |
-          wasm-pack build \
+          RUSTFLAGS='--cfg getrandom_backend="wasm_js"' wasm-pack build \
             --release \
             --target web \
             --no-typescript \
             --out-name js-framework-benchmark-yew \
             --out-dir $STRUCT_BUILD_DIR
 
-      - name: show built benchmark-struct benchmark files
+      - name: Show built benchmark-struct benchmark files
         run: |
           ls -lauh js-framework-benchmark/frameworks/keyed/yew/bundled-dist/
 
-      - name: setup yew-hooks benchmark
+      - name: Setup yew-hooks benchmark
         run: |
           ls -lauh
           rm *.js
           rm *.wasm
           echo "HOOKS_BUILD_DIR=$PWD" >> $GITHUB_ENV
         working-directory: js-framework-benchmark/frameworks/keyed/yew-hooks/bundled-dist/
 
-      - name: build benchmark-hooks app
+      - name: Build benchmark-hooks app
         working-directory: yew/tools/benchmark-hooks
         run: |
-          wasm-pack build \
+          RUSTFLAGS='--cfg getrandom_backend="wasm_js"' wasm-pack build \
             --release \
             --target web \
             --no-typescript \
             --out-name js-framework-benchmark-yew-hooks \
             --out-dir $HOOKS_BUILD_DIR
 
-      - name: show built benchmark-hooks benchmark files
+      - name: Show built benchmark-hooks benchmark files
         run: |
           ls -lauh js-framework-benchmark/frameworks/keyed/yew-hooks/bundled-dist/
 
-      - name: run js-framework-benchmark server
+      - name: Run js-framework-benchmark server
         working-directory: js-framework-benchmark
         run: |
           npm start &
           sleep 5
 
-      - name: js-framework-benchmark/webdriver-ts npm run bench
+      # https://chromium.googlesource.com/chromium/src/+/main/docs/security/apparmor-userns-restrictions.md
+      - run: echo 0 | sudo tee /proc/sys/kernel/apparmor_restrict_unprivileged_userns
+
+      - name: Run js-framework-benchmark/webdriver-ts npm run bench
         working-directory: js-framework-benchmark/webdriver-ts
-        run: xvfb-run npm run bench -- --framework keyed/yew keyed/yew-hooks --runner playwright
+        run: xvfb-run npm run bench -- --framework keyed/yew keyed/yew-hooks --runner playwright --chromeBinary "$CHROME_PATH"
+        env:
+          CHROME_PATH: ${{ steps.setup-chrome.outputs.chrome-path }}
 
-      - name: transform results to be fit for display benchmark-action/github-action-benchmark@v1
+      - name: Transform results to be fit for display benchmark-action/github-action-benchmark@v1
         run: |
           mkdir artifacts/
           jq -s . js-framework-benchmark/webdriver-ts/results/*.json | cargo run --manifest-path yew/Cargo.toml --release -p process-benchmark-results > artifacts/results.json
-          echo "$EVENT_INFO" > artifacts/PR_INFO
+          echo "$EVENT_INFO" > artifacts/.PR_INFO
         env:
           EVENT_INFO: ${{ toJSON(github.event) }}
 
       - name: Upload result artifacts
-        uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@v7
         with:
           name: results
           path: artifacts/
           if-no-files-found: error
+          include-hidden-files: true
+          retention-days: 1

.github/workflows/build-api-docs.yml

@@ -16,10 +16,8 @@ on:
 jobs:
   build:
     runs-on: ubuntu-latest
-    env:
-      PR_INFO_FILE: ".PR_INFO"
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v6
 
       - name: Setup toolchain
         uses: dtolnay/rust-toolchain@master
@@ -46,7 +44,7 @@ jobs:
           cp -r target/doc/* api-docs/dist/next
 
       - name: Upload build artifact
-        uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@v7
         with:
           name: api-docs
           path: api-docs/
@@ -55,12 +53,13 @@ jobs:
       - if: github.event_name == 'pull_request'
         name: Build pr info
         run: |
-          echo "${{ github.event.number }}" > $PR_INFO_FILE
+          echo "${{ github.event.number }}" > .PR_INFO
 
       - if: github.event_name == 'pull_request'
         name: Upload pr info
-        uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@v7
         with:
           name: pr-info
-          path: "${{ env.PR_INFO_FILE }}"
+          include-hidden-files: true
+          path: .PR_INFO
           retention-days: 1