Refactor windows module in `Local` #992

nekevss · 2023-03-16T01:03:27Z

Not sure if this (a new PR) is the best way to go about this, but I reworked the windows module as discussed in #979 targeting 0.4.x. It removes the panics, removes the Tm and Timespec unix-centric structs to be more windows-focused structs InnerDuration and LocalSysTime.

I did adapt the test that @vvkostenko had put together for his PR as a check, and everything does appears to run fine.

Let me know if this is more in line with the updates.

djc

This looks like a pretty good direction! I think we should make it much more minimal in order to make it easy to understand/review/verify for correctness, though.

djc · 2023-03-16T10:02:51Z

src/offset/local/windows_sys/file_time.rs

@@ -0,0 +1,50 @@
+use std::{io::Error, result::Result};


Is this stuff that you actually extracted from the windows-sys crate?

I think for now I'd prefer keeping all the code together in the windows module, which also simplifies the privacy approaches. It can really be quite minimal.

I see you moved all the code from windows_sys back into a single module, but I actually meant moving everything into windows (just moving the windows_sys stuff to the bottom of the module).

djc · 2023-03-16T10:03:58Z

src/offset/local/windows_sys/system_time.rs

+        Self { inner: st }
+    }
+
+    pub(crate) fn from_naive_datetime(dt: &NaiveDateTime) -> Self {


This should yield a Result with the Error happening if the values are out of range (I'm thinking about the year value in particular).

Do we want to be catching them here or allowing the window's functions to notify us in the windows_sys_call macro?

I'm not completely sure what you mean. I think we should yield Result here -- this function is only called by naive_to_local() which can return a LocalResult::None in case this function fails.

djc · 2023-03-16T10:07:59Z

src/offset/local/windows_sys/file_time.rs

+    inner: FILETIME,
+}
+
+impl WinFileTime {


I don't think we should keep the WinFileTime as a separate type internally. As far as I can tell the only use we have for it is to implement as_unix_seconds()? So IMO it would be good to implement as_unix_seconds() on WinSystemTime directly instead (inlining all the necessary operations for creating a FILETIME etc).

djc

This is definitely getting better! I think there are still some opportunities to simplify...

djc · 2023-03-17T09:05:29Z

src/offset/local/windows_sys/mod.rs

+    }
+
+    /// Return `WinSystemTime`'s inner `SYSTEMTIME` struct.
+    pub(crate) fn inner(&self) -> SYSTEMTIME {


I think we can replace with an impl From<WinSystemTime> for NaiveDateTime, which seems like a nicer API?

djc · 2023-03-17T09:06:59Z

src/offset/local/windows_sys/file_time.rs

@@ -0,0 +1,50 @@
+use std::{io::Error, result::Result};


I see you moved all the code from windows_sys back into a single module, but I actually meant moving everything into windows (just moving the windows_sys stuff to the bottom of the module).

djc · 2023-03-17T09:08:33Z

src/offset/local/windows_sys/system_time.rs

+        Self { inner: st }
+    }
+
+    pub(crate) fn from_naive_datetime(dt: &NaiveDateTime) -> Self {


I'm not completely sure what you mean. I think we should yield Result here -- this function is only called by naive_to_local() which can return a LocalResult::None in case this function fails.

djc · 2023-03-17T09:13:47Z

src/offset/local/windows_sys/mod.rs

+    }
+
+    /// Returns a Window's `FILETIME` struct representing the current `WinSystemTime`.
+    pub(crate) fn as_file_time(&self) -> Result<FILETIME, Error> {


I'd prefer to inline this into as_unix_seconds(), since that is its only user.

djc · 2023-03-17T09:15:02Z

src/offset/local/windows_sys/mod.rs

+    }
+
+    /// Returns a new `WinSystemTime` representing the current `WinSystemTime` converted to utc time.
+    pub(crate) fn as_utc_time(&self) -> Result<WinSystemTime, Error> {


I think this should become a free function, like:

fn local_to_utc(local: &WinSystemTime) -> Result<WinSystemTime, Error> { .. }

djc · 2023-03-17T09:15:52Z

src/offset/local/windows_sys/mod.rs

+    /// Returns a new `WinSystemTime` representing the current `WinSystemTime` converted to the local timezone specific time.
+    pub(crate) fn as_time_zone_specific(&self) -> Result<WinSystemTime, Error> {
+        let mut local = WinSystemTime::new();
+        unsafe {
+            windows_sys_call!(
+                SystemTimeToTzSpecificLocalTime(ptr::null(), &self.inner(), local.mut_inner()),
+                0
+            )
+        };
+        Ok(local)
+    }


I think this should also become a free function:

fn utc_to_local(utc: &WinSystemTime) -> Result<WinSystemTime, Error> { .. }

djc · 2023-03-17T09:17:28Z

src/offset/local/windows_sys/mod.rs

+impl WinSystemTime {
+    /// Creates a new empty `WinSystemTime`.
+    pub(crate) fn new() -> Self {
+        let st = SYSTEMTIME {


I don't like that we're initializing SYSTEMTIME with invalid values here. I think it would be maybe more obvious to use MaybeUninit in the functions that need it.

djc · 2023-03-17T09:21:54Z

src/offset/local/windows_sys/mod.rs

+use winapi::shared::minwindef::*;
+use winapi::um::minwinbase::SYSTEMTIME;
+use winapi::um::timezoneapi::*;


Would like to get rid of the * imports here, can you expand them to what we're actually using?

djc · 2023-03-17T09:23:54Z

src/offset/local/windows.rs

    /// Constructs a timespec representing the current time in UTC.
-    fn now() -> Timespec {
+    fn now_locally() -> LocalSysTime {


It seems like there should be Windows API that would let us get both the current WinSystemTime and the current timezone offset in one system call, instead of doing this stuff?

djc · 2023-03-21T09:05:24Z

This is great, thanks!

This PR contains the following updates: | Package | Type | Update | Change | |---|---|---|---| | [chrono](https://github.com/chronotope/chrono) | dependencies | patch | `0.4.24` -> `0.4.26` | --- ### Release Notes <details> <summary>chronotope/chrono</summary> ### [`v0.4.26`](https://github.com/chronotope/chrono/releases/tag/v0.4.26): 0.4.26 [Compare Source](chronotope/chrono@v0.4.25...v0.4.26) The changes from [#807](chronotope/chrono#807) we merged for 0.4.25 unfortunately restricted parsing in a way that was incompatible with earlier 0.4.x releases. We reverted this in [#1113](chronotope/chrono#1113). A small amount of other changes were merged since. - Update README ([#1111](chronotope/chrono#1111), thanks to [@pitdicker](https://github.com/pitdicker)) - Revert backport of [#807](chronotope/chrono#807) ([#1113](chronotope/chrono#1113), thanks to [@pitdicker](https://github.com/pitdicker)) - Update to 2021 edition ([#1109](chronotope/chrono#1109), thanks to [@tottoto](https://github.com/tottoto)) - Fix `DurationRound` panics from issue [#1010](chronotope/chrono#1010) ([#1093](chronotope/chrono#1093), thanks to [@pitdicker](https://github.com/pitdicker)) - tests: date path consolidate (branch 0.4.x) ([#1090](chronotope/chrono#1090), thanks to [@jtmoon79](https://github.com/jtmoon79)) - Parse tests nanosecond bare dot (branch 0.4.x) ([#1098](chronotope/chrono#1098), thanks to [@jtmoon79](https://github.com/jtmoon79)) - yamllint cleanup lint.yml test.yml ([#1102](chronotope/chrono#1102), thanks to [@jtmoon79](https://github.com/jtmoon79)) - Remove num-iter dependency ([#1107](chronotope/chrono#1107), thanks to [@tottoto](https://github.com/tottoto)) Thanks on behalf of the chrono team ([@djc](https://github.com/djc) and [@esheppa](https://github.com/esheppa)) to all contributors! ### [`v0.4.25`](https://github.com/chronotope/chrono/releases/tag/v0.4.25): 0.4.25 [Compare Source](chronotope/chrono@v0.4.24...v0.4.25) Time for another maintenance release. This release bumps the MSRV to 1.56; given MSRV bumps in chrono's dependencies (notably for syn 2), we felt that it no longer made sense to support any older versions. Feedback welcome in our issue tracker! ##### Additions - Bump the MSRV to 1.56 ([#1053](chronotope/chrono#1053)) - Apply comments from MSRV bump ([#1026](chronotope/chrono#1026), thanks to [@pitdicker](https://github.com/pitdicker)) - Remove num-integer dependency ([#1037](chronotope/chrono#1037), thanks to [@pitdicker](https://github.com/pitdicker)) - Add `NaiveDateTime::and_utc()` method ([#952](chronotope/chrono#952), thanks to [@klnusbaum](https://github.com/klnusbaum)) - derive `Hash` for most pub types that also derive `PartialEq` ([#938](chronotope/chrono#938), thanks to [@bruceg](https://github.com/bruceg)) - Add `parse_and_remainder()` methods ([#1011](chronotope/chrono#1011), thanks to [@pitdicker](https://github.com/pitdicker)) - Add `DateTime::fix_offset()` ([#1030](chronotope/chrono#1030), thanks to [@pitdicker](https://github.com/pitdicker)) - Add `#[track_caller]` to `LocalResult::unwrap` ([#1046](chronotope/chrono#1046), thanks to [@pitdicker](https://github.com/pitdicker)) - Add `#[must_use]` to some methods ([#1007](chronotope/chrono#1007), thanks to [@aceArt-GmbH](https://github.com/aceArt-GmbH)) - Implement `PartialOrd` for `Month` ([#999](chronotope/chrono#999), thanks to [@Munksgaard](https://github.com/Munksgaard)) - Add `impl From<NaiveDateTime> for NaiveDate` ([#1012](chronotope/chrono#1012), thanks to [@pezcore](https://github.com/pezcore)) - Extract timezone info from tzdata file on Android ([#978](chronotope/chrono#978), thanks to [@RumovZ](https://github.com/RumovZ)) ##### Fixes - Prevent string slicing inside char boundaries ([#1024](chronotope/chrono#1024), thanks to [@pitdicker](https://github.com/pitdicker)) - fix IsoWeek so that its flags are always correct ([#991](chronotope/chrono#991), thanks to [@moshevds](https://github.com/moshevds)) - Fix out-of-range panic in `NaiveWeek::last_day` ([#1070](chronotope/chrono#1070), thanks to [@pitdicker](https://github.com/pitdicker)) - Use correct offset in conversion from `Local` to `FixedOffset` ([#1041](chronotope/chrono#1041), thanks to [@pitdicker](https://github.com/pitdicker)) - Fix military timezones in RFC 2822 parsing ([#1013](chronotope/chrono#1013), thanks to [@pitdicker](https://github.com/pitdicker)) - Guard against overflow in NaiveDate::with_\*0 methods ([#1023](chronotope/chrono#1023), thanks to [@pitdicker](https://github.com/pitdicker)) - Fix panic in from_num_days_from_ce_opt ([#1052](chronotope/chrono#1052), thanks to [@pitdicker](https://github.com/pitdicker)) ##### Refactoring - Rely on std for getting local time offset ([#1072](chronotope/chrono#1072), thanks to [@pitdicker](https://github.com/pitdicker)) - Make functions in internals const ([#1043](chronotope/chrono#1043), thanks to [@pitdicker](https://github.com/pitdicker)) - Refactor windows module in `Local` ([#992](chronotope/chrono#992), thanks to [@nekevss](https://github.com/nekevss)) - Simplify from_timestamp_millis, from_timestamp_micros ([#1032](chronotope/chrono#1032), thanks to [@pitdicker](https://github.com/pitdicker)) - Backport [#983](chronotope/chrono#983) and [#1000](chronotope/chrono#1000) ([#1063](chronotope/chrono#1063), thanks to [@pitdicker](https://github.com/pitdicker)) ##### Documentation - Backport documentation improvements ([#1066](chronotope/chrono#1066), thanks to [@pitdicker](https://github.com/pitdicker)) - Add documentation for %Z quirk ([#1051](chronotope/chrono#1051), thanks to [@campbellcole](https://github.com/campbellcole)) - Add an example to Weekday ([#1019](chronotope/chrono#1019), thanks to [@pitdicker](https://github.com/pitdicker)) ##### Internal improvements - Gate test on `clock` feature ([#1061](chronotope/chrono#1061), thanks to [@pitdicker](https://github.com/pitdicker)) - CI: Also run tests with `--no-default-features` ([#1059](chronotope/chrono#1059), thanks to [@pitdicker](https://github.com/pitdicker)) - Prevent `bench_year_flags_from_year` from being optimized out ([#1034](chronotope/chrono#1034), thanks to [@pitdicker](https://github.com/pitdicker)) - Fix test_leap_second during DST transition ([#1064](chronotope/chrono#1064), thanks to [@pitdicker](https://github.com/pitdicker)) - Fix warnings when running tests on Windows ([#1038](chronotope/chrono#1038), thanks to [@pitdicker](https://github.com/pitdicker)) - Fix tests on AIX ([#1028](chronotope/chrono#1028), thanks to [@ecnelises](https://github.com/ecnelises)) - Fix doctest warnings, remove mention of deprecated methods from main doc ([#1081](chronotope/chrono#1081), thanks to [@pitdicker](https://github.com/pitdicker)) - Reformat `test_datetime_parse_from_str` ([#1078](chronotope/chrono#1078), thanks to [@pitdicker](https://github.com/pitdicker)) - GitHub yml shell `set -eux`, use bash ([#1103](chronotope/chrono#1103), thanks to [@jtmoon79](https://github.com/jtmoon79)) - test: explicitly set `LANG` to `c` in gnu `date` ([#1089](chronotope/chrono#1089), thanks to [@scarf005](https://github.com/scarf005)) - Switch test to `TryFrom` ([#1086](chronotope/chrono#1086), thanks to [@pitdicker](https://github.com/pitdicker)) - Add test for issue 551 ([#1020](chronotope/chrono#1020), thanks to [@pitdicker](https://github.com/pitdicker)) - RFC 2822 single-letter obsolete tests ([#1014](chronotope/chrono#1014), thanks to [@jtmoon79](https://github.com/jtmoon79)) - \[CI] Lint Windows target and documentation links ([#1062](chronotope/chrono#1062), thanks to [@pitdicker](https://github.com/pitdicker)) - add test_issue\_866 ([#1077](chronotope/chrono#1077), thanks to [@jtmoon79](https://github.com/jtmoon79)) - Remove AUTHORS metadata ([#1074](chronotope/chrono#1074)) On behalf of [@djc](https://github.com/djc) and [@esheppa](https://github.com/esheppa), thanks to all contributors! </details> --- ### Configuration 📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] If you want to rebase/retry this PR, check this box --- This PR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate).  Co-authored-by: cabr2-bot <cabr2.help@gmail.com> Reviewed-on: https://codeberg.org/Calciumdibromid/CaBr2/pulls/1909 Reviewed-by: crapStone <crapstone@noreply.codeberg.org> Co-authored-by: Calciumdibromid Bot <cabr2_bot@noreply.codeberg.org> Co-committed-by: Calciumdibromid Bot <cabr2_bot@noreply.codeberg.org>

Complete work on initial version of local windows refactor

568d826

djc reviewed Mar 16, 2023

View reviewed changes

Apply review feedback

2c653ee

djc reviewed Mar 17, 2023

View reviewed changes

nekevss added 3 commits March 17, 2023 11:44

Review feedback p2

6591967

Update winapi features

bafefbe

Add safety documentation

2b58247

djc merged commit 1f1e2f8 into chronotope:0.4.x Mar 21, 2023
30 of 31 checks passed

nekevss mentioned this pull request Mar 21, 2023

Several Date tests panic on Windows boa-dev/boa#1570

Closed

djc mentioned this pull request Apr 5, 2023

Fix available range of datetime for Local.from_utc_datetime and Local.from_local_datetime functions #979

Closed

This was referenced Jul 5, 2023

panic in Local.ymd_opt() on old dates for target i686-pc-windows-msvc #371

Closed

Panic in conversion of NaiveDateTime to the local time on Windows #977

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Refactor windows module in `Local` #992

Refactor windows module in `Local` #992

nekevss commented Mar 16, 2023

djc left a comment

djc Mar 16, 2023

djc Mar 17, 2023

djc Mar 16, 2023

nekevss Mar 17, 2023

djc Mar 17, 2023

djc Mar 16, 2023

djc left a comment

djc Mar 17, 2023

djc Mar 17, 2023

djc Mar 17, 2023

djc Mar 17, 2023

djc Mar 17, 2023

djc Mar 17, 2023

djc Mar 17, 2023

djc Mar 17, 2023

djc Mar 17, 2023

djc commented Mar 21, 2023

Refactor windows module in Local #992

Refactor windows module in Local #992

Conversation

nekevss commented Mar 16, 2023

djc left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

djc left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

djc commented Mar 21, 2023

Refactor windows module in `Local` #992

Refactor windows module in `Local` #992