Skip to content

Avoid string.Format allocations by ProfilingViewEngine when profiler is not enabled.#15859

Merged
JasonElkin merged 1 commit intoumbraco:contribfrom
nzdev:v13/bugfix/profiler-allocations
Mar 13, 2024
Merged

Avoid string.Format allocations by ProfilingViewEngine when profiler is not enabled.#15859
JasonElkin merged 1 commit intoumbraco:contribfrom
nzdev:v13/bugfix/profiler-allocations

Conversation

@nzdev
Copy link
Contributor

@nzdev nzdev commented Mar 11, 2024

Prerequisites

  • I have added steps to test this contribution in the description below

If there's an existing issue for this PR then this fixes

Description

Each time ProfilingViewEngine.FindView and ProfilingViewEngine.GetView is called (each time a view is used) the ProfilingViewEngine calls string.Format for a log message as part of profiling. However, if Umbraco is not in debug mode, this is unnecessary as the IProfiler will be a NoOp and will discard the formatted string, however this formatted string is still allocated.

This PR adds a IsEnabled property to IProfiler, so the string.Format allocations can be avoided when the IProfiler is not enabled.

How to test?
Check that IProfiler.Step is not called when IProfiler is not enabled.

@github-actions
Copy link

github-actions bot commented Mar 11, 2024

Hi there @nzdev, thank you for this contribution! 👍

While we wait for one of the Core Collaborators team to have a look at your work, we wanted to let you know about that we have a checklist for some of the things we will consider during review:

  • It's clear what problem this is solving, there's a connected issue or a description of what the changes do and how to test them
  • The automated tests all pass (see "Checks" tab on this PR)
  • The level of security for this contribution is the same or improved
  • The level of performance for this contribution is the same or improved
  • Avoids creating breaking changes; note that behavioral changes might also be perceived as breaking
  • If this is a new feature, Umbraco HQ provided guidance on the implementation beforehand
  • 💡 The contribution looks original and the contributor is presumably allowed to share it

Don't worry if you got something wrong. We like to think of a pull request as the start of a conversation, we're happy to provide guidance on improving your contribution.

If you realize that you might want to make some changes then you can do that by adding new commits to the branch you created for this work and pushing new commits. They should then automatically show up as updates to this pull request.

Thanks, from your friendly Umbraco GitHub bot 🤖 🙂

@georgebid
Copy link
Contributor

Hey @nzdev, thanks a lot for your PR 😄 someone on the Core Collaborators team will review this soon!

@JasonElkin JasonElkin self-assigned this Mar 11, 2024
@JasonElkin JasonElkin added community/pr category/performance Fixes for performance (generally cpu or memory) fixes release/13.3.0 labels Mar 13, 2024
@JasonElkin JasonElkin merged commit ac5539a into umbraco:contrib Mar 13, 2024
@JasonElkin
Copy link
Contributor

Thanks @nzdev!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

category/performance Fixes for performance (generally cpu or memory) fixes community/pr release/13.3.0

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants