revset: create DatePattern type

Creates a DatePattern type that can be created by parsing a string in any format supported by the chrono-english crate, including: - 2024-03-25 - 2024-03-25T00:00:00 - 2024-03-25T00:00:00-08:00 - 2 weeks ago - 5 minutes ago - yesterday - yesterday 5pm - yesterday 10:30 - yesterday 15:30 - tomorrow A `kind` can be specified to indicate whether the pattern should match dates at or after (`after`) or strictly before (`before`) the given instant. chrono-english supports US and UK dialects to disambiguate mm/dd/yy from dd/mm/yy, but for now we default to US. This should probably be a config setting.
jj-vcs · Jul 10, 2024 · 18f1230 · 18f1230
1 parent 93d76e5
commit 18f1230
Show file tree

Hide file tree

Showing 5 changed files with 211 additions and 0 deletions.
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/Cargo.toml b/Cargo.toml
@@ -39,6 +39,7 @@ chrono = { version = "0.4.38", default-features = false, features = [
     "std",
     "clock",
 ] }
+chrono-english = { version = "0.1.7" }
 config = { version = "0.13.4", default-features = false, features = ["toml"] }
 criterion = "0.5.1"
 crossterm = { version = "0.27", default-features = false }

diff --git a/lib/Cargo.toml b/lib/Cargo.toml
@@ -38,6 +38,7 @@ backoff = { workspace = true }
 blake2 = { workspace = true }
 bytes = { workspace = true }
 chrono = { workspace = true }
+chrono-english = { workspace = true }
 config = { workspace = true }
 digest = { workspace = true }
 either = { workspace = true }

diff --git a/lib/src/lib.rs b/lib/src/lib.rs
@@ -84,6 +84,7 @@ pub mod stacked_table;
 pub mod store;
 pub mod str_util;
 pub mod submodule_store;
+pub mod time_util;
 pub mod transaction;
 pub mod tree;
 pub mod tree_builder;

diff --git a/lib/src/time_util.rs b/lib/src/time_util.rs
@@ -0,0 +1,189 @@
+// Copyright 2024 The Jujutsu Authors
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// https://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+//! Provides support for parsing and matching date ranges.
+
+use chrono::{DateTime, Local, TimeZone, Utc};
+use chrono_english::{parse_date_string, DateError, Dialect};
+use thiserror::Error;
+
+use crate::backend::Timestamp;
+
+/// Context needed to create a DatePattern during revset evaluation.
+#[derive(Clone, Debug)]
+pub enum DatePatternContext {
+    /// Interpret date patterns using the local machine's time zone
+    Local(DateTime<Local>),
+    /// Interpret date patterns using UTC
+    Utc(DateTime<Utc>),
+}
+
+impl DatePatternContext {
+    /// Parses a DatePattern from the given string and kind.
+    pub fn to_date_pattern(
+        &self,
+        s: &str,
+        kind: &str,
+    ) -> Result<DatePattern, DatePatternParseError> {
+        match &self {
+            DatePatternContext::Local(dt) => DatePattern::from_str_kind(s, kind, dt.to_owned()),
+            DatePatternContext::Utc(dt) => DatePattern::from_str_kind(s, kind, dt.to_owned()),
+        }
+    }
+}
+
+impl From<DateTime<Local>> for DatePatternContext {
+    fn from(value: DateTime<Local>) -> Self {
+        DatePatternContext::Local(value)
+    }
+}
+
+impl From<DateTime<Utc>> for DatePatternContext {
+    fn from(value: DateTime<Utc>) -> Self {
+        DatePatternContext::Utc(value)
+    }
+}
+
+/// Error occurred during date pattern parsing.
+#[derive(Debug, Error)]
+pub enum DatePatternParseError {
+    /// Unknown pattern kind is specified.
+    #[error(r#"Invalid date pattern kind "{0}:""#)]
+    InvalidKind(String),
+    /// Failed to parse timestamp.
+    #[error(transparent)]
+    ParseError(#[from] DateError),
+}
+
+/// Represents an range of dates that may be matched against.
+#[derive(Clone, Debug, Eq, PartialEq)]
+pub enum DatePattern {
+    /// Represents all dates at or after the given instant.
+    AtOrAfter(Timestamp),
+    /// Represents all dates before, but not including, the given instant.
+    Before(Timestamp),
+}
+
+impl DatePattern {
+    /// Parses a string into a DatePattern.
+    ///
+    /// * `s` is the string to be parsed.
+    ///
+    /// * `kind` must be either "after" or "before". This determines whether the
+    ///   pattern will match dates after or before the parsed date.
+    ///
+    /// * `now` is the user's current time. This is a DateTime<Tz> because
+    ///   knowledge of offset changes is needed to correctly process relative
+    ///   times like "today". For example, California entered DST on March 10,
+    ///   2024, shifting clocks from UTC-8 to UTC-7 at 2:00 AM. If the pattern
+    ///   "today" was parsed at noon on that day, it should be interpreted as
+    ///   2024-03-10T00:00:00-08:00 even though the current offset is -07:00.
+    pub fn from_str_kind<Tz: TimeZone>(
+        s: &str,
+        kind: &str,
+        now: DateTime<Tz>,
+    ) -> Result<DatePattern, DatePatternParseError>
+    where
+        Tz::Offset: Copy,
+    {
+        let d =
+            parse_date_string(s, now, Dialect::Us).map_err(DatePatternParseError::ParseError)?;
+        let ts = Timestamp::from_datetime(d.to_utc().fixed_offset());
+        match kind {
+            "after" => Ok(DatePattern::AtOrAfter(ts)),
+            "before" => Ok(DatePattern::Before(ts)),
+            kind => Err(DatePatternParseError::InvalidKind(kind.to_owned())),
+        }
+    }
+
+    /// Determines whether a given timestamp is matched by the pattern.
+    pub fn matches(&self, timestamp: &Timestamp) -> bool {
+        match self {
+            DatePattern::AtOrAfter(earliest) => earliest <= timestamp,
+            DatePattern::Before(latest) => timestamp < latest,
+        }
+    }
+}
+
+#[cfg(test)]
+mod tests {
+    use chrono::DateTime;
+
+    use super::*;
+
+    fn test_equal<Tz: TimeZone>(now: DateTime<Tz>, expression: &str, should_equal_time: &str)
+    where
+        Tz::Offset: Copy,
+    {
+        let expression = DatePattern::from_str_kind(expression, "after", now).unwrap();
+        assert_eq!(
+            expression,
+            DatePattern::AtOrAfter(Timestamp::from_datetime(
+                DateTime::parse_from_rfc3339(should_equal_time)
+                    .unwrap()
+                    .to_utc()
+                    .fixed_offset()
+            ))
+        );
+    }
+
+    #[test]
+    fn test_date_pattern_parses_dates_without_times_as_the_date_at_local_midnight() {
+        let now = DateTime::parse_from_rfc3339("2024-01-01T00:00:00-08:00").unwrap();
+        test_equal(now, "2023-03-25", "2023-03-25T08:00:00Z");
+        test_equal(now, "3/25/2023", "2023-03-25T08:00:00Z");
+        test_equal(now, "3/25/23", "2023-03-25T08:00:00Z");
+    }
+
+    #[test]
+    fn test_date_pattern_parses_dates_with_times_without_specifying_an_offset() {
+        let now = DateTime::parse_from_rfc3339("2024-01-01T00:00:00-08:00").unwrap();
+        test_equal(now, "2023-03-25T00:00:00", "2023-03-25T08:00:00Z");
+        test_equal(now, "2023-03-25 00:00:00", "2023-03-25T08:00:00Z");
+    }
+
+    #[test]
+    fn test_date_pattern_parses_dates_with_a_specified_offset() {
+        let now = DateTime::parse_from_rfc3339("2024-01-01T00:00:00-08:00").unwrap();
+        test_equal(
+            now,
+            "2023-03-25T00:00:00-05:00",
+            "2023-03-25T00:00:00-05:00",
+        );
+    }
+
+    #[test]
+    fn test_date_pattern_parses_dates_with_the_z_offset() {
+        let now = DateTime::parse_from_rfc3339("2024-01-01T00:00:00-08:00").unwrap();
+        test_equal(now, "2023-03-25T00:00:00Z", "2023-03-25T00:00:00Z");
+    }
+
+    #[test]
+    fn test_date_pattern_parses_relative_durations() {
+        let now = DateTime::parse_from_rfc3339("2024-01-01T00:00:00-08:00").unwrap();
+        test_equal(now, "2 hours ago", "2024-01-01T06:00:00Z");
+        test_equal(now, "5 minutes", "2024-01-01T08:05:00Z");
+        test_equal(now, "1 week ago", "2023-12-25T08:00:00Z");
+        test_equal(now, "yesterday", "2023-12-31T08:00:00Z");
+        test_equal(now, "tomorrow", "2024-01-02T08:00:00Z");
+    }
+
+    #[test]
+    fn test_date_pattern_parses_relative_dates_with_times() {
+        let now = DateTime::parse_from_rfc3339("2024-01-01T08:00:00-08:00").unwrap();
+        test_equal(now, "yesterday 5pm", "2024-01-01T01:00:00Z");
+        test_equal(now, "yesterday 10am", "2023-12-31T18:00:00Z");
+        test_equal(now, "yesterday 10:30", "2023-12-31T18:30:00Z");
+    }
+}