|
|
@@ -0,0 +1,327 @@
|
|
|
+// Copyright 2019-2023 Tauri Programme within The Commons Conservancy
|
|
|
+// SPDX-License-Identifier: Apache-2.0
|
|
|
+// SPDX-License-Identifier: MIT
|
|
|
+
|
|
|
+use crate::{interface::rust::manifest::read_manifest, Result};
|
|
|
+
|
|
|
+use anyhow::Context;
|
|
|
+use itertools::Itertools;
|
|
|
+use tauri_utils_v1::config::Allowlist;
|
|
|
+use toml_edit::{Document, Entry, Item, Table, TableLike, Value};
|
|
|
+
|
|
|
+use std::{fs::File, io::Write, path::Path};
|
|
|
+
|
|
|
+const CRATE_TYPES: &[&str] = &["staticlib", "cdylib", "rlib"];
|
|
|
+
|
|
|
+pub fn migrate(tauri_dir: &Path) -> Result<()> {
|
|
|
+ let manifest_path = tauri_dir.join("Cargo.toml");
|
|
|
+ let mut manifest = read_manifest(&manifest_path)?;
|
|
|
+ migrate_manifest(&mut manifest)?;
|
|
|
+
|
|
|
+ let mut manifest_file =
|
|
|
+ File::create(&manifest_path).with_context(|| "failed to open Cargo.toml for rewrite")?;
|
|
|
+ manifest_file.write_all(
|
|
|
+ manifest
|
|
|
+ .to_string()
|
|
|
+ // apply some formatting fixes
|
|
|
+ .replace(r#"" ,features =["#, r#"", features = ["#)
|
|
|
+ .replace(r#"" , features"#, r#"", features"#)
|
|
|
+ .replace("]}", "] }")
|
|
|
+ .replace("={", "= {")
|
|
|
+ .replace("=[", "= [")
|
|
|
+ .as_bytes(),
|
|
|
+ )?;
|
|
|
+ manifest_file.flush()?;
|
|
|
+
|
|
|
+ Ok(())
|
|
|
+}
|
|
|
+
|
|
|
+fn migrate_manifest(manifest: &mut Document) -> Result<()> {
|
|
|
+ let dependencies = manifest
|
|
|
+ .as_table_mut()
|
|
|
+ .entry("dependencies")
|
|
|
+ .or_insert(Item::Table(Table::new()))
|
|
|
+ .as_table_mut()
|
|
|
+ .expect("manifest dependencies isn't a table");
|
|
|
+
|
|
|
+ let version = dependency_version();
|
|
|
+ migrate_dependency(dependencies, "tauri", version, &features_to_remove());
|
|
|
+
|
|
|
+ let lib = manifest
|
|
|
+ .as_table_mut()
|
|
|
+ .entry("lib")
|
|
|
+ .or_insert(Item::Table(Table::new()))
|
|
|
+ .as_table_mut()
|
|
|
+ .expect("manifest lib isn't a table");
|
|
|
+ match lib.entry("crate-type") {
|
|
|
+ Entry::Occupied(mut e) => {
|
|
|
+ if let Item::Value(Value::Array(types)) = e.get_mut() {
|
|
|
+ let mut crate_types_to_add = CRATE_TYPES.to_vec();
|
|
|
+ for t in types.iter() {
|
|
|
+ // type is already in the manifest, skip adding it
|
|
|
+ if let Some(i) = crate_types_to_add
|
|
|
+ .iter()
|
|
|
+ .position(|ty| Some(ty) == t.as_str().as_ref())
|
|
|
+ {
|
|
|
+ crate_types_to_add.remove(i);
|
|
|
+ }
|
|
|
+ }
|
|
|
+ for t in crate_types_to_add {
|
|
|
+ types.push(t);
|
|
|
+ }
|
|
|
+ }
|
|
|
+ }
|
|
|
+ Entry::Vacant(e) => {
|
|
|
+ let mut arr = toml_edit::Array::new();
|
|
|
+ arr.extend(CRATE_TYPES.to_vec());
|
|
|
+ e.insert(Item::Value(arr.into()));
|
|
|
+ }
|
|
|
+ }
|
|
|
+
|
|
|
+ Ok(())
|
|
|
+}
|
|
|
+
|
|
|
+fn features_to_remove() -> Vec<&'static str> {
|
|
|
+ let mut features_to_remove = tauri_utils_v1::config::AllowlistConfig::all_features();
|
|
|
+ features_to_remove.push("reqwest-client");
|
|
|
+ features_to_remove.push("reqwest-native-tls-vendored");
|
|
|
+ features_to_remove.push("process-command-api");
|
|
|
+ features_to_remove.push("shell-open-api");
|
|
|
+ features_to_remove.push("windows7-compat");
|
|
|
+ features_to_remove.push("updater");
|
|
|
+
|
|
|
+ // this allowlist feature was not removed
|
|
|
+ let index = features_to_remove
|
|
|
+ .iter()
|
|
|
+ .position(|x| x == &"protocol-asset")
|
|
|
+ .unwrap();
|
|
|
+ features_to_remove.remove(index);
|
|
|
+
|
|
|
+ features_to_remove
|
|
|
+}
|
|
|
+
|
|
|
+fn dependency_version() -> String {
|
|
|
+ let pre = env!("CARGO_PKG_VERSION_PRE");
|
|
|
+ if pre.is_empty() {
|
|
|
+ env!("CARGO_PKG_VERSION_MAJOR").to_string()
|
|
|
+ } else {
|
|
|
+ format!(
|
|
|
+ "{}.{}.{}-{}",
|
|
|
+ env!("CARGO_PKG_VERSION_MAJOR"),
|
|
|
+ env!("CARGO_PKG_VERSION_MINOR"),
|
|
|
+ env!("CARGO_PKG_VERSION_PATCH"),
|
|
|
+ pre.split('.').next().unwrap()
|
|
|
+ )
|
|
|
+ }
|
|
|
+}
|
|
|
+
|
|
|
+fn migrate_dependency(dependencies: &mut Table, name: &str, version: String, remove: &[&str]) {
|
|
|
+ let item = dependencies.entry(name).or_insert(Item::None);
|
|
|
+
|
|
|
+ // do not rewrite if dependency uses workspace inheritance
|
|
|
+ if item
|
|
|
+ .get("workspace")
|
|
|
+ .and_then(|v| v.as_bool())
|
|
|
+ .unwrap_or_default()
|
|
|
+ {
|
|
|
+ log::info!("`{name}` dependency has workspace inheritance enabled. The features array won't be automatically rewritten. Remove features: [{}]", remove.iter().join(", "));
|
|
|
+ return;
|
|
|
+ }
|
|
|
+
|
|
|
+ if let Some(dep) = item.as_table_mut() {
|
|
|
+ migrate_dependency_table(dep, version, remove);
|
|
|
+ } else if let Some(Value::InlineTable(table)) = item.as_value_mut() {
|
|
|
+ migrate_dependency_table(table, version, remove);
|
|
|
+ } else if item.as_str().is_some() {
|
|
|
+ *item = Item::Value(version.into());
|
|
|
+ }
|
|
|
+}
|
|
|
+
|
|
|
+fn migrate_dependency_table<D: TableLike>(dep: &mut D, version: String, remove: &[&str]) {
|
|
|
+ *dep.entry("version").or_insert(Item::None) = Item::Value(version.into());
|
|
|
+ let manifest_features = dep.entry("features").or_insert(Item::None);
|
|
|
+ if let Some(features_array) = manifest_features.as_array_mut() {
|
|
|
+ // remove features that shouldn't be in the manifest anymore
|
|
|
+ let mut i = features_array.len();
|
|
|
+ let mut add_features = Vec::new();
|
|
|
+ while i != 0 {
|
|
|
+ let index = i - 1;
|
|
|
+ if let Some(f) = features_array.get(index).and_then(|f| f.as_str()) {
|
|
|
+ if remove.contains(&f) {
|
|
|
+ let f = f.to_string();
|
|
|
+ features_array.remove(index);
|
|
|
+ if f == "reqwest-native-tls-vendored" {
|
|
|
+ add_features.push("native-tls-vendored");
|
|
|
+ }
|
|
|
+ }
|
|
|
+ }
|
|
|
+ i -= 1;
|
|
|
+ }
|
|
|
+ for f in add_features {
|
|
|
+ features_array.push(f);
|
|
|
+ }
|
|
|
+ }
|
|
|
+}
|
|
|
+
|
|
|
+#[cfg(test)]
|
|
|
+mod tests {
|
|
|
+ use itertools::Itertools;
|
|
|
+
|
|
|
+ fn migrate_deps<F: FnOnce(&[&str]) -> String>(get_toml: F) {
|
|
|
+ let keep_features = vec!["isolation", "protocol-asset"];
|
|
|
+ let mut features = super::features_to_remove();
|
|
|
+ features.extend(keep_features.clone());
|
|
|
+ let toml = get_toml(&features);
|
|
|
+
|
|
|
+ let mut manifest = toml.parse::<toml_edit::Document>().expect("invalid toml");
|
|
|
+ super::migrate_manifest(&mut manifest).expect("failed to migrate manifest");
|
|
|
+
|
|
|
+ let dependencies = manifest
|
|
|
+ .as_table()
|
|
|
+ .get("dependencies")
|
|
|
+ .expect("missing manifest dependencies")
|
|
|
+ .as_table()
|
|
|
+ .expect("manifest dependencies isn't a table");
|
|
|
+
|
|
|
+ let tauri = dependencies
|
|
|
+ .get("tauri")
|
|
|
+ .expect("missing tauri dependency in manifest");
|
|
|
+
|
|
|
+ let tauri_table = if let Some(table) = tauri.as_table() {
|
|
|
+ table.clone()
|
|
|
+ } else if let Some(toml_edit::Value::InlineTable(table)) = tauri.as_value() {
|
|
|
+ table.clone().into_table()
|
|
|
+ } else if let Some(version) = tauri.as_str() {
|
|
|
+ // convert the value to a table for the assert logic below
|
|
|
+ let mut table = toml_edit::Table::new();
|
|
|
+ table.insert(
|
|
|
+ "version",
|
|
|
+ toml_edit::Item::Value(version.to_string().into()),
|
|
|
+ );
|
|
|
+ table.insert(
|
|
|
+ "features",
|
|
|
+ toml_edit::Item::Value(toml_edit::Value::Array(Default::default())),
|
|
|
+ );
|
|
|
+ table
|
|
|
+ } else {
|
|
|
+ panic!("unexpected tauri dependency format");
|
|
|
+ };
|
|
|
+
|
|
|
+ // assert version matches
|
|
|
+ let version = tauri_table
|
|
|
+ .get("version")
|
|
|
+ .expect("missing version")
|
|
|
+ .as_str()
|
|
|
+ .expect("version must be a string");
|
|
|
+ assert_eq!(version, super::dependency_version());
|
|
|
+
|
|
|
+ // assert features matches
|
|
|
+ let features = tauri_table
|
|
|
+ .get("features")
|
|
|
+ .expect("missing features")
|
|
|
+ .as_array()
|
|
|
+ .expect("features must be an array")
|
|
|
+ .clone();
|
|
|
+ if toml.contains("reqwest-native-tls-vendored") {
|
|
|
+ assert!(
|
|
|
+ features
|
|
|
+ .iter()
|
|
|
+ .any(|f| f.as_str().expect("feature must be a string") == "native-tls-vendored"),
|
|
|
+ "reqwest-native-tls-vendored was not replaced with native-tls-vendored"
|
|
|
+ );
|
|
|
+ }
|
|
|
+ for feature in features.iter() {
|
|
|
+ let feature = feature.as_str().expect("feature must be a string");
|
|
|
+ assert!(
|
|
|
+ keep_features.contains(&feature) || feature == "native-tls-vendored",
|
|
|
+ "feature {feature} should have been removed"
|
|
|
+ );
|
|
|
+ }
|
|
|
+ }
|
|
|
+
|
|
|
+ fn migrate_lib(toml: &str) {
|
|
|
+ let mut manifest = toml.parse::<toml_edit::Document>().expect("invalid toml");
|
|
|
+ super::migrate_manifest(&mut manifest).expect("failed to migrate manifest");
|
|
|
+
|
|
|
+ let lib = manifest
|
|
|
+ .as_table()
|
|
|
+ .get("lib")
|
|
|
+ .expect("missing manifest lib")
|
|
|
+ .as_table()
|
|
|
+ .expect("manifest lib isn't a table");
|
|
|
+
|
|
|
+ let crate_types = lib
|
|
|
+ .get("crate-type")
|
|
|
+ .expect("missing lib crate-type")
|
|
|
+ .as_array()
|
|
|
+ .expect("crate-type must be an array");
|
|
|
+ let mut not_added_crate_types = super::CRATE_TYPES.to_vec();
|
|
|
+ for t in crate_types {
|
|
|
+ let t = t.as_str().expect("crate-type must be a string");
|
|
|
+ if let Some(i) = not_added_crate_types.iter().position(|ty| ty == &t) {
|
|
|
+ not_added_crate_types.remove(i);
|
|
|
+ }
|
|
|
+ }
|
|
|
+ assert!(
|
|
|
+ not_added_crate_types.is_empty(),
|
|
|
+ "missing crate-type: {not_added_crate_types:?}"
|
|
|
+ );
|
|
|
+ }
|
|
|
+
|
|
|
+ #[test]
|
|
|
+ fn migrate_table() {
|
|
|
+ migrate_deps(|features| {
|
|
|
+ format!(
|
|
|
+ r#"
|
|
|
+ [dependencies]
|
|
|
+ tauri = {{ version = "1.0.0", features = [{}] }}
|
|
|
+"#,
|
|
|
+ features.iter().map(|f| format!("{:?}", f)).join(", ")
|
|
|
+ )
|
|
|
+ });
|
|
|
+ }
|
|
|
+
|
|
|
+ #[test]
|
|
|
+ fn migrate_inline_table() {
|
|
|
+ migrate_deps(|features| {
|
|
|
+ format!(
|
|
|
+ r#"
|
|
|
+ [dependencies.tauri]
|
|
|
+ version = "1.0.0"
|
|
|
+ features = [{}]
|
|
|
+"#,
|
|
|
+ features.iter().map(|f| format!("{:?}", f)).join(", ")
|
|
|
+ )
|
|
|
+ });
|
|
|
+ }
|
|
|
+
|
|
|
+ #[test]
|
|
|
+ fn migrate_str() {
|
|
|
+ migrate_deps(|_features| {
|
|
|
+ r#"
|
|
|
+ [dependencies]
|
|
|
+ tauri = "1.0.0"
|
|
|
+"#
|
|
|
+ .into()
|
|
|
+ })
|
|
|
+ }
|
|
|
+
|
|
|
+ #[test]
|
|
|
+ fn migrate_missing_lib() {
|
|
|
+ migrate_lib("[dependencies]");
|
|
|
+ }
|
|
|
+
|
|
|
+ #[test]
|
|
|
+ fn migrate_missing_crate_types() {
|
|
|
+ migrate_lib("[lib]");
|
|
|
+ }
|
|
|
+
|
|
|
+ #[test]
|
|
|
+ fn migrate_add_crate_types() {
|
|
|
+ migrate_lib(
|
|
|
+ r#"
|
|
|
+ [lib]
|
|
|
+ crate-type = ["something"]"#,
|
|
|
+ );
|
|
|
+ }
|
|
|
+}
|
Lucas Fernandes Nogueira