Skip to content

Fix warning CA1062#CachePolicy #2238

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.

Sign up for GitHub

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
Jul 23, 2024
Merged

Fix warning CA1062#CachePolicy #2238

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
2cadfd8
Fix warning CA1062#CachePolicy
Zombach Jul 22, 2024
0568e50
Fix PR
Zombach Jul 22, 2024
849123a
Fix PR
Zombach Jul 22, 2024
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
36 changes: 28 additions & 8 deletions src/Polly/Caching/CachePolicy.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@ namespace Polly.Caching;
/// <summary>
/// A cache policy that can be applied to the results of delegate executions.
/// </summary>
#pragma warning disable CA1062 // Validate arguments of public methods
public class CachePolicy : Policy, ICachePolicy
{
private readonly ISyncCacheProvider _syncCacheProvider;
Expand Down Expand Up @@ -39,14 +38,27 @@ internal CachePolicy(
}

/// <inheritdoc/>
protected override void Implementation(Action<Context, CancellationToken> action, Context context, CancellationToken cancellationToken) // Pass-through/NOOP policy action, for void-returning calls through a cache policy.
=>
action(context, cancellationToken);
protected override void Implementation(Action<Context, CancellationToken> action, Context context, CancellationToken cancellationToken)
{
// Pass-through/NOOP policy action, for void-returning calls through a cache policy.
if (action is null)
{
throw new ArgumentNullException(nameof(action));
}

action(context, cancellationToken);
}

/// <inheritdoc/>
[DebuggerStepThrough]
protected override TResult Implementation<TResult>(Func<Context, CancellationToken, TResult> action, Context context, CancellationToken cancellationToken) =>
CacheEngine.Implementation<TResult>(
protected override TResult Implementation<TResult>(Func<Context, CancellationToken, TResult> action, Context context, CancellationToken cancellationToken)
{
if (action is null)
{
throw new ArgumentNullException(nameof(action));
}

return CacheEngine.Implementation<TResult>(
_syncCacheProvider.For<TResult>(),
_ttlStrategy.For<TResult>(),
_cacheKeyStrategy,
Expand All @@ -58,6 +70,7 @@ protected override TResult Implementation<TResult>(Func<Context, CancellationTok
_onCacheGetError,
_onCachePutError,
cancellationToken);
}
}

/// <summary>
Expand Down Expand Up @@ -99,8 +112,14 @@ internal CachePolicy(

/// <inheritdoc/>
[DebuggerStepThrough]
protected override TResult Implementation(Func<Context, CancellationToken, TResult> action, Context context, CancellationToken cancellationToken) =>
CacheEngine.Implementation(
protected override TResult Implementation(Func<Context, CancellationToken, TResult> action, Context context, CancellationToken cancellationToken)
{
if (action is null)
{
throw new ArgumentNullException(nameof(action));
}

return CacheEngine.Implementation(
_syncCacheProvider,
_ttlStrategy,
_cacheKeyStrategy,
Expand All @@ -112,4 +131,5 @@ protected override TResult Implementation(Func<Context, CancellationToken, TResu
_onCacheGetError,
_onCachePutError,
cancellationToken);
}
}
53 changes: 53 additions & 0 deletions test/Polly.Specs/Caching/CacheSpecs.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,59 @@ public class CacheSpecs : IDisposable
{
#region Configuration

[Fact]
public void Should_throw_when_action_is_null()
{
var flags = BindingFlags.NonPublic | BindingFlags.Instance;
Func<Context, CancellationToken, EmptyStruct> action = null!;
Action<Context, CancellationToken> actionVoid = null!;

ISyncCacheProvider syncCacheProvider = new StubCacheProvider();
ITtlStrategy ttlStrategy = new ContextualTtl();
Func<Context, string> cacheKeyStrategy = (_) => string.Empty;
Action<Context, string> onCacheGet = (_, _) => { };
Action<Context, string> onCacheMiss = (_, _) => { };
Action<Context, string> onCachePut = (_, _) => { };
Action<Context, string, Exception>? onCacheGetError = null;
Action<Context, string, Exception>? onCachePutError = null;

var instance = Activator.CreateInstance(
typeof(CachePolicy),
flags,
null,
[
syncCacheProvider,
ttlStrategy,
cacheKeyStrategy,
onCacheGet,
onCacheMiss,
onCachePut,
onCacheGetError,
onCachePutError,
],
null)!;
var instanceType = instance.GetType();
var methods = instanceType.GetMethods(flags);
var methodInfo = methods.First(method => method is { Name: "Implementation", ReturnType.Name: "TResult" });
var generic = methodInfo.MakeGenericMethod(typeof(EmptyStruct));

var func = () => generic.Invoke(instance, [action, new Context(), CancellationToken.None]);

var exceptionAssertions = func.Should().Throw<TargetInvocationException>();
exceptionAssertions.And.Message.Should().Be("Exception has been thrown by the target of an invocation.");
exceptionAssertions.And.InnerException.Should().BeOfType<ArgumentNullException>()
.Which.ParamName.Should().Be("action");

methodInfo = methods.First(method => method is { Name: "Implementation", ReturnType.Name: "Void" });

func = () => methodInfo.Invoke(instance, [actionVoid, new Context(), CancellationToken.None]);

exceptionAssertions = func.Should().Throw<TargetInvocationException>();
exceptionAssertions.And.Message.Should().Be("Exception has been thrown by the target of an invocation.");
exceptionAssertions.And.InnerException.Should().BeOfType<ArgumentNullException>()
.Which.ParamName.Should().Be("action");
}

[Fact]
public void Should_throw_when_cache_provider_is_null()
{
Expand Down
42 changes: 42 additions & 0 deletions test/Polly.Specs/Caching/CacheTResultSpecs.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,48 @@ public class CacheTResultSpecs : IDisposable
{
#region Configuration

[Fact]
public void Should_throw_when_action_is_null()
{
var flags = BindingFlags.NonPublic | BindingFlags.Instance;
Func<Context, CancellationToken, EmptyStruct> action = null!;

ISyncCacheProvider<EmptyStruct> syncCacheProvider = new StubCacheProvider().For<EmptyStruct>();
ITtlStrategy<EmptyStruct> ttlStrategy = new ContextualTtl().For<EmptyStruct>();
Func<Context, string> cacheKeyStrategy = (_) => string.Empty;
Action<Context, string> onCacheGet = (_, _) => { };
Action<Context, string> onCacheMiss = (_, _) => { };
Action<Context, string> onCachePut = (_, _) => { };
Action<Context, string, Exception>? onCacheGetError = null;
Action<Context, string, Exception>? onCachePutError = null;

var instance = Activator.CreateInstance(
typeof(CachePolicy<EmptyStruct>),
flags,
null,
[
syncCacheProvider,
ttlStrategy,
cacheKeyStrategy,
onCacheGet,
onCacheMiss,
onCachePut,
onCacheGetError,
onCachePutError,
],
null)!;
var instanceType = instance.GetType();
var methods = instanceType.GetMethods(flags);
var methodInfo = methods.First(method => method is { Name: "Implementation", ReturnType.Name: "EmptyStruct" });

var func = () => methodInfo.Invoke(instance, [action, new Context(), CancellationToken.None]);

var exceptionAssertions = func.Should().Throw<TargetInvocationException>();
exceptionAssertions.And.Message.Should().Be("Exception has been thrown by the target of an invocation.");
exceptionAssertions.And.InnerException.Should().BeOfType<ArgumentNullException>()
.Which.ParamName.Should().Be("action");
}

[Fact]
public void Should_throw_when_cache_provider_is_null()
{
Expand Down