cargo-semver-checks Crash Report

[jalil-salame]

Steps to reproduce the bug with the above code

I am testing sgx-quote and my PR on it.

1. Create a rustdoc-json file manually (I used RUSTDOCFLAGS="-Z unstable-options --document-private-items --document-hidden-items --output-format=json --cap-lints=allow" cargo +nightly doc --lib --no-deps)
2. Run cargo semver-checks while setting --current-rustdoc=target/doc/crate_name.json but not setting --baseline-rustdoc (leaving it unset or setting --baseline-version/--baseline-rev).
3. Watch the crash happen

Actual Behaviour

cargo-semver-checks crashes

Expected Behaviour

cargo-semver-checks should work as normal

Generated System Information

System information:

Software version

cargo-semver-checks 0.36.0

Operating system

Linux 6.6.57

Command-line

/home/jalil/.local/share/cargo/bin/cargo-semver-checks semver-checks --bugreport

cargo version

> cargo -V
cargo 1.84.0-nightly (cf53cc54b 2024-10-18)

Compile time information

• Profile: release
• Target triple: x86_64-unknown-linux-gnu
• Family: unix
• OS: linux
• Architecture: x86_64
• Pointer width: 64
• Endian: little
• CPU features: fxsr,sse,sse2
• Host: x86_64-unknown-linux-gnu

Cargo build configuration:

[registry]
token = "REDACTED"

Build Configuration

Nothing of note (just setting CARGO_HOME)

Additional Context

name = "cargo-semver-checks"
operating_system = "NixOS 24.5.0 [64-bit]"
crate_version = "0.36.0"
explanation = """
Panic occurred in file '/home/jalil/.local/share/cargo/registry/src/index.crates.io-6f17d22bba15001f/cargo-semver-checks-0.36.0/src/rustdoc_gen.rs' at line 773
"""
cause = "this should be impossible: InvalidKrateName(InvalidCharacter { invalid: '<', index: 0 })"
method = "Panic"
backtrace = """
   0:     0x5585ed034f04 - rust_begin_unwind
   1:     0x5585ebbe85a5 - core::panicking::panic_fmt::hdb89b5c14a056cec
   2:     0x5585ebbe8ad3 - core::result::unwrap_failed::h850510ea6c159887
   3:     0x5585ebef37f2 - <cargo_semver_checks::rustdoc_gen::RustdocFromRegistry as cargo_semver_checks::rustdoc_gen::RustdocGenerator>::load_rustdoc::h42d434d4ed79632d
   4:     0x5585ebeb5e92 - cargo_semver_checks::generate_versioned_crates::hd84e2714c8d60315
   5:     0x5585ebf6b8be - cargo_semver_checks::Check::check_release::{{closure}}::h52545f2c99e48089
   6:     0x5585ebef65c2 - <core::iter::adapters::map::Map<I,F> as core::iter::traits::iterator::Iterator>::fold::h2024869b0b73d614
   7:     0x5585ebd9090c - alloc::vec::in_place_collect::<impl alloc::vec::spec_from_iter::SpecFromIter<T,I> for alloc::vec::Vec<T>>::from_iter::hfbf4c87b15fdcd45
   8:     0x5585ebeb48a3 - cargo_semver_checks::Check::check_release::h710c6566250f8745
   9:     0x5585ebbecf6d - cargo_semver_checks::exit_on_error::h12b290f9f6301440
  10:     0x5585ebbec3d4 - cargo_semver_checks::main::h4c8608096b82b21a
  11:     0x5585ebc20443 - std::sys_common::backtrace::__rust_begin_short_backtrace::he0d47c16c887dc12
  12:     0x5585ebc13b99 - std::rt::lang_start::{{closure}}::h7415b008c476ed70
  13:     0x5585ed034e04 - std::panicking::try::ha86251cf5daa9bea
  14:     0x5585ed01f6bb - std::rt::lang_start_internal::ha6a51778162f8d22
  15:     0x5585ebbfa3a5 - main
  16:     0x7f2813edb10e - __libc_start_call_main
  17:     0x7f2813edb1c9 - __libc_start_main@@GLIBC_2.34
  18:     0x5585ebbe8ee5 - _start
  19:                0x0 - <unresolved>
"""

[jalil-salame]

I forgot to mention; setting both --baseline-rustdoc and --current-rustdoc or neither does not trigger the panic, as well as setting just --baseline-rustdoc

[obi1kenobi]

Nice catch, thank you! This should be rejected by the CLI with an error, since the baseline is not specified. We can't use an implicit baseline like we usually do because we have an explicit "current" setting of unknown origin. The other combinations work because we can always use "the package in this directory" as an implicit "current" version. Though I'm wondering what would happen if the current directory is the root of a virtual workspace — that might be another error or piece of unexpected behavior. Worth a look for sure!

…

On Fri, Oct 25, 2024, 3:45 AM Jalil David Salamé Messina < ***@***.***> wrote: I forgot to mention; setting both --baseline-rustdoc and --current-rustdoc or neither does not trigger the panic, as well as setting just --baseline-rustdoc — Reply to this email directly, view it on GitHub <#987 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AAR5MSWDT62U5COBRSBUZEDZ5HZJTAVCNFSM6AAAAABQSVVPQOVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDIMZXGEYTONRZHE> . You are receiving this because you are subscribed to this thread.Message ID: ***@***.***>