GV

GeezerVison

The World Wide Web, restored to 800 pixels of glory.

Home|About|Gaming cabinet|Archives|How it works|Starter sites

On this site

  • Sign in
  • ActionsCI/CD and automation
  • CodespacesCloud development environments
  • All Features
  • Documentation
  • Training
  • Certifications
  • Build with Copilot
  • Customize Copilot
  • Integrations
  • Trending repos
  • GitHub Sponsors
  • Developer articles
  • Enterprises

This view

  • Original page
  • New address

GeezerVison is showing github.com — Lazy initialisation of LinkedList in TokenOperations constructor -> 7% performance gain for formatter by bergmeister · Pull Request #1453 · PowerShell/PSScriptAnalyzer

Conversation

@bergmeister

@bergmeister Christoph Bergmeister (bergmeister) commented Apr 18, 2020 •
edited
Loading

Uh oh!

There was an error while loading. Please reload this page.

Copy link
Copy Markdown
Collaborator

PR Summary

This is a simple optimizaton as many consumers that construct the TokenOperations class do not call APIs that use the LinkedList. This changes the CPU consumption of this class constructor during a format run from 8% to 1%. Of course one could optimize further but I suggest to do the quick wins first with little risk of code regression.
Performance gains are mainly in formatter rules but also in relatively expensive UseSupportsShouldProcess rule.

Also remove unused method. Technically this is a breaking change due to them being publicly exposed but I don't think people use them, the only usage that I can imagine is in custom rules. I did a global GitHub search and it confirmed that no one is probably using those APIs.

This class is quite disgusting overall, littered with TODOs and private/public methods spread across the file. Idea is to keep changes minimal and safe.

PR Checklist

  • PR has a meaningful title
    • Use the present tense and imperative mood when describing your changes
  • Summarized changes
  • Change is not breaking
  • Make sure all .cs, .ps1 and .psm1 files have the correct copyright header
  • Make sure you've added a new test if existing tests do not effectively test the code changed and/or updated documentation
  • This PR is ready to merge and is not Work in Progress.
    • If the PR is work in progress, please add the prefix WIP: to the beginning of the title and remove the prefix when the PR is ready.

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

All reactions
Christoph Bergmeister added 2 commits April 18, 2020 23:47
Christoph Bergmeister
Lazy initialisation of LinkedList in TokenOperations constructor -> 7…
e24d350
…% performance gain

Also remove unused method
Christoph Bergmeister
remove another unused function
2c3eb02
@bergmeister Christoph Bergmeister (bergmeister) added Area - Formatter Area - Performance labels Apr 18, 2020
@bergmeister Christoph Bergmeister (bergmeister) assigned Rob Holt (rjmholt) and James Truher (JamesWTruher) Apr 18, 2020
@bergmeister Christoph Bergmeister (bergmeister) added Area - Rules Breaking Change labels Apr 18, 2020
rjmholt
Rob Holt (rjmholt) approved these changes Apr 20, 2020
View reviewed changes

@rjmholt Rob Holt (rjmholt) left a comment

Copy link
Copy Markdown
Contributor

There was a problem hiding this comment.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Awesome!

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

All reactions
@rjmholt

Rob Holt (rjmholt) commented Apr 20, 2020

Copy link
Copy Markdown
Contributor

Also, is there a good reason to use a linked list here? Surely it should just be a List<>?

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

@bergmeister

Christoph Bergmeister (bergmeister) commented Apr 21, 2020 •
edited
Loading

Uh oh!

There was an error while loading. Please reload this page.

Copy link
Copy Markdown
Collaborator Author

Also, is there a good reason to use a linked list here? Surely it should just be a List<>?

When you look at the callers, they use the .Previous and .Next properties of a LL, which makes the code easier to read I have to say. With this we reduced the overhead from 8% to 1% so although one could optimize more, this was an easy way of achieving much without having to change to much in the spirit of the 80-20 rule. Only once other, bigger perf impacts have been optimized, I'd come back to optimize the LinkedList away completely as well or at least create it only once and then share it.

rjmholt reacted with thumbs up emoji
All reactions
  • 👍 1 reaction

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

@JamesWTruher
James Truher (JamesWTruher) merged commit 022009b into PowerShell:master Apr 21, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

1 more reviewer
@rjmholt Rob Holt (rjmholt) rjmholt approved these changes
Reviewers whose approvals may not affect merge requirements

Uh oh!

There was an error while loading. Please reload this page.

Assignees

@rjmholt Rob Holt (rjmholt)

@JamesWTruher James Truher (JamesWTruher)

Labels

Area - Formatter Area - Performance Area - Rules Breaking Change

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Uh oh!

There was an error while loading. Please reload this page.

3 participants

@bergmeister @rjmholt @JamesWTruher
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
You are visitor 01402503 — GeezerVison does not store the pages you look up.
Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required.