perf: Fixup ordering, fix pathing, docs (#38970)

Release Notes: - N/A

Nia committed 1 year ago

Commit 30b49cf1 parent c69912c6 files · +35 −20Browse files

Unified · Split

6 files

Cargo.lock +1 −0
crates/util/src/paths.rs +20 −18
crates/zed/Cargo.toml +1 −0
docs/src/development.md +6 −0
tooling/perf/src/lib.rs +3 −1
tooling/perf/src/main.rs +4 −1

@@ -20315,6 +20315,7 @@ dependencies = [ · 20314 unmodified lines
20315	"url",	20315	"url",
20316	"urlencoding",	20316	"urlencoding",
20317	"util",	20317	"util",
		20318	"util_macros",
20318	"uuid",	20319	"uuid",
20319	"vim",	20320	"vim",
20320	"vim_mode_setting",	20321	"vim_mode_setting",

crates/util/src/paths.rs+20−18

 #[cfg(test)]
 mod tests {
     use super::*;
+    use util_macros::perf;
-    #[test]
+    #[perf]
     fn compare_paths_with_dots() {
         let mut paths = vec![
             (Path::new("test_dirs"), false),
         );
     }
-    #[test]
+    #[perf]
     fn compare_paths_with_same_name_different_extensions() {
         let mut paths = vec![
             (Path::new("test_dirs/file.rs"), true),
         );
     }
-    #[test]
+    #[perf]
     fn compare_paths_case_semi_sensitive() {
         let mut paths = vec![
             (Path::new("test_DIRS"), false),
         );
     }
-    #[test]
+    #[perf]
     fn path_with_position_parse_posix_path() {
         // Test POSIX filename edge cases
         // Read more at https://en.wikipedia.org/wiki/Filename
         );
     }
-    #[test]
+    #[perf]
     #[cfg(not(target_os = "windows"))]
     fn path_with_position_parse_posix_path_with_suffix() {
         assert_eq!(
         );
     }
-    #[test]
+    #[perf]
     #[cfg(target_os = "windows")]
     fn path_with_position_parse_windows_path() {
         assert_eq!(
         );
     }
-    #[test]
+    #[perf]
     #[cfg(target_os = "windows")]
     fn path_with_position_parse_windows_path_with_suffix() {
         assert_eq!(
         );
     }
-    #[test]
+    #[perf]
     fn test_path_compact() {
         let path: PathBuf = [
             home_dir().to_string_lossy().to_string(),
         }
     }
-    #[test]
+    #[perf]
     fn test_extension_or_hidden_file_name() {
         // No dots in name
         let path = Path::new("/a/b/c/file_name.rs");
         assert_eq!(path.extension_or_hidden_file_name(), Some("eslintrc.js"));
     }
-    #[test]
+    #[perf]
     fn edge_of_glob() {
         let path = Path::new("/work/node_modules");
         let path_matcher =
         );
     }
-    #[test]
+    #[perf]
     fn project_search() {
         let path = Path::new("/Users/someonetoignore/work/zed/zed.dev/node_modules");
         let path_matcher =
         );
     }
-    #[test]
+    #[perf]
     #[cfg(target_os = "windows")]
     fn test_sanitized_path() {
         let path = Path::new("C:\\Users\\someone\\test_file.rs");
         );
     }
-    #[test]
+    #[perf]
     fn test_compare_numeric_segments() {
         // Helper function to create peekable iterators and test
         fn compare(a: &str, b: &str) -> Ordering {
         assert_eq!(b_iter.collect::<String>(), "def");
     }
-    #[test]
+    #[perf]
     fn test_natural_sort() {
         // Basic alphanumeric
         assert_eq!(natural_sort("a", "b"), Ordering::Less);
         assert_eq!(natural_sort("File_a1", "File_A1"), Ordering::Less);
     }
-    #[test]
+    #[perf]
     fn test_compare_paths() {
         // Helper function for cleaner tests
         fn compare(a: &str, is_a_file: bool, b: &str, is_b_file: bool) -> Ordering {
         );
     }
-    #[test]
+    #[perf]
     fn test_natural_sort_case_sensitivity() {
+        std::thread::sleep(std::time::Duration::from_millis(100));
         // Same letter different case - lowercase should come first
         assert_eq!(natural_sort("a", "A"), Ordering::Less);
         assert_eq!(natural_sort("A", "a"), Ordering::Greater);
         assert_eq!(natural_sort("a", "B"), Ordering::Less);
     }
-    #[test]
+    #[perf]
     fn test_natural_sort_with_numbers() {
         // Basic number ordering
         assert_eq!(natural_sort("file1", "file2"), Ordering::Less);
         assert_eq!(natural_sort("file1", "File2"), Ordering::Less);
     }
-    #[test]
+    #[perf]
     fn test_natural_sort_edge_cases() {
         // Empty strings
         assert_eq!(natural_sort("", ""), Ordering::Equal);

crates/zed/Cargo.toml+1−0

@@ -189,6 +189,7 @@ project = { workspace = true, features = ["test-support"] } · 188 unmodified lines
189	terminal_view = { workspace = true, features = ["test-support"] }	189	terminal_view = { workspace = true, features = ["test-support"] }
190	tree-sitter-md.workspace = true	190	tree-sitter-md.workspace = true
191	tree-sitter-rust.workspace = true	191	tree-sitter-rust.workspace = true
		192	util_macros.workspace = true
192	workspace = { workspace = true, features = ["test-support"] }	193	workspace = { workspace = true, features = ["test-support"] }
193		194
194	[package.metadata.bundle-dev]	195	[package.metadata.bundle-dev]

docs/src/development.md+6−0

@@ -79,6 +79,12 @@ Here's a typical workflow for comparing frame rendering performance between diff · 78 unmodified lines
79		79
80	The `script/histogram` tool can accept as many measurement files as you like and will generate a histogram visualization comparing the frame rendering performance data between the provided versions.	80	The `script/histogram` tool can accept as many measurement files as you like and will generate a histogram visualization comparing the frame rendering performance data between the provided versions.
81		81
		82	### Using `util_macros::perf`
		83
		84	For benchmarking unit tests, annotate them with the `#[perf]` attribute from the `util_macros` crate. Then run `cargo
		85	perf-test -p $CRATE` to benchmark them. See the rustdoc documentation on `crates/util_macros` and `tooling/perf` for
		86	in-depth examples and explanations.
		87
82	## Contributor links	88	## Contributor links
83		89
84	- [CONTRIBUTING.md](https://github.com/zed-industries/zed/blob/main/CONTRIBUTING.md)	90	- [CONTRIBUTING.md](https://github.com/zed-industries/zed/blob/main/CONTRIBUTING.md)

tooling/perf/src/lib.rs+3−1

 //! Some constants and datatypes used in the Zed perf profiler. Should only be
 //! consumed by the crate providing the matching macros.
+//!
+//! For usage documentation, see the docs on this crate's binary.
 use collections::HashMap;
 use serde::{Deserialize, Serialize};
                         continue;
                     };
                     let shift =
-                        (s_timings.iters_per_sec(s_iters) / o_timings.iters_per_sec(o_iters)) - 1.;
+                        (o_timings.iters_per_sec(o_iters) / s_timings.iters_per_sec(s_iters)) - 1.;
                     if shift > max {
                         max = shift;
                     }

tooling/perf/src/main.rs+4−1

     let ident_new = args.first().expect("FATAL: missing identifier for new run");
     let ident_old = args.get(1).expect("FATAL: missing identifier for old run");
     let wspace_dir = std::env::var("CARGO_MANIFEST_DIR").unwrap();
-    let runs_dir = PathBuf::from(&wspace_dir).join(consts::RUNS_DIR);
+    let runs_dir = PathBuf::from(&wspace_dir)
+        .join("..")
+        .join("..")
+        .join(consts::RUNS_DIR);
     // Use the blank outputs initially, so we can merge into these with prefixes.
     let mut outputs_new = Output::blank();