Fix non append encoding to UTF8 No BOM in Start Transcript #13899

Gimly · 2020-10-26T21:56:19Z

PR Summary

When the -Append file has not been set by the user, the file is emptied using WriteAllText.

This method seems to keep the encoding of the file if it existed prior, which as discussed in #13677 shouldn't be the case. Instead, it should simply use the default encoding which should be UTF8 Without BOM.

The fix is to call the override with the encoding set in the part of the code that clears the file content.

PR Context

Fixes #13677

PR Checklist

When the -Append file has not been set by the user, the file is emptied using WriteAllText. This method seems to keep the encoding of the file if it existed prior. We don't want this behavior and want to be sure that the UTF8NoBom is used. It calls the override with the encoding set.

iSazonov · 2020-10-27T06:11:06Z

@Gimly I am ok with the change but I want ask - have you an interest to make more cleanups in follow PR? We could remove TranscriptionOption.Encoding and Utils.GetEncoding(), instead we could use standard StreamReader() to detect encoding in TranscriptionOption.FlushContentToDisk().

iSazonov · 2020-10-27T06:12:39Z

Formally it is a breaking change (bracket 3) so I ask PowerShell Committee to review.

/cc @SteveL-MSFT @daxian-dbw

Gimly · 2020-10-27T06:49:02Z

@iSazonov Sure, I will take a go at it.

SteveL-MSFT · 2020-10-28T22:10:03Z

@PowerShell/powershell-committee reviewed this, we are ok with the change. There should be a test added to this PR however.

iSazonov · 2020-10-29T04:34:55Z

@Gimly Please add tests. I guess it will be 3 tests (without Append, with Append and file in UTF16 exists, with Append and file doesn't exist)

iSazonov · 2020-10-30T06:06:36Z

test/powershell/Modules/Microsoft.Powershell.Host/Start-Transcript.Tests.ps1

+        Get-Date | Out-Null
+        Stop-Transcript
+
+        GetFileEncoding $transcriptFilePath | Should -Be 'utf-16'


Please use BeExactly for strings here and below:

Suggested change

GetFileEncoding $transcriptFilePath | Should -Be 'utf-16'

GetFileEncoding $transcriptFilePath | Should -BeExactly 'utf-16'

Gimly · 2020-11-03T09:22:59Z

@iSazonov I'm not sure why the CI has failed, it looks like powershellget has failed. Maybe you need to restart the builds?

iSazonov · 2020-11-03T10:21:17Z

Reopen to restart CIs.

ghost · 2020-11-10T14:00:06Z

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

test/powershell/Modules/Microsoft.Powershell.Host/Start-Transcript.Tests.ps1

SteveL-MSFT · 2020-12-15T21:08:41Z

test/powershell/Modules/Microsoft.Powershell.Host/Start-Transcript.Tests.ps1

        Receive-Job $job | Should -Be $null
    }
+    It "Should keep the existing file's encoding if the 'Append' parameter is used"{
+        $transcriptFilePath = Join-Path $TestDrive ([System.IO.Path]::GetRandomFileName())


better to put this in BeforeAll{} since it's reused?

I've used the $transcriptFilePath that already existed in the BeforeAll instead of creating a new one

@Gimly Please look CI fails.

SteveL-MSFT

A few minor suggestions

Co-authored-by: Steve Lee <slee@microsoft.com>

ghost · 2020-12-25T14:00:11Z

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

ghost · 2021-09-23T02:00:38Z

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

SteveL-MSFT

Sorry for the delay on this

iSazonov · 2022-05-16T17:46:07Z

/rebase

github-actions · 2022-05-16T17:46:43Z

Started rebase: https://github.com/PowerShell/PowerShell/actions/runs/2333666772

GitHub
Fix non append encoding to UTF8 No BOM in Start Transcript · PowerShell/PowerShell@cc3b6fb
PowerShell for every system! Contribute to PowerShell/PowerShell development by creating an account on GitHub.

pull-request-quantifier-deprecated · 2022-05-18T03:55:18Z

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

Quantification details

Label      : Extra Small
Size       : +26 -1
Percentile : 10.8%

Total files changed: 2

Change summary by file extension:
.cs : +1 -1
.ps1 : +25 -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 detetcted.
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.

iSazonov · 2022-05-18T13:01:49Z

@Gimly Please look test failures.

ghost · 2022-05-25T14:01:00Z

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

ghost · 2022-11-13T14:01:05Z

This pull request has been automatically marked as stale because it has been marked as requiring author feedback but has not had any activity for 15 days. It will be closed if no further activity occurs within 10 days of this comment.

Gimly requested review from anmenaga and daxian-dbw as code owners October 26, 2020 21:56

ghost assigned iSazonov Oct 26, 2020

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

iSazonov approved these changes Oct 27, 2020

View reviewed changes

iSazonov added CL-BreakingChange Indicates that a PR should be marked as a breaking change in the Change Log Review - Committee The PR/Issue needs a review from the PowerShell Committee labels Oct 27, 2020

Gimly mentioned this pull request Oct 27, 2020

Simplify getting Encoding in TranscriptionOption.FlushContentToDisk #13910

Merged

14 tasks

SteveL-MSFT added Committee-Reviewed PS-Committee has reviewed this and made a decision and removed Review - Committee The PR/Issue needs a review from the PowerShell Committee labels Oct 28, 2020

Add unit test to check encoding of start-transcript files

4758b70

iSazonov reviewed Oct 30, 2020

View reviewed changes

iSazonov requested a review from JamesWTruher October 30, 2020 06:09

Use BeExactly to compare strings

39b2203

iSazonov closed this Nov 3, 2020

iSazonov reopened this Nov 3, 2020

ghost added the Review - Needed The PR is being reviewed label Nov 10, 2020

SteveL-MSFT added the Backport-7.2.x-Consider label Dec 15, 2020

SteveL-MSFT reviewed Dec 15, 2020

View reviewed changes

test/powershell/Modules/Microsoft.Powershell.Host/Start-Transcript.Tests.ps1 Outdated Show resolved Hide resolved

SteveL-MSFT reviewed Dec 15, 2020

View reviewed changes

test/powershell/Modules/Microsoft.Powershell.Host/Start-Transcript.Tests.ps1 Outdated Show resolved Hide resolved

SteveL-MSFT reviewed Dec 15, 2020

View reviewed changes

SteveL-MSFT requested changes Dec 15, 2020

View reviewed changes

ghost 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 Dec 15, 2020

Change the syntax used to create the UTF8Encoding in unit tests

c1e8e82

Co-authored-by: Steve Lee <slee@microsoft.com>

ghost removed the Waiting on Author The PR was reviewed and requires changes or comments from the author before being accept label Dec 15, 2020

Remove the creation of the random test file path

353acdb

ghost added the Review - Needed The PR is being reviewed label Dec 25, 2020

adityapatwardhan removed the Backport-7.2.x-Consider label Sep 15, 2021

ghost removed the Review - Needed The PR is being reviewed label Sep 15, 2021

ghost added the Review - Needed The PR is being reviewed label Sep 23, 2021

SteveL-MSFT approved these changes May 16, 2022

View reviewed changes

ghost removed the Review - Needed The PR is being reviewed label May 16, 2022

iSazonov closed this May 18, 2022

iSazonov reopened this May 18, 2022

pull-request-quantifier-deprecated bot added the Extra Small label May 18, 2022

ghost added the Review - Needed The PR is being reviewed label May 25, 2022

iSazonov added the Waiting on Author The PR was reviewed and requires changes or comments from the author before being accept label Oct 29, 2022

ghost added the Stale label Nov 13, 2022

ghost closed this Nov 23, 2022

This pull request was closed.

	GetFileEncoding $transcriptFilePath \| Should -Be 'utf-16'
	GetFileEncoding $transcriptFilePath \| Should -BeExactly 'utf-16'

Fix non append encoding to UTF8 No BOM in Start Transcript #13899

Fix non append encoding to UTF8 No BOM in Start Transcript #13899

Uh oh!

Conversation

Gimly commented Oct 26, 2020

PR Summary

PR Context

PR Checklist

Uh oh!

iSazonov commented Oct 27, 2020

Uh oh!

iSazonov commented Oct 27, 2020

Uh oh!

Gimly commented Oct 27, 2020

Uh oh!

SteveL-MSFT commented Oct 28, 2020

Uh oh!

iSazonov commented Oct 29, 2020

Uh oh!

iSazonov Oct 30, 2020

Choose a reason for hiding this comment

Uh oh!

Gimly Oct 30, 2020

Choose a reason for hiding this comment

Uh oh!

Gimly commented Nov 3, 2020

Uh oh!

iSazonov commented Nov 3, 2020

Uh oh!

ghost commented Nov 10, 2020

Uh oh!

Uh oh!

Uh oh!

SteveL-MSFT Dec 15, 2020

Choose a reason for hiding this comment

Uh oh!

Gimly Dec 17, 2020

Choose a reason for hiding this comment

Uh oh!

iSazonov Dec 18, 2020

Choose a reason for hiding this comment

Uh oh!

SteveL-MSFT left a comment

Choose a reason for hiding this comment

Uh oh!

ghost commented Dec 25, 2020

Uh oh!

ghost commented Sep 23, 2021

Uh oh!

SteveL-MSFT left a comment

Choose a reason for hiding this comment

Uh oh!

iSazonov commented May 16, 2022

Uh oh!

github-actions bot commented May 16, 2022 • edited by unfurl-links bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

pull-request-quantifier-deprecated bot commented May 18, 2022

What can I do to optimize my changes

How to interpret the change counts in git diff output

Uh oh!

iSazonov commented May 18, 2022

Uh oh!

ghost commented May 25, 2022

Uh oh!

ghost commented Nov 13, 2022

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

github-actions bot commented May 16, 2022 •

edited by unfurl-links bot

Loading