Skip to content

Allow Regex engine to be trimmed #46813

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Feb 23, 2023
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 16 additions & 10 deletions src/Http/Routing/src/Constraints/RegexRouteConstraint.cs
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the MIT license.

using System.Diagnostics;
using System.Diagnostics.CodeAnalysis;
using System.Globalization;
using System.Text.RegularExpressions;
Expand All @@ -15,7 +16,7 @@ namespace Microsoft.AspNetCore.Routing.Constraints;
public class RegexRouteConstraint : IRouteConstraint, IParameterLiteralNodeMatchingPolicy
{
private static readonly TimeSpan RegexMatchTimeout = TimeSpan.FromSeconds(10);
private readonly string _regexPattern;
private readonly Func<Regex>? _regexFactory;
private Regex? _constraint;

/// <summary>
Expand All @@ -27,20 +28,24 @@ public RegexRouteConstraint(Regex regex)
ArgumentNullException.ThrowIfNull(regex);

_constraint = regex;
_regexPattern = regex.ToString();
}

/// <summary>
/// Constructor for a <see cref="RegexRouteConstraint"/> given a <paramref name="regexPattern"/>.
/// </summary>
/// <param name="regexPattern">A string containing the regex pattern.</param>
public RegexRouteConstraint(
[StringSyntax(StringSyntaxAttribute.Regex, RegexOptions.CultureInvariant | RegexOptions.IgnoreCase)]
[StringSyntax(StringSyntaxAttribute.Regex, RegexOptions.CultureInvariant | RegexOptions.Compiled | RegexOptions.IgnoreCase)]
string regexPattern)
{
ArgumentNullException.ThrowIfNull(regexPattern);

_regexPattern = regexPattern;
// Create regex instance lazily to avoid compiling regexes at app startup. Delay creation until Constraint is first evaluated.
// The regex instance is created by a delegate here to allow the regex engine to be trimmed when this constructor is trimmed.
_regexFactory = () => new Regex(
regexPattern,
RegexOptions.CultureInvariant | RegexOptions.Compiled | RegexOptions.IgnoreCase,
RegexMatchTimeout);
}

/// <summary>
Expand All @@ -50,12 +55,13 @@ public Regex Constraint
{
get
{
// Create regex instance lazily to avoid compiling regexes at app startup. Delay creation until constraint is first evaluated.
// This is not thread safe. No side effect but multiple instances of a regex instance could be created from a burst of requests.
_constraint ??= new Regex(
_regexPattern,
RegexOptions.CultureInvariant | RegexOptions.Compiled | RegexOptions.IgnoreCase,
RegexMatchTimeout);
if (_constraint is null)
{
Debug.Assert(_regexFactory is not null);

// This is not thread-safe. No side effect, but multiple instances of a regex instance could be created from a burst of requests.
_constraint = _regexFactory();
}

return _constraint;
}
Expand Down