[WIP] Use interpolated strings #18974

CarloToso · 2023-01-19T01:07:39Z

PR Summary

Use interpolated strings with String.Format(), StringBuilder.AppendFormat(), String.Create()

PR Context

PR Checklist

iSazonov · 2023-01-19T04:06:26Z

src/System.Management.Automation/engine/runtime/Operations/MiscOps.cs

+            return string.Format(CultureInfo.InvariantCulture, $"{0}> {File}",
+                                 FromStream == RedirectionStream.All ? "*" : ((int)FromStream).ToString(CultureInfo.InvariantCulture));


The code can be insterted in {0}.
(In C# 11 even multilines are supported https://learn.microsoft.com/en-us/dotnet/csharp/whats-new/csharp-11#newlines-in-string-interpolations but we should switch from C# 10 to 11 in our msbuild files.)

iSazonov · 2023-01-19T04:11:07Z

src/System.Management.Automation/utils/tracing/PSEtwLog.cs

            {
                string payLoadData = BitConverter.ToString(fragmentData.blob, fragmentData.offset, fragmentData.length);
-                payLoadData = string.Format(CultureInfo.InvariantCulture, "0x{0}", payLoadData.Replace("-", string.Empty));
+                payLoadData = string.Format(CultureInfo.InvariantCulture, $"0x{payLoadData.Replace("-", string.Empty)}");


Perhaps follow works (or will in .Net 8, or C# 11)

$"0x{payLoadData.AsSpan().Replace("-", string.Empty)}");

iSazonov · 2023-01-19T10:22:25Z

src/Microsoft.Management.Infrastructure.CimCmdlets/CimSessionOperations.cs

            CimTestCimSessionContext testCimSessionContext = context as CimTestCimSessionContext;
            uint sessionId = this.sessionState.GenerateSessionId();
            string originalSessionName = testCimSessionContext.CimSessionWrapper.Name;
-            string sessionName = originalSessionName ?? string.Format(CultureInfo.CurrentUICulture, @"{0}{1}", CimSessionState.CimSessionClassName, sessionId);


Really we should replace all string.Format with string.Create

Follow up PR?

No, current changes haven't value. Idea is to use new API to reduce allocations. There is no string.Format with interpalated string handler. I guess I misled you. Please use string.Create.
(You can find all new APIs with interpolated handlers starting with https://source.dot.net/#System.Private.CoreLib/src/libraries/System.Private.CoreLib/src/System/Runtime/CompilerServices/InterpolatedStringHandlerAttribute.cs,382762ca0bf5bcac,references)

Also please don't change our trace.WriteLine() and other such callsites - this requires changes in the APIs themselves, which is not always easy. See example #18246.

src/Microsoft.PowerShell.Commands.Diagnostics/ImportCounterCommand.cs

iSazonov · 2023-01-19T10:55:16Z

src/Microsoft.PowerShell.ConsoleHost/host/msh/ConsoleControl.cs

                            // at a time => bufferSize.Y == 1. Then, we can safely leave bufferSize.Y unchanged
                            // to retry with a smaller bufferSize.X.
-                            Dbg.Assert(bufferSize.Y == 1, string.Format(CultureInfo.InvariantCulture, "bufferSize.Y should be 1, but is {0}", bufferSize.Y));
+                            Dbg.Assert(bufferSize.Y == 1, string.Format(CultureInfo.InvariantCulture, $"bufferSize.Y should be 1, but is {bufferSize.Y}"));


Dbg.Assert is our API. In follow PR we could modernize it to support interpolated string handler and then remove string.Format from such callsites.

The same for StringUtil.Format API.

…mand.cs Co-authored-by: Ilya <darpa@yandex.ru>

iSazonov · 2023-01-19T12:10:45Z

src/Microsoft.Management.Infrastructure.CimCmdlets/CimSessionOperations.cs

            uint sessionId = this.sessionState.GenerateSessionId();
            string originalSessionName = testCimSessionContext.CimSessionWrapper.Name;
-            string sessionName = originalSessionName ?? string.Format(CultureInfo.CurrentUICulture, @"{0}{1}", CimSessionState.CimSessionClassName, sessionId);
+            string sessionName = originalSessionName ?? string.Create(CultureInfo.CurrentUICulture, $@"{CimSessionState.CimSessionClassName}{sessionId}");


We can remove verbatim string literal @. Below I see the same too.

iSazonov · 2023-01-19T12:11:27Z

src/Microsoft.Management.Infrastructure.CimCmdlets/CimSessionProxy.cs

                    }

-                    parameters.Append(string.Format(CultureInfo.CurrentUICulture, @"'{0}' = {1}", key, parameterList[key]));
+                    parameters.Append(string.Format(CultureInfo.CurrentUICulture, $@"'{key}' = {parameterList[key]}"));


We can use StringBuilder.AppendFormat

src/Microsoft.Management.Infrastructure.CimCmdlets/Utils.cs

src/Microsoft.Management.UI.Internal/HelpWindow/HelpParagraphBuilder.cs

iSazonov · 2023-01-19T12:14:31Z

src/Microsoft.Management.UI.Internal/ManagementList/FilterCore/ValidatingValueBase.cs

                if (result == null)
                {
-                    throw new InvalidOperationException(string.Format(CultureInfo.CurrentCulture, "DataErrorInfoValidationResult not returned by ValidationRule: {0}", rule.ToString()));
+                    throw new InvalidOperationException(string.Format(CultureInfo.CurrentCulture, $"DataErrorInfoValidationResult not returned by ValidationRule: {rule.ToString()}"));


The same. And we can remove ToString().

iSazonov · 2023-01-19T12:15:26Z

src/Microsoft.Management.UI.Internal/ManagementList/FilterProviders/SearchTextParser.cs

            }

-            patterns.Add(string.Format(CultureInfo.InvariantCulture, "(?<{0}>){1}", FullTextRuleGroupName, ValuePattern));
+            patterns.Add(string.Format(CultureInfo.InvariantCulture, $"(?<{FullTextRuleGroupName}>){ValuePattern}"));


The same. I stop review. Please replace all Format with Create.

I'm still working on it, its [WIP]. I'll change it to draft

iSazonov · 2023-01-19T16:13:06Z

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

            {
-                result.AppendFormat(null, "-Culture '{0}' ", CodeGeneration.EscapeSingleQuotedStringContent(runspaceConnectionInfo.Culture.ToString()));
-                result.AppendFormat(null, "-UICulture '{0}' ", CodeGeneration.EscapeSingleQuotedStringContent(runspaceConnectionInfo.UICulture.ToString()));
+                result.AppendFormat(null, $"-Culture '{CodeGeneration.EscapeSingleQuotedStringContent(runspaceConnectionInfo.Culture.ToString())}' ");


ToString() can be removed in interpolated strings.

iSazonov · 2023-01-19T16:23:36Z

@CarloToso The PR is too large. I suggest to split it by 5-10-15 files.

pull-request-quantifier-deprecated · 2023-01-19T16:31:11Z

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

Quantification details

Label      : Extra Large
Size       : +262 -330
Percentile : 86.4%

Total files changed: 103

Change summary by file extension:
.cs : +262 -330

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.

CarloToso · 2023-01-19T16:33:03Z

@iSazonov You are right this PR is too big, I'll leave it open until until I've finished splitting it, then I'll close it

CarloToso · 2023-01-19T18:43:25Z

PR split in 7 parts

CarloToso added 6 commits January 19, 2023 00:43

45 files

78bef76

14 Files

6c02093

10 FIles

09c4665

80 search results left

e205c4f

67 left

cea1464

49 left

f69f74b

CarloToso requested review from PaulHigin, SteveL-MSFT, TravisEz13, adityapatwardhan, anmenaga and daxian-dbw as code owners January 19, 2023 01:07

ghost assigned TravisEz13 Jan 19, 2023

pull-request-quantifier-deprecated bot added the Large label Jan 19, 2023

CarloToso added 3 commits January 19, 2023 02:10

fix error

ed984ab

fix errors

dcf8085

36 left

af6470f

CarloToso changed the title ~~Use interpolated strings~~ [WIP] Use interpolated strings Jan 19, 2023

fix error

3cf0ffc

iSazonov reviewed Jan 19, 2023

View reviewed changes

fix error

a709f7e

iSazonov reviewed Jan 19, 2023

View reviewed changes

13 left

19b37bf

iSazonov reviewed Jan 19, 2023

View reviewed changes

src/Microsoft.PowerShell.Commands.Diagnostics/ImportCounterCommand.cs Outdated Show resolved Hide resolved

iSazonov reviewed Jan 19, 2023

View reviewed changes

CarloToso and others added 3 commits January 19, 2023 11:56

Update src/Microsoft.PowerShell.Commands.Diagnostics/ImportCounterCom…

86c860d

…mand.cs Co-authored-by: Ilya <darpa@yandex.ru>

start replace string.Format with string.Create

5277d11

fix error

957dd4c

iSazonov reviewed Jan 19, 2023

View reviewed changes

pull-request-quantifier-deprecated bot added the Extra Large label Jan 19, 2023

CarloToso added 4 commits January 19, 2023 15:49

revert

8a509de

5 files left

29e6d90

Add suggestions

13e7898

StringBuilder.AppendFormat

37fe135

iSazonov reviewed Jan 19, 2023

View reviewed changes

1 file

4a7b460

CarloToso marked this pull request as ready for review January 19, 2023 16:16

remove tostring()

38a3af4

last files

eb6879a

CarloToso closed this Jan 19, 2023

This was referenced Jan 19, 2023

Use interpolated strings 8 #18988

Merged

Use interpolated strings 5b #18996

Merged

Use interpolated strings 5c #18997

Merged

CarloToso deleted the Use-interpolated-strings-2 branch January 21, 2023 13:48

This was referenced Jan 21, 2023

Use interpolated strings 11 #19002

Merged

Use interpolated strings 12 #19003

Merged

daxian-dbw mentioned this pull request Jan 24, 2023

Revert some of the interpolated string changes #19018

Merged

13 tasks

trackd mentioned this pull request Oct 28, 2023

Group-Object displays dates using a MM/dd/yyyy format regardless of the set culture (PowerShell 7.4 Preview) #20584

Closed

5 tasks

		return string.Format(CultureInfo.InvariantCulture, $"{0}> {File}",
		FromStream == RedirectionStream.All ? "*" : ((int)FromStream).ToString(CultureInfo.InvariantCulture));

[WIP] Use interpolated strings #18974

[WIP] Use interpolated strings #18974

Uh oh!

Conversation

CarloToso commented Jan 19, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

PR Summary

PR Context

PR Checklist

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

iSazonov Jan 19, 2023 • 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!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

iSazonov Jan 19, 2023 • 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!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

iSazonov commented Jan 19, 2023

Uh oh!

pull-request-quantifier-deprecated bot commented Jan 19, 2023

What can I do to optimize my changes

How to interpret the change counts in git diff output

Uh oh!

CarloToso commented Jan 19, 2023

Uh oh!

CarloToso commented Jan 19, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

CarloToso commented Jan 19, 2023 •

edited

Loading

iSazonov Jan 19, 2023 •

edited

Loading

iSazonov Jan 19, 2023 •

edited

Loading