Skip to content

Commit b6b39f4

Browse files
dgozmandgozman
authored
chore: update URLMatch to follow upstream (#3150)
1 parent 6b41bfe commit b6b39f4

File tree

5 files changed

+269
-135
lines changed

5 files changed

+269
-135
lines changed

‎src/Playwright.Tests/InterceptionTests.cs‎

Lines changed: 80 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@
2323
*/
2424

2525
using System.Net;
26+
using System.Text.RegularExpressions;
2627
using Microsoft.Playwright.Helpers;
2728

2829
namespace Microsoft.Playwright.Tests;
@@ -32,32 +33,85 @@ public class InterceptionTests : PageTestEx
3233
[PlaywrightTest("interception.spec.ts", "should work with glob")]
3334
public void ShouldWorkWithGlob()
3435
{
35-
Assert.That("https://localhost:8080/foo.js", Does.Match(StringExtensions.GlobToRegex("**/*.js")));
36-
Assert.That("https://localhost:8080/foo.js", Does.Not.Match(StringExtensions.GlobToRegex("**/*.css")));
37-
Assert.That("https://localhost:8080/foo.js", Does.Not.Match(StringExtensions.GlobToRegex("*.js")));
38-
Assert.That("https://localhost:8080/foo.js", Does.Match(StringExtensions.GlobToRegex("https://**/*.js")));
39-
Assert.That("http://localhost:8080/simple/path.js", Does.Match(StringExtensions.GlobToRegex("http://localhost:8080/simple/path.js")));
40-
Assert.That("http://localhost:8080/Simple/path.js", Does.Match(StringExtensions.GlobToRegex("http://localhost:8080/?imple/path.js")));
41-
Assert.That("https://localhost:8080/a.js", Does.Match(StringExtensions.GlobToRegex("**/{a,b}.js")));
42-
Assert.That("https://localhost:8080/b.js", Does.Match(StringExtensions.GlobToRegex("**/{a,b}.js")));
43-
Assert.That("https://localhost:8080/c.js", Does.Not.Match(StringExtensions.GlobToRegex("**/{a,b}.js")));
44-
Assert.That("https://localhost:8080/c.jpg", Does.Match(StringExtensions.GlobToRegex("**/*.{png,jpg,jpeg}")));
45-
Assert.That("https://localhost:8080/c.jpeg", Does.Match(StringExtensions.GlobToRegex("**/*.{png,jpg,jpeg}")));
46-
Assert.That("https://localhost:8080/c.png", Does.Match(StringExtensions.GlobToRegex("**/*.{png,jpg,jpeg}")));
47-
Assert.That("https://localhost:8080/c.css", Does.Not.Match(StringExtensions.GlobToRegex("**/*.{png,jpg,jpeg}")));
48-
Assert.That("foo.js", Does.Match(StringExtensions.GlobToRegex("foo*")));
49-
Assert.That("foo/bar.js", Does.Not.Match(StringExtensions.GlobToRegex("foo*")));
50-
Assert.That("http://localhost:3000/signin-oidc/foo", Does.Not.Match(StringExtensions.GlobToRegex("http://localhost:3000/signin-oidc*")));
51-
Assert.That("http://localhost:3000/signin-oidcnice", Does.Match(StringExtensions.GlobToRegex("http://localhost:3000/signin-oidc*")));
52-
53-
Assert.That("http://mydomain:8080/blah/blah/three-columns/settings.html?id=settings-e3c58efe-02e9-44b0-97ac-dd138100cf7c&blah", Does.Match(StringExtensions.GlobToRegex("**/three-columns/settings.html?**id=[a-z]**")));
54-
55-
Assert.AreEqual("^\\?$", StringExtensions.GlobToRegex("\\?"));
56-
Assert.AreEqual("^\\\\$", StringExtensions.GlobToRegex("\\"));
57-
Assert.AreEqual("^\\\\$", StringExtensions.GlobToRegex("\\\\"));
58-
Assert.AreEqual("^\\[$", StringExtensions.GlobToRegex("\\["));
59-
Assert.AreEqual("^[a-z]$", StringExtensions.GlobToRegex("[a-z]"));
60-
Assert.AreEqual(@"^\$\^\+\.\*\(\)\|\?\{\}\[\]$", StringExtensions.GlobToRegex("$^+.\\*()|\\?\\{\\}\\[\\]"));
36+
Regex GlobToRegex(string glob)
37+
{
38+
return new Regex(URLMatch.GlobToRegexPattern(glob));
39+
}
40+
41+
bool URLMatches(string baseURL, string url, string glob)
42+
{
43+
return new URLMatch()
44+
{
45+
baseURL = baseURL,
46+
glob = glob,
47+
}.Match(url);
48+
}
49+
50+
Assert.That("https://localhost:8080/foo.js", Does.Match(GlobToRegex("**/*.js")));
51+
Assert.That("https://localhost:8080/foo.js", Does.Not.Match(GlobToRegex("**/*.css")));
52+
Assert.That("https://localhost:8080/foo.js", Does.Not.Match(GlobToRegex("*.js")));
53+
Assert.That("https://localhost:8080/foo.js", Does.Match(GlobToRegex("https://**/*.js")));
54+
Assert.That("http://localhost:8080/simple/path.js", Does.Match(GlobToRegex("http://localhost:8080/simple/path.js")));
55+
Assert.That("https://localhost:8080/a.js", Does.Match(GlobToRegex("**/{a,b}.js")));
56+
Assert.That("https://localhost:8080/b.js", Does.Match(GlobToRegex("**/{a,b}.js")));
57+
Assert.That("https://localhost:8080/c.js", Does.Not.Match(GlobToRegex("**/{a,b}.js")));
58+
Assert.That("https://localhost:8080/c.jpg", Does.Match(GlobToRegex("**/*.{png,jpg,jpeg}")));
59+
Assert.That("https://localhost:8080/c.jpeg", Does.Match(GlobToRegex("**/*.{png,jpg,jpeg}")));
60+
Assert.That("https://localhost:8080/c.png", Does.Match(GlobToRegex("**/*.{png,jpg,jpeg}")));
61+
Assert.That("https://localhost:8080/c.css", Does.Not.Match(GlobToRegex("**/*.{png,jpg,jpeg}")));
62+
Assert.That("foo.js", Does.Match(GlobToRegex("foo*")));
63+
Assert.That("foo/bar.js", Does.Not.Match(GlobToRegex("foo*")));
64+
Assert.That("http://localhost:3000/signin-oidc/foo", Does.Not.Match(GlobToRegex("http://localhost:3000/signin-oidc*")));
65+
Assert.That("http://localhost:3000/signin-oidcnice", Does.Match(GlobToRegex("http://localhost:3000/signin-oidc*")));
66+
67+
// range [] is NOT supported
68+
Assert.That("http://example.com/api/v[0-9]", Does.Match(GlobToRegex("**/api/v[0-9]")));
69+
Assert.That("http://example.com/api/version", Does.Not.Match(GlobToRegex("**/api/v[0-9]")));
70+
71+
// query params
72+
Assert.That("http://example.com/api?param", Does.Match(GlobToRegex("**/api\\?param")));
73+
Assert.That("http://example.com/api-param", Does.Not.Match(GlobToRegex("**/api\\?param")));
74+
Assert.That("http://mydomain:8080/blah/blah/three-columns/settings.html?id=settings-e3c58efe-02e9-44b0-97ac-dd138100cf7c&blah", Does.Match(GlobToRegex("**/three-columns/settings.html\\?**id=settings-**")));
75+
76+
Assert.AreEqual("^\\?$", URLMatch.GlobToRegexPattern("\\?"));
77+
Assert.AreEqual("^\\\\$", URLMatch.GlobToRegexPattern("\\"));
78+
Assert.AreEqual("^\\\\$", URLMatch.GlobToRegexPattern("\\\\"));
79+
Assert.AreEqual("^\\[$", URLMatch.GlobToRegexPattern("\\["));
80+
Assert.AreEqual("^\\[a-z\\]$", URLMatch.GlobToRegexPattern("[a-z]"));
81+
Assert.AreEqual(@"^\$\^\+\.\*\(\)\|\?\{\}\[\]$", URLMatch.GlobToRegexPattern("$^+.\\*()|\\?\\{\\}\\[\\]"));
82+
83+
Assert.True(URLMatches(null, "http://playwright.dev/", "http://playwright.dev"));
84+
Assert.True(URLMatches(null, "http://playwright.dev/?a=b", "http://playwright.dev?a=b"));
85+
Assert.True(URLMatches(null, "http://playwright.dev/", "h*://playwright.dev"));
86+
Assert.True(URLMatches(null, "http://api.playwright.dev/?x=y", "http://*.playwright.dev?x=y"));
87+
Assert.True(URLMatches(null, "http://playwright.dev/foo/bar", "**/foo/**"));
88+
Assert.True(URLMatches("http://playwright.dev", "http://playwright.dev/?x=y", "?x=y"));
89+
Assert.True(URLMatches("http://playwright.dev/foo/", "http://playwright.dev/foo/bar?x=y", "./bar?x=y"));
90+
91+
// This is not supported, we treat ? as a query separator.
92+
Assert.That("http://localhost:8080/Simple/path.js", Does.Not.Match(GlobToRegex("http://localhost:8080/?imple/path.js")));
93+
Assert.False(URLMatches(null, "http://playwright.dev/", "http://playwright.?ev"));
94+
Assert.True(URLMatches(null, "http://playwright./?ev", "http://playwright.?ev"));
95+
Assert.False(URLMatches(null, "http://playwright.dev/foo", "http://playwright.dev/f??"));
96+
Assert.True(URLMatches(null, "http://playwright.dev/f??", "http://playwright.dev/f??"));
97+
Assert.True(URLMatches(null, "http://playwright.dev/?x=y", "http://playwright.dev\\?x=y"));
98+
Assert.True(URLMatches(null, "http://playwright.dev/?x=y", "http://playwright.dev/\\?x=y"));
99+
Assert.True(URLMatches("http://playwright.dev/foo", "http://playwright.dev/foo?bar", "?bar"));
100+
Assert.True(URLMatches("http://playwright.dev/foo", "http://playwright.dev/foo?bar", "\\\\?bar"));
101+
Assert.True(URLMatches("http://first.host/", "http://second.host/foo", "**/foo"));
102+
Assert.True(URLMatches("http://playwright.dev/", "http://localhost/", "*//localhost/"));
103+
}
104+
105+
[PlaywrightTest("interception.spec.ts", "should intercept by glob")]
106+
public async Task ShouldInterceptByGlob()
107+
{
108+
await Page.GotoAsync(Server.EmptyPage);
109+
await Page.RouteAsync("http://localhos**?*oo", (route) =>
110+
{
111+
return route.FulfillAsync(new() { Status = (int)HttpStatusCode.OK, Body = "intercepted" });
112+
});
113+
var result = await Page.EvaluateAsync<string>("url => fetch(url).then(r => r.text())", Server.Prefix + "/?foo");
114+
Assert.AreEqual("intercepted", result);
61115
}
62116

63117
[PlaywrightTest("interception.spec.ts", "should work with ignoreHTTPSErrors")]

‎src/Playwright/Core/BrowserContext.cs‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -765,7 +765,7 @@ private async Task UnrouteAsync(string globMatch, Regex reMatch, Func<string, bo
765765
var remaining = new List<RouteHandler>();
766766
foreach (var routeHandler in _routes)
767767
{
768-
if (routeHandler.urlMatcher.Equals(globMatch, reMatch, funcMatch, Options.BaseURL) && (handler == null || routeHandler.Handler == handler))
768+
if (routeHandler.urlMatcher.Equals(globMatch, reMatch, funcMatch, Options.BaseURL, false) && (handler == null || routeHandler.Handler == handler))
769769
{
770770
removed.Add(routeHandler);
771771
}
@@ -934,6 +934,7 @@ private Task RouteWebSocketAsync(string globMatch, Regex reMatch, Func<string, b
934934
glob = globMatch,
935935
re = reMatch,
936936
func = funcMatch,
937+
isWebSocketUrl = true,
937938
},
938939
Handler = handler,
939940
});

‎src/Playwright/Core/Page.cs‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1262,7 +1262,7 @@ private async Task UnrouteAsync(string globMatch, Regex reMatch, Func<string, bo
12621262
var remaining = new List<RouteHandler>();
12631263
foreach (var routeHandler in _routes)
12641264
{
1265-
if (routeHandler.urlMatcher.Equals(globMatch, reMatch, funcMatch, Context.Options.BaseURL) && (handler == null || routeHandler.Handler == handler))
1265+
if (routeHandler.urlMatcher.Equals(globMatch, reMatch, funcMatch, Context.Options.BaseURL, false) && (handler == null || routeHandler.Handler == handler))
12661266
{
12671267
removed.Add(routeHandler);
12681268
}
@@ -1610,6 +1610,7 @@ private Task RouteWebSocketAsync(string globMatch, Regex urlRegex, Func<string,
16101610
glob = globMatch,
16111611
re = urlRegex,
16121612
func = urlFunc,
1613+
isWebSocketUrl = true,
16131614
},
16141615
Handler = handler,
16151616
});

‎src/Playwright/Helpers/StringExtensions.cs‎

Lines changed: 0 additions & 91 deletions
Original file line numberDiff line numberDiff line change
@@ -34,9 +34,6 @@ namespace Microsoft.Playwright.Helpers;
3434
/// </summary>
3535
internal static class StringExtensions
3636
{
37-
// https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Regular_expressions#escaping
38-
private static readonly char[] _escapeGlobChars = new[] { '$', '^', '+', '.', '*', '(', ')', '|', '\\', '?', '{', '}', '[', ']' };
39-
4037
private static readonly Dictionary<string, string> _mappings = new Dictionary<string, string>(StringComparer.InvariantCultureIgnoreCase)
4138
{
4239
{ ".323", "text/h323" },
@@ -629,94 +626,6 @@ public static Dictionary<string, string> ParseQueryString(this string query)
629626
return result;
630627
}
631628

632-
/// <summary>
633-
/// Converts an url glob expression to a regex.
634-
/// </summary>
635-
/// <param name="glob">Input url.</param>
636-
/// <returns>A Regex with the glob expression.</returns>
637-
public static string GlobToRegex(this string glob)
638-
{
639-
if (string.IsNullOrEmpty(glob))
640-
{
641-
return null;
642-
}
643-
644-
List<string> tokens = new() { "^" };
645-
bool inGroup = false;
646-
647-
for (int i = 0; i < glob.Length; ++i)
648-
{
649-
var c = glob[i];
650-
if (c == '\\' && i + 1 < glob.Length)
651-
{
652-
var @char = glob[++i];
653-
tokens.Add(_escapeGlobChars.Contains(@char) ? "\\" + @char : @char.ToString());
654-
continue;
655-
}
656-
if (c == '*')
657-
{
658-
char? beforeDeep = i == 0 ? null : glob[i - 1];
659-
int starCount = 1;
660-
while (i < glob.Length - 1 && glob[i + 1] == '*')
661-
{
662-
starCount++;
663-
i++;
664-
}
665-
666-
char? afterDeep = i >= glob.Length - 1 ? null : glob[i + 1];
667-
var isDeep = starCount > 1 &&
668-
(beforeDeep == '/' || beforeDeep == null) &&
669-
(afterDeep == '/' || afterDeep == null);
670-
if (isDeep)
671-
{
672-
tokens.Add("((?:[^/]*(?:\\/|$))*)");
673-
i++;
674-
}
675-
else
676-
{
677-
tokens.Add("([^/]*)");
678-
}
679-
continue;
680-
}
681-
682-
switch (c)
683-
{
684-
case '?':
685-
tokens.Add(".");
686-
break;
687-
case '[':
688-
tokens.Add("[");
689-
break;
690-
case ']':
691-
tokens.Add("]");
692-
break;
693-
case '{':
694-
inGroup = true;
695-
tokens.Add("(");
696-
break;
697-
case '}':
698-
inGroup = false;
699-
tokens.Add(")");
700-
break;
701-
case ',':
702-
if (inGroup)
703-
{
704-
tokens.Add("|");
705-
break;
706-
}
707-
708-
tokens.Add("\\" + c);
709-
break;
710-
default:
711-
tokens.Add(_escapeGlobChars.Contains(c) ? "\\" + c : c.ToString());
712-
break;
713-
}
714-
}
715-
716-
tokens.Add("$");
717-
return string.Concat(tokens.ToArray());
718-
}
719-
720629
internal static string GetContentType(this string path)
721630
{
722631
const string defaultContentType = "application/octet-stream";

0 commit comments

Comments
 (0)