1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412
/*
* Copyright (c) Meta Platforms, Inc. and affiliates.
*
* This source code is licensed under both the MIT license found in the
* LICENSE-MIT file in the root directory of this source tree and the Apache
* License, Version 2.0 found in the LICENSE-APACHE file in the root directory
* of this source tree.
*/
#![deny(warnings, missing_docs, clippy::all, rustdoc::broken_intra_doc_links)]
//! This crate is a wrapper around
//! [fbthrift](https://github.com/facebook/fbthrift)'s compiler. Its main usage
//! is from within [Cargo build
//! scripts](https://doc.rust-lang.org/cargo/reference/build-scripts.html) where
//! it might be invoked to generate rust code from thrift files.
use std::borrow::Cow;
use std::env;
use std::ffi::OsStr;
use std::ffi::OsString;
use std::fmt;
use std::fs;
use std::path::Path;
use std::path::PathBuf;
use std::process::Command;
use anyhow::anyhow;
use anyhow::ensure;
use anyhow::Context;
use anyhow::Result;
use clap::ValueEnum;
use serde::Deserialize;
use which::which;
/// A thrift library 'foo' (say) results in two crates 'foo' and 'foo_types'. We
/// arrange that the thrift compiler wrapper be invoked from the build of both.
/// The behavior of the wrapper is sensitive to the invocation context ('foo' vs
/// 'foo-types') and this type is used to disambiguate.
#[derive(Clone, Copy, Debug, Deserialize, Eq, PartialEq, ValueEnum)]
pub enum GenContext {
/// 'lib' crate generation context (e.g. 'foo').
#[serde(rename = "lib")]
Lib,
/// 'types' crate generation context (e.g. 'foo_types').
#[serde(rename = "types")]
Types,
}
impl fmt::Display for GenContext {
fn fmt(&self, fmt: &mut fmt::Formatter) -> fmt::Result {
let t = match self {
GenContext::Lib => "lib",
GenContext::Types => "types",
};
fmt.write_str(t)
}
}
/// Builder for thrift compiler wrapper.
pub struct Config {
thrift_bin: Option<OsString>,
out_dir: PathBuf,
gen_context: GenContext,
base_path: Option<PathBuf>,
crate_map: Option<PathBuf>,
types_crate: Option<String>,
options: Option<String>,
lib_include_srcs: Vec<String>, // src to include in the primary crate
types_include_srcs: Vec<String>, // src to include in the -types sub-crate
}
impl Config {
/// Return a new configuration with the required parameters set
pub fn new(
gen_context: GenContext,
thrift_bin: Option<OsString>,
out_dir: PathBuf,
) -> Result<Self> {
Ok(Self {
thrift_bin,
out_dir,
gen_context,
base_path: None,
crate_map: None,
types_crate: None,
options: None,
lib_include_srcs: vec![],
types_include_srcs: vec![],
})
}
/// Return a new configuration with parameters computed based on environment variables set by
/// Cargo's build scrip (OUT_DIR mostly). If THRIFT is in the environment, that will be used as
/// the Thrift binary. Otherwise, it will be detected in run_compiler.
pub fn from_env(gen_context: GenContext) -> Result<Self> {
println!("cargo:rerun-if-env-changed=THRIFT");
let thrift_bin = env::var_os("THRIFT");
let out_dir = env::var_os("OUT_DIR")
.map(PathBuf::from)
.context("OUT_DIR environment variable must be set")?;
let crate_map = out_dir.join("cratemap");
let mut conf = Self::new(gen_context, thrift_bin, out_dir)?;
if crate_map.is_file() {
conf.crate_map(crate_map);
}
Ok(conf)
}
/// Set the base path which is used by the compiler to find thrift files included by input
/// thrift files. This is also used to find the compiler.
pub fn base_path(&mut self, value: impl Into<PathBuf>) -> &mut Self {
self.base_path = Some(value.into());
self
}
/// Set the path to file with crate map definition which is used by the
/// compiler to infer crate names that will be used in the generated code.
/// Please refer to code in
/// fbthrift/thrift/compiler/generate/t_mstch_rust_generator.cc
/// for the scheme of crate map.
pub fn crate_map(&mut self, value: impl Into<PathBuf>) -> &mut Self {
self.crate_map = Some(value.into());
self
}
/// Set the name of the types sub-crate needed by by the thrift-compiler (to
/// be able to generate things like `use ::foo__types`).
pub fn types_crate(&mut self, value: impl Into<String>) -> &mut Self {
self.types_crate = Some(value.into());
self
}
/// Set the options to be passed to `mstch_rust` code generation. Example
/// options are `serde`.
pub fn options(&mut self, value: impl Into<String>) -> &mut Self {
self.options = Some(value.into());
self
}
/// Set extra srcs to be available in the generated primary crate.
pub fn lib_include_srcs(&mut self, value: Vec<String>) -> &mut Self {
self.lib_include_srcs = value;
self
}
/// Set extra srcs to be available in the generated types sub-crate.
pub fn types_include_srcs(&mut self, value: Vec<String>) -> &mut Self {
self.types_include_srcs = value;
self
}
/// Run the compiler on the input files. As a result a `lib.rs` file will be
/// generated inside the output dir. The contents of the `lib.rs` can vary
/// according to the generation context (e.g. for a given thrift library,
/// 'foo' say, we invoke the generator for the crate 'foo' and for the crate
/// 'foo-types').
pub fn run(&self, input_files: impl IntoIterator<Item = impl AsRef<Path>>) -> Result<()> {
let thrift_bin = self.resolve_thrift_bin()?;
let input = name_and_path_from_input(input_files)?;
let out = &self.out_dir;
fs::create_dir_all(out)?;
for input in &input {
println!("cargo:rerun-if-changed={}", input.1.as_ref().display());
}
for lib_include_src in &self.lib_include_srcs {
println!("cargo:rerun-if-changed={lib_include_src}");
fs::copy(lib_include_src, out.join(lib_include_src))?;
}
for types_include_src in &self.types_include_srcs {
println!("cargo:rerun-if-changed={types_include_src}");
fs::copy(types_include_src, out.join(types_include_src))?;
}
if let [(_name, file)] = &input[..] {
match self.gen_context {
GenContext::Lib => {
// The primary crate.
self.run_compiler(&thrift_bin, out, file)?;
// These files are not of interest here.
fs::remove_file(out.join("consts.rs"))?;
fs::remove_file(out.join("errors.rs"))?;
fs::remove_file(out.join("services.rs"))?;
fs::remove_file(out.join("types.rs"))?;
// 'lib.rs' together with the remaining files have the
// content we want.
{ /* nothing to do */ }
}
GenContext::Types => {
// The -types sub-crate.
self.run_compiler(&thrift_bin, out, file)?;
// These files are not of interest here (for now).
fs::remove_file(out.join("lib.rs"))?;
fs::remove_file(out.join("dependencies.rs"))?;
fs::remove_file(out.join("client.rs"))?;
fs::remove_file(out.join("server.rs"))?;
fs::remove_file(out.join("mock.rs"))?;
// 'types.rs' (together with the remaining files) has the
// content we want (but the file needs renaming to
// 'lib.rs').
fs::rename(out.join("types.rs"), out.join("lib.rs"))?;
}
}
} else {
match self.gen_context {
GenContext::Lib => {
// The primary crate.
for (name, file) in &input {
let submod = out.join(name);
fs::create_dir_all(&submod)?;
self.run_compiler(&thrift_bin, &submod, file)?;
// These files are not of interest here.
fs::remove_file(submod.join("consts.rs"))?;
fs::remove_file(submod.join("errors.rs"))?;
fs::remove_file(submod.join("services.rs"))?;
fs::remove_file(submod.join("types.rs"))?;
// 'lib.rs' (together with the remaining files) has the
// content we want (but the file needs renaming to
// 'mod.rs').
fs::rename(submod.join("lib.rs"), submod.join("mod.rs"))?;
}
}
GenContext::Types => {
// The -types sub-crate.
for (name, file) in &input {
let submod = out.join(name);
fs::create_dir_all(&submod)?;
self.run_compiler(&thrift_bin, &submod, file)?;
// These files are not of interest here.
fs::remove_file(submod.join("lib.rs"))?;
fs::remove_file(submod.join("dependencies.rs"))?;
fs::remove_file(submod.join("client.rs"))?;
fs::remove_file(submod.join("server.rs"))?;
// 'types.rs' (together with the remaining files) has the
// content we want (but the file needs renaming to
// 'mod.rs').
fs::rename(submod.join("types.rs"), submod.join("mod.rs"))?;
}
}
}
let lib = format!(
"{}\n",
input
.iter()
.map(|(name, _file)| format!("pub mod {};", name.to_string_lossy()))
.collect::<Vec<_>>()
.join("\n")
);
fs::write(out.join("lib.rs"), lib)?;
}
Ok(())
}
fn resolve_thrift_bin(&self) -> Result<Cow<'_, OsString>> {
// Get raw location
let mut thrift_bin = if let Some(bin) = self.thrift_bin.as_ref() {
Cow::Borrowed(bin)
} else {
Cow::Owned(self.infer_thrift_binary())
};
// Resolve based on PATH if needed
let thrift_bin_path: &Path = thrift_bin.as_ref().as_ref();
if thrift_bin_path.components().count() == 1 {
println!("cargo:rerun-if-env-changed=PATH");
let new_path = which(thrift_bin.as_ref()).with_context(|| {
format!(
"Failed to resolve thrift binary `{}` to an absolute path",
thrift_bin.to_string_lossy()
)
})?;
thrift_bin = Cow::Owned(new_path.into_os_string())
}
println!("cargo:rerun-if-changed={}", thrift_bin.to_string_lossy());
Ok(thrift_bin)
}
fn infer_thrift_binary(&self) -> OsString {
if let Some(base) = self.base_path.as_ref() {
let mut candidate = base.clone();
candidate.push("thrift/facebook/rpm/thrift1");
#[cfg(windows)]
candidate.set_extension("exe");
if Path::new(&candidate).exists() {
return candidate.into_os_string();
}
}
"thrift1".into()
}
fn run_compiler(
&self,
thrift_bin: &OsStr,
out: impl AsRef<Path>,
input: impl AsRef<Path>,
) -> Result<String> {
let mut cmd = Command::new(thrift_bin);
let args = {
let mut args = Vec::new();
if let Some(crate_map) = &self.crate_map {
args.push(format!("cratemap={}", crate_map.display()))
}
if let Some(base_path) = &self.base_path {
args.push(format!("include_prefix={}", base_path.display()));
cmd.arg("-I");
cmd.arg(base_path);
}
if let Some(types_crate) = &self.types_crate {
args.push(format!("types_crate={}", types_crate));
}
if !self.lib_include_srcs.is_empty() {
args.push(format!(
"lib_include_srcs={}",
self.lib_include_srcs.join(":")
));
}
if !self.types_include_srcs.is_empty() {
args.push(format!(
"types_include_srcs={}",
self.types_include_srcs.join(":")
));
}
if let Some(options) = &self.options {
args.push(options.to_owned());
}
if args.is_empty() {
"".to_owned()
} else {
format!(":{}", args.join(","))
}
};
cmd.arg("--gen")
.arg(format!("mstch_rust{args}"))
.arg("--out")
.arg(out.as_ref())
.arg(input.as_ref());
let output = cmd.output().with_context(|| {
format!(
"Failed to run thrift compiler. Is '{}' executable?",
thrift_bin.to_string_lossy()
)
})?;
ensure!(
output.status.success(),
format!(
"Command '{:#?}' failed! Stdout:\n{}\nStderr:\n{}",
cmd,
String::from_utf8_lossy(&output.stdout),
String::from_utf8_lossy(&output.stderr),
)
);
let out_file = out.as_ref().join("lib.rs");
ensure!(
out_file.is_file(),
format!(
"Thrift has successfully run, but the resulting '{}' file is missing, command: '{:#?}'",
out_file.display(),
cmd,
)
);
fs::read_to_string(&out_file)
.with_context(|| format!("Failed to read content of file '{}'", out_file.display()))
}
}
fn name_and_path_from_input<T: AsRef<Path>>(
input_files: impl IntoIterator<Item = T>,
) -> Result<Vec<(OsString, T)>> {
input_files
.into_iter()
.map(|file| {
Ok((
file.as_ref()
.file_stem()
.ok_or_else(|| {
anyhow!(
"Failed to get file_stem from path {}",
file.as_ref().display()
)
})?
.to_owned(),
file,
))
})
.collect()
}