Merge pull request #898 from rylev/renames

Some Refactorings

Author: Mark-Simulacrum

collector/src/lib.rs

@@ -16,12 +16,15 @@ pub use self_profile::{QueryData, SelfProfile};
 #[derive(Debug, Copy, Clone, PartialEq, PartialOrd, Deserialize)]
 pub struct DeltaTime(#[serde(with = "round_float")] pub f64);
 
-/// The bound of a range changes in codebase
+/// The bound for finding an artifact
 ///
-/// This can either be the upper or lower bound
+/// This can either be the upper or lower bound.
+/// In the case of commits or tags this is an exact bound, but for dates
+/// it's a best effort (i.e., if the bound is a date but there are no artifacts
+/// for that date, we'll find the artifact that most closely matches).
 #[derive(Debug, Clone, PartialEq, Eq)]
 pub enum Bound {
-    /// An unverified git commit (in sha form)
+    /// An unverified git commit (in sha form) or a tag of a commit (e.g., "1.53.0")
     Commit(String),
     /// A date in time
     Date(NaiveDate),
@@ -30,7 +33,7 @@ pub enum Bound {
 }
 
 impl Bound {
-    /// Tests whether self bounds the commit to the left
+    /// Tests whether `self` matches commit when searching from the left
     pub fn left_match(&self, commit: &Commit) -> bool {
         match self {
             Bound::Commit(sha) => commit.sha == **sha,
@@ -42,7 +45,7 @@ impl Bound {
         }
     }
 
-    /// Tests whether self bounds the commit to the right
+    /// Tests whether `self` matches commit when searching from the right
     pub fn right_match(&self, commit: &Commit) -> bool {
         match self {
             Bound::Commit(sha) => commit.sha == **sha,

database/src/lib.rs

@@ -450,9 +450,11 @@ pub struct LabelId(pub u8, pub u32);
 #[derive(Serialize, Deserialize, Copy, Clone, PartialEq, Eq, PartialOrd, Ord, Hash, Debug)]
 pub struct ArtifactIdNumber(pub u32);
 
-/// Id lookups for various things
+/// Cached Id lookups for many database tables.
 ///
-/// This is a quick way to find what the database id for something
+/// This is a quick way to find what the database id for something.
+/// Essentially duplicates of the various database tables (artifacts,
+/// error_series, pstat_series, etc.) so that we can avoid a network round-trip.
 #[derive(Debug, Clone, PartialEq, Eq, Default)]
 pub struct Index {
     /// Id look for a commit

site/src/api.rs

@@ -1,12 +1,3 @@
-// Copyright 2016 The rustc-perf Project Developers. See the COPYRIGHT
-// file at the top-level directory.
-//
-// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
-// http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
-// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
-// option. This file may not be copied, modified, or distributed
-// except according to those terms.
-
 //! Each API endpoint has its own module. The modules contain Request and/or
 //! Response structs; these contain the specifications for how to interact
 //! with the API.
@@ -80,7 +71,7 @@ pub struct CommitResponse {
 }
 
 pub mod data {
-    use crate::comparison::DateData;
+    use crate::comparison::ArtifactData;
     use collector::Bound;
     use serde::{Deserialize, Serialize};
 
@@ -95,7 +86,7 @@ pub mod data {
 
     /// List of DateData's from oldest to newest
     #[derive(Debug, Clone, Serialize)]
-    pub struct Response(pub Vec<DateData>);
+    pub struct Response(pub Vec<ArtifactData>);
 }
 
 pub mod graph {
@@ -165,16 +156,16 @@ pub mod bootstrap {
     }
 }
 
-pub mod days {
-    use crate::comparison::DateData;
+pub mod comparison {
     use collector::Bound;
+    use database::Date;
     use serde::{Deserialize, Serialize};
+    use std::collections::HashMap;
 
     #[derive(Debug, PartialEq, Clone, Serialize, Deserialize)]
     pub struct Request {
         pub start: Bound,
         pub end: Bound,
-
         pub stat: String,
     }
 
@@ -183,8 +174,8 @@ pub mod days {
         /// The names for the previous artifact before `a`, if any.
         pub prev: Option<String>,
 
-        pub a: DateData,
-        pub b: DateData,
+        pub a: ArtifactData,
+        pub b: ArtifactData,
 
         /// The names for the next artifact after `b`, if any.
         pub next: Option<String>,
@@ -193,6 +184,16 @@ pub mod days {
         /// `b`).
         pub is_contiguous: bool,
     }
+
+    /// A serializable wrapper for `comparison::ArtifactData`.
+    #[derive(Debug, Clone, Serialize)]
+    pub struct ArtifactData {
+        pub commit: String,
+        pub date: Option<Date>,
+        pub pr: Option<u32>,
+        pub data: HashMap<String, Vec<(String, f64)>>,
+        pub bootstrap: HashMap<String, u64>,
+    }
 }
 
 pub mod status {