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

fix: don't write files outside of OUT_DIR #347

Merged
merged 4 commits into from
Jul 10, 2024
Merged

Conversation

frectonz
Copy link
Contributor

The cargo docs state that build.rs scripts should not write files outside of the OUT_DIR.

In general, build scripts should not modify any files outside of OUT_DIR. It may seem fine on the first blush, but it does cause problems when you use such crate as a dependency, because there’s an implicit invariant that sources in .cargo/registry should be immutable. cargo won’t allow such scripts when packaging.

Taken from here.

Some build environments like Nix use this information to provide a sandbox environment for build.rs scripts to run. These sandbox environments fail the build if the script tries to modify files that are not in the OUT_DIR.

The modification being done in this crate is the extraction of the DuckDB source archive. Currently, the archive is being extracted in the root directory of the libduckdb-sys crate. This causes the build to fail in sandbox environments.

In this PR, I have modified the build.rs script for libduckdb-sys to extract the DuckDB archive in the OUT_DIR. I have also added some code to delete all the extracted source files from the OUT_DIR after the compilation is completed because they will no longer needed.

@frectonz frectonz changed the title Don't write files outside of OUT_DIR fix: don't write files outside of OUT_DIR Jun 23, 2024
@frectonz
Copy link
Contributor Author

frectonz commented Jul 6, 2024

The clippy warnings in the failed CI run are not part of my changes.

@Mytherin Mytherin merged commit 983e02a into duckdb:main Jul 10, 2024
3 of 4 checks passed
@Mytherin
Copy link
Contributor

Thanks!

robert3005 referenced this pull request in spiraldb/vortex Jul 11, 2024
[![Mend
Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com)

This PR contains the following updates:

| Package | Type | Update | Change |
|---|---|---|---|
| [duckdb](https://togithub.com/wangfenjin/duckdb-rs) |
workspace.dependencies | major | `0.10.2` -> `1.0.0` |

---

### Release Notes

<details>
<summary>wangfenjin/duckdb-rs (duckdb)</summary>

###
[`v1.0.0`](https://togithub.com/duckdb/duckdb-rs/releases/tag/v1.0.0)

[Compare
Source](https://togithub.com/wangfenjin/duckdb-rs/compare/v0.10.2...v1.0.0)

This release upgrades the shipped DuckDB to v1.0.0, in addition to a
number of bug fixes.

**Note**: The `httpfs` module that ships the `httpfs` extension is
removed in this release. The `httpfs` extension can instead be used
through DuckDB's native extension installation/loading mechanism.

#### What's Changed

- feat: support "large" arrow data types by
[@&#8203;Mause](https://togithub.com/Mause) in
[https://github.com/duckdb/duckdb-rs/pull/307](https://togithub.com/duckdb/duckdb-rs/pull/307)
- Fixes the issue ignoring nulls when copy from arrow array to flat
vector by [@&#8203;y-f-u](https://togithub.com/y-f-u) in
[https://github.com/duckdb/duckdb-rs/pull/316](https://togithub.com/duckdb/duckdb-rs/pull/316)
- change SQLite to DuckDB by
[@&#8203;era127](https://togithub.com/era127) in
[https://github.com/duckdb/duckdb-rs/pull/308](https://togithub.com/duckdb/duckdb-rs/pull/308)
- Organise workspace crates and consolidate Cargo.toml manifest
properties/dependencies by
[@&#8203;Swoorup](https://togithub.com/Swoorup) in
[https://github.com/duckdb/duckdb-rs/pull/285](https://togithub.com/duckdb/duckdb-rs/pull/285)
- Update README.md by [@&#8203;yoonghm](https://togithub.com/yoonghm) in
[https://github.com/duckdb/duckdb-rs/pull/242](https://togithub.com/duckdb/duckdb-rs/pull/242)
- Add support for DuckDB arrays when using Arrow's FixedSizeList by
[@&#8203;Jeadie](https://togithub.com/Jeadie) in
[https://github.com/duckdb/duckdb-rs/pull/323](https://togithub.com/duckdb/duckdb-rs/pull/323)
- Add support for BinaryArray in arrow-vtab by
[@&#8203;phillipleblanc](https://togithub.com/phillipleblanc) in
[https://github.com/duckdb/duckdb-rs/pull/324](https://togithub.com/duckdb/duckdb-rs/pull/324)
- use openssl from runner by
[@&#8203;Maxxen](https://togithub.com/Maxxen) in
[https://github.com/duckdb/duckdb-rs/pull/327](https://togithub.com/duckdb/duckdb-rs/pull/327)
- Add ability to pass vendored feature to openssl in libduckdb-sys by
[@&#8203;muralisoundararajan](https://togithub.com/muralisoundararajan)
in
[https://github.com/duckdb/duckdb-rs/pull/321](https://togithub.com/duckdb/duckdb-rs/pull/321)
- Implement appender for date/time types by
[@&#8203;rijkvp](https://togithub.com/rijkvp) in
[https://github.com/duckdb/duckdb-rs/pull/313](https://togithub.com/duckdb/duckdb-rs/pull/313)
- Support decimal128 without casting to double by
[@&#8203;Maxxen](https://togithub.com/Maxxen) in
[https://github.com/duckdb/duckdb-rs/pull/328](https://togithub.com/duckdb/duckdb-rs/pull/328)
- feat: experimental support for further nested types by
[@&#8203;Mause](https://togithub.com/Mause) in
[https://github.com/duckdb/duckdb-rs/pull/318](https://togithub.com/duckdb/duckdb-rs/pull/318)
- upgrade arrow-rs to 52 by [@&#8203;Mause](https://togithub.com/Mause)
in
[https://github.com/duckdb/duckdb-rs/pull/332](https://togithub.com/duckdb/duckdb-rs/pull/332)
- Expose the underlying schema of executed statement by
[@&#8203;abhiaagarwal](https://togithub.com/abhiaagarwal) in
[https://github.com/duckdb/duckdb-rs/pull/333](https://togithub.com/duckdb/duckdb-rs/pull/333)
- Remove mut from raw_query by
[@&#8203;rijkvp](https://togithub.com/rijkvp) in
[https://github.com/duckdb/duckdb-rs/pull/339](https://togithub.com/duckdb/duckdb-rs/pull/339)
- Support Arrow type `LargeUtf8`. by
[@&#8203;Jeadie](https://togithub.com/Jeadie) in
[https://github.com/duckdb/duckdb-rs/pull/341](https://togithub.com/duckdb/duckdb-rs/pull/341)
- Update duckdb-rs to DuckDB v1.0.0 by
[@&#8203;Mytherin](https://togithub.com/Mytherin) in
[https://github.com/duckdb/duckdb-rs/pull/336](https://togithub.com/duckdb/duckdb-rs/pull/336)
- fix: don't write files outside of `OUT_DIR` by
[@&#8203;frectonz](https://togithub.com/frectonz) in
[https://github.com/duckdb/duckdb-rs/pull/347](https://togithub.com/duckdb/duckdb-rs/pull/347)
- Remove built-in HTTPFS extension and fix Windows CI by
[@&#8203;Mytherin](https://togithub.com/Mytherin) in
[https://github.com/duckdb/duckdb-rs/pull/353](https://togithub.com/duckdb/duckdb-rs/pull/353)
- Upgrade duckdb-loadable-macros to 0.1.2 by
[@&#8203;Mytherin](https://togithub.com/Mytherin) in
[https://github.com/duckdb/duckdb-rs/pull/354](https://togithub.com/duckdb/duckdb-rs/pull/354)

#### New Contributors

- [@&#8203;y-f-u](https://togithub.com/y-f-u) made their first
contribution in
[https://github.com/duckdb/duckdb-rs/pull/316](https://togithub.com/duckdb/duckdb-rs/pull/316)
- [@&#8203;era127](https://togithub.com/era127) made their first
contribution in
[https://github.com/duckdb/duckdb-rs/pull/308](https://togithub.com/duckdb/duckdb-rs/pull/308)
-
[@&#8203;muralisoundararajan](https://togithub.com/muralisoundararajan)
made their first contribution in
[https://github.com/duckdb/duckdb-rs/pull/321](https://togithub.com/duckdb/duckdb-rs/pull/321)
- [@&#8203;rijkvp](https://togithub.com/rijkvp) made their first
contribution in
[https://github.com/duckdb/duckdb-rs/pull/313](https://togithub.com/duckdb/duckdb-rs/pull/313)
- [@&#8203;abhiaagarwal](https://togithub.com/abhiaagarwal) made their
first contribution in
[https://github.com/duckdb/duckdb-rs/pull/333](https://togithub.com/duckdb/duckdb-rs/pull/333)
- [@&#8203;frectonz](https://togithub.com/frectonz) made their first
contribution in
[https://github.com/duckdb/duckdb-rs/pull/347](https://togithub.com/duckdb/duckdb-rs/pull/347)

**Full Changelog**:
duckdb/duckdb-rs@v0.10.2...v1.0.0

</details>

---

### Configuration

📅 **Schedule**: Branch creation - At any time (no schedule defined),
Automerge - At any time (no schedule defined).

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

♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the
rebase/retry checkbox.

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

---

- [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check
this box

---

This PR has been generated by [Mend
Renovate](https://www.mend.io/free-developer-tools/renovate/). View
repository job log
[here](https://developer.mend.io/github/spiraldb/vortex).

<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNy40MjUuMSIsInVwZGF0ZWRJblZlciI6IjM3LjQyNS4xIiwidGFyZ2V0QnJhbmNoIjoiZGV2ZWxvcCIsImxhYmVscyI6W119-->

---------

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
Co-authored-by: Robert Kruszewski <github@robertk.io>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants