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

Vendor rust dependencies #62297

Merged
merged 21 commits into from
Apr 17, 2024
Merged

Vendor rust dependencies #62297

merged 21 commits into from
Apr 17, 2024

Conversation

Algunenano
Copy link
Member

@Algunenano Algunenano commented Apr 4, 2024

Changelog category (leave one):

  • Build/Testing/Packaging Improvement

Changelog entry (a user-readable short description of the changes that goes to CHANGELOG.md):

  • Vendor in rust dependencies.

Documentation entry for user-facing changes

Rust dependencies are no longer retrieved from the internet and they live in a submodule.

Important

This PR also updates the internal rust toolchain to nightly-2024-04-01. As the vendor dependencies for the sanitizer builds are specific a rustc version, using other versions might not be supported (due to missing deps in the submodule).

Closes #61741


Modify your CI run:

NOTE: If your merge the PR with modified CI you MUST KNOW what you are doing
NOTE: Checked options will be applied if set before CI RunConfig/PrepareRunConfig step

Include tests (required builds will be added automatically):

  • Fast test
  • Integration Tests
  • Stateless tests
  • Stateful tests
  • Unit tests
  • Performance tests
  • All with ASAN
  • All with TSAN
  • All with Analyzer
  • Add your option here

Exclude tests:

  • Fast test
  • Integration Tests
  • Stateless tests
  • Stateful tests
  • Performance tests
  • All with ASAN
  • All with TSAN
  • All with MSAN
  • All with UBSAN
  • All with Coverage
  • All with Aarch64
  • Add your option here

Extra options:

  • do not test (only style check)
  • disable merge-commit (no merge from master before tests)
  • disable CI cache (job reuse)

Only specified batches in multi-batch jobs:

  • 1
  • 2
  • 3
  • 4

@robot-clickhouse robot-clickhouse added pr-build Pull request with build/testing/packaging improvement submodule changed At least one submodule changed in this PR. labels Apr 4, 2024
@robot-clickhouse
Copy link
Member

robot-clickhouse commented Apr 4, 2024

This is an automated comment for commit e65dc63 with description of existing statuses. It's updated for the latest CI running

❌ Click here to open a full report in a separate page

Check nameDescriptionStatus
CI runningA meta-check that indicates the running CI. Normally, it's in success or pending state. The failed status indicates some problems with the PR⏳ pending
Integration testsThe integration tests report. In parenthesis the package type is given, and in square brackets are the optional part/total tests❌ failure
Mergeable CheckChecks if all other necessary checks are successful❌ failure
Stateless testsRuns stateless functional tests for ClickHouse binaries built in various configurations -- release, debug, with sanitizers, etc❌ failure
Stress testRuns stateless functional tests concurrently from several clients to detect concurrency-related errors❌ failure
Successful checks
Check nameDescriptionStatus
A SyncThere's no description for the check yet, please add it to tests/ci/ci_config.py:CHECK_DESCRIPTIONS✅ success
AST fuzzerRuns randomly generated queries to catch program errors. The build type is optionally given in parenthesis. If it fails, ask a maintainer for help✅ success
ClickBenchRuns [ClickBench](https://github.com/ClickHouse/ClickBench/) with instant-attach table✅ success
ClickHouse build checkBuilds ClickHouse in various configurations for use in further steps. You have to fix the builds that fail. Build logs often has enough information to fix the error, but you might have to reproduce the failure locally. The cmake options can be found in the build log, grepping for cmake. Use these options and follow the general build process✅ success
Compatibility checkChecks that clickhouse binary runs on distributions with old libc versions. If it fails, ask a maintainer for help✅ success
Docker keeper imageThe check to build and optionally push the mentioned image to docker hub✅ success
Docker server imageThe check to build and optionally push the mentioned image to docker hub✅ success
Docs checkBuilds and tests the documentation✅ success
Fast testNormally this is the first check that is ran for a PR. It builds ClickHouse and runs most of stateless functional tests, omitting some. If it fails, further checks are not started until it is fixed. Look at the report to see which tests fail, then reproduce the failure locally as described here✅ success
Flaky testsChecks if new added or modified tests are flaky by running them repeatedly, in parallel, with more randomization. Functional tests are run 100 times with address sanitizer, and additional randomization of thread scheduling. Integrational tests are run up to 10 times. If at least once a new test has failed, or was too long, this check will be red. We don't allow flaky tests, read the doc✅ success
Install packagesChecks that the built packages are installable in a clear environment✅ success
PR CheckThere's no description for the check yet, please add it to tests/ci/ci_config.py:CHECK_DESCRIPTIONS✅ success
Performance ComparisonMeasure changes in query performance. The performance test report is described in detail here. In square brackets are the optional part/total tests✅ success
Push to DockerhubThe check for building and pushing the CI related docker images to docker hub✅ success
Stateful testsRuns stateful functional tests for ClickHouse binaries built in various configurations -- release, debug, with sanitizers, etc✅ success
Style checkRuns a set of checks to keep the code style clean. If some of tests failed, see the related log from the report✅ success
Unit testsRuns the unit tests for different release types✅ success
Upgrade checkRuns stress tests on server version from last release and then tries to upgrade it to the version from the PR. It checks if the new server can successfully startup without any errors, crashes or sanitizer asserts✅ success

@Algunenano
Copy link
Member Author

Ok it seems it's finally building in all scenarios. I needed to vendor not only dependencies but also the crate repositories themselves. Without them you still need a connection.

Some things need to be changed though:

  • It always rebuild the rust libraries even with no changes to them. :suboptimal:
  • The vendor directories are pretty big. This is because you can't ignore certain architectures/OSx while vendoring and windows has extremely big binary deps. No easy solution that I could see, but it might be possible to ignore those nested deps with some patch or something like that.
  • The vendor deps might be duplicated since they've been created for each of the 2 projects. I'll see if I can merge them.

After everything is ready, it would be best to clean up the history of the submodule before merging to remove all the big files from history and keep only the necessary ones.

@Algunenano Algunenano mentioned this pull request Apr 8, 2024
29 tasks
@Algunenano
Copy link
Member Author

After way more hours that I'm ok accepting, trying I don't know how many things to solve the recompilation problem, I found out the problem with rebuilding comes from having multiple corrosion projects clashing. The solution is to do things properly and create, and use, a rust workspace. This fixes both the first and the third point.

Only thing pending is to see if there is a way to remove the windows deps from the vendor submodule so it's not that big.

This fixes recompilation and avoids duplication of dependencies
@Algunenano Algunenano marked this pull request as ready for review April 9, 2024 17:40
@Algunenano Algunenano disabled auto-merge April 9, 2024 18:14
@Algunenano Algunenano mentioned this pull request Apr 10, 2024
29 tasks
@Algunenano
Copy link
Member Author

A couple of problems with the build:

  • FreeBSD: The new rust toolchain used new functions that aren't available in our sysroot. Support for rust and FreeBSD was already partially disabled and I've disabled it completely for now. A possible solution would be to update the sysroot to something newer, but that might mean losing compatibility with older FreeBSD (maybe ok?).
  • MUSL: The new rust toolchain uses a recent libc function (pthread_getname_np) that wasn't available in our musl sysroot. I'm updating the sysroot here: Update musl sysroot sysroot#22

@Algunenano
Copy link
Member Author

Everything builds and tests pass, so I'm updating the submodules to their final status

@Algunenano
Copy link
Member Author

This is ready and has a green CI. Only missing review and merge with master to fix conflicts

@antaljanosbenjamin antaljanosbenjamin self-assigned this Apr 16, 2024
@alexey-milovidov alexey-milovidov self-assigned this Apr 16, 2024
@Algunenano Algunenano added this pull request to the merge queue Apr 17, 2024
Merged via the queue into ClickHouse:master with commit 5849aeb Apr 17, 2024
233 of 240 checks passed
@Algunenano Algunenano deleted the rust_vendor branch April 17, 2024 12:47
@robot-clickhouse robot-clickhouse added the pr-synced-to-cloud The PR is synced to the cloud repo label Apr 17, 2024
@@ -0,0 +1,51 @@
As we have multiple projects we use a workspace to manage them (it's way simpler and leads to less issues). In order
Copy link
Member

Choose a reason for hiding this comment

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

A very cool thing is done here!

Does adding a script into https://github.com/ClickHouse/rust_vendor to update everything as a simple command make sense?

Copy link
Member Author

Choose a reason for hiding this comment

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

Maybe.

I generated the commands matching exactly how std is organised and our current Cargo.lock so they might not be universal. We can wait to execute them a few times in the future (understanding the commands) before making it automatic.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
pr-build Pull request with build/testing/packaging improvement pr-synced-to-cloud The PR is synced to the cloud repo submodule changed At least one submodule changed in this PR.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Rust does not work without Internet
5 participants