Remove code which delete GUID from Progress, Verbose, Debug and Warning messages by iSazonov · Pull Request #18871 · PowerShell/PowerShell

iSazonov · 2022-12-31T16:38:26Z

PR Summary

Since nobody can find where GUID is added to a message we can remove RemoveGuidFromMessage and RemoveIdentifierInfoFromMessage methods and wait feedback. I guess it is not used for years (maybe it was in psworkflows?).
Notice, the methods are perf expensive since process every message by Regex.

PR Context

PR Checklist

xtqqczze · 2023-01-02T15:01:58Z

As the the pattern is known at compile time, could we use a regular expression source generator?

src/System.Management.Automation/engine/hostifaces/HostUtilities.cs

iSazonov · 2023-01-02T17:04:09Z

As the the pattern is known at compile time, could we use a regular expression source generator?

We could. But first I would like to know where we create this prefix. If it's remoting only, it's probably not worth it.

xtqqczze · 2023-01-02T19:03:21Z

src/System.Management.Automation/engine/hostifaces/HostUtilities.cs

                return message;
+            }

            const string pattern = @"^([\d\w]{8}\-[\d\w]{4}\-[\d\w]{4}\-[\d\w]{4}\-[\d\w]{12}:\[.*\]:).*";


Suggested change

const string pattern = @"^([\d\w]{8}\-[\d\w]{4}\-[\d\w]{4}\-[\d\w]{4}\-[\d\w]{12}:\[.*\]:).*";

const string pattern = @"^[\d\w]{8}\-[\d\w]{4}\-[\d\w]{4}\-[\d\w]{4}\-[\d\w]{12}:\[.*\]:";

Remove the unnecessary capturing group and refactor:

message = message.Substring(matchResult.Length);`

Eh, I don't know that is real format of the messages - perhaps we need the capture group.

It looks like line 548 below uses the capture group. I would suggest replacing [\d\w] with [a-fA-F0-9] as \w is any alphanumeric character.

@SteveL-MSFT I mean line 548 can become message = message.Substring(matchResult.Length);

src/System.Management.Automation/engine/hostifaces/HostUtilities.cs

SteveL-MSFT · 2023-01-07T02:16:34Z

I'm trying to find out why this was originally needed and if it's still needed at all. I was able to find a related methods called GetIdentifierInfo() that extracts the information and it has out parameters for jobInstanceId (the guid), and computerName. So it appears to be related to jobs and remoting. However, I haven't found in the source where it's actually being set.

iSazonov · 2023-01-07T05:26:21Z

I see only AddSourceTagToError and CreateInformationalMessage.
Perhaps @PaulHigin can help.

SteveL-MSFT · 2023-01-09T16:40:15Z

@PaulHigin confirmed that this is used by remoting/jobs to de-multiplex multi-sessions so that alleviates my concern if this is dead code.

SteveL-MSFT · 2023-01-09T20:41:45Z

src/System.Management.Automation/engine/hostifaces/HostUtilities.cs

@@ -499,21 +499,27 @@ internal static List<string> GetSuggestion(HistoryInfo lastHistory, object lastE
        /// Remove the GUID from the message if the message is in the pre-defined format.


Can we update this comment to include:

Suggested change

/// Remove the GUID from the message if the message is in the pre-defined format.

/// Remove the GUID from the message (added by remoting/jobs for concurrent operations to be de-multiplexed) if the message is in the pre-defined format.

SteveL-MSFT · 2023-01-09T20:45:11Z

src/System.Management.Automation/engine/hostifaces/HostUtilities.cs

                return message;
+            }

            const string pattern = @"^([\d\w]{8}\-[\d\w]{4}\-[\d\w]{4}\-[\d\w]{4}\-[\d\w]{12}:).*";


Since you're already updating this, perhaps we should change this regex a bit. Replace [\d\w] (which would accept any alphanumeric character making \d redundant anyways) to [a-fA-F0-9] to accept any hex digit.

@PaulHigin Could you please point the code (for error and progress bar too) where we add the GUID? Can there be some GUIDs and should we use capture group?

SteveL-MSFT · 2023-01-09T20:46:44Z

src/System.Management.Automation/engine/hostifaces/HostUtilities.cs

                return message;
+            }

            const string pattern = @"^([\d\w]{8}\-[\d\w]{4}\-[\d\w]{4}\-[\d\w]{4}\-[\d\w]{12}:\[.*\]:).*";


It looks like line 548 below uses the capture group. I would suggest replacing [\d\w] with [a-fA-F0-9] as \w is any alphanumeric character.

ghost · 2023-01-17T14:01:03Z

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

PaulHigin

LGTM

To be honest I don't remember if/where Guids are added to remote information messages, or if they even are anymore. I seem to remember that in some cases they were added but, again, I cannot remember or find those cases in the code base. The RemoteData object contains all session routing information so I don't know why/when an information message would need a guid.

iSazonov · 2023-02-17T04:14:48Z

I cannot find too. I guess it is not used for years. I suggest to delete the code (RemoveIdentifierInfoFromMessage and RemoveGuidFromMessage) and wait feedbacks while we are at preview time.

ghost · 2023-02-24T14:01: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

daxian-dbw

LGTM

xtqqczze · 2023-02-24T20:43:01Z

Since you're already updating this, perhaps we should change this regex a bit. Replace [\d\w] (which would accept any alphanumeric character making \d redundant anyways) to [a-fA-F0-9] to accept any hex digit.

I suggest making these changes for clarity reasons.

iSazonov · 2023-02-25T14:43:10Z

I cannot find too. I guess it is not used for years. I suggest to delete the code (RemoveIdentifierInfoFromMessage and RemoveGuidFromMessage) and wait feedbacks while we are at preview time.

@daxian-dbw What do you think about the proposal?

daxian-dbw · 2023-02-27T20:31:18Z

I cannot find too. I guess it is not used for years. I suggest to delete the code (RemoveIdentifierInfoFromMessage and RemoveGuidFromMessage) and wait feedbacks while we are at preview time.

@daxian-dbw What do you think about the proposal?

That sounds good to me :)

pull-request-quantifier-deprecated · 2023-02-28T05:57:51Z

This PR has 29 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       : +0 -29
Percentile : 11.6%

Total files changed: 2

Change summary by file extension:
.cs : +0 -29

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.

xtqqczze · 2023-02-28T23:52:04Z

@iSazonov Please update issue title before merge.

daxian-dbw

LGTM. As @xtqqczze reminded, please update the PR title and description before merging. Thanks!
Oh, please refer to Paul's comment #18871 (review) in the PR description for context information.

iSazonov · 2023-03-01T04:35:57Z

Done.

daxian-dbw · 2023-03-01T18:25:54Z

@SteveL-MSFT Please take another look when you get a chance. Thanks!

ghost · 2023-03-09T02:01:01Z

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 · 2023-03-09T03:11:32Z

@SteveL-MSFT Friendly ping.

ghost · 2023-03-14T22:26:55Z

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

Handy links:

Release Notes

Fast return if progress message does not start with GUID

8a17a2b

iSazonov added the CL-Performance Indicates that a PR should be marked as a performance improvement in the Change Log label Dec 31, 2022

iSazonov requested review from SteveL-MSFT and daxian-dbw December 31, 2022 16:38

iSazonov self-assigned this Dec 31, 2022

pull-request-quantifier-deprecated bot added the Extra Small label Dec 31, 2022

iSazonov marked this pull request as ready for review December 31, 2022 16:39

Fix indexes

6987334

xtqqczze reviewed Jan 2, 2023

View reviewed changes

src/System.Management.Automation/engine/hostifaces/HostUtilities.cs Outdated Show resolved Hide resolved

xtqqczze reviewed Jan 2, 2023

View reviewed changes

Fast return if other messages don't start with GUID

c957eb5

iSazonov changed the title ~~Fast return if progress message does not start with GUID~~ Fast return if progress and other messages don't start with GUID Jan 5, 2023

SteveL-MSFT reviewed Jan 6, 2023

View reviewed changes

src/System.Management.Automation/engine/hostifaces/HostUtilities.cs Outdated Show resolved Hide resolved

iSazonov added 2 commits January 7, 2023 10:28

Remove unused out parameter

5b5ec55

Remove unused out parameter 2

9b442c0

iSazonov requested a review from anmenaga as a code owner January 7, 2023 06:35

SteveL-MSFT requested changes Jan 9, 2023

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 Waiting on Author The PR was reviewed and requires changes or comments from the author before being accept labels Jan 9, 2023

ghost added the Review - Needed The PR is being reviewed label Jan 17, 2023

PaulHigin approved these changes Feb 16, 2023

View reviewed changes

ghost removed the Review - Needed The PR is being reviewed label Feb 17, 2023

ghost added the Review - Needed The PR is being reviewed label Feb 24, 2023

daxian-dbw approved these changes Feb 24, 2023

View reviewed changes

ghost removed the Review - Needed The PR is being reviewed label Feb 25, 2023

Remove RemoveGuidFromMessage and RemoveIdentifierInfoFromMessage

b9bcacd

iSazonov requested review from PaulHigin, SteveL-MSFT and daxian-dbw February 28, 2023 06:04

daxian-dbw approved these changes Mar 1, 2023

View reviewed changes

daxian-dbw added CL-CodeCleanup Indicates that a PR should be marked as a Code Cleanup change in the Change Log and removed CL-Performance Indicates that a PR should be marked as a performance improvement in the Change Log labels Mar 1, 2023

iSazonov changed the title ~~Fast return if progress and other messages don't start with GUID~~ Remove code which delete GUID from Progress, Verbose, Debug and Warning messages Mar 1, 2023

ghost added the Review - Needed The PR is being reviewed label Mar 9, 2023

ghost removed the Review - Needed The PR is being reviewed label Mar 9, 2023

SteveL-MSFT approved these changes Mar 13, 2023

View reviewed changes

daxian-dbw merged commit 9dd9322 into PowerShell:master Mar 13, 2023

iSazonov deleted the perf-progress-regex branch March 14, 2023 03:51

	const string pattern = @"^([\d\w]{8}\-[\d\w]{4}\-[\d\w]{4}\-[\d\w]{4}\-[\d\w]{12}:\[.\]:).";
	const string pattern = @"^[\d\w]{8}\-[\d\w]{4}\-[\d\w]{4}\-[\d\w]{4}\-[\d\w]{12}:\[.*\]:";

		@@ -499,21 +499,27 @@ internal static List<string> GetSuggestion(HistoryInfo lastHistory, object lastE
		/// Remove the GUID from the message if the message is in the pre-defined format.

	/// Remove the GUID from the message if the message is in the pre-defined format.
	/// Remove the GUID from the message (added by remoting/jobs for concurrent operations to be de-multiplexed) if the message is in the pre-defined format.

Conversation

iSazonov commented Dec 31, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

PR Summary

PR Context

PR Checklist

Uh oh!

xtqqczze commented Jan 2, 2023

Uh oh!

Uh oh!

iSazonov commented Jan 2, 2023

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!

SteveL-MSFT commented Jan 7, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

iSazonov commented Jan 7, 2023

Uh oh!

SteveL-MSFT commented Jan 9, 2023

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!

ghost commented Jan 17, 2023

Uh oh!

PaulHigin left a comment

Choose a reason for hiding this comment

Uh oh!

iSazonov commented Feb 17, 2023

Uh oh!

ghost commented Feb 24, 2023

Uh oh!

daxian-dbw left a comment

Choose a reason for hiding this comment

Uh oh!

xtqqczze commented Feb 24, 2023

Uh oh!

iSazonov commented Feb 25, 2023

Uh oh!

daxian-dbw commented Feb 27, 2023

Uh oh!

pull-request-quantifier-deprecated bot commented Feb 28, 2023

What can I do to optimize my changes

How to interpret the change counts in git diff output

Uh oh!

xtqqczze commented Feb 28, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

daxian-dbw left a comment • 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!

iSazonov commented Mar 1, 2023

Uh oh!

daxian-dbw commented Mar 1, 2023

Uh oh!

ghost commented Mar 9, 2023

Uh oh!

iSazonov commented Mar 9, 2023

Uh oh!

ghost commented Mar 14, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

iSazonov commented Dec 31, 2022 •

edited

Loading

SteveL-MSFT commented Jan 7, 2023 •

edited

Loading

xtqqczze commented Feb 28, 2023 •

edited

Loading

daxian-dbw left a comment •

edited

Loading