1. 1//! Shared install-root resolution (docs/design/32-release-engineering.md).
2. 2//!
3. 3//! `vak self install/status/verify` (crate `vak`, via
4. 4//! `install::layout::InstallRoot`) and `vak_core::health`'s "self version
5. 5//! parity" check must agree on where the installed-release manifest
6. 6//! lives. `vak-core` cannot depend on the `vak` binary crate (the
7. 7//! dependency runs the other way), so this module is the single source
8. 8//! of truth for manifest-path resolution and `vak::install::layout`
9. 9//! delegates to it instead of re-deriving the platform default.
10. 10//!
11. 11//! Before this module existed, `vak_core::health::install_manifest_path`
12. 12//! hardcoded the Linux `~/.local/share/vak/...`-style layout
13. 13//! (`home.join("local/release/install.json")`) for every platform,
14. 14//! including macOS, where `self install` actually writes the manifest
15. 15//! into the app bundle at `<prefix>/Contents/Resources/install.json`.
16. 16//! `vak doctor` reported "no installed release manifest" unconditionally
17. 17//! on macOS even for a correctly installed app.
18. 18
19. 19use std::path::{Path, PathBuf};
20. 20
21. 21/// Application bundle name on macOS. Matches `productName` in
22. 22/// `tauri.conf.json`; the desktop bundle and the managed install are the
23. 23/// same directory, so the two spellings must never diverge.
24. 24pub const BUNDLE_NAME: &str = "Vakyartha.app";
25. 25
26. 26/// Overrides the install prefix without threading `--prefix` through
27. 27/// every invocation. Useful for staging and for tests.
28. 28pub const PREFIX_ENV: &str = "VAK_PREFIX";
29. 29
30. 30const MANIFEST_FILE: &str = "install.json";
31. 31
32. 32/// True when `root` is a macOS application bundle, which puts the
33. 33/// manifest (and executables) under `Contents/...` rather than beside
34. 34/// the prefix.
35. 35pub fn is_bundle(root: &Path) -> bool {
36. 36 root.extension().and_then(|e| e.to_str()) == Some("app")
37. 37}
38. 38
39. 39/// Where the install manifest lives under a given prefix, accounting for
40. 40/// the bundle layout.
41. 41pub fn manifest_path_for_prefix(prefix: &Path) -> PathBuf {
42. 42 if is_bundle(prefix) {
43. 43 prefix
44. 44 .join("Contents")
45. 45 .join("Resources")
46. 46 .join(MANIFEST_FILE)
47. 47 } else {
48. 48 prefix.join(MANIFEST_FILE)
49. 49 }
50. 50}
51. 51
52. 52/// Platform default install root. macOS gets a real application bundle
53. 53/// so the app is launchable from Finder; other platforms get a managed
54. 54/// prefix under the XDG/canonical data home.
55. 55pub fn platform_default_prefix() -> PathBuf {
56. 56 #[cfg(target_os = "macos")]
57. 57 {
58. 58 let system = PathBuf::from("/Applications").join(BUNDLE_NAME);
59. 59 if system.exists() || dir_writable(Path::new("/Applications")) {
60. 60 return system;
61. 61 }
62. 62 if let Some(h) = std::env::var_os("HOME") {
63. 63 return PathBuf::from(h).join("Applications").join(BUNDLE_NAME);
64. 64 }
65. 65 system
66. 66 }
67. 67 #[cfg(not(target_os = "macos"))]
68. 68 {
69. 69 vak_config::paths::data_home().join("local").join("release")
70. 70 }
71. 71}
72. 72
73. 73#[cfg(target_os = "macos")]
74. 74fn dir_writable(dir: &Path) -> bool {
75. 75 let probe = dir.join(format!(".vak-write-probe-{}", std::process::id()));
76. 76 match std::fs::write(&probe, b"") {
77. 77 Ok(()) => {
78. 78 let _ = std::fs::remove_file(&probe);
79. 79 true
80. 80 }
81. 81 Err(_) => false,
82. 82 }
83. 83}
84. 84
85. 85/// Resolve the install manifest path the same way `InstallRoot::resolve`
86. 86/// resolves the prefix: explicit prefix, then `VAK_PREFIX`, then the
87. 87/// platform default.
88. 88pub fn resolve_manifest_path(explicit_prefix: Option<PathBuf>) -> PathBuf {
89. 89 let prefix = explicit_prefix
90. 90 .or_else(|| {
91. 91 std::env::var_os(PREFIX_ENV)
92. 92 .filter(|v| !v.is_empty())
93. 93 .map(PathBuf::from)
94. 94 })
95. 95 .unwrap_or_else(platform_default_prefix);
96. 96 manifest_path_for_prefix(&prefix)
97. 97}
98. 98
99. 99#[cfg(test)]
100. 100#[allow(clippy::unwrap_used, clippy::expect_used)]
101. 101mod tests {
102. 102 use super::*;
103. 103
104. 104 #[test]
105. 105 fn plain_prefix_puts_manifest_beside_it() {
106. 106 let path = manifest_path_for_prefix(Path::new("/opt/vak"));
107. 107 assert_eq!(path, PathBuf::from("/opt/vak/install.json"));
108. 108 }
109. 109
110. 110 #[test]
111. 111 fn bundle_prefix_puts_manifest_inside_contents_resources() {
112. 112 let path = manifest_path_for_prefix(Path::new("/Applications/Vakyartha.app"));
113. 113 assert_eq!(
114. 114 path,
115. 115 PathBuf::from("/Applications/Vakyartha.app/Contents/Resources/install.json")
116. 116 );
117. 117 }
118. 118
119. 119 #[test]
120. 120 fn explicit_prefix_wins_over_default() {
121. 121 let path = resolve_manifest_path(Some(PathBuf::from("/tmp/vak-explicit")));
122. 122 assert_eq!(path, PathBuf::from("/tmp/vak-explicit/install.json"));
123. 123 }
124. 124}
125. 125