tk/Ocelot
1
0
Fork 0
mirror of https://github.com/nsnail/Ocelot.git synced 2025-04-20 17:42:50 +08:00
Code Issues Packages Projects Releases Wiki Activity

Checkin for caching the template matching for significant route finder performance improvements (#728)

Browse Source
This commit is contained in:
Phil Proctor 2018-12-26 15:05:20 -05:00 committed by Marcelo Castagna
parent ac211886f1
commit 9bbb6364f2
7 changed files with 124 additions and 114 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
src/Ocelot/DownstreamRouteFinder/Finder/DownstreamRouteFinder.cs
View File

@ -28,7 +28,7 @@ namespace Ocelot.DownstreamRouteFinder.Finder
foreach (var reRoute in applicableReRoutes) foreach (var reRoute in applicableReRoutes)
{ {
var urlMatch = _urlMatcher.Match(upstreamUrlPath, upstreamQueryString, reRoute.UpstreamTemplatePattern.Template, reRoute.UpstreamTemplatePattern.ContainsQueryString); var urlMatch = _urlMatcher.Match(upstreamUrlPath, upstreamQueryString, reRoute.UpstreamTemplatePattern);
if (urlMatch.Data.Match) if (urlMatch.Data.Match)
{ {

17
src/Ocelot/DownstreamRouteFinder/UrlMatcher/IUrlPathToUrlTemplateMatcher.cs
View File

@ -1,9 +1,10 @@
using Ocelot.Responses; using Ocelot.Responses;
using Ocelot.Values;
namespace Ocelot.DownstreamRouteFinder.UrlMatcher
{ namespace Ocelot.DownstreamRouteFinder.UrlMatcher
public interface IUrlPathToUrlTemplateMatcher {
{ public interface IUrlPathToUrlTemplateMatcher
Response<UrlMatch> Match(string upstreamUrlPath, string upstreamQueryString, string upstreamUrlPathTemplate, bool containsQueryString); {
} Response<UrlMatch> Match(string upstreamUrlPath, string upstreamQueryString, UpstreamPathTemplate pathTemplate);
}
} }

47
src/Ocelot/DownstreamRouteFinder/UrlMatcher/RegExUrlMatcher.cs
View File

@ -1,24 +1,23 @@
using System.Text.RegularExpressions; using System.Text.RegularExpressions;
using Ocelot.Responses; using Ocelot.Responses;
using Ocelot.Values;
namespace Ocelot.DownstreamRouteFinder.UrlMatcher
{ namespace Ocelot.DownstreamRouteFinder.UrlMatcher
public class RegExUrlMatcher : IUrlPathToUrlTemplateMatcher {
{ public class RegExUrlMatcher : IUrlPathToUrlTemplateMatcher
public Response<UrlMatch> Match(string upstreamUrlPath, string upstreamQueryString, string upstreamUrlPathTemplate, bool containsQueryString) {
{ public Response<UrlMatch> Match(string upstreamUrlPath, string upstreamQueryString, UpstreamPathTemplate pathTemplate)
var regex = new Regex(upstreamUrlPathTemplate); {
if (!pathTemplate.ContainsQueryString)
if (!containsQueryString) {
{ return pathTemplate.Pattern.IsMatch(upstreamUrlPath)
return regex.IsMatch(upstreamUrlPath) ? new OkResponse<UrlMatch>(new UrlMatch(true))
? new OkResponse<UrlMatch>(new UrlMatch(true)) : new OkResponse<UrlMatch>(new UrlMatch(false));
: new OkResponse<UrlMatch>(new UrlMatch(false)); }
}
return pathTemplate.Pattern.IsMatch($"{upstreamUrlPath}{upstreamQueryString}")
return regex.IsMatch($"{upstreamUrlPath}{upstreamQueryString}") ? new OkResponse<UrlMatch>(new UrlMatch(true))
? new OkResponse<UrlMatch>(new UrlMatch(true)) : new OkResponse<UrlMatch>(new UrlMatch(false));
: new OkResponse<UrlMatch>(new UrlMatch(false)); }
} }
} }
}

49
src/Ocelot/Values/UpstreamPathTemplate.cs
View File

@ -1,21 +1,28 @@
namespace Ocelot.Values using System.Text.RegularExpressions;
{
public class UpstreamPathTemplate namespace Ocelot.Values
{ {
public UpstreamPathTemplate(string template, int priority, bool containsQueryString, string originalValue) public class UpstreamPathTemplate
{ {
Template = template; public UpstreamPathTemplate(string template, int priority, bool containsQueryString, string originalValue)
Priority = priority; {
ContainsQueryString = containsQueryString; Template = template;
OriginalValue = originalValue; Priority = priority;
} ContainsQueryString = containsQueryString;
OriginalValue = originalValue;
public string Template { get; } Pattern = template == null ?
new Regex("$^", RegexOptions.Compiled | RegexOptions.Singleline) :
public int Priority { get; } new Regex(template, RegexOptions.Compiled | RegexOptions.Singleline);
}
public bool ContainsQueryString { get; }
public string Template { get; }
public string OriginalValue { get; }
} public int Priority { get; }
}
public bool ContainsQueryString { get; }
public string OriginalValue { get; }
public Regex Pattern { get; }
}
}

103
test/Ocelot.Benchmarks/UrlPathToUrlPathTemplateMatcherBenchmarks.cs
View File

@ -1,51 +1,52 @@
using System; using System;
using BenchmarkDotNet.Attributes; using BenchmarkDotNet.Attributes;
using BenchmarkDotNet.Columns; using BenchmarkDotNet.Columns;
using BenchmarkDotNet.Configs; using BenchmarkDotNet.Configs;
using BenchmarkDotNet.Diagnosers; using BenchmarkDotNet.Diagnosers;
using BenchmarkDotNet.Validators; using BenchmarkDotNet.Validators;
using Ocelot.DownstreamRouteFinder.UrlMatcher; using Ocelot.DownstreamRouteFinder.UrlMatcher;
using Ocelot.Values;
namespace Ocelot.Benchmarks
{ namespace Ocelot.Benchmarks
[Config(typeof(UrlPathToUrlPathTemplateMatcherBenchmarks))] {
public class UrlPathToUrlPathTemplateMatcherBenchmarks : ManualConfig [Config(typeof(UrlPathToUrlPathTemplateMatcherBenchmarks))]
{ public class UrlPathToUrlPathTemplateMatcherBenchmarks : ManualConfig
private RegExUrlMatcher _urlPathMatcher; {
private string _downstreamUrlPath; private RegExUrlMatcher _urlPathMatcher;
private string _downstreamUrlPathTemplate; private UpstreamPathTemplate _pathTemplate;
private string _upstreamQuery; private string _downstreamUrlPath;
private string _upstreamQuery;
public UrlPathToUrlPathTemplateMatcherBenchmarks()
{ public UrlPathToUrlPathTemplateMatcherBenchmarks()
Add(StatisticColumn.AllStatistics); {
Add(MemoryDiagnoser.Default); Add(StatisticColumn.AllStatistics);
Add(BaselineValidator.FailOnError); Add(MemoryDiagnoser.Default);
} Add(BaselineValidator.FailOnError);
}
[GlobalSetup]
public void SetUp() [GlobalSetup]
{ public void SetUp()
_urlPathMatcher = new RegExUrlMatcher(); {
_downstreamUrlPath = "api/product/products/1/variants/?soldout=false"; _urlPathMatcher = new RegExUrlMatcher();
_downstreamUrlPathTemplate = "api/product/products/{productId}/variants/"; _pathTemplate = new UpstreamPathTemplate("api/product/products/{productId}/variants/", 0, false, null);
} _downstreamUrlPath = "api/product/products/1/variants/?soldout=false";
}
[Benchmark(Baseline = true)]
public void Baseline() [Benchmark(Baseline = true)]
{ public void Baseline()
_urlPathMatcher.Match(_downstreamUrlPath, _upstreamQuery, _downstreamUrlPathTemplate, false); {
} _urlPathMatcher.Match(_downstreamUrlPath, _upstreamQuery, _pathTemplate);
}
// * Summary *
// * Summary *
// BenchmarkDotNet=v0.10.13, OS=macOS 10.12.6 (16G1212) [Darwin 16.7.0]
// Intel Core i5-4278U CPU 2.60GHz (Haswell), 1 CPU, 4 logical cores and 2 physical cores // BenchmarkDotNet=v0.10.13, OS=macOS 10.12.6 (16G1212) [Darwin 16.7.0]
// .NET Core SDK=2.1.4 // Intel Core i5-4278U CPU 2.60GHz (Haswell), 1 CPU, 4 logical cores and 2 physical cores
// [Host] : .NET Core 2.0.6 (CoreCLR 4.6.0.0, CoreFX 4.6.26212.01), 64bit RyuJIT // .NET Core SDK=2.1.4
// DefaultJob : .NET Core 2.0.6 (CoreCLR 4.6.0.0, CoreFX 4.6.26212.01), 64bit RyuJIT // [Host] : .NET Core 2.0.6 (CoreCLR 4.6.0.0, CoreFX 4.6.26212.01), 64bit RyuJIT
// Method | Mean | Error | StdDev | StdErr | Min | Q1 | Median | Q3 | Max | Op/s | // DefaultJob : .NET Core 2.0.6 (CoreCLR 4.6.0.0, CoreFX 4.6.26212.01), 64bit RyuJIT
// ----------- |---------:|----------:|----------:|----------:|---------:|---------:|---------:|---------:|---------:|----------:| // Method | Mean | Error | StdDev | StdErr | Min | Q1 | Median | Q3 | Max | Op/s |
// Benchmark1 | 3.133 us | 0.0492 us | 0.0460 us | 0.0119 us | 3.082 us | 3.100 us | 3.122 us | 3.168 us | 3.233 us | 319,161.9 | // ----------- |---------:|----------:|----------:|----------:|---------:|---------:|---------:|---------:|---------:|----------:|
} // Benchmark1 | 3.133 us | 0.0492 us | 0.0460 us | 0.0119 us | 3.082 us | 3.100 us | 3.122 us | 3.168 us | 3.233 us | 319,161.9 |
} }
}

17
test/Ocelot.UnitTests/DownstreamRouteFinder/DownstreamRouteFinderTests.cs
View File

@ -624,7 +624,7 @@ namespace Ocelot.UnitTests.DownstreamRouteFinder
.And(x => x.GivenTheUrlMatcherReturns(new OkResponse<UrlMatch>(new UrlMatch(true)))) .And(x => x.GivenTheUrlMatcherReturns(new OkResponse<UrlMatch>(new UrlMatch(true))))
.And(x => x.GivenTheUpstreamHttpMethodIs("Get")) .And(x => x.GivenTheUpstreamHttpMethodIs("Get"))
.When(x => x.WhenICallTheFinder()) .When(x => x.WhenICallTheFinder())
.And(x => x.ThenTheUrlMatcherIsCalledCorrectly(1)) .And(x => x.ThenTheUrlMatcherIsCalledCorrectly(1, 0))
.BDDfy(); .BDDfy();
} }
@ -677,7 +677,8 @@ namespace Ocelot.UnitTests.DownstreamRouteFinder
.WithUpstreamPathTemplate(new UpstreamPathTemplate("someUpstreamPath", 1, false, "test")) .WithUpstreamPathTemplate(new UpstreamPathTemplate("someUpstreamPath", 1, false, "test"))
.Build() .Build()
))) )))
.And(x => x.ThenTheUrlMatcherIsCalledCorrectly(2)) .And(x => x.ThenTheUrlMatcherIsCalledCorrectly(1, 0))
.And(x => x.ThenTheUrlMatcherIsCalledCorrectly(1, 1))
.BDDfy(); .BDDfy();
} }
@ -706,32 +707,32 @@ namespace Ocelot.UnitTests.DownstreamRouteFinder
private void ThenTheUrlMatcherIsCalledCorrectly() private void ThenTheUrlMatcherIsCalledCorrectly()
{ {
_mockMatcher _mockMatcher
.Verify(x => x.Match(_upstreamUrlPath, _upstreamQuery, _reRoutesConfig[0].UpstreamTemplatePattern.Template, _reRoutesConfig[0].UpstreamTemplatePattern.ContainsQueryString), Times.Once); .Verify(x => x.Match(_upstreamUrlPath, _upstreamQuery, _reRoutesConfig[0].UpstreamTemplatePattern), Times.Once);
} }
private void ThenTheUrlMatcherIsCalledCorrectly(int times) private void ThenTheUrlMatcherIsCalledCorrectly(int times, int index = 0)
{ {
_mockMatcher _mockMatcher
.Verify(x => x.Match(_upstreamUrlPath, _upstreamQuery, _reRoutesConfig[0].UpstreamTemplatePattern.OriginalValue, _reRoutesConfig[0].UpstreamTemplatePattern.ContainsQueryString), Times.Exactly(times)); .Verify(x => x.Match(_upstreamUrlPath, _upstreamQuery, _reRoutesConfig[index].UpstreamTemplatePattern), Times.Exactly(times));
} }
private void ThenTheUrlMatcherIsCalledCorrectly(string expectedUpstreamUrlPath) private void ThenTheUrlMatcherIsCalledCorrectly(string expectedUpstreamUrlPath)
{ {
_mockMatcher _mockMatcher
.Verify(x => x.Match(expectedUpstreamUrlPath, _upstreamQuery, _reRoutesConfig[0].UpstreamTemplatePattern.OriginalValue, _reRoutesConfig[0].UpstreamTemplatePattern.ContainsQueryString), Times.Once); .Verify(x => x.Match(expectedUpstreamUrlPath, _upstreamQuery, _reRoutesConfig[0].UpstreamTemplatePattern), Times.Once);
} }
private void ThenTheUrlMatcherIsNotCalled() private void ThenTheUrlMatcherIsNotCalled()
{ {
_mockMatcher _mockMatcher
.Verify(x => x.Match(_upstreamUrlPath, _upstreamQuery, _reRoutesConfig[0].UpstreamTemplatePattern.OriginalValue, _reRoutesConfig[0].UpstreamTemplatePattern.ContainsQueryString), Times.Never); .Verify(x => x.Match(_upstreamUrlPath, _upstreamQuery, _reRoutesConfig[0].UpstreamTemplatePattern), Times.Never);
} }
private void GivenTheUrlMatcherReturns(Response<UrlMatch> match) private void GivenTheUrlMatcherReturns(Response<UrlMatch> match)
{ {
_match = match; _match = match;
_mockMatcher _mockMatcher
.Setup(x => x.Match(It.IsAny<string>(), It.IsAny<string>(), It.IsAny<string>(), It.IsAny<bool>())) .Setup(x => x.Match(It.IsAny<string>(), It.IsAny<string>(), It.IsAny<UpstreamPathTemplate>()))
.Returns(_match); .Returns(_match);
} }

3
test/Ocelot.UnitTests/DownstreamRouteFinder/UrlMatcher/RegExUrlMatcherTests.cs
View File

@ -1,5 +1,6 @@
using Ocelot.DownstreamRouteFinder.UrlMatcher; using Ocelot.DownstreamRouteFinder.UrlMatcher;
using Ocelot.Responses; using Ocelot.Responses;
using Ocelot.Values;
using Shouldly; using Shouldly;
using TestStack.BDDfy; using TestStack.BDDfy;
using Xunit; using Xunit;
@ -270,7 +271,7 @@ namespace Ocelot.UnitTests.DownstreamRouteFinder.UrlMatcher
private void WhenIMatchThePaths() private void WhenIMatchThePaths()
{ {
_result = _urlMatcher.Match(_path, _queryString, _downstreamPathTemplate, _containsQueryString); _result = _urlMatcher.Match(_path, _queryString, new UpstreamPathTemplate(_downstreamPathTemplate, 0, _containsQueryString, _downstreamPathTemplate));
} }
private void ThenTheResultIsTrue() private void ThenTheResultIsTrue()