Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore(deps): update rust crate interprocess to v2 #1915

Merged
merged 11 commits into from
Jun 10, 2024

Conversation

renovate[bot]
Copy link
Contributor

@renovate renovate bot commented Jun 1, 2024

Mend Renovate

This PR contains the following updates:

Package Type Update Change
interprocess workspace.dependencies major 1 -> 2

Release Notes

kotauskas/interprocess (interprocess)

v2.1.1

Compare Source

  • Removed async Incoming and futures::Stream ("AsyncIterator") implementations on local_socket::traits::Listener implementors – those were actually completely broken, so this change is not breaking in practice and thus does not warrant a bump to 3.0.0
  • Fixed ListenerOptionsExt::mode() behavior in umask fallback mode and improved its documentation
  • Moved examples to their own dedicated files with the help of the doctest-file crate

v2.1.0: – listeners are now iterators

Compare Source

  • Fixes #​49
  • Adds Iterator impl on local socket listeners (closes #​64)
  • Miscellaneous documentation fixes

v2.0.1: – fix for non-x86 platforms

Compare Source

  • Fixed a portability bug that broke the build on Android (#​62, #​63)
  • Minor documentation adjustments

v2.0.0

Compare Source

The long-awaited 2.0.0 release brings substantial API enhancements that constitute breaking changes, countless bugfixes, better portability, some future-proofing, a grand refactor and significant scope creep mitigation.

You can upgrade to the new version by changing your Cargo.toml to depend on Interprocess 2.0.0 instead of 1.2.1 and fixing the compilation errors that ensue. The behavioral changes have been made in a manner that avoids the introduction of bugs that successfully compile. The Rustdoc documentation contains all the information that's needed to write code that uses Interprocess 2.0.0, and, by extension, all the information that's needed to port dependents of Interprocess 1.2.1.

  • Many bugs have been fixed
    • A comprehensive set of testing utilities has been added to prevent new bugs of the embarrassing variety
  • The minimum Rust version has been bumped to 1.75.0, bringing many improvements to both the API and the internals, including RAII of file descriptors and handles and use of RPITITs
  • Platform support has been clarified and expanded
  • Windows named pipe support has been largely remade:
    • The API has been overhauled to be more idiomatic to Rust with expanded use of generics
    • A "limbo" is now used to prevent in-flight data from being lost when dropping connections
  • Small API deficiencies, such as inaccurate types that unnecessarily made invalid options representable, have been corrected
  • Windows security descriptors have received a proper API
  • Numerous improvements to local sockets
    • They have been made more uniform across platforms – the portability magic that is now in place has eliminated the need to explicitly acknowledge the platform differences in most practical programs
      • Ud-socket local socket listeners now clean up corpse socket files when dropped
    • The new API allows explicit selection of the underlying implementation: every possible backend of local sockets has its own public API, and all of them implement the new local socket traits
    • The name type and the name creation API have been overhauled to facilitate the changes
    • Streams are now splittable by value and readable + writable by reference
  • Some functionality has been offloaded to the recvmsg crate – it is now part of the public API of Interprocess
  • Ud-sockets have been outsourced to the standard library
  • Signal support has been removed in favor of signal_hook

Configuration

📅 Schedule: Branch creation - "every weekend" in timezone America/Los_Angeles, Automerge - At any time (no schedule defined).

🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.

Rebasing: Whenever PR is behind base branch, or you tick the rebase/retry checkbox.

🔕 Ignore: Close this PR and you won't be reminded about this update again.


  • If you want to rebase/retry this PR, check this box

This PR has been generated by Mend Renovate. View repository job log here.

@renovate renovate bot requested a review from a team as a code owner June 1, 2024 12:26
@jonathanrainer jonathanrainer self-assigned this Jun 4, 2024
@renovate renovate bot force-pushed the renovate/interprocess-2.x branch from 4bb8e5c to 0dfc4c3 Compare June 4, 2024 14:41
Copy link
Contributor Author

renovate bot commented Jun 4, 2024

Edited/Blocked Notification

Renovate will not automatically rebase this PR, because it does not recognize the last commit author and assumes somebody else may have edited the PR.

You can manually request rebase by checking the rebase/retry box above.

⚠️ Warning: custom changes will be lost.

$raw_socket_name
.clone()
.to_fs_name::<GenericFilePath>()
.unwrap()
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

do we want unwraps here or something else? Worried about panics (especially without an error message; we should switch to expect if we can't move to something more robust), but also about panics coming from macros making it super, super hard to track down what went wrong

$raw_socket_name
.clone()
.to_ns_name::<GenericNamespaced>()
.unwrap()
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

same question about the unwrap here

pub use leader::*;
pub(crate) use socket::*;
pub use types::*;
macro_rules! create_socket_name {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I played around with this locally, and it seems like we could get away with something like this in place of a macro:

pub(crate) fn create_socket_name<'s>(raw_socket_name: &'s str) -> std::io::Result<Name<'s>> {
    if GenericFilePath::is_supported() {
        raw_socket_name.clone().to_fs_name::<GenericFilePath>()
    } else {
        raw_socket_name.clone().to_ns_name::<GenericNamespaced>()
    }
}

This would pass the buck on unwrapping or mapping the result to the calling function and solve for aaron's comments below. Passing the buck to the caller for errors is generally something we tend to do instead of panicking.

In the calling code, it's simple enough to do something like:

let socket_name = create_socket_name(&raw_socket_name as &str)?;

This works cleanly because rover maps any error into an anyhow::Error here.

OnlyNamespaced => "@",
};
Ok(format!("{}{}", socket_prefix, socket_name))
pub fn get_raw_socket_name(&self) -> String {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is it worth attempting a test for this change to confirm that the behavior is what we expect? We may have to submit the test as a separate PR and then rebase this branch on top of it to confirm, though.

@jonathanrainer jonathanrainer force-pushed the renovate/interprocess-2.x branch 2 times, most recently from eb71014 to 8dad8ac Compare June 6, 2024 05:14
@dotdat dotdat force-pushed the renovate/interprocess-2.x branch from 6526e1a to 63672a1 Compare June 7, 2024 16:16
@dotdat
Copy link
Contributor

dotdat commented Jun 7, 2024

This appears to work. Ultimately, since we can't query for the filename support anymore, we'll defer to this naming convention on Windows, and the existing naming convention on unix-like systems.

@aaronArinder aaronArinder enabled auto-merge (squash) June 10, 2024 19:09
@aaronArinder aaronArinder merged commit 9ac07b2 into main Jun 10, 2024
11 checks passed
@aaronArinder aaronArinder deleted the renovate/interprocess-2.x branch June 10, 2024 19:34
@jonathanrainer jonathanrainer added this to the v0.24.0 milestone Jul 10, 2024
@jonathanrainer jonathanrainer mentioned this pull request Jul 12, 2024
jonathanrainer added a commit that referenced this pull request Jul 15, 2024
# [0.24.0]

> Important: 1 potentially breaking change below, indicated by **❗
BREAKING ❗**

## ❗ BREAKING ❗

- **Removed the deprecated `plain` and `json` options for `--output` -
@dylan-apollo PR
[#1804](#1804

The `--output` option is now only for specifying a file to write to. The
`--format` option should be used to specify the format of the output.

## 🚀 Features

- **Return the name of the linting rule that is violated, as well as the
code - @jonathanrainer PR
[#1907](#1907

Originally only the message from the linting violation was included in
the response, but now it also includes the name of the specific linting
rule to aid debugging

- **Use the Router's `/health?ready` endpoint to check readiness -
@nmoutschen PR
[#1939](#1939

Previously `rover dev` used a simple query to establish readiness, but
this did not allow for router customizations.

- **Adding architecture and OS metrics - @aaronArinder PR
[#1947](#1947

Allows us to track the Operating Systems and Architectures in use by our
users, this will give us more information as to where to focus support
efforts

- **Allow `aarch64` macOS to pull correct `supergraph` binaries where
available - @jonathanrainer PR
[#1971](#1971

We recently started publishing `supergraph` binaries for `aarch64`, so
if they are available Rover will use them in preference to x86_64
binaries.

## 🐛 Fixes

- **Don't panic if the telemetry client cannot be initialised -
@dylan-apollo PR
[#1897](#1897) - Issue
[#1893](#1893
- **Rename `.cargo/config` to `.cargo/config.toml` - @jonathanrainer PR
[#1921](#1921
- **Fix `pnpm` installs by moving the binary download location -
@jonathanrainer PR
[#1927](#1927) - Issue
[#1881](#1881
  
After we inlined the `binary-install` dependency in v0.23.0 this changed
where the downloaded binary was stored when using `pnpm`. This caused
users running the binary to enter an infinite loop. This moves the
binary to a new location which avoids this.

- **Don't panic on file watcher errors - @nmoutschen PR
[#1935](#1935

Instead of panicking when errors occur watching files return those
errors gracefully to the user.

- **Store binaries with version numbers attached so upgrades are
possible - @jonathanrainer PR
[#1932](#1932) - Issue
[#1563](#1563

When downloading binaries via `npm` they were always stored as `rover`
despite the version. As such, when a new version came out the upgrade
would fail. This now doesn't happen, as binaries are stored with their
versions number in the name.

- **Ensure correct URL is used if `subgraph_url` and `routing_url` are
provided in a supergraph schema - @jonathanrainer PR
[#1948](#1948) - Issue
[#1782](#1782
- **Let `--output` accept paths with missing intermediate directories -
@jonathanrainer PR
[#1944](#1944) - Issue
[#1787](#1787
- **Allow `rover dev` to read Federation Version from supergraph schema
- @jonathanrainer PR
[#1950](#1950) - Issue
[#1735](#1735

The Federation version could be set in the supegraph schema but was
being ignored by `rover dev`. It now is taken into account, along with
the overriding environment variable.

- **Stop .exe being printed after Federation version during composition
- @jonathanrainer PR
[#1951](#1951) - Issue
[#1390](#1390
- **Reinstate support for `glibc` 2.17 - @jonathanrainer PR
[#1953](#1953

In resolving the issues with CentOS 7 we accidentally removed support
for `glibc` 2.17, this has now been restored

- **Be more lenient about `supergraph` binary versions - @dylan-apollo
PR [#1966](#1966

In resolving #1390, we were too restrictive in what counted as a valid
version. This restores the correct behaviour

- **Set `package.json` to a stable version when testing NPM Installers -
@jonathanrainer PR
[#1967](#1967

When testing whether our NPM installers worked correctly we were trying
to download the latest `rover` binary. On release PRs, where the binary
didn't yet exist, this was causing problems.

- **Fix mocking of calls to Orbiter in Installer tests - @jonathanrainer
PR [#1968](#1968
- **Remove noisy errors from intermediate composition states -
@aaronArinder PR
[#1956](#1956
  
When `rover dev` composes multiple subgraphs it does so one at a time.
As such if there are dependencies there can be noisy ephemeral errors,
this fixes that by waiting until all subgraphs are added before trying
composition.

## 🛠 Maintenance

- **Update GitHub CircleCI Orb to v2.3.0 - @Geal PR
[#1831](#1831
- **Update plugins to Fed 2.7 and Router 1.43.0 - @smyrick PR
[#1877](#1877
- **Update CODEOWNERS - @dotdat PR
[#1890](#1890

  Make Betelgeuse the primary owners of the Rover repository

- **Update lychee-lib to v0.15 - @dotData PR
[#1902](#1902
- **Add tests and provide status codes as part of linter errors -
@dotdat PR [#1903](#1903
- **Add nix files to .gitignore - @aaronArinder PR
[#1908](#1908
- **Update apollographql/router to v1.47.0 - @aaronArinder PR
[#1841](#1841
- **Update apollographql/federation-rs to v2.7.8 - @aaronArinder PR
[#1746](#1746
- **Update node.js to v20 - @aaronArinder PR
[#1778](#1778
- **Update Rust to v1.76.0 and the Rust CircleCI Orb to v1.6.1 -
@aaronArinder PR
[#1788](#1788
- **Update serial_test to v3 - @jonathanrainer PR
[#1836](#1836
- **Update which to v6 - @jonathanrainer PR
[#1835](#1835
- **Update apollographql/federation-rs to v2.8.0 - @aaronArinder PR
[#1909](#1909
- **Update tar to v6.2.1 - @aaronArinder PR
[#1888](#1888
- **Update tar to v7 - @aaronArinder PR
[#1914](#1914
- **Update node.js packages - @aaronArinder PR
[#1830](#1830

Includes `eslint` to v8.57.0, `node.js` to v20.14.0, `nodemon` to
v3.1.2, `npm` to v10.8.1 and `prettier` to v3.3.0

- **Update Rust to v1.78.0 - @aaronArinder PR
[#1912](#1912
- **Update apollographql/router to v1.48.0 - @aaronArinder PR
[#1917](#1917
- **Update zip to v2 - @jonathanrainer PR
[#1916](#1916
- **Update eslint to v9.4.0 - @dotdat PR
[#1913](#1913
- **Update hyper to v1.0 - @dotdat PR
[#1789](#1789
- **Add tests for socket names - @jonathanrainer PR
[#1918](#1918
  
In future dependency upgrades we want to ensure that behaviour around
socket naming works as expected, so add a test to ensure that.

- **Update rust packages - @jonathanrainer PR
[#1755](#1755

Consolidates updates of pre-1.0 rust crates, check PR for full details
of crates updated

- **Update notify to v6 - @jonathanrainer PR
[#1603](#1603
- **Include cargo-deny checks on PRs - @jonathanrainer PR
[#1910](#1910

Now we can check for licences that don't correspond to our allowed list
and pick up on dependency issues live on PRs

- **Pin node.js dev dependencies - @aaronArinder PR
[#1923](#1923
- **Allow 0BSD licence - @aaronArinder PR
[#1924](#1923
- **Update interprocess to v2 - @dotdat PR
[#1915](#1915
- **Update apollographql/router to v1.48.1 - @dotdat PR
[#1926](#1926
- **Update Rust to v1.79.0 - @jonathanrainer PR
[#1931](#1931
- **Update git2 to v0.19 - @jonathanrainer PR
[#1930](#1930
- **Update node.js packages - @jonathanrainer PR
[#1929](#1929

Includes `@eslint/compat` to v1.1.0, `eslint` to v9.5.0, `graphql` to
v16.8.2 and `prettier` to v3.3.2

- **Migrate CI to use manylinux rather than CentOS 7 - @jonathanrainer
PR [#1952](#1952

As CentOS 7 has now entered End-of-Life, migrate our CI to use a
different Linux distribution.

- **Update apollographql/router to v1.49.1 - @jonathanrainer PR
[#1933](#1933
- **Update apollographql/federation-rs to v2.8.2 - @jonathanrainer PR
[#1934](#1934
- **Update node.js packages - @jonathanrainer PR
[#1940](#1940

Includes `eslint` to v9.6.0, `node.js` to v20.15.0, `nodemon` to v3.1.4,
`graphql` to v16.9.0

- **Fix clippy warnings - @loshz PR
[#1955](#1955
- **Allow integration tests to accept a pre-compiled binary -
@jonathanrainer PR
[#1957](#1957
- **Run macOS x86_64 integration tests in GitHub Actions - @nmoutschen
PR [#1958](#1958
  
Due to CircleCI's deprecation of x86_64 macOS executors use GitHub
Actions to still run our tests on this architecture

- **Add smoke tests for `rover dev` - @jonathanrainer PR
[#1961](#1961
- **Update apollographql/router to v1.50.0 - @jonathanrainer PR
[#1954](#1954
- **Trigger GitHub Actions from CircleCI - @nmoutschen PR
[#1959](#1959
- **Add docs team to CODEOWNERS - @aaronArinder PR
[#1965](#1965
- **Fix up Release CI and explicitly add tokio `rt-multi-thread flag` -
@jonathanrainer PR
[#1972](#1972
- **Add context to auth output when saving an API Key - @loshz PR
[#1974](#1974


## 📚 Documentation

- **Minor update to README.md - @tratzlaff PR
[#1880](#1880

  Fixes use of numbered lists in the README.md 

- **Remove failing/redundant links from docs - @dotdat PR
[#1894](#1894
- **Update docs style - @Meschreiber PR
[#1883](#1883

  Update formatting and admonitions to most recent conventions.

- **Update frontmatter - @Meschreiber PR
[#1898](#1898

  Updates title casing and adds metadata to subtitles

- **Clarify `subgraph publish` can only create variants not graphs -
@Meschreiber PR
[#1938](#1938
- **Make example using `-` instead of filepath clearer - @aaronArinder
PR [#1963](#1963
- **Update Router terminology - @Meschreiber PR
[#1925](#1925

Update the uses of Apollo Router to GraphOS Router or Apollo Router Core
where necessary
- **Update documentation to make it clear we collect CPU Architecture,
per command - @aaronArinder PR
[#1964](#1964
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants