Get-Content -Head and -Tail disallow negative values and cleanup #19715

CarloToso · 2023-05-26T12:19:08Z

PR Summary

Disallow negative values for -Head and -Tail
Add fast return if -Tail == 0
Cleanup code

TODO:

~~Add tests~~

PR Context

#19710 @jhoneill @mklement0

PR Checklist

ghost · 2023-06-02T14:00:52Z

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

TravisEz13

Are there tests for the modified scenarios?

Update:
https://github.com/PowerShell/PowerShell/blob/master/test/powershell/Modules/Microsoft.PowerShell.Management/Get-Content.Tests.ps1

Add tests for:

tail = 0
verify error when tail is negative
verify error when totalcount is negative.

CarloToso · 2023-06-09T23:51:19Z

@TravisEz13 Added tests

pull-request-quantifier-deprecated · 2023-06-10T00:11:38Z

This PR has 100 quantified lines of changes. In general, a change size of upto 200 lines is ideal for the best PR experience!

Quantification details

Label      : Small
Size       : +40 -60
Percentile : 40%

Total files changed: 2

Change summary by file extension:
.cs : +36 -60
.ps1 : +4 -0

Change counts above are quantified counts, based on the PullRequestQuantifier customizations.

Why proper sizing of changes matters

Optimal pull request sizes drive a better predictable PR flow as they strike a
balance between between PR complexity and PR review overhead. PRs within the
optimal size (typical small, or medium sized PRs) mean:

Fast and predictable releases to production:
- Optimal size changes are more likely to be reviewed faster with fewer
  iterations.
- Similarity in low PR complexity drives similar review times.
Review quality is likely higher as complexity is lower:
- Bugs are more likely to be detected.
- Code inconsistencies are more likely to be detected.
Knowledge sharing is improved within the participants:
- Small portions can be assimilated better.
Better engineering practices are exercised:
- Solving big problems by dividing them in well contained, smaller problems.
- Exercising separation of concerns within the code changes.

What can I do to optimize my changes

Use the PullRequestQuantifier to quantify your PR accurately
- Create a context profile for your repo using the context generator
- Exclude files that are not necessary to be reviewed or do not increase the review complexity. Example: Autogenerated code, docs, project IDE setting files, binaries, etc. Check out the Excluded section from your prquantifier.yaml context profile.
- Understand your typical change complexity, drive towards the desired complexity by adjusting the label mapping in your prquantifier.yaml context profile.
- Only use the labels that matter to you, see context specification to customize your prquantifier.yaml context profile.
Change your engineering behaviors
- For PRs that fall outside of the desired spectrum, review the details and check if:
  - Your PR could be split in smaller, self-contained PRs instead
  - Your PR only solves one particular issue. (For example, don't refactor and code new features in the same PR).

How to interpret the change counts in git diff output

One line was added: +1 -0
One line was deleted: +0 -1
One line was modified: +1 -1 (git diff doesn't know about modified, it will
interpret that line like one addition plus one deletion)
Change percentiles: Change characteristics (addition, deletion, modification)
of this PR in relation to all other PRs within the repository.

Was this comment helpful? 👍 :ok_hand: :thumbsdown: (Email)
Customize PullRequestQuantifier for this repository.

jhoneill · 2023-06-10T14:14:24Z

To me this looks like a valid solution , I have added the wg-cmdlets tag because I think the WG should be saying "There are other ways this could be addressed, we like (or don't like) this one."

ghost · 2023-06-18T02:00:52Z

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

It looks good to me overall. However, this is a breaking change, as today a user can specify negative value like Get-Content -Tail -50 or Get-Content -TotalCount -100, and they just mean get all content.
It seems to be a bucket 3 breaking change, but I'd like the Cmdlet WG to make a conclusion.

SteveL-MSFT · 2023-06-19T20:00:46Z

Added to WG agenda

SteveL-MSFT · 2023-06-21T16:31:30Z

@PowerShell/wg-powershell-cmdlets reviewed this, we agreed that although a breaking change, we think it is a bucket 3 unlikely to impact users change. The main concern is that -1 is documented as default and implied to be supported. Docs would need to be changed to remove mention of this internal detail and users are likely to not specify the parameter rather than explicitly -1 to get all content so we don't expect users to be using -1 directly.

SteveL-MSFT · 2023-06-21T16:35:15Z

@JamesWTruher has some individual PR comments he'll add

daxian-dbw · 2023-06-21T16:36:58Z

@SteveL-MSFT @JamesWTruher I didn't see the new comment above until after I merged the PR ...
Please still leave your comment. If it's something you think that needs code changes, please open an issue to track it.

daxian-dbw · 2023-06-21T16:44:34Z

Doc issue MicrosoftDocs/PowerShell-Docs#10183 was opened to track removing mention of the default value.

JamesWTruher · 2023-06-21T15:51:44Z

src/Microsoft.PowerShell.Commands.Management/commands/management/GetContentCommand.cs

@@ -116,15 +79,15 @@ protected override void ProcessRecord()
        {
            // TotalCount and Tail should not be specified at the same time.
            // Throw out terminating error if this is the case.


this comment seems wrong - it doesn't look like a terminating error

JamesWTruher · 2023-06-21T16:00:28Z

src/Microsoft.PowerShell.Commands.Management/commands/management/GetContentCommand.cs

-        }
-
-        private bool _totalCountSpecified = false;
+        public long TotalCount { get; set; } = -1;


hmmm, I wonder if this should be just be long? TotalCount

ghost · 2023-06-29T22:06:58Z

🎉v7.4.0-preview.4 has been released which incorporates this pull request.:tada:

Handy links:

Release Notes

CarloToso added 13 commits May 23, 2023 18:59

TotalCount {get; set;}

ad5957e

Tail { get; set; }

fdf3335

Add comment Tail

055da9f

add {} while, for

fe59996

remove remainder

19ba389

Add {} if

4ba3554

remove space

f74f1e8

var, Logs

4d2459b

fast return

777d526

remove unnecessary if

c60a839

fix comment

c4d1b51

capitalize comment

c5729b1

edit comment

174ad16

CarloToso requested review from daxian-dbw and adityapatwardhan as code owners May 26, 2023 12:19

pull-request-quantifier-deprecated bot added the Small label May 26, 2023

ghost assigned TravisEz13 May 26, 2023

ghost added the Review - Needed The PR is being reviewed label Jun 2, 2023

StevenBucher98 added the PowerShell-Docs not needed The PR was reviewed and doesn't appear to require a PowerShell Docs update label Jun 5, 2023

TravisEz13 reviewed Jun 5, 2023

View reviewed changes

daxian-dbw added Waiting on Author The PR was reviewed and requires changes or comments from the author before being accept and removed Review - Needed The PR is being reviewed labels Jun 6, 2023

Add Tests

434dfe8

pull-request-quantifier-deprecated bot removed the Small label Jun 9, 2023

ghost removed the Waiting on Author The PR was reviewed and requires changes or comments from the author before being accept label Jun 9, 2023

pull-request-quantifier-deprecated bot added the Medium label Jun 9, 2023

Add {}

727d53a

pull-request-quantifier-deprecated bot removed the Medium label Jun 10, 2023

pull-request-quantifier-deprecated bot added the Small label Jun 10, 2023

jhoneill added the WG-Cmdlets general cmdlet issues label Jun 10, 2023

ghost added the Review - Needed The PR is being reviewed label Jun 18, 2023

daxian-dbw approved these changes Jun 19, 2023

View reviewed changes

daxian-dbw added Needs-Triage The issue is new and needs to be triaged by a work group. CL-General Indicates that a PR should be marked as a general cmdlet change in the Change Log and removed Review - Needed The PR is being reviewed labels Jun 19, 2023

SteveL-MSFT added PowerShell-Docs needed The PR was reviewed and a PowerShell Docs update is needed and removed PowerShell-Docs not needed The PR was reviewed and doesn't appear to require a PowerShell Docs update labels Jun 21, 2023

SteveL-MSFT removed the Needs-Triage The issue is new and needs to be triaged by a work group. label Jun 21, 2023

daxian-dbw merged commit cb2848c into PowerShell:master Jun 21, 2023
40 checks passed

daxian-dbw mentioned this pull request Jun 21, 2023

Do not mention the default value -1 for the -TotalCount parameter of Get-Content MicrosoftDocs/PowerShell-Docs#10183

Closed

3 tasks

JamesWTruher reviewed Jun 22, 2023

View reviewed changes

CarloToso deleted the cleanup-GetContent branch July 25, 2023 10:34

6e6e58c4 mentioned this pull request Nov 20, 2023

PS 7.4.0: "-Tail 0" ignores "-Wait" and immediately stops Get-Content #20731

Closed

5 tasks

CarloToso mentioned this pull request Nov 21, 2023

Fix regression -Tail 0 -Wait #20734

Merged

22 tasks

MartinGC94 mentioned this pull request Mar 15, 2024

Negative values provided to the Get-Content -Tail parameter no longer return the entire content, and instead print an error #21347

Closed

5 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Get-Content -Head and -Tail disallow negative values and cleanup #19715

Get-Content -Head and -Tail disallow negative values and cleanup #19715

CarloToso commented May 26, 2023 •

edited

Loading

ghost commented Jun 2, 2023

TravisEz13 left a comment •

edited

Loading

CarloToso commented Jun 9, 2023

pull-request-quantifier-deprecated bot commented Jun 10, 2023

What can I do to optimize my changes

How to interpret the change counts in git diff output

jhoneill commented Jun 10, 2023

ghost commented Jun 18, 2023

daxian-dbw left a comment

SteveL-MSFT commented Jun 19, 2023

SteveL-MSFT commented Jun 21, 2023

SteveL-MSFT commented Jun 21, 2023

daxian-dbw commented Jun 21, 2023

daxian-dbw commented Jun 21, 2023

JamesWTruher Jun 21, 2023

JamesWTruher Jun 21, 2023

ghost commented Jun 29, 2023

Get-Content -Head and -Tail disallow negative values and cleanup #19715

Get-Content -Head and -Tail disallow negative values and cleanup #19715

Conversation

CarloToso commented May 26, 2023 • edited Loading

PR Summary

PR Context

PR Checklist

ghost commented Jun 2, 2023

TravisEz13 left a comment • edited Loading

Choose a reason for hiding this comment

CarloToso commented Jun 9, 2023

pull-request-quantifier-deprecated bot commented Jun 10, 2023

What can I do to optimize my changes

How to interpret the change counts in git diff output

jhoneill commented Jun 10, 2023

ghost commented Jun 18, 2023

daxian-dbw left a comment

Choose a reason for hiding this comment

SteveL-MSFT commented Jun 19, 2023

SteveL-MSFT commented Jun 21, 2023

SteveL-MSFT commented Jun 21, 2023

daxian-dbw commented Jun 21, 2023

daxian-dbw commented Jun 21, 2023

JamesWTruher Jun 21, 2023

Choose a reason for hiding this comment

JamesWTruher Jun 21, 2023

Choose a reason for hiding this comment

ghost commented Jun 29, 2023

CarloToso commented May 26, 2023 •

edited

Loading

TravisEz13 left a comment •

edited

Loading