[ { "path": ".cargo/config.toml", "content": "[target.'cfg(all(target_arch = \"wasm32\", not(target_os = \"wasi\")))']\nrunner = 'wasm-bindgen-test-runner'\n\n[target.'cfg(all(target_arch = \"wasm32\", target_os = \"wasi\"))']\nrunner = 'wasmtime -W unknown-imports-trap=y'\n\n[target.wasm32-unknown-unknown]\nrustflags = ['--cfg', 'getrandom_backend=\"wasm_js\"']\n" }, { "path": ".firebaserc", "content": "{\n \"projects\": {\n \"default\": \"yew-rs\"\n },\n \"targets\": {\n \"yew-rs\": {\n \"hosting\": {\n \"website\": [\n \"yew-rs\"\n ],\n \"examples\": [\n \"yew-rs-examples\"\n ],\n \"api\": [\n \"yew-rs-api\"\n ]\n }\n }\n }\n}" }, { "path": ".gitattributes", "content": "*.mdx linguist-detectable=false\n" }, { "path": ".github/FUNDING.yml", "content": "# These are supported funding model platforms\n\ngithub: # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2]\npatreon: # Replace with a single Patreon username\nopen_collective: yew\nko_fi: # Replace with a single Ko-fi username\ntidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel\ncommunity_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry\nliberapay: # Replace with a single Liberapay username\nissuehunt: # Replace with a single IssueHunt username\notechie: # Replace with a single Otechie username\ncustom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2']\n" }, { "path": ".github/ISSUE_TEMPLATE/bug_report.md", "content": "---\nname: Bug report\nabout: Create a report to help us improve Yew\ntitle: ''\nlabels: bug\nassignees: ''\n\n---\n\n**Problem**\n\n\n**Steps To Reproduce**\nSteps to reproduce the behavior:\n1. Go to '...'\n2. Click on '....'\n3. Scroll down to '....'\n4. See error\n\n**Expected behavior**\nA clear and concise description of what you expected to happen.\n\n**Screenshots**\nIf applicable, add screenshots to help explain your problem.\n\n**Environment:**\n - Yew version: [e.g. v0.17, `master`]\n - Rust version: [e.g. 1.43.0, `nightly`]\n - Target, if relevant: [e.g. `wasm32-unknown-emscripten`]\n - Build tool, if relevant: [e.g. `wasm-pack`, `trunk`]\n - OS, if relevant: [e.g. MacOS]\n - Browser and version, if relevant: [e.g. Chrome v83]\n\n**Questionnaire**\n\n\n- [ ] I'm interested in fixing this myself but don't know where to start\n- [ ] I would like to fix and I have a solution\n- [ ] I don't have time to fix this right now, but maybe later\n" }, { "path": ".github/ISSUE_TEMPLATE/config.yml", "content": "blank_issues_enabled: true\ncontact_links:\n - name: Ask question\n url: https://discord.gg/VQck8X4\n about: Looking for a quick answer? Ask the community!\n - name: Feature proposal\n url: https://github.com/yewstack/yew/discussions/categories/ideas\n about: Start a discussion for a feature you would like to see\n - name: Issue with the Playground?\n url: https://github.com/yewstack/yew-playground/issues/new\n about: Open an issue on the yew-playground repository\n" }, { "path": ".github/ISSUE_TEMPLATE/documentation.md", "content": "---\nname: Documentation\nabout: Report an issue relating to this project's documentation.\ntitle: ''\nlabels: documentation\nassignees: ''\n\n---\n\n\n\nThis is about:\n- [ ] A typo \n- [ ] Inaccurate/misleading documentation (e.g. technically incorrect advice)\n- [ ] Undocumented code\n- [ ] Outdated documentation\n- [ ] Other\n\n**Problem**\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n**Details about the solution you'd like** _(Optional)_\n\n**Additional context** _(Optional)_\n\n\n**Questionaire** _(Optional)_\n- [ ] I'd like to write this documentation\n- [ ] I'd like to write this documentation but I'm not sure what's needed\n- [ ] I don't have time to add this right now, but maybe later\n" }, { "path": ".github/PULL_REQUEST_TEMPLATE.md", "content": "#### Description\n\n\n\nFixes #0000 \n\n#### Checklist\n\n\n\n- [ ] I have reviewed my own code\n- [ ] I have added tests\n \n \n" }, { "path": ".github/dependabot.yml", "content": "version: 2\nupdates:\n - package-ecosystem: \"cargo\"\n directory: \"/\"\n schedule:\n interval: \"weekly\"\n day: \"friday\"\n open-pull-requests-limit: 2\n groups:\n cargo-deps:\n patterns:\n - \"*\"\n\n - package-ecosystem: \"npm\"\n directory: \"/website\"\n schedule:\n interval: \"monthly\"\n target-branch: \"master\"\n groups:\n website-deps:\n patterns:\n - \"*\"\n\n - package-ecosystem: \"github-actions\"\n directory: \"/\"\n schedule:\n interval: \"monthly\"\n target-branch: \"master\"\n" }, { "path": ".github/workflows/auto-approve-maintainer-pr.yml", "content": "name: Auto approve\n\non:\n pull_request_target:\n types:\n - opened\n - reopened\n - synchronize\n - ready_for_review\n - review_requested\n\njobs:\n auto-approve:\n runs-on: ubuntu-latest\n if: github.event.pull_request.draft == false\n steps:\n - name: Check if organization member\n id: is_organization_member\n uses: JamesSingleton/is-organization-member@1.1.0\n with:\n organization: \"yewstack\"\n username: ${{ github.event.pull_request.user.login }}\n token: ${{ secrets.GITHUB_TOKEN }}\n\n - name: Auto approve\n uses: hmarr/auto-approve-action@v4\n if: ${{ steps.is_organization_member.outputs.result == 'true' || github.actor == 'dependabot[bot]' }}\n with:\n github-token: ${{ secrets.GITHUB_TOKEN }}\n" }, { "path": ".github/workflows/benchmark-core.yml", "content": "name: Benchmark - core\n\non:\n pull_request:\n branches: [master]\n paths:\n - .github/workflows/benchmark-core.yml\n - \"packages/yew/**\"\n - \"tools/benchmark-core/**\"\n\njobs:\n benchmark-core:\n name: Benchmark - core\n runs-on: ubuntu-latest\n\n steps:\n - name: Checkout master\n uses: actions/checkout@v6\n with:\n repository: \"yewstack/yew\"\n ref: master\n path: yew-master\n\n - name: Checkout pull request\n uses: actions/checkout@v6\n with:\n path: current-pr\n\n - name: Setup toolchain\n uses: dtolnay/rust-toolchain@master\n with:\n toolchain: stable\n\n - name: Restore Rust cache for yew packages\n uses: Swatinem/rust-cache@v2\n with:\n workspaces: |\n yew-master\n current-pr\n\n - name: Run pull request benchmark\n working-directory: current-pr/tools/benchmark-core\n run: cargo bench -q > ../output.log\n\n - name: Run master benchmark\n working-directory: yew-master/tools/benchmark-core\n run: cargo bench -q > ../output.log\n\n - name: Write Pull Request ID\n run: |\n echo \"${{ github.event.number }}\" > .PR_NUMBER\n\n - name: Upload Artifact\n uses: actions/upload-artifact@v7\n with:\n name: benchmark-core\n include-hidden-files: true\n path: |\n .PR_NUMBER\n yew-master/tools/output.log\n current-pr/tools/output.log\n retention-days: 1\n" }, { "path": ".github/workflows/benchmark-ssr.yml", "content": "name: Benchmark - SSR\n\non:\n pull_request:\n branches: [master]\n paths:\n - .github/workflows/benchmark-ssr.yml\n - \"packages/yew/**\"\n - \"packages/yew-macro/**\"\n - \"packages/yew-router/**\"\n - \"packages/yew-router-macro/**\"\n - \"examples/function_router/**\"\n - \"tools/benchmark-ssr/**\"\n\njobs:\n benchmark-ssr:\n name: Benchmark - SSR\n runs-on: ubuntu-latest\n\n steps:\n - name: Checkout master\n uses: actions/checkout@v6\n with:\n repository: \"yewstack/yew\"\n ref: master\n path: yew-master\n\n - name: Checkout pull request\n uses: actions/checkout@v6\n with:\n path: current-pr\n\n - name: Setup toolchain\n uses: dtolnay/rust-toolchain@master\n with:\n toolchain: stable\n targets: wasm32-unknown-unknown\n\n - name: Restore Rust cache for yew packages\n uses: Swatinem/rust-cache@v2\n with:\n workspaces: |\n yew-master\n current-pr\n\n - name: Run pull request benchmark\n working-directory: current-pr/tools/benchmark-ssr\n run: cargo run --profile=bench -- --output-path ../output.json\n\n - name: Run master benchmark\n working-directory: yew-master/tools/benchmark-ssr\n run: cargo run --profile=bench -- --output-path ../output.json\n\n - name: Write Pull Request ID\n run: |\n echo \"${{ github.event.number }}\" > .PR_NUMBER\n\n - name: Upload Artifact\n uses: actions/upload-artifact@v7\n with:\n name: benchmark-ssr\n include-hidden-files: true\n path: |\n .PR_NUMBER\n yew-master/tools/output.json\n current-pr/tools/output.json\n retention-days: 1\n" }, { "path": ".github/workflows/benchmark.yml", "content": "name: Benchmark\n\non:\n push:\n paths-ignore:\n - \"website/**\"\n branches:\n - master\n pull_request:\n paths-ignore:\n - \"website/**\"\n types: [labeled, synchronize, opened, reopened]\n\n# Cancel outstanding benchmarks on pull requests\n# https://docs.github.com/en/actions/writing-workflows/workflow-syntax-for-github-actions#example-using-a-fallback-value\nconcurrency:\n group: ${{ github.head_ref || github.run_id }}\n cancel-in-progress: true\n\njobs:\n benchmark:\n if: github.event_name != 'pull_request' || contains(github.event.pull_request.labels.*.name, 'performance')\n runs-on: ubuntu-latest\n\n steps:\n - uses: actions/checkout@v6\n with:\n path: \"yew\"\n\n - uses: actions/checkout@v6\n with:\n repository: krausest/js-framework-benchmark\n path: \"js-framework-benchmark\"\n\n - name: Setup toolchain\n uses: dtolnay/rust-toolchain@master\n with:\n toolchain: stable\n targets: wasm32-unknown-unknown\n\n - name: Setup wasm-pack\n uses: jetli/wasm-pack-action@v0.4.0\n\n - name: Setup Node\n uses: actions/setup-node@v6\n with:\n node-version: \"lts/Jod\"\n cache: \"npm\"\n cache-dependency-path: js-framework-benchmark/package-lock.json\n\n - name: Restore Rust cache for yew packages\n uses: Swatinem/rust-cache@v2\n with:\n save-if: ${{ github.ref == 'refs/heads/master' }}\n workspaces: |\n yew\n\n - name: Setup chrome\n id: setup-chrome\n uses: browser-actions/setup-chrome@v2\n with:\n install-chromedriver: true\n\n - name: Setup js-framework-benchmark\n working-directory: js-framework-benchmark\n run: |\n npm ci\n npm run install-server\n npm run install-webdriver-ts\n\n - name: Setup benchmark-struct benchmark\n run: |\n ls -lauh\n rm *.js\n rm *.wasm\n echo \"STRUCT_BUILD_DIR=$PWD\" >> $GITHUB_ENV\n working-directory: js-framework-benchmark/frameworks/keyed/yew/bundled-dist/\n\n - name: Build benchmark-struct app\n working-directory: yew/tools/benchmark-struct\n run: |\n RUSTFLAGS='--cfg getrandom_backend=\"wasm_js\"' wasm-pack build \\\n --release \\\n --target web \\\n --no-typescript \\\n --out-name js-framework-benchmark-yew \\\n --out-dir $STRUCT_BUILD_DIR\n\n - name: Show built benchmark-struct benchmark files\n run: |\n ls -lauh js-framework-benchmark/frameworks/keyed/yew/bundled-dist/\n\n - name: Setup yew-hooks benchmark\n run: |\n ls -lauh\n rm *.js\n rm *.wasm\n echo \"HOOKS_BUILD_DIR=$PWD\" >> $GITHUB_ENV\n working-directory: js-framework-benchmark/frameworks/keyed/yew-hooks/bundled-dist/\n\n - name: Build benchmark-hooks app\n working-directory: yew/tools/benchmark-hooks\n run: |\n RUSTFLAGS='--cfg getrandom_backend=\"wasm_js\"' wasm-pack build \\\n --release \\\n --target web \\\n --no-typescript \\\n --out-name js-framework-benchmark-yew-hooks \\\n --out-dir $HOOKS_BUILD_DIR\n\n - name: Show built benchmark-hooks benchmark files\n run: |\n ls -lauh js-framework-benchmark/frameworks/keyed/yew-hooks/bundled-dist/\n\n - name: Run js-framework-benchmark server\n working-directory: js-framework-benchmark\n run: |\n npm start &\n sleep 5\n\n # https://chromium.googlesource.com/chromium/src/+/main/docs/security/apparmor-userns-restrictions.md\n - run: echo 0 | sudo tee /proc/sys/kernel/apparmor_restrict_unprivileged_userns\n\n - name: Run js-framework-benchmark/webdriver-ts npm run bench\n working-directory: js-framework-benchmark/webdriver-ts\n run: xvfb-run npm run bench -- --framework keyed/yew keyed/yew-hooks --runner playwright --chromeBinary \"${{ steps.setup-chrome.outputs.chrome-path }}\"\n\n - name: Transform results to be fit for display benchmark-action/github-action-benchmark@v1\n run: |\n mkdir artifacts/\n jq -s . js-framework-benchmark/webdriver-ts/results/*.json | cargo run --manifest-path yew/Cargo.toml --release -p process-benchmark-results > artifacts/results.json\n echo \"$EVENT_INFO\" > artifacts/.PR_INFO\n env:\n EVENT_INFO: ${{ toJSON(github.event) }}\n\n - name: Upload result artifacts\n uses: actions/upload-artifact@v7\n with:\n name: results\n path: artifacts/\n if-no-files-found: error\n include-hidden-files: true\n retention-days: 1\n" }, { "path": ".github/workflows/build-api-docs.yml", "content": "name: Build API Docs (Rustdoc)\non:\n pull_request:\n branches: [master]\n paths:\n - \"packages/**\"\n - \"firebase.json\"\n - \".github/workflows/*-docs.yml\"\n push:\n branches: [master]\n paths:\n - \"packages/**\"\n - \"firebase.json\"\n - \".github/workflows/*-docs.yml\"\n\njobs:\n build:\n runs-on: ubuntu-latest\n steps:\n - uses: actions/checkout@v6\n\n - name: Setup toolchain\n uses: dtolnay/rust-toolchain@master\n with:\n toolchain: nightly\n components: rust-docs\n\n - name: Run cargo doc\n env:\n RUSTDOCFLAGS: --cfg documenting --html-before-content ./api-docs/before-content.html --extend-css ./api-docs/styles.css -Z unstable-options --enable-index-page\n run: |\n cargo doc \\\n --no-deps \\\n --all-features \\\n -p yew \\\n -p yew-macro \\\n -p yew-router \\\n -p yew-router-macro \\\n -p yew-agent\n\n - name: Move files in correct directory\n run: |\n mkdir -p api-docs/dist/next\n cp -r target/doc/* api-docs/dist/next\n\n - name: Upload build artifact\n uses: actions/upload-artifact@v7\n with:\n name: api-docs\n path: api-docs/\n retention-days: 1\n\n - if: github.event_name == 'pull_request'\n name: Build pr info\n run: |\n echo \"${{ github.event.number }}\" > .PR_INFO\n\n - if: github.event_name == 'pull_request'\n name: Upload pr info\n uses: actions/upload-artifact@v7\n with:\n name: pr-info\n include-hidden-files: true\n path: .PR_INFO\n retention-days: 1\n" }, { "path": ".github/workflows/build-website.yml", "content": "name: Build website\non:\n pull_request:\n branches: [master]\n paths:\n - \"website/**\"\n - \"firebase.json\"\n - \".github/workflows/*-website.yml\"\n push:\n branches: [master]\n paths:\n - \"website/**\"\n - \"firebase.json\"\n - \".github/workflows/*-website.yml\"\n\njobs:\n build:\n name: Build Website\n runs-on: ubuntu-latest\n steps:\n - uses: actions/checkout@v6\n\n - name: Setup node\n uses: actions/setup-node@v6\n with:\n node-version: \"lts/Jod\"\n package-manager-cache: false\n\n - name: Install dependencies\n run: |\n cd website\n npm ci\n\n - name: Run prettier\n id: fmt\n continue-on-error: true\n run: |\n cd website\n npm run fmt\n\n - if: steps.fmt.outcome == 'failure'\n run: |\n cd website\n npm run fmt:write\n git diff\n exit 1\n\n - name: Check Translations\n run: |\n cd website\n npm run check-translations\n\n - name: Build\n run: |\n cd website\n npm run build\n\n - name: Upload build artifact\n uses: actions/upload-artifact@v7\n with:\n name: website\n path: website/build/\n retention-days: 1\n\n - if: github.event_name == 'pull_request'\n name: Build pr info\n run: |\n echo \"${{ github.event.number }}\" > .PR_INFO\n\n - if: github.event_name == 'pull_request'\n name: Upload pr info\n uses: actions/upload-artifact@v7\n with:\n name: pr-info\n include-hidden-files: true\n path: .PR_INFO\n retention-days: 1\n" }, { "path": ".github/workflows/clippy.yml", "content": "name: Clippy\n\non:\n pull_request:\n paths:\n - \".github/workflows/clippy.yml\"\n - \"tools/**/*\"\n - \"examples/**/*\"\n - \"packages/**/*\"\n - \"Cargo.toml\"\n - \"Cargo.lock\"\n push:\n branches: [master]\n\njobs:\n feature-soundness:\n name: Feature Soundness\n runs-on: ubuntu-latest\n # if normal clippy doesn't succeed, do not try to lint feature soundness\n needs: clippy\n\n strategy:\n fail-fast: false\n matrix:\n profile:\n - dev\n - release\n steps:\n - uses: actions/checkout@v6\n\n - name: Setup toolchain\n uses: dtolnay/rust-toolchain@master\n with:\n toolchain: stable\n components: clippy\n\n - uses: Swatinem/rust-cache@v2\n with:\n save-if: ${{ github.ref == 'refs/heads/master' }}\n\n - uses: taiki-e/install-action@cargo-hack\n\n - name: Lint feature soundness\n if: matrix.profile == 'dev'\n run: >-\n cargo hack clippy\n -p yew -p yew-agent -p yew-router\n --feature-powerset --no-dev-deps\n --keep-going\n -- -D warnings\n\n - name: Lint feature soundness\n if: matrix.profile == 'release'\n run: >-\n cargo hack clippy\n -p yew -p yew-agent -p yew-router\n --feature-powerset --no-dev-deps\n --keep-going --release\n -- -D warnings\n\n clippy:\n name: Clippy Workspace\n runs-on: ubuntu-latest\n strategy:\n fail-fast: false\n matrix:\n toolchain:\n - stable\n\n steps:\n - uses: actions/checkout@v6\n\n - name: Setup toolchain\n uses: dtolnay/rust-toolchain@master\n with:\n toolchain: ${{ matrix.toolchain }}\n components: clippy\n\n - uses: Swatinem/rust-cache@v2\n with:\n save-if: ${{ github.ref == 'refs/heads/master' }}\n\n - name: Run clippy\n run: |\n cargo clippy \\\n --all-targets \\\n --all-features \\\n --workspace \\\n -- -D warnings\n" }, { "path": ".github/workflows/fmt.yml", "content": "name: cargo fmt\non:\n pull_request:\n paths:\n - \"**/*.rs\"\n push:\n branches: [master]\n paths:\n - \"**/*.rs\"\n\njobs:\n format:\n name: cargo fmt\n runs-on: ubuntu-latest\n steps:\n - uses: actions/checkout@v6\n\n - name: Setup toolchain\n uses: dtolnay/rust-toolchain@master\n with:\n toolchain: nightly\n components: rustfmt\n\n - name: Run fmt\n run: cargo +nightly fmt --all -- --check\n" }, { "path": ".github/workflows/inspect-next-changelogs.yml", "content": "name: Inspect next changelogs\n\npermissions:\n contents: write\n\non:\n workflow_dispatch:\n\njobs:\n generate:\n name: Generate changelogs\n runs-on: ubuntu-latest\n steps:\n - name: Checkout sources\n uses: actions/checkout@v6\n with:\n fetch-depth: 0\n\n - name: Setup toolchain\n uses: dtolnay/rust-toolchain@master\n with:\n toolchain: stable\n\n - name: Build changelog generator\n run: cargo build --release -p changelog -- \n\n - name: Read yew changelog in this step\n shell: bash\n run: ./target/release/changelog yew minor -t ${{ secrets.GITHUB_TOKEN }} -f \"$(pwd)/CHANGELOG.md\"\n\n - name: Read yew-router changelog in this step\n shell: bash\n run: ./target/release/changelog yew-router minor -t ${{ secrets.GITHUB_TOKEN }} -f \"$(pwd)/CHANGELOG.md\"\n\n - name: Read yew-agent changelog in this step\n shell: bash\n run: ./target/release/changelog yew-agent minor -t ${{ secrets.GITHUB_TOKEN }} -f \"$(pwd)/CHANGELOG.md\"\n" }, { "path": ".github/workflows/main-checks.yml", "content": "name: Main Checks\n\non:\n pull_request:\n paths:\n - \".github/workflows/main-checks.yml\"\n - \"ci/**\"\n - \"packages/**/*\"\n - \"examples/**/*\"\n - \"tools/**/*\"\n - \"Cargo.toml\"\n - \"Cargo.lock\"\n push:\n branches: [master]\n\njobs:\n spell_check:\n name: spellcheck\n runs-on: ubuntu-latest\n steps:\n - uses: actions/checkout@v6\n - name: Check spelling\n uses: crate-ci/typos@v1.44.0\n\n doc_tests:\n name: Documentation Tests\n runs-on: ubuntu-latest\n steps:\n - uses: actions/checkout@v6\n\n # for wasm-bindgen-cli, always use stable rust\n - name: Setup toolchain\n uses: dtolnay/rust-toolchain@master\n with:\n toolchain: stable\n\n - name: Setup toolchain\n uses: dtolnay/rust-toolchain@master\n with:\n toolchain: nightly\n targets: wasm32-unknown-unknown\n\n - uses: Swatinem/rust-cache@v2\n with:\n save-if: ${{ github.ref == 'refs/heads/master' }}\n\n - name: Install wasm-bindgen-cli\n shell: bash\n run: ./ci/install-wasm-bindgen-cli.sh\n\n - uses: browser-actions/setup-geckodriver@latest\n with:\n token: ${{ secrets.GITHUB_TOKEN }}\n - uses: nanasess/setup-chromedriver@v2\n\n - name: Run doctest\n run: |\n ls packages | xargs -I {} \\\n cargo test \\\n -p {} \\\n --doc \\\n --all-features \\\n --target wasm32-unknown-unknown\n\n integration_tests:\n name: Integration Tests on ${{ matrix.toolchain }}\n runs-on: ubuntu-latest\n\n strategy:\n fail-fast: false\n matrix:\n toolchain:\n - 1.84.0\n - stable\n\n steps:\n - uses: actions/checkout@v6\n\n # for wasm-bindgen-cli, always use stable rust\n - name: Setup toolchain\n uses: dtolnay/rust-toolchain@master\n with:\n toolchain: stable\n\n - name: Setup toolchain\n uses: dtolnay/rust-toolchain@master\n with:\n toolchain: ${{ matrix.toolchain }}\n targets: wasm32-unknown-unknown\n\n - uses: Swatinem/rust-cache@v2\n with:\n save-if: ${{ github.ref == 'refs/heads/master' }}\n\n - name: Install wasm-bindgen-cli\n shell: bash\n run: ./ci/install-wasm-bindgen-cli.sh\n\n - uses: browser-actions/setup-geckodriver@latest\n with:\n token: ${{ secrets.GITHUB_TOKEN }}\n\n - uses: nanasess/setup-chromedriver@v2\n\n - name: Run tests - yew\n run: |\n cd packages/yew\n CHROMEDRIVER=$(which chromedriver) cargo test --features csr,hydration,ssr,test --target wasm32-unknown-unknown\n GECKODRIVER=$(which geckodriver) cargo test --features csr,hydration,ssr,test --target wasm32-unknown-unknown\n\n - name: Run tests - yew-router\n run: |\n cd packages/yew-router\n CHROMEDRIVER=$(which chromedriver) cargo test --target wasm32-unknown-unknown\n GECKODRIVER=$(which geckodriver) cargo test --target wasm32-unknown-unknown\n\n unit_tests:\n name: Unit Tests on ${{ matrix.toolchain }}\n runs-on: ubuntu-latest\n strategy:\n fail-fast: false\n matrix:\n toolchain:\n - 1.84.0\n - stable\n - nightly\n\n steps:\n - uses: actions/checkout@v6\n\n - name: Setup toolchain\n uses: dtolnay/rust-toolchain@master\n with:\n toolchain: ${{ matrix.toolchain }}\n\n - uses: Swatinem/rust-cache@v2\n with:\n save-if: ${{ github.ref == 'refs/heads/master' }}\n\n - name: Run native tests\n env:\n # workaround for lack of ternary operator\n # see https://github.com/orgs/community/discussions/25725\n RUSTFLAGS: ${{ matrix.toolchain == 'nightly' && '--cfg nightly_yew' || '' }}\n run: |\n if [[ \"${{ matrix.toolchain }}\" == \"1.84.0\" ]]; then\n cargo test --all-targets -p yew-agent -p yew-agent-macro -p yew-router\n else\n ls packages | grep -v \"^yew$\" | xargs -I {} cargo test --all-targets -p {}\n fi\n\n - name: Run native tests for yew\n env:\n # workaround for lack of ternary operator\n # see https://github.com/orgs/community/discussions/25725\n RUSTFLAGS: ${{ matrix.toolchain == 'nightly' && '--cfg nightly_yew' || '' }}\n run: cargo test -p yew --all-features\n\n test-lints:\n name: Test lints on nightly\n runs-on: ubuntu-latest\n\n steps:\n - uses: actions/checkout@v6\n\n - name: Setup toolchain\n uses: dtolnay/rust-toolchain@master\n with:\n toolchain: nightly\n\n - uses: Swatinem/rust-cache@v2\n with:\n save-if: ${{ github.ref == 'refs/heads/master' }}\n\n - name: Run tests\n env:\n RUSTFLAGS: --cfg nightly_yew --cfg yew_lints\n run: cargo test -p yew-macro test_html_lints\n\n macro_tests_discovery:\n name: Discover macro tests\n runs-on: ubuntu-latest\n outputs:\n matrix: ${{ steps.discover.outputs.matrix }}\n steps:\n - uses: actions/checkout@v6\n - id: discover\n run: |\n matrix=$(\n find packages/*/tests -name '*_test.rs' ! -name 'html_lints_test.rs' -printf '%h/%f\\n' \\\n | while IFS= read -r path; do\n pkg=$(echo \"$path\" | cut -d/ -f2)\n test=$(basename \"$path\" .rs)\n printf '{\"package\":\"%s\",\"test\":\"%s\"}\\n' \"$pkg\" \"$test\"\n done \\\n | jq -sc '{include: .}'\n )\n echo \"matrix=$matrix\" >> \"$GITHUB_OUTPUT\"\n\n macro_tests:\n name: Macro Tests (${{ matrix.test }})\n needs: macro_tests_discovery\n runs-on: ubuntu-latest\n strategy:\n fail-fast: false\n matrix: ${{ fromJson(needs.macro_tests_discovery.outputs.matrix) }}\n\n steps:\n - uses: actions/checkout@v6\n\n - name: Setup toolchain\n uses: dtolnay/rust-toolchain@master\n with:\n toolchain: 1.84.0\n\n - uses: Swatinem/rust-cache@v2\n with:\n save-if: ${{ github.ref == 'refs/heads/master' }}\n\n - name: Run ${{ matrix.test }}\n run: cargo test -p ${{ matrix.package }} --test ${{ matrix.test }}\n\n unit_tests_wasi:\n name: Unit Tests (WASI) on ${{ matrix.toolchain }}\n runs-on: ubuntu-latest\n strategy:\n fail-fast: false\n matrix:\n toolchain:\n - stable\n - nightly\n\n steps:\n - uses: actions/checkout@v6\n - uses: dtolnay/rust-toolchain@master\n with:\n toolchain: ${{ matrix.toolchain }}\n target: wasm32-wasip1\n\n - name: Install wasmtime\n run: |\n wget https://github.com/bytecodealliance/wasmtime/releases/download/v24.0.0/wasmtime-v24.0.0-x86_64-linux.tar.xz\n tar xf wasmtime-v24.0.0-x86_64-linux.tar.xz\n mv wasmtime-v24.0.0-x86_64-linux/wasmtime ~/wasmtime\n rm -rf wasmtime-v24.0.0-x86_64-linux.tar.xz wasmtime-v24.0.0-x86_64-linux\n chmod +x ~/wasmtime\n mv ~/wasmtime /usr/local/bin\n source ~/.bashrc\n\n - uses: Swatinem/rust-cache@v2\n with:\n save-if: ${{ github.ref == 'refs/heads/master' }}\n\n - name: Run WASI tests for yew\n run: |\n RUST_LOG=info\n cargo test --features ssr,hydration,test --target wasm32-wasip1 -p yew\n\n example-runnable-tests-on-wasi:\n name: Example Runnable Tests on WASI\n runs-on: ubuntu-latest\n strategy:\n fail-fast: false\n matrix:\n package:\n - wasi_ssr_module\n toolchain:\n - stable\n - nightly\n steps:\n - uses: actions/checkout@v6\n - uses: dtolnay/rust-toolchain@master\n with:\n toolchain: ${{ matrix.toolchain }}\n target: wasm32-wasip1\n\n - name: Install wasmtime\n run: |\n wget https://github.com/bytecodealliance/wasmtime/releases/download/v24.0.0/wasmtime-v24.0.0-x86_64-linux.tar.xz\n tar xf wasmtime-v24.0.0-x86_64-linux.tar.xz\n mv wasmtime-v24.0.0-x86_64-linux/wasmtime ~/wasmtime\n rm -rf wasmtime-v24.0.0-x86_64-linux.tar.xz wasmtime-v24.0.0-x86_64-linux\n chmod +x ~/wasmtime\n mv ~/wasmtime /usr/local/bin\n source ~/.bashrc\n\n - uses: Swatinem/rust-cache@v2\n with:\n save-if: ${{ github.ref == 'refs/heads/master' }}\n\n - name: Build and run ${{ matrix.package }}\n run: |\n cargo build --target wasm32-wasip1 -p ${{ matrix.package }}\n wasmtime -W unknown-imports-trap=y target/wasm32-wasip1/debug/${{ matrix.package }}.wasm\n\n ssr_e2e_tests:\n name: SSR E2E Tests (${{ matrix.example }})\n runs-on: ubuntu-latest\n\n strategy:\n fail-fast: false\n matrix:\n include:\n - example: ssr_router\n server_bin: ssr_router_server\n trunk_dir: examples/ssr_router\n - example: simple_ssr\n server_bin: simple_ssr_server\n trunk_dir: examples/simple_ssr\n\n steps:\n - uses: actions/checkout@v6\n\n - name: Setup toolchain\n uses: dtolnay/rust-toolchain@master\n with:\n toolchain: stable\n targets: wasm32-unknown-unknown\n\n - uses: Swatinem/rust-cache@v2\n with:\n save-if: ${{ github.ref == 'refs/heads/master' }}\n\n - name: Install wasm-bindgen-cli\n shell: bash\n run: ./ci/install-wasm-bindgen-cli.sh\n\n - name: Install trunk\n uses: jetli/trunk-action@v0.5.1\n with:\n version: \"latest\"\n\n - uses: browser-actions/setup-geckodriver@latest\n with:\n token: ${{ secrets.GITHUB_TOKEN }}\n\n - name: Run SSR E2E tests\n run: |\n GECKODRIVER=$(which geckodriver) cargo run -p ssr-e2e -- \\\n --trunk-dir ${{ matrix.trunk_dir }} \\\n --server-cmd \"cargo run -p ${{ matrix.example }} --bin ${{ matrix.server_bin }} --features ssr -- --dir ${{ matrix.trunk_dir }}/dist\" \\\n --health-url http://127.0.0.1:8080/ \\\n --test-pkg ${{ matrix.example }} \\\n -- --target wasm32-unknown-unknown --test e2e\n" }, { "path": ".github/workflows/post-benchmark-core.yml", "content": "name: Post Comment for Benchmark - core\n\non:\n workflow_run:\n workflows: [\"Benchmark - core\"]\n types:\n - completed\n\njobs:\n post-benchmark-core:\n name: Post Benchmark Comment on Pull Request\n if: github.event.workflow_run.conclusion == 'success' && github.event.workflow_run.event == 'pull_request'\n runs-on: ubuntu-latest\n\n steps:\n - name: Download Repository\n uses: actions/checkout@v6\n\n - name: Download Artifact\n uses: actions/download-artifact@v8\n with:\n github-token: \"${{ secrets.GITHUB_TOKEN }}\"\n run-id: ${{ github.event.workflow_run.id }}\n name: benchmark-core\n path: benchmark-core/\n\n - name: Make pull request comment\n run: |\n cat - >>comment.txt <>comment.txt\n cat - >>comment.txt <>comment.txt\n cat - >>comment.txt <> $GITHUB_ENV\n\n - name: Post Comment\n uses: actions/github-script@v8\n with:\n script: |\n const fs = require('fs');\n\n const commentInfo = {\n ...context.repo,\n issue_number: ${{ env.PR_NUMBER }},\n };\n\n const comment = {\n ...commentInfo,\n body: fs.readFileSync(\"comment.txt\", 'utf-8'),\n };\n\n function isCommentByBot(comment) {\n return comment.user.type === \"Bot\" && comment.body.includes(\"### Benchmark - core\");\n }\n\n let commentId = null;\n const comments = (await github.rest.issues.listComments(commentInfo)).data;\n for (let i = comments.length; i--; ) {\n const c = comments[i];\n if (isCommentByBot(c)) {\n commentId = c.id;\n break;\n }\n }\n\n if (commentId) {\n try {\n await github.rest.issues.updateComment({\n ...context.repo,\n comment_id: commentId,\n body: comment.body,\n });\n } catch (e) {\n commentId = null;\n }\n }\n\n if (!commentId) {\n await github.rest.issues.createComment(comment);\n }\n" }, { "path": ".github/workflows/post-benchmark-ssr.yml", "content": "name: Post Comment for Benchmark - SSR\n\non:\n workflow_run:\n workflows: [\"Benchmark - SSR\"]\n types:\n - completed\n\njobs:\n post-benchmark-ssr:\n name: Post Comment on Pull Request\n if: github.event.workflow_run.conclusion == 'success' && github.event.workflow_run.event == 'pull_request'\n runs-on: ubuntu-latest\n\n steps:\n - name: Download Repository\n uses: actions/checkout@v6\n\n - name: Download Artifact\n uses: actions/download-artifact@v8\n with:\n github-token: \"${{ secrets.GITHUB_TOKEN }}\"\n run-id: ${{ github.event.workflow_run.id }}\n name: benchmark-ssr\n path: benchmark-ssr/\n\n - name: Make pull request comment\n run: python3 ci/make_benchmark_ssr_cmt.py\n\n - name: Read Pull Request ID\n run: echo \"PR_NUMBER=$(cat benchmark-ssr/.PR_NUMBER)\" >> $GITHUB_ENV\n\n - name: Post Comment\n uses: actions/github-script@v8\n with:\n script: |\n const commentInfo = {\n ...context.repo,\n issue_number: ${{ env.PR_NUMBER }},\n };\n\n const comment = {\n ...commentInfo,\n body: JSON.parse(process.env.YEW_BENCH_SSR),\n };\n\n function isCommentByBot(comment) {\n return comment.user.type === \"Bot\" && comment.body.includes(\"### Benchmark - SSR\");\n }\n\n let commentId = null;\n const comments = (await github.rest.issues.listComments(commentInfo)).data;\n for (let i = comments.length; i--; ) {\n const c = comments[i];\n if (isCommentByBot(c)) {\n commentId = c.id;\n break;\n }\n }\n\n if (commentId) {\n try {\n await github.rest.issues.updateComment({\n ...context.repo,\n comment_id: commentId,\n body: comment.body,\n });\n } catch (e) {\n commentId = null;\n }\n }\n\n if (!commentId) {\n await github.rest.issues.createComment(comment);\n }\n" }, { "path": ".github/workflows/post-benchmark.yml", "content": "name: \"Post benchmark results\"\n\non:\n workflow_run:\n workflows: [\"Benchmark\"]\n types:\n - completed\n\njobs:\n post-benchmark-results:\n if: github.event.workflow_run.conclusion == 'success'\n runs-on: ubuntu-latest\n\n steps:\n # Checkout repo for the github-action-benchmark action\n - uses: actions/checkout@v6\n\n - name: Download result artifacts\n uses: actions/download-artifact@v8\n with:\n github-token: \"${{ secrets.GITHUB_TOKEN }}\"\n run-id: ${{ github.event.workflow_run.id }}\n name: results\n path: ./artifacts\n\n - name: Test for PR\n uses: mathiasvr/command-output@v1\n id: test-pr\n with:\n run: cat artifacts/.PR_INFO\n\n # gh-pages branch is updated and pushed automatically with extracted benchmark data\n - name: Store benchmark result\n uses: benchmark-action/github-action-benchmark@v1\n with:\n name: \"Yew master branch benchmarks (Lower is better)\"\n tool: \"customSmallerIsBetter\"\n output-file-path: artifacts/results.json\n gh-pages-branch: \"gh-pages\"\n # Access token to deploy GitHub Pages branch\n github-token: ${{ secrets.GITHUB_TOKEN }}\n # Push and deploy GitHub pages branch automatically\n alert-threshold: \"200%\"\n alert-comment-cc-users: \"@yewstack/yew\"\n # Only push when this is a non-pr commit that has been benchmarked, i.e. master\n auto-push: ${{ fromJSON(steps.test-pr.outputs.stdout).number == '' }}\n save-data-file: ${{ fromJSON(steps.test-pr.outputs.stdout).number == '' }}\n # Enable job summary\n summary-always: true\n comment-always: true\n ref: ${{ github.event.workflow_run.head_sha }}\n" }, { "path": ".github/workflows/post-size-cmp.yml", "content": "name: Post Comment for Size Comparison\n\non:\n workflow_run:\n workflows: [\"Size Comparison\"]\n types:\n - completed\n\njobs:\n post-size-cmp:\n name: Post Size Comment on Pull Request\n if: github.event.workflow_run.conclusion == 'success' && github.event.workflow_run.event == 'pull_request'\n runs-on: ubuntu-latest\n\n steps:\n - name: Download Repository\n uses: actions/checkout@v6\n\n - name: Download Artifact (master)\n uses: actions/download-artifact@v8\n with:\n github-token: \"${{ secrets.GITHUB_TOKEN }}\"\n run-id: ${{ github.event.workflow_run.id }}\n name: size-cmp-master-info\n path: \"size-cmp-master-info/\"\n\n - name: Download Artifact (PR)\n uses: actions/download-artifact@v8\n with:\n github-token: \"${{ secrets.GITHUB_TOKEN }}\"\n run-id: ${{ github.event.workflow_run.id }}\n name: size-cmp-pr-info\n path: \"size-cmp-pr-info/\"\n\n - name: Make pull request comment\n run: python3 ci/make_example_size_cmt.py\n\n - name: Post Comment\n uses: actions/github-script@v8\n with:\n script: |\n const commentInfo = {\n ...context.repo,\n issue_number: ${{ env.PR_NUMBER }},\n };\n\n const comment = {\n ...commentInfo,\n body: JSON.parse(process.env.YEW_EXAMPLE_SIZES),\n };\n\n function isCommentByBot(comment) {\n return comment.user.type === \"Bot\" && comment.body.includes(\"### Size Comparison\");\n }\n\n let commentId = null;\n const comments = (await github.rest.issues.listComments(commentInfo)).data;\n for (let i = comments.length; i--; ) {\n const c = comments[i];\n if (isCommentByBot(c)) {\n commentId = c.id;\n break;\n }\n }\n\n if (commentId) {\n try {\n await github.rest.issues.updateComment({\n ...context.repo,\n comment_id: commentId,\n body: comment.body,\n });\n } catch (e) {\n commentId = null;\n }\n }\n\n if (!commentId) {\n await github.rest.issues.createComment(comment);\n }\n" }, { "path": ".github/workflows/publish-api-docs.yml", "content": "name: Publish API Docs\non:\n workflow_run:\n workflows: [\"Build API Docs (Rustdoc)\"]\n types:\n - completed\n\njobs:\n publish:\n if: github.event.workflow_run.conclusion == 'success'\n runs-on: ubuntu-latest\n\n steps:\n # need to checkout to get \"firebase.json\", \".firebaserc\"\n - uses: actions/checkout@v6\n\n - name: Download build artifact\n uses: actions/download-artifact@v8\n with:\n github-token: \"${{ secrets.GITHUB_TOKEN }}\"\n run-id: ${{ github.event.workflow_run.id }}\n name: api-docs\n path: api-docs/\n\n - if: github.event.workflow_run.event == 'pull_request'\n name: Download pr info\n uses: actions/download-artifact@v8\n with:\n github-token: \"${{ secrets.GITHUB_TOKEN }}\"\n run-id: ${{ github.event.workflow_run.id }}\n name: pr-info\n path: artifacts\n\n - if: github.event.workflow_run.event == 'pull_request'\n name: Apply pull request environment\n run: |\n pr_number=$(cat \"artifacts/.PR_INFO\")\n if ! [[ \"$pr_number\" =~ ^[0-9]+$ ]]; then\n echo \"pr number invalid\"\n exit 1\n fi\n echo \"PR_NUMBER=$pr_number\" >> $GITHUB_ENV\n echo \"PR_BRANCH=${{ github.event.workflow_run.head_branch }}\" >> $GITHUB_ENV\n echo \"COMMIT_SHA=${{ github.event.workflow_run.head_sha }}\" >> $GITHUB_ENV\n\n - if: github.event.workflow_run.event == 'push'\n name: Apply push environment\n run: |\n echo \"CHANNEL_ID=live\" >> $GITHUB_ENV\n\n - name: Deploy to Firebase\n uses: siku2/action-hosting-deploy@v1\n with:\n repoToken: \"${{ secrets.GITHUB_TOKEN }}\"\n firebaseToken: \"${{ secrets.FIREBASE_TOKEN }}\"\n targets: api\n channelId: \"${{ env.CHANNEL_ID }}\"\n # link to the next version because that's what we care about\n commentURLPath: \"/next/yew\"\n # PR information\n prNumber: \"${{ env.PR_NUMBER }}\"\n prBranchName: \"${{ env.PR_BRANCH }}\"\n commitSHA: \"${{ env.COMMIT_SHA }}\"\n" }, { "path": ".github/workflows/publish-examples.yml", "content": "name: Publish Examples\non:\n push:\n branches: [master]\n paths:\n - 'tools/build-examples/**'\n - 'examples/**'\n\njobs:\n publish:\n runs-on: ubuntu-latest\n env:\n # leave empty for /\n PUBLIC_URL_PREFIX: \"\"\n RUSTUP_TOOLCHAIN: nightly\n\n steps:\n - uses: actions/checkout@v6\n\n - name: Setup toolchain\n uses: dtolnay/rust-toolchain@master\n with:\n toolchain: nightly\n targets: wasm32-unknown-unknown\n components: rust-src\n\n - uses: Swatinem/rust-cache@v2\n\n - uses: jetli/trunk-action@v0.5.1\n with:\n version: 'latest'\n\n - name: Get latest wasm-opt version\n id: wasm-opt\n uses: pozetroninc/github-action-get-latest-release@master\n with:\n repository: WebAssembly/binaryen\n excludes: prerelease, draft\n token: ${{ secrets.GITHUB_TOKEN }}\n\n - name: Build examples\n run: cargo run -p build-examples --bin build-examples\n env:\n LATEST_WASM_OPT_VERSION: ${{ steps.wasm-opt.outputs.release }}\n\n - name: Deploy to Firebase\n uses: siku2/action-hosting-deploy@v1\n with:\n repoToken: \"${{ secrets.GITHUB_TOKEN }}\"\n firebaseToken: \"${{ secrets.FIREBASE_TOKEN }}\"\n channelId: live\n targets: examples\n" }, { "path": ".github/workflows/publish-website.yml", "content": "name: Publish website\non:\n workflow_run:\n workflows: [\"Build website\"]\n types:\n - completed\n\njobs:\n publish:\n if: github.event.workflow_run.conclusion == 'success'\n runs-on: ubuntu-latest\n\n steps:\n # need to checkout to get \"firebase.json\", \".firebaserc\"\n - uses: actions/checkout@v6\n\n - name: Download build artifact\n uses: actions/download-artifact@v8\n with:\n github-token: \"${{ secrets.GITHUB_TOKEN }}\"\n run-id: ${{ github.event.workflow_run.id }}\n name: website\n path: website/build\n\n - if: github.event.workflow_run.event == 'pull_request'\n name: Download pr info\n uses: actions/download-artifact@v8\n with:\n github-token: \"${{ secrets.GITHUB_TOKEN }}\"\n run-id: ${{ github.event.workflow_run.id }}\n name: pr-info\n path: artifacts\n\n - if: github.event.workflow_run.event == 'pull_request'\n name: Apply pull request environment\n run: |\n pr_number=$(cat \"artifacts/.PR_INFO\")\n if ! [[ \"$pr_number\" =~ ^[0-9]+$ ]]; then\n echo \"pr number invalid\"\n exit 1\n fi\n echo \"PR_NUMBER=$pr_number\" >> $GITHUB_ENV\n echo \"PR_BRANCH=${{ github.event.workflow_run.head_branch }}\" >> $GITHUB_ENV\n echo \"COMMIT_SHA=${{ github.event.workflow_run.head_sha }}\" >> $GITHUB_ENV\n\n - if: github.event.workflow_run.event == 'push'\n name: Apply push environment\n run: |\n echo \"CHANNEL_ID=live\" >> $GITHUB_ENV\n\n - name: Deploy to Firebase\n uses: siku2/action-hosting-deploy@v1\n with:\n repoToken: \"${{ secrets.GITHUB_TOKEN }}\"\n firebaseToken: \"${{ secrets.FIREBASE_TOKEN }}\"\n targets: website\n channelId: \"${{ env.CHANNEL_ID }}\"\n # link to the next version because that's what we care about\n commentURLPath: \"/docs/next\"\n # PR information\n prNumber: \"${{ env.PR_NUMBER }}\"\n prBranchName: \"${{ env.PR_BRANCH }}\"\n commitSHA: \"${{ env.COMMIT_SHA }}\"\n" }, { "path": ".github/workflows/publish.yml", "content": "name: Publish yew package(s)\n\npermissions:\n contents: write\n\non:\n workflow_dispatch:\n inputs:\n level:\n description: \"Version Level major|minor|patch\"\n required: true\n type: choice\n options:\n - patch\n - minor\n - major\n packages:\n description: \"List of packages to publish (space separated)\"\n required: true\n type: string\n\njobs:\n publish:\n name: Publish yew\n runs-on: ubuntu-latest\n steps:\n - name: Checkout sources\n uses: actions/checkout@v6\n with:\n token: \"${{ secrets.YEWTEMPBOT_TOKEN }}\"\n fetch-depth: 0\n\n - name: Config Git\n uses: oleksiyrudenko/gha-git-credentials@v2.1.2\n with:\n token: \"${{ secrets.YEWTEMPBOT_TOKEN }}\"\n\n - name: Setup toolchain\n uses: dtolnay/rust-toolchain@master\n with:\n toolchain: stable\n\n - name: Install cargo binary dependencies\n uses: baptiste0928/cargo-install@v3\n with:\n crate: cargo-release\n version: =1.1.1\n\n - name: Cargo login\n run: cargo login ${{ secrets.CRATES_IO_TOKEN }}\n\n - name: Build command\n shell: bash\n env:\n PACKAGES: ${{ github.event.inputs.packages }}\n run: |\n output=\"\"\n for pkg in ${{ github.event.inputs.packages }}\n do\n output+=\"--package $pkg \" \n done\n echo \"pkg=$output\" >> $GITHUB_ENV\n\n - name: Release yew\n run: cargo release ${{ github.event.inputs.level }} --execute --no-confirm ${{ env.pkg }}\n\n - name: Collect release info\n id: releaseinfo\n run: cargo run -p collect-release-info -- ${{ github.event.inputs.packages }}\n\n - name: Create a version branch\n if: github.event.inputs.level != 'patch'\n uses: peterjgrainger/action-create-branch@v3.0.0\n env:\n GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}\n with:\n branch: ${{ steps.releaseinfo.outputs.version_branch }}\n\n - name: Create releases\n env:\n GH_TOKEN: ${{ secrets.YEWTEMPBOT_TOKEN }}\n RELEASES: ${{ steps.releaseinfo.outputs.releases }}\n run: |\n echo \"$RELEASES\" | jq -c '.[]' | while read -r release; do\n tag=$(echo \"$release\" | jq -r '.tag')\n name=$(echo \"$release\" | jq -r '.name')\n body=$(echo \"$release\" | jq -r '.body')\n gh release create \"$tag\" --title \"$name\" --notes \"$body\"\n done\n" }, { "path": ".github/workflows/size-cmp.yml", "content": "name: Size Comparison\n\non:\n pull_request:\n branches: [master]\n paths:\n - .github/workflows/size-cmp.yml\n - \"ci/**\"\n - \"packages/**\"\n - \"examples/**\"\n - \"Cargo.toml\"\n\njobs:\n size-cmp:\n name: Collect ${{ matrix.target }} Size\n runs-on: ubuntu-latest\n strategy:\n matrix:\n target: [\"master\", \"pr\"]\n\n steps:\n - name: Checkout master\n uses: actions/checkout@v6\n if: ${{ matrix.target == 'master' }}\n with:\n repository: \"yewstack/yew\"\n ref: master\n\n - name: Checkout pull request\n uses: actions/checkout@v6\n if: ${{ matrix.target == 'pr' }}\n\n - name: Write Optimisation Flags\n run: |\n if [ -x ci/write-min-size-flags.sh ] ; then\n ci/write-min-size-flags.sh\n else\n # this branch is a fallback used only for compatibility with earlier commits\n # in the repository and other branches and can be removed in the future.\n echo 'build-std = [\"std\", \"panic_abort\"]' >> .cargo/config.toml\n echo '[build]' >> .cargo/config.toml\n echo 'rustflags = [\"-Cpanic=abort\"]' >> .cargo/config.toml\n fi\n\n - name: Setup toolchain\n uses: dtolnay/rust-toolchain@master\n with:\n toolchain: nightly\n components: rust-src\n targets: wasm32-unknown-unknown\n\n - name: Restore Rust cache\n uses: Swatinem/rust-cache@v2\n\n - name: Setup Trunk\n uses: jetli/trunk-action@v0.5.1\n with:\n version: \"latest\"\n\n - name: Get latest wasm-opt version\n id: wasm-opt\n uses: pozetroninc/github-action-get-latest-release@master\n with:\n repository: WebAssembly/binaryen\n excludes: prerelease, draft\n token: ${{ secrets.GITHUB_TOKEN }}\n\n - name: Build examples\n run: cargo run -p build-examples --bin build-examples\n env:\n LATEST_WASM_OPT_VERSION: ${{ steps.wasm-opt.outputs.release }}\n\n - name: Collect size information\n run: python3 ci/collect_sizes.py\n env:\n ISSUE_NUMBER: ${{ github.event.number }}\n\n - name: Upload Artifact\n uses: actions/upload-artifact@v7\n with:\n name: size-cmp-${{ matrix.target }}-info\n include-hidden-files: true\n path: \".SIZE_CMP_INFO\"\n retention-days: 1\n" }, { "path": ".github/workflows/test-website.yml", "content": "name: \"Test Website\"\n\non:\n pull_request:\n paths:\n - \".github/workflows/test-website.yml\"\n - \"packages/**/*\"\n - \"website/**/*\"\n push:\n branches: [master]\n\njobs:\n website_tests:\n name: Tests Website Snippets\n runs-on: ubuntu-latest\n steps:\n - uses: actions/checkout@v6\n\n # for wasm-bindgen-cli, always use stable rust\n - name: Setup toolchain\n uses: dtolnay/rust-toolchain@master\n with:\n toolchain: stable\n\n - name: Install wasm-bindgen-cli\n shell: bash\n run: ./ci/install-wasm-bindgen-cli.sh\n\n - name: Setup toolchain\n uses: dtolnay/rust-toolchain@master\n with:\n toolchain: nightly\n targets: wasm32-unknown-unknown\n\n - uses: Swatinem/rust-cache@v2\n with:\n save-if: ${{ github.ref == 'refs/heads/master' }}\n\n - uses: browser-actions/setup-geckodriver@latest\n with:\n token: ${{ secrets.GITHUB_TOKEN }}\n\n - uses: nanasess/setup-chromedriver@v2\n\n - name: Run website code snippet tests\n run: cargo test -p website-test --target wasm32-unknown-unknown\n" }, { "path": ".gitignore", "content": "target/\ndist/\n\n# backup files generated by rustfmt\n**/*.rs.bk\n\n# editor config files and directories\n*.iml\n/.idea/\n/.vscode/\n" }, { "path": "CHANGELOG.md", "content": "# Changelog\n\n## ✨ yew **0.23.0** *(2026-03-10)*\n\nbumping from 0.22 should require no code changes for most users.\n\n### 🚨 Breaking changes\n\n- Performance: use_reducer now skips re-rendering for the same Rc. [[@Pascal Sommer](https://github.com/Pascal-So), [#3945](https://github.com/yewstack/yew/pull/3945)]\n NOTE: Whether this is breaking is arguable. It merely breaks the promise that a dispatch will always cause a re-render. For code that wishes to force re-render, [use_force_update](https://docs.rs/yew/latest/yew/functional/fn.use_force_update.html) helps. Please refer to [the migration guide](https://yew.rs/docs/next/migration-guides/yew/from-0_22_0-to-0_23_0) for details.\n\n### ⚡️ Features\n\n- `&str` and `String` can now be used for props of type `Option`. [[@Cashew](https://github.com/Casheeew), [#4020](https://github.com/yewstack/yew/pull/4020)]\n- Added a `scheduler::flush` function to reliably finish rendering. Useful in testing as a replacement for timeouts. [[@Siyuan Yan](https://github.com/Madoshakalaka), [#4044](https://github.com/yewstack/yew/pull/4044)]\n\n### 🛠 Fixes\n\n- No more broken child re-renders while setting parents' states. [[@Siyuan Yan](https://github.com/Madoshakalaka), [#4060](https://github.com/yewstack/yew/pull/4060)]\n- Ergonomics: Bare `None`s are now allowed for `Option` props in the `html!` macro. [[@Siyuan Yan](https://github.com/Madoshakalaka), [#4021](https://github.com/yewstack/yew/pull/4021)]\n\n### ⚙️ Improvements\n\n- Yew's scheduler now yields to the main thread from time to time. This fix will make the web page more responsive and reduce warnings about long tasks in the console. [[@Siyuan Yan](https://github.com/Madoshakalaka), [#4033](https://github.com/yewstack/yew/pull/4033)]\n\n## ✨ yew-router **0.20.0** *(2026-03-10)*\n\nYew pinned to 0.23 now.\n\n### 🛠 Fixes\n\n- '/' is no longer wrongly encoded in wildcard route segments. [[@Siyuan Yan](https://github.com/Madoshakalaka), [#4056](https://github.com/yewstack/yew/pull/4056)]\n- Fixed a url corruption issue causing redirection to `/basename//basename` resulting in a 404. [[@Siyuan Yan](https://github.com/Madoshakalaka), [#4030](https://github.com/yewstack/yew/pull/4030)]\n\n## ✨ yew-agent **0.5.0** *(2026-03-10)*\n\nNo changes. \n\nYew pinned to 0.23 now.\n\n## ✨ yew **0.22.1** *(2026-02-28)*\n\n### 🛠 Fixes\n\n- Domslot hydration panic caused by suspension [[@Siyuan Yan](https://github.com/Madoshakalaka), [#4003](https://github.com/yewstack/yew/pull/4003)]\n- Some `Option` and `&T` types can be used as children again. e.g. `Option` [[@Siyuan Yan](https://github.com/Madoshakalaka), [#4005](https://github.com/yewstack/yew/pull/4005)]\n- Custom hooks now compiles in edition 2024. [[@Siyuan Yan](https://github.com/Madoshakalaka), [#3992](https://github.com/yewstack/yew/pull/3992)]\n- No more stale states in callbacks when multiple events fire rapidly. [[@Siyuan Yan](https://github.com/Madoshakalaka), [#3988](https://github.com/yewstack/yew/pull/3988)]\n- Fixed invisible svg issue on Chrome when included with `from_html_unchecked` [[@Jason Heard](https://github.com/101100), [#3970](https://github.com/yewstack/yew/pull/3970)]\n- Fixed documentation typo in introduction.mdx. [[@devfbe](https://github.com/devfbe), [#3417](https://github.com/yewstack/yew/pull/3417)]\n\n### ⚙️ Improvements\n- Improved SSR example with meta rendering. [[@Siyuan Yan](https://github.com/Madoshakalaka), [#4011](https://github.com/yewstack/yew/pull/4011)]\n- Replaced once_cell with std equivalents (LazyLock, OnceLock). [[@Siyuan Yan](https://github.com/Madoshakalaka), [#4010](https://github.com/yewstack/yew/pull/4010)]\n- Updated rust dependencies.\n\n## ✨ yew **0.22.0** *(2025-12-08)*\n\n\n### 🚨 Breaking changes\n\n - **MSRV raised to 1.84.0.** [[@Siyuan Yan](https://github.com/Madoshakalaka), [#3900](https://github.com/yewstack/yew/pull/3900)]\n - Allow setting JsValue as properties. [[@Elina](https://github.com/ranile), [#3458](https://github.com/yewstack/yew/pull/3458)]\n - Remove deprecated `class=(...)` syntax. [[@Tim Kurdov](https://github.com/its-the-shrimp), [#3497](https://github.com/yewstack/yew/pull/3497)]\n - Remove ToHtml trait. [[@Elina](https://github.com/ranile), [#3453](https://github.com/yewstack/yew/pull/3453)]\n - Make `\");\n }\n VTagInner::Other { tag, children } => {\n let lowercase_tag = tag.to_ascii_lowercase();\n if !VOID_ELEMENTS.contains(&lowercase_tag.as_ref()) {\n children\n .render_into_stream(w, parent_scope, hydratable, tag.into())\n .await;\n\n let _ = w.write_str(\"\");\n } else {\n // We don't write children of void elements nor closing tags.\n debug_assert!(\n match children {\n VNode::VList(m) => m.is_empty(),\n _ => false,\n },\n \"{tag} cannot have any children!\"\n );\n }\n }\n }\n }\n }\n}\n\n#[cfg(any(not(target_arch = \"wasm32\"), target_os = \"wasi\"))]\n#[cfg(feature = \"ssr\")]\n#[cfg(test)]\nmod ssr_tests {\n use tokio::test;\n\n use crate::prelude::*;\n use crate::LocalServerRenderer as ServerRenderer;\n\n #[cfg_attr(not(target_os = \"wasi\"), test)]\n #[cfg_attr(target_os = \"wasi\", test(flavor = \"current_thread\"))]\n async fn test_simple_tag() {\n #[component]\n fn Comp() -> Html {\n html! {
}\n }\n\n let s = ServerRenderer::::new()\n .hydratable(false)\n .render()\n .await;\n\n assert_eq!(s, \"
\");\n }\n\n #[cfg_attr(not(target_os = \"wasi\"), test)]\n #[cfg_attr(target_os = \"wasi\", test(flavor = \"current_thread\"))]\n async fn test_simple_tag_with_attr() {\n #[component]\n fn Comp() -> Html {\n html! {
}\n }\n\n let s = ServerRenderer::::new()\n .hydratable(false)\n .render()\n .await;\n\n assert_eq!(s, r#\"
\"#);\n }\n\n #[cfg_attr(not(target_os = \"wasi\"), test)]\n #[cfg_attr(target_os = \"wasi\", test(flavor = \"current_thread\"))]\n async fn test_simple_tag_with_content() {\n #[component]\n fn Comp() -> Html {\n html! {
{\"Hello!\"}
}\n }\n\n let s = ServerRenderer::::new()\n .hydratable(false)\n .render()\n .await;\n\n assert_eq!(s, r#\"
Hello!
\"#);\n }\n\n #[cfg_attr(not(target_os = \"wasi\"), test)]\n #[cfg_attr(target_os = \"wasi\", test(flavor = \"current_thread\"))]\n async fn test_simple_tag_with_nested_tag_and_input() {\n #[component]\n fn Comp() -> Html {\n html! {
{\"Hello!\"}
}\n }\n\n let s = ServerRenderer::::new()\n .hydratable(false)\n .render()\n .await;\n\n assert_eq!(s, r#\"
Hello!
\"#);\n }\n\n #[cfg_attr(not(target_os = \"wasi\"), test)]\n #[cfg_attr(target_os = \"wasi\", test(flavor = \"current_thread\"))]\n async fn test_textarea() {\n #[component]\n fn Comp() -> Html {\n html! { \"#);\n }\n\n #[cfg_attr(not(target_os = \"wasi\"), test)]\n #[cfg_attr(target_os = \"wasi\", test(flavor = \"current_thread\"))]\n async fn test_textarea_w_defaultvalue() {\n #[component]\n fn Comp() -> Html {\n html! { \"#);\n }\n\n #[cfg_attr(not(target_os = \"wasi\"), test)]\n #[cfg_attr(target_os = \"wasi\", test(flavor = \"current_thread\"))]\n async fn test_value_precedence_over_defaultvalue() {\n #[component]\n fn Comp() -> Html {\n html! { \"#);\n }\n\n #[cfg_attr(not(target_os = \"wasi\"), test)]\n #[cfg_attr(target_os = \"wasi\", test(flavor = \"current_thread\"))]\n async fn test_escaping_in_style_tag() {\n #[component]\n fn Comp() -> Html {\n html! { }\n }\n\n let s = ServerRenderer::::new()\n .hydratable(false)\n .render()\n .await;\n\n assert_eq!(s, r#\"\"#);\n }\n\n #[cfg_attr(not(target_os = \"wasi\"), test)]\n #[cfg_attr(target_os = \"wasi\", test(flavor = \"current_thread\"))]\n async fn test_escaping_in_script_tag() {\n #[component]\n fn Comp() -> Html {\n html! { }\n }\n\n let s = ServerRenderer::::new()\n .hydratable(false)\n .render()\n .await;\n\n assert_eq!(s, r#\"\"#);\n }\n\n #[cfg_attr(not(target_os = \"wasi\"), test)]\n #[cfg_attr(target_os = \"wasi\", test(flavor = \"current_thread\"))]\n async fn test_multiple_vtext_in_style_tag() {\n #[component]\n fn Comp() -> Html {\n let one = \"html { background: black } \";\n let two = \"body > a { color: white } \";\n html! {\n \n }\n }\n\n let s = ServerRenderer::::new()\n .hydratable(false)\n .render()\n .await;\n\n assert_eq!(\n s,\n r#\"\"#\n );\n }\n}\n" }, { "path": "packages/yew/src/virtual_dom/vtext.rs", "content": "//! This module contains the implementation of a virtual text node `VText`.\n\nuse std::cmp::PartialEq;\n\nuse super::AttrValue;\nuse crate::html::ImplicitClone;\n\n/// A type for a virtual\n/// [`TextNode`](https://developer.mozilla.org/en-US/docs/Web/API/Document/createTextNode)\n/// representation.\n#[derive(Clone, ImplicitClone)]\npub struct VText {\n /// Contains a text of the node.\n pub text: AttrValue,\n}\n\nimpl VText {\n /// Creates new virtual text node with a content.\n pub fn new(text: impl Into) -> Self {\n VText { text: text.into() }\n }\n}\n\nimpl std::fmt::Debug for VText {\n fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {\n write!(f, \"VText {{ text: \\\"{}\\\" }}\", self.text)\n }\n}\n\nimpl PartialEq for VText {\n fn eq(&self, other: &VText) -> bool {\n self.text == other.text\n }\n}\n\nimpl From for VText {\n fn from(value: T) -> Self {\n VText::new(value.to_string())\n }\n}\n\n#[cfg(feature = \"ssr\")]\nmod feat_ssr {\n\n use std::fmt::Write;\n\n use super::*;\n use crate::feat_ssr::VTagKind;\n use crate::html::AnyScope;\n use crate::platform::fmt::BufWriter;\n\n impl VText {\n pub(crate) async fn render_into_stream(\n &self,\n w: &mut BufWriter,\n _parent_scope: &AnyScope,\n _hydratable: bool,\n parent_vtag_kind: VTagKind,\n ) {\n _ = w.write_str(&match parent_vtag_kind {\n VTagKind::Style => html_escape::encode_style(&self.text),\n VTagKind::Script => html_escape::encode_script(&self.text),\n VTagKind::Other => html_escape::encode_text(&self.text),\n })\n }\n }\n}\n\n#[cfg(any(not(target_arch = \"wasm32\"), target_os = \"wasi\"))]\n#[cfg(feature = \"ssr\")]\n#[cfg(test)]\nmod ssr_tests {\n use tokio::test;\n\n use crate::prelude::*;\n use crate::LocalServerRenderer as ServerRenderer;\n\n #[cfg_attr(not(target_os = \"wasi\"), test)]\n #[cfg_attr(target_os = \"wasi\", test(flavor = \"current_thread\"))]\n async fn test_simple_str() {\n #[component]\n fn Comp() -> Html {\n html! { \"abc\" }\n }\n\n let s = ServerRenderer::::new()\n .hydratable(false)\n .render()\n .await;\n\n assert_eq!(s, r#\"abc\"#);\n }\n}\n" }, { "path": "packages/yew/tests/common/mod.rs", "content": "#![allow(dead_code)]\n\npub fn obtain_result() -> String {\n gloo::utils::document()\n .get_element_by_id(\"result\")\n .expect(\"No result found. Most likely, the application crashed and burned\")\n .inner_html()\n}\n\npub fn obtain_result_by_id(id: &str) -> String {\n gloo::utils::document()\n .get_element_by_id(id)\n .expect(\"No result found. Most likely, the application crashed and burned\")\n .inner_html()\n}\n\npub fn output_element() -> web_sys::Element {\n gloo::utils::document().get_element_by_id(\"output\").unwrap()\n}\n" }, { "path": "packages/yew/tests/hydration.rs", "content": "#![cfg(feature = \"hydration\")]\n#![cfg(all(target_arch = \"wasm32\", not(target_os = \"wasi\")))]\n\nuse std::ops::Range;\nuse std::rc::Rc;\nuse std::time::Duration;\n\nmod common;\n\nuse common::{obtain_result, obtain_result_by_id};\nuse wasm_bindgen::JsCast;\nuse wasm_bindgen_futures::spawn_local;\nuse wasm_bindgen_test::*;\nuse web_sys::{HtmlElement, HtmlTextAreaElement};\nuse yew::platform::time::sleep;\nuse yew::prelude::*;\nuse yew::suspense::{use_future, Suspension, SuspensionResult};\nuse yew::virtual_dom::VNode;\nuse yew::{component, scheduler, Renderer, ServerRenderer};\n\nwasm_bindgen_test::wasm_bindgen_test_configure!(run_in_browser);\n\n// If any of the assertions fail due to a modification to hydration logic, cargo will suggest the\n// expected result and you can copy it into the test to fix it.\n\n#[wasm_bindgen_test]\nasync fn hydration_works() {\n #[component]\n fn Comp() -> Html {\n let ctr = use_state_eq(|| 0);\n\n let onclick = {\n let ctr = ctr.clone();\n\n Callback::from(move |_| {\n ctr.set(*ctr + 1);\n })\n };\n\n html! {\n
\n {\"Counter: \"}{*ctr}\n \n
\n }\n }\n\n #[component]\n fn App() -> Html {\n html! {\n
\n \n
\n }\n }\n\n let s = ServerRenderer::::new().render().await;\n\n gloo::utils::document()\n .query_selector(\"#output\")\n .unwrap()\n .unwrap()\n .set_inner_html(&s);\n\n scheduler::flush().await;\n\n Renderer::::with_root(gloo::utils::document().get_element_by_id(\"output\").unwrap())\n .hydrate();\n\n scheduler::flush().await;\n\n let result = obtain_result_by_id(\"output\");\n\n // no placeholders, hydration is successful.\n assert_eq!(\n result,\n r#\"
Counter: 0
\"#\n );\n\n gloo::utils::document()\n .query_selector(\".increase\")\n .unwrap()\n .unwrap()\n .dyn_into::()\n .unwrap()\n .click();\n\n scheduler::flush().await;\n\n let result = obtain_result_by_id(\"output\");\n\n assert_eq!(\n result,\n r#\"
Counter: 1
\"#\n );\n}\n\n#[wasm_bindgen_test]\nasync fn hydration_with_raw() {\n #[component(Content)]\n fn content() -> Html {\n let vnode = VNode::from_html_unchecked(\"

Hello World

\".into());\n\n html! {\n
\n {vnode}\n
\n }\n }\n\n #[component(App)]\n fn app() -> Html {\n html! {\n
\n \n
\n }\n }\n\n let s = ServerRenderer::::new().render().await;\n\n gloo::utils::document()\n .query_selector(\"#output\")\n .unwrap()\n .unwrap()\n .set_inner_html(&s);\n\n sleep(Duration::from_millis(10)).await;\n\n Renderer::::with_root(gloo::utils::document().get_element_by_id(\"output\").unwrap())\n .hydrate();\n\n let result = obtain_result();\n\n // still hydrating, during hydration, the server rendered result is shown.\n assert_eq!(\n result.as_str(),\n r#\"

Hello World

\"#\n );\n\n sleep(Duration::from_millis(50)).await;\n\n let result = obtain_result();\n\n // hydrated.\n assert_eq!(\n result.as_str(),\n r#\"

Hello World

\"#\n );\n}\n\n#[wasm_bindgen_test]\nasync fn hydration_with_suspense() {\n #[derive(PartialEq)]\n pub struct SleepState {\n s: Suspension,\n }\n\n impl SleepState {\n fn new() -> Self {\n let (s, handle) = Suspension::new();\n\n spawn_local(async move {\n sleep(Duration::from_millis(50)).await;\n\n handle.resume();\n });\n\n Self { s }\n }\n }\n\n impl Reducible for SleepState {\n type Action = ();\n\n fn reduce(self: Rc, _action: Self::Action) -> Rc {\n Self::new().into()\n }\n }\n\n #[hook]\n pub fn use_sleep() -> SuspensionResult> {\n let sleep_state = use_reducer(SleepState::new);\n\n if sleep_state.s.resumed() {\n Ok(Rc::new(move || sleep_state.dispatch(())))\n } else {\n Err(sleep_state.s.clone())\n }\n }\n\n #[component(Content)]\n fn content() -> HtmlResult {\n let resleep = use_sleep()?;\n\n let value = use_state(|| 0);\n\n let on_increment = {\n let value = value.clone();\n\n Callback::from(move |_: MouseEvent| {\n value.set(*value + 1);\n })\n };\n\n let on_take_a_break = Callback::from(move |_: MouseEvent| (resleep.clone())());\n\n Ok(html! {\n
\n
{*value}
\n \n
\n \n
\n
\n })\n }\n\n #[component(App)]\n fn app() -> Html {\n let fallback = html! {
{\"wait...\"}
};\n\n html! {\n
\n \n \n \n
\n }\n }\n\n let s = ServerRenderer::::new().render().await;\n\n gloo::utils::document()\n .query_selector(\"#output\")\n .unwrap()\n .unwrap()\n .set_inner_html(&s);\n\n scheduler::flush().await;\n\n Renderer::::with_root(gloo::utils::document().get_element_by_id(\"output\").unwrap())\n .hydrate();\n\n sleep(Duration::from_millis(10)).await;\n\n let result = obtain_result();\n\n // still hydrating, during hydration, the server rendered result is shown.\n assert_eq!(\n result.as_str(),\n r#\"
0
\"#\n );\n\n sleep(Duration::from_millis(50)).await;\n\n let result = obtain_result();\n\n // hydrated.\n assert_eq!(\n result.as_str(),\n r#\"
0
\"#\n );\n\n gloo::utils::document()\n .query_selector(\".increase\")\n .unwrap()\n .unwrap()\n .dyn_into::()\n .unwrap()\n .click();\n\n sleep(Duration::from_millis(50)).await;\n\n let result = obtain_result();\n assert_eq!(\n result.as_str(),\n r#\"
1
\"#\n );\n\n gloo::utils::document()\n .query_selector(\".take-a-break\")\n .unwrap()\n .unwrap()\n .dyn_into::()\n .unwrap()\n .click();\n\n sleep(Duration::from_millis(10)).await;\n let result = obtain_result();\n assert_eq!(result.as_str(), \"
wait...
\");\n\n sleep(Duration::from_millis(50)).await;\n\n let result = obtain_result();\n assert_eq!(\n result.as_str(),\n r#\"
1
\"#\n );\n}\n\n#[wasm_bindgen_test]\nasync fn hydration_with_suspense_not_suspended_at_start() {\n #[derive(PartialEq)]\n pub struct SleepState {\n s: Option,\n }\n\n impl SleepState {\n fn new() -> Self {\n Self { s: None }\n }\n }\n\n impl Reducible for SleepState {\n type Action = ();\n\n fn reduce(self: Rc, _action: Self::Action) -> Rc {\n let (s, handle) = Suspension::new();\n\n spawn_local(async move {\n sleep(Duration::from_millis(50)).await;\n\n handle.resume();\n });\n\n Self { s: Some(s) }.into()\n }\n }\n\n #[hook]\n pub fn use_sleep() -> SuspensionResult> {\n let sleep_state = use_reducer(SleepState::new);\n\n let s = match sleep_state.s.clone() {\n Some(m) => m,\n None => return Ok(Rc::new(move || sleep_state.dispatch(()))),\n };\n\n if s.resumed() {\n Ok(Rc::new(move || sleep_state.dispatch(())))\n } else {\n Err(s)\n }\n }\n\n #[component(Content)]\n fn content() -> HtmlResult {\n let resleep = use_sleep()?;\n\n let value = use_state(|| \"I am writing a long story...\".to_string());\n\n let on_text_input = {\n let value = value.clone();\n\n Callback::from(move |e: InputEvent| {\n let input: HtmlTextAreaElement = e.target_unchecked_into();\n\n value.set(input.value());\n })\n };\n\n let on_take_a_break = Callback::from(move |_| (resleep.clone())());\n\n Ok(html! {\n
\n
\"#\n );\n gloo::utils::document()\n .query_selector(\".take-a-break\")\n .unwrap()\n .unwrap()\n .dyn_into::()\n .unwrap()\n .click();\n\n sleep(Duration::from_millis(10)).await;\n\n let result = obtain_result();\n assert_eq!(result.as_str(), \"
wait...
\");\n\n sleep(Duration::from_millis(50)).await;\n\n let result = obtain_result();\n assert_eq!(\n result.as_str(),\n r#\"
\"#\n );\n}\n\n#[wasm_bindgen_test]\nasync fn hydration_nested_suspense_works() {\n #[derive(PartialEq)]\n pub struct SleepState {\n s: Suspension,\n }\n\n impl SleepState {\n fn new() -> Self {\n let (s, handle) = Suspension::new();\n\n spawn_local(async move {\n sleep(Duration::from_millis(50)).await;\n\n handle.resume();\n });\n\n Self { s }\n }\n }\n\n impl Reducible for SleepState {\n type Action = ();\n\n fn reduce(self: Rc, _action: Self::Action) -> Rc {\n Self::new().into()\n }\n }\n\n #[hook]\n pub fn use_sleep() -> SuspensionResult> {\n let sleep_state = use_reducer(SleepState::new);\n\n if sleep_state.s.resumed() {\n Ok(Rc::new(move || sleep_state.dispatch(())))\n } else {\n Err(sleep_state.s.clone())\n }\n }\n\n #[component(InnerContent)]\n fn inner_content() -> HtmlResult {\n let resleep = use_sleep()?;\n\n let on_take_a_break = Callback::from(move |_: MouseEvent| (resleep.clone())());\n\n Ok(html! {\n
\n
\n \n
\n
\n })\n }\n\n #[component(Content)]\n fn content() -> HtmlResult {\n let resleep = use_sleep()?;\n\n let fallback = html! {
{\"wait...(inner)\"}
};\n\n let on_take_a_break = Callback::from(move |_: MouseEvent| (resleep.clone())());\n\n Ok(html! {\n
\n
\n \n
\n \n \n \n
\n })\n }\n\n #[component(App)]\n fn app() -> Html {\n let fallback = html! {
{\"wait...(outer)\"}
};\n\n html! {\n
\n \n \n \n
\n }\n }\n\n let s = ServerRenderer::::new().render().await;\n\n gloo::utils::document()\n .query_selector(\"#output\")\n .unwrap()\n .unwrap()\n .set_inner_html(&s);\n\n scheduler::flush().await;\n\n Renderer::::with_root(gloo::utils::document().get_element_by_id(\"output\").unwrap())\n .hydrate();\n\n // outer suspense is hydrating...\n sleep(Duration::from_millis(10)).await;\n let result = obtain_result();\n assert_eq!(\n result.as_str(),\n r#\"
\"#\n );\n\n sleep(Duration::from_millis(50)).await;\n\n // inner suspense is hydrating...\n let result = obtain_result();\n assert_eq!(\n result.as_str(),\n r#\"
\"#\n );\n\n sleep(Duration::from_millis(50)).await;\n\n // hydrated.\n let result = obtain_result();\n assert_eq!(\n result.as_str(),\n r#\"
\"#\n );\n\n gloo::utils::document()\n .query_selector(\".take-a-break\")\n .unwrap()\n .unwrap()\n .dyn_into::()\n .unwrap()\n .click();\n\n sleep(Duration::from_millis(10)).await;\n\n let result = obtain_result();\n assert_eq!(result.as_str(), \"
wait...(outer)
\");\n\n sleep(Duration::from_millis(50)).await;\n\n let result = obtain_result();\n assert_eq!(\n result.as_str(),\n r#\"
\"#\n );\n\n gloo::utils::document()\n .query_selector(\".take-a-break2\")\n .unwrap()\n .unwrap()\n .dyn_into::()\n .unwrap()\n .click();\n\n sleep(Duration::from_millis(10)).await;\n let result = obtain_result();\n assert_eq!(\n result.as_str(),\n r#\"
wait...(inner)
\"#\n );\n\n sleep(Duration::from_millis(50)).await;\n\n let result = obtain_result();\n assert_eq!(\n result.as_str(),\n r#\"
\"#\n );\n}\n\n#[wasm_bindgen_test]\nasync fn hydration_node_ref_works() {\n #[component(App)]\n pub fn app() -> Html {\n let size = use_state(|| 4);\n\n let callback = {\n let size = size.clone();\n Callback::from(move |_| {\n size.set(10);\n })\n };\n\n html! {\n
\n \n
\n }\n }\n\n #[derive(Properties, PartialEq)]\n struct ListProps {\n size: u32,\n }\n\n #[component(Test1)]\n fn test1() -> Html {\n html! {\n {\"test\"}\n }\n }\n #[component(Test2)]\n fn test2() -> Html {\n html! {\n \n }\n }\n\n #[component(List)]\n fn list(props: &ListProps) -> Html {\n let elems = 0..props.size;\n\n html! {\n <>\n { for elems.map(|_|\n html! {\n \n }\n )}\n \n }\n }\n\n let s = ServerRenderer::::new().render().await;\n\n gloo::utils::document()\n .query_selector(\"#output\")\n .unwrap()\n .unwrap()\n .set_inner_html(&s);\n\n scheduler::flush().await;\n\n Renderer::::with_root(gloo::utils::document().get_element_by_id(\"output\").unwrap())\n .hydrate();\n\n scheduler::flush().await;\n\n let result = obtain_result_by_id(\"output\");\n assert_eq!(\n result.as_str(),\n r#\"
testtesttesttest
\"#\n );\n\n gloo::utils::document()\n .query_selector(\"span\")\n .unwrap()\n .unwrap()\n .dyn_into::()\n .unwrap()\n .click();\n\n scheduler::flush().await;\n\n let result = obtain_result_by_id(\"output\");\n assert_eq!(\n result.as_str(),\n r#\"
testtesttesttesttesttesttesttesttesttest
\"#\n );\n}\n\n#[wasm_bindgen_test]\nasync fn hydration_list_order_works() {\n #[component(App)]\n pub fn app() -> Html {\n let elems = 0..10;\n\n html! {\n <>\n { for elems.map(|number|\n html! {\n \n }\n )}\n \n }\n }\n\n #[derive(Properties, PartialEq)]\n struct NumberProps {\n number: u32,\n }\n\n #[component(Number)]\n fn number(props: &NumberProps) -> Html {\n html! {\n
{props.number.to_string()}
\n }\n }\n #[component(SuspendedNumber)]\n fn suspended_number(props: &NumberProps) -> HtmlResult {\n use_suspend()?;\n Ok(html! {\n
{props.number.to_string()}
\n })\n }\n #[component(ToSuspendOrNot)]\n fn suspend_or_not(props: &NumberProps) -> Html {\n let number = props.number;\n html! {\n \n if number % 3 == 0 {\n \n } else {\n \n }\n \n }\n }\n\n #[hook]\n pub fn use_suspend() -> SuspensionResult<()> {\n use_future(|| async {})?;\n Ok(())\n }\n\n let s = ServerRenderer::::new().render().await;\n\n gloo::utils::document()\n .query_selector(\"#output\")\n .unwrap()\n .unwrap()\n .set_inner_html(&s);\n\n scheduler::flush().await;\n\n Renderer::::with_root(gloo::utils::document().get_element_by_id(\"output\").unwrap())\n .hydrate();\n\n // Wait until all suspended components becomes revealed.\n scheduler::flush().await;\n\n let result = obtain_result_by_id(\"output\");\n assert_eq!(\n result.as_str(),\n // Until all components become revealed, there will be component markers.\n // As long as there's no component markers all components have become unsuspended.\n r#\"
0
1
2
3
4
5
6
7
8
9
\"#\n );\n}\n\n#[wasm_bindgen_test]\nasync fn hydration_suspense_no_flickering() {\n #[component(App)]\n pub fn app() -> Html {\n let fallback = html! {

{\"Loading...\"}

};\n html! {\n \n \n \n }\n }\n\n #[derive(Properties, PartialEq, Clone)]\n struct NumberProps {\n number: u32,\n }\n\n #[component(SuspendedNumber)]\n fn suspended_number(props: &NumberProps) -> HtmlResult {\n use_suspend()?;\n\n Ok(html! {\n \n })\n }\n #[component(Number)]\n fn number(props: &NumberProps) -> Html {\n html! {\n
\n {props.number.to_string()}\n
\n }\n }\n\n #[component(Suspended)]\n fn suspended() -> HtmlResult {\n use_suspend()?;\n\n Ok(html! {\n { for (0..10).map(|number|\n html! {\n \n }\n )}\n })\n }\n\n #[hook]\n pub fn use_suspend() -> SuspensionResult<()> {\n use_future(|| async {\n yew::platform::time::sleep(std::time::Duration::from_millis(200)).await;\n })?;\n Ok(())\n }\n\n let s = ServerRenderer::::new().render().await;\n\n gloo::utils::document()\n .query_selector(\"#output\")\n .unwrap()\n .unwrap()\n .set_inner_html(&s);\n\n scheduler::flush().await;\n\n Renderer::::with_root(gloo::utils::document().get_element_by_id(\"output\").unwrap())\n .hydrate();\n\n // Wait until all suspended components becomes revealed.\n scheduler::flush().await;\n\n let result = obtain_result_by_id(\"output\");\n assert_eq!(\n result.as_str(),\n // outer still suspended.\n r#\"
0
1
2
3
4
5
6
7
8
9
\"#\n );\n sleep(Duration::from_millis(103)).await;\n\n let result = obtain_result_by_id(\"output\");\n assert_eq!(\n result.as_str(),\n r#\"
0
1
2
3
4
5
6
7
8
9
\"#\n );\n sleep(Duration::from_millis(103)).await;\n\n let result = obtain_result_by_id(\"output\");\n assert_eq!(\n result.as_str(),\n r#\"
0
1
2
3
4
5
6
7
8
9
\"#\n );\n sleep(Duration::from_millis(103)).await;\n\n let result = obtain_result_by_id(\"output\");\n assert_eq!(\n result.as_str(),\n // outer revealed, inner still suspended, outer remains.\n r#\"
0
1
2
3
4
5
6
7
8
9
\"#\n );\n\n sleep(Duration::from_millis(103)).await;\n\n let result = obtain_result_by_id(\"output\");\n assert_eq!(\n result.as_str(),\n // inner revealed.\n r#\"
0
1
2
3
4
5
6
7
8
9
\"#\n );\n}\n\n#[wasm_bindgen_test]\nasync fn hydration_order_issue_nested_suspense() {\n #[component(App)]\n pub fn app() -> Html {\n let elems = (0..10).map(|number: u32| {\n html! {\n \n }\n });\n\n html! {\n \n { for elems }\n \n }\n }\n\n #[derive(Properties, PartialEq)]\n struct NumberProps {\n number: u32,\n }\n\n #[component(Number)]\n fn number(props: &NumberProps) -> Html {\n html! {\n
{props.number.to_string()}
\n }\n }\n\n #[component(SuspendedNumber)]\n fn suspended_number(props: &NumberProps) -> HtmlResult {\n use_suspend()?;\n Ok(html! {\n
{props.number.to_string()}
\n })\n }\n\n #[component(ToSuspendOrNot)]\n fn suspend_or_not(props: &NumberProps) -> HtmlResult {\n let number = props.number;\n Ok(html! {\n if number % 3 == 0 {\n \n \n \n } else {\n \n }\n })\n }\n\n #[hook]\n pub fn use_suspend() -> SuspensionResult<()> {\n use_future(|| async {})?;\n\n Ok(())\n }\n\n let s = ServerRenderer::::new().render().await;\n\n gloo::utils::document()\n .query_selector(\"#output\")\n .unwrap()\n .unwrap()\n .set_inner_html(&s);\n\n scheduler::flush().await;\n\n Renderer::::with_root(gloo::utils::document().get_element_by_id(\"output\").unwrap())\n .hydrate();\n\n // Wait until all suspended components becomes revealed.\n scheduler::flush().await;\n\n let result = obtain_result_by_id(\"output\");\n assert_eq!(\n result.as_str(),\n // Until all components become revealed, there will be component markers.\n // As long as there's no component markers all components have become unsuspended.\n r#\"
0
1
2
3
4
5
6
7
8
9
\"#\n );\n}\n\n#[wasm_bindgen_test]\nasync fn hydration_props_blocked_until_hydrated() {\n #[component(App)]\n pub fn app() -> Html {\n let range = use_state(|| 0u32..2);\n {\n let range = range.clone();\n use_effect_with((), move |_| {\n range.set(0..3);\n || ()\n });\n }\n\n html! {\n \n \n \n }\n }\n\n #[derive(Properties, PartialEq)]\n struct ToSuspendProps {\n range: Range,\n }\n\n #[component(ToSuspend)]\n fn to_suspend(ToSuspendProps { range }: &ToSuspendProps) -> HtmlResult {\n use_suspend(Duration::from_millis(100))?;\n Ok(html! {\n { for range.clone().map(|i|\n html!{
{i}
}\n )}\n })\n }\n\n #[hook]\n pub fn use_suspend(_dur: Duration) -> SuspensionResult<()> {\n yew::suspense::use_future(|| async move {\n sleep(_dur).await;\n })?;\n\n Ok(())\n }\n\n let s = ServerRenderer::::new().render().await;\n\n let output_element = gloo::utils::document()\n .query_selector(\"#output\")\n .unwrap()\n .unwrap();\n\n output_element.set_inner_html(&s);\n\n Renderer::::with_root(output_element).hydrate();\n sleep(Duration::from_millis(150)).await;\n\n let result = obtain_result_by_id(\"output\");\n assert_eq!(result.as_str(), r#\"
0
1
2
\"#);\n}\n\n#[wasm_bindgen_test]\nasync fn hydrate_empty() {\n #[component]\n fn Updating() -> Html {\n let trigger = use_state(|| false);\n {\n let trigger = trigger.clone();\n use_effect_with((), move |_| {\n trigger.set(true);\n || {}\n });\n }\n if *trigger {\n html! {
{\"after\"}
}\n } else {\n html! {
{\"before\"}
}\n }\n }\n #[component]\n fn Empty() -> Html {\n html! { <> }\n }\n #[component]\n fn App() -> Html {\n html! {\n <>\n \n \n \n \n }\n }\n let s = ServerRenderer::::new().render().await;\n\n let output_element = gloo::utils::document()\n .query_selector(\"#output\")\n .unwrap()\n .unwrap();\n\n output_element.set_inner_html(&s);\n\n Renderer::::with_root(output_element).hydrate();\n sleep(Duration::from_millis(50)).await;\n\n let result = obtain_result_by_id(\"output\");\n assert_eq!(result.as_str(), r#\"
after
after
\"#);\n}\n\n#[wasm_bindgen_test]\nasync fn hydrate_flicker() {\n // This components renders the same on the server and client during the first render,\n // but then immediately changes the order of keyed elements in the next render.\n // This should not lead to any hydration failures\n #[derive(Properties, PartialEq)]\n struct InnerCompProps {\n text: String,\n }\n #[component]\n fn InnerComp(InnerCompProps { text }: &InnerCompProps) -> Html {\n html! {

{text.clone()}

}\n }\n #[component]\n fn Flickering() -> Html {\n let trigger = use_state(|| false);\n let is_first = !*trigger;\n if is_first {\n trigger.set(true);\n html! {\n <>\n \n \n \n }\n } else {\n html! {\n <>\n \n \n \n }\n }\n }\n let s = ServerRenderer::::new().render().await;\n let output_element = gloo::utils::document()\n .query_selector(\"#output\")\n .unwrap()\n .unwrap();\n\n output_element.set_inner_html(&s);\n\n Renderer::::with_root(output_element).hydrate();\n sleep(Duration::from_millis(50)).await;\n\n let result = obtain_result_by_id(\"output\");\n assert_eq!(result.as_str(), r#\"

2

1

\"#);\n}\n\n#[wasm_bindgen_test]\nasync fn hydration_with_camelcase_svg_elements() {\n #[function_component]\n fn SvgWithCamelCase() -> Html {\n html! {\n \n \n <@{\"linearGradient\"} id=\"gradient1\">\n \n \n \n <@{\"radialGradient\"} id=\"gradient2\">\n \n \n \n <@{\"clipPath\"} id=\"clip1\">\n \n \n \n \n \n <@{\"feDropShadow\"} dx=\"2\" dy=\"2\" stdDeviation=\"2\" />\n \n }\n }\n\n #[function_component]\n fn App() -> Html {\n let counter = use_state(|| 0);\n let onclick = {\n let counter = counter.clone();\n Callback::from(move |_| counter.set(*counter + 1))\n };\n\n html! {\n
\n
{\"Count: \"}{*counter}
\n \n \n
\n }\n }\n\n // Server render\n let s = ServerRenderer::::new().render().await;\n\n // Set HTML\n gloo::utils::document()\n .query_selector(\"#output\")\n .unwrap()\n .unwrap()\n .set_inner_html(&s);\n\n scheduler::flush().await;\n\n // Hydrate - this should not panic\n Renderer::::with_root(gloo::utils::document().get_element_by_id(\"output\").unwrap())\n .hydrate();\n\n sleep(Duration::from_millis(10)).await;\n\n // Verify the SVG elements are present and properly cased\n let svg = gloo::utils::document()\n .query_selector(\"svg\")\n .unwrap()\n .unwrap();\n\n let linear_gradient = svg.query_selector(\"linearGradient\").unwrap().unwrap();\n assert_eq!(linear_gradient.tag_name(), \"linearGradient\");\n\n let radial_gradient = svg.query_selector(\"radialGradient\").unwrap().unwrap();\n assert_eq!(radial_gradient.tag_name(), \"radialGradient\");\n\n let clip_path = svg.query_selector(\"clipPath\").unwrap().unwrap();\n assert_eq!(clip_path.tag_name(), \"clipPath\");\n\n // Test interactivity still works after hydration\n gloo::utils::document()\n .query_selector(\".increment\")\n .unwrap()\n .unwrap()\n .dyn_into::()\n .unwrap()\n .click();\n\n sleep(Duration::from_millis(10)).await;\n\n let counter_text = gloo::utils::document()\n .query_selector(\".counter\")\n .unwrap()\n .unwrap()\n .text_content()\n .unwrap();\n\n assert_eq!(counter_text, \"Count: 1\");\n}\n\n#[wasm_bindgen_test]\nasync fn hydration_suspended_child_does_not_trap_sibling_slot() {\n #[hook]\n fn use_suspend() -> SuspensionResult<()> {\n use_future(|| async {})?;\n Ok(())\n }\n\n #[component(SuspendingChild)]\n fn suspending_child() -> HtmlResult {\n use_suspend()?;\n Ok(html! {
{\"child\"}
})\n }\n\n #[component(App)]\n fn app() -> Html {\n let trigger = use_state(|| false);\n {\n let trigger = trigger.clone();\n use_effect_with((), move |_| {\n trigger.set(true);\n });\n }\n\n html! {\n
\n {\"Loading...\"}
}}>\n if *trigger {\n

{\"new sibling\"}

\n }\n \n \n \n }\n }\n\n let s = ServerRenderer::::new().render().await;\n\n gloo::utils::document()\n .query_selector(\"#output\")\n .unwrap()\n .unwrap()\n .set_inner_html(&s);\n\n scheduler::flush().await;\n\n Renderer::::with_root(gloo::utils::document().get_element_by_id(\"output\").unwrap())\n .hydrate();\n\n scheduler::flush().await;\n\n let result = obtain_result();\n\n assert_eq!(\n result.as_str(),\n r#\"

new sibling

child
\"#,\n );\n}\n" }, { "path": "packages/yew/tests/layout.rs", "content": "#![cfg(all(target_arch = \"wasm32\", not(target_os = \"wasi\")))]\n\nmod common;\n\nwasm_bindgen_test::wasm_bindgen_test_configure!(run_in_browser);\n\nuse std::time::Duration;\n\nuse common::obtain_result;\nuse wasm_bindgen_futures::spawn_local;\nuse wasm_bindgen_test::*;\nuse yew::platform::time::sleep;\nuse yew::prelude::*;\n\n#[wasm_bindgen_test]\nasync fn change_nested_after_append() {\n #[component]\n fn Nested() -> Html {\n let delayed_trigger = use_state(|| true);\n\n {\n let delayed_trigger = delayed_trigger.clone();\n use_effect_with((), move |_| {\n spawn_local(async move {\n sleep(Duration::from_millis(50)).await;\n delayed_trigger.set(false);\n });\n || {}\n });\n }\n\n if *delayed_trigger {\n html! {
{\"failure\"}
}\n } else {\n html! { <>{\"success\"} }\n }\n }\n\n #[component]\n fn Top() -> Html {\n html! { }\n }\n\n #[component]\n fn App() -> Html {\n let show_bottom = use_state_eq(|| false);\n\n {\n let show_bottom = show_bottom.clone();\n\n use_effect_with((), move |_| {\n show_bottom.set(true);\n || {}\n });\n }\n\n html! {\n <>\n \n if *show_bottom {\n
{\"
Bottom
\"}
\n }\n \n }\n }\n\n yew::Renderer::::with_root(gloo::utils::document().get_element_by_id(\"output\").unwrap())\n .render();\n\n sleep(Duration::from_millis(100)).await;\n\n let result = obtain_result();\n assert_eq!(result.as_str(), \"success\");\n}\n" }, { "path": "packages/yew/tests/mod.rs", "content": "#![cfg(all(target_arch = \"wasm32\", not(target_os = \"wasi\")))]\n\nmod common;\n\nuse common::obtain_result;\nuse wasm_bindgen_test::*;\nuse yew::prelude::*;\nuse yew::scheduler;\n\nwasm_bindgen_test::wasm_bindgen_test_configure!(run_in_browser);\n\n#[wasm_bindgen_test]\nasync fn props_are_passed() {\n #[derive(Properties, Clone, PartialEq)]\n struct PropsPassedFunctionProps {\n value: String,\n }\n\n #[component]\n fn PropsComponent(props: &PropsPassedFunctionProps) -> Html {\n assert_eq!(&props.value, \"props\");\n html! {\n
\n {\"done\"}\n
\n }\n }\n\n yew::Renderer::::with_root_and_props(\n gloo::utils::document().get_element_by_id(\"output\").unwrap(),\n PropsPassedFunctionProps {\n value: \"props\".to_string(),\n },\n )\n .render();\n\n scheduler::flush().await;\n let result = obtain_result();\n assert_eq!(result.as_str(), \"done\");\n}\n" }, { "path": "packages/yew/tests/raw_html.rs", "content": "mod common;\n\n#[cfg(all(target_arch = \"wasm32\", not(target_os = \"wasi\")))]\nuse wasm_bindgen::JsCast;\n#[cfg(all(target_arch = \"wasm32\", not(target_os = \"wasi\")))]\nuse wasm_bindgen_test::wasm_bindgen_test as test;\nuse yew::prelude::*;\n#[cfg(all(target_arch = \"wasm32\", not(target_os = \"wasi\")))]\nwasm_bindgen_test::wasm_bindgen_test_configure!(run_in_browser);\n#[cfg(any(not(target_arch = \"wasm32\"), target_os = \"wasi\"))]\nuse tokio::test;\n\nmacro_rules! create_test {\n ($name:ident, $html:expr) => {\n create_test!($name, $html, $html);\n };\n ($name:ident, $raw:expr, $expected:expr) => {\n #[test]\n async fn $name() {\n #[component]\n fn App() -> Html {\n let raw = Html::from_html_unchecked(AttrValue::from($raw));\n html! {\n
\n {raw}\n
\n }\n }\n\n #[cfg(all(target_arch = \"wasm32\", not(target_os = \"wasi\")))]\n {\n use std::time::Duration;\n\n use yew::platform::time::sleep;\n\n yew::Renderer::::with_root(\n gloo::utils::document().get_element_by_id(\"output\").unwrap(),\n )\n .render();\n\n // wait for render to finish\n sleep(Duration::from_millis(100)).await;\n\n let e = gloo::utils::document()\n .get_element_by_id(\"raw-container\")\n .unwrap();\n assert_eq!(e.inner_html(), $expected);\n }\n #[cfg(any(not(target_arch = \"wasm32\"), target_os = \"wasi\"))]\n {\n let actual = yew::LocalServerRenderer::::new()\n .hydratable(false)\n .render()\n .await;\n assert_eq!(\n actual,\n format!(r#\"
{}
\"#, $expected)\n );\n }\n }\n };\n}\n\ncreate_test!(empty_string, \"\");\ncreate_test!(one_node, \"text\");\ncreate_test!(\n one_but_nested_node,\n r#\"

one link more paragraph

\"#\n);\ncreate_test!(\n multi_node,\n r#\"

paragraph

link\"#\n);\n\n#[cfg(all(target_arch = \"wasm32\", not(target_os = \"wasi\")))]\nmacro_rules! create_update_html_test {\n ($name:ident, $initial:expr, $updated:expr) => {\n #[cfg(all(target_arch = \"wasm32\", not(target_os = \"wasi\")))]\n #[test]\n async fn $name() {\n #[component]\n fn App() -> Html {\n let raw_html = use_state(|| ($initial));\n let onclick = {\n let raw_html = raw_html.clone();\n move |_| raw_html.set($updated)\n };\n let raw = Html::from_html_unchecked(AttrValue::from(*raw_html));\n html! {\n <>\n
\n {raw}\n
\n \n \n }\n }\n use std::time::Duration;\n\n use yew::platform::time::sleep;\n\n yew::Renderer::::with_root(\n gloo::utils::document().get_element_by_id(\"output\").unwrap(),\n )\n .render();\n\n // wait for render to finish\n sleep(Duration::from_millis(100)).await;\n\n let e = gloo::utils::document()\n .get_element_by_id(\"raw-container\")\n .unwrap();\n assert_eq!(e.inner_html(), $initial);\n\n gloo::utils::document()\n .get_element_by_id(\"click-me-btn\")\n .unwrap()\n .unchecked_into::()\n .click();\n\n sleep(Duration::from_millis(100)).await;\n\n let e = gloo::utils::document()\n .get_element_by_id(\"raw-container\")\n .unwrap();\n assert_eq!(e.inner_html(), $updated);\n }\n };\n}\n\n#[cfg(all(target_arch = \"wasm32\", not(target_os = \"wasi\")))]\ncreate_update_html_test!(\n set_new_html_string,\n \"first\",\n \"second\"\n);\n\n#[cfg(all(target_arch = \"wasm32\", not(target_os = \"wasi\")))]\ncreate_update_html_test!(\n set_new_html_string_multiple_children,\n \"firstsecond\",\n \"second\"\n);\n\n#[cfg(all(target_arch = \"wasm32\", not(target_os = \"wasi\")))]\ncreate_update_html_test!(\n clear_html_string_multiple_children,\n \"firstsecond\",\n \"\"\n);\n\n#[cfg(all(target_arch = \"wasm32\", not(target_os = \"wasi\")))]\ncreate_update_html_test!(\n nothing_changes,\n \"firstsecond\",\n \"firstsecond\"\n);\n\n#[cfg(all(target_arch = \"wasm32\", not(target_os = \"wasi\")))]\n#[test]\nasync fn change_vnode_types_from_other_to_vraw() {\n #[component]\n fn App() -> Html {\n let node = use_state(|| html!(\"text\"));\n let onclick = {\n let node = node.clone();\n move |_| {\n node.set(Html::from_html_unchecked(AttrValue::from(\n \"second\",\n )))\n }\n };\n html! {\n <>\n
\n {(*node).clone()}\n
\n \n \n }\n }\n use std::time::Duration;\n\n use yew::platform::time::sleep;\n\n yew::Renderer::::with_root(gloo::utils::document().get_element_by_id(\"output\").unwrap())\n .render();\n\n // wait for render to finish\n sleep(Duration::from_millis(100)).await;\n\n let e = gloo::utils::document()\n .get_element_by_id(\"raw-container\")\n .unwrap();\n assert_eq!(e.inner_html(), \"text\");\n\n gloo::utils::document()\n .get_element_by_id(\"click-me-btn\")\n .unwrap()\n .unchecked_into::()\n .click();\n\n sleep(Duration::from_millis(100)).await;\n\n let e = gloo::utils::document()\n .get_element_by_id(\"raw-container\")\n .unwrap();\n assert_eq!(e.inner_html(), \"second\");\n}\n\n#[cfg(all(target_arch = \"wasm32\", not(target_os = \"wasi\")))]\n#[test]\nasync fn change_vnode_types_from_vraw_to_other() {\n #[component]\n fn App() -> Html {\n let node = use_state(|| Html::from_html_unchecked(AttrValue::from(\"second\")));\n let onclick = {\n let node = node.clone();\n move |_| node.set(html!(\"text\"))\n };\n html! {\n <>\n
\n {(*node).clone()}\n
\n \n \n }\n }\n use std::time::Duration;\n\n use yew::platform::time::sleep;\n\n yew::Renderer::::with_root(gloo::utils::document().get_element_by_id(\"output\").unwrap())\n .render();\n\n // wait for render to finish\n sleep(Duration::from_millis(100)).await;\n\n let e = gloo::utils::document()\n .get_element_by_id(\"raw-container\")\n .unwrap();\n assert_eq!(e.inner_html(), \"second\");\n\n gloo::utils::document()\n .get_element_by_id(\"click-me-btn\")\n .unwrap()\n .unchecked_into::()\n .click();\n\n sleep(Duration::from_millis(100)).await;\n\n let e = gloo::utils::document()\n .get_element_by_id(\"raw-container\")\n .unwrap();\n assert_eq!(e.inner_html(), \"text\");\n}\n" }, { "path": "packages/yew/tests/suspense.rs", "content": "#![cfg(all(target_arch = \"wasm32\", not(target_os = \"wasi\")))]\n\nmod common;\n\nuse std::cell::RefCell;\nuse std::rc::Rc;\nuse std::time::Duration;\n\nuse common::obtain_result;\nuse wasm_bindgen::JsCast;\nuse wasm_bindgen_test::*;\nuse web_sys::{HtmlElement, HtmlTextAreaElement};\nuse yew::platform::spawn_local;\nuse yew::platform::time::sleep;\nuse yew::prelude::*;\nuse yew::suspense::{use_future, use_future_with, Suspension, SuspensionResult};\nuse yew::{scheduler, UseStateHandle};\n\nwasm_bindgen_test_configure!(run_in_browser);\n\n#[wasm_bindgen_test]\nasync fn suspense_works() {\n #[derive(PartialEq)]\n pub struct SleepState {\n s: Suspension,\n }\n\n impl SleepState {\n fn new() -> Self {\n let (s, handle) = Suspension::new();\n\n spawn_local(async move {\n sleep(Duration::from_millis(50)).await;\n\n handle.resume();\n });\n\n Self { s }\n }\n }\n\n impl Reducible for SleepState {\n type Action = ();\n\n fn reduce(self: Rc, _action: Self::Action) -> Rc {\n Self::new().into()\n }\n }\n\n #[hook]\n pub fn use_sleep() -> SuspensionResult> {\n let sleep_state = use_reducer(SleepState::new);\n\n if sleep_state.s.resumed() {\n Ok(Rc::new(move || sleep_state.dispatch(())))\n } else {\n Err(sleep_state.s.clone())\n }\n }\n\n #[component(Content)]\n fn content() -> HtmlResult {\n let resleep = use_sleep()?;\n\n let value = use_state(|| 0);\n\n let on_increment = {\n let value = value.clone();\n\n Callback::from(move |_: MouseEvent| {\n value.set(*value + 1);\n })\n };\n\n let on_take_a_break = Callback::from(move |_: MouseEvent| (resleep.clone())());\n\n Ok(html! {\n
\n
{*value}
\n \n
\n \n
\n
\n })\n }\n\n #[component(App)]\n fn app() -> Html {\n let fallback = html! {
{\"wait...\"}
};\n\n html! {\n
\n \n \n \n
\n }\n }\n\n yew::Renderer::::with_root(gloo::utils::document().get_element_by_id(\"output\").unwrap())\n .render();\n\n sleep(Duration::from_millis(10)).await;\n let result = obtain_result();\n assert_eq!(result.as_str(), \"
wait...
\");\n\n sleep(Duration::from_millis(50)).await;\n\n let result = obtain_result();\n assert_eq!(\n result.as_str(),\n r#\"
0
\"#\n );\n\n sleep(Duration::from_millis(10)).await;\n\n gloo::utils::document()\n .query_selector(\".increase\")\n .unwrap()\n .unwrap()\n .dyn_into::()\n .unwrap()\n .click();\n\n scheduler::flush().await;\n\n gloo::utils::document()\n .query_selector(\".increase\")\n .unwrap()\n .unwrap()\n .dyn_into::()\n .unwrap()\n .click();\n\n sleep(Duration::from_millis(1)).await;\n\n let result = obtain_result();\n assert_eq!(\n result.as_str(),\n r#\"
2
\"#\n );\n\n gloo::utils::document()\n .query_selector(\".take-a-break\")\n .unwrap()\n .unwrap()\n .dyn_into::()\n .unwrap()\n .click();\n\n sleep(Duration::from_millis(10)).await;\n let result = obtain_result();\n assert_eq!(result.as_str(), \"
wait...
\");\n\n sleep(Duration::from_millis(50)).await;\n\n let result = obtain_result();\n assert_eq!(\n result.as_str(),\n r#\"
2
\"#\n );\n}\n\n#[wasm_bindgen_test]\nasync fn suspense_not_suspended_at_start() {\n #[derive(PartialEq)]\n pub struct SleepState {\n s: Option,\n }\n\n impl SleepState {\n fn new() -> Self {\n Self { s: None }\n }\n }\n\n impl Reducible for SleepState {\n type Action = ();\n\n fn reduce(self: Rc, _action: Self::Action) -> Rc {\n let (s, handle) = Suspension::new();\n\n spawn_local(async move {\n sleep(Duration::from_millis(50)).await;\n\n handle.resume();\n });\n\n Self { s: Some(s) }.into()\n }\n }\n\n #[hook]\n pub fn use_sleep() -> SuspensionResult> {\n let sleep_state = use_reducer(SleepState::new);\n\n let s = match sleep_state.s.clone() {\n Some(m) => m,\n None => return Ok(Rc::new(move || sleep_state.dispatch(()))),\n };\n\n if s.resumed() {\n Ok(Rc::new(move || sleep_state.dispatch(())))\n } else {\n Err(s)\n }\n }\n\n #[component(Content)]\n fn content() -> HtmlResult {\n let resleep = use_sleep()?;\n\n let value = use_state(|| \"I am writing a long story...\".to_string());\n\n let on_text_input = {\n let value = value.clone();\n\n Callback::from(move |e: InputEvent| {\n let input: HtmlTextAreaElement = e.target_unchecked_into();\n\n value.set(input.value());\n })\n };\n\n let on_take_a_break = Callback::from(move |_| (resleep.clone())());\n\n Ok(html! {\n
\n
\"#\n );\n gloo::utils::document()\n .query_selector(\".take-a-break\")\n .unwrap()\n .unwrap()\n .dyn_into::()\n .unwrap()\n .click();\n\n sleep(Duration::from_millis(10)).await;\n let result = obtain_result();\n assert_eq!(result.as_str(), \"
wait...
\");\n\n sleep(Duration::from_millis(50)).await;\n\n let result = obtain_result();\n assert_eq!(\n result.as_str(),\n r#\"
\"#\n );\n}\n\n#[wasm_bindgen_test]\nasync fn suspense_nested_suspense_works() {\n #[derive(PartialEq)]\n pub struct SleepState {\n s: Suspension,\n }\n\n impl SleepState {\n fn new() -> Self {\n let (s, handle) = Suspension::new();\n\n spawn_local(async move {\n sleep(Duration::from_millis(50)).await;\n\n handle.resume();\n });\n\n Self { s }\n }\n }\n\n impl Reducible for SleepState {\n type Action = ();\n\n fn reduce(self: Rc, _action: Self::Action) -> Rc {\n Self::new().into()\n }\n }\n\n #[hook]\n pub fn use_sleep() -> SuspensionResult> {\n let sleep_state = use_reducer(SleepState::new);\n\n if sleep_state.s.resumed() {\n Ok(Rc::new(move || sleep_state.dispatch(())))\n } else {\n Err(sleep_state.s.clone())\n }\n }\n\n #[component(InnerContent)]\n fn inner_content() -> HtmlResult {\n let resleep = use_sleep()?;\n\n let on_take_a_break = Callback::from(move |_: MouseEvent| (resleep.clone())());\n\n Ok(html! {\n
\n
\n \n
\n
\n })\n }\n\n #[component(Content)]\n fn content() -> HtmlResult {\n let resleep = use_sleep()?;\n\n let fallback = html! {
{\"wait...(inner)\"}
};\n\n let on_take_a_break = Callback::from(move |_: MouseEvent| (resleep.clone())());\n\n Ok(html! {\n
\n
\n \n
\n \n \n \n
\n })\n }\n\n #[component(App)]\n fn app() -> Html {\n let fallback = html! {
{\"wait...(outer)\"}
};\n\n html! {\n
\n \n \n \n
\n }\n }\n\n yew::Renderer::::with_root(gloo::utils::document().get_element_by_id(\"output\").unwrap())\n .render();\n\n sleep(Duration::from_millis(10)).await;\n let result = obtain_result();\n assert_eq!(result.as_str(), \"
wait...(outer)
\");\n\n sleep(Duration::from_millis(50)).await;\n\n let result = obtain_result();\n assert_eq!(\n result.as_str(),\n r#\"
wait...(inner)
\"#\n );\n\n sleep(Duration::from_millis(50)).await;\n\n let result = obtain_result();\n assert_eq!(\n result.as_str(),\n r#\"
\"#\n );\n\n gloo::utils::document()\n .query_selector(\".take-a-break2\")\n .unwrap()\n .unwrap()\n .dyn_into::()\n .unwrap()\n .click();\n\n sleep(Duration::from_millis(10)).await;\n let result = obtain_result();\n assert_eq!(\n result.as_str(),\n r#\"
wait...(inner)
\"#\n );\n\n sleep(Duration::from_millis(50)).await;\n\n let result = obtain_result();\n assert_eq!(\n result.as_str(),\n r#\"
\"#\n );\n}\n\n#[wasm_bindgen_test]\nasync fn effects_not_run_when_suspended() {\n #[derive(PartialEq)]\n pub struct SleepState {\n s: Suspension,\n }\n\n impl SleepState {\n fn new() -> Self {\n let (s, handle) = Suspension::new();\n\n spawn_local(async move {\n sleep(Duration::from_millis(50)).await;\n\n handle.resume();\n });\n\n Self { s }\n }\n }\n\n impl Reducible for SleepState {\n type Action = ();\n\n fn reduce(self: Rc, _action: Self::Action) -> Rc {\n Self::new().into()\n }\n }\n\n #[hook]\n pub fn use_sleep() -> SuspensionResult> {\n let sleep_state = use_reducer(SleepState::new);\n\n if sleep_state.s.resumed() {\n Ok(Rc::new(move || sleep_state.dispatch(())))\n } else {\n Err(sleep_state.s.clone())\n }\n }\n\n #[derive(Properties, Clone)]\n struct Props {\n counter: Rc>,\n }\n\n impl PartialEq for Props {\n fn eq(&self, _rhs: &Self) -> bool {\n true\n }\n }\n\n #[component(Content)]\n fn content(props: &Props) -> HtmlResult {\n {\n let counter = props.counter.clone();\n\n use_effect(move || {\n let mut counter = counter.borrow_mut();\n\n *counter += 1;\n\n || {}\n });\n }\n\n let resleep = use_sleep()?;\n\n let value = use_state(|| 0);\n\n let on_increment = {\n let value = value.clone();\n\n Callback::from(move |_: MouseEvent| {\n value.set(*value + 1);\n })\n };\n\n let on_take_a_break = Callback::from(move |_: MouseEvent| (resleep.clone())());\n\n Ok(html! {\n
\n
{*value}
\n \n
\n \n
\n
\n })\n }\n\n #[component(App)]\n fn app(props: &Props) -> Html {\n let fallback = html! {
{\"wait...\"}
};\n\n html! {\n
\n \n \n \n
\n }\n }\n\n let counter = Rc::new(RefCell::new(0_u64));\n\n let props = Props {\n counter: counter.clone(),\n };\n\n yew::Renderer::::with_root_and_props(\n gloo::utils::document().get_element_by_id(\"output\").unwrap(),\n props,\n )\n .render();\n\n sleep(Duration::from_millis(10)).await;\n let result = obtain_result();\n assert_eq!(result.as_str(), \"
wait...
\");\n assert_eq!(*counter.borrow(), 0); // effects not called.\n\n sleep(Duration::from_millis(50)).await;\n\n let result = obtain_result();\n assert_eq!(\n result.as_str(),\n r#\"
0
\"#\n );\n assert_eq!(*counter.borrow(), 1); // effects ran 1 time.\n\n sleep(Duration::from_millis(10)).await;\n\n gloo::utils::document()\n .query_selector(\".increase\")\n .unwrap()\n .unwrap()\n .dyn_into::()\n .unwrap()\n .click();\n\n scheduler::flush().await;\n\n gloo::utils::document()\n .query_selector(\".increase\")\n .unwrap()\n .unwrap()\n .dyn_into::()\n .unwrap()\n .click();\n\n scheduler::flush().await;\n\n let result = obtain_result();\n assert_eq!(\n result.as_str(),\n r#\"
2
\"#\n );\n assert_eq!(*counter.borrow(), 3); // effects ran 3 times.\n\n gloo::utils::document()\n .query_selector(\".take-a-break\")\n .unwrap()\n .unwrap()\n .dyn_into::()\n .unwrap()\n .click();\n\n sleep(Duration::from_millis(10)).await;\n let result = obtain_result();\n assert_eq!(result.as_str(), \"
wait...
\");\n assert_eq!(*counter.borrow(), 3); // effects ran 3 times.\n\n sleep(Duration::from_millis(50)).await;\n\n let result = obtain_result();\n assert_eq!(\n result.as_str(),\n r#\"
2
\"#\n );\n assert_eq!(*counter.borrow(), 4); // effects ran 4 times.\n}\n\n#[wasm_bindgen_test]\nasync fn use_suspending_future_works() {\n #[component(Content)]\n fn content() -> HtmlResult {\n let _sleep_handle = use_future(|| async move {\n sleep(Duration::from_millis(50)).await;\n })?;\n\n Ok(html! {\n
\n {\"Content\"}\n
\n })\n }\n\n #[component(App)]\n fn app() -> Html {\n let fallback = html! {
{\"wait...\"}
};\n\n html! {\n
\n \n \n \n
\n }\n }\n\n yew::Renderer::::with_root(gloo::utils::document().get_element_by_id(\"output\").unwrap())\n .render();\n\n sleep(Duration::from_millis(10)).await;\n let result = obtain_result();\n assert_eq!(result.as_str(), \"
wait...
\");\n\n sleep(Duration::from_millis(50)).await;\n\n let result = obtain_result();\n assert_eq!(result.as_str(), r#\"
Content
\"#);\n}\n\n#[wasm_bindgen_test]\nasync fn use_suspending_future_with_deps_works() {\n #[derive(PartialEq, Properties)]\n struct ContentProps {\n delay_millis: u64,\n }\n\n #[component(Content)]\n fn content(ContentProps { delay_millis }: &ContentProps) -> HtmlResult {\n let delayed_result = use_future_with(*delay_millis, |delay_millis| async move {\n sleep(Duration::from_millis(*delay_millis)).await;\n 42\n })?;\n\n Ok(html! {\n
\n {*delayed_result}\n
\n })\n }\n\n #[component(App)]\n fn app() -> Html {\n let fallback = html! {
{\"wait...\"}
};\n\n html! {\n
\n \n \n \n
\n }\n }\n\n yew::Renderer::::with_root(gloo::utils::document().get_element_by_id(\"output\").unwrap())\n .render();\n\n sleep(Duration::from_millis(10)).await;\n let result = obtain_result();\n assert_eq!(result.as_str(), \"
wait...
\");\n\n sleep(Duration::from_millis(50)).await;\n\n let result = obtain_result();\n assert_eq!(result.as_str(), r#\"
42
\"#);\n}\n\n#[wasm_bindgen_test]\nasync fn test_suspend_forever() {\n /// A component that its suspension never resumes.\n /// We test that this can be used with to trigger a suspension and unsuspend upon unmount.\n #[component]\n fn SuspendForever() -> HtmlResult {\n let (s, handle) = Suspension::new();\n use_state(move || handle);\n Err(s.into())\n }\n\n #[component]\n fn App() -> Html {\n let page = use_state(|| 1);\n\n {\n let page_setter = page.setter();\n use_effect_with((), move |_| {\n spawn_local(async move {\n sleep(Duration::from_secs(1)).await;\n page_setter.set(2);\n });\n });\n }\n\n let content = if *page == 1 {\n html! { }\n } else {\n html! {
{\"OK\"}
}\n };\n\n html! {\n {\"Loading...\"}}}>\n {content}\n \n }\n }\n\n yew::Renderer::::with_root(gloo::utils::document().get_element_by_id(\"output\").unwrap())\n .render();\n\n sleep(Duration::from_millis(1500)).await;\n\n let result = obtain_result();\n assert_eq!(result.as_str(), r#\"OK\"#);\n}\n\n#[wasm_bindgen_test]\nasync fn resume_after_unmount() {\n #[derive(Clone, Properties, PartialEq)]\n struct ContentProps {\n state: UseStateHandle,\n }\n\n #[component(Content)]\n fn content(ContentProps { state }: &ContentProps) -> HtmlResult {\n let state = state.clone();\n let _sleep_handle = use_future(|| async move {\n sleep(Duration::from_millis(50)).await;\n state.set(false);\n sleep(Duration::from_millis(50)).await;\n })?;\n\n Ok(html! {\n
{\"Content\"}
\n })\n }\n\n #[component(App)]\n fn app() -> Html {\n let fallback = html! {
{\"wait...\"}
};\n let state = use_state(|| true);\n\n html! {\n
\n if *state {\n \n \n \n } else {\n
{\"Content replacement\"}
\n }\n
\n }\n }\n\n yew::Renderer::::with_root(gloo::utils::document().get_element_by_id(\"output\").unwrap())\n .render();\n\n sleep(Duration::from_millis(25)).await;\n let result = obtain_result();\n assert_eq!(result.as_str(), \"
wait...
\");\n\n sleep(Duration::from_millis(50)).await;\n let result = obtain_result();\n assert_eq!(result.as_str(), \"
Content replacement
\");\n}\n\n#[wasm_bindgen_test]\nasync fn test_duplicate_suspension() {\n use yew::html::ChildrenProps;\n\n #[component]\n fn FetchingProvider(props: &ChildrenProps) -> HtmlResult {\n use_future(|| async {\n scheduler::flush().await;\n })?;\n Ok(html! { <>{props.children.clone()} })\n }\n\n #[component]\n fn Child() -> Html {\n html! {
{\"hello!\"}
}\n }\n\n #[component]\n fn App() -> Html {\n let fallback = Html::default();\n html! {\n \n \n \n \n \n }\n }\n\n yew::Renderer::::with_root(gloo::utils::document().get_element_by_id(\"output\").unwrap())\n .render();\n sleep(Duration::from_millis(50)).await;\n let result = obtain_result();\n assert_eq!(result.as_str(), \"hello!\");\n}\n" }, { "path": "packages/yew/tests/use_callback.rs", "content": "#![cfg(all(target_arch = \"wasm32\", not(target_os = \"wasi\")))]\n\nuse std::sync::atomic::{AtomicBool, Ordering};\n\nmod common;\n\nuse common::obtain_result;\nuse wasm_bindgen_test::*;\nuse yew::prelude::*;\nuse yew::scheduler;\n\nwasm_bindgen_test::wasm_bindgen_test_configure!(run_in_browser);\n\n#[wasm_bindgen_test]\nasync fn use_callback_works() {\n #[derive(Properties, PartialEq)]\n struct Props {\n callback: Callback,\n }\n\n #[component(MyComponent)]\n fn my_component(props: &Props) -> Html {\n let greeting = props.callback.emit(\"Yew\".to_string());\n\n static CTR: AtomicBool = AtomicBool::new(false);\n\n if CTR.swap(true, Ordering::Relaxed) {\n panic!(\"multiple times rendered!\");\n }\n\n html! {\n
\n {\"The test output is: \"}\n
{&greeting}
\n {\"\\n\"}\n
\n }\n }\n\n #[component(UseCallbackComponent)]\n fn use_callback_comp() -> Html {\n let state = use_state(|| 0);\n\n let callback = use_callback((), move |name, _| format!(\"Hello, {}!\", name));\n\n use_effect(move || {\n if *state < 5 {\n state.set(*state + 1);\n }\n\n || {}\n });\n\n html! {\n
\n \n
\n }\n }\n\n yew::Renderer::::with_root(\n gloo::utils::document().get_element_by_id(\"output\").unwrap(),\n )\n .render();\n\n scheduler::flush().await;\n\n let result = obtain_result();\n assert_eq!(result.as_str(), \"Hello, Yew!\");\n}\n" }, { "path": "packages/yew/tests/use_context.rs", "content": "#![cfg(all(target_arch = \"wasm32\", not(target_os = \"wasi\")))]\n\nmod common;\n\nuse std::rc::Rc;\n\nuse common::obtain_result_by_id;\nuse wasm_bindgen_test::*;\nuse yew::prelude::*;\nuse yew::scheduler;\n\nwasm_bindgen_test::wasm_bindgen_test_configure!(run_in_browser);\n\n#[wasm_bindgen_test]\nasync fn use_context_scoping_works() {\n #[derive(Clone, Debug, PartialEq)]\n struct ExampleContext(String);\n\n #[component]\n fn ExpectNoContextComponent() -> Html {\n let example_context = use_context::();\n\n if example_context.is_some() {\n console_log!(\n \"Context should be None here, but was {:?}!\",\n example_context\n );\n };\n html! {\n
\n }\n }\n\n #[component]\n fn UseContextComponent() -> Html {\n type ExampleContextProvider = ContextProvider;\n html! {\n
\n \n
{\"ignored\"}
\n \n \n \n \n
{\"ignored\"}
\n \n \n \n \n \n
{\"ignored\"}
\n \n \n
\n }\n }\n\n #[component]\n fn UseContextComponentInner() -> Html {\n let context = use_context::();\n html! {\n
{ &context.unwrap().0 }
\n }\n }\n\n yew::Renderer::::with_root(\n gloo::utils::document().get_element_by_id(\"output\").unwrap(),\n )\n .render();\n\n scheduler::flush().await;\n\n let result: String = obtain_result_by_id(\"result\");\n assert_eq!(\"correct\", result);\n}\n\n#[wasm_bindgen_test]\nasync fn use_context_works_with_multiple_types() {\n #[derive(Clone, Debug, PartialEq)]\n struct ContextA(u32);\n #[derive(Clone, Debug, PartialEq)]\n struct ContextB(u32);\n\n #[component]\n fn Test1() -> Html {\n let ctx_a = use_context::();\n let ctx_b = use_context::();\n\n assert_eq!(ctx_a, Some(ContextA(2)));\n assert_eq!(ctx_b, Some(ContextB(1)));\n\n html! {}\n }\n\n #[component]\n fn Test2() -> Html {\n let ctx_a = use_context::();\n let ctx_b = use_context::();\n\n assert_eq!(ctx_a, Some(ContextA(0)));\n assert_eq!(ctx_b, Some(ContextB(1)));\n\n html! {}\n }\n\n #[component]\n fn Test3() -> Html {\n let ctx_a = use_context::();\n let ctx_b = use_context::();\n\n assert_eq!(ctx_a, Some(ContextA(0)));\n assert_eq!(ctx_b, None);\n\n html! {}\n }\n\n #[component]\n fn Test4() -> Html {\n let ctx_a = use_context::();\n let ctx_b = use_context::();\n\n assert_eq!(ctx_a, None);\n assert_eq!(ctx_b, None);\n\n html! {}\n }\n\n #[component]\n fn TestComponent() -> Html {\n type ContextAProvider = ContextProvider;\n type ContextBProvider = ContextProvider;\n\n html! {\n
\n \n \n \n \n \n \n \n \n \n \n
\n }\n }\n\n yew::Renderer::::with_root(\n gloo::utils::document().get_element_by_id(\"output\").unwrap(),\n )\n .render();\n\n scheduler::flush().await;\n}\n\n#[wasm_bindgen_test]\nasync fn use_context_update_works() {\n #[derive(Clone, Debug, PartialEq)]\n struct MyContext(String);\n\n #[derive(Clone, Debug, PartialEq, Properties)]\n struct RenderCounterProps {\n id: String,\n children: Children,\n }\n\n #[component]\n fn RenderCounter(props: &RenderCounterProps) -> Html {\n let counter = use_mut_ref(|| 0);\n *counter.borrow_mut() += 1;\n html! {\n <>\n
\n { format!(\"total: {}\", counter.borrow()) }\n
\n { props.children.clone() }\n \n }\n }\n\n #[derive(Clone, Debug, PartialEq, Properties)]\n struct ContextOutletProps {\n id: String,\n #[prop_or_default]\n magic: usize,\n }\n\n #[component]\n fn ContextOutlet(props: &ContextOutletProps) -> Html {\n let counter = use_mut_ref(|| 0);\n *counter.borrow_mut() += 1;\n\n let ctx = use_context::>().expect(\"context not passed down\");\n\n html! {\n <>\n
{ format!(\"magic: {}\\n\", props.magic) }
\n
\n { format!(\"current: {}, total: {}\", ctx.0, counter.borrow()) }\n
\n \n }\n }\n\n #[component]\n fn TestComponent() -> Html {\n type MyContextProvider = ContextProvider>;\n\n let ctx = use_state(|| MyContext(\"hello\".into()));\n let rendered = use_mut_ref(|| 0);\n\n // this is used to force an update specific to test-2\n let magic_rc = use_state(|| 0);\n let magic: usize = *magic_rc;\n {\n let ctx = ctx.clone();\n use_effect(move || {\n let count = *rendered.borrow();\n match count {\n 0 => {\n ctx.set(MyContext(\"world\".into()));\n *rendered.borrow_mut() += 1;\n }\n 1 => {\n // force test-2 to re-render.\n magic_rc.set(1);\n *rendered.borrow_mut() += 1;\n }\n 2 => {\n ctx.set(MyContext(\"hello world!\".into()));\n *rendered.borrow_mut() += 1;\n }\n _ => (),\n };\n || {}\n });\n }\n html! {\n \n \n \n \n \n \n }\n }\n\n yew::Renderer::::with_root(\n gloo::utils::document().get_element_by_id(\"output\").unwrap(),\n )\n .render();\n\n scheduler::flush().await;\n\n // 1 initial render + 1 magic\n assert_eq!(obtain_result_by_id(\"test-0\"), \"total: 2\");\n\n // 1 initial + 2 context update\n assert_eq!(\n obtain_result_by_id(\"test-1\"),\n \"current: hello world!, total: 3\"\n );\n\n // 1 initial + 1 context update + 1 magic update + 1 context update\n assert_eq!(\n obtain_result_by_id(\"test-2\"),\n \"current: hello world!, total: 4\"\n );\n}\n" }, { "path": "packages/yew/tests/use_effect.rs", "content": "#![cfg(all(target_arch = \"wasm32\", not(target_os = \"wasi\")))]\n\nmod common;\n\nuse std::ops::{Deref, DerefMut};\nuse std::rc::Rc;\n\nuse common::obtain_result;\nuse wasm_bindgen_test::*;\nuse yew::prelude::*;\nuse yew::scheduler;\n\nwasm_bindgen_test::wasm_bindgen_test_configure!(run_in_browser);\n\n#[wasm_bindgen_test]\nasync fn use_effect_destroys_on_component_drop() {\n #[derive(Properties, Clone)]\n struct WrapperProps {\n destroy_called: Rc,\n }\n impl PartialEq for WrapperProps {\n fn eq(&self, _other: &Self) -> bool {\n false\n }\n }\n #[derive(Properties, Clone)]\n struct FunctionProps {\n effect_called: Rc,\n destroy_called: Rc,\n }\n impl PartialEq for FunctionProps {\n fn eq(&self, _other: &Self) -> bool {\n false\n }\n }\n\n #[component(UseEffectComponent)]\n fn use_effect_comp(props: &FunctionProps) -> Html {\n let effect_called = props.effect_called.clone();\n let destroy_called = props.destroy_called.clone();\n use_effect_with((), move |_| {\n effect_called();\n #[allow(clippy::redundant_closure)] // Otherwise there is a build error\n move || destroy_called()\n });\n html! {}\n }\n\n #[component(UseEffectWrapperComponent)]\n fn use_effect_wrapper_comp(props: &WrapperProps) -> Html {\n let show = use_state(|| true);\n if *show {\n let effect_called: Rc = { Rc::new(move || show.set(false)) };\n html! {\n \n }\n } else {\n html! {\n
{ \"EMPTY\" }
\n }\n }\n }\n\n let destroy_counter = Rc::new(std::cell::RefCell::new(0));\n let destroy_counter_c = destroy_counter.clone();\n yew::Renderer::::with_root_and_props(\n gloo::utils::document().get_element_by_id(\"output\").unwrap(),\n WrapperProps {\n destroy_called: Rc::new(move || *destroy_counter_c.borrow_mut().deref_mut() += 1),\n },\n )\n .render();\n\n scheduler::flush().await;\n\n assert_eq!(1, *destroy_counter.borrow().deref());\n}\n\n#[wasm_bindgen_test]\nasync fn use_effect_works_many_times() {\n #[component(UseEffectComponent)]\n fn use_effect_comp() -> Html {\n let counter = use_state(|| 0);\n let counter_clone = counter.clone();\n\n use_effect_with(*counter, move |_| {\n if *counter_clone < 4 {\n counter_clone.set(*counter_clone + 1);\n }\n || {}\n });\n\n html! {\n
\n { \"The test result is\" }\n
{ *counter }
\n { \"\\n\" }\n
\n }\n }\n\n yew::Renderer::::with_root(\n gloo::utils::document().get_element_by_id(\"output\").unwrap(),\n )\n .render();\n\n scheduler::flush().await;\n let result = obtain_result();\n assert_eq!(result.as_str(), \"4\");\n}\n\n#[wasm_bindgen_test]\nasync fn use_effect_works_once() {\n #[component(UseEffectComponent)]\n fn use_effect_comp() -> Html {\n let counter = use_state(|| 0);\n let counter_clone = counter.clone();\n\n use_effect_with((), move |_| {\n counter_clone.set(*counter_clone + 1);\n || panic!(\"Destructor should not have been called\")\n });\n\n html! {\n
\n { \"The test result is\" }\n
{ *counter }
\n { \"\\n\" }\n
\n }\n }\n\n yew::Renderer::::with_root(\n gloo::utils::document().get_element_by_id(\"output\").unwrap(),\n )\n .render();\n scheduler::flush().await;\n\n let result = obtain_result();\n\n assert_eq!(result.as_str(), \"1\");\n}\n\n#[wasm_bindgen_test]\nasync fn use_effect_refires_on_dependency_change() {\n #[component(UseEffectComponent)]\n fn use_effect_comp() -> Html {\n let number_ref = use_mut_ref(|| 0);\n let number_ref_c = number_ref.clone();\n let number_ref2 = use_mut_ref(|| 0);\n let number_ref2_c = number_ref2.clone();\n let arg = *number_ref.borrow_mut().deref_mut();\n let counter = use_state(|| 0);\n use_effect_with(arg, move |dep| {\n let mut ref_mut = number_ref_c.borrow_mut();\n let inner_ref_mut = ref_mut.deref_mut();\n if *inner_ref_mut < 1 {\n *inner_ref_mut += 1;\n assert_eq!(dep, &0);\n } else {\n assert_eq!(dep, &1);\n }\n counter.set(10); // we just need to make sure it does not panic\n move || {\n counter.set(11);\n *number_ref2_c.borrow_mut().deref_mut() += 1;\n }\n });\n html! {\n
\n {\"The test result is\"}\n
{*number_ref.borrow_mut().deref_mut()}{*number_ref2.borrow_mut().deref_mut()}
\n {\"\\n\"}\n
\n }\n }\n\n yew::Renderer::::with_root(\n gloo::utils::document().get_element_by_id(\"output\").unwrap(),\n )\n .render();\n\n scheduler::flush().await;\n let result: String = obtain_result();\n\n assert_eq!(result.as_str(), \"11\");\n}\n" }, { "path": "packages/yew/tests/use_memo.rs", "content": "#![cfg(all(target_arch = \"wasm32\", not(target_os = \"wasi\")))]\n\nuse std::sync::atomic::{AtomicBool, Ordering};\n\nmod common;\n\nuse common::obtain_result;\nuse wasm_bindgen_test::*;\nuse yew::prelude::*;\nuse yew::scheduler;\n\nwasm_bindgen_test::wasm_bindgen_test_configure!(run_in_browser);\n\n#[wasm_bindgen_test]\nasync fn use_memo_works() {\n #[component(UseMemoComponent)]\n fn use_memo_comp() -> Html {\n let state = use_state(|| 0);\n\n let memoed_val = use_memo((), |_| {\n static CTR: AtomicBool = AtomicBool::new(false);\n\n if CTR.swap(true, Ordering::Relaxed) {\n panic!(\"multiple times rendered!\");\n }\n\n \"true\"\n });\n\n use_effect(move || {\n if *state < 5 {\n state.set(*state + 1);\n }\n\n || {}\n });\n\n html! {\n
\n {\"The test output is: \"}\n
{*memoed_val}
\n {\"\\n\"}\n
\n }\n }\n\n yew::Renderer::::with_root(\n gloo::utils::document().get_element_by_id(\"output\").unwrap(),\n )\n .render();\n\n scheduler::flush().await;\n\n let result = obtain_result();\n assert_eq!(result.as_str(), \"true\");\n}\n" }, { "path": "packages/yew/tests/use_prepared_state.rs", "content": "#![cfg(all(target_arch = \"wasm32\", not(target_os = \"wasi\")))]\n#![cfg(feature = \"hydration\")]\n#![cfg_attr(nightly_yew, feature(async_closure))]\n\nuse std::time::Duration;\n\nmod common;\n\nuse common::obtain_result_by_id;\nuse wasm_bindgen_test::*;\nuse yew::platform::time::sleep;\nuse yew::prelude::*;\nuse yew::{scheduler, Renderer, ServerRenderer};\n\nwasm_bindgen_test::wasm_bindgen_test_configure!(run_in_browser);\n\n#[wasm_bindgen_test]\nasync fn use_prepared_state_works() {\n #[component]\n fn Comp() -> HtmlResult {\n let ctr = use_prepared_state!((), |_| -> u32 { 12345 })?.unwrap_or_default();\n\n Ok(html! {\n
\n {*ctr}\n
\n })\n }\n\n #[component]\n fn App() -> Html {\n html! {\n \n
\n \n
\n \n }\n }\n\n let s = ServerRenderer::::new().render().await;\n\n assert_eq!(\n s,\n r#\"
12345
\"#\n );\n\n gloo::utils::document()\n .query_selector(\"#output\")\n .unwrap()\n .unwrap()\n .set_inner_html(&s);\n\n scheduler::flush().await;\n\n Renderer::::with_root(gloo::utils::document().get_element_by_id(\"output\").unwrap())\n .hydrate();\n\n sleep(Duration::from_millis(200)).await;\n\n let result = obtain_result_by_id(\"output\");\n\n // no placeholders, hydration is successful and state 12345 is preserved.\n assert_eq!(result, r#\"
12345
\"#);\n}\n\n#[wasm_bindgen_test]\nasync fn use_prepared_state_with_suspension_works() {\n #[component]\n fn Comp() -> HtmlResult {\n let ctr = use_prepared_state!((), async move |_| -> u32 { 12345 })?.unwrap_or_default();\n\n Ok(html! {\n
\n {*ctr}\n
\n })\n }\n\n #[component]\n fn App() -> Html {\n html! {\n \n
\n \n
\n \n }\n }\n\n let s = ServerRenderer::::new().render().await;\n\n assert_eq!(\n s,\n r#\"
12345
\"#\n );\n\n gloo::utils::document()\n .query_selector(\"#output\")\n .unwrap()\n .unwrap()\n .set_inner_html(&s);\n\n scheduler::flush().await;\n\n Renderer::::with_root(gloo::utils::document().get_element_by_id(\"output\").unwrap())\n .hydrate();\n\n sleep(Duration::from_millis(200)).await;\n\n let result = obtain_result_by_id(\"output\");\n\n // no placeholders, hydration is successful and state 12345 is preserved.\n assert_eq!(result, r#\"
12345
\"#);\n}\n" }, { "path": "packages/yew/tests/use_reducer.rs", "content": "#![cfg(all(target_arch = \"wasm32\", not(target_os = \"wasi\")))]\n\nuse std::collections::HashSet;\nuse std::rc::Rc;\n\nuse gloo::utils::document;\nuse wasm_bindgen::JsCast;\nuse wasm_bindgen_test::*;\nuse web_sys::HtmlElement;\nuse yew::prelude::*;\nuse yew::scheduler;\n\nmod common;\n\nuse common::obtain_result;\n\nwasm_bindgen_test::wasm_bindgen_test_configure!(run_in_browser);\n\n#[derive(Debug)]\nstruct CounterState {\n counter: i32,\n}\n\nimpl Reducible for CounterState {\n type Action = i32;\n\n fn reduce(self: Rc, action: Self::Action) -> Rc {\n Self {\n counter: self.counter + action,\n }\n .into()\n }\n}\n\n#[wasm_bindgen_test]\nasync fn use_reducer_works() {\n #[component(UseReducerComponent)]\n fn use_reducer_comp() -> Html {\n let counter = use_reducer(|| CounterState { counter: 10 });\n\n let counter_clone = counter.clone();\n use_effect_with((), move |_| {\n counter_clone.dispatch(1);\n || {}\n });\n html! {\n
\n {\"The test result is\"}\n
{counter.counter}
\n {\"\\n\"}\n
\n }\n }\n\n yew::Renderer::::with_root(\n gloo::utils::document().get_element_by_id(\"output\").unwrap(),\n )\n .render();\n scheduler::flush().await;\n let result = obtain_result();\n\n assert_eq!(result.as_str(), \"11\");\n}\n\n#[derive(Debug, Clone, PartialEq)]\nstruct ContentState {\n content: HashSet,\n}\n\nimpl Reducible for ContentState {\n type Action = String;\n\n fn reduce(self: Rc, action: Self::Action) -> Rc {\n let mut self_: Self = (*self).clone();\n self_.content.insert(action);\n self_.into()\n }\n}\n\n#[wasm_bindgen_test]\nasync fn use_reducer_eq_works() {\n #[component(UseReducerComponent)]\n fn use_reducer_comp() -> Html {\n let content = use_reducer_eq(|| ContentState {\n content: HashSet::default(),\n });\n\n let render_count = use_mut_ref(|| 0);\n\n let render_count = {\n let mut render_count = render_count.borrow_mut();\n *render_count += 1;\n\n *render_count\n };\n\n let add_content_a = {\n let content = content.clone();\n Callback::from(move |_| content.dispatch(\"A\".to_string()))\n };\n\n let add_content_b = Callback::from(move |_| content.dispatch(\"B\".to_string()));\n\n html! {\n <>\n
\n {\"This component has been rendered: \"}{render_count}{\" Time(s).\"}\n
\n \n \n \n }\n }\n\n yew::Renderer::::with_root(\n document().get_element_by_id(\"output\").unwrap(),\n )\n .render();\n scheduler::flush().await;\n\n let result = obtain_result();\n assert_eq!(result.as_str(), \"1\");\n\n document()\n .get_element_by_id(\"add-a\")\n .unwrap()\n .unchecked_into::()\n .click();\n scheduler::flush().await;\n\n let result = obtain_result();\n assert_eq!(result.as_str(), \"2\");\n\n document()\n .get_element_by_id(\"add-a\")\n .unwrap()\n .unchecked_into::()\n .click();\n scheduler::flush().await;\n\n let result = obtain_result();\n assert_eq!(result.as_str(), \"2\");\n\n document()\n .get_element_by_id(\"add-b\")\n .unwrap()\n .unchecked_into::()\n .click();\n scheduler::flush().await;\n\n let result = obtain_result();\n assert_eq!(result.as_str(), \"3\");\n\n document()\n .get_element_by_id(\"add-b\")\n .unwrap()\n .unchecked_into::()\n .click();\n scheduler::flush().await;\n\n let result = obtain_result();\n assert_eq!(result.as_str(), \"3\");\n}\n\nenum SometimesChangeAction {\n /// If this action is sent, the state will remain the same\n Keep,\n /// If this action is sent, the state will change\n Change,\n}\n\n/// A state that does not implement PartialEq\n#[derive(Clone)]\nstruct SometimesChangingState {\n value: i32,\n}\n\nimpl Reducible for SometimesChangingState {\n type Action = SometimesChangeAction;\n\n fn reduce(self: Rc, action: Self::Action) -> Rc {\n use SometimesChangeAction::*;\n match action {\n Keep => self,\n Change => {\n let mut self_: Self = (*self).clone();\n self_.value += 1;\n self_.into()\n }\n }\n }\n}\n\n#[wasm_bindgen_test]\nasync fn use_reducer_does_not_rerender_when_rc_is_reused() {\n #[component(UseReducerComponent)]\n fn use_reducer_comp() -> Html {\n let state = use_reducer(|| SometimesChangingState { value: 0 });\n let render_count = use_mut_ref(|| 0);\n\n let render_count = {\n let mut render_count = render_count.borrow_mut();\n *render_count += 1;\n\n *render_count\n };\n\n let keep_state = {\n let state = state.clone();\n Callback::from(move |_| state.dispatch(SometimesChangeAction::Keep))\n };\n\n let change_state = Callback::from(move |_| state.dispatch(SometimesChangeAction::Change));\n\n html! {\n <>\n
\n {\"This component has been rendered: \"}{render_count}{\" Time(s).\"}\n
\n \n \n \n }\n }\n\n yew::Renderer::::with_root(\n document().get_element_by_id(\"output\").unwrap(),\n )\n .render();\n scheduler::flush().await;\n\n let result = obtain_result();\n assert_eq!(result.as_str(), \"1\");\n\n document()\n .get_element_by_id(\"change-state\")\n .unwrap()\n .unchecked_into::()\n .click();\n scheduler::flush().await;\n\n let result = obtain_result();\n assert_eq!(result.as_str(), \"2\");\n\n document()\n .get_element_by_id(\"keep-state\")\n .unwrap()\n .unchecked_into::()\n .click();\n scheduler::flush().await;\n\n let result = obtain_result();\n assert_eq!(result.as_str(), \"2\");\n}\n" }, { "path": "packages/yew/tests/use_ref.rs", "content": "#![cfg(all(target_arch = \"wasm32\", not(target_os = \"wasi\")))]\n\nmod common;\n\nuse std::ops::DerefMut;\n\nuse common::obtain_result;\nuse wasm_bindgen_test::*;\nuse yew::prelude::*;\nuse yew::scheduler;\n\nwasm_bindgen_test::wasm_bindgen_test_configure!(run_in_browser);\n\n#[wasm_bindgen_test]\nasync fn use_ref_works() {\n #[component(UseRefComponent)]\n fn use_ref_comp() -> Html {\n let ref_example = use_mut_ref(|| 0);\n *ref_example.borrow_mut().deref_mut() += 1;\n let counter = use_state(|| 0);\n if *counter < 5 {\n counter.set(*counter + 1)\n }\n html! {\n
\n {\"The test output is: \"}\n
{*ref_example.borrow_mut().deref_mut() > 4}
\n {\"\\n\"}\n
\n }\n }\n\n yew::Renderer::::with_root(\n gloo::utils::document().get_element_by_id(\"output\").unwrap(),\n )\n .render();\n scheduler::flush().await;\n\n let result = obtain_result();\n assert_eq!(result.as_str(), \"true\");\n}\n" }, { "path": "packages/yew/tests/use_state.rs", "content": "#![cfg(all(target_arch = \"wasm32\", not(target_os = \"wasi\")))]\n\nmod common;\n\nuse common::obtain_result;\nuse wasm_bindgen_test::*;\nuse yew::prelude::*;\nuse yew::scheduler;\n\nwasm_bindgen_test::wasm_bindgen_test_configure!(run_in_browser);\n\n#[wasm_bindgen_test]\nasync fn use_state_works() {\n #[component(UseComponent)]\n fn use_state_comp() -> Html {\n let counter = use_state(|| 0);\n if *counter < 5 {\n counter.set(*counter + 1)\n }\n html! {\n
\n {\"Test Output: \"}\n
{*counter}
\n {\"\\n\"}\n
\n }\n }\n\n yew::Renderer::::with_root(\n gloo::utils::document().get_element_by_id(\"output\").unwrap(),\n )\n .render();\n scheduler::flush().await;\n let result = obtain_result();\n assert_eq!(result.as_str(), \"5\");\n}\n\n#[wasm_bindgen_test]\nasync fn multiple_use_state_setters() {\n #[component(UseComponent)]\n fn use_state_comp() -> Html {\n let counter = use_state(|| 0);\n let counter_clone = counter.clone();\n use_effect_with((), move |_| {\n // 1st location\n counter_clone.set(*counter_clone + 1);\n || {}\n });\n let another_scope = {\n let counter = counter.clone();\n move || {\n if *counter < 11 {\n // 2nd location\n counter.set(*counter + 10)\n }\n }\n };\n another_scope();\n html! {\n
\n { \"Test Output: \" }\n // expected output\n
{ *counter }
\n { \"\\n\" }\n
\n }\n }\n\n yew::Renderer::::with_root(\n gloo::utils::document().get_element_by_id(\"output\").unwrap(),\n )\n .render();\n scheduler::flush().await;\n let result = obtain_result();\n assert_eq!(result.as_str(), \"11\");\n}\n\n#[wasm_bindgen_test]\nasync fn use_state_eq_works() {\n use std::sync::atomic::{AtomicUsize, Ordering};\n static RENDER_COUNT: AtomicUsize = AtomicUsize::new(0);\n\n #[component(UseComponent)]\n fn use_state_comp() -> Html {\n RENDER_COUNT.fetch_add(1, Ordering::Relaxed);\n let counter = use_state_eq(|| 0);\n counter.set(1);\n\n html! {\n
\n {\"Test Output: \"}\n
{*counter}
\n {\"\\n\"}\n
\n }\n }\n\n yew::Renderer::::with_root(\n gloo::utils::document().get_element_by_id(\"output\").unwrap(),\n )\n .render();\n scheduler::flush().await;\n let result = obtain_result();\n assert_eq!(result.as_str(), \"1\");\n assert_eq!(RENDER_COUNT.load(Ordering::Relaxed), 2);\n}\n\n/// Exercises the exact pattern that causes use-after-free in the original PR #3963\n/// fix, where `UseReducerHandle::deref()` drops the `Ref` guard but returns a\n/// pointer derived from it.\n///\n/// The dangerous sequence within a single callback:\n/// 1. `handle.set(v1)` — dispatch puts a *new* `Rc` (refcount=1) in the shared `RefCell`,\n/// replacing the one from render time.\n/// 2. `let r: &T = &*handle` — `deref()` borrows the RefCell, grabs a raw pointer into the Rc\n/// (refcount still 1), and **drops the `Ref` guard**.\n/// 3. `handle.set(v2)` — dispatch replaces that Rc. Because its refcount was 1, it is freed. `r`\n/// is now dangling.\n/// 4. Allocate objects of similar size to encourage the allocator to reuse the freed memory,\n/// overwriting the old `T`.\n/// 5. Read through `r` — **use-after-free**.\n///\n/// With the `deref_history` fix, step 2 clones the Rc into a `Vec` kept alive by\n/// the handle, bumping the refcount to 2. Step 3 only drops it to 1, so the\n/// allocation survives and `r` remains valid.\n#[wasm_bindgen_test]\nasync fn deref_remains_valid_across_multiple_dispatches_in_callback() {\n use std::cell::RefCell;\n\n use gloo::utils::document;\n use wasm_bindgen::JsCast;\n use web_sys::HtmlElement;\n\n thread_local! {\n static DEREF_RESULT: RefCell> = const { RefCell::new(None) };\n }\n\n #[component(UBTestComponent)]\n fn ub_test_comp() -> Html {\n let state = use_state(|| \"initial\".to_string());\n\n let trigger = {\n let state = state.clone();\n Callback::from(move |_| {\n // Step 1: dispatch. The RefCell now contains a *new* Rc whose only\n // owner is the RefCell itself (refcount = 1).\n state.set(\"first_dispatch\".to_string());\n\n // Step 2: deref. In the original fix the Ref guard is dropped\n // immediately, leaving us with a bare pointer into the refcount-1\n // Rc. With deref_history, the Rc is cloned into the Vec so the\n // refcount is bumped to 2.\n let borrowed: &String = &*state;\n\n // Step 3: dispatch again. The RefCell's old Rc is replaced.\n // Original fix: refcount was 1 → drops to 0 → freed → `borrowed`\n // dangles.\n // deref_history fix: refcount was 2 → drops to 1 (still in Vec)\n // → allocation survives → `borrowed` is valid.\n state.set(\"second_dispatch\".to_string());\n\n // Step 4: churn the allocator. Create and drop many heap objects\n // of ~32 bytes (the size of the freed Rc+UseStateReducer+String\n // struct on wasm32) to maximize the chance that the allocator\n // hands out the freed address to one of these, overwriting the\n // memory `borrowed` points into.\n for _ in 0..256 {\n // Each Box<[u8; 32]> is roughly the same size as the freed Rc\n // allocation containing UseStateReducer.\n let overwrite = Box::new([0xFFu8; 32]);\n std::hint::black_box(&*overwrite);\n drop(overwrite);\n }\n\n // Also allocate Strings whose *buffers* might reuse the freed\n // String buffer from step 1.\n let _noise: Vec = (0..64).map(|i| format!(\"noise_{:032}\", i)).collect();\n\n // Step 5: read through the potentially-dangling reference.\n // With the original fix this is UB: the memory behind `borrowed`\n // may have been reused by the allocations above, so `.clone()`\n // could read a garbage ptr/len/cap triple and trap, or silently\n // return corrupted data.\n // With deref_history, this always reads \"first_dispatch\".\n let value = borrowed.clone();\n\n DEREF_RESULT.with(|r| {\n *r.borrow_mut() = Some(value);\n });\n })\n };\n\n html! {\n
\n \n
{(*state).clone()}
\n
\n }\n }\n\n yew::Renderer::::with_root(document().get_element_by_id(\"output\").unwrap())\n .render();\n scheduler::flush().await;\n\n // Fire the callback\n document()\n .get_element_by_id(\"ub-trigger\")\n .unwrap()\n .unchecked_into::()\n .click();\n\n scheduler::flush().await;\n\n // The reference obtained between the two dispatches must still read the\n // value from the first dispatch, not garbage or \"second_dispatch\".\n let captured = DEREF_RESULT.with(|r| r.borrow().clone());\n assert_eq!(\n captured,\n Some(\"first_dispatch\".to_string()),\n \"deref() reference must remain valid across subsequent dispatches\"\n );\n}\n\n/// Regression test for issue #3796\n/// Tests that state handles always read the latest value even when accessed\n/// from callbacks before a rerender occurs.\n///\n/// The bug occurred when:\n/// 1. State A is updated via set()\n/// 2. State B is updated via set()\n/// 3. A callback reads both states before rerender\n/// 4. The callback would see stale value for B because the handle was caching a snapshot instead of\n/// reading from the shared RefCell\n#[wasm_bindgen_test]\nasync fn use_state_handles_read_latest_value_issue_3796() {\n use std::cell::RefCell;\n\n use gloo::utils::document;\n use wasm_bindgen::JsCast;\n use web_sys::HtmlElement;\n\n // Shared storage for the values read by the submit handler\n thread_local! {\n static CAPTURED_VALUES: RefCell> = const { RefCell::new(None) };\n }\n\n #[component(FormComponent)]\n fn form_comp() -> Html {\n let field_a = use_state(String::new);\n let field_b = use_state(String::new);\n\n let update_a = {\n let field_a = field_a.clone();\n Callback::from(move |_| {\n field_a.set(\"value_a\".to_string());\n })\n };\n\n let update_b = {\n let field_b = field_b.clone();\n Callback::from(move |_| {\n field_b.set(\"value_b\".to_string());\n })\n };\n\n // This callback reads both states - the bug caused field_b to be stale\n let submit = {\n let field_a = field_a.clone();\n let field_b = field_b.clone();\n Callback::from(move |_| {\n let a = (*field_a).clone();\n let b = (*field_b).clone();\n CAPTURED_VALUES.with(|v| {\n *v.borrow_mut() = Some((a.clone(), b.clone()));\n });\n })\n };\n\n html! {\n
\n \n \n \n
{format!(\"a={}, b={}\", *field_a, *field_b)}
\n
\n }\n }\n\n yew::Renderer::::with_root(document().get_element_by_id(\"output\").unwrap())\n .render();\n scheduler::flush().await;\n\n // Initial state\n let result = obtain_result();\n assert_eq!(result.as_str(), \"a=, b=\");\n\n // Click update-a, then update-b, then submit WITHOUT waiting for rerender.\n // This simulates rapid user interaction (like the Firefox bug in issue #3796).\n document()\n .get_element_by_id(\"update-a\")\n .unwrap()\n .unchecked_into::()\n .click();\n\n document()\n .get_element_by_id(\"update-b\")\n .unwrap()\n .unchecked_into::()\n .click();\n\n document()\n .get_element_by_id(\"submit\")\n .unwrap()\n .unchecked_into::()\n .click();\n\n // Now wait for rerenders to complete\n scheduler::flush().await;\n\n // Check the values captured by the submit handler.\n // Before the fix, field_b would be empty because the callback captured a stale handle.\n let captured = CAPTURED_VALUES.with(|v| v.borrow().clone());\n assert_eq!(\n captured,\n Some((\"value_a\".to_string(), \"value_b\".to_string())),\n \"Submit handler should see latest values for both fields\"\n );\n\n // Also verify the DOM shows correct values after rerender\n let result = obtain_result();\n assert_eq!(result.as_str(), \"a=value_a, b=value_b\");\n}\n\n/// Regression test for issue #4058\n///\n/// When a UseStateHandle is passed as a prop to a child component, updating the\n/// state should cause the child to re-render. After the deref_history change\n/// (PR #3988), UseReducerHandle::eq dereferences both old and new handles, but\n/// since Deref now always reads from the shared RefCell, both sides resolve to\n/// the latest value, making eq always return true and preventing child re-renders.\n#[wasm_bindgen_test]\nasync fn use_state_handle_as_prop_triggers_child_rerender_issue_4058() {\n use std::sync::atomic::{AtomicUsize, Ordering};\n\n use gloo::utils::document;\n use wasm_bindgen::JsCast;\n use web_sys::HtmlElement;\n\n static CHILD_RENDER_COUNT: AtomicUsize = AtomicUsize::new(0);\n\n #[derive(Properties, PartialEq)]\n struct ChildProps {\n handle: UseStateHandle,\n }\n\n #[component(ChildComponent)]\n fn child_comp(props: &ChildProps) -> Html {\n CHILD_RENDER_COUNT.fetch_add(1, Ordering::Relaxed);\n\n let onclick = {\n let handle = props.handle.clone();\n Callback::from(move |_| {\n handle.set(*handle + 1);\n })\n };\n\n html! {\n
\n \n
{ *props.handle }
\n
\n }\n }\n\n #[component(ParentComponent)]\n fn parent_comp() -> Html {\n let state = use_state(|| 0);\n html! {\n \n }\n }\n\n CHILD_RENDER_COUNT.store(0, Ordering::Relaxed);\n\n yew::Renderer::::with_root(document().get_element_by_id(\"output\").unwrap())\n .render();\n scheduler::flush().await;\n\n // Initial render: child should show 0\n let result = obtain_result();\n assert_eq!(result.as_str(), \"0\");\n assert_eq!(CHILD_RENDER_COUNT.load(Ordering::Relaxed), 1);\n\n // Click the increment button in the child\n document()\n .get_element_by_id(\"child-increment\")\n .unwrap()\n .unchecked_into::()\n .click();\n\n scheduler::flush().await;\n\n // After increment: child should re-render and show 1\n let result = obtain_result();\n assert_eq!(\n result.as_str(),\n \"1\",\n \"Child component must re-render when UseStateHandle prop changes (issue #4058)\"\n );\n assert!(\n CHILD_RENDER_COUNT.load(Ordering::Relaxed) >= 2,\n \"Child must have re-rendered at least twice, but rendered {} times\",\n CHILD_RENDER_COUNT.load(Ordering::Relaxed)\n );\n}\n" }, { "path": "packages/yew/tests/use_transitive_state.rs", "content": "#![cfg(feature = \"hydration\")]\n#![cfg(target_arch = \"wasm32\")]\n\nuse std::time::Duration;\n\nmod common;\n\nuse common::obtain_result_by_id;\nuse wasm_bindgen_test::*;\nuse yew::platform::time::sleep;\nuse yew::prelude::*;\nuse yew::{scheduler, Renderer, ServerRenderer};\n\nwasm_bindgen_test::wasm_bindgen_test_configure!(run_in_browser);\n\n#[wasm_bindgen_test]\nasync fn use_transitive_state_works() {\n #[component]\n fn Comp() -> HtmlResult {\n let ctr = use_transitive_state!((), |_| -> u32 { 12345 })?.unwrap_or_default();\n\n Ok(html! {\n
\n {*ctr}\n
\n })\n }\n\n #[component]\n fn App() -> Html {\n html! {\n \n
\n \n
\n \n }\n }\n\n let s = ServerRenderer::::new().render().await;\n\n assert_eq!(\n s,\n // div text content should be 0 but state should be 12345.\n r#\"
0
\"#\n );\n\n gloo::utils::document()\n .query_selector(\"#output\")\n .unwrap()\n .unwrap()\n .set_inner_html(&s);\n\n scheduler::flush().await;\n\n Renderer::::with_root(gloo::utils::document().get_element_by_id(\"output\").unwrap())\n .hydrate();\n\n sleep(Duration::from_millis(200)).await;\n\n let result = obtain_result_by_id(\"output\");\n\n // no placeholders, hydration is successful and div text content now becomes 12345.\n assert_eq!(result, r#\"
12345
\"#);\n}\n" }, { "path": "packages/yew-agent/Cargo.toml", "content": "[package]\nname = \"yew-agent\"\nversion = \"0.5.0\"\nauthors = [\"Hamza \"]\nrepository = \"https://github.com/yewstack/yew\"\nhomepage = \"https://yew.rs\"\ndocumentation = \"https://docs.rs/yew/\"\nedition = \"2021\"\nreadme = \"../../README.md\"\ndescription = \"Agents for Yew\"\nlicense = \"MIT OR Apache-2.0\"\nrust-version = \"1.84.0\"\n\n[dependencies]\nyew = { version = \"0.23.0\", path = \"../yew\" }\nwasm-bindgen.workspace = true\njs-sys.workspace = true\npinned = \"0.1.0\"\nthiserror.workspace = true\nbincode = { workspace = true }\nwasm-bindgen-futures.workspace = true\nserde = { workspace = true, features = [\"derive\"] }\nfutures.workspace = true\nyew-agent-macro = { version = \"0.4\", path = \"../yew-agent-macro\" }\n\n[dependencies.web-sys]\nworkspace = true\nfeatures = [\n \"Blob\",\n \"BlobPropertyBag\",\n \"DedicatedWorkerGlobalScope\",\n \"MessageEvent\",\n \"Url\",\n \"Worker\",\n \"WorkerOptions\",\n\t\"WorkerType\"\n]\n\n[dev-dependencies]\nserde = { workspace = true }\n" }, { "path": "packages/yew-agent/README.md", "content": "# Yew Agent\n\nThis module contains Yew's web worker implementation.\n\n## Types\n\nThere're a couple kinds of agents:\n\n### Oneshot\n\nA kind of agent that for each input, a single output is returned.\n\n#### Reactor\n\nA kind of agent that can send many inputs and receive many outputs over a single bridge.\n\n#### Worker\n\nThe low-level implementation of agents that provides an actor model and communicates with\nmultiple bridges.\n\n## Reachability\n\nWhen an agent is spawned, each agent is associated with a reachability.\n\n### Private\n\nEach time a bridge is created, a new instance\nof agent is spawned. This allows parallel computing between agents.\n\n#### Public\n\nPublic agents are shared among all children of a provider.\nOnly 1 instance will be spawned for each public agents provider.\n\n### Provider\n\nEach Agent requires a provider to provide communications and maintain bridges.\nAll hooks must be called within a provider.\n\n## Communications with Agents\n\nHooks provides means to communicate with agent instances.\n\n### Bridge\n\nSee: [`use_worker_bridge`](worker::use_worker_bridge),\n[`use_reactor_bridge`](reactor::use_reactor_bridge)\n\nA bridge takes a callback to receive outputs from agents\nand provides a handle to send inputs to agents.\n\n#### Subscription\n\nSee: [`use_worker_subscription`](worker::use_worker_subscription),\n[`use_reactor_subscription`](reactor::use_reactor_subscription)\n\nSimilar to bridges, a subscription produces a handle to send inputs to agents. However, instead\nof notifying the receiver with a callback, it collect all outputs into a slice.\n\n#### Runner\n\nSee: [`use_oneshot_runner`](oneshot::use_oneshot_runner)\n\nUnlike other agents, oneshot bridges provide a `use_oneshot_runner` hook to execute oneshot\nagents on demand.\n" }, { "path": "packages/yew-agent/src/codec.rs", "content": "//! Submodule providing the `Codec` trait and its default implementation using `bincode`.\n\nuse js_sys::Uint8Array;\nuse serde::{Deserialize, Serialize};\nuse wasm_bindgen::JsValue;\n\n/// Message Encoding and Decoding Format\npub trait Codec {\n /// Encode an input to JsValue\n fn encode(input: I) -> JsValue\n where\n I: Serialize;\n\n /// Decode a message to a type\n fn decode(input: JsValue) -> O\n where\n O: for<'de> Deserialize<'de>;\n}\n\n/// Default message encoding with [bincode].\n#[derive(Debug)]\npub struct Bincode;\n\nimpl Codec for Bincode {\n fn encode(input: I) -> JsValue\n where\n I: Serialize,\n {\n let buf = bincode::serde::encode_to_vec(&input, bincode::config::standard())\n .expect(\"can't serialize an worker message\");\n Uint8Array::from(buf.as_slice()).into()\n }\n\n fn decode(input: JsValue) -> O\n where\n O: for<'de> Deserialize<'de>,\n {\n let data = Uint8Array::from(input).to_vec();\n let (result, _) = bincode::serde::decode_from_slice(&data, bincode::config::standard())\n .expect(\"can't deserialize an worker message\");\n result\n }\n}\n" }, { "path": "packages/yew-agent/src/lib.rs", "content": "#![doc = include_str!(\"../README.md\")]\n#![deny(\n clippy::all,\n missing_docs,\n missing_debug_implementations,\n bare_trait_objects,\n anonymous_parameters,\n elided_lifetimes_in_paths\n)]\n\nextern crate self as yew_agent;\n\npub mod codec;\npub mod oneshot;\npub mod reactor;\npub mod worker;\npub use codec::{Bincode, Codec};\npub mod traits;\npub use traits::{Registrable, Spawnable};\n\nmod reach;\npub mod scope_ext;\n\npub use reach::Reach;\n\nmod utils;\n\n#[doc(hidden)]\npub mod __vendored {\n pub use futures;\n}\n\npub mod prelude {\n //! Prelude module to be imported when working with `yew-agent`.\n //!\n //! This module re-exports the frequently used types from the crate.\n pub use crate::oneshot::{oneshot, use_oneshot_runner, UseOneshotRunnerHandle};\n pub use crate::reach::Reach;\n pub use crate::reactor::{\n reactor, use_reactor_bridge, use_reactor_subscription, ReactorEvent, ReactorScope,\n UseReactorBridgeHandle, UseReactorSubscriptionHandle,\n };\n pub use crate::scope_ext::{AgentScopeExt, ReactorBridgeHandle, WorkerBridgeHandle};\n pub use crate::worker::{\n use_worker_bridge, use_worker_subscription, UseWorkerBridgeHandle,\n UseWorkerSubscriptionHandle, WorkerScope,\n };\n pub use crate::{Registrable, Spawnable};\n}\n" }, { "path": "packages/yew-agent/src/oneshot/bridge.rs", "content": "use futures::stream::StreamExt;\nuse pinned::mpsc;\nuse pinned::mpsc::UnboundedReceiver;\n\nuse super::traits::Oneshot;\nuse super::worker::OneshotWorker;\nuse crate::codec::Codec;\nuse crate::worker::{WorkerBridge, WorkerSpawner};\n\n/// A connection manager for components interaction with oneshot workers.\n#[derive(Debug)]\npub struct OneshotBridge\nwhere\n N: Oneshot + 'static,\n{\n inner: WorkerBridge>,\n rx: UnboundedReceiver,\n}\n\nimpl OneshotBridge\nwhere\n N: Oneshot + 'static,\n{\n #[inline(always)]\n pub(crate) fn new(\n inner: WorkerBridge>,\n rx: UnboundedReceiver,\n ) -> Self {\n Self { inner, rx }\n }\n\n #[inline(always)]\n pub(crate) fn register_callback(\n spawner: &mut WorkerSpawner, CODEC>,\n ) -> UnboundedReceiver\n where\n CODEC: Codec,\n {\n let (tx, rx) = mpsc::unbounded();\n spawner.callback(move |output| {\n let _ = tx.send_now(output);\n });\n\n rx\n }\n\n /// Forks the bridge.\n ///\n /// This method creates a new bridge that can be used to execute tasks on the same worker\n /// instance.\n pub fn fork(&self) -> Self {\n let (tx, rx) = mpsc::unbounded();\n let inner = self.inner.fork(Some(move |output| {\n let _ = tx.send_now(output);\n }));\n\n Self { inner, rx }\n }\n\n /// Run the current oneshot worker once in the current worker instance.\n pub async fn run(&mut self, input: N::Input) -> N::Output {\n // &mut self guarantees that the bridge will be\n // exclusively borrowed during the time the oneshot worker is running.\n self.inner.send(input);\n\n // For each bridge, there can only be 1 active task running on the worker instance.\n // The next output will be the output for the input that we just sent.\n self.rx\n .next()\n .await\n .expect(\"failed to receive result from worker\")\n }\n}\n" }, { "path": "packages/yew-agent/src/oneshot/hooks.rs", "content": "use yew::prelude::*;\n\nuse super::provider::OneshotProviderState;\nuse super::Oneshot;\n\n/// Hook handle for [`use_oneshot_runner`]\n#[derive(Debug)]\npub struct UseOneshotRunnerHandle\nwhere\n T: Oneshot + 'static,\n{\n state: OneshotProviderState,\n}\n\nimpl UseOneshotRunnerHandle\nwhere\n T: Oneshot + 'static,\n{\n /// Runs an oneshot agent.\n pub async fn run(&self, input: T::Input) -> T::Output {\n self.state.create_bridge().run(input).await\n }\n}\n\nimpl Clone for UseOneshotRunnerHandle\nwhere\n T: Oneshot + 'static,\n{\n fn clone(&self) -> Self {\n Self {\n state: self.state.clone(),\n }\n }\n}\n\nimpl PartialEq for UseOneshotRunnerHandle\nwhere\n T: Oneshot,\n{\n fn eq(&self, rhs: &Self) -> bool {\n self.state == rhs.state\n }\n}\n\n/// A hook to create a runner to an oneshot agent.\n#[hook]\npub fn use_oneshot_runner() -> UseOneshotRunnerHandle\nwhere\n T: Oneshot + 'static,\n{\n let state = use_context::>().expect(\"failed to find worker context\");\n\n UseOneshotRunnerHandle { state }\n}\n" }, { "path": "packages/yew-agent/src/oneshot/mod.rs", "content": "//! This module provides task agent implementation.\n\nmod bridge;\nmod hooks;\nmod provider;\nmod registrar;\nmod spawner;\nmod traits;\nmod worker;\n\npub use bridge::OneshotBridge;\npub use hooks::{use_oneshot_runner, UseOneshotRunnerHandle};\npub use provider::OneshotProvider;\npub(crate) use provider::OneshotProviderState;\npub use registrar::OneshotRegistrar;\npub use spawner::OneshotSpawner;\npub use traits::Oneshot;\n/// A procedural macro to create oneshot agents.\npub use yew_agent_macro::oneshot;\n" }, { "path": "packages/yew-agent/src/oneshot/provider.rs", "content": "use core::fmt;\nuse std::any::type_name;\nuse std::cell::RefCell;\nuse std::rc::Rc;\n\nuse serde::{Deserialize, Serialize};\nuse yew::prelude::*;\n\nuse super::{Oneshot, OneshotBridge, OneshotSpawner};\nuse crate::utils::get_next_id;\nuse crate::worker::WorkerProviderProps;\nuse crate::{Bincode, Codec, Reach};\n\npub(crate) struct OneshotProviderState\nwhere\n T: Oneshot + 'static,\n{\n id: usize,\n spawn_bridge_fn: Rc OneshotBridge>,\n reach: Reach,\n held_bridge: Rc>>>,\n}\n\nimpl fmt::Debug for OneshotProviderState\nwhere\n T: Oneshot,\n{\n fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {\n f.write_str(type_name::())\n }\n}\n\nimpl OneshotProviderState\nwhere\n T: Oneshot,\n{\n fn get_held_bridge(&self) -> OneshotBridge {\n let mut held_bridge = self.held_bridge.borrow_mut();\n\n match held_bridge.as_mut() {\n Some(m) => m.fork(),\n None => {\n let bridge = (self.spawn_bridge_fn)();\n *held_bridge = Some(bridge.fork());\n bridge\n }\n }\n }\n\n /// Creates a bridge, uses \"fork\" for public agents.\n pub fn create_bridge(&self) -> OneshotBridge {\n match self.reach {\n Reach::Public => {\n let held_bridge = self.get_held_bridge();\n held_bridge.fork()\n }\n Reach::Private => (self.spawn_bridge_fn)(),\n }\n }\n}\n\nimpl Clone for OneshotProviderState\nwhere\n T: Oneshot,\n{\n fn clone(&self) -> Self {\n Self {\n id: self.id,\n spawn_bridge_fn: self.spawn_bridge_fn.clone(),\n reach: self.reach,\n held_bridge: self.held_bridge.clone(),\n }\n }\n}\n\nimpl PartialEq for OneshotProviderState\nwhere\n T: Oneshot,\n{\n fn eq(&self, rhs: &Self) -> bool {\n self.id == rhs.id\n }\n}\n\n/// The Oneshot Agent Provider.\n///\n/// This component provides its children access to an oneshot agent.\n#[component]\npub fn OneshotProvider(props: &WorkerProviderProps) -> Html\nwhere\n T: Oneshot + 'static,\n T::Input: Serialize + for<'de> Deserialize<'de> + 'static,\n T::Output: Serialize + for<'de> Deserialize<'de> + 'static,\n C: Codec + 'static,\n{\n let WorkerProviderProps {\n children,\n path,\n lazy,\n module,\n reach,\n } = props.clone();\n\n // Creates a spawning function so Codec is can be erased from contexts.\n let spawn_bridge_fn: Rc OneshotBridge> = {\n let path = path.clone();\n Rc::new(move || {\n OneshotSpawner::::new()\n .as_module(module)\n .encoding::()\n .spawn(&path)\n })\n };\n\n let state = {\n use_memo((path, lazy, reach), move |(_path, lazy, reach)| {\n let state = OneshotProviderState:: {\n id: get_next_id(),\n spawn_bridge_fn,\n reach: *reach,\n held_bridge: Rc::default(),\n };\n\n if *reach == Reach::Public && !*lazy {\n state.get_held_bridge();\n }\n state\n })\n };\n\n html! {\n > context={(*state).clone()}>\n {children}\n >>\n }\n}\n" }, { "path": "packages/yew-agent/src/oneshot/registrar.rs", "content": "use std::fmt;\n\nuse serde::de::Deserialize;\nuse serde::ser::Serialize;\n\nuse super::traits::Oneshot;\nuse super::worker::OneshotWorker;\nuse crate::codec::{Bincode, Codec};\nuse crate::traits::Registrable;\nuse crate::worker::WorkerRegistrar;\n\n/// A registrar for oneshot workers.\npub struct OneshotRegistrar\nwhere\n T: Oneshot + 'static,\n CODEC: Codec + 'static,\n{\n inner: WorkerRegistrar, CODEC>,\n}\n\nimpl Default for OneshotRegistrar\nwhere\n T: Oneshot + 'static,\n CODEC: Codec + 'static,\n{\n fn default() -> Self {\n Self::new()\n }\n}\n\nimpl OneshotRegistrar\nwhere\n N: Oneshot + 'static,\n CODEC: Codec + 'static,\n{\n /// Creates a new Oneshot Registrar.\n pub fn new() -> Self {\n Self {\n inner: OneshotWorker::::registrar().encoding::(),\n }\n }\n\n /// Sets the encoding.\n pub fn encoding(&self) -> OneshotRegistrar\n where\n C: Codec + 'static,\n {\n OneshotRegistrar {\n inner: self.inner.encoding::(),\n }\n }\n\n /// Registers the worker.\n pub fn register(&self)\n where\n N::Input: Serialize + for<'de> Deserialize<'de>,\n N::Output: Serialize + for<'de> Deserialize<'de>,\n {\n self.inner.register()\n }\n}\n\nimpl fmt::Debug for OneshotRegistrar\nwhere\n T: Oneshot + 'static,\n CODEC: Codec + 'static,\n{\n fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {\n f.debug_struct(\"OneshotRegistrar<_>\").finish()\n }\n}\n" }, { "path": "packages/yew-agent/src/oneshot/spawner.rs", "content": "use serde::de::Deserialize;\nuse serde::ser::Serialize;\n\nuse super::bridge::OneshotBridge;\nuse super::traits::Oneshot;\nuse super::worker::OneshotWorker;\nuse crate::codec::{Bincode, Codec};\nuse crate::worker::WorkerSpawner;\n\n/// A spawner to create oneshot workers.\n#[derive(Debug, Default)]\npub struct OneshotSpawner\nwhere\n N: Oneshot + 'static,\n CODEC: Codec,\n{\n inner: WorkerSpawner, CODEC>,\n}\n\nimpl OneshotSpawner\nwhere\n N: Oneshot + 'static,\n CODEC: Codec,\n{\n /// Creates a [OneshotSpawner].\n pub const fn new() -> Self {\n Self {\n inner: WorkerSpawner::, CODEC>::new(),\n }\n }\n\n /// Sets a new message encoding.\n pub const fn encoding(&self) -> OneshotSpawner\n where\n C: Codec,\n {\n OneshotSpawner {\n inner: WorkerSpawner::, C>::new(),\n }\n }\n\n /// Indicates that [`spawn`](WorkerSpawner#method.spawn) should expect a\n /// `path` to a loader shim script (e.g. when using Trunk, created by using\n /// the [`data-loader-shim`](https://trunkrs.dev/assets/#link-asset-types)\n /// asset type) and one does not need to be generated. `false` by default.\n pub fn with_loader(mut self, with_loader: bool) -> Self {\n self.inner.with_loader(with_loader);\n self\n }\n\n /// Determines whether the worker will be spawned with\n /// [`options.type`](https://developer.mozilla.org/en-US/docs/Web/API/Worker/Worker#type)\n /// set to `module`. `true` by default.\n ///\n /// This option should be un-set if the worker was created with the\n /// `--target no-modules` flag of `wasm-bindgen`. If using Trunk, see the\n /// [`data-bindgen-target`](https://trunkrs.dev/assets/#link-asset-types)\n /// asset type.\n pub fn as_module(mut self, as_module: bool) -> Self {\n self.inner.as_module(as_module);\n\n self\n }\n\n /// Spawns a Oneshot Worker.\n pub fn spawn(mut self, path: &str) -> OneshotBridge\n where\n N::Input: Serialize + for<'de> Deserialize<'de>,\n N::Output: Serialize + for<'de> Deserialize<'de>,\n {\n let rx = OneshotBridge::register_callback(&mut self.inner);\n\n let inner = self.inner.spawn(path);\n\n OneshotBridge::new(inner, rx)\n }\n}\n" }, { "path": "packages/yew-agent/src/oneshot/traits.rs", "content": "use std::future::Future;\n\n/// A future-based worker that for each input, one output is produced.\npub trait Oneshot: Future {\n /// Incoming message type.\n type Input;\n\n /// Creates an oneshot worker.\n fn create(input: Self::Input) -> Self;\n}\n" }, { "path": "packages/yew-agent/src/oneshot/worker.rs", "content": "use super::traits::Oneshot;\nuse crate::worker::{HandlerId, Worker, WorkerDestroyHandle, WorkerScope};\n\npub(crate) enum Message\nwhere\n T: Oneshot,\n{\n Finished {\n handler_id: HandlerId,\n output: T::Output,\n },\n}\n\npub(crate) struct OneshotWorker\nwhere\n T: 'static + Oneshot,\n{\n running_tasks: usize,\n destruct_handle: Option>,\n}\n\nimpl Worker for OneshotWorker\nwhere\n T: 'static + Oneshot,\n{\n type Input = T::Input;\n type Message = Message;\n type Output = T::Output;\n\n fn create(_scope: &WorkerScope) -> Self {\n Self {\n running_tasks: 0,\n destruct_handle: None,\n }\n }\n\n fn update(&mut self, scope: &WorkerScope, msg: Self::Message) {\n let Message::Finished { handler_id, output } = msg;\n\n self.running_tasks -= 1;\n\n scope.respond(handler_id, output);\n\n if self.running_tasks == 0 {\n self.destruct_handle = None;\n }\n }\n\n fn received(&mut self, scope: &WorkerScope, input: Self::Input, handler_id: HandlerId) {\n self.running_tasks += 1;\n\n scope.send_future(async move {\n let output = T::create(input).await;\n\n Message::Finished { handler_id, output }\n });\n }\n\n fn destroy(&mut self, _scope: &WorkerScope, destruct: WorkerDestroyHandle) {\n if self.running_tasks > 0 {\n self.destruct_handle = Some(destruct);\n }\n }\n}\n" }, { "path": "packages/yew-agent/src/reach.rs", "content": "/// The reachability of an agent.\n#[derive(Debug, Clone, PartialEq, Eq, Hash, Copy)]\npub enum Reach {\n /// Public Reachability.\n Public,\n /// Private Reachability.\n Private,\n}\n" }, { "path": "packages/yew-agent/src/reactor/bridge.rs", "content": "use std::fmt;\nuse std::pin::Pin;\nuse std::task::{Context, Poll};\n\nuse futures::sink::Sink;\nuse futures::stream::{FusedStream, Stream};\nuse pinned::mpsc;\nuse pinned::mpsc::{UnboundedReceiver, UnboundedSender};\nuse thiserror::Error;\n\nuse super::messages::{ReactorInput, ReactorOutput};\nuse super::scope::ReactorScoped;\nuse super::traits::Reactor;\nuse super::worker::ReactorWorker;\nuse crate::worker::{WorkerBridge, WorkerSpawner};\nuse crate::Codec;\n\n/// A connection manager for components interaction with oneshot workers.\n///\n/// As this type implements [Stream] + [Sink], it can be split with [`StreamExt::split`].\npub struct ReactorBridge\nwhere\n R: Reactor + 'static,\n{\n inner: WorkerBridge>,\n rx: UnboundedReceiver<::Output>,\n}\n\nimpl fmt::Debug for ReactorBridge\nwhere\n R: Reactor,\n{\n fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {\n f.write_str(\"ReactorBridge<_>\")\n }\n}\n\nimpl ReactorBridge\nwhere\n R: Reactor + 'static,\n{\n #[inline(always)]\n pub(crate) fn new(\n inner: WorkerBridge>,\n rx: UnboundedReceiver<::Output>,\n ) -> Self {\n Self { inner, rx }\n }\n\n pub(crate) fn output_callback(\n tx: &UnboundedSender<::Output>,\n output: ReactorOutput<::Output>,\n ) {\n match output {\n ReactorOutput::Output(m) => {\n let _ = tx.send_now(m);\n }\n ReactorOutput::Finish => {\n tx.close_now();\n }\n }\n }\n\n #[inline(always)]\n pub(crate) fn register_callback(\n spawner: &mut WorkerSpawner, CODEC>,\n ) -> UnboundedReceiver<::Output>\n where\n CODEC: Codec,\n {\n let (tx, rx) = mpsc::unbounded();\n spawner.callback(move |output| Self::output_callback(&tx, output));\n\n rx\n }\n\n /// Forks the bridge.\n ///\n /// This method creates a new bridge connected to a new reactor on the same worker instance.\n pub fn fork(&self) -> Self {\n let (tx, rx) = mpsc::unbounded();\n let inner = self\n .inner\n .fork(Some(move |output| Self::output_callback(&tx, output)));\n\n Self { inner, rx }\n }\n\n /// Sends an input to the current reactor.\n pub fn send_input(&self, msg: ::Input) {\n self.inner.send(ReactorInput::Input(msg));\n }\n}\n\nimpl Stream for ReactorBridge\nwhere\n R: Reactor + 'static,\n{\n type Item = ::Output;\n\n fn poll_next(mut self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll> {\n Pin::new(&mut self.rx).poll_next(cx)\n }\n\n fn size_hint(&self) -> (usize, Option) {\n self.rx.size_hint()\n }\n}\n\nimpl FusedStream for ReactorBridge\nwhere\n R: Reactor + 'static,\n{\n fn is_terminated(&self) -> bool {\n self.rx.is_terminated()\n }\n}\n\n/// An error type for bridge sink.\n#[derive(Error, Clone, PartialEq, Eq, Debug)]\npub enum ReactorBridgeSinkError {\n /// A bridge is an RAII Guard, it can only be closed by dropping the value.\n #[error(\"attempting to close the bridge via the sink\")]\n AttemptClosure,\n}\n\nimpl Sink<::Input> for ReactorBridge\nwhere\n R: Reactor + 'static,\n{\n type Error = ReactorBridgeSinkError;\n\n fn poll_close(self: Pin<&mut Self>, _cx: &mut Context<'_>) -> Poll> {\n Poll::Ready(Err(ReactorBridgeSinkError::AttemptClosure))\n }\n\n fn poll_flush(self: Pin<&mut Self>, _cx: &mut Context<'_>) -> Poll> {\n Poll::Ready(Ok(()))\n }\n\n fn poll_ready(self: Pin<&mut Self>, _cx: &mut Context<'_>) -> Poll> {\n Poll::Ready(Ok(()))\n }\n\n fn start_send(\n self: Pin<&mut Self>,\n item: ::Input,\n ) -> Result<(), Self::Error> {\n self.send_input(item);\n\n Ok(())\n }\n}\n" }, { "path": "packages/yew-agent/src/reactor/hooks.rs", "content": "use std::any::type_name;\nuse std::fmt;\nuse std::ops::Deref;\nuse std::rc::Rc;\n\nuse futures::sink::SinkExt;\nuse futures::stream::{SplitSink, StreamExt};\nuse wasm_bindgen::UnwrapThrowExt;\nuse yew::platform::pinned::RwLock;\nuse yew::platform::spawn_local;\nuse yew::prelude::*;\n\nuse super::provider::ReactorProviderState;\nuse super::{Reactor, ReactorBridge, ReactorScoped};\nuse crate::utils::{BridgeIdState, OutputsAction, OutputsState};\n\ntype ReactorTx =\n Rc, <::Scope as ReactorScoped>::Input>>>;\n\n/// A type that represents events from a reactor.\npub enum ReactorEvent\nwhere\n R: Reactor,\n{\n /// The reactor agent has sent an output.\n Output(::Output),\n /// The reactor agent has exited.\n Finished,\n}\n\nimpl fmt::Debug for ReactorEvent\nwhere\n R: Reactor,\n ::Output: fmt::Debug,\n{\n fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {\n match self {\n Self::Output(m) => f.debug_tuple(\"ReactorEvent::Output\").field(&m).finish(),\n Self::Finished => f.debug_tuple(\"ReactorEvent::Finished\").finish(),\n }\n }\n}\n\n/// Hook handle for the [`use_reactor_bridge`] hook.\npub struct UseReactorBridgeHandle\nwhere\n R: 'static + Reactor,\n{\n tx: ReactorTx,\n ctr: UseReducerDispatcher,\n}\n\nimpl fmt::Debug for UseReactorBridgeHandle\nwhere\n R: 'static + Reactor,\n ::Input: fmt::Debug,\n{\n fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {\n f.debug_struct(type_name::())\n .field(\"inner\", &self.tx)\n .finish()\n }\n}\n\nimpl Clone for UseReactorBridgeHandle\nwhere\n R: 'static + Reactor,\n{\n fn clone(&self) -> Self {\n Self {\n tx: self.tx.clone(),\n ctr: self.ctr.clone(),\n }\n }\n}\n\nimpl UseReactorBridgeHandle\nwhere\n R: 'static + Reactor,\n{\n /// Send an input to a reactor agent.\n pub fn send(&self, msg: ::Input) {\n let tx = self.tx.clone();\n spawn_local(async move {\n let mut tx = tx.write().await;\n let _ = tx.send(msg).await;\n });\n }\n\n /// Reset the bridge.\n ///\n /// Disconnect the old bridge and re-connects the agent with a new bridge.\n pub fn reset(&self) {\n self.ctr.dispatch(());\n }\n}\n\nimpl PartialEq for UseReactorBridgeHandle\nwhere\n R: 'static + Reactor,\n{\n fn eq(&self, rhs: &Self) -> bool {\n self.ctr == rhs.ctr\n }\n}\n\n/// A hook to bridge to a [`Reactor`].\n///\n/// This hooks will only bridge the reactor once over the entire component lifecycle.\n///\n/// Takes a callback as the argument.\n///\n/// The callback will be updated on every render to make sure captured values (if any) are up to\n/// date.\n#[hook]\npub fn use_reactor_bridge(on_output: F) -> UseReactorBridgeHandle\nwhere\n R: 'static + Reactor,\n F: Fn(ReactorEvent) + 'static,\n{\n let ctr = use_reducer(BridgeIdState::default);\n\n let worker_state = use_context::>()\n .expect_throw(\"cannot find a provider for current agent.\");\n\n let on_output = Rc::new(on_output);\n\n let on_output_ref = {\n let on_output = on_output.clone();\n use_mut_ref(move || on_output)\n };\n\n // Refresh the callback on every render.\n {\n let mut on_output_ref = on_output_ref.borrow_mut();\n *on_output_ref = on_output;\n }\n\n let tx = use_memo((worker_state, ctr.inner), |(state, _ctr)| {\n let bridge = state.create_bridge();\n\n let (tx, mut rx) = bridge.split();\n\n spawn_local(async move {\n while let Some(m) = rx.next().await {\n let on_output = on_output_ref.borrow().clone();\n on_output(ReactorEvent::::Output(m));\n }\n\n let on_output = on_output_ref.borrow().clone();\n on_output(ReactorEvent::::Finished);\n });\n\n RwLock::new(tx)\n });\n\n UseReactorBridgeHandle {\n tx: tx.clone(),\n ctr: ctr.dispatcher(),\n }\n}\n\n/// Hook handle for the [`use_reactor_subscription`] hook.\npub struct UseReactorSubscriptionHandle\nwhere\n R: 'static + Reactor,\n{\n bridge: UseReactorBridgeHandle,\n outputs: Vec::Output>>,\n finished: bool,\n ctr: usize,\n}\n\nimpl UseReactorSubscriptionHandle\nwhere\n R: 'static + Reactor,\n{\n /// Send an input to a reactor agent.\n pub fn send(&self, msg: ::Input) {\n self.bridge.send(msg);\n }\n\n /// Returns whether the current bridge has received a finish message.\n pub fn finished(&self) -> bool {\n self.finished\n }\n\n /// Reset the subscription.\n ///\n /// This disconnects the old bridge and re-connects the agent with a new bridge.\n /// Existing outputs stored in the subscription will also be cleared.\n pub fn reset(&self) {\n self.bridge.reset();\n }\n}\n\nimpl Clone for UseReactorSubscriptionHandle\nwhere\n R: 'static + Reactor,\n{\n fn clone(&self) -> Self {\n Self {\n bridge: self.bridge.clone(),\n outputs: self.outputs.clone(),\n ctr: self.ctr,\n finished: self.finished,\n }\n }\n}\n\nimpl fmt::Debug for UseReactorSubscriptionHandle\nwhere\n R: 'static + Reactor,\n ::Input: fmt::Debug,\n ::Output: fmt::Debug,\n{\n fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {\n f.debug_struct(type_name::())\n .field(\"bridge\", &self.bridge)\n .field(\"outputs\", &self.outputs)\n .finish()\n }\n}\n\nimpl Deref for UseReactorSubscriptionHandle\nwhere\n R: 'static + Reactor,\n{\n type Target = [Rc<::Output>];\n\n fn deref(&self) -> &Self::Target {\n &self.outputs\n }\n}\n\nimpl PartialEq for UseReactorSubscriptionHandle\nwhere\n R: 'static + Reactor,\n{\n fn eq(&self, rhs: &Self) -> bool {\n self.bridge == rhs.bridge && self.ctr == rhs.ctr\n }\n}\n\n/// A hook to subscribe to the outputs of a [Reactor] agent.\n///\n/// All outputs sent to current bridge will be collected into a slice.\n#[hook]\npub fn use_reactor_subscription() -> UseReactorSubscriptionHandle\nwhere\n R: 'static + Reactor,\n{\n let outputs = use_reducer(OutputsState::<::Output>::default);\n\n let bridge = {\n let outputs = outputs.clone();\n use_reactor_bridge::(move |output| {\n outputs.dispatch(match output {\n ReactorEvent::Output(m) => OutputsAction::Push(m.into()),\n ReactorEvent::Finished => OutputsAction::Close,\n })\n })\n };\n\n {\n let outputs = outputs.clone();\n use_effect_with(bridge.clone(), move |_| {\n outputs.dispatch(OutputsAction::Reset);\n\n || {}\n });\n }\n\n UseReactorSubscriptionHandle {\n bridge,\n outputs: outputs.inner.clone(),\n ctr: outputs.ctr,\n finished: outputs.closed,\n }\n}\n" }, { "path": "packages/yew-agent/src/reactor/messages.rs", "content": "use serde::{Deserialize, Serialize};\n\n/// The Bridge Input.\n#[derive(Debug, Serialize, Deserialize)]\npub(crate) enum ReactorInput {\n /// An input message.\n Input(I),\n}\n\n/// The Bridge Output.\n#[derive(Debug, Serialize, Deserialize)]\npub enum ReactorOutput {\n /// An output message has been received.\n Output(O),\n /// Reactor for current bridge has exited.\n Finish,\n}\n" }, { "path": "packages/yew-agent/src/reactor/mod.rs", "content": "//! This module contains the reactor agent implementation.\n//!\n//! Reactor agents are agents that receive multiple inputs and send multiple outputs over a single\n//! bridge. A reactor is defined as an async function that takes a [ReactorScope]\n//! as the argument.\n//!\n//! The reactor scope is a stream that produces inputs from the bridge and a\n//! sink that implements an additional send method to send outputs to the connected bridge.\n//! When the bridge disconnects, the output stream and input sink will be closed.\n//!\n//! # Example\n//!\n//! ```\n//! # use serde::{Serialize, Deserialize};\n//! # #[derive(Serialize, Deserialize)]\n//! # pub struct ReactorInput {}\n//! # #[derive(Serialize, Deserialize)]\n//! # pub struct ReactorOutput {}\n//! #\n//! use futures::sink::SinkExt;\n//! use futures::stream::StreamExt;\n//! use yew_agent::reactor::{reactor, ReactorScope};\n//! #[reactor(MyReactor)]\n//! pub async fn my_reactor(mut scope: ReactorScope) {\n//! while let Some(input) = scope.next().await {\n//! // handles each input.\n//! // ...\n//! # let output = ReactorOutput { /* ... */ };\n//!\n//! // sends output\n//! if scope.send(output).await.is_err() {\n//! // sender closed, the bridge is disconnected\n//! break;\n//! }\n//! }\n//! }\n//! ```\n\nmod bridge;\nmod hooks;\nmod messages;\nmod provider;\nmod registrar;\nmod scope;\nmod spawner;\nmod traits;\nmod worker;\n\npub use bridge::{ReactorBridge, ReactorBridgeSinkError};\npub use hooks::{\n use_reactor_bridge, use_reactor_subscription, ReactorEvent, UseReactorBridgeHandle,\n UseReactorSubscriptionHandle,\n};\npub use provider::ReactorProvider;\npub(crate) use provider::ReactorProviderState;\npub use registrar::ReactorRegistrar;\npub use scope::{ReactorScope, ReactorScoped};\npub use spawner::ReactorSpawner;\npub use traits::Reactor;\n/// A procedural macro to create reactor agents.\npub use yew_agent_macro::reactor;\n" }, { "path": "packages/yew-agent/src/reactor/provider.rs", "content": "use std::any::type_name;\nuse std::cell::RefCell;\nuse std::fmt;\nuse std::rc::Rc;\n\nuse serde::{Deserialize, Serialize};\nuse yew::prelude::*;\n\nuse super::{Reactor, ReactorBridge, ReactorScoped, ReactorSpawner};\nuse crate::utils::get_next_id;\nuse crate::worker::WorkerProviderProps;\nuse crate::{Bincode, Codec, Reach};\n\npub(crate) struct ReactorProviderState\nwhere\n T: Reactor + 'static,\n{\n id: usize,\n spawn_bridge_fn: Rc ReactorBridge>,\n reach: Reach,\n held_bridge: Rc>>>,\n}\n\nimpl fmt::Debug for ReactorProviderState\nwhere\n T: Reactor,\n{\n fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {\n f.write_str(type_name::())\n }\n}\n\nimpl ReactorProviderState\nwhere\n T: Reactor,\n{\n fn get_held_bridge(&self) -> ReactorBridge {\n let mut held_bridge = self.held_bridge.borrow_mut();\n\n match held_bridge.as_mut() {\n Some(m) => m.fork(),\n None => {\n let bridge = (self.spawn_bridge_fn)();\n *held_bridge = Some(bridge.fork());\n bridge\n }\n }\n }\n\n /// Creates a bridge, uses \"fork\" for public agents.\n pub fn create_bridge(&self) -> ReactorBridge {\n match self.reach {\n Reach::Public => {\n let held_bridge = self.get_held_bridge();\n held_bridge.fork()\n }\n Reach::Private => (self.spawn_bridge_fn)(),\n }\n }\n}\n\nimpl Clone for ReactorProviderState\nwhere\n T: Reactor,\n{\n fn clone(&self) -> Self {\n Self {\n id: self.id,\n spawn_bridge_fn: self.spawn_bridge_fn.clone(),\n reach: self.reach,\n held_bridge: self.held_bridge.clone(),\n }\n }\n}\n\nimpl PartialEq for ReactorProviderState\nwhere\n T: Reactor,\n{\n fn eq(&self, rhs: &Self) -> bool {\n self.id == rhs.id\n }\n}\n\n/// The Reactor Agent Provider.\n///\n/// This component provides its children access to a reactor agent.\n#[component]\npub fn ReactorProvider(props: &WorkerProviderProps) -> Html\nwhere\n R: 'static + Reactor,\n <::Scope as ReactorScoped>::Input:\n Serialize + for<'de> Deserialize<'de> + 'static,\n <::Scope as ReactorScoped>::Output:\n Serialize + for<'de> Deserialize<'de> + 'static,\n C: Codec + 'static,\n{\n let WorkerProviderProps {\n children,\n path,\n lazy,\n module,\n reach,\n } = props.clone();\n\n // Creates a spawning function so Codec is can be erased from contexts.\n let spawn_bridge_fn: Rc ReactorBridge> = {\n let path = path.clone();\n Rc::new(move || {\n ReactorSpawner::::new()\n .as_module(module)\n .encoding::()\n .spawn(&path)\n })\n };\n\n let state = {\n use_memo((path, lazy, reach), move |(_path, lazy, reach)| {\n let state = ReactorProviderState:: {\n id: get_next_id(),\n spawn_bridge_fn,\n reach: *reach,\n held_bridge: Rc::default(),\n };\n\n if *reach == Reach::Public && !*lazy {\n state.get_held_bridge();\n }\n state\n })\n };\n\n html! {\n > context={(*state).clone()}>\n {children}\n >>\n }\n}\n" }, { "path": "packages/yew-agent/src/reactor/registrar.rs", "content": "use std::fmt;\n\nuse serde::de::Deserialize;\nuse serde::ser::Serialize;\n\nuse super::scope::ReactorScoped;\nuse super::traits::Reactor;\nuse super::worker::ReactorWorker;\nuse crate::codec::{Bincode, Codec};\nuse crate::traits::Registrable;\nuse crate::worker::WorkerRegistrar;\n\n/// A registrar for reactor workers.\npub struct ReactorRegistrar\nwhere\n R: Reactor + 'static,\n CODEC: Codec + 'static,\n{\n inner: WorkerRegistrar, CODEC>,\n}\n\nimpl Default for ReactorRegistrar\nwhere\n R: Reactor + 'static,\n CODEC: Codec + 'static,\n{\n fn default() -> Self {\n Self::new()\n }\n}\n\nimpl ReactorRegistrar\nwhere\n R: Reactor + 'static,\n CODEC: Codec + 'static,\n{\n /// Creates a new reactor registrar.\n pub fn new() -> Self {\n Self {\n inner: ReactorWorker::::registrar().encoding::(),\n }\n }\n\n /// Sets the encoding.\n pub fn encoding(&self) -> ReactorRegistrar\n where\n C: Codec + 'static,\n {\n ReactorRegistrar {\n inner: self.inner.encoding::(),\n }\n }\n\n /// Registers the worker.\n pub fn register(&self)\n where\n ::Input: Serialize + for<'de> Deserialize<'de>,\n ::Output: Serialize + for<'de> Deserialize<'de>,\n {\n self.inner.register()\n }\n}\n\nimpl fmt::Debug for ReactorRegistrar\nwhere\n R: Reactor + 'static,\n CODEC: Codec + 'static,\n{\n fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {\n f.debug_struct(\"ReactorRegistrar<_>\").finish()\n }\n}\n" }, { "path": "packages/yew-agent/src/reactor/scope.rs", "content": "use std::convert::Infallible;\nuse std::fmt;\nuse std::pin::Pin;\n\nuse futures::stream::{FusedStream, Stream};\nuse futures::task::{Context, Poll};\nuse futures::Sink;\n\n/// A handle to communicate with bridges.\npub struct ReactorScope {\n input_stream: Pin>>,\n output_sink: Pin>>,\n}\n\nimpl fmt::Debug for ReactorScope {\n fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {\n f.debug_struct(\"ReactorScope<_>\").finish()\n }\n}\n\nimpl Stream for ReactorScope {\n type Item = I;\n\n #[inline(always)]\n fn poll_next(mut self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll> {\n Pin::new(&mut self.input_stream).poll_next(cx)\n }\n\n #[inline(always)]\n fn size_hint(&self) -> (usize, Option) {\n self.input_stream.size_hint()\n }\n}\n\nimpl FusedStream for ReactorScope {\n #[inline(always)]\n fn is_terminated(&self) -> bool {\n self.input_stream.is_terminated()\n }\n}\n\n/// A helper trait to extract the input and output type from a [ReactorStream].\npub trait ReactorScoped: Stream + FusedStream {\n /// The Input Message.\n type Input;\n /// The Output Message.\n type Output;\n\n /// Creates a ReactorReceiver.\n fn new(input_stream: IS, output_sink: OS) -> Self\n where\n IS: Stream + FusedStream + 'static,\n OS: Sink + 'static;\n}\n\nimpl ReactorScoped for ReactorScope {\n type Input = I;\n type Output = O;\n\n #[inline]\n fn new(input_stream: IS, output_sink: OS) -> Self\n where\n IS: Stream + FusedStream + 'static,\n OS: Sink + 'static,\n {\n Self {\n input_stream: Box::pin(input_stream),\n output_sink: Box::pin(output_sink),\n }\n }\n}\n\nimpl Sink for ReactorScope {\n type Error = Infallible;\n\n fn start_send(mut self: Pin<&mut Self>, item: O) -> Result<(), Self::Error> {\n Pin::new(&mut self.output_sink).start_send(item)\n }\n\n fn poll_close(mut self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll> {\n Pin::new(&mut self.output_sink).poll_close(cx)\n }\n\n fn poll_flush(mut self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll> {\n Pin::new(&mut self.output_sink).poll_flush(cx)\n }\n\n fn poll_ready(mut self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll> {\n Pin::new(&mut self.output_sink).poll_flush(cx)\n }\n}\n" }, { "path": "packages/yew-agent/src/reactor/spawner.rs", "content": "use serde::de::Deserialize;\nuse serde::ser::Serialize;\n\nuse super::bridge::ReactorBridge;\nuse super::scope::ReactorScoped;\nuse super::traits::Reactor;\nuse super::worker::ReactorWorker;\nuse crate::codec::{Bincode, Codec};\nuse crate::worker::WorkerSpawner;\n\n/// A spawner to create oneshot workers.\n#[derive(Debug, Default)]\npub struct ReactorSpawner\nwhere\n R: Reactor + 'static,\n CODEC: Codec,\n{\n inner: WorkerSpawner, CODEC>,\n}\n\nimpl ReactorSpawner\nwhere\n R: Reactor + 'static,\n CODEC: Codec,\n{\n /// Creates a ReactorSpawner.\n pub const fn new() -> Self {\n Self {\n inner: WorkerSpawner::, CODEC>::new(),\n }\n }\n\n /// Sets a new message encoding.\n pub const fn encoding(&self) -> ReactorSpawner\n where\n C: Codec,\n {\n ReactorSpawner {\n inner: WorkerSpawner::, C>::new(),\n }\n }\n\n /// Indicates that [`spawn`](WorkerSpawner#method.spawn) should expect a\n /// `path` to a loader shim script (e.g. when using Trunk, created by using\n /// the [`data-loader-shim`](https://trunkrs.dev/assets/#link-asset-types)\n /// asset type) and one does not need to be generated. `false` by default.\n pub fn with_loader(mut self, with_loader: bool) -> Self {\n self.inner.with_loader(with_loader);\n self\n }\n\n /// Determines whether the worker will be spawned with\n /// [`options.type`](https://developer.mozilla.org/en-US/docs/Web/API/Worker/Worker#type)\n /// set to `module`. `true` by default.\n ///\n /// This option should be un-set if the worker was created with the\n /// `--target no-modules` flag of `wasm-bindgen`. If using Trunk, see the\n /// [`data-bindgen-target`](https://trunkrs.dev/assets/#link-asset-types)\n /// asset type.\n pub fn as_module(mut self, as_module: bool) -> Self {\n self.inner.as_module(as_module);\n\n self\n }\n\n /// Spawns a reactor worker.\n pub fn spawn(mut self, path: &str) -> ReactorBridge\n where\n ::Input: Serialize + for<'de> Deserialize<'de>,\n ::Output: Serialize + for<'de> Deserialize<'de>,\n {\n let rx = ReactorBridge::register_callback(&mut self.inner);\n\n let inner = self.inner.spawn(path);\n\n ReactorBridge::new(inner, rx)\n }\n}\n" }, { "path": "packages/yew-agent/src/reactor/traits.rs", "content": "use std::future::Future;\n\nuse super::scope::ReactorScoped;\n\n/// A reactor worker.\npub trait Reactor: Future {\n /// The Reactor Scope\n type Scope: ReactorScoped;\n\n /// Creates a reactor worker.\n fn create(scope: Self::Scope) -> Self;\n}\n" }, { "path": "packages/yew-agent/src/reactor/worker.rs", "content": "use std::collections::HashMap;\nuse std::convert::Infallible;\n\nuse futures::sink;\nuse futures::stream::StreamExt;\nuse pinned::mpsc;\nuse pinned::mpsc::UnboundedSender;\nuse wasm_bindgen_futures::spawn_local;\n\nuse super::messages::{ReactorInput, ReactorOutput};\nuse super::scope::ReactorScoped;\nuse super::traits::Reactor;\nuse crate::worker::{HandlerId, Worker, WorkerDestroyHandle, WorkerScope};\n\npub(crate) enum Message {\n ReactorExited(HandlerId),\n}\n\npub(crate) struct ReactorWorker\nwhere\n R: 'static + Reactor,\n{\n senders: HashMap::Input>>,\n destruct_handle: Option>,\n}\n\nimpl Worker for ReactorWorker\nwhere\n R: 'static + Reactor,\n{\n type Input = ReactorInput<::Input>;\n type Message = Message;\n type Output = ReactorOutput<::Output>;\n\n fn create(_scope: &WorkerScope) -> Self {\n Self {\n senders: HashMap::new(),\n destruct_handle: None,\n }\n }\n\n fn update(&mut self, scope: &WorkerScope, msg: Self::Message) {\n match msg {\n Self::Message::ReactorExited(id) => {\n scope.respond(id, ReactorOutput::Finish);\n self.senders.remove(&id);\n }\n }\n\n // All reactors have closed themselves, the worker can now close.\n if self.destruct_handle.is_some() && self.senders.is_empty() {\n self.destruct_handle = None;\n }\n }\n\n fn connected(&mut self, scope: &WorkerScope, id: HandlerId) {\n let from_bridge = {\n let (tx, rx) = mpsc::unbounded();\n self.senders.insert(id, tx);\n\n rx\n };\n\n let to_bridge = {\n let scope_ = scope.clone();\n let (tx, mut rx) = mpsc::unbounded();\n spawn_local(async move {\n while let Some(m) = rx.next().await {\n scope_.respond(id, ReactorOutput::Output(m));\n }\n });\n\n sink::unfold((), move |_, item: ::Output| {\n let tx = tx.clone();\n\n async move {\n let _ = tx.send_now(item);\n\n Ok::<(), Infallible>(())\n }\n })\n };\n\n let reactor_scope = ReactorScoped::new(from_bridge, to_bridge);\n\n let reactor = R::create(reactor_scope);\n\n scope.send_future(async move {\n reactor.await;\n\n Message::ReactorExited(id)\n });\n }\n\n fn received(&mut self, _scope: &WorkerScope, input: Self::Input, id: HandlerId) {\n match input {\n Self::Input::Input(input) => {\n if let Some(m) = self.senders.get_mut(&id) {\n let _result = m.send_now(input);\n }\n }\n }\n }\n\n fn disconnected(&mut self, _scope: &WorkerScope, id: HandlerId) {\n // We close this channel, but drop it when the reactor has exited itself.\n if let Some(m) = self.senders.get_mut(&id) {\n m.close_now();\n }\n }\n\n fn destroy(&mut self, _scope: &WorkerScope, destruct: WorkerDestroyHandle) {\n if !self.senders.is_empty() {\n self.destruct_handle = Some(destruct);\n }\n }\n}\n" }, { "path": "packages/yew-agent/src/scope_ext.rs", "content": "//! This module contains extensions to the component scope for agent access.\n\nuse std::any::type_name;\nuse std::fmt;\nuse std::rc::Rc;\n\nuse futures::stream::SplitSink;\nuse futures::{SinkExt, StreamExt};\nuse wasm_bindgen::UnwrapThrowExt;\nuse yew::html::Scope;\nuse yew::platform::pinned::RwLock;\nuse yew::platform::spawn_local;\nuse yew::prelude::*;\n\nuse crate::oneshot::{Oneshot, OneshotProviderState};\nuse crate::reactor::{Reactor, ReactorBridge, ReactorEvent, ReactorProviderState, ReactorScoped};\nuse crate::worker::{Worker, WorkerBridge, WorkerProviderState};\n\n/// A Worker Bridge Handle.\n#[derive(Debug)]\npub struct WorkerBridgeHandle\nwhere\n W: Worker,\n{\n inner: WorkerBridge,\n}\n\nimpl WorkerBridgeHandle\nwhere\n W: Worker,\n{\n /// Sends a message to the worker agent.\n pub fn send(&self, input: W::Input) {\n self.inner.send(input)\n }\n}\n\ntype ReactorTx =\n Rc, <::Scope as ReactorScoped>::Input>>>;\n\n/// A Reactor Bridge Handle.\npub struct ReactorBridgeHandle\nwhere\n R: Reactor + 'static,\n{\n tx: ReactorTx,\n}\n\nimpl fmt::Debug for ReactorBridgeHandle\nwhere\n R: Reactor + 'static,\n{\n fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {\n f.debug_struct(type_name::()).finish_non_exhaustive()\n }\n}\n\nimpl ReactorBridgeHandle\nwhere\n R: Reactor + 'static,\n{\n /// Sends a message to the reactor agent.\n pub fn send(&self, input: ::Input) {\n let tx = self.tx.clone();\n spawn_local(async move {\n let mut tx = tx.write().await;\n let _ = tx.send(input).await;\n });\n }\n}\n\n/// An extension to [`Scope`](yew::html::Scope) that provides communication mechanism to agents.\n///\n/// You can access them on `ctx.link()`\npub trait AgentScopeExt {\n /// Bridges to a Worker Agent.\n fn bridge_worker(&self, callback: Callback) -> WorkerBridgeHandle\n where\n W: Worker + 'static;\n\n /// Bridges to a Reactor Agent.\n fn bridge_reactor(&self, callback: Callback>) -> ReactorBridgeHandle\n where\n R: Reactor + 'static,\n ::Output: 'static;\n\n /// Runs an oneshot in an Oneshot Agent.\n fn run_oneshot(&self, input: T::Input, callback: Callback)\n where\n T: Oneshot + 'static;\n}\n\nimpl AgentScopeExt for Scope\nwhere\n COMP: Component,\n{\n fn bridge_worker(&self, callback: Callback) -> WorkerBridgeHandle\n where\n W: Worker + 'static,\n {\n let inner = self\n .context::>>((|_| {}).into())\n .expect_throw(\"failed to bridge to agent.\")\n .0\n .create_bridge(callback);\n\n WorkerBridgeHandle { inner }\n }\n\n fn bridge_reactor(&self, callback: Callback>) -> ReactorBridgeHandle\n where\n R: Reactor + 'static,\n ::Output: 'static,\n {\n let (tx, mut rx) = self\n .context::>((|_| {}).into())\n .expect_throw(\"failed to bridge to agent.\")\n .0\n .create_bridge()\n .split();\n\n spawn_local(async move {\n while let Some(m) = rx.next().await {\n callback.emit(ReactorEvent::::Output(m));\n }\n\n callback.emit(ReactorEvent::::Finished);\n });\n\n let tx = Rc::new(RwLock::new(tx));\n\n ReactorBridgeHandle { tx }\n }\n\n fn run_oneshot(&self, input: T::Input, callback: Callback)\n where\n T: Oneshot + 'static,\n {\n let (inner, _) = self\n .context::>((|_| {}).into())\n .expect_throw(\"failed to bridge to agent.\");\n\n spawn_local(async move { callback.emit(inner.create_bridge().run(input).await) });\n }\n}\n" }, { "path": "packages/yew-agent/src/traits.rs", "content": "//! Submodule providing the `Spawnable` and `Registrable` traits.\n\n/// A Worker that can be spawned by a spawner.\npub trait Spawnable {\n /// Spawner Type.\n type Spawner;\n\n /// Creates a spawner.\n fn spawner() -> Self::Spawner;\n}\n\n/// A trait to enable public workers being registered in a web worker.\npub trait Registrable {\n /// Registrar Type.\n type Registrar;\n\n /// Creates a registrar for the current worker.\n fn registrar() -> Self::Registrar;\n}\n" }, { "path": "packages/yew-agent/src/utils.rs", "content": "use std::rc::Rc;\nuse std::sync::atomic::{AtomicUsize, Ordering};\n\nuse wasm_bindgen::UnwrapThrowExt;\nuse yew::Reducible;\n\n/// Convenience function to avoid repeating expect logic.\npub fn window() -> web_sys::Window {\n web_sys::window().expect_throw(\"Can't find the global Window\")\n}\n\n/// Gets a unique worker id\npub(crate) fn get_next_id() -> usize {\n static CTR: AtomicUsize = AtomicUsize::new(0);\n\n CTR.fetch_add(1, Ordering::SeqCst)\n}\n\n#[derive(Default, PartialEq)]\npub(crate) struct BridgeIdState {\n pub inner: usize,\n}\n\nimpl Reducible for BridgeIdState {\n type Action = ();\n\n fn reduce(self: Rc, _: Self::Action) -> Rc {\n Self {\n inner: self.inner + 1,\n }\n .into()\n }\n}\n\npub(crate) enum OutputsAction {\n Push(Rc),\n Close,\n Reset,\n}\n\npub(crate) struct OutputsState {\n pub ctr: usize,\n pub inner: Vec>,\n pub closed: bool,\n}\n\nimpl Clone for OutputsState {\n fn clone(&self) -> Self {\n Self {\n ctr: self.ctr,\n inner: self.inner.clone(),\n closed: self.closed,\n }\n }\n}\n\nimpl Reducible for OutputsState {\n type Action = OutputsAction;\n\n fn reduce(mut self: Rc, action: Self::Action) -> Rc {\n {\n let this = Rc::make_mut(&mut self);\n this.ctr += 1;\n\n match action {\n OutputsAction::Push(m) => this.inner.push(m),\n OutputsAction::Close => {\n this.closed = true;\n }\n OutputsAction::Reset => {\n this.closed = false;\n this.inner = Vec::new();\n }\n }\n }\n\n self\n }\n}\n\nimpl Default for OutputsState {\n fn default() -> Self {\n Self {\n ctr: 0,\n inner: Vec::new(),\n closed: false,\n }\n }\n}\n" }, { "path": "packages/yew-agent/src/worker/bridge.rs", "content": "use std::cell::RefCell;\nuse std::collections::HashMap;\nuse std::fmt;\nuse std::marker::PhantomData;\nuse std::rc::{Rc, Weak};\n\nuse serde::{Deserialize, Serialize};\n\nuse super::handler_id::HandlerId;\nuse super::messages::ToWorker;\nuse super::native_worker::NativeWorkerExt;\nuse super::traits::Worker;\nuse super::{Callback, Shared};\nuse crate::codec::Codec;\n\npub(crate) type ToWorkerQueue = Vec>;\npub(crate) type CallbackMap = HashMap::Output)>>;\n\nstruct WorkerBridgeInner\nwhere\n W: Worker,\n{\n // When worker is loaded, queue becomes None.\n pending_queue: Shared>>,\n callbacks: Shared>,\n post_msg: Rc)>,\n}\n\nimpl fmt::Debug for WorkerBridgeInner\nwhere\n W: Worker,\n{\n fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {\n f.write_str(\"WorkerBridgeInner<_>\")\n }\n}\n\nimpl WorkerBridgeInner\nwhere\n W: Worker,\n{\n /// Send a message to the worker, queuing the message if necessary\n fn send_message(&self, msg: ToWorker) {\n let mut pending_queue = self.pending_queue.borrow_mut();\n\n match pending_queue.as_mut() {\n Some(m) => {\n m.push(msg);\n }\n None => {\n (self.post_msg)(msg);\n }\n }\n }\n}\n\nimpl Drop for WorkerBridgeInner\nwhere\n W: Worker,\n{\n fn drop(&mut self) {\n let destroy = ToWorker::Destroy;\n self.send_message(destroy);\n }\n}\n\n/// A connection manager for components interaction with workers.\npub struct WorkerBridge\nwhere\n W: Worker,\n{\n inner: Rc>,\n id: HandlerId,\n _worker: PhantomData,\n _cb: Option>,\n}\n\nimpl WorkerBridge\nwhere\n W: Worker,\n{\n fn init(&self) {\n self.inner.send_message(ToWorker::Connected(self.id));\n }\n\n pub(crate) fn new(\n id: HandlerId,\n native_worker: web_sys::Worker,\n pending_queue: Rc>>>,\n callbacks: Rc>>,\n callback: Option>,\n ) -> Self\n where\n CODEC: Codec,\n W::Input: Serialize + for<'de> Deserialize<'de>,\n {\n let post_msg = move |msg: ToWorker| native_worker.post_packed_message::<_, CODEC>(msg);\n\n let self_ = Self {\n inner: WorkerBridgeInner {\n pending_queue,\n callbacks,\n post_msg: Rc::new(post_msg),\n }\n .into(),\n id,\n _worker: PhantomData,\n _cb: callback,\n };\n self_.init();\n\n self_\n }\n\n /// Send a message to the current worker.\n pub fn send(&self, msg: W::Input) {\n let msg = ToWorker::ProcessInput(self.id, msg);\n self.inner.send_message(msg);\n }\n\n /// Forks the bridge with a different callback.\n ///\n /// This creates a new [HandlerID] that helps the worker to differentiate bridges.\n pub fn fork(&self, cb: Option) -> Self\n where\n F: 'static + Fn(W::Output),\n {\n let cb = cb.map(|m| Rc::new(m) as Rc);\n let handler_id = HandlerId::new();\n\n if let Some(cb_weak) = cb.as_ref().map(Rc::downgrade) {\n self.inner\n .callbacks\n .borrow_mut()\n .insert(handler_id, cb_weak);\n }\n\n let self_ = Self {\n inner: self.inner.clone(),\n id: handler_id,\n _worker: PhantomData,\n _cb: cb,\n };\n self_.init();\n\n self_\n }\n}\n\nimpl Drop for WorkerBridge\nwhere\n W: Worker,\n{\n fn drop(&mut self) {\n let disconnected = ToWorker::Disconnected(self.id);\n self.inner.send_message(disconnected);\n }\n}\n\nimpl fmt::Debug for WorkerBridge\nwhere\n W: Worker,\n{\n fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {\n f.write_str(\"WorkerBridge<_>\")\n }\n}\n\nimpl PartialEq for WorkerBridge\nwhere\n W: Worker,\n{\n fn eq(&self, rhs: &Self) -> bool {\n self.id == rhs.id\n }\n}\n" }, { "path": "packages/yew-agent/src/worker/handler_id.rs", "content": "use std::sync::atomic::{AtomicUsize, Ordering};\n\nuse serde::{Deserialize, Serialize};\n\n/// Identifier to send output to bridges.\n#[derive(Debug, Serialize, Deserialize, Eq, PartialEq, Hash, Clone, Copy)]\npub struct HandlerId(usize);\n\nimpl HandlerId {\n pub(crate) fn new() -> Self {\n static CTR: AtomicUsize = AtomicUsize::new(0);\n\n let id = CTR.fetch_add(1, Ordering::SeqCst);\n\n HandlerId(id)\n }\n}\n" }, { "path": "packages/yew-agent/src/worker/hooks.rs", "content": "use std::any::type_name;\nuse std::fmt;\nuse std::ops::Deref;\nuse std::rc::Rc;\n\nuse wasm_bindgen::prelude::*;\nuse yew::prelude::*;\n\nuse crate::utils::{BridgeIdState, OutputsAction, OutputsState};\nuse crate::worker::provider::WorkerProviderState;\nuse crate::worker::{Worker, WorkerBridge};\n\n/// Hook handle for the [`use_worker_bridge`] hook.\npub struct UseWorkerBridgeHandle\nwhere\n T: Worker,\n{\n inner: Rc>,\n ctr: UseReducerDispatcher,\n}\n\nimpl UseWorkerBridgeHandle\nwhere\n T: Worker,\n{\n /// Send an input to a worker agent.\n pub fn send(&self, msg: T::Input) {\n self.inner.send(msg);\n }\n\n /// Reset the bridge.\n ///\n /// Disconnect the old bridge and re-connects the agent with a new bridge.\n pub fn reset(&self) {\n self.ctr.dispatch(());\n }\n}\n\nimpl Clone for UseWorkerBridgeHandle\nwhere\n T: Worker,\n{\n fn clone(&self) -> Self {\n Self {\n inner: self.inner.clone(),\n ctr: self.ctr.clone(),\n }\n }\n}\n\nimpl fmt::Debug for UseWorkerBridgeHandle\nwhere\n T: Worker,\n{\n fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {\n f.debug_struct(type_name::())\n .field(\"inner\", &self.inner)\n .finish()\n }\n}\n\nimpl PartialEq for UseWorkerBridgeHandle\nwhere\n T: Worker,\n{\n fn eq(&self, rhs: &Self) -> bool {\n self.inner == rhs.inner\n }\n}\n\n/// A hook to bridge to a [`Worker`].\n///\n/// This hooks will only bridge the worker once over the entire component lifecycle.\n///\n/// Takes a callback as the argument.\n///\n/// The callback will be updated on every render to make sure captured values (if any) are up to\n/// date.\n#[hook]\npub fn use_worker_bridge(on_output: F) -> UseWorkerBridgeHandle\nwhere\n T: Worker + 'static,\n F: Fn(T::Output) + 'static,\n{\n let ctr = use_reducer(BridgeIdState::default);\n\n let worker_state = use_context::>>()\n .expect_throw(\"cannot find a provider for current agent.\");\n\n let on_output = Rc::new(on_output);\n\n let on_output_clone = on_output.clone();\n let on_output_ref = use_mut_ref(move || on_output_clone);\n\n // Refresh the callback on every render.\n {\n let mut on_output_ref = on_output_ref.borrow_mut();\n *on_output_ref = on_output;\n }\n\n let bridge = use_memo((worker_state, ctr.inner), |(state, _ctr)| {\n state.create_bridge(Callback::from(move |output| {\n let on_output = on_output_ref.borrow().clone();\n on_output(output);\n }))\n });\n\n UseWorkerBridgeHandle {\n inner: bridge,\n ctr: ctr.dispatcher(),\n }\n}\n\n/// Hook handle for the [`use_worker_subscription`] hook.\npub struct UseWorkerSubscriptionHandle\nwhere\n T: Worker,\n{\n bridge: UseWorkerBridgeHandle,\n outputs: Vec>,\n ctr: usize,\n}\n\nimpl UseWorkerSubscriptionHandle\nwhere\n T: Worker,\n{\n /// Send an input to a worker agent.\n pub fn send(&self, msg: T::Input) {\n self.bridge.send(msg);\n }\n\n /// Reset the subscription.\n ///\n /// This disconnects the old bridge and re-connects the agent with a new bridge.\n /// Existing outputs stored in the subscription will also be cleared.\n pub fn reset(&self) {\n self.bridge.reset();\n }\n}\n\nimpl Clone for UseWorkerSubscriptionHandle\nwhere\n T: Worker,\n{\n fn clone(&self) -> Self {\n Self {\n bridge: self.bridge.clone(),\n outputs: self.outputs.clone(),\n ctr: self.ctr,\n }\n }\n}\n\nimpl fmt::Debug for UseWorkerSubscriptionHandle\nwhere\n T: Worker,\n T::Output: fmt::Debug,\n{\n fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {\n f.debug_struct(type_name::())\n .field(\"bridge\", &self.bridge)\n .field(\"outputs\", &self.outputs)\n .finish()\n }\n}\n\nimpl Deref for UseWorkerSubscriptionHandle\nwhere\n T: Worker,\n{\n type Target = [Rc];\n\n fn deref(&self) -> &[Rc] {\n &self.outputs\n }\n}\n\nimpl PartialEq for UseWorkerSubscriptionHandle\nwhere\n T: Worker,\n{\n fn eq(&self, rhs: &Self) -> bool {\n self.bridge == rhs.bridge && self.ctr == rhs.ctr\n }\n}\n\n/// A hook to subscribe to the outputs of a [Worker] agent.\n///\n/// All outputs sent to current bridge will be collected into a slice.\n#[hook]\npub fn use_worker_subscription() -> UseWorkerSubscriptionHandle\nwhere\n T: Worker + 'static,\n{\n let outputs = use_reducer(OutputsState::default);\n\n let bridge = {\n let outputs = outputs.clone();\n use_worker_bridge::(move |output| {\n outputs.dispatch(OutputsAction::Push(Rc::new(output)))\n })\n };\n\n {\n let outputs_dispatcher = outputs.dispatcher();\n use_effect_with(bridge.clone(), move |_| {\n outputs_dispatcher.dispatch(OutputsAction::Reset);\n\n || {}\n });\n }\n\n UseWorkerSubscriptionHandle {\n bridge,\n outputs: outputs.inner.clone(),\n ctr: outputs.ctr,\n }\n}\n" }, { "path": "packages/yew-agent/src/worker/lifecycle.rs", "content": "use wasm_bindgen::prelude::*;\n\nuse super::messages::ToWorker;\nuse super::native_worker::{DedicatedWorker, WorkerSelf};\nuse super::scope::{WorkerDestroyHandle, WorkerScope};\nuse super::traits::Worker;\nuse super::Shared;\n\npub(crate) struct WorkerState\nwhere\n W: Worker,\n{\n worker: Option<(W, WorkerScope)>,\n to_destroy: bool,\n}\n\nimpl WorkerState\nwhere\n W: Worker,\n{\n pub fn new() -> Self {\n WorkerState {\n worker: None,\n to_destroy: false,\n }\n }\n}\n\n/// Internal Worker lifecycle events\npub(crate) enum WorkerLifecycleEvent {\n /// Request to create the scope\n Create(WorkerScope),\n\n /// Internal Worker message\n Message(W::Message),\n\n /// External Messages from bridges\n Remote(ToWorker),\n\n /// Destroy the Worker\n Destroy,\n}\n\npub(crate) struct WorkerRunnable {\n pub state: Shared>,\n pub event: WorkerLifecycleEvent,\n}\n\nimpl WorkerRunnable\nwhere\n W: Worker + 'static,\n{\n pub fn run(self) {\n let mut state = self.state.borrow_mut();\n\n // We should block all event other than message after a worker is destroyed.\n match self.event {\n WorkerLifecycleEvent::Create(scope) => {\n if state.to_destroy {\n return;\n }\n state.worker = Some((W::create(&scope), scope));\n }\n WorkerLifecycleEvent::Message(msg) => {\n if let Some((worker, scope)) = state.worker.as_mut() {\n worker.update(scope, msg);\n }\n }\n WorkerLifecycleEvent::Remote(ToWorker::Connected(id)) => {\n if state.to_destroy {\n return;\n }\n\n let (worker, scope) = state\n .worker\n .as_mut()\n .expect_throw(\"worker was not created to process connected messages\");\n\n worker.connected(scope, id);\n }\n WorkerLifecycleEvent::Remote(ToWorker::ProcessInput(id, inp)) => {\n if state.to_destroy {\n return;\n }\n\n let (worker, scope) = state\n .worker\n .as_mut()\n .expect_throw(\"worker was not created to process inputs\");\n\n worker.received(scope, inp, id);\n }\n WorkerLifecycleEvent::Remote(ToWorker::Disconnected(id)) => {\n if state.to_destroy {\n return;\n }\n\n let (worker, scope) = state\n .worker\n .as_mut()\n .expect_throw(\"worker was not created to process disconnected messages\");\n\n worker.disconnected(scope, id);\n }\n WorkerLifecycleEvent::Remote(ToWorker::Destroy) => {\n if state.to_destroy {\n return;\n }\n\n state.to_destroy = true;\n\n let (worker, scope) = state\n .worker\n .as_mut()\n .expect_throw(\"trying to destroy not existent worker\");\n\n let destruct = WorkerDestroyHandle::new(scope.clone());\n\n worker.destroy(scope, destruct);\n }\n\n WorkerLifecycleEvent::Destroy => {\n state\n .worker\n .take()\n .expect_throw(\"worker is not initialised or already destroyed\");\n\n DedicatedWorker::worker_self().close();\n }\n }\n }\n}\n" }, { "path": "packages/yew-agent/src/worker/messages.rs", "content": "use serde::{Deserialize, Serialize};\n\nuse super::handler_id::HandlerId;\nuse super::traits::Worker;\n\n/// Serializable messages to worker\n#[derive(Serialize, Deserialize, Debug)]\npub(crate) enum ToWorker\nwhere\n W: Worker,\n{\n /// Client is connected\n Connected(HandlerId),\n /// Incoming message to Worker\n ProcessInput(HandlerId, W::Input),\n /// Client is disconnected\n Disconnected(HandlerId),\n /// Worker should be terminated\n Destroy,\n}\n\n/// Serializable messages sent by worker to consumer\n#[derive(Serialize, Deserialize, Debug)]\npub(crate) enum FromWorker\nwhere\n W: Worker,\n{\n /// Worker sends this message when `wasm` bundle has loaded.\n WorkerLoaded,\n /// Outgoing message to consumer\n ProcessOutput(HandlerId, W::Output),\n}\n" }, { "path": "packages/yew-agent/src/worker/mod.rs", "content": "//! This module contains the worker agent implementation.\n//!\n//! This is a low-level implementation that uses an actor model.\n//!\n//! # Example\n//!\n//! ```\n//! # mod example {\n//! use serde::{Deserialize, Serialize};\n//! use yew::prelude::*;\n//! use yew_agent::worker::{use_worker_bridge, UseWorkerBridgeHandle};\n//!\n//! // This would usually live in the same file as your worker\n//! #[derive(Serialize, Deserialize)]\n//! pub enum WorkerResponseType {\n//! IncrementCounter,\n//! }\n//! # mod my_worker_mod {\n//! # use yew_agent::worker::{HandlerId, WorkerScope};\n//! # use super::WorkerResponseType;\n//! # pub struct MyWorker {}\n//! #\n//! # impl yew_agent::worker::Worker for MyWorker {\n//! # type Input = ();\n//! # type Output = WorkerResponseType;\n//! # type Message = ();\n//! #\n//! # fn create(scope: &WorkerScope) -> Self {\n//! # MyWorker {}\n//! # }\n//! #\n//! # fn update(&mut self, scope: &WorkerScope, _msg: Self::Message) {\n//! # // do nothing\n//! # }\n//! #\n//! # fn received(&mut self, scope: &WorkerScope, _msg: Self::Input, id: HandlerId) {\n//! # scope.respond(id, WorkerResponseType::IncrementCounter);\n//! # }\n//! # }\n//! # }\n//! use my_worker_mod::MyWorker; // note that ::Output == WorkerResponseType\n//! #[component(UseWorkerBridge)]\n//! fn bridge() -> Html {\n//! let counter = use_state(|| 0);\n//!\n//! // a scoped block to clone the state in\n//! {\n//! let counter = counter.clone();\n//! // response will be of type MyWorker::Output, i.e. WorkerResponseType\n//! let bridge: UseWorkerBridgeHandle = use_worker_bridge(move |response| match response {\n//! WorkerResponseType::IncrementCounter => {\n//! counter.set(*counter + 1);\n//! }\n//! });\n//! }\n//!\n//! html! {\n//!
\n//! {*counter}\n//!
\n//! }\n//! }\n//! # }\n//! ```\n\nmod bridge;\nmod handler_id;\nmod hooks;\nmod lifecycle;\nmod messages;\nmod native_worker;\nmod provider;\nmod registrar;\nmod scope;\nmod spawner;\nmod traits;\n\nuse std::cell::RefCell;\nuse std::rc::Rc;\n\npub use bridge::WorkerBridge;\npub use handler_id::HandlerId;\npub use hooks::{\n use_worker_bridge, use_worker_subscription, UseWorkerBridgeHandle, UseWorkerSubscriptionHandle,\n};\npub(crate) use provider::WorkerProviderState;\npub use provider::{WorkerProvider, WorkerProviderProps};\npub use registrar::WorkerRegistrar;\npub use scope::{WorkerDestroyHandle, WorkerScope};\npub use spawner::WorkerSpawner;\npub use traits::Worker;\n\n/// Alias for `Rc>`\ntype Shared = Rc>;\n\n/// Alias for `Rc`\ntype Callback = Rc;\n" }, { "path": "packages/yew-agent/src/worker/native_worker.rs", "content": "use serde::{Deserialize, Serialize};\nuse wasm_bindgen::closure::Closure;\nuse wasm_bindgen::prelude::*;\nuse wasm_bindgen::{JsCast, JsValue};\npub(crate) use web_sys::Worker as DedicatedWorker;\nuse web_sys::{DedicatedWorkerGlobalScope, MessageEvent};\n\nuse crate::codec::Codec;\n\npub(crate) trait WorkerSelf {\n type GlobalScope;\n\n fn worker_self() -> Self::GlobalScope;\n}\n\nimpl WorkerSelf for DedicatedWorker {\n type GlobalScope = DedicatedWorkerGlobalScope;\n\n fn worker_self() -> Self::GlobalScope {\n JsValue::from(js_sys::global()).into()\n }\n}\n\npub(crate) trait NativeWorkerExt {\n fn set_on_packed_message(&self, handler: F)\n where\n T: Serialize + for<'de> Deserialize<'de>,\n CODEC: Codec,\n F: 'static + Fn(T);\n\n fn post_packed_message(&self, data: T)\n where\n T: Serialize + for<'de> Deserialize<'de>,\n CODEC: Codec;\n}\n\nmacro_rules! worker_ext_impl {\n ($($type:path),+) => {$(\n impl NativeWorkerExt for $type {\n fn set_on_packed_message(&self, handler: F)\n where\n T: Serialize + for<'de> Deserialize<'de>,\n CODEC: Codec,\n F: 'static + Fn(T)\n {\n let handler = move |message: MessageEvent| {\n let msg = CODEC::decode(message.data());\n handler(msg);\n };\n let closure = Closure::wrap(Box::new(handler) as Box).into_js_value();\n self.set_onmessage(Some(closure.as_ref().unchecked_ref()));\n }\n\n fn post_packed_message(&self, data: T)\n where\n T: Serialize + for<'de> Deserialize<'de>,\n CODEC: Codec\n {\n self.post_message(&CODEC::encode(data))\n .expect_throw(\"failed to post message\");\n }\n }\n )+};\n}\n\nworker_ext_impl! {\n DedicatedWorker, DedicatedWorkerGlobalScope\n}\n" }, { "path": "packages/yew-agent/src/worker/provider.rs", "content": "use std::any::type_name;\nuse std::cell::RefCell;\nuse std::fmt;\nuse std::rc::Rc;\n\nuse serde::{Deserialize, Serialize};\nuse yew::prelude::*;\n\nuse super::{Worker, WorkerBridge};\nuse crate::reach::Reach;\nuse crate::utils::get_next_id;\nuse crate::{Bincode, Codec, Spawnable};\n\n/// Properties for [WorkerProvider].\n#[derive(Debug, Properties, PartialEq, Clone)]\npub struct WorkerProviderProps {\n /// The path to an agent.\n pub path: AttrValue,\n\n /// The reachability of an agent.\n ///\n /// Default: [`Public`](Reach::Public).\n #[prop_or(Reach::Public)]\n pub reach: Reach,\n\n /// Whether the agent should be created\n /// with type `Module`.\n #[prop_or(false)]\n pub module: bool,\n\n /// Lazily spawn the agent.\n ///\n /// The agent will be spawned when the first time a hook requests a bridge.\n ///\n /// Does not affect private agents.\n ///\n /// Default: `true`\n #[prop_or(true)]\n pub lazy: bool,\n\n /// Children of the provider.\n #[prop_or_default]\n pub children: Html,\n}\n\npub(crate) struct WorkerProviderState\nwhere\n W: Worker,\n{\n id: usize,\n spawn_bridge_fn: Rc WorkerBridge>,\n reach: Reach,\n held_bridge: RefCell>>>,\n}\n\nimpl fmt::Debug for WorkerProviderState\nwhere\n W: Worker,\n{\n fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {\n f.write_str(type_name::())\n }\n}\n\nimpl WorkerProviderState\nwhere\n W: Worker,\n W::Output: 'static,\n{\n fn get_held_bridge(&self) -> Rc> {\n let mut held_bridge = self.held_bridge.borrow_mut();\n\n match held_bridge.as_mut() {\n Some(m) => m.clone(),\n None => {\n let bridge = Rc::new((self.spawn_bridge_fn)());\n *held_bridge = Some(bridge.clone());\n bridge\n }\n }\n }\n\n /// Creates a bridge, uses \"fork\" for public agents.\n pub fn create_bridge(&self, cb: Callback) -> WorkerBridge {\n match self.reach {\n Reach::Public => {\n let held_bridge = self.get_held_bridge();\n held_bridge.fork(Some(move |m| cb.emit(m)))\n }\n Reach::Private => (self.spawn_bridge_fn)(),\n }\n }\n}\n\nimpl PartialEq for WorkerProviderState\nwhere\n W: Worker,\n{\n fn eq(&self, rhs: &Self) -> bool {\n self.id == rhs.id\n }\n}\n\n/// The Worker Agent Provider.\n///\n/// This component provides its children access to a worker agent.\n#[component]\npub fn WorkerProvider(props: &WorkerProviderProps) -> Html\nwhere\n W: Worker + 'static,\n W::Input: Serialize + for<'de> Deserialize<'de> + 'static,\n W::Output: Serialize + for<'de> Deserialize<'de> + 'static,\n C: Codec + 'static,\n{\n let WorkerProviderProps {\n children,\n path,\n lazy,\n module,\n reach,\n } = props.clone();\n\n // Creates a spawning function so Codec is can be erased from contexts.\n let spawn_bridge_fn: Rc WorkerBridge> = {\n let path = path.clone();\n Rc::new(move || W::spawner().as_module(module).encoding::().spawn(&path))\n };\n\n let state = {\n use_memo((path, lazy, reach), move |(_path, lazy, reach)| {\n let state = WorkerProviderState:: {\n id: get_next_id(),\n spawn_bridge_fn,\n reach: *reach,\n held_bridge: Default::default(),\n };\n\n if *reach == Reach::Public && !*lazy {\n state.get_held_bridge();\n }\n state\n })\n };\n\n html! {\n >> context={state.clone()}>\n {children}\n >>>\n }\n}\n" }, { "path": "packages/yew-agent/src/worker/registrar.rs", "content": "use std::fmt;\nuse std::marker::PhantomData;\n\nuse serde::de::Deserialize;\nuse serde::ser::Serialize;\n\nuse super::lifecycle::WorkerLifecycleEvent;\nuse super::messages::{FromWorker, ToWorker};\nuse super::native_worker::{DedicatedWorker, NativeWorkerExt, WorkerSelf};\nuse super::scope::WorkerScope;\nuse super::traits::Worker;\nuse crate::codec::{Bincode, Codec};\n\n/// A Worker Registrar.\npub struct WorkerRegistrar\nwhere\n W: Worker,\n CODEC: Codec,\n{\n _marker: PhantomData<(W, CODEC)>,\n}\n\nimpl fmt::Debug for WorkerRegistrar {\n fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {\n f.write_str(\"WorkerRegistrar<_>\")\n }\n}\n\nimpl WorkerRegistrar\nwhere\n W: Worker + 'static,\n CODEC: Codec,\n{\n pub(crate) fn new() -> Self {\n Self {\n _marker: PhantomData,\n }\n }\n\n /// Sets a new message encoding.\n pub fn encoding(&self) -> WorkerRegistrar\n where\n C: Codec,\n {\n WorkerRegistrar::new()\n }\n\n /// Executes an worker in the current environment.\n pub fn register(&self)\n where\n CODEC: Codec,\n W::Input: Serialize + for<'de> Deserialize<'de>,\n W::Output: Serialize + for<'de> Deserialize<'de>,\n {\n let scope = WorkerScope::::new::();\n let upd = WorkerLifecycleEvent::Create(scope.clone());\n scope.send(upd);\n let handler = move |msg: ToWorker| {\n let upd = WorkerLifecycleEvent::Remote(msg);\n scope.send(upd);\n };\n let loaded: FromWorker = FromWorker::WorkerLoaded;\n let worker = DedicatedWorker::worker_self();\n worker.set_on_packed_message::<_, CODEC, _>(handler);\n worker.post_packed_message::<_, CODEC>(loaded);\n }\n}\n" }, { "path": "packages/yew-agent/src/worker/scope.rs", "content": "use std::cell::RefCell;\nuse std::fmt;\nuse std::future::Future;\nuse std::rc::Rc;\n\nuse serde::de::Deserialize;\nuse serde::ser::Serialize;\nuse wasm_bindgen_futures::spawn_local;\n\nuse super::handler_id::HandlerId;\nuse super::lifecycle::{WorkerLifecycleEvent, WorkerRunnable, WorkerState};\nuse super::messages::FromWorker;\nuse super::native_worker::{DedicatedWorker, NativeWorkerExt, WorkerSelf};\nuse super::traits::Worker;\nuse super::Shared;\nuse crate::codec::Codec;\n\n/// A handle that closes the worker when it is dropped.\npub struct WorkerDestroyHandle\nwhere\n W: Worker + 'static,\n{\n scope: WorkerScope,\n}\n\nimpl fmt::Debug for WorkerDestroyHandle {\n fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {\n f.write_str(\"WorkerDestroyHandle<_>\")\n }\n}\n\nimpl WorkerDestroyHandle\nwhere\n W: Worker,\n{\n pub(crate) fn new(scope: WorkerScope) -> Self {\n Self { scope }\n }\n}\n\nimpl Drop for WorkerDestroyHandle\nwhere\n W: Worker,\n{\n fn drop(&mut self) {\n self.scope.send(WorkerLifecycleEvent::Destroy);\n }\n}\n\n/// This struct holds a reference to a component and to a global scheduler.\npub struct WorkerScope {\n state: Shared>,\n post_msg: Rc)>,\n}\n\nimpl fmt::Debug for WorkerScope {\n fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {\n f.write_str(\"WorkerScope<_>\")\n }\n}\n\nimpl Clone for WorkerScope {\n fn clone(&self) -> Self {\n WorkerScope {\n state: self.state.clone(),\n post_msg: self.post_msg.clone(),\n }\n }\n}\n\nimpl WorkerScope\nwhere\n W: Worker + 'static,\n{\n /// Create worker scope\n pub(crate) fn new() -> Self\n where\n CODEC: Codec,\n W::Output: Serialize + for<'de> Deserialize<'de>,\n {\n let post_msg = move |msg: FromWorker| {\n DedicatedWorker::worker_self().post_packed_message::<_, CODEC>(msg)\n };\n\n let state = Rc::new(RefCell::new(WorkerState::new()));\n WorkerScope {\n post_msg: Rc::new(post_msg),\n state,\n }\n }\n\n /// Schedule message for sending to worker\n pub(crate) fn send(&self, event: WorkerLifecycleEvent) {\n let state = self.state.clone();\n\n // We can implement a custom scheduler,\n // but it's easier to borrow the one from wasm-bindgen-futures.\n spawn_local(async move {\n WorkerRunnable { state, event }.run();\n });\n }\n\n /// Send response to a worker bridge.\n pub fn respond(&self, id: HandlerId, output: W::Output) {\n let msg = FromWorker::::ProcessOutput(id, output);\n (self.post_msg)(msg);\n }\n\n /// Send a message to the worker\n pub fn send_message(&self, msg: T)\n where\n T: Into,\n {\n self.send(WorkerLifecycleEvent::Message(msg.into()));\n }\n\n /// Create a callback which will send a message to the worker when invoked.\n pub fn callback(&self, function: F) -> Rc\n where\n M: Into,\n F: Fn(IN) -> M + 'static,\n {\n let scope = self.clone();\n let closure = move |input| {\n let output = function(input).into();\n scope.send(WorkerLifecycleEvent::Message(output));\n };\n Rc::new(closure)\n }\n\n /// This method creates a callback which returns a Future which\n /// returns a message to be sent back to the worker\n ///\n /// # Panics\n /// If the future panics, then the promise will not resolve, and\n /// will leak.\n pub fn callback_future(&self, function: FN) -> Rc\n where\n M: Into,\n FU: Future + 'static,\n FN: Fn(IN) -> FU + 'static,\n {\n let scope = self.clone();\n\n let closure = move |input: IN| {\n let future: FU = function(input);\n scope.send_future(future);\n };\n\n Rc::new(closure)\n }\n\n /// This method processes a Future that returns a message and sends it back to the worker.\n ///\n /// # Panics\n /// If the future panics, then the promise will not resolve, and will leak.\n pub fn send_future(&self, future: F)\n where\n M: Into,\n F: Future + 'static,\n {\n let scope = self.clone();\n let js_future = async move {\n let message: W::Message = future.await.into();\n let cb = scope.callback(|m: W::Message| m);\n (*cb)(message);\n };\n wasm_bindgen_futures::spawn_local(js_future);\n }\n}\n" }, { "path": "packages/yew-agent/src/worker/spawner.rs", "content": "use std::cell::RefCell;\nuse std::collections::HashMap;\nuse std::fmt;\nuse std::marker::PhantomData;\nuse std::rc::{Rc, Weak};\n\nuse js_sys::Array;\nuse serde::de::Deserialize;\nuse serde::ser::Serialize;\nuse web_sys::{Blob, BlobPropertyBag, Url, WorkerOptions, WorkerType};\n\nuse super::bridge::{CallbackMap, WorkerBridge};\nuse super::handler_id::HandlerId;\nuse super::messages::FromWorker;\nuse super::native_worker::{DedicatedWorker, NativeWorkerExt};\nuse super::traits::Worker;\nuse super::{Callback, Shared};\nuse crate::codec::{Bincode, Codec};\nuse crate::utils::window;\n\n/// A spawner to create workers.\n#[derive(Clone)]\npub struct WorkerSpawner\nwhere\n W: Worker,\n CODEC: Codec,\n{\n _marker: PhantomData<(W, CODEC)>,\n callback: Option>,\n with_loader: bool,\n as_module: bool,\n}\n\nimpl fmt::Debug for WorkerSpawner\nwhere\n W: Worker,\n CODEC: Codec,\n{\n fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {\n f.write_str(\"WorkerScope<_>\")\n }\n}\n\nimpl Default for WorkerSpawner\nwhere\n W: Worker + 'static,\n CODEC: Codec,\n{\n fn default() -> Self {\n Self::new()\n }\n}\n\nimpl WorkerSpawner\nwhere\n W: Worker + 'static,\n CODEC: Codec,\n{\n /// Creates a [WorkerSpawner].\n pub const fn new() -> Self {\n Self {\n _marker: PhantomData,\n callback: None,\n with_loader: false,\n as_module: false,\n }\n }\n\n /// Sets a new message encoding.\n pub fn encoding(&mut self) -> WorkerSpawner\n where\n C: Codec,\n {\n WorkerSpawner {\n _marker: PhantomData,\n callback: self.callback.clone(),\n with_loader: self.with_loader,\n as_module: self.as_module,\n }\n }\n\n /// Sets a callback.\n pub fn callback(&mut self, cb: F) -> &mut Self\n where\n F: 'static + Fn(W::Output),\n {\n self.callback = Some(Rc::new(cb));\n\n self\n }\n\n /// Indicates that [`spawn`](WorkerSpawner#method.spawn) should expect a\n /// `path` to a loader shim script (e.g. when using Trunk, created by using\n /// the [`data-loader-shim`](https://trunkrs.dev/assets/#link-asset-types)\n /// asset type) and one does not need to be generated. `false` by default.\n pub fn with_loader(&mut self, with_loader: bool) -> &mut Self {\n self.with_loader = with_loader;\n\n self\n }\n\n /// Determines whether the worker will be spawned with\n /// [`options.type`](https://developer.mozilla.org/en-US/docs/Web/API/Worker/Worker#type)\n /// set to `module`. `true` by default.\n ///\n /// This option should be un-set if the worker was created with the\n /// `--target no-modules` flag of `wasm-bindgen`. If using Trunk, see the\n /// [`data-bindgen-target`](https://trunkrs.dev/assets/#link-asset-types)\n /// asset type.\n pub fn as_module(&mut self, as_module: bool) -> &mut Self {\n self.as_module = as_module;\n\n self\n }\n\n /// Spawns a Worker.\n pub fn spawn(&self, path: &str) -> WorkerBridge\n where\n W::Input: Serialize + for<'de> Deserialize<'de>,\n W::Output: Serialize + for<'de> Deserialize<'de>,\n {\n let worker = self.create_worker(path).expect(\"failed to spawn worker\");\n\n self.spawn_inner(worker)\n }\n\n fn create_worker(&self, path: &str) -> Option {\n let path = if self.with_loader {\n std::borrow::Cow::Borrowed(path)\n } else {\n let js_shim_url = Url::new_with_base(\n path,\n &window().location().href().expect(\"failed to read href.\"),\n )\n .expect(\"failed to create url for javascript entrypoint\")\n .to_string();\n\n let wasm_url = js_shim_url.replace(\".js\", \"_bg.wasm\");\n\n let array = Array::new();\n let shim = if self.as_module {\n format!(r#\"import init from '{js_shim_url}';await init();\"#)\n } else {\n format!(r#\"importScripts(\"{js_shim_url}\");wasm_bindgen(\"{wasm_url}\");\"#)\n };\n array.push(&shim.into());\n let blob_property = BlobPropertyBag::new();\n blob_property.set_type(\"application/javascript\");\n let blob = Blob::new_with_str_sequence_and_options(&array, &blob_property).unwrap();\n let url = Url::create_object_url_with_blob(&blob).unwrap();\n std::borrow::Cow::Owned(url)\n };\n let path = path.as_ref();\n\n if self.as_module {\n let options = WorkerOptions::new();\n options.set_type(WorkerType::Module);\n DedicatedWorker::new_with_options(path, &options).ok()\n } else {\n DedicatedWorker::new(path).ok()\n }\n }\n\n fn spawn_inner(&self, worker: DedicatedWorker) -> WorkerBridge\n where\n W::Input: Serialize + for<'de> Deserialize<'de>,\n W::Output: Serialize + for<'de> Deserialize<'de>,\n {\n let pending_queue = Rc::new(RefCell::new(Some(Vec::new())));\n let handler_id = HandlerId::new();\n let mut callbacks = HashMap::new();\n\n if let Some(m) = self.callback.as_ref().map(Rc::downgrade) {\n callbacks.insert(handler_id, m);\n }\n\n let callbacks: Shared> = Rc::new(RefCell::new(callbacks));\n\n let handler = {\n let pending_queue = pending_queue.clone();\n let callbacks = callbacks.clone();\n\n let worker = worker.clone();\n\n move |msg: FromWorker| match msg {\n FromWorker::WorkerLoaded => {\n if let Some(pending_queue) = pending_queue.borrow_mut().take() {\n for to_worker in pending_queue.into_iter() {\n worker.post_packed_message::<_, CODEC>(to_worker);\n }\n }\n }\n FromWorker::ProcessOutput(id, output) => {\n let mut callbacks = callbacks.borrow_mut();\n\n if let Some(m) = callbacks.get(&id) {\n if let Some(m) = Weak::upgrade(m) {\n m(output);\n } else {\n callbacks.remove(&id);\n }\n }\n }\n }\n };\n\n worker.set_on_packed_message::<_, CODEC, _>(handler);\n\n WorkerBridge::::new::(\n handler_id,\n worker,\n pending_queue,\n callbacks,\n self.callback.clone(),\n )\n }\n}\n" }, { "path": "packages/yew-agent/src/worker/traits.rs", "content": "use super::handler_id::HandlerId;\nuse super::registrar::WorkerRegistrar;\nuse super::scope::{WorkerDestroyHandle, WorkerScope};\nuse super::spawner::WorkerSpawner;\nuse crate::traits::{Registrable, Spawnable};\n\n/// Declares the behaviour of a worker.\npub trait Worker: Sized {\n /// Update message type.\n type Message;\n /// Incoming message type.\n type Input;\n /// Outgoing message type.\n type Output;\n\n /// Creates an instance of a worker.\n fn create(scope: &WorkerScope) -> Self;\n\n /// Receives an update.\n ///\n /// This method is called when the worker send messages to itself via\n /// [`WorkerScope::send_message`].\n fn update(&mut self, scope: &WorkerScope, msg: Self::Message);\n\n /// New bridge created.\n ///\n /// When a new bridge is created by [`WorkerSpawner::spawn`](crate::WorkerSpawner)\n /// or [`WorkerBridge::fork`](crate::WorkerBridge::fork),\n /// the worker will be notified the [`HandlerId`] of the created bridge via this method.\n fn connected(&mut self, scope: &WorkerScope, id: HandlerId) {\n let _scope = scope;\n let _id = id;\n }\n\n /// Receives an input from a connected bridge.\n ///\n /// When a bridge sends an input via [`WorkerBridge::send`](crate::WorkerBridge::send), the\n /// worker will receive the input via this method.\n fn received(&mut self, scope: &WorkerScope, msg: Self::Input, id: HandlerId);\n\n /// Existing bridge destroyed.\n ///\n /// When a bridge is dropped, the worker will be notified with this method.\n fn disconnected(&mut self, scope: &WorkerScope, id: HandlerId) {\n let _scope = scope;\n let _id = id;\n }\n\n /// Destroys the current worker.\n ///\n /// When all bridges are dropped, the method will be invoked.\n ///\n /// This method is provided a destroy handle where when it is dropped, the worker is closed.\n /// If the worker is closed immediately, then it can ignore the destroy handle.\n /// Otherwise hold the destroy handle until the clean up task is finished.\n ///\n /// # Note\n ///\n /// This method will only be called after all bridges are disconnected.\n /// Attempting to send messages after this method is called will have no effect.\n fn destroy(&mut self, scope: &WorkerScope, destruct: WorkerDestroyHandle) {\n let _scope = scope;\n let _destruct = destruct;\n }\n}\n\nimpl Spawnable for W\nwhere\n W: Worker + 'static,\n{\n type Spawner = WorkerSpawner;\n\n fn spawner() -> WorkerSpawner {\n WorkerSpawner::new()\n }\n}\n\nimpl Registrable for W\nwhere\n W: Worker + 'static,\n{\n type Registrar = WorkerRegistrar;\n\n fn registrar() -> WorkerRegistrar {\n WorkerRegistrar::new()\n }\n}\n" }, { "path": "packages/yew-agent-macro/Cargo.toml", "content": "[package]\nname = \"yew-agent-macro\"\nversion = \"0.4.0\"\nedition = \"2021\"\nrust-version = \"1.84.0\"\nauthors = [\"Kaede Hoshikawa \"]\nrepository = \"https://github.com/yewstack/yew\"\nhomepage = \"https://yew.rs\"\ndocumentation = \"https://docs.rs/yew/\"\nreadme = \"../../README.md\"\ndescription = \"Macro Support for Yew Agents\"\nlicense = \"MIT OR Apache-2.0\"\n\n[lib]\nproc-macro = true\n\n[dependencies]\nproc-macro2.workspace = true\nquote.workspace = true\nsyn = { workspace = true, features = [\"full\", \"extra-traits\"] }\n\n[dev-dependencies]\nrustversion.workspace = true\ntrybuild = { workspace = true }\nyew-agent = { path = \"../yew-agent\" }\n" }, { "path": "packages/yew-agent-macro/release.toml", "content": "tag = false\n" }, { "path": "packages/yew-agent-macro/src/agent_fn.rs", "content": "use proc_macro2::{Span, TokenStream};\nuse quote::ToTokens;\nuse syn::parse::{Parse, ParseStream};\nuse syn::punctuated::Punctuated;\nuse syn::token::Comma;\nuse syn::{Attribute, FnArg, Generics, Ident, Item, ItemFn, Signature, Type, Visibility};\n\npub trait AgentFnType {\n type RecvType;\n type OutputType;\n\n fn attr_name() -> &'static str;\n fn agent_type_name() -> &'static str;\n fn parse_recv_type(sig: &Signature) -> syn::Result;\n fn parse_output_type(sig: &Signature) -> syn::Result;\n\n fn extract_fn_arg_type(arg: &FnArg) -> syn::Result {\n let ty = match arg {\n FnArg::Typed(arg) => arg.ty.clone(),\n\n FnArg::Receiver(_) => {\n return Err(syn::Error::new_spanned(\n arg,\n format!(\"{} agents can't accept a receiver\", Self::agent_type_name()),\n ));\n }\n };\n\n Ok(*ty)\n }\n\n fn assert_no_left_argument(rest_inputs: I, expected_len: usize) -> syn::Result<()>\n where\n I: ExactSizeIterator + IntoIterator,\n T: ToTokens,\n {\n // Checking after param parsing may make it a little inefficient\n // but that's a requirement for better error messages in case of receivers\n // `>0` because first one is already consumed.\n if rest_inputs.len() > 0 {\n let params: TokenStream = rest_inputs\n .into_iter()\n .map(|it| it.to_token_stream())\n .collect();\n return Err(syn::Error::new_spanned(\n params,\n format!(\n \"{} agent can accept at most {} argument{}\",\n Self::agent_type_name(),\n expected_len,\n if expected_len > 1 { \"s\" } else { \"\" }\n ),\n ));\n }\n\n Ok(())\n }\n}\n\n#[derive(Clone)]\npub struct AgentFn\nwhere\n F: AgentFnType + 'static,\n{\n pub recv_type: F::RecvType,\n pub output_type: F::OutputType,\n pub generics: Generics,\n pub vis: Visibility,\n pub attrs: Vec,\n pub name: Ident,\n pub agent_name: Option,\n pub is_async: bool,\n\n pub func: ItemFn,\n}\n\nimpl Parse for AgentFn\nwhere\n F: AgentFnType + 'static,\n{\n fn parse(input: ParseStream) -> syn::Result {\n let parsed: Item = input.parse()?;\n\n let func = match parsed {\n Item::Fn(m) => m,\n\n item => {\n return Err(syn::Error::new_spanned(\n item,\n format!(\n \"`{}` attribute can only be applied to functions\",\n F::attr_name()\n ),\n ))\n }\n };\n\n let ItemFn {\n attrs, vis, sig, ..\n } = func.clone();\n\n if sig.generics.lifetimes().next().is_some() {\n return Err(syn::Error::new_spanned(\n sig.generics,\n format!(\n \"{} agents can't have generic lifetime parameters\",\n F::agent_type_name()\n ),\n ));\n }\n\n if sig.constness.is_some() {\n return Err(syn::Error::new_spanned(\n sig.constness,\n format!(\"const functions can't be {} agents\", F::agent_type_name()),\n ));\n }\n\n if sig.abi.is_some() {\n return Err(syn::Error::new_spanned(\n sig.abi,\n format!(\"extern functions can't be {} agents\", F::agent_type_name()),\n ));\n }\n let recv_type = F::parse_recv_type(&sig)?;\n let output_type = F::parse_output_type(&sig)?;\n\n let is_async = sig.asyncness.is_some();\n\n Ok(Self {\n recv_type,\n output_type,\n generics: sig.generics,\n is_async,\n vis,\n attrs,\n name: sig.ident,\n agent_name: None,\n func,\n })\n }\n}\n\nimpl AgentFn\nwhere\n F: AgentFnType + 'static,\n{\n /// Filters attributes that should be copied to agent definition.\n pub fn filter_attrs_for_agent_struct(&self) -> Vec {\n self.attrs\n .iter()\n .filter_map(|m| {\n m.path()\n .get_ident()\n .and_then(|ident| match ident.to_string().as_str() {\n \"doc\" | \"allow\" => Some(m.clone()),\n _ => None,\n })\n })\n .collect()\n }\n\n /// Filters attributes that should be copied to the agent impl block.\n pub fn filter_attrs_for_agent_impl(&self) -> Vec {\n self.attrs\n .iter()\n .filter_map(|m| {\n m.path()\n .get_ident()\n .and_then(|ident| match ident.to_string().as_str() {\n \"allow\" => Some(m.clone()),\n _ => None,\n })\n })\n .collect()\n }\n\n pub fn phantom_generics(&self) -> Punctuated {\n self.generics\n .type_params()\n .map(|ty_param| ty_param.ident.clone()) // create a new Punctuated sequence without any type bounds\n .collect::>()\n }\n\n pub fn merge_agent_name(&mut self, name: AgentName) -> syn::Result<()> {\n if let Some(ref m) = name.agent_name {\n if m == &self.name {\n return Err(syn::Error::new_spanned(\n m,\n format!(\n \"the {} must not have the same name as the function\",\n F::agent_type_name()\n ),\n ));\n }\n }\n\n self.agent_name = name.agent_name;\n\n Ok(())\n }\n\n pub fn inner_fn_ident(&self) -> Ident {\n if self.agent_name.is_some() {\n self.name.clone()\n } else {\n Ident::new(\"inner\", Span::mixed_site())\n }\n }\n\n pub fn agent_name(&self) -> Ident {\n self.agent_name.clone().unwrap_or_else(|| self.name.clone())\n }\n\n pub fn print_inner_fn(&self) -> ItemFn {\n let mut func = self.func.clone();\n func.sig.ident = self.inner_fn_ident();\n\n func.vis = Visibility::Inherited;\n\n func\n }\n}\n\npub struct AgentName {\n agent_name: Option,\n}\n\nimpl Parse for AgentName {\n fn parse(input: ParseStream) -> syn::Result {\n if input.is_empty() {\n return Ok(Self { agent_name: None });\n }\n\n let agent_name = input.parse()?;\n\n Ok(Self {\n agent_name: Some(agent_name),\n })\n }\n}\n" }, { "path": "packages/yew-agent-macro/src/lib.rs", "content": "use proc_macro::TokenStream;\nuse syn::parse_macro_input;\n\nmod agent_fn;\nmod oneshot;\nmod reactor;\n\nuse agent_fn::{AgentFn, AgentName};\nuse oneshot::{oneshot_impl, OneshotFn};\nuse reactor::{reactor_impl, ReactorFn};\n\n#[proc_macro_attribute]\npub fn reactor(attr: TokenStream, item: TokenStream) -> TokenStream {\n let item = parse_macro_input!(item as AgentFn);\n let attr = parse_macro_input!(attr as AgentName);\n\n reactor_impl(attr, item)\n .unwrap_or_else(|err| err.to_compile_error())\n .into()\n}\n\n#[proc_macro_attribute]\npub fn oneshot(attr: TokenStream, item: TokenStream) -> TokenStream {\n let item = parse_macro_input!(item as AgentFn);\n let attr = parse_macro_input!(attr as AgentName);\n\n oneshot_impl(attr, item)\n .unwrap_or_else(|err| err.to_compile_error())\n .into()\n}\n" }, { "path": "packages/yew-agent-macro/src/oneshot.rs", "content": "use proc_macro2::{Span, TokenStream};\nuse quote::quote;\nuse syn::{parse_quote, Ident, ReturnType, Signature, Type};\n\nuse crate::agent_fn::{AgentFn, AgentFnType, AgentName};\n\npub struct OneshotFn {}\n\nimpl AgentFnType for OneshotFn {\n type OutputType = Type;\n type RecvType = Type;\n\n fn attr_name() -> &'static str {\n \"oneshot\"\n }\n\n fn agent_type_name() -> &'static str {\n \"oneshot\"\n }\n\n fn parse_recv_type(sig: &Signature) -> syn::Result {\n let mut inputs = sig.inputs.iter();\n let arg = inputs\n .next()\n .ok_or_else(|| syn::Error::new_spanned(&sig.ident, \"expected 1 argument\"))?;\n\n let ty = Self::extract_fn_arg_type(arg)?;\n\n Self::assert_no_left_argument(inputs, 1)?;\n\n Ok(ty)\n }\n\n fn parse_output_type(sig: &Signature) -> syn::Result {\n let ty = match &sig.output {\n ReturnType::Default => {\n parse_quote! { () }\n }\n ReturnType::Type(_, ty) => *ty.clone(),\n };\n\n Ok(ty)\n }\n}\n\npub fn oneshot_impl(name: AgentName, mut agent_fn: AgentFn) -> syn::Result {\n agent_fn.merge_agent_name(name)?;\n\n let struct_attrs = agent_fn.filter_attrs_for_agent_struct();\n let oneshot_impl_attrs = agent_fn.filter_attrs_for_agent_impl();\n let phantom_generics = agent_fn.phantom_generics();\n let oneshot_name = agent_fn.agent_name();\n let fn_name = agent_fn.inner_fn_ident();\n let inner_fn = agent_fn.print_inner_fn();\n\n let AgentFn {\n recv_type: input_type,\n generics,\n output_type,\n vis,\n is_async,\n ..\n } = agent_fn;\n let (impl_generics, ty_generics, where_clause) = generics.split_for_impl();\n let fn_generics = ty_generics.as_turbofish();\n\n let in_ident = Ident::new(\"_input\", Span::mixed_site());\n\n let fn_call = if is_async {\n quote! { #fn_name #fn_generics (#in_ident).await }\n } else {\n quote! { #fn_name #fn_generics (#in_ident) }\n };\n let crate_name = quote! { yew_agent };\n\n let quoted = quote! {\n #(#struct_attrs)*\n #[allow(unused_parens)]\n #vis struct #oneshot_name #generics #where_clause {\n inner: ::std::pin::Pin<::std::boxed::Box>>,\n _marker: ::std::marker::PhantomData<(#phantom_generics)>,\n }\n\n // we cannot disable any lints here because it will be applied to the function body\n // as well.\n #(#oneshot_impl_attrs)*\n impl #impl_generics ::#crate_name::oneshot::Oneshot for #oneshot_name #ty_generics #where_clause {\n type Input = #input_type;\n\n fn create(#in_ident: Self::Input) -> Self {\n #inner_fn\n\n Self {\n inner: ::std::boxed::Box::pin(\n async move {\n #fn_call\n }\n ),\n _marker: ::std::marker::PhantomData,\n }\n }\n }\n\n impl #impl_generics ::std::future::Future for #oneshot_name #ty_generics #where_clause {\n type Output = #output_type;\n\n fn poll(mut self: ::std::pin::Pin<&mut Self>, cx: &mut ::std::task::Context<'_>) -> ::std::task::Poll {\n ::std::future::Future::poll(::std::pin::Pin::new(&mut self.inner), cx)\n }\n }\n\n impl #impl_generics ::#crate_name::Registrable for #oneshot_name #ty_generics #where_clause {\n type Registrar = ::#crate_name::oneshot::OneshotRegistrar;\n\n fn registrar() -> Self::Registrar {\n ::#crate_name::oneshot::OneshotRegistrar::::new()\n }\n }\n\n impl #impl_generics ::#crate_name::Spawnable for #oneshot_name #ty_generics #where_clause {\n type Spawner = ::#crate_name::oneshot::OneshotSpawner;\n\n fn spawner() -> Self::Spawner {\n ::#crate_name::oneshot::OneshotSpawner::::new()\n }\n }\n };\n\n Ok(quoted)\n}\n" }, { "path": "packages/yew-agent-macro/src/reactor.rs", "content": "use proc_macro2::{Span, TokenStream};\nuse quote::quote;\nuse syn::{Ident, ReturnType, Signature, Type};\n\nuse crate::agent_fn::{AgentFn, AgentFnType, AgentName};\n\npub struct ReactorFn {}\n\nimpl AgentFnType for ReactorFn {\n type OutputType = ();\n type RecvType = Type;\n\n fn attr_name() -> &'static str {\n \"reactor\"\n }\n\n fn agent_type_name() -> &'static str {\n \"reactor\"\n }\n\n fn parse_recv_type(sig: &Signature) -> syn::Result {\n let mut inputs = sig.inputs.iter();\n let arg = inputs\n .next()\n .ok_or_else(|| syn::Error::new_spanned(&sig.ident, \"expected 1 argument\"))?;\n\n let ty = Self::extract_fn_arg_type(arg)?;\n\n Self::assert_no_left_argument(inputs, 1)?;\n\n Ok(ty)\n }\n\n fn parse_output_type(sig: &Signature) -> syn::Result {\n match &sig.output {\n ReturnType::Default => {}\n ReturnType::Type(_, ty) => {\n return Err(syn::Error::new_spanned(\n ty,\n \"reactor agents cannot return any value\",\n ))\n }\n }\n\n Ok(())\n }\n}\n\npub fn reactor_impl(name: AgentName, mut agent_fn: AgentFn) -> syn::Result {\n agent_fn.merge_agent_name(name)?;\n\n if !agent_fn.is_async {\n return Err(syn::Error::new_spanned(\n &agent_fn.name,\n \"reactor agents must be asynchronous\",\n ));\n }\n\n let struct_attrs = agent_fn.filter_attrs_for_agent_struct();\n let reactor_impl_attrs = agent_fn.filter_attrs_for_agent_impl();\n let phantom_generics = agent_fn.phantom_generics();\n let reactor_name = agent_fn.agent_name();\n let fn_name = agent_fn.inner_fn_ident();\n let inner_fn = agent_fn.print_inner_fn();\n\n let AgentFn {\n recv_type,\n generics,\n vis,\n ..\n } = agent_fn;\n\n let (impl_generics, ty_generics, where_clause) = generics.split_for_impl();\n let fn_generics = ty_generics.as_turbofish();\n\n let scope_ident = Ident::new(\"_scope\", Span::mixed_site());\n\n let fn_call = quote! { #fn_name #fn_generics (#scope_ident).await };\n let crate_name = quote! { yew_agent };\n\n let quoted = quote! {\n #(#struct_attrs)*\n #[allow(unused_parens)]\n #vis struct #reactor_name #generics #where_clause {\n inner: ::std::pin::Pin<::std::boxed::Box>>,\n _marker: ::std::marker::PhantomData<(#phantom_generics)>,\n }\n\n // we cannot disable any lints here because it will be applied to the function body\n // as well.\n #(#reactor_impl_attrs)*\n impl #impl_generics ::#crate_name::reactor::Reactor for #reactor_name #ty_generics #where_clause {\n type Scope = #recv_type;\n\n fn create(#scope_ident: Self::Scope) -> Self {\n #inner_fn\n\n Self {\n inner: ::std::boxed::Box::pin(\n async move {\n #fn_call\n }\n ),\n _marker: ::std::marker::PhantomData,\n }\n }\n }\n\n impl #impl_generics ::std::future::Future for #reactor_name #ty_generics #where_clause {\n type Output = ();\n\n fn poll(mut self: ::std::pin::Pin<&mut Self>, cx: &mut ::std::task::Context<'_>) -> ::std::task::Poll {\n ::std::future::Future::poll(::std::pin::Pin::new(&mut self.inner), cx)\n }\n }\n\n impl #impl_generics ::#crate_name::Registrable for #reactor_name #ty_generics #where_clause {\n type Registrar = ::#crate_name::reactor::ReactorRegistrar;\n\n fn registrar() -> Self::Registrar {\n ::#crate_name::reactor::ReactorRegistrar::::new()\n }\n }\n\n impl #impl_generics ::#crate_name::Spawnable for #reactor_name #ty_generics #where_clause {\n type Spawner = ::#crate_name::reactor::ReactorSpawner;\n\n fn spawner() -> Self::Spawner {\n ::#crate_name::reactor::ReactorSpawner::::new()\n }\n }\n };\n\n Ok(quoted)\n}\n" }, { "path": "packages/yew-macro/Cargo.toml", "content": "[package]\nname = \"yew-macro\"\nversion = \"0.23.0\"\nedition = \"2021\"\nauthors = [\"Justin Starry \"]\nrepository = \"https://github.com/yewstack/yew\"\nhomepage = \"https://github.com/yewstack/yew\"\ndocumentation = \"https://docs.rs/yew-macro/\"\nlicense = \"MIT OR Apache-2.0\"\nkeywords = [\"web\", \"wasm\", \"frontend\", \"webasm\", \"webassembly\"]\ncategories = [\"gui\", \"web-programming\", \"wasm\"]\ndescription = \"A framework for making client-side single-page apps\"\nrust-version = \"1.84.0\"\n\n[lib]\nproc-macro = true\n\n[dependencies]\nproc-macro-error = \"1\"\nproc-macro2.workspace = true\nquote.workspace = true\nsyn = { workspace = true, features = [\"full\", \"extra-traits\", \"visit-mut\"] }\nprettyplease = \"0.2\"\nrustversion.workspace = true\n\n# testing\n[dev-dependencies]\ntrybuild = { workspace = true }\nyew = { path = \"../yew\" }\nimplicit-clone = { workspace = true }\n\n[lints]\nworkspace = true\n" }, { "path": "packages/yew-macro/Makefile.toml", "content": "[tasks.test]\nclear = true\ntoolchain = \"1.84.0\"\ncommand = \"cargo\"\n# test target can be optionally specified like `cargo make test html_macro`,\nargs = [\"test\", \"${@}\"]\n\n[tasks.test-lint]\nclear = true\ntoolchain = \"nightly\"\ncommand = \"cargo\"\nargs = [\"test\", \"test_html_lints\", \"--features\", \"lints\"]\n\n[tasks.test-overwrite]\nextend = \"test\"\nenv = { TRYBUILD = \"overwrite\" }\n" }, { "path": "packages/yew-macro/release.toml", "content": "tag = false\n" }, { "path": "packages/yew-macro/src/classes/mod.rs", "content": "use proc_macro2::TokenStream;\nuse quote::{quote, quote_spanned, ToTokens};\nuse syn::parse::{Parse, ParseStream};\nuse syn::punctuated::Punctuated;\nuse syn::spanned::Spanned;\nuse syn::{Expr, ExprLit, Lit, LitStr, Token};\n\n/// List of HTML classes.\npub struct Classes(Punctuated);\n\nimpl Parse for Classes {\n fn parse(input: ParseStream) -> syn::Result {\n input\n .parse_terminated(ClassExpr::parse, Token![,])\n .map(Self)\n }\n}\n\nimpl ToTokens for Classes {\n fn to_tokens(&self, tokens: &mut TokenStream) {\n let n = self.0.len();\n let push_classes = self.0.iter().map(|x| match x {\n ClassExpr::Lit(class) => quote! {\n unsafe { __yew_classes.unchecked_push(#class) };\n },\n ClassExpr::Expr(class) => quote_spanned! {class.span()=>\n __yew_classes.push(#class);\n },\n });\n tokens.extend(quote! {\n {\n let mut __yew_classes = ::yew::html::Classes::with_capacity(#n);\n #(#push_classes)*\n __yew_classes\n }\n });\n }\n}\n\nenum ClassExpr {\n Lit(LitStr),\n Expr(Box),\n}\n\nimpl Parse for ClassExpr {\n fn parse(input: ParseStream) -> syn::Result {\n match input.parse()? {\n Expr::Lit(ExprLit {\n lit: Lit::Str(lit_str),\n ..\n }) => {\n let value = lit_str.value();\n let classes = value.split_whitespace().collect::>();\n if classes.len() > 1 {\n let fix = classes\n .into_iter()\n .map(|class| format!(\"\\\"{class}\\\"\"))\n .collect::>()\n .join(\", \");\n let msg = format!(\n \"string literals must not contain more than one class (hint: use `{fix}`)\"\n );\n\n Err(syn::Error::new(lit_str.span(), msg))\n } else {\n Ok(Self::Lit(lit_str))\n }\n }\n expr => Ok(Self::Expr(Box::new(expr))),\n }\n }\n}\n" }, { "path": "packages/yew-macro/src/derive_props/builder.rs", "content": "//! The `PropsBuilder` constructs props in alphabetical order and enforces that required props have\n//! been set before allowing the build to complete. Each property has a corresponding method in the\n//! builder. Required property builder methods advance the builder to the next step, optional\n//! properties can be added or skipped with no effect on the build step. Once all of required\n//! properties have been set, the builder moves to the final build step which implements the\n//! `build()` method.\n\nuse proc_macro2::{Ident, Span};\nuse quote::{format_ident, quote, ToTokens};\nuse syn::{parse_quote_spanned, Attribute, GenericParam};\n\nuse super::generics::to_arguments;\nuse super::DerivePropsInput;\nuse crate::derive_props::generics::push_type_param;\n\npub struct PropsBuilder<'a> {\n builder_name: &'a Ident,\n props: &'a DerivePropsInput,\n wrapper_name: &'a Ident,\n check_all_props_name: &'a Ident,\n extra_attrs: &'a [Attribute],\n}\n\nimpl ToTokens for PropsBuilder<'_> {\n fn to_tokens(&self, tokens: &mut proc_macro2::TokenStream) {\n let Self {\n builder_name,\n props,\n wrapper_name,\n ..\n } = self;\n\n let DerivePropsInput { vis, generics, .. } = props;\n\n let assert_all_props = self.impl_assert_props();\n\n let (_, ty_generics, where_clause) = generics.split_for_impl();\n\n let builder = quote! {\n #[doc(hidden)]\n #vis struct #builder_name #generics\n #where_clause\n {\n wrapped: ::std::boxed::Box<#wrapper_name #ty_generics>,\n }\n\n #assert_all_props\n };\n\n tokens.extend(builder);\n }\n}\n\nimpl<'a> PropsBuilder<'_> {\n pub fn new(\n name: &'a Ident,\n props: &'a DerivePropsInput,\n wrapper_name: &'a Ident,\n check_all_props_name: &'a Ident,\n extra_attrs: &'a [Attribute],\n ) -> PropsBuilder<'a> {\n PropsBuilder {\n builder_name: name,\n props,\n wrapper_name,\n check_all_props_name,\n extra_attrs,\n }\n }\n}\n\nimpl PropsBuilder<'_> {\n fn set_fields(&self) -> impl Iterator {\n self.props.prop_fields.iter().map(|pf| pf.to_field_setter())\n }\n\n fn impl_assert_props(&self) -> proc_macro2::TokenStream {\n let Self {\n builder_name,\n check_all_props_name,\n extra_attrs,\n ..\n } = self;\n let DerivePropsInput {\n vis,\n generics,\n props_name,\n prop_fields,\n ..\n } = self.props;\n\n let set_fields = self.set_fields();\n let prop_fns = prop_fields\n .iter()\n .map(|pf| pf.to_build_step_fn(vis, props_name));\n\n let (builder_impl_generics, ty_generics, builder_where_clause) = generics.split_for_impl();\n let turbofish_generics = ty_generics.as_turbofish();\n let generic_args = to_arguments(generics);\n\n let mut assert_impl_generics = generics.clone();\n let token_arg: GenericParam = parse_quote_spanned! {Span::mixed_site()=>\n __YewToken\n };\n push_type_param(&mut assert_impl_generics, token_arg.clone());\n let assert_impl_generics = assert_impl_generics;\n let (impl_generics, _, where_clause) = assert_impl_generics.split_for_impl();\n\n let props_mod_name = format_ident!(\"_{}\", props_name, span = Span::mixed_site());\n let mut check_impl_generics = assert_impl_generics.clone();\n let mut check_args = vec![];\n let mut check_props = proc_macro2::TokenStream::new();\n let prop_field_decls = prop_fields\n .iter()\n .map(|pf| pf.to_field_check(props_name, vis, &token_arg))\n .collect::>();\n let prop_name_decls = prop_field_decls.iter().map(|pf| pf.to_fake_prop_decl());\n for pf in prop_field_decls.iter() {\n check_props.extend(pf.to_stream(\n &mut check_impl_generics,\n &mut check_args,\n &props_mod_name,\n ));\n }\n let (check_impl_generics, _, check_where_clause) = check_impl_generics.split_for_impl();\n\n quote! {\n #[automatically_derived]\n #( #extra_attrs )*\n impl #builder_impl_generics #builder_name<#generic_args> #builder_where_clause {\n #( #prop_fns )*\n }\n\n #[doc(hidden)]\n #[allow(non_snake_case)]\n #vis mod #props_mod_name {\n #( #prop_name_decls )*\n }\n #check_props\n\n #[doc(hidden)]\n #vis struct #check_all_props_name(::std::marker::PhantomData);\n\n #[automatically_derived]\n #[diagnostic::do_not_recommend]\n impl ::yew::html::HasProp>\n for #check_all_props_name\n where B: ::yew::html::HasProp {}\n\n #[automatically_derived]\n #[diagnostic::do_not_recommend]\n impl #check_impl_generics ::yew::html::HasAllProps<\n #props_name #ty_generics ,\n ( #( #check_args , )* ),\n > for #check_all_props_name< #token_arg > #check_where_clause {\n }\n\n #[automatically_derived]\n impl #impl_generics ::yew::html::Buildable< #token_arg > for #builder_name<#generic_args> #where_clause {\n type Output = #props_name #ty_generics;\n type WrappedToken = #check_all_props_name< #token_arg >;\n fn build(this: Self) -> Self::Output {\n #props_name #turbofish_generics {\n #(#set_fields)*\n }\n }\n }\n }\n }\n}\n" }, { "path": "packages/yew-macro/src/derive_props/field.rs", "content": "use std::cmp::{Ord, Ordering, PartialEq, PartialOrd};\nuse std::convert::TryFrom;\n\nuse proc_macro2::{Ident, Span};\nuse quote::{format_ident, quote, quote_spanned};\nuse syn::parse::Result;\nuse syn::spanned::Spanned;\nuse syn::{\n parse_quote, Attribute, Error, Expr, Field, GenericArgument, GenericParam, Generics,\n PathArguments, Type, Visibility,\n};\n\nuse super::should_preserve_attr;\nuse crate::derive_props::generics::push_type_param;\n\nfn is_option_type(ty: &Type) -> bool {\n if let Type::Path(type_path) = ty {\n if let Some(segment) = type_path.path.segments.last() {\n if segment.ident == \"Option\" {\n if let PathArguments::AngleBracketed(args) = &segment.arguments {\n return args.args.len() == 1\n && matches!(args.args.first(), Some(GenericArgument::Type(_)));\n }\n }\n }\n }\n false\n}\n\n#[allow(clippy::large_enum_variant)]\n#[derive(PartialEq, Eq)]\npub enum PropAttr {\n Required { wrapped_name: Ident },\n PropOr(Expr),\n PropOrElse(Expr),\n PropOrDefault,\n}\n\n#[derive(Eq)]\npub struct PropField {\n pub ty: Type,\n name: Ident,\n pub attr: PropAttr,\n extra_attrs: Vec,\n}\n\nimpl PropField {\n /// All required property fields are wrapped in an `Option`\n pub fn is_required(&self) -> bool {\n matches!(self.attr, PropAttr::Required { .. })\n }\n\n /// This check name is descriptive to help a developer realize they missed a required prop\n fn to_check_name(&self, props_name: &Ident) -> Ident {\n format_ident!(\"Has{}{}\", props_name, self.name, span = Span::mixed_site())\n }\n\n /// This check name is descriptive to help a developer realize they missed a required prop\n fn to_check_arg_name(&self, props_name: &Ident) -> GenericParam {\n let ident = format_ident!(\"How{}{}\", props_name, self.name, span = Span::mixed_site());\n GenericParam::Type(ident.into())\n }\n\n /// Ident of the wrapped field name\n fn wrapped_name(&self) -> &Ident {\n match &self.attr {\n PropAttr::Required { wrapped_name } => wrapped_name,\n _ => &self.name,\n }\n }\n\n pub fn to_field_check<'a>(\n &'a self,\n props_name: &'a Ident,\n vis: &'a Visibility,\n token: &'a GenericParam,\n ) -> PropFieldCheck<'a> {\n let check_struct = self.to_check_name(props_name);\n let check_arg = self.to_check_arg_name(props_name);\n PropFieldCheck {\n this: self,\n vis,\n token,\n check_struct,\n check_arg,\n }\n }\n\n /// Used to transform the `PropWrapper` struct into `Properties`\n pub fn to_field_setter(&self) -> proc_macro2::TokenStream {\n let name = &self.name;\n let setter = match &self.attr {\n PropAttr::Required { wrapped_name } => {\n quote! {\n #name: ::std::option::Option::unwrap(this.wrapped.#wrapped_name),\n }\n }\n PropAttr::PropOr(value) => {\n quote_spanned! {value.span()=>\n #name: ::std::option::Option::unwrap_or(this.wrapped.#name, #value),\n }\n }\n PropAttr::PropOrElse(func) => {\n quote_spanned! {func.span()=>\n #name: ::std::option::Option::unwrap_or_else(this.wrapped.#name, #func),\n }\n }\n PropAttr::PropOrDefault => {\n quote! {\n #name: ::std::option::Option::unwrap_or_default(this.wrapped.#name),\n }\n }\n };\n let extra_attrs = &self.extra_attrs;\n quote! {\n #( #extra_attrs )*\n #setter\n }\n }\n\n /// Wrap all required props in `Option`\n pub fn to_field_def(&self) -> proc_macro2::TokenStream {\n let ty = &self.ty;\n let extra_attrs = &self.extra_attrs;\n let wrapped_name = self.wrapped_name();\n quote! {\n #( #extra_attrs )*\n #wrapped_name: ::std::option::Option<#ty>,\n }\n }\n\n /// All optional props must implement the `Default` trait\n pub fn to_default_setter(&self) -> proc_macro2::TokenStream {\n let wrapped_name = self.wrapped_name();\n let extra_attrs = &self.extra_attrs;\n quote! {\n #( #extra_attrs )*\n #wrapped_name: ::std::option::Option::None,\n }\n }\n\n /// Each field is set using a builder method\n pub fn to_build_step_fn(\n &self,\n vis: &Visibility,\n props_name: &Ident,\n ) -> proc_macro2::TokenStream {\n let Self { name, ty, attr, .. } = self;\n let token_ty = Ident::new(\"__YewTokenTy\", Span::mixed_site());\n let none_fn_name = format_ident!(\"{}_none\", name, span = Span::mixed_site());\n let build_fn = match attr {\n PropAttr::Required { wrapped_name } => {\n let check_struct = self.to_check_name(props_name);\n let none_setter = if is_option_type(ty) {\n quote! {\n #[doc(hidden)]\n #vis fn #none_fn_name<#token_ty>(\n &mut self,\n token: #token_ty,\n ) -> #check_struct< #token_ty > {\n self.wrapped.#wrapped_name = ::std::option::Option::Some(::std::option::Option::None);\n #check_struct ( ::std::marker::PhantomData )\n }\n }\n } else {\n quote! {}\n };\n quote! {\n #[doc(hidden)]\n #vis fn #name<#token_ty>(\n &mut self,\n token: #token_ty,\n value: impl ::yew::html::IntoPropValue<#ty>,\n ) -> #check_struct< #token_ty > {\n self.wrapped.#wrapped_name = ::std::option::Option::Some(value.into_prop_value());\n #check_struct ( ::std::marker::PhantomData )\n }\n\n #none_setter\n }\n }\n _ => {\n let none_setter = if is_option_type(ty) {\n quote! {\n #[doc(hidden)]\n #vis fn #none_fn_name<#token_ty>(\n &mut self,\n token: #token_ty,\n ) -> #token_ty {\n self.wrapped.#name = ::std::option::Option::Some(::std::option::Option::None);\n token\n }\n }\n } else {\n quote! {}\n };\n quote! {\n #[doc(hidden)]\n #vis fn #name<#token_ty>(\n &mut self,\n token: #token_ty,\n value: impl ::yew::html::IntoPropValue<#ty>,\n ) -> #token_ty {\n self.wrapped.#name = ::std::option::Option::Some(value.into_prop_value());\n token\n }\n\n #none_setter\n }\n }\n };\n let extra_attrs = &self.extra_attrs;\n quote! {\n #( #extra_attrs )*\n #build_fn\n }\n }\n\n // Detect Properties 2.0 attributes\n fn attribute(named_field: &Field) -> Result {\n let attr = named_field.attrs.iter().find(|attr| {\n attr.path().is_ident(\"prop_or\")\n || attr.path().is_ident(\"prop_or_else\")\n || attr.path().is_ident(\"prop_or_default\")\n });\n\n if let Some(attr) = attr {\n if attr.path().is_ident(\"prop_or\") {\n Ok(PropAttr::PropOr(attr.parse_args()?))\n } else if attr.path().is_ident(\"prop_or_else\") {\n Ok(PropAttr::PropOrElse(attr.parse_args()?))\n } else if attr.path().is_ident(\"prop_or_default\") {\n Ok(PropAttr::PropOrDefault)\n } else {\n unreachable!()\n }\n } else {\n let ident = named_field.ident.as_ref().unwrap();\n let wrapped_name = format_ident!(\"{}_wrapper\", ident, span = Span::mixed_site());\n Ok(PropAttr::Required { wrapped_name })\n }\n }\n}\n\npub struct PropFieldCheck<'a> {\n this: &'a PropField,\n vis: &'a Visibility,\n token: &'a GenericParam,\n check_struct: Ident,\n check_arg: GenericParam,\n}\n\nimpl PropFieldCheck<'_> {\n pub fn to_fake_prop_decl(&self) -> proc_macro2::TokenStream {\n let Self { this, .. } = self;\n if !this.is_required() {\n return Default::default();\n }\n let mut prop_check_name = this.name.clone();\n prop_check_name.set_span(Span::mixed_site());\n quote! {\n #[allow(non_camel_case_types)]\n pub struct #prop_check_name;\n }\n }\n\n pub fn to_stream(\n &self,\n type_generics: &mut Generics,\n check_args: &mut Vec,\n prop_name_mod: &Ident,\n ) -> proc_macro2::TokenStream {\n let Self {\n this,\n vis,\n token,\n check_struct,\n check_arg,\n } = self;\n if !this.is_required() {\n return Default::default();\n }\n let mut prop_check_name = this.name.clone();\n prop_check_name.set_span(Span::mixed_site());\n check_args.push(check_arg.clone());\n push_type_param(type_generics, check_arg.clone());\n let where_clause = type_generics.make_where_clause();\n where_clause.predicates.push(parse_quote! {\n #token: ::yew::html::HasProp< #prop_name_mod :: #prop_check_name, #check_arg >\n });\n\n quote! {\n #[doc(hidden)]\n #[allow(non_camel_case_types)]\n #vis struct #check_struct(::std::marker::PhantomData);\n\n #[automatically_derived]\n #[diagnostic::do_not_recommend]\n impl ::yew::html::HasProp< #prop_name_mod :: #prop_check_name, #check_struct>\n for #check_struct {}\n\n #[automatically_derived]\n #[diagnostic::do_not_recommend]\n impl ::yew::html::HasProp>\n for #check_struct\n where B: ::yew::html::HasProp {}\n\n }\n }\n}\n\nimpl TryFrom for PropField {\n type Error = Error;\n\n fn try_from(field: Field) -> Result {\n let extra_attrs = field\n .attrs\n .iter()\n .filter(|a| should_preserve_attr(a))\n .cloned()\n .collect();\n\n Ok(PropField {\n attr: Self::attribute(&field)?,\n extra_attrs,\n ty: field.ty,\n name: field.ident.unwrap(),\n })\n }\n}\n\nimpl PartialOrd for PropField {\n fn partial_cmp(&self, other: &PropField) -> Option {\n Some(self.cmp(other))\n }\n}\n\nimpl Ord for PropField {\n fn cmp(&self, other: &PropField) -> Ordering {\n if self.name == other.name {\n Ordering::Equal\n } else if self.name == \"children\" {\n Ordering::Greater\n } else if other.name == \"children\" {\n Ordering::Less\n } else {\n self.name.cmp(&other.name)\n }\n }\n}\n\nimpl PartialEq for PropField {\n fn eq(&self, other: &Self) -> bool {\n self.name == other.name\n }\n}\n" }, { "path": "packages/yew-macro/src/derive_props/generics.rs", "content": "use proc_macro2::Ident;\nuse syn::punctuated::Punctuated;\nuse syn::{GenericArgument, GenericParam, Generics, Path, Token, Type, TypePath};\n\n/// Alias for a comma-separated list of `GenericArgument`\npub type GenericArguments = Punctuated;\n\n/// Finds the index of the first generic param with a default value or a const generic.\nfn first_default_or_const_param_position(generics: &Generics) -> Option {\n generics.params.iter().position(|param| match param {\n GenericParam::Type(param) => param.default.is_some(),\n GenericParam::Const(_) => true,\n _ => false,\n })\n}\n\n/// Push a type GenericParam into a Generics\npub fn push_type_param(generics: &mut Generics, type_param: GenericParam) {\n if let Some(idx) = first_default_or_const_param_position(generics) {\n generics.params.insert(idx, type_param)\n } else {\n generics.params.push(type_param)\n }\n}\n\n/// Converts `GenericParams` into `GenericArguments`.\npub fn to_arguments(generics: &Generics) -> GenericArguments {\n let mut args: GenericArguments = Punctuated::new();\n args.extend(generics.params.iter().map(|param| match param {\n GenericParam::Type(type_param) => new_generic_type_arg(type_param.ident.clone()),\n GenericParam::Lifetime(lifetime_param) => {\n GenericArgument::Lifetime(lifetime_param.lifetime.clone())\n }\n GenericParam::Const(const_param) => new_generic_type_arg(const_param.ident.clone()),\n }));\n args\n}\n\n// Creates a `GenericArgument` from an `Ident`\nfn new_generic_type_arg(ident: Ident) -> GenericArgument {\n GenericArgument::Type(Type::Path(TypePath {\n path: Path::from(ident),\n qself: None,\n }))\n}\n" }, { "path": "packages/yew-macro/src/derive_props/mod.rs", "content": "mod builder;\nmod field;\nmod generics;\nmod wrapper;\n\nuse std::convert::TryInto;\n\nuse builder::PropsBuilder;\nuse field::PropField;\nuse proc_macro2::{Ident, Span};\nuse quote::{format_ident, quote, ToTokens};\nuse syn::parse::{Parse, ParseStream, Result};\nuse syn::punctuated::Pair;\nuse syn::visit_mut::VisitMut;\nuse syn::{\n AngleBracketedGenericArguments, Attribute, ConstParam, DeriveInput, GenericArgument,\n GenericParam, Generics, Path, PathArguments, PathSegment, Type, TypeParam, TypePath,\n Visibility,\n};\nuse wrapper::PropsWrapper;\n\nuse self::field::PropAttr;\nuse self::generics::to_arguments;\n\npub struct DerivePropsInput {\n vis: Visibility,\n generics: Generics,\n props_name: Ident,\n prop_fields: Vec,\n preserved_attrs: Vec,\n}\n\n/// AST visitor that replaces all occurrences of the keyword `Self` with `new_self`\nstruct Normaliser<'ast> {\n new_self: &'ast Ident,\n generics: &'ast Generics,\n /// `Option` for one-time initialisation\n new_self_full: Option,\n}\n\nimpl<'ast> Normaliser<'ast> {\n pub fn new(new_self: &'ast Ident, generics: &'ast Generics) -> Self {\n Self {\n new_self,\n generics,\n new_self_full: None,\n }\n }\n\n fn get_new_self(&mut self) -> PathSegment {\n self.new_self_full\n .get_or_insert_with(|| {\n PathSegment {\n ident: self.new_self.clone(),\n arguments: if self.generics.lt_token.is_some() {\n PathArguments::AngleBracketed(AngleBracketedGenericArguments {\n colon2_token: Some(Default::default()),\n lt_token: Default::default(),\n args: self\n .generics\n .params\n .pairs()\n .map(|pair| {\n let (value, punct) = pair.cloned().into_tuple();\n let value = match value {\n GenericParam::Lifetime(param) => {\n GenericArgument::Lifetime(param.lifetime)\n }\n GenericParam::Type(TypeParam { ident, .. })\n | GenericParam::Const(ConstParam { ident, .. }) => {\n GenericArgument::Type(Type::Path(TypePath {\n qself: None,\n path: ident.into(),\n }))\n }\n };\n Pair::new(value, punct)\n })\n .collect(),\n gt_token: Default::default(),\n })\n } else {\n // if no generics were defined for the struct\n PathArguments::None\n },\n }\n })\n .clone()\n }\n}\n\nimpl VisitMut for Normaliser<'_> {\n fn visit_path_mut(&mut self, path: &mut Path) {\n if let Some(first) = path.segments.first_mut() {\n if first.ident == \"Self\" {\n *first = self.get_new_self();\n }\n syn::visit_mut::visit_path_mut(self, path)\n }\n }\n}\n\n/// Some attributes on the original struct are to be preserved and added to the builder struct,\n/// in order to avoid warnings (sometimes reported as errors) in the output.\nfn should_preserve_attr(attr: &Attribute) -> bool {\n // #[cfg(...)]: does not usually appear in macro inputs, but rust-analyzer seems to generate it\n // sometimes. If not preserved, results in \"no-such-field\" errors generating\n // the field setter for `build` #[allow(...)]: silences warnings from clippy, such as\n // dead_code etc. #[deny(...)]: enable additional warnings from clippy\n let path = attr.path();\n path.is_ident(\"allow\") || path.is_ident(\"deny\") || path.is_ident(\"cfg\")\n}\n\nimpl Parse for DerivePropsInput {\n fn parse(input: ParseStream) -> Result {\n let input: DeriveInput = input.parse()?;\n let prop_fields = match input.data {\n syn::Data::Struct(data) => match data.fields {\n syn::Fields::Named(fields) => {\n let mut prop_fields: Vec = fields\n .named\n .into_iter()\n .map(|f| f.try_into())\n .collect::>>()?;\n\n // Alphabetize\n prop_fields.sort();\n\n prop_fields\n }\n syn::Fields::Unit => Vec::new(),\n _ => unimplemented!(\"only structs are supported\"),\n },\n _ => unimplemented!(\"only structs are supported\"),\n };\n\n let preserved_attrs = input\n .attrs\n .iter()\n .filter(|a| should_preserve_attr(a))\n .cloned()\n .collect();\n\n Ok(Self {\n vis: input.vis,\n props_name: input.ident,\n generics: input.generics,\n prop_fields,\n preserved_attrs,\n })\n }\n}\n\nimpl DerivePropsInput {\n /// Replaces all occurrences of `Self` in the struct with the actual name of the struct.\n /// Must be called before tokenising the struct.\n pub fn normalise(&mut self) {\n let mut normaliser = Normaliser::new(&self.props_name, &self.generics);\n for field in &mut self.prop_fields {\n normaliser.visit_type_mut(&mut field.ty);\n if let PropAttr::PropOr(expr) | PropAttr::PropOrElse(expr) = &mut field.attr {\n normaliser.visit_expr_mut(expr)\n }\n }\n }\n}\n\nimpl ToTokens for DerivePropsInput {\n fn to_tokens(&self, tokens: &mut proc_macro2::TokenStream) {\n let Self {\n generics,\n props_name,\n prop_fields,\n preserved_attrs,\n ..\n } = self;\n\n // The wrapper is a new struct which wraps required props in `Option`\n let wrapper_name = format_ident!(\"{}Wrapper\", props_name, span = Span::mixed_site());\n let wrapper = PropsWrapper::new(&wrapper_name, generics, prop_fields, preserved_attrs);\n tokens.extend(wrapper.into_token_stream());\n\n // The builder will only build if all required props have been set\n let builder_name = format_ident!(\"{}Builder\", props_name, span = Span::mixed_site());\n let check_all_props_name =\n format_ident!(\"Check{}All\", props_name, span = Span::mixed_site());\n let builder = PropsBuilder::new(\n &builder_name,\n self,\n &wrapper_name,\n &check_all_props_name,\n preserved_attrs,\n );\n let generic_args = to_arguments(generics);\n tokens.extend(builder.into_token_stream());\n\n // The properties trait has a `builder` method which creates the props builder\n let (impl_generics, ty_generics, where_clause) = generics.split_for_impl();\n let properties = quote! {\n impl #impl_generics ::yew::html::Properties for #props_name #ty_generics #where_clause {\n type Builder = #builder_name<#generic_args>;\n\n fn builder() -> Self::Builder {\n #builder_name {\n wrapped: ::std::boxed::Box::new(::std::default::Default::default()),\n }\n }\n }\n };\n tokens.extend(properties);\n }\n}\n" }, { "path": "packages/yew-macro/src/derive_props/wrapper.rs", "content": "use proc_macro2::Ident;\nuse quote::{quote, ToTokens};\nuse syn::{Attribute, Generics};\n\nuse super::PropField;\n\npub struct PropsWrapper<'a> {\n wrapper_name: &'a Ident,\n generics: &'a Generics,\n prop_fields: &'a [PropField],\n extra_attrs: &'a [Attribute],\n}\n\nimpl ToTokens for PropsWrapper<'_> {\n fn to_tokens(&self, tokens: &mut proc_macro2::TokenStream) {\n let Self {\n generics,\n wrapper_name,\n extra_attrs,\n ..\n } = self;\n\n let (impl_generics, ty_generics, where_clause) = generics.split_for_impl();\n let turbofish_generics = ty_generics.as_turbofish();\n\n let wrapper_field_defs = self.field_defs();\n let wrapper_default_setters = self.default_setters();\n\n let wrapper = quote! {\n #[doc(hidden)]\n #(#extra_attrs)*\n struct #wrapper_name #generics\n #where_clause\n {\n #(#wrapper_field_defs)*\n }\n\n #[automatically_derived]\n impl #impl_generics ::std::default::Default for #wrapper_name #ty_generics #where_clause {\n fn default() -> Self {\n #wrapper_name #turbofish_generics {\n #(#wrapper_default_setters)*\n }\n }\n }\n };\n wrapper.to_tokens(tokens);\n }\n}\n\nimpl<'a> PropsWrapper<'a> {\n pub fn new(\n name: &'a Ident,\n generics: &'a Generics,\n prop_fields: &'a [PropField],\n extra_attrs: &'a [Attribute],\n ) -> Self {\n PropsWrapper {\n wrapper_name: name,\n generics,\n prop_fields,\n extra_attrs,\n }\n }\n\n fn field_defs(&self) -> impl Iterator {\n self.prop_fields.iter().map(|pf| pf.to_field_def())\n }\n\n fn default_setters(&self) -> impl Iterator {\n self.prop_fields.iter().map(|pf| pf.to_default_setter())\n }\n}\n" }, { "path": "packages/yew-macro/src/function_component.rs", "content": "use proc_macro2::{Span, TokenStream};\nuse quote::{quote, ToTokens};\nuse syn::parse::{Parse, ParseStream};\nuse syn::punctuated::Punctuated;\nuse syn::token::{Comma, Fn};\nuse syn::{\n parse_quote, parse_quote_spanned, visit_mut, Attribute, Block, FnArg, Generics, Ident, Item,\n ItemFn, LitStr, ReturnType, Type, Visibility,\n};\n\nuse crate::hook::BodyRewriter;\n\n#[derive(Clone)]\npub struct FunctionComponent {\n block: Box,\n props_type: Box,\n arg: FnArg,\n generics: Generics,\n vis: Visibility,\n attrs: Vec,\n name: Ident,\n return_type: Box,\n fn_token: Fn,\n\n component_name: Option,\n}\n\nimpl Parse for FunctionComponent {\n fn parse(input: ParseStream) -> syn::Result {\n let parsed: Item = input.parse()?;\n\n let func = match parsed {\n Item::Fn(m) => m,\n\n item => {\n return Err(syn::Error::new_spanned(\n item,\n \"`component` attribute can only be applied to functions\",\n ))\n }\n };\n\n let ItemFn {\n attrs,\n vis,\n sig,\n block,\n } = func;\n\n if sig.generics.lifetimes().next().is_some() {\n return Err(syn::Error::new_spanned(\n sig.generics,\n \"function components can't have generic lifetime parameters\",\n ));\n }\n\n if sig.asyncness.is_some() {\n return Err(syn::Error::new_spanned(\n sig.asyncness,\n \"function components can't be async\",\n ));\n }\n\n if sig.constness.is_some() {\n return Err(syn::Error::new_spanned(\n sig.constness,\n \"const functions can't be function components\",\n ));\n }\n\n if sig.abi.is_some() {\n return Err(syn::Error::new_spanned(\n sig.abi,\n \"extern functions can't be function components\",\n ));\n }\n\n let return_type = match sig.output {\n ReturnType::Default => {\n return Err(syn::Error::new_spanned(\n sig,\n \"function components must return `yew::Html` or `yew::HtmlResult`\",\n ))\n }\n ReturnType::Type(_, ty) => ty,\n };\n\n let mut inputs = sig.inputs.into_iter();\n let arg = inputs\n .next()\n .unwrap_or_else(|| syn::parse_quote! { _: &() });\n\n let ty = match &arg {\n FnArg::Typed(arg) => match &*arg.ty {\n Type::Reference(ty) => {\n if ty.lifetime.is_some() {\n return Err(syn::Error::new_spanned(\n &ty.lifetime,\n \"reference must not have a lifetime\",\n ));\n }\n\n if ty.mutability.is_some() {\n return Err(syn::Error::new_spanned(\n ty.mutability,\n \"reference must not be mutable\",\n ));\n }\n\n ty.elem.clone()\n }\n ty => {\n let msg = format!(\n \"expected a reference to a `Properties` type (try: `&{}`)\",\n ty.to_token_stream()\n );\n return Err(syn::Error::new_spanned(ty, msg));\n }\n },\n\n FnArg::Receiver(_) => {\n return Err(syn::Error::new_spanned(\n arg,\n \"function components can't accept a receiver\",\n ));\n }\n };\n\n // Checking after param parsing may make it a little inefficient\n // but that's a requirement for better error messages in case of receivers\n // `>0` because first one is already consumed.\n if inputs.len() > 0 {\n let params: TokenStream = inputs.map(|it| it.to_token_stream()).collect();\n return Err(syn::Error::new_spanned(\n params,\n \"function components can accept at most one parameter for the props\",\n ));\n }\n\n Ok(Self {\n props_type: ty,\n block,\n arg,\n generics: sig.generics,\n vis,\n attrs,\n name: sig.ident,\n return_type,\n fn_token: sig.fn_token,\n component_name: None,\n })\n }\n}\n\nimpl FunctionComponent {\n /// Filters attributes that should be copied to component definition.\n fn filter_attrs_for_component_struct(&self) -> Vec {\n self.attrs\n .iter()\n .filter_map(|m| {\n m.path()\n .get_ident()\n .and_then(|ident| match ident.to_string().as_str() {\n \"doc\" | \"allow\" => Some(m.clone()),\n _ => None,\n })\n })\n .collect()\n }\n\n /// Filters attributes that should be copied to the component impl block.\n fn filter_attrs_for_component_impl(&self) -> Vec {\n self.attrs\n .iter()\n .filter_map(|m| {\n m.path()\n .get_ident()\n .and_then(|ident| match ident.to_string().as_str() {\n \"allow\" => Some(m.clone()),\n _ => None,\n })\n })\n .collect()\n }\n\n fn phantom_generics(&self) -> Punctuated {\n self.generics\n .type_params()\n .map(|ty_param| ty_param.ident.clone()) // create a new Punctuated sequence without any type bounds\n .collect::>()\n }\n\n fn merge_component_name(&mut self, name: FunctionComponentName) -> syn::Result<()> {\n if let Some(ref m) = name.component_name {\n if m == &self.name {\n return Err(syn::Error::new_spanned(\n m,\n \"the component must not have the same name as the function\",\n ));\n }\n }\n\n self.component_name = name.component_name;\n\n Ok(())\n }\n\n fn inner_fn_ident(&self) -> Ident {\n if self.component_name.is_some() {\n self.name.clone()\n } else {\n Ident::new(\"inner\", Span::mixed_site())\n }\n }\n\n fn component_name(&self) -> Ident {\n self.component_name\n .clone()\n .unwrap_or_else(|| self.name.clone())\n }\n\n // We need to cast 'static on all generics for base component.\n fn create_static_component_generics(&self) -> Generics {\n let mut generics = self.generics.clone();\n\n let where_clause = generics.make_where_clause();\n for ty_generic in self.generics.type_params() {\n let ident = &ty_generic.ident;\n let bound = parse_quote_spanned! { ident.span() =>\n #ident: 'static\n };\n\n where_clause.predicates.push(bound);\n }\n\n where_clause.predicates.push(parse_quote! { Self: 'static });\n\n generics\n }\n\n /// Prints the impl fn.\n fn print_inner_fn(&self) -> TokenStream {\n let name = self.inner_fn_ident();\n let FunctionComponent {\n ref fn_token,\n ref attrs,\n ref block,\n ref return_type,\n ref generics,\n ref arg,\n ..\n } = self;\n let mut block = *block.clone();\n let (impl_generics, _ty_generics, where_clause) = generics.split_for_impl();\n\n // We use _ctx here so if the component does not use any hooks, the unused_vars lint will\n // not be triggered.\n let ctx_ident = Ident::new(\"_ctx\", Span::mixed_site());\n\n let mut body_rewriter = BodyRewriter::new(ctx_ident.clone());\n visit_mut::visit_block_mut(&mut body_rewriter, &mut block);\n\n quote! {\n #(#attrs)*\n #fn_token #name #impl_generics (#ctx_ident: &mut ::yew::functional::HookContext, #arg) -> #return_type\n #where_clause\n {\n #block\n }\n }\n }\n\n fn print_base_component_impl(&self) -> TokenStream {\n let component_name = self.component_name();\n let props_type = &self.props_type;\n let static_comp_generics = self.create_static_component_generics();\n\n let (impl_generics, ty_generics, where_clause) = static_comp_generics.split_for_impl();\n\n // TODO: replace with blanket implementation when specialisation becomes stable.\n quote! {\n #[automatically_derived]\n impl #impl_generics ::yew::html::BaseComponent for #component_name #ty_generics #where_clause {\n type Message = ();\n type Properties = #props_type;\n\n #[inline]\n fn create(ctx: &::yew::html::Context) -> Self {\n Self {\n _marker: ::std::marker::PhantomData,\n function_component: ::yew::functional::FunctionComponent::::new(ctx),\n }\n }\n\n #[inline]\n fn update(&mut self, _ctx: &::yew::html::Context, _msg: Self::Message) -> ::std::primitive::bool {\n true\n }\n\n #[inline]\n fn changed(&mut self, _ctx: &::yew::html::Context, _old_props: &Self::Properties) -> ::std::primitive::bool {\n true\n }\n\n #[inline]\n fn view(&self, ctx: &::yew::html::Context) -> ::yew::html::HtmlResult {\n ::yew::functional::FunctionComponent::::render(\n &self.function_component,\n ::yew::html::Context::::props(ctx)\n )\n }\n\n #[inline]\n fn rendered(&mut self, _ctx: &::yew::html::Context, _first_render: ::std::primitive::bool) {\n ::yew::functional::FunctionComponent::::rendered(&self.function_component)\n }\n\n #[inline]\n fn destroy(&mut self, _ctx: &::yew::html::Context) {\n ::yew::functional::FunctionComponent::::destroy(&self.function_component)\n }\n\n #[inline]\n fn prepare_state(&self) -> ::std::option::Option<::std::string::String> {\n ::yew::functional::FunctionComponent::::prepare_state(&self.function_component)\n }\n }\n }\n }\n\n fn print_debug_impl(&self) -> TokenStream {\n let component_name = self.component_name();\n let (impl_generics, ty_generics, where_clause) = self.generics.split_for_impl();\n\n let component_name_lit = LitStr::new(&format!(\"{component_name}<_>\"), Span::mixed_site());\n\n quote! {\n #[automatically_derived]\n impl #impl_generics ::std::fmt::Debug for #component_name #ty_generics #where_clause {\n fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {\n ::std::write!(f, #component_name_lit)\n }\n }\n }\n }\n\n fn print_fn_provider_impl(&self) -> TokenStream {\n let func = self.print_inner_fn();\n let component_impl_attrs = self.filter_attrs_for_component_impl();\n let component_name = self.component_name();\n let fn_name = self.inner_fn_ident();\n let (impl_generics, ty_generics, where_clause) = self.generics.split_for_impl();\n let props_type = &self.props_type;\n let fn_generics = ty_generics.as_turbofish();\n\n let component_props = Ident::new(\"props\", Span::mixed_site());\n let ctx_ident = Ident::new(\"ctx\", Span::mixed_site());\n\n quote! {\n // we cannot disable any lints here because it will be applied to the function body\n // as well.\n #(#component_impl_attrs)*\n impl #impl_generics ::yew::functional::FunctionProvider for #component_name #ty_generics #where_clause {\n type Properties = #props_type;\n\n fn run(#ctx_ident: &mut ::yew::functional::HookContext, #component_props: &Self::Properties) -> ::yew::html::HtmlResult {\n #func\n\n ::yew::html::IntoHtmlResult::into_html_result(#fn_name #fn_generics (#ctx_ident, #component_props))\n }\n }\n }\n }\n\n fn print_struct_def(&self) -> TokenStream {\n let component_attrs = self.filter_attrs_for_component_struct();\n let component_name = self.component_name();\n\n let generics = &self.generics;\n let (_impl_generics, _ty_generics, where_clause) = self.generics.split_for_impl();\n let phantom_generics = self.phantom_generics();\n let vis = &self.vis;\n\n quote! {\n #(#component_attrs)*\n #[allow(unused_parens)]\n #vis struct #component_name #generics #where_clause {\n _marker: ::std::marker::PhantomData<(#phantom_generics)>,\n function_component: ::yew::functional::FunctionComponent,\n }\n }\n }\n}\n\npub struct FunctionComponentName {\n component_name: Option,\n}\n\nimpl Parse for FunctionComponentName {\n fn parse(input: ParseStream) -> syn::Result {\n if input.is_empty() {\n return Ok(Self {\n component_name: None,\n });\n }\n\n let component_name = input.parse()?;\n\n Ok(Self {\n component_name: Some(component_name),\n })\n }\n}\n\npub fn function_component_impl(\n name: FunctionComponentName,\n mut component: FunctionComponent,\n) -> syn::Result {\n component.merge_component_name(name)?;\n\n let base_comp_impl = component.print_base_component_impl();\n let debug_impl = component.print_debug_impl();\n let provider_fn_impl = component.print_fn_provider_impl();\n let struct_def = component.print_struct_def();\n\n let quoted = quote! {\n #struct_def\n\n #provider_fn_impl\n #debug_impl\n #base_comp_impl\n };\n\n Ok(quoted)\n}\n" }, { "path": "packages/yew-macro/src/hook/body.rs", "content": "use std::sync::{Arc, Mutex};\n\nuse proc_macro_error::emit_error;\nuse syn::spanned::Spanned;\nuse syn::visit_mut::VisitMut;\nuse syn::{\n parse_quote_spanned, visit_mut, Expr, ExprCall, ExprClosure, ExprForLoop, ExprIf, ExprLoop,\n ExprMatch, ExprWhile, Ident, Item,\n};\n\n#[derive(Debug)]\npub struct BodyRewriter {\n branch_lock: Arc>,\n ctx_ident: Ident,\n}\n\nimpl BodyRewriter {\n pub fn new(ctx_ident: Ident) -> Self {\n Self {\n branch_lock: Arc::default(),\n ctx_ident,\n }\n }\n\n fn is_branched(&self) -> bool {\n self.branch_lock.try_lock().is_err()\n }\n\n fn with_branch(&mut self, f: F) -> O\n where\n F: FnOnce(&mut BodyRewriter) -> O,\n {\n let branch_lock = self.branch_lock.clone();\n let _branched = branch_lock.try_lock();\n f(self)\n }\n}\n\nimpl VisitMut for BodyRewriter {\n fn visit_expr_call_mut(&mut self, i: &mut ExprCall) {\n let ctx_ident = &self.ctx_ident;\n\n // Only rewrite hook calls.\n if let Expr::Path(ref m) = &*i.func {\n if let Some(m) = m.path.segments.last().as_ref().map(|m| &m.ident) {\n if m.to_string().starts_with(\"use_\") {\n if self.is_branched() {\n emit_error!(\n m,\n \"hooks cannot be called at this position.\";\n help = \"move hooks to the top-level of your function.\";\n note = \"see: https://yew.rs/docs/next/concepts/function-components/hooks\"\n );\n } else {\n *i = parse_quote_spanned! { i.span() => ::yew::functional::Hook::run(#i, #ctx_ident) };\n }\n\n return;\n }\n }\n }\n\n visit_mut::visit_expr_call_mut(self, i);\n }\n\n fn visit_expr_mut(&mut self, i: &mut Expr) {\n let ctx_ident = &self.ctx_ident;\n\n match &mut *i {\n Expr::Macro(m) => {\n if let Some(ident) = m.mac.path.segments.last().as_ref().map(|m| &m.ident) {\n if ident.to_string().starts_with(\"use_\") {\n if self.is_branched() {\n emit_error!(\n ident,\n \"hooks cannot be called at this position.\";\n help = \"move hooks to the top-level of your function.\";\n note = \"see: https://yew.rs/docs/next/concepts/function-components/hooks\"\n );\n } else {\n *i = parse_quote_spanned! { i.span() => ::yew::functional::Hook::run(#i, #ctx_ident) };\n }\n } else {\n visit_mut::visit_expr_macro_mut(self, m);\n }\n }\n }\n _ => visit_mut::visit_expr_mut(self, i),\n }\n }\n\n fn visit_expr_closure_mut(&mut self, i: &mut ExprClosure) {\n self.with_branch(move |m| visit_mut::visit_expr_closure_mut(m, i))\n }\n\n fn visit_expr_if_mut(&mut self, i: &mut ExprIf) {\n for it in &mut i.attrs {\n visit_mut::visit_attribute_mut(self, it);\n }\n\n visit_mut::visit_expr_mut(self, &mut i.cond);\n\n self.with_branch(|m| visit_mut::visit_block_mut(m, &mut i.then_branch));\n\n if let Some(it) = &mut i.else_branch {\n self.with_branch(|m| visit_mut::visit_expr_mut(m, &mut (it).1));\n }\n }\n\n fn visit_expr_loop_mut(&mut self, i: &mut ExprLoop) {\n self.with_branch(|m| visit_mut::visit_expr_loop_mut(m, i));\n }\n\n fn visit_expr_for_loop_mut(&mut self, i: &mut ExprForLoop) {\n for it in &mut i.attrs {\n visit_mut::visit_attribute_mut(self, it);\n }\n if let Some(it) = &mut i.label {\n visit_mut::visit_label_mut(self, it);\n }\n visit_mut::visit_pat_mut(self, &mut i.pat);\n visit_mut::visit_expr_mut(self, &mut i.expr);\n\n self.with_branch(|m| visit_mut::visit_block_mut(m, &mut i.body));\n }\n\n fn visit_expr_match_mut(&mut self, i: &mut ExprMatch) {\n for it in &mut i.attrs {\n visit_mut::visit_attribute_mut(self, it);\n }\n\n visit_mut::visit_expr_mut(self, &mut i.expr);\n\n self.with_branch(|m| {\n for it in &mut i.arms {\n visit_mut::visit_arm_mut(m, it);\n }\n });\n }\n\n fn visit_expr_while_mut(&mut self, i: &mut ExprWhile) {\n for it in &mut i.attrs {\n visit_mut::visit_attribute_mut(self, it);\n }\n if let Some(it) = &mut i.label {\n visit_mut::visit_label_mut(self, it);\n }\n\n self.with_branch(|m| visit_mut::visit_expr_mut(m, &mut i.cond));\n self.with_branch(|m| visit_mut::visit_block_mut(m, &mut i.body));\n }\n\n fn visit_item_mut(&mut self, _i: &mut Item) {\n // We don't do anything for items.\n // for components / hooks in other components / hooks, apply the attribute again.\n }\n}\n" }, { "path": "packages/yew-macro/src/hook/lifetime.rs", "content": "use std::sync::{Arc, Mutex};\n\nuse proc_macro2::Span;\nuse syn::visit_mut::{self, VisitMut};\nuse syn::{\n GenericArgument, Lifetime, ParenthesizedGenericArguments, Receiver, TypeBareFn, TypeImplTrait,\n TypeParamBound, TypeReference, TypeTraitObject,\n};\n\n// borrowed from the awesome async-trait crate.\npub struct CollectLifetimes {\n pub elided: Vec,\n pub name: &'static str,\n pub default_span: Span,\n\n pub type_trait_obj_lock: Arc>,\n pub impl_trait_lock: Arc>,\n pub impl_fn_lock: Arc>,\n}\n\nimpl CollectLifetimes {\n pub fn new(name: &'static str, default_span: Span) -> Self {\n CollectLifetimes {\n elided: Vec::new(),\n name,\n default_span,\n\n impl_trait_lock: Arc::default(),\n type_trait_obj_lock: Arc::default(),\n impl_fn_lock: Arc::default(),\n }\n }\n\n fn is_impl_trait(&self) -> bool {\n self.impl_trait_lock.try_lock().is_err()\n }\n\n fn is_type_trait_obj(&self) -> bool {\n self.type_trait_obj_lock.try_lock().is_err()\n }\n\n fn is_impl_fn(&self) -> bool {\n self.impl_fn_lock.try_lock().is_err()\n }\n\n fn visit_opt_lifetime(&mut self, lifetime: &mut Option) {\n match lifetime {\n None => *lifetime = Some(self.next_lifetime(None)),\n Some(lifetime) => self.visit_lifetime(lifetime),\n }\n }\n\n fn visit_lifetime(&mut self, lifetime: &mut Lifetime) {\n if lifetime.ident == \"_\" {\n *lifetime = self.next_lifetime(lifetime.span());\n }\n }\n\n fn next_lifetime>>(&mut self, span: S) -> Lifetime {\n let name = format!(\"{}{}\", self.name, self.elided.len());\n let span = span.into().unwrap_or(self.default_span);\n let life = Lifetime::new(&name, span);\n self.elided.push(life.clone());\n life\n }\n}\n\nimpl VisitMut for CollectLifetimes {\n fn visit_receiver_mut(&mut self, arg: &mut Receiver) {\n if let Some((_, lifetime)) = &mut arg.reference {\n self.visit_opt_lifetime(lifetime);\n }\n }\n\n fn visit_type_reference_mut(&mut self, ty: &mut TypeReference) {\n // We don't rewrite references in the impl FnOnce(&arg) or fn(&arg)\n if self.is_impl_fn() {\n return;\n }\n\n self.visit_opt_lifetime(&mut ty.lifetime);\n visit_mut::visit_type_reference_mut(self, ty);\n }\n\n fn visit_generic_argument_mut(&mut self, gen: &mut GenericArgument) {\n // We don't rewrite types in the impl FnOnce(&arg) -> Type<'_>\n if self.is_impl_fn() {\n return;\n }\n\n if let GenericArgument::Lifetime(lifetime) = gen {\n self.visit_lifetime(lifetime);\n }\n visit_mut::visit_generic_argument_mut(self, gen);\n }\n\n fn visit_type_impl_trait_mut(&mut self, impl_trait: &mut TypeImplTrait) {\n let impl_trait_lock = self.impl_trait_lock.clone();\n let _locked = impl_trait_lock.try_lock();\n\n impl_trait\n .bounds\n .insert(0, TypeParamBound::Lifetime(self.next_lifetime(None)));\n\n visit_mut::visit_type_impl_trait_mut(self, impl_trait);\n }\n\n fn visit_type_trait_object_mut(&mut self, type_trait_obj: &mut TypeTraitObject) {\n let type_trait_obj_lock = self.type_trait_obj_lock.clone();\n let _locked = type_trait_obj_lock.try_lock();\n\n visit_mut::visit_type_trait_object_mut(self, type_trait_obj);\n }\n\n fn visit_parenthesized_generic_arguments_mut(\n &mut self,\n generic_args: &mut ParenthesizedGenericArguments,\n ) {\n let impl_fn_lock = self.impl_fn_lock.clone();\n let _maybe_locked =\n (self.is_impl_trait() || self.is_type_trait_obj()).then(|| impl_fn_lock.try_lock());\n\n visit_mut::visit_parenthesized_generic_arguments_mut(self, generic_args);\n }\n\n fn visit_type_bare_fn_mut(&mut self, i: &mut TypeBareFn) {\n let impl_fn_lock = self.impl_fn_lock.clone();\n let _locked = impl_fn_lock.try_lock();\n\n visit_mut::visit_type_bare_fn_mut(self, i);\n }\n}\n" }, { "path": "packages/yew-macro/src/hook/mod.rs", "content": "use proc_macro2::{Span, TokenStream};\nuse proc_macro_error::emit_error;\nuse quote::quote;\nuse syn::parse::{Parse, ParseStream};\nuse syn::spanned::Spanned;\nuse syn::{\n visit_mut, AttrStyle, Attribute, Block, Expr, ExprPath, File, Ident, Item, ItemFn, LitStr,\n Meta, MetaNameValue, ReturnType, Signature, Stmt, Token, Type,\n};\n\nmod body;\nmod lifetime;\nmod signature;\n\npub use body::BodyRewriter;\nuse signature::HookSignature;\n\n#[derive(Clone)]\npub struct HookFn {\n inner: ItemFn,\n}\n\nimpl Parse for HookFn {\n fn parse(input: ParseStream) -> syn::Result {\n let func: ItemFn = input.parse()?;\n\n let sig = func.sig.clone();\n\n if sig.asyncness.is_some() {\n emit_error!(sig.asyncness, \"async functions can't be hooks\");\n }\n\n if sig.constness.is_some() {\n emit_error!(sig.constness, \"const functions can't be hooks\");\n }\n\n if sig.abi.is_some() {\n emit_error!(sig.abi, \"extern functions can't be hooks\");\n }\n\n if sig.unsafety.is_some() {\n emit_error!(sig.unsafety, \"unsafe functions can't be hooks\");\n }\n\n if !sig.ident.to_string().starts_with(\"use_\") {\n emit_error!(sig.ident, \"hooks must have a name starting with `use_`\");\n }\n\n Ok(Self { inner: func })\n }\n}\n\nimpl HookFn {\n fn doc_attr(&self) -> Attribute {\n let span = self.inner.span();\n\n let sig_formatted = prettyplease::unparse(&File {\n shebang: None,\n attrs: vec![],\n items: vec![Item::Fn(ItemFn {\n block: Box::new(Block {\n brace_token: Default::default(),\n stmts: vec![Stmt::Expr(\n Expr::Path(ExprPath {\n attrs: vec![],\n qself: None,\n path: Ident::new(\"__yew_macro_dummy_function_body__\", span).into(),\n }),\n None,\n )],\n }),\n ..self.inner.clone()\n })],\n });\n\n let literal = LitStr::new(\n &format!(\n r#\"\n# Note\n\nWhen used in function components and hooks, this hook is equivalent to:\n\n```\n{}\n```\n\"#,\n sig_formatted.replace(\n \"__yew_macro_dummy_function_body__\",\n \"/* implementation omitted */\"\n )\n ),\n span,\n );\n\n Attribute {\n pound_token: Default::default(),\n style: AttrStyle::Outer,\n bracket_token: Default::default(),\n meta: Meta::NameValue(MetaNameValue {\n path: Ident::new(\"doc\", span).into(),\n eq_token: Token![=](span),\n value: Expr::Lit(syn::ExprLit {\n attrs: vec![],\n lit: literal.into(),\n }),\n }),\n }\n }\n}\n\npub fn hook_impl(hook: HookFn) -> syn::Result {\n let doc_attr = hook.doc_attr();\n\n let HookFn { inner: original_fn } = hook;\n\n let ItemFn {\n ref vis,\n ref sig,\n ref block,\n ref attrs,\n } = original_fn;\n let mut block = *block.clone();\n\n let hook_sig = HookSignature::rewrite(sig);\n\n let Signature {\n ref fn_token,\n ref ident,\n ref inputs,\n output: ref hook_return_type,\n ref generics,\n ..\n } = hook_sig.sig;\n\n let output_type = &hook_sig.output_type;\n\n let (impl_generics, ty_generics, where_clause) = generics.split_for_impl();\n let call_generics = hook_sig.call_generics();\n\n // We use _ctx so that if a hook does not use other hooks, it will not trigger unused_vars.\n let ctx_ident = Ident::new(\"_ctx\", Span::mixed_site());\n\n let mut body_rewriter = BodyRewriter::new(ctx_ident.clone());\n visit_mut::visit_block_mut(&mut body_rewriter, &mut block);\n\n let inner_fn_ident = Ident::new(\"inner_fn\", Span::mixed_site());\n let input_args = hook_sig.input_args();\n\n let inner_fn_rt = match &sig.output {\n ReturnType::Default => None,\n ReturnType::Type(rarrow, _) => Some(quote! { #rarrow #output_type }),\n };\n\n let output_is_impl_trait = matches!(hook_sig.output_type, Type::ImplTrait(_));\n\n let inner_fn = if output_is_impl_trait {\n quote! {}\n } else {\n quote! { fn #inner_fn_ident #generics (#ctx_ident: &mut ::yew::functional::HookContext, #inputs) #inner_fn_rt #where_clause #block }\n };\n\n let inner_type_impl = if hook_sig.needs_boxing {\n let hook_lifetime = &hook_sig.hook_lifetime;\n let boxed_inner_ident = Ident::new(\"boxed_inner\", Span::mixed_site());\n\n if output_is_impl_trait {\n quote! {\n let #boxed_inner_ident = ::std::boxed::Box::new(\n move |#ctx_ident: &mut ::yew::functional::HookContext| #block\n );\n\n ::yew::functional::BoxedHook::<#hook_lifetime,>::new(#boxed_inner_ident)\n }\n } else {\n let hook_lifetime_plus = quote! { #hook_lifetime + };\n let boxed_fn_type = quote! { ::std::boxed::Box };\n let as_boxed_fn = quote! { as #boxed_fn_type };\n let generic_types = generics.type_params().map(|t| &t.ident);\n\n quote! {\n let #boxed_inner_ident = ::std::boxed::Box::new(\n move |#ctx_ident: &mut ::yew::functional::HookContext| #inner_fn_rt {\n #inner_fn_ident :: <#(#generic_types,)*> (#ctx_ident, #(#input_args,)*)\n }\n ) #as_boxed_fn;\n\n ::yew::functional::BoxedHook::<#hook_lifetime, #output_type>::new(#boxed_inner_ident)\n }\n }\n } else {\n let input_types = hook_sig.input_types();\n\n let args_ident = Ident::new(\"args\", Span::mixed_site());\n let hook_struct_name = Ident::new(\"HookProvider\", Span::mixed_site());\n\n let phantom_types = hook_sig.phantom_types();\n let phantom_lifetimes = hook_sig.phantom_lifetimes();\n\n quote! {\n struct #hook_struct_name #generics #where_clause {\n _marker: ::std::marker::PhantomData<( #(#phantom_types,)* #(#phantom_lifetimes,)* )>,\n #args_ident: (#(#input_types,)*),\n }\n\n #[automatically_derived]\n impl #impl_generics ::yew::functional::Hook for #hook_struct_name #ty_generics #where_clause {\n type Output = #output_type;\n\n fn run(mut self, #ctx_ident: &mut ::yew::functional::HookContext) -> Self::Output {\n let (#(#input_args,)*) = self.#args_ident;\n\n #inner_fn_ident #call_generics (#ctx_ident, #(#input_args,)*)\n }\n }\n\n #[automatically_derived]\n impl #impl_generics #hook_struct_name #ty_generics #where_clause {\n fn new(#inputs) -> Self {\n #hook_struct_name {\n _marker: ::std::marker::PhantomData,\n #args_ident: (#(#input_args,)*),\n }\n }\n }\n\n #hook_struct_name #call_generics ::new(#(#input_args,)*)\n }\n };\n\n // There're some weird issues with doc tests that it cannot detect return types properly.\n // So we print original implementation instead.\n let output = quote! {\n #[cfg(not(doctest))]\n #(#attrs)*\n #doc_attr\n #vis #fn_token #ident #generics (#inputs) #hook_return_type #where_clause {\n #inner_fn\n\n #inner_type_impl\n }\n\n #[cfg(doctest)]\n #original_fn\n };\n\n Ok(output)\n}\n" }, { "path": "packages/yew-macro/src/hook/signature.rs", "content": "use std::iter::once;\nuse std::mem::take;\n\nuse proc_macro2::{Span, TokenStream};\nuse proc_macro_error::emit_error;\nuse quote::{quote, ToTokens};\nuse syn::punctuated::{Pair, Punctuated};\nuse syn::spanned::Spanned;\nuse syn::visit_mut::VisitMut;\nuse syn::{\n parse_quote, parse_quote_spanned, visit_mut, FnArg, GenericParam, Ident, Lifetime,\n LifetimeParam, Pat, Receiver, ReturnType, Signature, Type, TypeImplTrait, TypeParam,\n TypeParamBound, TypeReference, WherePredicate,\n};\n\nuse super::lifetime;\n\nfn type_is_generic(ty: &Type, param: &TypeParam) -> bool {\n match ty {\n Type::Path(path) => path.path.is_ident(¶m.ident),\n _ => false,\n }\n}\n\n#[derive(Default)]\npub struct CollectArgs {\n needs_boxing: bool,\n}\n\nimpl CollectArgs {\n pub fn new() -> Self {\n Self::default()\n }\n}\n\nimpl VisitMut for CollectArgs {\n fn visit_type_impl_trait_mut(&mut self, impl_trait: &mut TypeImplTrait) {\n self.needs_boxing = true;\n\n visit_mut::visit_type_impl_trait_mut(self, impl_trait);\n }\n\n fn visit_receiver_mut(&mut self, recv: &mut Receiver) {\n emit_error!(recv, \"methods cannot be hooks\");\n\n visit_mut::visit_receiver_mut(self, recv);\n }\n}\n\npub struct HookSignature {\n pub hook_lifetime: Lifetime,\n pub sig: Signature,\n pub output_type: Type,\n pub needs_boxing: bool,\n}\n\nimpl HookSignature {\n fn rewrite_return_type(hook_lifetime: &Lifetime, rt_type: &ReturnType) -> (ReturnType, Type) {\n let bound = quote! { #hook_lifetime + };\n\n match rt_type {\n ReturnType::Default => (\n parse_quote! { -> impl #bound ::yew::functional::Hook },\n parse_quote! { () },\n ),\n ReturnType::Type(arrow, ref return_type) => {\n if let Type::Reference(ref m) = &**return_type {\n if m.lifetime.is_none() {\n let mut return_type_ref = m.clone();\n return_type_ref.lifetime = parse_quote!('hook);\n\n let return_type_ref = Type::Reference(return_type_ref);\n\n return (\n parse_quote_spanned! {\n return_type.span() => #arrow impl #bound ::yew::functional::Hook\n },\n return_type_ref,\n );\n }\n }\n\n (\n parse_quote_spanned! {\n return_type.span() => #arrow impl #bound ::yew::functional::Hook\n },\n *return_type.clone(),\n )\n }\n }\n }\n\n /// Rewrites a Hook Signature and extracts information.\n pub fn rewrite(sig: &Signature) -> Self {\n let mut sig = sig.clone();\n\n let mut arg_info = CollectArgs::new();\n arg_info.visit_signature_mut(&mut sig);\n\n let mut lifetimes = lifetime::CollectLifetimes::new(\"'arg\", sig.ident.span());\n for arg in sig.inputs.iter_mut() {\n match arg {\n FnArg::Receiver(arg) => lifetimes.visit_receiver_mut(arg),\n FnArg::Typed(arg) => lifetimes.visit_type_mut(&mut arg.ty),\n }\n }\n\n let Signature {\n ref mut generics,\n output: ref return_type,\n ..\n } = sig;\n\n let hook_lifetime = Lifetime::new(\"'hook\", Span::mixed_site());\n let mut params: Punctuated<_, _> = once(hook_lifetime.clone())\n .chain(lifetimes.elided)\n .map(|lifetime| {\n GenericParam::Lifetime(LifetimeParam {\n attrs: vec![],\n lifetime,\n colon_token: None,\n bounds: Default::default(),\n })\n })\n .map(|param| Pair::new(param, Some(Default::default())))\n .chain(take(&mut generics.params).into_pairs())\n .collect();\n\n for type_param in params.iter_mut().skip(1) {\n match type_param {\n GenericParam::Lifetime(param) => {\n if let Some(predicate) = generics\n .where_clause\n .iter_mut()\n .flat_map(|c| &mut c.predicates)\n .find_map(|predicate| match predicate {\n WherePredicate::Lifetime(p) if p.lifetime == param.lifetime => Some(p),\n _ => None,\n })\n {\n predicate.bounds.push(hook_lifetime.clone());\n } else {\n param.colon_token = Some(param.colon_token.unwrap_or_default());\n param.bounds.push(hook_lifetime.clone());\n }\n }\n\n GenericParam::Type(param) => {\n if let Some(predicate) = generics\n .where_clause\n .iter_mut()\n .flat_map(|c| &mut c.predicates)\n .find_map(|predicate| match predicate {\n WherePredicate::Type(p) if type_is_generic(&p.bounded_ty, param) => {\n Some(p)\n }\n _ => None,\n })\n {\n predicate\n .bounds\n .push(TypeParamBound::Lifetime(hook_lifetime.clone()));\n } else {\n param.colon_token = Some(param.colon_token.unwrap_or_default());\n param\n .bounds\n .push(TypeParamBound::Lifetime(hook_lifetime.clone()));\n }\n }\n\n GenericParam::Const(_) => {}\n }\n }\n\n generics.params = params;\n\n let (output, output_type) = Self::rewrite_return_type(&hook_lifetime, return_type);\n sig.output = output;\n\n Self {\n hook_lifetime,\n sig,\n output_type,\n needs_boxing: arg_info.needs_boxing,\n }\n }\n\n pub fn phantom_types(&self) -> Vec {\n self.sig\n .generics\n .type_params()\n .map(|ty_param| ty_param.ident.clone())\n .collect()\n }\n\n pub fn phantom_lifetimes(&self) -> Vec {\n self.sig\n .generics\n .lifetimes()\n .map(|life| TypeReference {\n and_token: Default::default(),\n lifetime: Some(life.lifetime.clone()),\n mutability: None,\n elem: Box::new(Type::Tuple(syn::TypeTuple {\n paren_token: Default::default(),\n elems: Default::default(),\n })),\n })\n .collect()\n }\n\n pub fn input_args(&self) -> Vec {\n self.sig\n .inputs\n .iter()\n .filter_map(|m| {\n if let FnArg::Typed(m) = m {\n if let Pat::Ident(ref m) = *m.pat {\n return Some(m.ident.clone());\n }\n }\n\n None\n })\n .collect()\n }\n\n pub fn input_types(&self) -> Vec {\n self.sig\n .inputs\n .iter()\n .filter_map(|m| {\n if let FnArg::Typed(m) = m {\n return Some(*m.ty.clone());\n }\n\n None\n })\n .collect()\n }\n\n pub fn call_generics(&self) -> TokenStream {\n let mut generics = self.sig.generics.clone();\n\n // We need to filter out lifetimes.\n generics.params = generics\n .params\n .into_iter()\n .filter(|m| !matches!(m, GenericParam::Lifetime(_)))\n .collect();\n\n let (_impl_generics, ty_generics, _where_clause) = generics.split_for_impl();\n ty_generics.as_turbofish().to_token_stream()\n }\n}\n" }, { "path": "packages/yew-macro/src/html_tree/html_block.rs", "content": "use proc_macro2::Delimiter;\nuse quote::{quote, quote_spanned, ToTokens};\nuse syn::buffer::Cursor;\nuse syn::parse::{Parse, ParseStream};\nuse syn::{braced, token};\n\nuse super::{HtmlIterable, HtmlNode, ToNodeIterator};\nuse crate::PeekValue;\n\npub struct HtmlBlock {\n pub content: BlockContent,\n brace: token::Brace,\n}\n\npub enum BlockContent {\n Node(Box),\n Iterable(Box),\n}\n\nimpl PeekValue<()> for HtmlBlock {\n fn peek(cursor: Cursor) -> Option<()> {\n cursor.group(Delimiter::Brace).map(|_| ())\n }\n}\n\nimpl Parse for HtmlBlock {\n fn parse(input: ParseStream) -> syn::Result {\n let content;\n let brace = braced!(content in input);\n let content = if HtmlIterable::peek(content.cursor()).is_some() {\n BlockContent::Iterable(Box::new(content.parse()?))\n } else {\n BlockContent::Node(Box::new(content.parse()?))\n };\n\n Ok(HtmlBlock { content, brace })\n }\n}\n\nimpl ToTokens for HtmlBlock {\n fn to_tokens(&self, tokens: &mut proc_macro2::TokenStream) {\n let HtmlBlock { content, .. } = self;\n let new_tokens = match content {\n BlockContent::Iterable(html_iterable) => quote! {#html_iterable},\n BlockContent::Node(html_node) => quote! {#html_node},\n };\n\n tokens.extend(quote! {#new_tokens});\n }\n}\n\nimpl ToNodeIterator for HtmlBlock {\n fn to_node_iterator_stream(&self) -> Option {\n let HtmlBlock { content, brace } = self;\n let new_tokens = match content {\n BlockContent::Iterable(iterable) => iterable.to_node_iterator_stream(),\n BlockContent::Node(node) => node.to_node_iterator_stream(),\n }?;\n\n Some(quote_spanned! {brace.span=> #new_tokens})\n }\n\n fn is_singular(&self) -> bool {\n match &self.content {\n BlockContent::Node(node) => node.is_singular(),\n BlockContent::Iterable(_) => false,\n }\n }\n}\n" }, { "path": "packages/yew-macro/src/html_tree/html_component.rs", "content": "use proc_macro2::Span;\nuse quote::{quote, quote_spanned, ToTokens};\nuse syn::parse::discouraged::Speculative;\nuse syn::parse::{Parse, ParseStream};\nuse syn::spanned::Spanned;\nuse syn::{Token, Type};\n\nuse super::{HtmlChildrenTree, TagTokens};\nuse crate::is_ide_completion;\nuse crate::props::ComponentProps;\n\npub struct HtmlComponent {\n ty: Type,\n pub props: ComponentProps,\n children: HtmlChildrenTree,\n close: Option,\n}\n\nimpl Parse for HtmlComponent {\n fn parse(input: ParseStream) -> syn::Result {\n // check if the next tokens are ();\n if !is_ide_completion() {\n return match close {\n Ok(close) => Err(syn::Error::new_spanned(\n close.to_spanned(),\n \"this closing tag has no corresponding opening tag\",\n )),\n Err(err) => Err(err),\n };\n }\n }\n\n let open = input.parse::()?;\n // Return early if it's a self-closing tag\n if open.is_self_closing() {\n return Ok(HtmlComponent {\n ty: open.ty,\n props: open.props,\n children: HtmlChildrenTree::new(),\n close: None,\n });\n }\n\n let mut children = HtmlChildrenTree::new();\n let close = loop {\n if input.is_empty() {\n if is_ide_completion() {\n break None;\n }\n return Err(syn::Error::new_spanned(\n open.to_spanned(),\n \"this opening tag has no corresponding closing tag\",\n ));\n }\n\n if trying_to_close() {\n fn format_token_stream(ts: impl ToTokens) -> String {\n let string = ts.to_token_stream().to_string();\n // remove unnecessary spaces\n string.replace(' ', \"\")\n }\n\n let fork = input.fork();\n let close = TagTokens::parse_end_content(&fork, |i_fork, tag| {\n let ty = i_fork.parse().map_err(|e| {\n syn::Error::new(\n e.span(),\n format!(\n \"expected a valid closing tag for component\\nnote: found opening \\\n tag `{lt}{0}{gt}`\\nhelp: try `{lt}/{0}{gt}`\",\n format_token_stream(&open.ty),\n lt = open.tag.lt.to_token_stream(),\n gt = open.tag.gt.to_token_stream(),\n ),\n )\n })?;\n\n if ty != open.ty && !is_ide_completion() {\n let open_ty = &open.ty;\n Err(syn::Error::new_spanned(\n quote!(#open_ty #ty),\n format!(\n \"mismatched closing tags: expected `{}`, found `{}`\",\n format_token_stream(open_ty),\n format_token_stream(ty)\n ),\n ))\n } else {\n let close = HtmlComponentClose { tag, ty };\n input.advance_to(&fork);\n Ok(close)\n }\n })?;\n break Some(close);\n }\n children.parse_child(input)?;\n };\n\n if !children.is_empty() {\n if let Some(children_prop) = open.props.children() {\n return Err(syn::Error::new_spanned(\n &children_prop.label,\n \"cannot specify the `children` prop when the component already has children\",\n ));\n }\n }\n\n Ok(HtmlComponent {\n ty: open.ty,\n props: open.props,\n children,\n close,\n })\n }\n}\n\nimpl ToTokens for HtmlComponent {\n fn to_tokens(&self, tokens: &mut proc_macro2::TokenStream) {\n let Self {\n ty,\n props,\n children,\n close,\n } = self;\n\n let ty_span = ty.span().resolved_at(Span::call_site());\n let props_ty = quote_spanned!(ty_span=> <#ty as ::yew::html::BaseComponent>::Properties);\n let children_renderer = children.to_children_renderer_tokens();\n let build_props = props.build_properties_tokens(&props_ty, children_renderer);\n let key = props.special().wrap_key_attr();\n let use_close_tag = close\n .as_ref()\n .map(|close| {\n let close_ty = &close.ty;\n quote_spanned! {close_ty.span()=>\n let _ = |_:#close_ty| {};\n }\n })\n .unwrap_or_default();\n\n tokens.extend(quote_spanned! {ty_span=>\n {\n #use_close_tag\n #[allow(clippy::let_unit_value)]\n let __yew_props = #build_props;\n ::yew::virtual_dom::VChild::<#ty>::new(__yew_props, #key)\n }\n });\n }\n}\n\nstruct HtmlComponentOpen {\n tag: TagTokens,\n ty: Type,\n props: ComponentProps,\n}\nimpl HtmlComponentOpen {\n fn is_self_closing(&self) -> bool {\n self.tag.div.is_some()\n }\n\n fn to_spanned(&self) -> impl ToTokens {\n self.tag.to_spanned()\n }\n}\n\nimpl Parse for HtmlComponentOpen {\n fn parse(input: ParseStream) -> syn::Result {\n TagTokens::parse_start_content(input, |input, tag| {\n let ty = input.parse()?;\n let props: ComponentProps = input.parse()?;\n\n if let Some(ref node_ref) = props.special().node_ref {\n return Err(syn::Error::new_spanned(\n &node_ref.label,\n \"cannot use `ref` with components. If you want to specify a property, use \\\n `r#ref` here instead.\",\n ));\n }\n\n Ok(Self { tag, ty, props })\n })\n }\n}\n\nstruct HtmlComponentClose {\n tag: TagTokens,\n ty: Type,\n}\nimpl HtmlComponentClose {\n fn to_spanned(&self) -> impl ToTokens {\n self.tag.to_spanned()\n }\n}\n\nimpl Parse for HtmlComponentClose {\n fn parse(input: ParseStream) -> syn::Result {\n TagTokens::parse_end_content(input, |input, tag| {\n let ty = input.parse()?;\n Ok(Self { tag, ty })\n })\n }\n}\n" }, { "path": "packages/yew-macro/src/html_tree/html_dashed_name.rs", "content": "use std::fmt;\n\nuse proc_macro2::{Ident, Span, TokenStream};\nuse quote::{quote, ToTokens};\nuse syn::buffer::Cursor;\nuse syn::ext::IdentExt;\nuse syn::parse::{Parse, ParseStream};\nuse syn::spanned::Spanned;\nuse syn::{LitStr, Token};\n\nuse crate::stringify::Stringify;\nuse crate::{non_capitalized_ascii, Peek};\n\n#[derive(Clone, PartialEq, Eq)]\npub struct HtmlDashedName {\n pub name: Ident,\n pub extended: Vec<(Token![-], Ident)>,\n}\n\nimpl HtmlDashedName {\n /// Checks if this name is equal to the provided item (which can be anything implementing\n /// `Into`).\n pub fn eq_ignore_ascii_case(&self, other: S) -> bool\n where\n S: Into,\n {\n let mut s = other.into();\n s.make_ascii_lowercase();\n s == self.to_ascii_lowercase_string()\n }\n\n pub fn to_ascii_lowercase_string(&self) -> String {\n let mut s = self.to_string();\n s.make_ascii_lowercase();\n s\n }\n\n pub fn to_lit_str(&self) -> LitStr {\n LitStr::new(&self.to_string(), self.span())\n }\n}\n\nimpl fmt::Display for HtmlDashedName {\n fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {\n write!(f, \"{}\", self.name)?;\n for (_, ident) in &self.extended {\n write!(f, \"-{ident}\")?;\n }\n Ok(())\n }\n}\n\nimpl Peek<'_, Self> for HtmlDashedName {\n fn peek(cursor: Cursor) -> Option<(Self, Cursor)> {\n let (name, cursor) = cursor.ident()?;\n if !non_capitalized_ascii(&name.to_string()) {\n return None;\n }\n\n let mut extended = Vec::new();\n let mut cursor = cursor;\n loop {\n if let Some((punct, p_cursor)) = cursor.punct() {\n if punct.as_char() == '-' {\n let (ident, i_cursor) = p_cursor.ident()?;\n cursor = i_cursor;\n extended.push((Token![-](Span::mixed_site()), ident));\n continue;\n }\n }\n break;\n }\n\n Some((HtmlDashedName { name, extended }, cursor))\n }\n}\n\nimpl Parse for HtmlDashedName {\n fn parse(input: ParseStream) -> syn::Result {\n let name = input.call(Ident::parse_any)?;\n let mut extended = Vec::new();\n while input.peek(Token![-]) {\n extended.push((input.parse::()?, input.call(Ident::parse_any)?));\n }\n\n Ok(HtmlDashedName { name, extended })\n }\n}\n\nimpl ToTokens for HtmlDashedName {\n fn to_tokens(&self, tokens: &mut TokenStream) {\n let HtmlDashedName { name, extended } = self;\n let dashes = extended.iter().map(|(dash, _)| quote! {#dash});\n let idents = extended.iter().map(|(_, ident)| quote! {#ident});\n let extended = quote! { #(#dashes #idents)* };\n tokens.extend(quote! { #name #extended });\n }\n}\n\nimpl Stringify for HtmlDashedName {\n fn try_into_lit(&self) -> Option {\n Some(self.to_lit_str())\n }\n\n fn stringify(&self) -> TokenStream {\n self.to_lit_str().stringify()\n }\n}\n\nimpl From for HtmlDashedName {\n fn from(name: Ident) -> Self {\n HtmlDashedName {\n name,\n extended: vec![],\n }\n }\n}\n" }, { "path": "packages/yew-macro/src/html_tree/html_element.rs", "content": "use proc_macro2::{Delimiter, Group, Span, TokenStream};\nuse proc_macro_error::emit_warning;\nuse quote::{quote, quote_spanned, ToTokens};\nuse syn::buffer::Cursor;\nuse syn::parse::{Parse, ParseStream};\nuse syn::spanned::Spanned;\nuse syn::{Expr, Ident, Lit, LitStr, Token};\n\nuse super::{HtmlChildrenTree, HtmlDashedName, TagTokens};\nuse crate::props::{ElementProps, Prop, PropDirective};\nuse crate::stringify::{Stringify, Value};\nuse crate::{is_ide_completion, non_capitalized_ascii, Peek, PeekValue};\n\nfn is_normalised_element_name(name: &str) -> bool {\n match name {\n \"animateMotion\"\n | \"animateTransform\"\n | \"clipPath\"\n | \"feBlend\"\n | \"feColorMatrix\"\n | \"feComponentTransfer\"\n | \"feComposite\"\n | \"feConvolveMatrix\"\n | \"feDiffuseLighting\"\n | \"feDisplacementMap\"\n | \"feDistantLight\"\n | \"feDropShadow\"\n | \"feFlood\"\n | \"feFuncA\"\n | \"feFuncB\"\n | \"feFuncG\"\n | \"feFuncR\"\n | \"feGaussianBlur\"\n | \"feImage\"\n | \"feMerge\"\n | \"feMergeNode\"\n | \"feMorphology\"\n | \"feOffset\"\n | \"fePointLight\"\n | \"feSpecularLighting\"\n | \"feSpotLight\"\n | \"feTile\"\n | \"feTurbulence\"\n | \"foreignObject\"\n | \"glyphRef\"\n | \"linearGradient\"\n | \"radialGradient\"\n | \"textPath\" => true,\n _ => !name.chars().any(|c| c.is_ascii_uppercase()),\n }\n}\n\npub struct HtmlElement {\n pub name: TagName,\n pub props: ElementProps,\n pub children: HtmlChildrenTree,\n}\n\nimpl PeekValue<()> for HtmlElement {\n fn peek(cursor: Cursor) -> Option<()> {\n HtmlElementOpen::peek(cursor)\n .or_else(|| HtmlElementClose::peek(cursor))\n .map(|_| ())\n }\n}\n\nimpl Parse for HtmlElement {\n fn parse(input: ParseStream) -> syn::Result {\n if HtmlElementClose::peek(input.cursor()).is_some() {\n return match input.parse::() {\n Ok(close) => Err(syn::Error::new_spanned(\n close.to_spanned(),\n \"this closing tag has no corresponding opening tag\",\n )),\n Err(err) => Err(err),\n };\n }\n\n let open = input.parse::()?;\n // Return early if it's a self-closing tag\n if open.is_self_closing() {\n return Ok(HtmlElement {\n name: open.name,\n props: open.props,\n children: HtmlChildrenTree::new(),\n });\n }\n\n if let TagName::Lit(name) = &open.name {\n // Void elements should not have children.\n // See https://html.spec.whatwg.org/multipage/syntax.html#void-elements\n //\n // For dynamic tags this is done at runtime!\n match name.to_ascii_lowercase_string().as_str() {\n \"textarea\" => {\n return Err(syn::Error::new_spanned(\n open.to_spanned(),\n \"the tag ` }\n // make sure that capitalization doesn't matter for the void children check\n html! { };\n\n // no tag name\n html! { <@> };\n html! { <@/> };\n\n // invalid closing tag\n html! { <@{\"test\"}> };\n // type mismatch\n html! { <@{55}> };\n\n // Missing curly braces\n html! { };\n html! { };\n html! { };\n html! { };\n html! { };\n html! { };\n html! { };\n html! { };\n html! { };\n}\n\nfn main() {}\n" }, { "path": "packages/yew-macro/tests/html_macro/element-fail.stderr", "content": "error: this opening tag has no corresponding closing tag\n --> tests/html_macro/element-fail.rs:7:13\n |\n7 | html! {
};\n | ^^^^^\n\nerror: this opening tag has no corresponding closing tag\n --> tests/html_macro/element-fail.rs:8:18\n |\n8 | html! {
};\n | ^^^^^\n\nerror: this opening tag has no corresponding closing tag\n --> tests/html_macro/element-fail.rs:9:13\n |\n9 | html! {
};\n | ^^^^^\n\nerror: this closing tag has no corresponding opening tag\n --> tests/html_macro/element-fail.rs:12:13\n |\n12 | html! {
};\n | ^^^^^^\n\nerror: this closing tag has no corresponding opening tag\n --> tests/html_macro/element-fail.rs:13:18\n |\n13 | html! {
};\n | ^^^^^^^\n\nerror: only one root html element is allowed (hint: you can wrap multiple html elements in a fragment `<>`)\n --> tests/html_macro/element-fail.rs:14:20\n |\n14 | html! { };\n | ^^^^^^\n\nerror: this closing tag has no corresponding opening tag\n --> tests/html_macro/element-fail.rs:17:18\n |\n17 | html! {
};\n | ^^^^^^^\n\nerror: this closing tag has no corresponding opening tag\n --> tests/html_macro/element-fail.rs:18:20\n |\n18 | html! { };\n | ^^^^^^^^\n\nerror: only one root html element is allowed (hint: you can wrap multiple html elements in a fragment `<>`)\n --> tests/html_macro/element-fail.rs:21:24\n |\n21 | html! {
};\n | ^^^^^^^^^^^\n\nerror: expected a valid html element\n --> tests/html_macro/element-fail.rs:23:18\n |\n23 | html! {
Invalid
};\n | ^^^^^^^\n\nerror: `attr` can only be specified once but is given here again\n --> tests/html_macro/element-fail.rs:26:27\n |\n26 | html! { };\n | ^^^^\n\nerror: `value` can only be specified once but is given here again\n --> tests/html_macro/element-fail.rs:27:32\n |\n27 | html! { };\n | ^^^^^\n\nerror: `kind` can only be specified once but is given here again\n --> tests/html_macro/element-fail.rs:28:36\n |\n28 | html! { };\n | ^^^^\n\nerror: `checked` can only be specified once but is given here again\n --> tests/html_macro/element-fail.rs:29:33\n |\n29 | html! { };\n | ^^^^^^^\n\nerror: `disabled` can only be specified once but is given here again\n --> tests/html_macro/element-fail.rs:30:34\n |\n30 | html! { };\n | ^^^^^^^^\n\nerror: `selected` can only be specified once but is given here again\n --> tests/html_macro/element-fail.rs:31:35\n |\n31 | html! {
};\n | ^^^^^\n\nerror: `ref` can only be specified once\n --> tests/html_macro/element-fail.rs:33:29\n |\n33 | html! { };\n | ^^^\n\nerror: `ref` can only be specified once\n --> tests/html_macro/element-fail.rs:63:29\n |\n63 | html! { };\n | ^^^\n\nerror: the tag `` is a void element and cannot have children (hint: rewrite this as ``)\n --> tests/html_macro/element-fail.rs:66:13\n |\n66 | html! { };\n | ^^^^^^^^^^^^^^^^^^^\n\nerror: the tag ` }\n | ^^^^^^^^^^\n\nerror: the tag `` is a void element and cannot have children (hint: rewrite this as ``)\n --> tests/html_macro/element-fail.rs:70:13\n |\n70 | html! { };\n | ^^^^^^^^^^^^^^^^^^^\n\nerror: this dynamic tag is missing an expression block defining its value\n --> tests/html_macro/element-fail.rs:73:14\n |\n73 | html! { <@> };\n | ^\n\nerror: this dynamic tag is missing an expression block defining its value\n --> tests/html_macro/element-fail.rs:74:14\n |\n74 | html! { <@/> };\n | ^\n\nerror: dynamic closing tags must not have a body (hint: replace it with just ``)\n --> tests/html_macro/element-fail.rs:77:27\n |\n77 | html! { <@{\"test\"}> };\n | ^^^^^^^^\n\nerror: the property value must be either a literal or enclosed in braces. Consider adding braces around your expression.: Expr::Tuple {\n attrs: [],\n paren_token: Paren,\n elems: [],\n }\n --> tests/html_macro/element-fail.rs:82:24\n |\n82 | html! { };\n | ^^\n\nerror: the property value must be either a literal or enclosed in braces. Consider adding braces around your expression.: Expr::Tuple {\n attrs: [],\n paren_token: Paren,\n elems: [],\n }\n --> tests/html_macro/element-fail.rs:83:24\n |\n83 | html! { };\n | ^^\n\nerror: the property value must be either a literal or enclosed in braces. Consider adding braces around your expression.: Expr::Call {\n attrs: [],\n func: Expr::Path {\n attrs: [],\n qself: None,\n path: Path {\n leading_colon: None,\n segments: [\n PathSegment {\n ident: Ident {\n ident: \"Some\",\n span: #0 bytes(2628..2632),\n },\n arguments: PathArguments::None,\n },\n ],\n },\n },\n paren_token: Paren,\n args: [\n Expr::Lit {\n attrs: [],\n lit: Lit::Int {\n token: 5,\n },\n },\n ],\n }\n --> tests/html_macro/element-fail.rs:84:28\n |\n84 | html! { };\n | ^^^^^^^\n\nerror: the property value must be either a literal or enclosed in braces. Consider adding braces around your expression.: Expr::Path {\n attrs: [],\n qself: None,\n path: Path {\n leading_colon: None,\n segments: [\n PathSegment {\n ident: Ident {\n ident: \"NotToString\",\n span: #0 bytes(2668..2679),\n },\n arguments: PathArguments::None,\n },\n ],\n },\n }\n --> tests/html_macro/element-fail.rs:85:27\n |\n85 | html! { };\n | ^^^^^^^^^^^\n\nerror: the property value must be either a literal or enclosed in braces. Consider adding braces around your expression.: Expr::Call {\n attrs: [],\n func: Expr::Path {\n attrs: [],\n qself: None,\n path: Path {\n leading_colon: None,\n segments: [\n PathSegment {\n ident: Ident {\n ident: \"Some\",\n span: #0 bytes(2707..2711),\n },\n arguments: PathArguments::None,\n },\n ],\n },\n },\n paren_token: Paren,\n args: [\n Expr::Path {\n attrs: [],\n qself: None,\n path: Path {\n leading_colon: None,\n segments: [\n PathSegment {\n ident: Ident {\n ident: \"NotToString\",\n span: #0 bytes(2712..2723),\n },\n arguments: PathArguments::None,\n },\n ],\n },\n },\n ],\n }\n --> tests/html_macro/element-fail.rs:86:22\n |\n86 | html! { };\n | ^^^^^^^^^^^^^^^^^\n\nerror: the property value must be either a literal or enclosed in braces. Consider adding braces around your expression.: Expr::Call {\n attrs: [],\n func: Expr::Path {\n attrs: [],\n qself: None,\n path: Path {\n leading_colon: None,\n segments: [\n PathSegment {\n ident: Ident {\n ident: \"Some\",\n span: #0 bytes(2751..2755),\n },\n arguments: PathArguments::None,\n },\n ],\n },\n },\n paren_token: Paren,\n args: [\n Expr::Lit {\n attrs: [],\n lit: Lit::Int {\n token: 5,\n },\n },\n ],\n }\n --> tests/html_macro/element-fail.rs:87:21\n |\n87 | html! { };\n | ^^^^^^^\n\nerror: the property value must be either a literal or enclosed in braces. Consider adding braces around your expression.: Expr::Tuple {\n attrs: [],\n paren_token: Paren,\n elems: [],\n }\n --> tests/html_macro/element-fail.rs:88:25\n |\n88 | html! { };\n | ^^\n\nerror: the property value must be either a literal or enclosed in braces. Consider adding braces around your expression.: Expr::Tuple {\n attrs: [],\n paren_token: Paren,\n elems: [],\n }\n --> tests/html_macro/element-fail.rs:89:26\n |\n89 | html! { };\n | ^^\n\nerror: the property value must be either a literal or enclosed in braces. Consider adding braces around your expression.: Expr::Path {\n attrs: [],\n qself: None,\n path: Path {\n leading_colon: None,\n segments: [\n PathSegment {\n ident: Ident {\n ident: \"NotToString\",\n span: #0 bytes(2858..2869),\n },\n arguments: PathArguments::None,\n },\n ],\n },\n }\n --> tests/html_macro/element-fail.rs:90:27\n |\n90 | html! { };\n | ^^^^^^^^^^^\n\nerror[E0308]: mismatched types\n --> tests/html_macro/element-fail.rs:36:28\n |\n36 | html! { };\n | -----------------------^-----\n | | |\n | | expected `bool`, found integer\n | arguments to this enum variant are incorrect\n |\nhelp: the type constructed contains `{integer}` due to the type of the argument passed\n --> tests/html_macro/element-fail.rs:36:5\n |\n36 | html! { };\n | ^^^^^^^^^^^^^^^^^^^^^^^-^^^^^\n | |\n | this argument influences the type of `{{root}}`\nnote: tuple variant defined here\n --> $RUST/core/src/option.rs\n = note: this error originates in the macro `html` (in Nightly builds, run with -Z macro-backtrace for more info)\n\nerror[E0308]: mismatched types\n --> tests/html_macro/element-fail.rs:37:29\n |\n37 | html! { };\n | ------------------------^^^^^^^^^^^------\n | | |\n | | expected `bool`, found `Option`\n | arguments to this enum variant are incorrect\n |\n = note: expected type `bool`\n found enum `Option`\nhelp: the type constructed contains `Option` due to the type of the argument passed\n --> tests/html_macro/element-fail.rs:37:5\n |\n37 | html! { };\n | ^^^^^^^^^^^^^^^^^^^^^^^^-----------^^^^^^\n | |\n | this argument influences the type of `{{root}}`\nnote: tuple variant defined here\n --> $RUST/core/src/option.rs\n = note: this error originates in the macro `html` (in Nightly builds, run with -Z macro-backtrace for more info)\nhelp: use `Option::is_some` to test if the `Option` has a value\n |\n37 | html! { };\n | ++++++++++\n\nerror[E0308]: mismatched types\n --> tests/html_macro/element-fail.rs:38:29\n |\n38 | html! { };\n | ^\n | |\n | expected `bool`, found integer\n | arguments to this function are incorrect\n |\nnote: function defined here\n --> $WORKSPACE/packages/yew/src/utils/mod.rs\n |\n | pub fn __ensure_type(_: T) {}\n | ^^^^^^^^^^^^^\n\nerror[E0308]: mismatched types\n --> tests/html_macro/element-fail.rs:39:30\n |\n39 | html! { };\n | ^^^^^^^^^^ expected `bool`, found `Option`\n |\n = note: expected type `bool`\n found enum `Option`\nhelp: use `Option::is_some` to test if the `Option` has a value\n |\n39 | html! { };\n | ++++++++++\n\nerror[E0308]: mismatched types\n --> tests/html_macro/element-fail.rs:40:30\n |\n40 | html! { };\n | ^^ the trait `IntoPropValue>` is not implemented for `()`\n |\n = help: the trait `IntoPropValue>` is not implemented for `()`\n but trait `IntoPropValue` is implemented for it\n = help: for that trait implementation, expected `VNode`, found `Option`\n\nerror[E0277]: the trait bound `NotToString: IntoPropValue>` is not satisfied\n --> tests/html_macro/element-fail.rs:46:28\n |\n46 | html! { };\n | ^^^^^^^^^^^ the trait `IntoPropValue>` is not implemented for `NotToString`\n |\n = help: the following other types implement trait `IntoPropValue`:\n `&&String` implements `IntoPropValue>`\n `&&String` implements `IntoPropValue`\n `&&str` implements `IntoPropValue>`\n `&&str` implements `IntoPropValue`\n `&'static [(K, V)]` implements `IntoPropValue>`\n `&'static [T]` implements `IntoPropValue>`\n `&'static str` implements `IntoPropValue`\n `&'static str` implements `IntoPropValue>`\n and $N others\n\nerror[E0277]: the trait bound `Option: IntoPropValue>` is not satisfied\n --> tests/html_macro/element-fail.rs:47:23\n |\n47 | html! { };\n | ----^^^^^^^^^^^^^\n | |\n | the trait `IntoPropValue>` is not implemented for `Option`\n | required by a bound introduced by this call\n |\n = help: the following other types implement trait `IntoPropValue`:\n `Option<&String>` implements `IntoPropValue>`\n `Option<&implicit_clone::unsync::string::IString>` implements `IntoPropValue>`\n `Option<&str>` implements `IntoPropValue>`\n `Option<&str>` implements `IntoPropValue>`\n `Option<&str>` implements `IntoPropValue>`\n `Option>` implements `IntoPropValue>`\n `Option>` implements `IntoPropValue>`\n `Option>` implements `IntoPropValue>`\n and $N others\n\nerror[E0277]: the trait bound `Option<{integer}>: IntoPropValue>` is not satisfied\n --> tests/html_macro/element-fail.rs:48:22\n |\n48 | html! { };\n | ----^^^\n | |\n | the trait `IntoPropValue>` is not implemented for `Option<{integer}>`\n | required by a bound introduced by this call\n |\n = help: the following other types implement trait `IntoPropValue`:\n `Option<&String>` implements `IntoPropValue>`\n `Option<&implicit_clone::unsync::string::IString>` implements `IntoPropValue>`\n `Option<&str>` implements `IntoPropValue>`\n `Option<&str>` implements `IntoPropValue>`\n `Option<&str>` implements `IntoPropValue>`\n `Option>` implements `IntoPropValue>`\n `Option>` implements `IntoPropValue>`\n `Option>` implements `IntoPropValue>`\n and $N others\n\nerror[E0277]: the trait bound `{integer}: IntoEventCallback` is not satisfied\n --> tests/html_macro/element-fail.rs:51:28\n |\n51 | html! { };\n | -----------------------^-----\n | | |\n | | the trait `Fn(MouseEvent)` is not implemented for `{integer}`\n | required by a bound introduced by this call\n |\n = help: the following other types implement trait `IntoEventCallback`:\n &yew::Callback\n Option\n Option>\n yew::Callback\n = note: required for `{integer}` to implement `IntoEventCallback`\nnote: required by a bound in `yew::html::onclick::Wrapper::__macro_new`\n --> $WORKSPACE/packages/yew/src/html/listener/events.rs\n |\n | / impl_short! {\n | | onauxclick(MouseEvent)\n | | onclick(MouseEvent)\n... |\n | | ontransitionstart(TransitionEvent)\n | | }\n | | ^\n | | |\n | |_required by a bound in this associated function\n | required by this bound in `Wrapper::__macro_new`\n = note: this error originates in the macro `impl_action` which comes from the expansion of the macro `impl_short` (in Nightly builds, run with -Z macro-backtrace for more info)\n\nerror[E0277]: the trait bound `yew::Callback: IntoEventCallback` is not satisfied\n --> tests/html_macro/element-fail.rs:52:29\n |\n52 | html! { };\n | ------------------------^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^------\n | | |\n | | the trait `Fn(MouseEvent)` is not implemented for `yew::Callback`\n | required by a bound introduced by this call\n |\n = help: the following other types implement trait `IntoEventCallback`:\n &yew::Callback\n yew::Callback\n = note: required for `yew::Callback` to implement `IntoEventCallback`\nnote: required by a bound in `yew::html::onclick::Wrapper::__macro_new`\n --> $WORKSPACE/packages/yew/src/html/listener/events.rs\n |\n | / impl_short! {\n | | onauxclick(MouseEvent)\n | | onclick(MouseEvent)\n... |\n | | ontransitionstart(TransitionEvent)\n | | }\n | | ^\n | | |\n | |_required by a bound in this associated function\n | required by this bound in `Wrapper::__macro_new`\n = note: this error originates in the macro `impl_action` which comes from the expansion of the macro `impl_short` (in Nightly builds, run with -Z macro-backtrace for more info)\n\nerror[E0277]: the trait bound `Option<{integer}>: IntoEventCallback` is not satisfied\n --> tests/html_macro/element-fail.rs:53:29\n |\n53 | html! { };\n | ------------------------^^^^^^^------\n | | |\n | | the trait `IntoEventCallback` is not implemented for `Option<{integer}>`\n | required by a bound introduced by this call\n |\n = help: the following other types implement trait `IntoEventCallback`:\n Option\n Option>\nnote: required by a bound in `yew::html::onfocus::Wrapper::__macro_new`\n --> $WORKSPACE/packages/yew/src/html/listener/events.rs\n |\n | / impl_short! {\n | | onauxclick(MouseEvent)\n | | onclick(MouseEvent)\n... |\n | | ontransitionstart(TransitionEvent)\n | | }\n | | ^\n | | |\n | |_required by a bound in this associated function\n | required by this bound in `Wrapper::__macro_new`\n = note: this error originates in the macro `impl_action` which comes from the expansion of the macro `impl_short` (in Nightly builds, run with -Z macro-backtrace for more info)\n\nerror[E0277]: the trait bound `(): IntoPropValue` is not satisfied\n --> tests/html_macro/element-fail.rs:56:25\n |\n56 | html! { };\n | ^^\n | |\n | the trait `IntoPropValue` is not implemented for `()`\n | required by a bound introduced by this call\n |\n = help: the trait `IntoPropValue` is not implemented for `()`\n but trait `IntoPropValue` is implemented for it\n = help: for that trait implementation, expected `VNode`, found `yew::NodeRef`\n\nerror[E0277]: the trait bound `Option: IntoPropValue` is not satisfied\n --> tests/html_macro/element-fail.rs:57:25\n |\n57 | html! { };\n | ----^^^^^^^^^^^^^^^^^^^^\n | |\n | the trait `IntoPropValue` is not implemented for `Option`\n | required by a bound introduced by this call\n |\n = help: the following other types implement trait `IntoPropValue`:\n `Option<&String>` implements `IntoPropValue>`\n `Option<&implicit_clone::unsync::string::IString>` implements `IntoPropValue>`\n `Option<&str>` implements `IntoPropValue>`\n `Option<&str>` implements `IntoPropValue>`\n `Option<&str>` implements `IntoPropValue>`\n `Option>` implements `IntoPropValue>`\n `Option>` implements `IntoPropValue>`\n `Option>` implements `IntoPropValue>`\n and $N others\n\nerror[E0277]: the trait bound `yew::Callback: IntoEventCallback` is not satisfied\n --> tests/html_macro/element-fail.rs:58:29\n |\n58 | html! { };\n | ------------------------^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^------\n | | |\n | | the trait `Fn(MouseEvent)` is not implemented for `yew::Callback`\n | required by a bound introduced by this call\n |\n = help: the following other types implement trait `IntoEventCallback`:\n &yew::Callback\n yew::Callback\n = note: required for `yew::Callback` to implement `IntoEventCallback`\nnote: required by a bound in `yew::html::onclick::Wrapper::__macro_new`\n --> $WORKSPACE/packages/yew/src/html/listener/events.rs\n |\n | / impl_short! {\n | | onauxclick(MouseEvent)\n | | onclick(MouseEvent)\n... |\n | | ontransitionstart(TransitionEvent)\n | | }\n | | ^\n | | |\n | |_required by a bound in this associated function\n | required by this bound in `Wrapper::__macro_new`\n = note: this error originates in the macro `impl_action` which comes from the expansion of the macro `impl_short` (in Nightly builds, run with -Z macro-backtrace for more info)\n\nerror[E0277]: the trait bound `NotToString: IntoPropValue>` is not satisfied\n --> tests/html_macro/element-fail.rs:60:28\n |\n60 | html! { };\n | ^^^^^^^^^^^ the trait `IntoPropValue>` is not implemented for `NotToString`\n |\n = help: the following other types implement trait `IntoPropValue`:\n `&&String` implements `IntoPropValue>`\n `&&String` implements `IntoPropValue`\n `&&str` implements `IntoPropValue>`\n `&&str` implements `IntoPropValue`\n `&'static [(K, V)]` implements `IntoPropValue>`\n `&'static [T]` implements `IntoPropValue>`\n `&'static str` implements `IntoPropValue`\n `&'static str` implements `IntoPropValue>`\n and $N others\n\nerror[E0277]: the trait bound `(): IntoPropValue` is not satisfied\n --> tests/html_macro/element-fail.rs:62:25\n |\n62 | html! { };\n | ^^\n | |\n | the trait `IntoPropValue` is not implemented for `()`\n | required by a bound introduced by this call\n |\n = help: the trait `IntoPropValue` is not implemented for `()`\n but trait `IntoPropValue` is implemented for it\n = help: for that trait implementation, expected `VNode`, found `yew::NodeRef`\n\nerror[E0277]: the trait bound `implicit_clone::unsync::string::IString: From<{integer}>` is not satisfied\n --> tests/html_macro/element-fail.rs:79:16\n |\n79 | html! { <@{55}> };\n | ^^ the trait `From<{integer}>` is not implemented for `implicit_clone::unsync::string::IString`\n |\n = help: the following other types implement trait `From`:\n `implicit_clone::unsync::string::IString` implements `From<&Classes>`\n `implicit_clone::unsync::string::IString` implements `From<&implicit_clone::unsync::string::IString>`\n `implicit_clone::unsync::string::IString` implements `From<&str>`\n `implicit_clone::unsync::string::IString` implements `From>`\n `implicit_clone::unsync::string::IString` implements `From>`\n `implicit_clone::unsync::string::IString` implements `From>`\n `implicit_clone::unsync::string::IString` implements `From`\n = note: required for `{integer}` to implement `Into`\n" }, { "path": "packages/yew-macro/tests/html_macro/for-fail.rs", "content": "mod smth {\n const KEY: u32 = 42;\n}\n\nfn main() {\n _ = ::yew::html!{for x};\n _ = ::yew::html!{for x in};\n _ = ::yew::html!{for x in 0 .. 10};\n _ = ::yew::html!{for (x, y) in 0 .. 10 {\n {x}\n }};\n\n _ = ::yew::html!{for _ in 0 .. 10 {\n {break}\n }};\n\n _ = ::yew::html!{for _ in 0 .. 10 {\n
\n }};\n\n _ = ::yew::html!{for _ in 0 .. 10 {\n
\n }};\n}\n" }, { "path": "packages/yew-macro/tests/html_macro/for-fail.stderr", "content": "error: unexpected end of input, expected `in`\n --> tests/html_macro/for-fail.rs:6:9\n |\n6 | _ = ::yew::html!{for x};\n | ^^^^^^^^^^^^^^^^^^^\n |\n = note: this error originates in the macro `::yew::html` (in Nightly builds, run with -Z macro-backtrace for more info)\n\nerror: unexpected end of input, expected an expression\n --> tests/html_macro/for-fail.rs:7:9\n |\n7 | _ = ::yew::html!{for x in};\n | ^^^^^^^^^^^^^^^^^^^^^^\n |\n = note: this error originates in the macro `::yew::html` (in Nightly builds, run with -Z macro-backtrace for more info)\n\nerror: unexpected end of input, expected curly braces\n --> tests/html_macro/for-fail.rs:8:9\n |\n8 | _ = ::yew::html!{for x in 0 .. 10};\n | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^\n |\n = note: this error originates in the macro `::yew::html` (in Nightly builds, run with -Z macro-backtrace for more info)\n\nerror: duplicate key for a node in a `for`-loop\n this will create elements with duplicate keys if the loop iterates more than once\n --> tests/html_macro/for-fail.rs:18:18\n |\n18 |
\n | ^^^^^^^^^^^\n\nerror: duplicate key for a node in a `for`-loop\n this will create elements with duplicate keys if the loop iterates more than once\n --> tests/html_macro/for-fail.rs:22:19\n |\n22 |
\n | ^^^^\n\nerror[E0267]: `break` inside of a closure\n --> tests/html_macro/for-fail.rs:14:16\n |\n13 | _ = ::yew::html!{for _ in 0 .. 10 {\n | _________-\n14 | | {break}\n | | ^^^^^ cannot `break` inside of a closure\n15 | | }};\n | |______- enclosing closure\n\nerror[E0308]: mismatched types\n --> tests/html_macro/for-fail.rs:9:26\n |\n9 | _ = ::yew::html!{for (x, y) in 0 .. 10 {\n | ^^^^^^\n | |\n | expected integer, found `(_, _)`\n | expected due to this\n |\n = note: expected type `{integer}`\n found tuple `(_, _)`\n" }, { "path": "packages/yew-macro/tests/html_macro/for-pass.rs", "content": "#![no_implicit_prelude]\n\n// Shadow primitives\n#[allow(non_camel_case_types)]\npub struct bool;\n#[allow(non_camel_case_types)]\npub struct char;\n#[allow(non_camel_case_types)]\npub struct f32;\n#[allow(non_camel_case_types)]\npub struct f64;\n#[allow(non_camel_case_types)]\npub struct i128;\n#[allow(non_camel_case_types)]\npub struct i16;\n#[allow(non_camel_case_types)]\npub struct i32;\n#[allow(non_camel_case_types)]\npub struct i64;\n#[allow(non_camel_case_types)]\npub struct i8;\n#[allow(non_camel_case_types)]\npub struct isize;\n#[allow(non_camel_case_types)]\npub struct str;\n#[allow(non_camel_case_types)]\npub struct u128;\n#[allow(non_camel_case_types)]\npub struct u16;\n#[allow(non_camel_case_types)]\npub struct u32;\n#[allow(non_camel_case_types)]\npub struct u64;\n#[allow(non_camel_case_types)]\npub struct u8;\n#[allow(non_camel_case_types)]\npub struct usize;\n\nfn main() {\n _ = ::yew::html!{\n for i in 0 .. 10 {\n {i}\n }\n };\n\n struct Pair {\n value1: &'static ::std::primitive::str,\n value2: ::std::primitive::i32\n }\n\n _ = ::yew::html! {\n for Pair { value1, value2 } in ::std::iter::Iterator::map(0 .. 10, |value2| Pair { value1: \"Yew\", value2 }) {\n {value1}\n {value2}\n }\n };\n\n fn rand_number() -> ::std::primitive::u32 {\n 4 // chosen by fair dice roll. guaranteed to be random.\n }\n\n _ = ::yew::html!{\n for _ in 0..5 {\n
\n {{\n loop {\n let a = rand_number();\n if a % 2 == 0 {\n break a;\n }\n }\n }}\n
\n }\n }\n}\n" }, { "path": "packages/yew-macro/tests/html_macro/generic-component-fail.rs", "content": "use std::marker::PhantomData;\r\nuse yew::prelude::*;\r\n\r\npub struct Generic {\r\n marker: PhantomData,\r\n}\r\n\r\nimpl Component for Generic\r\nwhere\r\n T: 'static,\r\n{\r\n type Message = ();\r\n type Properties = ();\r\n\r\n fn create(_ctx: &Context) -> Self {\r\n unimplemented!()\r\n }\r\n fn view(&self, _ctx: &Context) -> Html {\r\n unimplemented!()\r\n }\r\n}\r\n\r\npub struct Generic2 {\r\n marker: PhantomData<(T1, T2)>,\r\n}\r\n\r\nimpl Component for Generic2\r\nwhere\r\n T1: 'static,\r\n T2: 'static,\r\n{\r\n type Message = ();\r\n type Properties = ();\r\n\r\n fn create(_ctx: &Context) -> Self {\r\n unimplemented!()\r\n }\r\n fn view(&self, _ctx: &Context) -> Html {\r\n unimplemented!()\r\n }}\r\n\r\nfn compile_fail() {\r\n #[allow(unused_imports)]\r\n use std::path::Path;\r\n\r\n html! { > };\r\n html! { > };\r\n html! { >>> };\r\n\r\n html! { >> };\r\n html! { > };\r\n}\r\n\r\nfn main() {}\r\n" }, { "path": "packages/yew-macro/tests/html_macro/generic-component-fail.stderr", "content": "error: this opening tag has no corresponding closing tag\n --> tests/html_macro/generic-component-fail.rs:46:13\n |\n46 | html! { > };\n | ^^^^^^^^^^^^^^^^^\n\nerror: mismatched closing tags: expected `Generic`, found `Generic`\n --> tests/html_macro/generic-component-fail.rs:47:14\n |\n47 | html! { > };\n | ^^^^^^^^^^^^^^^^^^^^^^^^^\n\nerror: mismatched closing tags: expected `Generic`, found `Generic>`\n --> tests/html_macro/generic-component-fail.rs:48:14\n |\n48 | html! { >>> };\n | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^\n\nerror: mismatched closing tags: expected `Generic`, found `Generic`\n --> tests/html_macro/generic-component-fail.rs:50:14\n |\n50 | html! { >> };\n | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^\n\nerror: expected a valid closing tag for component\n note: found opening tag `>`\n help: try `>`\n --> tests/html_macro/generic-component-fail.rs:51:30\n |\n51 | html! { > };\n | ^^^\n" }, { "path": "packages/yew-macro/tests/html_macro/generic-component-pass.rs", "content": "#![no_implicit_prelude]\r\n\r\n// Shadow primitives\r\n#[allow(non_camel_case_types)]\r\npub struct bool;\r\n#[allow(non_camel_case_types)]\r\npub struct char;\r\n#[allow(non_camel_case_types)]\r\npub struct f32;\r\n#[allow(non_camel_case_types)]\r\npub struct f64;\r\n#[allow(non_camel_case_types)]\r\npub struct i128;\r\n#[allow(non_camel_case_types)]\r\npub struct i16;\r\n#[allow(non_camel_case_types)]\r\npub struct i32;\r\n#[allow(non_camel_case_types)]\r\npub struct i64;\r\n#[allow(non_camel_case_types)]\r\npub struct i8;\r\n#[allow(non_camel_case_types)]\r\npub struct isize;\r\n#[allow(non_camel_case_types)]\r\npub struct str;\r\n#[allow(non_camel_case_types)]\r\npub struct u128;\r\n#[allow(non_camel_case_types)]\r\npub struct u16;\r\n#[allow(non_camel_case_types)]\r\npub struct u32;\r\n#[allow(non_camel_case_types)]\r\npub struct u64;\r\n#[allow(non_camel_case_types)]\r\npub struct u8;\r\n#[allow(non_camel_case_types)]\r\npub struct usize;\r\n\r\npub struct Generic {\r\n marker: ::std::marker::PhantomData,\r\n}\r\n\r\nimpl ::yew::Component for Generic\r\nwhere\r\n T: 'static,\r\n{\r\n type Message = ();\r\n type Properties = ();\r\n\r\n fn create(_ctx: &::yew::Context) -> Self {\r\n ::std::unimplemented!()\r\n }\r\n fn view(&self, _ctx: &::yew::Context) -> ::yew::Html {\r\n ::std::unimplemented!()\r\n }\r\n}\r\n\r\npub struct Generic2 {\r\n marker: ::std::marker::PhantomData<(T1, T2)>,\r\n}\r\n\r\nimpl ::yew::Component for Generic2\r\nwhere\r\n T1: 'static,\r\n T2: 'static,\r\n{\r\n type Message = ();\r\n type Properties = ();\r\n\r\n fn create(_ctx: &::yew::Context) -> Self {\r\n ::std::unimplemented!()\r\n }\r\n fn view(&self, _ctx: &::yew::Context) -> ::yew::Html {\r\n ::std::unimplemented!()\r\n }\r\n}\r\n\r\nfn compile_pass() {\r\n _ = ::yew::html! { /> };\r\n _ = ::yew::html! { /> };\r\n _ = ::yew::html! { >> };\r\n _ = ::yew::html! { >> };\r\n\r\n _ = ::yew::html! { > /> };\r\n _ = ::yew::html! { >>>> };\r\n\r\n _ = ::yew::html! { /> };\r\n _ = ::yew::html! { >> };\r\n _ = ::yew::html! { /> };\r\n _ = ::yew::html! { >> };\r\n\r\n _ = ::yew::html! { /> };\r\n _ = ::yew::html! { >> };\r\n\r\n _ = ::yew::html! { /> };\r\n _ = ::yew::html! { >> };\r\n}\r\n\r\nfn main() {}\r\n" }, { "path": "packages/yew-macro/tests/html_macro/html-component-fail.stderr", "content": "error: this opening tag has no corresponding closing tag\n --> $DIR/html-component-fail.rs:78:13\n |\n78 | html! { };\n | ^^^^^^^\n\nerror: unexpected end of input, expected identifier\n --> $DIR/html-component-fail.rs:79:13\n |\n79 | html! { };\n | ^^^^^^^^^^^\n\nerror: expected expression following this `with`\n --> $DIR/html-component-fail.rs:80:20\n |\n80 | html! { };\n | ^^^^\n\nerror: `props` doesn't have a value. (hint: set the value to `true` or `false` for boolean attributes)\n --> $DIR/html-component-fail.rs:81:20\n |\n81 | html! { };\n | ^^^^^\n\nerror: this opening tag has no corresponding closing tag\n --> $DIR/html-component-fail.rs:82:13\n |\n82 | html! { };\n | ^^^^^^^^^^^^^^^^^^^\n\nerror: there are two `with ` definitions for this component (note: you can only define `with ` once)\n --> $DIR/html-component-fail.rs:84:20\n |\n84 | html! { };\n | ^^^^^^^\n\nerror: `ref` can only be set once\n --> $DIR/html-component-fail.rs:85:38\n |\n85 | html! { };\n | ^^^\n\nerror: `ref` can only be set once\n --> $DIR/html-component-fail.rs:86:38\n |\n86 | html! { };\n | ^^^\n\nerror: Using the `with props` syntax in combination with named props is not allowed (note: this does not apply to special props like `ref` and `key`)\n --> $DIR/html-component-fail.rs:87:38\n |\n87 | html! { };\n | ^^^^^\n\nerror: Using the `with props` syntax in combination with named props is not allowed (note: this does not apply to special props like `ref` and `key`)\n --> $DIR/html-component-fail.rs:88:31\n |\n88 | html! { };\n | ^^^^^\n\nerror: Using the `with props` syntax in combination with named props is not allowed (note: this does not apply to special props like `ref` and `key`)\n --> $DIR/html-component-fail.rs:89:20\n |\n89 | html! { };\n | ^^^^^\n\nerror: Using the `with props` syntax in combination with named props is not allowed (note: this does not apply to special props like `ref` and `key`)\n --> $DIR/html-component-fail.rs:90:20\n |\n90 | html! { };\n | ^^^^^\n\nerror: `ref` can only be set once\n --> $DIR/html-component-fail.rs:91:27\n |\n91 | html! { };\n | ^^^\n\nerror: Using the `with props` syntax in combination with named props is not allowed (note: this does not apply to special props like `ref` and `key`)\n --> $DIR/html-component-fail.rs:93:20\n |\n93 | html! { };\n | ^^^^^\n\nerror: Using the `with props` syntax in combination with named props is not allowed (note: this does not apply to special props like `ref` and `key`)\n --> $DIR/html-component-fail.rs:94:31\n |\n94 | html! { };\n | ^^^^^\n\nerror: expected identifier, found keyword `type`\n --> $DIR/html-component-fail.rs:95:20\n |\n95 | html! { };\n | ^^^^ expected identifier, found keyword\n |\nhelp: you can escape reserved keywords to use them as identifiers\n |\n95 | html! { };\n | ^^^^^^\n\nerror: expected a valid Rust identifier\n --> $DIR/html-component-fail.rs:96:20\n |\n96 | html! { };\n | ^^^^^^^^^^^^^^^^^\n\nerror: expected an expression following this equals sign\n --> $DIR/html-component-fail.rs:98:26\n |\n98 | html! { };\n | ^\n\nerror: `int` can only be specified once but is given here again\n --> $DIR/html-component-fail.rs:99:26\n |\n99 | html! { };\n | ^^^\n\nerror: `int` can only be specified once but is given here again\n --> $DIR/html-component-fail.rs:99:32\n |\n99 | html! { };\n | ^^^\n\nerror: `ref` can only be specified once\n --> $DIR/html-component-fail.rs:104:26\n |\n104 | html! { };\n | ^^^\n\nerror: this closing tag has no corresponding opening tag\n --> $DIR/html-component-fail.rs:107:13\n |\n107 | html! { };\n | ^^^^^^^^\n\nerror: this opening tag has no corresponding closing tag\n --> $DIR/html-component-fail.rs:108:13\n |\n108 | html! { };\n | ^^^^^^^\n\nerror: only one root html element is allowed (hint: you can wrap multiple html elements in a fragment `<>`)\n --> $DIR/html-component-fail.rs:109:28\n |\n109 | html! { };\n | ^^^^^^^^^^^^^^^\n\nerror: cannot specify the `children` prop when the component already has children\n --> $DIR/html-component-fail.rs:128:25\n |\n128 | \n | ^^^^^^^^\n\nerror: this closing tag has no corresponding opening tag\n --> $DIR/html-component-fail.rs:133:30\n |\n133 | html! { > };\n | ^^^^^^^^^^\n\nerror: this closing tag has no corresponding opening tag\n --> $DIR/html-component-fail.rs:134:30\n |\n134 | html! { >>> };\n | ^^^^^^^^^^^^^^^^^^^^^^^\n\nerror: only one root html element is allowed (hint: you can wrap multiple html elements in a fragment `<>`)\n --> $DIR/html-component-fail.rs:138:9\n |\n138 | { 2 }\n | ^^^^^^^^^^^^^^^^^^\n\nerror: optional attributes are only supported on elements. Components can use `Option` properties to accomplish the same thing.\n --> $DIR/html-component-fail.rs:141:28\n |\n141 | html! { };\n | ^^^^^\n\nerror[E0425]: cannot find value `blah` in this scope\n --> $DIR/html-component-fail.rs:92:25\n |\n92 | html! { };\n | ^^^^ not found in this scope\n\nerror[E0609]: no field `r#type` on type `ChildProperties`\n --> $DIR/html-component-fail.rs:95:20\n |\n95 | html! { };\n | ^^^^ unknown field\n |\n = note: available fields are: `string`, `int`\n\nerror[E0599]: no method named `r#type` found for struct `ChildPropertiesBuilder` in the current scope\n --> $DIR/html-component-fail.rs:95:20\n |\n5 | #[derive(Clone, Properties, PartialEq)]\n | ---------- method `r#type` not found for this\n...\n95 | html! { };\n | ^^^^ method not found in `ChildPropertiesBuilder`\n\nerror[E0609]: no field `unknown` on type `ChildProperties`\n --> $DIR/html-component-fail.rs:97:20\n |\n97 | html! { };\n | ^^^^^^^ unknown field\n |\n = note: available fields are: `string`, `int`\n\nerror[E0599]: no method named `unknown` found for struct `ChildPropertiesBuilder` in the current scope\n --> $DIR/html-component-fail.rs:97:20\n |\n5 | #[derive(Clone, Properties, PartialEq)]\n | ---------- method `unknown` not found for this\n...\n97 | html! { };\n | ^^^^^^^ method not found in `ChildPropertiesBuilder`\n\nerror[E0277]: the trait bound `yew::virtual_dom::vcomp::VComp: yew::virtual_dom::Transformer<(), std::string::String>` is not satisfied\n --> $DIR/html-component-fail.rs:100:33\n |\n100 | html! { };\n | ^^ the trait `yew::virtual_dom::Transformer<(), std::string::String>` is not implemented for `yew::virtual_dom::vcomp::VComp`\n |\n = help: the following implementations were found:\n >\n >>\n >>\n >\n and 3 others\n = note: required by `yew::virtual_dom::Transformer::transform`\n\nerror[E0277]: the trait bound `yew::virtual_dom::vcomp::VComp: yew::virtual_dom::Transformer<{integer}, std::string::String>` is not satisfied\n --> $DIR/html-component-fail.rs:101:33\n |\n101 | html! { };\n | ^ the trait `yew::virtual_dom::Transformer<{integer}, std::string::String>` is not implemented for `yew::virtual_dom::vcomp::VComp`\n |\n = help: the following implementations were found:\n >\n >>\n >>\n >\n and 3 others\n = note: required by `yew::virtual_dom::Transformer::transform`\n\nerror[E0277]: the trait bound `yew::virtual_dom::vcomp::VComp: yew::virtual_dom::Transformer<{integer}, std::string::String>` is not satisfied\n --> $DIR/html-component-fail.rs:102:33\n |\n102 | html! { };\n | ^^^ the trait `yew::virtual_dom::Transformer<{integer}, std::string::String>` is not implemented for `yew::virtual_dom::vcomp::VComp`\n |\n = help: the following implementations were found:\n >\n >>\n >>\n >\n and 3 others\n = note: required by `yew::virtual_dom::Transformer::transform`\n\nerror[E0308]: mismatched types\n --> $DIR/html-component-fail.rs:103:30\n |\n103 | html! { };\n | ^^ expected struct `yew::html::NodeRef`, found `()`\n\nerror[E0277]: the trait bound `yew::virtual_dom::vcomp::VComp: yew::virtual_dom::Transformer` is not satisfied\n --> $DIR/html-component-fail.rs:105:24\n |\n105 | html! { };\n | ^^^^ the trait `yew::virtual_dom::Transformer` is not implemented for `yew::virtual_dom::vcomp::VComp`\n |\n = help: the following implementations were found:\n >\n >>\n >>\n >\n and 3 others\n = note: required by `yew::virtual_dom::Transformer::transform`\n\nerror[E0599]: no method named `string` found for struct `ChildPropertiesBuilder` in the current scope\n --> $DIR/html-component-fail.rs:106:20\n |\n5 | #[derive(Clone, Properties, PartialEq)]\n | ---------- method `string` not found for this\n...\n106 | html! { };\n | ^^^^^^ method not found in `ChildPropertiesBuilder`\n |\n = help: items from traits can only be used if the trait is implemented and in scope\n = note: the following trait defines an item `string`, perhaps you need to implement it:\n candidate #1: `proc_macro::bridge::server::Literal`\n\nerror[E0609]: no field `children` on type `ChildProperties`\n --> $DIR/html-component-fail.rs:110:14\n |\n110 | html! { { \"Not allowed\" } };\n | ^^^^^ unknown field\n |\n = note: available fields are: `string`, `int`\n\nerror[E0599]: no method named `children` found for struct `ChildPropertiesBuilder` in the current scope\n --> $DIR/html-component-fail.rs:110:14\n |\n5 | #[derive(Clone, Properties, PartialEq)]\n | ---------- method `children` not found for this\n...\n110 | html! { { \"Not allowed\" } };\n | ^^^^^ method not found in `ChildPropertiesBuilder`\n\nerror[E0609]: no field `children` on type `ChildProperties`\n --> $DIR/html-component-fail.rs:114:10\n |\n114 | \n | ^^^^^ unknown field\n |\n = note: available fields are: `string`, `int`\n\nerror[E0599]: no method named `build` found for struct `ChildContainerPropertiesBuilder` in the current scope\n --> $DIR/html-component-fail.rs:119:14\n |\n31 | #[derive(Clone, Properties)]\n | ---------- method `build` not found for this\n...\n119 | html! { };\n | ^^^^^^^^^^^^^^ method not found in `ChildContainerPropertiesBuilder`\n |\n = help: items from traits can only be used if the trait is implemented and in scope\n = note: the following trait defines an item `build`, perhaps you need to implement it:\n candidate #1: `proc_macro::bridge::server::TokenStreamBuilder`\n\nerror[E0599]: no method named `build` found for struct `ChildContainerPropertiesBuilder` in the current scope\n --> $DIR/html-component-fail.rs:120:14\n |\n31 | #[derive(Clone, Properties)]\n | ---------- method `build` not found for this\n...\n120 | html! { };\n | ^^^^^^^^^^^^^^ method not found in `ChildContainerPropertiesBuilder`\n |\n = help: items from traits can only be used if the trait is implemented and in scope\n = note: the following trait defines an item `build`, perhaps you need to implement it:\n candidate #1: `proc_macro::bridge::server::TokenStreamBuilder`\n\nerror[E0277]: the trait bound `yew::virtual_dom::vcomp::VChild: std::convert::From` is not satisfied\n --> $DIR/html-component-fail.rs:121:31\n |\n121 | html! { { \"Not allowed\" } };\n | ^^^^^^^^^^^^^ the trait `std::convert::From` is not implemented for `yew::virtual_dom::vcomp::VChild`\n |\n = note: required because of the requirements on the impl of `std::convert::Into>` for `yew::virtual_dom::vtext::VText`\n = note: required by `std::convert::Into::into`\n\nerror[E0277]: the trait bound `yew::virtual_dom::vcomp::VChild: std::convert::From` is not satisfied\n --> $DIR/html-component-fail.rs:122:29\n |\n122 | html! { <> };\n | ^ the trait `std::convert::From` is not implemented for `yew::virtual_dom::vcomp::VChild`\n |\n = note: required because of the requirements on the impl of `std::convert::Into>` for `yew::virtual_dom::vnode::VNode`\n = note: required by `std::convert::Into::into`\n\nerror[E0277]: the trait bound `yew::virtual_dom::vcomp::VChild: std::convert::From` is not satisfied\n --> $DIR/html-component-fail.rs:123:30\n |\n123 | html! { };\n | ^^^^^ the trait `std::convert::From` is not implemented for `yew::virtual_dom::vcomp::VChild`\n |\n = note: required because of the requirements on the impl of `std::convert::Into>` for `yew::virtual_dom::vnode::VNode`\n = note: required by `std::convert::Into::into`\n" }, { "path": "packages/yew-macro/tests/html_macro/html-element-pass.rs", "content": "#![no_implicit_prelude]\n\n// Shadow primitives\n#[allow(non_camel_case_types)]\npub struct bool;\n#[allow(non_camel_case_types)]\npub struct char;\n#[allow(non_camel_case_types)]\npub struct f32;\n#[allow(non_camel_case_types)]\npub struct f64;\n#[allow(non_camel_case_types)]\npub struct i128;\n#[allow(non_camel_case_types)]\npub struct i16;\n#[allow(non_camel_case_types)]\npub struct i32;\n#[allow(non_camel_case_types)]\npub struct i64;\n#[allow(non_camel_case_types)]\npub struct i8;\n#[allow(non_camel_case_types)]\npub struct isize;\n#[allow(non_camel_case_types)]\npub struct str;\n#[allow(non_camel_case_types)]\npub struct u128;\n#[allow(non_camel_case_types)]\npub struct u16;\n#[allow(non_camel_case_types)]\npub struct u32;\n#[allow(non_camel_case_types)]\npub struct u64;\n#[allow(non_camel_case_types)]\npub struct u8;\n#[allow(non_camel_case_types)]\npub struct usize;\n\nfn compile_pass() {\n let onclick = <::yew::Callback<::yew::events::MouseEvent> as ::std::convert::From<_>>::from(\n |_: ::yew::events::MouseEvent| (),\n );\n let parent_ref = <::yew::NodeRef as ::std::default::Default>::default();\n\n let dyn_tag =\n || <::std::string::String as ::std::convert::From<&::std::primitive::str>>::from(\"test\");\n let mut extra_tags_iter = ::std::iter::IntoIterator::into_iter(::std::vec![\"a\", \"b\"]);\n\n let attr_val_none: ::std::option::Option<::yew::virtual_dom::AttrValue> = ::std::option::Option::None;\n\n _ = ::yew::html! {\n
\n
\n
\n
\n \n \n \n \n \n```\n\nWhich would fail to compile, it's customary to write\n\n```html\n\n```\n\nWhich would fail to compile, it's customary to write\n\n```html\n\n```\n\nWhich would fail to compile, it's customary to write\n\n```html\n