mgrachev / update-informer Goto Github PK

View Code? Open in Web Editor NEW

205.0 5.0 7.0 375 KB

Update informer for CLI applications written in Rust 🦀

License: MIT License

Rust 98.52% Shell 1.48%

rust rust-lang rust-library update-checker update-notifier contributors-welcome contributor-friendly hacktoberfest

update-informer's Introduction

👋 Hi, I'm Mikhail!

I'm:

Senior Software Engineer (Rust, Go, Ruby, Elixir) 🚀
DevOps Engineer 🐳
Open Source Activist & Contributor 😍
Speaker 🎤
Mentor 👨‍💻

I ❤️ Open Source:

Author of dotenv-linter. It's a ⚡️ fast linter for .env files. Written in Rust 🦀
Core-contributor of datanymizer, goreleaser & reviewdog 🔥

Look at my other projects 👍

Follow me on Twitter ✌️

update-informer's People

Contributors

Stargazers

Watchers

Forkers

itamarst playfloor x0f5c3 tknickman chris-olszewski iq-scm dyc3

update-informer's Issues

More standardized location for "last-checked" file

On the assumption that pip has done the relevant research correctly:

For Unix-y systems, use "$XDG_CACHE_HOME/app-name" or fallback to "~/.cache/app-name". (https://github.com/pypa/pip/blob/dec279ecdf8fd2b0f984dd213198635fdbe320c7/src/pip/_vendor/platformdirs/unix.py#L86)
For Windows, CSIDL_LOCAL_APPDATA (https://github.com/pypa/pip/blob/dec279ecdf8fd2b0f984dd213198635fdbe320c7/src/pip/_vendor/platformdirs/windows.py#L62)
For macOS, "~/Library/Caches/app-name" (https://github.com/pypa/pip/blob/dec279ecdf8fd2b0f984dd213198635fdbe320c7/src/pip/_vendor/platformdirs/macos.py#L37).

Timeouts for ureq usage

Given networks can have issues, there should probably be some sort of timeouts set on the ureq HTTP client.
The timeouts should be fairly short, since the version check is not the user's goal, it's a nice-to-have.

Add `User-Agent` header for GitHub registry

https://docs.github.com/en/rest/overview/resources-in-the-rest-api?apiVersion=2022-11-28#user-agent-required

Add an interval option to check updates

Less fakes in testing strategy

I'm working on branch for #18, all unit tests pass... but running the example CLI to get a PyPI package is not working. So I would suggest less #[cfg(test)] code variants and more just running with the real code paths.

Add tests to check for updates on Crates.io and GitHub

Useful links:

Put different update checks behind cargo features

Usually Rust crates don't have PyPI pages, so it would make sense to put that behind an optional feature.

Add more examples

For Crates.io and GitHub.

Save the latest version to a temporary file

Release v0.1.0

Tasks to be done:

update-informer is tainted with MPL-2 via option-ext

Hello, I wanted to raise a note that this crate currently has a transitive dependency on option-ext. That library is MPL-2, a copyleft license. The option-ext dependency is brought in via the dependency on directories. The maintainer of the underlying dirs-sys crate has indicated that they added a dependency on option-ext for the express purpose of tainting the use of dirs-sys with MPL-2, which thus taints any use of update-informer. I'd recommend using an alternate dependency such as etcetera, which does not suffer from this tainting issue.

I'll note that the default ureq dependency also pulls in webpki-roots, which is also MPL-2, but that is an optional dependency that can be side-stepped by using native-tls (though I would overall prefer to use rustls-tls, but with native-roots), so it's not a particular concern for me.

As an alternative, the caching functionality could be optional behind a feature, so that the MPL-2 dependency isn't required if we don't need the caching check.

update-informer does not work with target x86_64-unknown-linux-musl and i686-unknown-linux-musl

Running cargo build --target=x86_64-unknown-linux-musl (with and without --release) and cargo build --target=x86_64-unknown-linux-musl (with and without release) fails, but works with cargo build and cargo build --release (which uses target x86_64-unknown-linux-gnu) works fine

The reason I traced it to update-informer is that removing update-informer and the update-informer code in main.rs allows it to compile just fine.

This is the error message:

Compiling ring v0.16.20
error: failed to run custom build command for `ring v0.16.20`

Caused by:
  process didn't exit successfully: `/home/chirag/projects/ddr_mount/target/debug/build/ring-f696b55488b2d439/build-script-build` (exit status: 101)
  --- stdout
  OPT_LEVEL = Some("0")
  TARGET = Some("x86_64-unknown-linux-musl")
  HOST = Some("x86_64-unknown-linux-gnu")
  CC_x86_64-unknown-linux-musl = None
  CC_x86_64_unknown_linux_musl = None
  TARGET_CC = None
  CC = None
  CROSS_COMPILE = None
  CFLAGS_x86_64-unknown-linux-musl = None
  CFLAGS_x86_64_unknown_linux_musl = None
  TARGET_CFLAGS = None
  CFLAGS = None
  CRATE_CC_NO_DEFAULTS = None
  DEBUG = Some("true")
  CARGO_CFG_TARGET_FEATURE = Some("fxsr,sse,sse2")

  --- stderr
  running "musl-gcc" "-O0" "-ffunction-sections" "-fdata-sections" "-fPIC" "-g" "-fno-omit-frame-pointer" "-m64" "-I" "include" "-Wall" "-Wextra" "-pedantic" "-pedantic-errors" "-Wall" "-Wextra" "-Wcast-align" "-Wcast-qual" "-Wconversion" "-Wenum-compare" "-Wfloat-equal" "-Wformat=2" "-Winline" "-Winvalid-pch" "-Wmissing-field-initializers" "-Wmissing-include-dirs" "-Wredundant-decls" "-Wshadow" "-Wsign-compare" "-Wsign-conversion" "-Wundef" "-Wuninitialized" "-Wwrite-strings" "-fno-strict-aliasing" "-fvisibility=hidden" "-fstack-protector" "-g3" "-U_FORTIFY_SOURCE" "-DNDEBUG" "-c" "-o/home/chirag/projects/ddr_mount/target/x86_64-unknown-linux-musl/debug/build/ring-3cd0dd4557c022ec/out/aesni-x86_64-elf.o" "/home/chirag/.cargo/registry/src/github.com-1ecc6299db9ec823/ring-0.16.20/pregenerated/aesni-x86_64-elf.S"
  thread 'main' panicked at 'failed to execute ["musl-gcc" "-O0" "-ffunction-sections" "-fdata-sections" "-fPIC" "-g" "-fno-omit-frame-pointer" "-m64" "-I" "include" "-Wall" "-Wextra" "-pedantic" "-pedantic-errors" "-Wall" "-Wextra" "-Wcast-align" "-Wcast-qual" "-Wconversion" "-Wenum-compare" "-Wfloat-equal" "-Wformat=2" "-Winline" "-Winvalid-pch" "-Wmissing-field-initializers" "-Wmissing-include-dirs" "-Wredundant-decls" "-Wshadow" "-Wsign-compare" "-Wsign-conversion" "-Wundef" "-Wuninitialized" "-Wwrite-strings" "-fno-strict-aliasing" "-fvisibility=hidden" "-fstack-protector" "-g3" "-U_FORTIFY_SOURCE" "-DNDEBUG" "-c" "-o/home/chirag/projects/ddr_mount/target/x86_64-unknown-linux-musl/debug/build/ring-3cd0dd4557c022ec/out/aesni-x86_64-elf.o" "/home/chirag/.cargo/registry/src/github.com-1ecc6299db9ec823/ring-0.16.20/pregenerated/aesni-x86_64-elf.S"]: No such file or directory (os error 2)', /home/chirag/.cargo/registry/src/github.com-1ecc6299db9ec823/ring-0.16.20/build.rs:653:9
  note: run with `RUST_BACKTRACE=1` environment variable to display a backtrace

Does not build for target `x86_64-unknown-linux-musl` when using `reqwest`

Building for the target x86_64-unknown-linux-musl does not work by default.

cross build --target=x86_64-unknown-linux-musl --no-default-features --features reqwest

Workaround: disable the reqwest feature.