Add a nonce option and Render testing #465
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,108 @@ | ||
| using System; | ||
| using System.Collections.Generic; | ||
| using StackExchange.Profiling.Internal; | ||
| using Xunit; | ||
| using Xunit.Abstractions; | ||
|
|
||
| namespace StackExchange.Profiling.Tests | ||
| { | ||
| public class RenderTests : BaseTest | ||
| { | ||
| public RenderTests(ITestOutputHelper output) : base(output) { } | ||
|
|
||
| [Fact] | ||
| public void DefaultRender() | ||
| { | ||
| var profiler = GetBasicProfiler(); | ||
| var renderOptions = new RenderOptions(); | ||
| var result = Render.Includes(profiler, "/", true, renderOptions, new List<Guid>() { profiler.Id }); | ||
| Output.WriteLine("Result: " + result); | ||
|
|
||
| Assert.NotNull(result); | ||
| Assert.Contains("id=\"mini-profiler\"", result); | ||
|
|
||
| var expected = $@"<script async id=""mini-profiler"" src=""/includes.min.js?v={Options.VersionHash}"" data-version=""{Options.VersionHash}"" data-path=""/"" data-current-id=""{profiler.Id}"" data-ids=""{profiler.Id}"" data-position=""Left"""" data-scheme=""Light"" data-authorized=""true"" data-max-traces=""15"" data-toggle-shortcut=""Alt+P"" data-trivial-milliseconds=""2.0"" data-ignored-duplicate-execute-types=""Open,OpenAsync,Close,CloseAsync""></script>"; | ||
| Assert.Equal(expected, result); | ||
| } | ||
|
|
||
| [Fact] | ||
| public void OptionsSet() | ||
| { | ||
| var profiler = GetBasicProfiler(); | ||
| var renderOptions = new RenderOptions() | ||
| { | ||
| ColorScheme = ColorScheme.Auto, | ||
| MaxTracesToShow = 12, | ||
| Nonce = "myNonce", | ||
| PopupToggleKeyboardShortcut = "Alt+Q", | ||
| Position = RenderPosition.Right, | ||
| ShowControls = true, | ||
| ShowTimeWithChildren = true, | ||
| ShowTrivial = true, | ||
| StartHidden = true, | ||
| TrivialDurationThresholdMilliseconds = 23 | ||
| }; | ||
| var result = Render.Includes(profiler, "/", true, renderOptions, new List<Guid>() { profiler.Id }); | ||
| Output.WriteLine("Result: " + result); | ||
|
|
||
| Assert.NotNull(result); | ||
| Assert.Contains("id=\"mini-profiler\"", result); | ||
|
|
||
| var expected = $@"<script async id=""mini-profiler"" src=""/includes.min.js?v={Options.VersionHash}"" data-version=""{Options.VersionHash}"" data-path=""/"" data-current-id=""{profiler.Id}"" data-ids=""{profiler.Id}"" data-position=""Right"""" data-scheme=""Auto"" data-authorized=""true"" data-trivial=""true"" data-children=""true"" data-controls=""true"" data-start-hidden=""true"" nonce=""myNonce"" data-max-traces=""12"" data-toggle-shortcut=""Alt+Q"" data-trivial-milliseconds=""23"" data-ignored-duplicate-execute-types=""Open,OpenAsync,Close,CloseAsync""></script>"; | ||
| Assert.Equal(expected, result); | ||
| } | ||
|
|
||
| [Theory] | ||
| [InlineData(null, @"data-scheme=""Light""")] | ||
| [InlineData(ColorScheme.Auto, @"data-scheme=""Auto""")] | ||
| [InlineData(ColorScheme.Dark, @"data-scheme=""Dark""")] | ||
| [InlineData(ColorScheme.Light, @"data-scheme=""Light""")] | ||
| public void ColorSchemes(ColorScheme? scheme, string expected) | ||
| { | ||
| var profiler = GetBasicProfiler(); | ||
| var renderOptions = new RenderOptions() { ColorScheme = scheme }; | ||
|
|
||
| var result = Render.Includes(profiler, " / ", true, renderOptions); | ||
| Output.WriteLine("Result: " + result); | ||
|
|
||
| Assert.NotNull(result); | ||
| Assert.Contains(expected, result); | ||
| } | ||
|
|
||
| [Theory] | ||
| [InlineData(null, @"data-position=""Left""")] | ||
| [InlineData(RenderPosition.BottomLeft, @"data-position=""BottomLeft""")] | ||
| [InlineData(RenderPosition.BottomRight, @"data-position=""BottomRight""")] | ||
| [InlineData(RenderPosition.Left, @"data-position=""Left""")] | ||
| [InlineData(RenderPosition.Right, @"data-position=""Right""")] | ||
| public void Positions(RenderPosition? position, string expected) | ||
| { | ||
| var profiler = GetBasicProfiler(); | ||
| var renderOptions = new RenderOptions() { Position = position }; | ||
|
|
||
| var result = Render.Includes(profiler, " / ", true, renderOptions); | ||
| Output.WriteLine("Result: " + result); | ||
|
|
||
| Assert.NotNull(result); | ||
| Assert.Contains(expected, result); | ||
| } | ||
|
|
||
| [Fact] | ||
| public void Nonce() | ||
| { | ||
| var profiler = GetBasicProfiler(); | ||
| var renderOptions = new RenderOptions(); | ||
|
|
||
| // Default | ||
| var result = Render.Includes(profiler, "/", true, renderOptions); | ||
| Output.WriteLine("Result: " + result); | ||
| Assert.DoesNotContain("nonce", result); | ||
|
|
||
| // With nonce | ||
| var nonce = Guid.NewGuid().ToString(); | ||
| renderOptions.Nonce = nonce; | ||
| result = Render.Includes(profiler, "/", true, renderOptions); | ||
| Assert.Contains($@"nonce=""{nonce}""", result); | ||
| } | ||
| } | ||
| } |
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.
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.
Given that nonce is supposed to be random on every page load, I'm not sure it makes sense to have it as an attribute on
mini-profiler? Would the intention instead be to use something like@NonceSource.GetNonce()?As far as documentation / samples go, what is the story for "I want to inform miniprofiler about a nonce that comes from some piece of middleware?" The middleware shoves it in the context somewhere and it gets pulled in here?
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.
Correct - you'd pass in a unique value. Even putting say a
<Func<HttpContext, string>is complicated due to the different primitives with .NET vs. .NET Core...maybe when we can drop .NET Full Framework support one day that gets easier since there's no common ancestor need.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.
Oh sorry misread the second part - there's no built-in middleware story I can think of that makes sense here. The problem is generally you want MiniProfiler to profile the things you're doing and we have an order inversion problems with dependencies about the middleware doing it. Either direction we choose would be wrong for some subset of users. At least in v1, I'd want to leave it up to the users to handle their nonce generation.