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.

Sign up for GitHub

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 docs.rs #3580

Merged
merged 6 commits into from
Sep 23, 2022
Merged

Fix docs.rs #3580

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
9f83f97
I think this will fix docs.rs but no idea how to test
Sep 21, 2022
52acd56
Generate to correct location
Sep 21, 2022
edaf322
Clippy
Sep 21, 2022
b99dc0c
Alphabetize
Sep 21, 2022
1d07f82
Feature -> cfg
Sep 22, 2022
c7fcac2
New clippy is more demanding
Sep 22, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions datafusion/proto/Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,13 +28,17 @@ keywords = ["arrow", "query", "sql"]
edition = "2021"
rust-version = "1.62"

[package.metadata.docs.rs]
Copy link
Contributor Author

Choose a reason for hiding this comment

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

docs.rs will set this, according to their docs.

features = [ "docsrs" ] # https://github.com/rust-lang/docs.rs/issues/147

[lib]
name = "datafusion_proto"
path = "src/lib.rs"

[features]
default = []
json = ["pbjson", "pbjson-build", "serde", "serde_json"]
docsrs = []
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Did I do this correctly? Does this declare a new feature but say it has no affect on dependencies?

Copy link
Member

Choose a reason for hiding this comment

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

Yes, I think so


[dependencies]
arrow = "23.0.0"
Expand Down
25 changes: 21 additions & 4 deletions datafusion/proto/build.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ fn build() -> Result<(), String> {
use std::io::Write;

let out = std::path::PathBuf::from(
std::env::var("OUT_DIR").expect("Cannot find OUT_DIR environment vairable"),
std::env::var("OUT_DIR").expect("Cannot find OUT_DIR environment variable"),
);
let descriptor_path = out.join("proto_descriptor.bin");

Expand Down Expand Up @@ -61,8 +61,9 @@ fn build() -> Result<(), String> {
let json = std::fs::read_to_string(out.join("datafusion.serde.rs")).unwrap();
let mut file = std::fs::OpenOptions::new()
.write(true)
.truncate(true)
Copy link
Contributor Author

Choose a reason for hiding this comment

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

This was key to use just one output file for either feature set and avoid combinatorial explosions.

.create(true)
.open("src/generated/datafusion_json.rs")
.open("src/generated/datafusion.rs")
Copy link
Contributor Author

Choose a reason for hiding this comment

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

I was generating to two different files because it seemed like it was smooshing the code together when I switched feature sets. Now I realize I had to call .truncate(true) below.

.unwrap();
file.write(proto.as_str().as_ref()).unwrap();
file.write(json.as_str().as_ref()).unwrap();
Expand All @@ -72,8 +73,24 @@ fn build() -> Result<(), String> {

#[cfg(not(feature = "json"))]
fn build() -> Result<(), String> {
use std::io::Write;

let out = std::path::PathBuf::from(
std::env::var("OUT_DIR").expect("Cannot find OUT_DIR environment variable"),
);

prost_build::Config::new()
.out_dir("src/generated")
.compile_protos(&["proto/datafusion.proto"], &["proto"])
.map_err(|e| format!("protobuf compilation failed: {}", e))
.map_err(|e| format!("protobuf compilation failed: {}", e))?;

let proto = std::fs::read_to_string(out.join("datafusion.rs")).unwrap();
let mut file = std::fs::OpenOptions::new()
.write(true)
.truncate(true)
.create(true)
.open("src/generated/datafusion.rs")
.unwrap();
file.write(proto.as_str().as_ref()).unwrap();
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Generate code the same way no matter which feature is selected.


Ok(())
}
13 changes: 8 additions & 5 deletions datafusion/proto/src/generated/mod.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,13 +15,16 @@
// specific language governing permissions and limitations
// under the License.

// include the generated protobuf source as a submodule
#[allow(clippy::all)]
#[rustfmt::skip]
#[cfg(not(feature = "json"))]
#[cfg(not(docsrs))]
Copy link
Contributor Author

Choose a reason for hiding this comment

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

When we have a writable source folder, generate into that.

pub mod datafusion;

#[cfg(docsrs)]
#[allow(clippy::all)]
#[rustfmt::skip]
#[cfg(feature = "json")]
pub mod datafusion_json;
pub mod datafusion {
Copy link
Contributor Author

Choose a reason for hiding this comment

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

When not writable, pull from OUT_DIR.

include!(concat!(env!("OUT_DIR"), "/datafusion.rs"));

#[cfg(feature = "json")]
include!(concat!(env!("OUT_DIR"), "/datafusion.serde.rs"));
}
3 changes: 0 additions & 3 deletions datafusion/proto/src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,10 +25,7 @@ pub mod generated;
pub mod logical_plan;
pub mod to_proto;

#[cfg(not(feature = "json"))]
pub use generated::datafusion as protobuf;
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Now the module name is always the same! :D

#[cfg(feature = "json")]
pub use generated::datafusion_json as protobuf;

#[cfg(doctest)]
doc_comment::doctest!("../README.md", readme_example_test);
Expand Down