Apply Obsolete to Filters feature APIs

Azure · Sep 17, 2018 · 23918fe · 23918fe
1 parent eeb0744
commit 23918fe
Show file tree

Hide file tree

Showing 10 changed files with 19 additions and 8 deletions.
diff --git a/src/Microsoft.Azure.WebJobs.Host/Filters/FunctionExceptionContext.cs b/src/Microsoft.Azure.WebJobs.Host/Filters/FunctionExceptionContext.cs
@@ -11,6 +11,7 @@ namespace Microsoft.Azure.WebJobs.Host
     /// <summary>
     /// Base context class for <see cref="IFunctionExceptionFilter.OnExceptionAsync(FunctionExceptionContext, System.Threading.CancellationToken)"/>.
     /// </summary>
+    [Obsolete("Filters is in preview and there may be breaking changes in this area.")]
     public class FunctionExceptionContext : FunctionFilterContext
     {
         /// <summary>

diff --git a/src/Microsoft.Azure.WebJobs.Host/Filters/FunctionExceptionFilterAttribute.cs b/src/Microsoft.Azure.WebJobs.Host/Filters/FunctionExceptionFilterAttribute.cs
@@ -10,6 +10,7 @@ namespace Microsoft.Azure.WebJobs.Host
     /// <summary>
     /// Base class for declarative function exception filters.
     /// </summary>
+    [Obsolete("Filters is in preview and there may be breaking changes in this area.")]
     [AttributeUsage(AttributeTargets.Class | AttributeTargets.Method, AllowMultiple = true, Inherited = true)]
     public abstract class FunctionExceptionFilterAttribute : Attribute, IFunctionExceptionFilter
     {

diff --git a/src/Microsoft.Azure.WebJobs.Host/Filters/FunctionExecutedContext.cs b/src/Microsoft.Azure.WebJobs.Host/Filters/FunctionExecutedContext.cs
@@ -11,6 +11,7 @@ namespace Microsoft.Azure.WebJobs.Host
     /// <summary>
     /// Context class for <see cref="IFunctionInvocationFilter.OnExecutedAsync(FunctionExecutedContext, System.Threading.CancellationToken)"/>>.
     /// </summary>
+    [Obsolete("Filters is in preview and there may be breaking changes in this area.")]
     public class FunctionExecutedContext : FunctionInvocationContext
     {
         /// <summary>

diff --git a/src/Microsoft.Azure.WebJobs.Host/Filters/FunctionExecutingContext.cs b/src/Microsoft.Azure.WebJobs.Host/Filters/FunctionExecutingContext.cs
@@ -10,6 +10,7 @@ namespace Microsoft.Azure.WebJobs.Host
     /// <summary>
     /// Context class for <see cref="IFunctionInvocationFilter.OnExecutingAsync(FunctionExecutingContext, System.Threading.CancellationToken)"/>>.
     /// </summary>
+    [Obsolete("Filters is in preview and there may be breaking changes in this area.")]
     public class FunctionExecutingContext : FunctionInvocationContext
     {
         /// <summary>

diff --git a/src/Microsoft.Azure.WebJobs.Host/Filters/FunctionFilterContext.cs b/src/Microsoft.Azure.WebJobs.Host/Filters/FunctionFilterContext.cs
@@ -10,6 +10,7 @@ namespace Microsoft.Azure.WebJobs.Host
     /// <summary>
     /// Base context class for all function filter context objects.
     /// </summary>
+    [Obsolete("Filters is in preview and there may be breaking changes in this area.")]
     public abstract class FunctionFilterContext
     {
         /// <summary>

diff --git a/src/Microsoft.Azure.WebJobs.Host/Filters/FunctionInvocationContext.cs b/src/Microsoft.Azure.WebJobs.Host/Filters/FunctionInvocationContext.cs
@@ -10,6 +10,7 @@ namespace Microsoft.Azure.WebJobs.Host
     /// <summary>
     /// Base context class for <see cref="IFunctionInvocationFilter"/> context objects.
     /// </summary>
+    [Obsolete("Filters is in preview and there may be breaking changes in this area.")]
     public abstract class FunctionInvocationContext : FunctionFilterContext
     {
         /// <summary>

diff --git a/src/Microsoft.Azure.WebJobs.Host/Filters/FunctionInvocationFilterAttribute.cs b/src/Microsoft.Azure.WebJobs.Host/Filters/FunctionInvocationFilterAttribute.cs
@@ -10,6 +10,7 @@ namespace Microsoft.Azure.WebJobs.Host
     /// <summary>
     /// Base class for declarative function invocation filters.
     /// </summary>
+    [Obsolete("Filters is in preview and there may be breaking changes in this area.")]
     [AttributeUsage(AttributeTargets.Class | AttributeTargets.Method, AllowMultiple = true, Inherited = true)]
     public abstract class FunctionInvocationFilterAttribute : Attribute, IFunctionInvocationFilter
     {

diff --git a/src/Microsoft.Azure.WebJobs.Host/Filters/IFunctionExceptionFilter.cs b/src/Microsoft.Azure.WebJobs.Host/Filters/IFunctionExceptionFilter.cs
@@ -1,6 +1,7 @@
 // Copyright (c) .NET Foundation. All rights reserved.
 // Licensed under the MIT License. See License.txt in the project root for license information.
 
+using System;
 using System.Threading;
 using System.Threading.Tasks;
 
@@ -10,6 +11,7 @@ namespace Microsoft.Azure.WebJobs.Host
     /// Defines a filter that will be called as part of the function invocation pipeline
     /// for failed function invocations.
     /// </summary>
+    [Obsolete("Filters is in preview and there may be breaking changes in this area.")]
     public interface IFunctionExceptionFilter : IFunctionFilter
     {
         /// <summary>

diff --git a/src/Microsoft.Azure.WebJobs.Host/Filters/IFunctionInvocationFilter.cs b/src/Microsoft.Azure.WebJobs.Host/Filters/IFunctionInvocationFilter.cs
@@ -1,6 +1,7 @@
 // Copyright (c) .NET Foundation. All rights reserved.
 // Licensed under the MIT License. See License.txt in the project root for license information.
 
+using System;
 using System.Threading;
 using System.Threading.Tasks;
 
@@ -10,6 +11,7 @@ namespace Microsoft.Azure.WebJobs.Host
     /// Defines a filter that will be called as part of the function invocation pipeline
     /// immediately before and after the job function is invoked.
     /// </summary>
+    [Obsolete("Filters is in preview and there may be breaking changes in this area.")]
     public interface IFunctionInvocationFilter : IFunctionFilter
     {
         /// <summary>

diff --git a/test/Microsoft.Azure.WebJobs.Host.UnitTests/PublicSurfaceTests.cs b/test/Microsoft.Azure.WebJobs.Host.UnitTests/PublicSurfaceTests.cs
@@ -133,16 +133,16 @@ public void WebJobs_Host_VerifyPublicSurfaceArea()
                 "FunctionDescriptor",
                 "FunctionException",
                 "FunctionExceptionContext",
-                "FunctionExceptionFilterAttribute",
-                "FunctionExecutedContext",
+                //"FunctionExceptionFilterAttribute",
+                //"FunctionExecutedContext",
                 "FunctionExecutingContext",
-                "FunctionFilterContext",
+                //"FunctionFilterContext",
                 "FunctionIndexingException",
                 "FunctionInstanceFactoryContext",
                 "FunctionInstanceLogEntry",
-                "FunctionInvocationContext",
+                //"FunctionInvocationContext",
                 "FunctionInvocationException",
-                "FunctionInvocationFilterAttribute",
+                //"FunctionInvocationFilterAttribute",
                 "FunctionListenerException",
                 "FunctionMetadata",
                 "FunctionResult",
@@ -168,13 +168,13 @@ public void WebJobs_Host_VerifyPublicSurfaceArea()
                 "IExtensionRegistryExtensions",
                 "IExtensionRegistryFactory",
                 "IFunctionDefinition",
-                "IFunctionExceptionFilter",
+                //"IFunctionExceptionFilter",
                 "IFunctionExecutor",
-                "IFunctionFilter",
+                //"IFunctionFilter",
                 "IFunctionIndexLookup",
                 "IFunctionInstance",
                 "IFunctionInstanceFactory",
-                "IFunctionInvocationFilter",
+                //"IFunctionInvocationFilter",
                 "IFunctionInvoker",
                 "IHostIdProvider",
                 "IHostSingletonManager",