Merge pull request #1800 from DioxusLabs/jk/fix-miri-test-setup

Tweak CI with new caching

.github/workflows/main.yml

@@ -33,9 +33,12 @@ concurrency:
 
 env:
   CARGO_TERM_COLOR: always
-  CARGO_INCREMENTAL: 0
+  CARGO_INCREMENTAL: "0"
   SCCACHE_GHA_ENABLED: "true"
-  RUSTC_WRAPPER: "sccache"
+  # RUSTC_WRAPPER: "sccache"
+  SCCACHE_IDLE_TIMEOUT: "0"
+  SCCACHE_GHA_VERSION: "sccache"
+  SCCACHE_BYPASS_CHECK: "on"
 
 jobs:
   check:
@@ -43,12 +46,15 @@ jobs:
     name: Check
     runs-on: ubuntu-latest
     steps:
-      - run: sudo apt-get update
-      - run: sudo apt install libwebkit2gtk-4.1-dev libgtk-3-dev libayatana-appindicator3-dev
-      - uses: dtolnay/rust-toolchain@stable
-      - uses: mozilla-actions/sccache-action@v0.0.3
-      - uses: ilammy/setup-nasm@v1
       - uses: actions/checkout@v4
+      - run: sudo apt-get update
+      - run: sudo apt install libwebkit2gtk-4.1-dev libgtk-3-dev libayatana-appindicator3-dev libxdo-dev
+      - uses: dtolnay/rust-toolchain@stable
+      - uses: Swatinem/rust-cache@v2
+        with:
+          cache-all-crates: "true"
+          save-if: ${{ github.ref == 'refs/heads/master' }}
+      - uses: ilammy/setup-nasm@v1
       - run: cargo check --all --examples --tests
 
   test:
@@ -56,15 +62,18 @@ jobs:
     name: Test Suite
     runs-on: ubuntu-latest
     steps:
+      - uses: actions/checkout@v4
       - run: sudo apt-get update
       - run: sudo apt install libwebkit2gtk-4.1-dev libgtk-3-dev libayatana-appindicator3-dev libxdo-dev
       - uses: dtolnay/rust-toolchain@stable
-      - uses: mozilla-actions/sccache-action@v0.0.3
+      - uses: Swatinem/rust-cache@v2
+        with:
+          cache-all-crates: "true"
+          save-if: ${{ github.ref == 'refs/heads/master' }}
       - uses: ilammy/setup-nasm@v1
       - uses: davidB/rust-cargo-make@v1
       - uses: browser-actions/setup-firefox@latest
       - uses: jetli/wasm-pack-action@v0.4.0
-      - uses: actions/checkout@v4
       - run: cargo make tests
 
   fmt:
@@ -72,11 +81,15 @@ jobs:
     name: Rustfmt
     runs-on: ubuntu-latest
     steps:
-      - uses: dtolnay/rust-toolchain@stable
-      - uses: mozilla-actions/sccache-action@v0.0.3
-      - uses: ilammy/setup-nasm@v1
-      - run: rustup component add rustfmt
       - uses: actions/checkout@v4
+      - uses: ilammy/setup-nasm@v1
+      - uses: dtolnay/rust-toolchain@stable
+        with:
+          components: rustfmt
+      - uses: Swatinem/rust-cache@v2
+        with:
+          cache-all-crates: "true"
+          save-if: ${{ github.ref == 'refs/heads/master' }}
       - run: cargo fmt --all -- --check
 
   clippy:
@@ -84,13 +97,17 @@ jobs:
     name: Clippy
     runs-on: ubuntu-latest
     steps:
+      - uses: actions/checkout@v4
       - run: sudo apt-get update
       - run: sudo apt install libwebkit2gtk-4.1-dev libgtk-3-dev libayatana-appindicator3-dev
-      - uses: dtolnay/rust-toolchain@stable
-      - uses: mozilla-actions/sccache-action@v0.0.3
       - uses: ilammy/setup-nasm@v1
-      - run: rustup component add clippy
+      - uses: dtolnay/rust-toolchain@stable
-      - uses: actions/checkout@v4
+        with:
+          components: rustfmt, clippy
+      - uses: Swatinem/rust-cache@v2
+        with:
+          cache-all-crates: "true"
+          save-if: ${{ github.ref == 'refs/heads/master' }}
       - run: cargo clippy --workspace --examples --tests -- -D warnings
 
   miri:
@@ -115,7 +132,10 @@ jobs:
         with:
           toolchain: ${{ env.rust_nightly }}
           components: miri
-      - uses: mozilla-actions/sccache-action@v0.0.3
+      - uses: Swatinem/rust-cache@v2
+        with:
+          cache-all-crates: "true"
+          save-if: ${{ github.ref == 'refs/heads/master' }}
       - name: miri
         # Many of tests in tokio/tests and doctests use #[tokio::test] or
         # #[tokio::main] that calls epoll_create1 that Miri does not support.
@@ -131,9 +151,6 @@ jobs:
     if: github.event.pull_request.draft == false
     name: Playwright Tests
     runs-on: ubuntu-latest
-    defaults:
-      run:
-        working-directory: ./playwright-tests
     steps:
       # Do our best to cache the toolchain and node install steps
       - uses: actions/checkout@v4
@@ -146,21 +163,34 @@ jobs:
         with:
           toolchain: stable
           targets: x86_64-unknown-linux-gnu,wasm32-unknown-unknown
-      - uses: mozilla-actions/sccache-action@v0.0.3
+      - uses: Swatinem/rust-cache@v2
+        with:
+          cache-all-crates: "true"
+          save-if: ${{ github.ref == 'refs/heads/master' }}
+
       - name: Install dependencies
         run: npm ci
+        working-directory: ./playwright-tests
+
       - name: Install Playwright
         run: npm install -D @playwright/test
+        working-directory: ./playwright-tests
+
       - name: Install Playwright Browsers
         run: npx playwright install --with-deps
+        working-directory: ./playwright-tests
+
       #  Cache the CLI by using cargo run internally
       # - name: Install Dioxus CLI
       #   uses: actions-rs/cargo@v1
       #   with:
       #     command: install
       #     args: --path packages/cli
+
       - name: Run Playwright tests
         run: npx playwright test
+        working-directory: ./playwright-tests
+
       - uses: actions/upload-artifact@v4
         if: always()
         with:
@@ -171,6 +201,7 @@ jobs:
 
   matrix_test:
     runs-on: ${{ matrix.platform.os }}
+    if: github.event.pull_request.draft == false
     env:
       RUST_CARGO_COMMAND: ${{ matrix.platform.cross == true && 'cross' || 'cargo' }}
     strategy:
@@ -217,21 +248,81 @@ jobs:
         with:
           toolchain: ${{ matrix.platform.toolchain }}
           targets: ${{ matrix.platform.target }}
+          components: rustfmt
 
       - name: Install cross
         if: ${{ matrix.platform.cross == true }}
+
         uses: taiki-e/install-action@cross
 
-      - uses: mozilla-actions/sccache-action@v0.0.3
+      - uses: Swatinem/rust-cache@v2
         with:
-          workspaces: core -> ../target
+          # The prefix cache key, this can be changed to start a new cache manually.
-          save-if: ${{ matrix.features.key == 'all' }}
+          # default: "v0-rust"
+          # prefix-key: ""
 
-      - name: Install rustfmt
+          # A cache key that is used instead of the automatic `job`-based key,
-        run: rustup component add rustfmt
+          # and is stable over multiple jobs.
+          # default: empty
+          # shared-key: ""
 
-      - uses: actions/checkout@v4
+          # An additional cache key that is added alongside the automatic `job`-based
+          # cache key and can be used to further differentiate jobs.
+          # default: empty
+          key: "${{ matrix.platform.target }}"
 
+          # A whitespace separated list of env-var *prefixes* who's value contributes
+          # to the environment cache key.
+          # The env-vars are matched by *prefix*, so the default `RUST` var will
+          # match all of `RUSTC`, `RUSTUP_*`, `RUSTFLAGS`, `RUSTDOC_*`, etc.
+          # default: "CARGO CC CFLAGS CXX CMAKE RUST"
+          # env-vars: ""
+
+          # The cargo workspaces and target directory configuration.
+          # These entries are separated by newlines and have the form
+          # `$workspace -> $target`. The `$target` part is treated as a directory
+          # relative to the `$workspace` and defaults to "target" if not explicitly given.
+          # default: ". -> target"
+          # workspaces: ""
+
+          # Additional non workspace directories to be cached, separated by newlines.
+          # cache-directories: ""
+
+          # Determines whether workspace `target` directories are cached.
+          # If `false`, only the cargo registry will be cached.
+          # default: "true"
+          # cache-targets: ""
+
+          # Determines if the cache should be saved even when the workflow has failed.
+          # default: "false"
+          # cache-on-failure: "true"
+
+          # Determines which crates are cached.
+          # If `true` all crates will be cached, otherwise only dependent crates will be cached.
+          # Useful if additional crates are used for CI tooling.
+          # default: "false"
+          cache-all-crates: "true"
+          # save-if: ${{ github.ref == 'refs/heads/master' }}
+
+          # Determiners whether the cache should be saved.
+          # If `false`, the cache is only restored.
+          # Useful for jobs where the matrix is additive e.g. additional Cargo features,
+          # or when only runs from `master` should be saved to the cache.
+          # default: "true"
+          # save-if: ""
+          # To only cache runs from `master`:
+          save-if: ${{ github.ref == 'refs/heads/master' }}
+
+          # Specifies what to use as the backend providing cache
+          # Can be set to either "github" or "buildjet"
+          # default: "github"
+          # cache-provider: ""
+
+
+      # - uses: mozilla-actions/sccache-action@v0.0.3
+      #   with:
+      #     workspaces: core -> ../target
+      #     save-if: ${{ matrix.features.key == 'all' }}
       - name: test
         run: |
           ${{ env.RUST_CARGO_COMMAND }} ${{ matrix.platform.command }} ${{ matrix.platform.args }} --target ${{ matrix.platform.target }}

.gitignore

@@ -2,10 +2,12 @@
 /playwright-tests/web/dist
 /playwright-tests/fullstack/dist
 /dist
-Cargo.lock
 .DS_Store
 /examples/assets/test_video.mp4
 
+# new recommendation to keep the lockfile in for CI and reproducible builds
+# Cargo.lock
+
 .vscode/*
 !.vscode/settings.json
 !.vscode/tasks.json

packages/desktop/src/app.rs

@@ -63,7 +63,7 @@ impl<P: 'static> App<P> {
     pub fn new(cfg: Config, props: P, root: Component<P>) -> (EventLoop<UserWindowEvent>, Self) {
         let event_loop = EventLoopBuilder::<UserWindowEvent>::with_user_event().build();
 
-        let mut app = Self {
+        let app = Self {
             root,
             window_behavior: cfg.last_window_close_behaviour,
             is_visible_before_start: true,
@@ -109,7 +109,7 @@ impl<P: 'static> App<P> {
     }
 
     #[cfg(all(feature = "hot-reload", debug_assertions))]
-    pub fn connect_hotreload(&mut self) {
+    pub fn connect_hotreload(&self) {
         dioxus_hot_reload::connect({
             let proxy = self.shared.proxy.clone();
             move |template| {

packages/desktop/src/launch.rs

@@ -113,6 +113,7 @@ pub fn launch_with_props_blocking<P: 'static>(root: Component<P>, props: P, cfg:
                 EventData::Poll => app.poll_vdom(id),
                 EventData::NewWindow => app.handle_new_window(),
                 EventData::CloseWindow => app.handle_close_msg(id),
+                #[cfg(feature = "hot-reload")]
                 EventData::HotReloadEvent(msg) => app.handle_hot_reload_msg(msg),
                 EventData::Ipc(msg) => match msg.method() {
                     IpcMethod::FileDialog => app.handle_file_dialog_msg(msg, id),