Add `-UnixTimeSeconds` to `Get-Date` to allow Unix time input by aetos382 · Pull Request #13084 · PowerShell/PowerShell

aetos382 · 2020-07-02T14:08:27Z

PR Summary

Add the -UnixTimeSeconds parameter to the Get-Date command.
This allows the time in seconds elapsed since 1970-01-01T00:00:00Z (aka Unix Time).

PR #12179 has already been submitted, but my proposal is more like the specification proposed in #11719.
This proposal also supports negative values (meaning time before the Unix epoch), therefore improving compatibility with the DateTimeOffset class and the Linux date utility.

The following is an example of its use.

> Get-Date -UnixTimeSeconds 1593696159

Thursday, July 2, 2020 1:22:39 PM

> Get-Date -UnixTimeSeconds -1

Wednesday, December 31, 1969 11:59:59 PM

The parameter has -UnixTime alias, because 'Unix Time' generally means a value expressed in seconds.
Also, consider the possibility of adding a parameter in the future that takes values expressed in milliseconds.

The parameter is named UnixTimeSeconds, not FromUnixTime.
This is for consistency with the Date parameter (it's not FromDate).

PR Context

Close #12976

Compatibility Notes

This proposal is basically compatible with PowerShell 7.0.2, but not compatible with 7.1.0-preview.4, including #12179.

It also includes a parameter set name changes. It's classified as Non-Public surface in the guideline.

PR Checklist

src/Microsoft.PowerShell.Commands.Utility/commands/utility/GetDateCommand.cs

iSazonov · 2020-07-02T17:35:10Z

@jackdcasey @mklement0 Please review.

src/Microsoft.PowerShell.Commands.Utility/commands/utility/GetDateCommand.cs

daxian-dbw · 2020-07-13T16:52:32Z

@TravisEz13 and @iSazonov, since both of you reviewed and approved #12179, can you please also review this PR?

iSazonov · 2020-07-15T07:50:19Z

src/Microsoft.PowerShell.Commands.Utility/commands/utility/GetDateCommand.cs

Our common pattern is to use consts without extra static class.

iSazonov · 2020-07-15T07:54:51Z

test/powershell/Modules/Microsoft.PowerShell.Utility/Get-Date.Tests.ps1

It is preferred to use TestCases.

ghost · 2020-07-23T14:00:20Z

This pull request has been automatically marked as Review Needed because it has been there has not been any activity for 7 days.
Maintainer, please provide feedback and/or mark it as Waiting on Author

iSazonov · 2020-07-23T14:55:47Z

@aetos382 Please address my comments.

src/Microsoft.PowerShell.Commands.Utility/commands/utility/GetDateCommand.cs

iSazonov · 2020-07-27T07:26:23Z

src/Microsoft.PowerShell.Commands.Utility/commands/utility/GetDateCommand.cs

It is parameter set names. So I'd add this in the consts:

Suggested change

private const string DateAndFormat = "DateAndFormat";

private const string DateAndFormatParameterSet = "DateAndFormat";

I think that if the parameter set name constants have the suffix ParameterSet, it would be better to make them members of the static inner class, as before.

It is our common pattern. If you see a const with the suffix in code you understand that it is a parameter set name.

daxian-dbw · 2020-07-30T18:05:38Z

@iSazonov Thanks for the review!
@TravisEz13 can you please also take a look?

ghost · 2020-08-07T02:00:29Z

This pull request has been automatically marked as Review Needed because it has been there has not been any activity for 7 days.
Maintainer, please provide feedback and/or mark it as Waiting on Author

daxian-dbw · 2020-08-11T20:37:42Z

@aetos382 and @iSazonov, I notice the PR has a breaking change comparing to the existing 7.1 preview versions -- FromUnixTime is removed. Is that breaking change intentional? (just want to confirm).

Other than that, @aetos382 can you please resolve the conflict? Then it should be ready for merging.

Since it was difficult to implement exclusivity between Date and UnixTimeSeconds, and Format and UFormat using parameter set, I checked Format and UFormat at runtime.

If UFormat is specified, DateTime is never returned.

To pass CodeFactor's static check, the value of the summary element now begins with an alphabetic character.

By changing the validation attribute of the UFormat parameter from ValidateNotNullOrEmpty to Mandatory

This test is not necessary because ParameterSet is used to ensure that Format and UFormat are not used together, and is not determined by an if statement.

…DateCommand.cs Co-authored-by: Ilya <[email protected]>

aetos382 · 2020-08-12T02:18:53Z

@daxian-dbw

Is that breaking change intentional? (just want to confirm).

Yes. I am aware from the beginning that this PR is not compatible with the 7.1.0 preview.

iSazonov · 2020-08-12T03:29:20Z

@daxian-dbw Yes, new approach looks more good and it better to replace previous commit before RC and release.
I think we have no need use "Breaking-Change" label because it is used only for real breaking changes with released versions. Otherwise docs and release notes will confuse users.

daxian-dbw · 2020-08-12T17:15:42Z

Thank you both for the clarification.
I will leave the "breaking change" label on for now and marked this PR to be reviewed by maintainers, so we can conclude on how to deal with breaking changes that happen within the preview releases.

iSazonov · 2020-08-12T17:28:13Z

@aetos382 Thanks for your contribution!

aetos382 · 2020-08-12T17:30:23Z

@iSazonov @daxian-dbw @mklement0 @SteveL-MSFT @TravisEz13 Thank you all!

… the FromUnixTime parameter (#6264) * Add UnixTimeSeconds parameter and Remove FromUnixTime parameter PowerShell/PowerShell#13084 * docs: change date * docs: Use full parameter name * docs: change 'added' to 'introduced' For consistency with other documents * Fix parameter set names Changed to reflect the merged PowerShell code. * Update Get-Date.md Reads better Co-authored-by: Chase Wilson <[email protected]> Co-authored-by: Sean Wheeler <[email protected]>

ghost · 2020-08-17T22:21:52Z

🎉v7.1.0-preview.6 has been released which incorporates this pull request.:tada:

Handy links:

Release Notes

scotthardwick · 2020-08-18T13:47:26Z

@aetos382 Thank you so much for your work on this! I wrote #11719 and am glad to see this come to completion. It will be very useful. Also look forward to your work on Timezones in #13312
Finally, if you get a chance, please feel free to look at my issue #11714 and make any suggestions too. It is also tied up with Unix Date/Times.

ghost assigned daxian-dbw Jul 2, 2020

iSazonov reviewed Jul 2, 2020

View reviewed changes

src/Microsoft.PowerShell.Commands.Utility/commands/utility/GetDateCommand.cs Outdated Show resolved Hide resolved

src/Microsoft.PowerShell.Commands.Utility/commands/utility/GetDateCommand.cs Outdated Show resolved Hide resolved

iSazonov requested review from SteveL-MSFT and TravisEz13 July 2, 2020 17:34

mklement0 reviewed Jul 2, 2020

View reviewed changes

src/Microsoft.PowerShell.Commands.Utility/commands/utility/GetDateCommand.cs Outdated Show resolved Hide resolved

iSazonov added the CL-General Indicates that a PR should be marked as a general cmdlet change in the Change Log label Jul 3, 2020

This was referenced Jul 13, 2020

Add -UnixTimeSeconds parameter to Get-Date MicrosoftDocs/PowerShell-Docs#6263

Closed

Add the UnixTimeSeconds parameter to the Get-Date command and removes the FromUnixTime parameter MicrosoftDocs/PowerShell-Docs#6264

Merged

iSazonov reviewed Jul 15, 2020

View reviewed changes

mklement0 mentioned this pull request Jul 16, 2020

Add -AsLocal switch to Get-Date #11731

Closed

ghost added the Review - Needed The PR is being reviewed label Jul 23, 2020

iSazonov added the Waiting on Author The PR was reviewed and requires changes or comments from the author before being accept label Jul 23, 2020

ghost removed Review - Needed The PR is being reviewed Waiting on Author The PR was reviewed and requires changes or comments from the author before being accept labels Jul 23, 2020

iSazonov reviewed Jul 27, 2020

View reviewed changes

iSazonov approved these changes Jul 27, 2020

View reviewed changes

ghost added the Review - Needed The PR is being reviewed label Aug 7, 2020

ghost removed the Review - Needed The PR is being reviewed label Aug 11, 2020

daxian-dbw added the CL-BreakingChange Indicates that a PR should be marked as a breaking change in the Change Log label Aug 11, 2020

aetos382 added 3 commits August 12, 2020 11:04

add ParameterSetNames

12b0122

use ParameterSetNames

4ca4c93

change FromUnixTime to UnixTimeSeconds

f64e772

aetos382 and others added 16 commits August 12, 2020 11:04

validate range of UnixTimeSeconds

4e12728

add property body of Format and UFormat

2835675

make Format and UFormat are exclusive.

fdcf497

Since it was difficult to implement exclusivity between Date and UnixTimeSeconds, and Format and UFormat using parameter set, I checked Format and UFormat at runtime.

use indicator fields

5016914

add tests

c215713

Using a ParameterSet to control parameter exclusivity

cab658e

Remove unnecessary code

ba4ecea

Set ParameterSetName for OutputType.

9a23d6f

If UFormat is specified, DateTime is never returned.

Fix documentation comment

3930798

To pass CodeFactor's static check, the value of the summary element now begins with an alphabetic character.

Fix test

fefc7e8

By changing the validation attribute of the UFormat parameter from ValidateNotNullOrEmpty to Mandatory

Remove test

e239b72

This test is not necessary because ParameterSet is used to ensure that Format and UFormat are not used together, and is not determined by an if statement.

Use testcase

781bef5

Declare ParameterSetNames directly.

a37c645

Update src/Microsoft.PowerShell.Commands.Utility/commands/utility/Get…

4b1a2fc

…DateCommand.cs Co-authored-by: Ilya <[email protected]>

Update src/Microsoft.PowerShell.Commands.Utility/commands/utility/Get…

08e0af7

…DateCommand.cs Co-authored-by: Ilya <[email protected]>

add 'ParameterSet' suffix to parameter set names

f1dfd52

daxian-dbw merged commit ede1085 into PowerShell:master Aug 12, 2020

daxian-dbw added the Review - Maintainer The PR/issue needs a review from the PowerShell repo Maintainers label Aug 12, 2020

aetos382 deleted the add-unixtime-to-get-date branch August 12, 2020 17:30

ghost mentioned this pull request Aug 17, 2020

Get-Date -FromUnixTime should support negative values. #12976

Closed

rjmholt removed the Review - Maintainer The PR/issue needs a review from the PowerShell repo Maintainers label Feb 2, 2021

iSazonov added this to the 7.2.0-preview.3 milestone Feb 6, 2021

	private const string DateAndFormat = "DateAndFormat";
	private const string DateAndFormatParameterSet = "DateAndFormat";

Conversation

aetos382 commented Jul 2, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

PR Summary

PR Context

Compatibility Notes

PR Checklist

Uh oh!

Uh oh!

Uh oh!

iSazonov commented Jul 2, 2020

Uh oh!

Uh oh!

daxian-dbw commented Jul 13, 2020

Uh oh!

iSazonov Jul 15, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

aetos382 Jul 24, 2020

Choose a reason for hiding this comment

Uh oh!

iSazonov Jul 15, 2020

Choose a reason for hiding this comment

Uh oh!

aetos382 Jul 24, 2020

Choose a reason for hiding this comment

Uh oh!

ghost commented Jul 23, 2020

Uh oh!

iSazonov commented Jul 23, 2020

Uh oh!

Uh oh!

Uh oh!

iSazonov Jul 27, 2020

Choose a reason for hiding this comment

Uh oh!

aetos382 Jul 27, 2020

Choose a reason for hiding this comment

Uh oh!

iSazonov Jul 27, 2020

Choose a reason for hiding this comment

Uh oh!

daxian-dbw commented Jul 30, 2020

Uh oh!

ghost commented Aug 7, 2020

Uh oh!

daxian-dbw commented Aug 11, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

aetos382 commented Aug 12, 2020

Uh oh!

iSazonov commented Aug 12, 2020

Uh oh!

daxian-dbw commented Aug 12, 2020

Uh oh!

iSazonov commented Aug 12, 2020

Uh oh!

aetos382 commented Aug 12, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

ghost commented Aug 17, 2020

Uh oh!

scotthardwick commented Aug 18, 2020

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

aetos382 commented Jul 2, 2020 •

edited

Loading

iSazonov Jul 15, 2020 •

edited

Loading

daxian-dbw commented Aug 11, 2020 •

edited

Loading

aetos382 commented Aug 12, 2020 •

edited

Loading