Manifest parse error with matrix-sdk as a workspace dependency pinned to a git rev

[LGUG2Z]

I have tried searching around and have found some similar issues, but nothing that quite matches what I'm seeing.

I think an issue is arising when members of the matrix-sdk workspace make a reference to something defined at the level of the workspace Cargo.toml, but honestly I feel pretty out of my depth here.

If anyone can help point me in the right direction I'd be very grateful!

Nix log:

cargoArtifacts not set, will not reuse any cargo artifacts
@nix { "action": "setPhase", "phase": "unpackPhase" }
unpacking sources
unpacking source archive /nix/store/cfdk2n1zwsvn3in5dkibwfbl5cv75zna-source
source root is source
@nix { "action": "setPhase", "phase": "patchPhase" }
patching sources
Executing configureCargoCommonVars
@nix { "action": "setPhase", "phase": "configurePhase" }
configuring
will append /build/source/.cargo-home/config.toml with contents of /nix/store/gm33phkg38rqr5fg11mk1kyajzh3a04i-vendor-cargo-deps/config.toml
default configurePhase, nothing to do
@nix { "action": "setPhase", "phase": "buildPhase" }
building
++ command cargo --version
cargo 1.68.0 (115f34552 2023-02-26)
++ command cargo check --profile release --package api --all-targets
error: failed to get `matrix-sdk` as a dependency of package `api v0.1.0 (/build/source/api)`

Caused by:
  failed to load source for dependency `matrix-sdk`

Caused by:
  Unable to update https://github.com/matrix-org/matrix-rust-sdk?rev=8d83a996a69ffcfca786dbc343dc9b862a9965df#8d83a996

Caused by:
  failed to update replaced source https://github.com/matrix-org/matrix-rust-sdk?rev=8d83a996a69ffcfca786dbc343dc9b862a9965df#8d83a996

Caused by:
  failed to parse manifest at `/nix/store/gm33phkg38rqr5fg11mk1kyajzh3a04i-vendor-cargo-deps/9401cbf19ed1b24e4f204eb582d8aa9e7ac5398e17b13a5c16b99e0d081595ec/matrix-sdk-common-0.6.0/Cargo.toml`

Caused by:
  failed to find a workspace root

❯ ls /nix/store/gm33phkg38rqr5fg11mk1kyajzh3a04i-vendor-cargo-deps/9401cbf19ed1b24e4f204eb582d8aa9e7ac5398e17b13a5c16b99e0d081595ec
 matrix-sdk-0.6.2        matrix-sdk-common-0.6.0   matrix-sdk-indexeddb-0.2.0   matrix-sdk-store-encryption-0.2.0
 matrix-sdk-base-0.6.1   matrix-sdk-crypto-0.6.0   matrix-sdk-sled-0.2.0    

Contents of the Cargo.toml which failed parsing:

[package]
authors = ["Damir Jelić <poljar@termina.org.uk>"]
description = "Collection of common types and imports used in the matrix-sdk"
edition = "2021"
homepage = "https://github.com/matrix-org/matrix-rust-sdk"
keywords = ["matrix", "chat", "messaging", "ruma", "nio"]
license = "Apache-2.0"
name = "matrix-sdk-common"
readme = "README.md"
repository = "https://github.com/matrix-org/matrix-rust-sdk"
rust-version = "1.65"
version = "0.6.0"
[package.metadata.docs.rs]
default-target = "x86_64-unknown-linux-gnu"
targets = ["x86_64-unknown-linux-gnu", "wasm32-unknown-unknown"]

[features]
js = ["instant/wasm-bindgen", "instant/inaccurate", "wasm-bindgen-futures"]

[dependencies]
futures-core = "0.3.21"
instant = "0.1.12"
serde = "1.0.151"
serde_json = "1.0.91"

[dependencies.ruma]
git = "https://github.com/ruma/ruma"
rev = "543c03f8f2d0f5a357b6be41cc0e166aa58cce63"
features = ["client-api-c"]
[target."cfg(target_arch = \"wasm32\")".dependencies]
async-lock = "2.5.0"

[target."cfg(target_arch = \"wasm32\")".dependencies.futures-util]
workspace = true
features = ["channel"]

[target."cfg(target_arch = \"wasm32\")".dependencies.wasm-bindgen-futures]
version = "0.4.33"
optional = true

[target."cfg(target_arch = \"wasm32\")".dependencies.gloo-timers]
version = "0.2.6"
features = ["futures"]
[target."cfg(not(target_arch = \"wasm32\"))".dependencies.tokio]
version = "1.24.2"
default-features = false
features = ["rt", "sync", "time"]

[dev-dependencies]
wasm-bindgen-test = "0.3.33"

[dev-dependencies.matrix-sdk-test]
path = "../../testing/matrix-sdk-test/"
version = "0.6.0"

My own stripped down Cargo.toml at the workspace level:

[workspace]
members = ["api"]

[workspace.dependencies]
matrix-sdk = { git = "https://github.com/matrix-org/matrix-rust-sdk", rev = "8d83a996a69ffcfca786dbc343dc9b862a9965df", default-features = false, features = [
  "e2e-encryption",
  "sled",
  "rustls-tls",
  "markdown",
] }

The stripped down Cargo.toml from the workspace member:

[package]
name = "api"
version = "0.1.0"
edition = "2021"

[dependencies]
matrix-sdk = { workspace = true }

And finally from the flake.nix where craneLib.buildPackage is eventually called:

          src = craneLib.cleanCargoSource ./.;

          commonArgs = rec {
            inherit src;
            pname = "api";
            cargoExtraArgs = "--package ${pname}";
            version = "0.1.0";

            buildInputs =
              [
                pkgs.sqlite
              ]
              ++ lib.optionals pkgs.stdenv.isDarwin [
                pkgs.libiconv
              ];
          };

          cargoArtifacts = craneLib.buildDepsOnly commonArgs;

          api = craneLib.buildPackage (commonArgs
            // {
              inherit cargoArtifacts;
            });

[ipetkov]

Quick question: is your Cargo.lock file up to date (and if so, could you post the minified version)?

Normally when running cargo outside of nix it can pull down git deps even if they have not been committed to the Cargo.lock file. But if the git dependency is not listed there crane has no way of vendoring it, which would lead to the error you are seeing

[LGUG2Z]

I believe it is up to date; I just ran cargo update and the same error was produced by nix build.

I've put together a minimal reproduction of this issue (with the Cargo.lock!) here: https://github.com/LGUG2Z/nix-crane-matrix-repro

[LGUG2Z]

Actually, even if you try to build example as a standalone crate that is not part of a workspace, with the same matrix-sdk dependency explicitly declared in the standalone Cargo.toml, the same error occurs with nix build (using the same flake.nix in the repro) 🤔

[LGUG2Z]

Update: I tried out this PR (#265) which seems to have worked. Based on this, it looks like the issue was related to information inherited from the workspace in target block.

[ipetkov]

Glad you found the PR! I was just merged so hopefully this should be fixed now, but let me know if it doesn't!