naming only: IsPatternBased -> IsPattern (#2482)

mgravell · web-flow · commit 309d2760cd11 · 2023-06-13T16:27:51.000+01:00
(also fix some remaining debug tests)
diff --git a/docs/ReleaseNotes.md b/docs/ReleaseNotes.md
@@ -8,7 +8,7 @@ Current package versions:
 
 ## Unreleased
 
-- Fix [#2479](https://github.com/StackExchange/StackExchange.Redis/issues/2479): Add `RedisChannel.UseImplicitAutoPattern` (global) and `RedisChannel.IsPatternBased` ([#2480 by mgravell](https://github.com/StackExchange/StackExchange.Redis/pull/2480))
+- Fix [#2479](https://github.com/StackExchange/StackExchange.Redis/issues/2479): Add `RedisChannel.UseImplicitAutoPattern` (global) and `RedisChannel.IsPattern` ([#2480 by mgravell](https://github.com/StackExchange/StackExchange.Redis/pull/2480))
 - Fix [#2479](https://github.com/StackExchange/StackExchange.Redis/issues/2479): Mark `RedisChannel` conversion operators as obsolete; add `RedisChannel.Literal` and `RedisChannel.Pattern` helpers ([#2481 by mgravell](https://github.com/StackExchange/StackExchange.Redis/pull/2481))
 - Fix [#2449](https://github.com/StackExchange/StackExchange.Redis/issues/2449): Update `Pipelines.Sockets.Unofficial` to `v2.2.8` to support native AOT ([#2456 by eerhardt](https://github.com/StackExchange/StackExchange.Redis/pull/2456))
 
diff --git a/src/StackExchange.Redis/KeyspaceIsolation/KeyPrefixed.cs b/src/StackExchange.Redis/KeyspaceIsolation/KeyPrefixed.cs
@@ -844,7 +844,7 @@ protected RedisValue SortGetToInner(RedisValue outer) =>
         protected RedisChannel ToInner(RedisChannel outer)
         {
             var combined = RedisKey.ConcatenateBytes(Prefix, null, (byte[]?)outer);
-            return new RedisChannel(combined, outer.IsPatternBased ? RedisChannel.PatternMode.Pattern : RedisChannel.PatternMode.Literal);
+            return new RedisChannel(combined, outer.IsPattern ? RedisChannel.PatternMode.Pattern : RedisChannel.PatternMode.Literal);
         }
 
         private Func<RedisKey, RedisKey>? mapFunction;
diff --git a/src/StackExchange.Redis/PublicAPI/PublicAPI.Shipped.txt b/src/StackExchange.Redis/PublicAPI/PublicAPI.Shipped.txt
@@ -1259,7 +1259,7 @@ StackExchange.Redis.Proxy.Twemproxy = 1 -> StackExchange.Redis.Proxy
 StackExchange.Redis.RedisChannel
 StackExchange.Redis.RedisChannel.Equals(StackExchange.Redis.RedisChannel other) -> bool
 StackExchange.Redis.RedisChannel.IsNullOrEmpty.get -> bool
-StackExchange.Redis.RedisChannel.IsPatternBased.get -> bool
+StackExchange.Redis.RedisChannel.IsPattern.get -> bool
 StackExchange.Redis.RedisChannel.PatternMode
 StackExchange.Redis.RedisChannel.PatternMode.Auto = 0 -> StackExchange.Redis.RedisChannel.PatternMode
 StackExchange.Redis.RedisChannel.PatternMode.Literal = 1 -> StackExchange.Redis.RedisChannel.PatternMode
diff --git a/src/StackExchange.Redis/RedisChannel.cs b/src/StackExchange.Redis/RedisChannel.cs
@@ -19,7 +19,7 @@ namespace StackExchange.Redis
         /// <summary>
         /// Indicates whether this channel represents a wildcard pattern (see <c>PSUBSCRIBE</c>)
         /// </summary>
-        public bool IsPatternBased => _isPatternBased;
+        public bool IsPattern => _isPatternBased;
 
         internal bool IsNull => Value == null;
 
diff --git a/tests/StackExchange.Redis.Tests/ChannelTests.cs b/tests/StackExchange.Redis.Tests/ChannelTests.cs
@@ -25,7 +25,7 @@ public void ValidateAutoPatternModeString(string name, bool useImplicitAutoPatte
 #pragma warning disable CS0618 // we need to test the operator
                 RedisChannel channel = name;
 #pragma warning restore CS0618
-                Assert.Equal(isPatternBased, channel.IsPatternBased);
+                Assert.Equal(isPatternBased, channel.IsPattern);
             }
             finally
             {
@@ -53,7 +53,7 @@ public void ValidateModeSpecifiedIgnoresGlobalSetting(string name, RedisChannel.
             {
                 RedisChannel.UseImplicitAutoPattern = useImplicitAutoPattern;
                 RedisChannel channel = new(name, mode);
-                Assert.Equal(isPatternBased, channel.IsPatternBased);
+                Assert.Equal(isPatternBased, channel.IsPattern);
             }
             finally
             {
@@ -76,7 +76,7 @@ public void ValidateAutoPatternModeBytes(string name, bool useImplicitAutoPatter
 #pragma warning disable CS0618 // we need to test the operator
                 RedisChannel channel = bytes;
 #pragma warning restore CS0618
-                Assert.Equal(isPatternBased, channel.IsPatternBased);
+                Assert.Equal(isPatternBased, channel.IsPattern);
             }
             finally
             {
@@ -105,7 +105,7 @@ public void ValidateModeSpecifiedIgnoresGlobalSettingBytes(string name, RedisCha
             {
                 RedisChannel.UseImplicitAutoPattern = useImplicitAutoPattern;
                 RedisChannel channel = new(bytes, mode);
-                Assert.Equal(isPatternBased, channel.IsPatternBased);
+                Assert.Equal(isPatternBased, channel.IsPattern);
             }
             finally
             {
@@ -128,21 +128,21 @@ public void ValidateLiteralPatternMode(string name, bool useImplicitAutoPattern)
 
                 // literal, string
                 channel = RedisChannel.Literal(name);
-                Assert.False(channel.IsPatternBased);
+                Assert.False(channel.IsPattern);
 
                 // pattern, string
                 channel = RedisChannel.Pattern(name);
-                Assert.True(channel.IsPatternBased);
+                Assert.True(channel.IsPattern);
 
                 var bytes = Encoding.UTF8.GetBytes(name);
 
                 // literal, byte[]
                 channel = RedisChannel.Literal(bytes);
-                Assert.False(channel.IsPatternBased);
+                Assert.False(channel.IsPattern);
 
                 // pattern, byte[]
                 channel = RedisChannel.Pattern(bytes);
-                Assert.True(channel.IsPatternBased);
+                Assert.True(channel.IsPattern);
             }
             finally
             {
diff --git a/tests/StackExchange.Redis.Tests/FailoverTests.cs b/tests/StackExchange.Redis.Tests/FailoverTests.cs
@@ -203,7 +203,7 @@ public async Task SubscriptionsSurviveConnectionFailureAsync()
         using var conn = (Create(allowAdmin: true, shared: false, log: Writer, syncTimeout: 1000) as ConnectionMultiplexer)!;
 
         var profiler = conn.AddProfiler();
-        RedisChannel channel = Me();
+        RedisChannel channel = RedisChannel.Literal(Me());
         var sub = conn.GetSubscriber();
         int counter = 0;
         Assert.True(sub.IsConnected());
@@ -308,7 +308,7 @@ public async Task SubscriptionsSurvivePrimarySwitchAsync()
         using var aConn = Create(allowAdmin: true, shared: false);
         using var bConn = Create(allowAdmin: true, shared: false);
 
-        RedisChannel channel = Me();
+        RedisChannel channel = RedisChannel.Literal(Me());
         Log("Using Channel: " + channel);
         var subA = aConn.GetSubscriber();
         var subB = bConn.GetSubscriber();

Original file line number	Diff line number	Diff line change
`@@ -844,7 +844,7 @@ protected RedisValue SortGetToInner(RedisValue outer) =>`
`844`	`844`	`protected RedisChannel ToInner(RedisChannel outer)`
`845`	`845`	`{`
`846`	`846`	`var combined = RedisKey.ConcatenateBytes(Prefix, null, (byte[]?)outer);`
`847`		`- return new RedisChannel(combined, outer.IsPatternBased ? RedisChannel.PatternMode.Pattern : RedisChannel.PatternMode.Literal);`
	`847`	`+ return new RedisChannel(combined, outer.IsPattern ? RedisChannel.PatternMode.Pattern : RedisChannel.PatternMode.Literal);`
`848`	`848`	`}`
`849`	`849`
`850`	`850`	`private Func<RedisKey, RedisKey>? mapFunction;`
Original file line number	Diff line number	Diff line change
`@@ -25,7 +25,7 @@ public void ValidateAutoPatternModeString(string name, bool useImplicitAutoPatte`
`25`	`25`	`#pragma warning disable CS0618 // we need to test the operator`
`26`	`26`	`RedisChannel channel = name;`
`27`	`27`	`#pragma warning restore CS0618`
`28`		`- Assert.Equal(isPatternBased, channel.IsPatternBased);`
	`28`	`+ Assert.Equal(isPatternBased, channel.IsPattern);`
`29`	`29`	`}`
`30`	`30`	`finally`
`31`	`31`	`{`
`@@ -53,7 +53,7 @@ public void ValidateModeSpecifiedIgnoresGlobalSetting(string name, RedisChannel.`
`53`	`53`	`{`
`54`	`54`	`RedisChannel.UseImplicitAutoPattern = useImplicitAutoPattern;`
`55`	`55`	`RedisChannel channel = new(name, mode);`
`56`		`- Assert.Equal(isPatternBased, channel.IsPatternBased);`
	`56`	`+ Assert.Equal(isPatternBased, channel.IsPattern);`
`57`	`57`	`}`
`58`	`58`	`finally`
`59`	`59`	`{`
`@@ -76,7 +76,7 @@ public void ValidateAutoPatternModeBytes(string name, bool useImplicitAutoPatter`
`76`	`76`	`#pragma warning disable CS0618 // we need to test the operator`
`77`	`77`	`RedisChannel channel = bytes;`
`78`	`78`	`#pragma warning restore CS0618`
`79`		`- Assert.Equal(isPatternBased, channel.IsPatternBased);`
	`79`	`+ Assert.Equal(isPatternBased, channel.IsPattern);`
`80`	`80`	`}`
`81`	`81`	`finally`
`82`	`82`	`{`
`@@ -105,7 +105,7 @@ public void ValidateModeSpecifiedIgnoresGlobalSettingBytes(string name, RedisCha`
`105`	`105`	`{`
`106`	`106`	`RedisChannel.UseImplicitAutoPattern = useImplicitAutoPattern;`
`107`	`107`	`RedisChannel channel = new(bytes, mode);`
`108`		`- Assert.Equal(isPatternBased, channel.IsPatternBased);`
	`108`	`+ Assert.Equal(isPatternBased, channel.IsPattern);`
`109`	`109`	`}`
`110`	`110`	`finally`
`111`	`111`	`{`
`@@ -128,21 +128,21 @@ public void ValidateLiteralPatternMode(string name, bool useImplicitAutoPattern)`
`128`	`128`
`129`	`129`	`// literal, string`
`130`	`130`	`channel = RedisChannel.Literal(name);`
`131`		`- Assert.False(channel.IsPatternBased);`
	`131`	`+ Assert.False(channel.IsPattern);`
`132`	`132`
`133`	`133`	`// pattern, string`
`134`	`134`	`channel = RedisChannel.Pattern(name);`
`135`		`- Assert.True(channel.IsPatternBased);`
	`135`	`+ Assert.True(channel.IsPattern);`
`136`	`136`
`137`	`137`	`var bytes = Encoding.UTF8.GetBytes(name);`
`138`	`138`
`139`	`139`	`// literal, byte[]`
`140`	`140`	`channel = RedisChannel.Literal(bytes);`
`141`		`- Assert.False(channel.IsPatternBased);`
	`141`	`+ Assert.False(channel.IsPattern);`
`142`	`142`
`143`	`143`	`// pattern, byte[]`
`144`	`144`	`channel = RedisChannel.Pattern(bytes);`
`145`		`- Assert.True(channel.IsPatternBased);`
	`145`	`+ Assert.True(channel.IsPattern);`
`146`	`146`	`}`
`147`	`147`	`finally`
`148`	`148`	`{`