Api updates (#262)

brettsam · web-flow · commit 55452699adf4 · 2021-03-09T19:57:50.000-08:00
diff --git a/samples/FunctionApp/Program.cs b/samples/FunctionApp/Program.cs
@@ -1,10 +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.Diagnostics;
 using System.Threading.Tasks;
-using Microsoft.Azure.Functions.Worker.Configuration;
-using Microsoft.Extensions.Configuration;
 using Microsoft.Extensions.DependencyInjection;
 using Microsoft.Extensions.Hosting;
 
@@ -19,12 +16,6 @@ static async Task Main(string[] args)
 // #endif
             //<docsnippet_startup>
             var host = new HostBuilder()
-                //<docsnippet_configure_app>
-                .ConfigureAppConfiguration(c =>
-                {
-                    c.AddCommandLine(args);
-                })
-                //</docsnippet_configure_app>
                 //<docsnippet_middleware>
                 .ConfigureFunctionsWorkerDefaults()
                 //</docsnippet_middleware>
diff --git a/src/DotNetWorker.Core/Context/BindingContext.cs b/src/DotNetWorker.Core/Context/BindingContext.cs
@@ -6,7 +6,7 @@
 namespace Microsoft.Azure.Functions.Worker
 {
     /// <summary>
-    /// Exposes binding infomation for a given funcion context.
+    /// Exposes binding infomation for a given function context.
     /// </summary>
     public abstract class BindingContext
     {
diff --git a/src/DotNetWorker.Core/Context/DefaultFunctionContext.cs b/src/DotNetWorker.Core/Context/DefaultFunctionContext.cs
@@ -26,7 +26,7 @@ public DefaultFunctionContext(IServiceScopeFactory serviceScopeFactory, IInvocat
         }
 
 
-        public override string Id => _invocation.Id;
+        public override string InvocationId => _invocation.Id;
 
         public override string FunctionId => _invocation.FunctionId;
 
diff --git a/src/DotNetWorker.Core/Context/FunctionContext.cs b/src/DotNetWorker.Core/Context/FunctionContext.cs
@@ -15,7 +15,7 @@ public abstract class FunctionContext
         /// Gets the invocation ID.
         /// This identifier is unique to an invocation.
         /// </summary>
-        public abstract string Id { get; }
+        public abstract string InvocationId { get; }
 
         /// <summary>
         /// Gets the function ID, typically assigned by the host.
@@ -30,6 +30,7 @@ public abstract class FunctionContext
 
         /// <summary>
         /// Gets the binding context for the current function invocation.
+        /// This context is used to retrieve binding data.
         /// </summary>
         public abstract BindingContext BindingContext { get; }
 
diff --git a/src/DotNetWorker.Core/FunctionsApplication.cs b/src/DotNetWorker.Core/FunctionsApplication.cs
@@ -5,6 +5,7 @@
 using System.Collections.Concurrent;
 using System.Threading.Tasks;
 using Microsoft.Azure.Functions.Worker.Diagnostics;
+using Microsoft.Azure.Functions.Worker.Middleware;
 using Microsoft.Azure.Functions.Worker.Pipeline;
 using Microsoft.Extensions.Logging;
 using Microsoft.Extensions.Options;
@@ -57,7 +58,7 @@ public void LoadFunction(FunctionDefinition definition)
 
         public Task InvokeFunctionAsync(FunctionContext context)
         {
-            var scope = new FunctionInvocationScope(context.FunctionDefinition.Name, context.Id);
+            var scope = new FunctionInvocationScope(context.FunctionDefinition.Name, context.InvocationId);
             using (_logger.BeginScope(scope))
             {
                 return _functionExecutionDelegate(context);
diff --git a/src/DotNetWorker.Core/Hosting/FunctionsWorkerApplicationBuilder.cs b/src/DotNetWorker.Core/Hosting/FunctionsWorkerApplicationBuilder.cs
@@ -1,7 +1,8 @@
-// Copyright (c) .NET Foundation. All rights reserved.
+﻿// 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 Microsoft.Azure.Functions.Worker.Middleware;
 using Microsoft.Azure.Functions.Worker.Pipeline;
 using Microsoft.Extensions.DependencyInjection;
 
diff --git a/src/DotNetWorker.Core/Hosting/IFunctionsWorkerApplicationBuilder.cs b/src/DotNetWorker.Core/Hosting/IFunctionsWorkerApplicationBuilder.cs
@@ -2,7 +2,7 @@
 // Licensed under the MIT License. See License.txt in the project root for license information.
 
 using System;
-using Microsoft.Azure.Functions.Worker.Pipeline;
+using Microsoft.Azure.Functions.Worker.Middleware;
 using Microsoft.Extensions.DependencyInjection;
 
 namespace Microsoft.Azure.Functions.Worker
diff --git a/src/DotNetWorker.Core/Hosting/WorkerMiddlewareWorkerApplicationBuilderExtensions.cs b/src/DotNetWorker.Core/Hosting/WorkerMiddlewareWorkerApplicationBuilderExtensions.cs
@@ -2,7 +2,6 @@
 // Licensed under the MIT License. See License.txt in the project root for license information.
 
 using System.Linq;
-using System.Reflection;
 using Microsoft.Azure.Functions.Worker;
 using Microsoft.Azure.Functions.Worker.Middleware;
 using Microsoft.Azure.Functions.Worker.OutputBindings;
@@ -14,7 +13,7 @@ namespace Microsoft.Extensions.Hosting
     /// <summary>
     /// Provides extension methods to work with Worker Middleware against a <see cref="IHostBuilder"/>.
     /// </summary>
-    public static class WorkerMiddlewareWorkerApplicationBuilderExtensions
+    public static class MiddlewareWorkerApplicationBuilderExtensions
     {
         /// <summary>
         /// Configures the <see cref="IFunctionsWorkerApplicationBuilder"/> to use the default set of middleware used by the worker, in the following order:
diff --git a/src/DotNetWorker.Core/Invocation/DefaultFunctionExecutor.Log.cs b/src/DotNetWorker.Core/Invocation/DefaultFunctionExecutor.Log.cs
@@ -17,7 +17,7 @@ private static class Log
 
             public static void ModelBindingFeatureUnavailable(ILogger<DefaultFunctionExecutor> logger, FunctionContext context)
             {
-                _modelBindingFeatureUnavailable(logger, context.Id, context.FunctionId, null);
+                _modelBindingFeatureUnavailable(logger, context.InvocationId, context.FunctionId, null);
             }
         }
     }
diff --git a/src/DotNetWorker.Core/OutputBindings/OutputBindingsMiddleware.cs b/src/DotNetWorker.Core/OutputBindings/OutputBindingsMiddleware.cs
@@ -2,7 +2,7 @@
 // Licensed under the MIT License. See License.txt in the project root for license information.
 
 using System.Threading.Tasks;
-using Microsoft.Azure.Functions.Worker.Pipeline;
+using Microsoft.Azure.Functions.Worker.Middleware;
 
 namespace Microsoft.Azure.Functions.Worker.OutputBindings
 {
diff --git a/src/DotNetWorker.Core/Pipeline/DefaultInvocationPipelineBuilder.cs b/src/DotNetWorker.Core/Pipeline/DefaultInvocationPipelineBuilder.cs
@@ -4,15 +4,14 @@
 using System;
 using System.Collections.Generic;
 using System.Linq;
-using System.Runtime.CompilerServices;
-using System.Text;
 using System.Threading.Tasks;
+using Microsoft.Azure.Functions.Worker.Middleware;
 
 namespace Microsoft.Azure.Functions.Worker.Pipeline
 {
     internal class DefaultInvocationPipelineBuilder<Context> : IInvocationPipelineBuilder<Context>
     {
-        private readonly IList<Func<FunctionExecutionDelegate, FunctionExecutionDelegate>> _middlewareCollection = 
+        private readonly IList<Func<FunctionExecutionDelegate, FunctionExecutionDelegate>> _middlewareCollection =
             new List<Func<FunctionExecutionDelegate, FunctionExecutionDelegate>>();
 
         public IInvocationPipelineBuilder<Context> Use(Func<FunctionExecutionDelegate, FunctionExecutionDelegate> middleware)
diff --git a/src/DotNetWorker.Core/Pipeline/FunctionExecutionDelegate.cs b/src/DotNetWorker.Core/Pipeline/FunctionExecutionDelegate.cs
@@ -1,13 +1,9 @@
-// Copyright (c) .NET Foundation. All rights reserved.
+﻿// 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.Collections.Generic;
-using System.Linq;
-using System.Text;
 using System.Threading.Tasks;
 
-namespace Microsoft.Azure.Functions.Worker.Pipeline
+namespace Microsoft.Azure.Functions.Worker.Middleware
 {
     /// <summary>
     /// A delegate that can process an event.
diff --git a/src/DotNetWorker.Core/Pipeline/IInvocationPipelineBuilder.cs b/src/DotNetWorker.Core/Pipeline/IInvocationPipelineBuilder.cs
@@ -2,6 +2,7 @@
 // Licensed under the MIT License. See License.txt in the project root for license information.
 
 using System;
+using Microsoft.Azure.Functions.Worker.Middleware;
 
 namespace Microsoft.Azure.Functions.Worker.Pipeline
 {
diff --git a/src/DotNetWorker/Hosting/FunctionsWorkerHost.cs b/src/DotNetWorker/Hosting/FunctionsWorkerHost.cs
@@ -4,11 +4,12 @@
 using System;
 using System.Threading.Tasks;
 using Microsoft.Extensions.DependencyInjection;
+using Microsoft.Extensions.Hosting;
 
-namespace Microsoft.Extensions.Hosting
+namespace Microsoft.Azure.Functions.Worker
 {
     /// <summary>
-    /// Hosing helpers to work with Azure Functions Workers
+    /// Hosting helpers to work with Azure Functions Workers
     /// </summary>
     public static class FunctionsWorkerHost
     {
@@ -30,14 +31,14 @@ public static void RunDefault(Action<IServiceCollection>? configureServices = nu
         /// <returns>A <see cref="Task"/> that will complete when the host shuts down.</returns>
         public async static Task RunDefaultAsync(Action<IServiceCollection>? configureService = null)
         {
-           var builder = Host.CreateDefaultBuilder()
-                .ConfigureFunctionsWorkerDefaults();
+            var builder = Host.CreateDefaultBuilder()
+                 .ConfigureFunctionsWorkerDefaults();
 
             if (configureService is not null)
             {
                 builder.ConfigureServices(configureService);
             }
-            
+
             await builder.Build().RunAsync();
         }
     }
diff --git a/src/DotNetWorker/Hosting/WorkerHostBuilderExtensions.cs b/src/DotNetWorker/Hosting/WorkerHostBuilderExtensions.cs
@@ -3,6 +3,7 @@
 
 using System;
 using Microsoft.Azure.Functions.Worker;
+using Microsoft.Extensions.Configuration;
 using Microsoft.Extensions.DependencyInjection;
 
 namespace Microsoft.Extensions.Hosting
@@ -109,18 +110,35 @@ public static IHostBuilder ConfigureFunctionsWorkerDefaults(this IHostBuilder bu
         /// <returns>The <see cref="IHostBuilder"/>.</returns>
         public static IHostBuilder ConfigureFunctionsWorkerDefaults(this IHostBuilder builder, Action<HostBuilderContext, IFunctionsWorkerApplicationBuilder> configure, Action<WorkerOptions> configureOptions)
         {
-            builder.ConfigureServices((context, services) =>
-            {
-                IFunctionsWorkerApplicationBuilder appBuilder = services.AddFunctionsWorkerDefaults(configureOptions);
+            builder
+                .ConfigureAppConfiguration(configBuilder =>
+                {
+                    var cmdLine = Environment.GetCommandLineArgs();
+                    RegisterCommandLine(configBuilder, cmdLine);
+                })
+                .ConfigureServices((context, services) =>
+                {
+                    IFunctionsWorkerApplicationBuilder appBuilder = services.AddFunctionsWorkerDefaults(configureOptions);
 
-                // Call the provided configuration prior to adding default middleware
-                configure(context, appBuilder);
+                    // Call the provided configuration prior to adding default middleware
+                    configure(context, appBuilder);
 
-                // Add default middleware
-                appBuilder.UseDefaultWorkerMiddleware();
-            });
+                    // Add default middleware
+                    appBuilder.UseDefaultWorkerMiddleware();
+                });
 
             return builder;
         }
+
+        internal static void RegisterCommandLine(IConfigurationBuilder builder, string[] cmdLine)
+        {
+            if (cmdLine.Length > 0 &&
+                !cmdLine[0].StartsWith("--"))
+            {
+                cmdLine[0] = $"\"{cmdLine[0]}\"";
+            }
+
+            builder.AddCommandLine(cmdLine);
+        }
     }
 }
diff --git a/src/DotNetWorker/Properties/AssemblyInfo.cs b/src/DotNetWorker/Properties/AssemblyInfo.cs
@@ -0,0 +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.Runtime.CompilerServices;
+
+[assembly: InternalsVisibleTo("Microsoft.Azure.Functions.Worker.Tests, PublicKey=00240000048000009400000006020000002400005253413100040000010001005148be37ac1d9f58bd40a2e472c9d380d635b6048278f7d47480b08c928858f0f7fe17a6e4ce98da0e7a7f0b8c308aecd9e9b02d7e9680a5b5b75ac7773cec096fbbc64aebd429e77cb5f89a569a79b28e9c76426783f624b6b70327eb37341eb498a2c3918af97c4860db6cdca4732787150841e395a29cfacb959c1fd971c1")]
+[assembly: InternalsVisibleTo("DynamicProxyGenAssembly2, PublicKey=0024000004800000940000000602000000240000525341310004000001000100c547cac37abd99c8db225ef2f6c8a3602f3b3606cc9891605d02baa56104f4cfc0734aa39b93bf7852f7d9266654753cc297e7d2edfe0bac1cdcf9f717241550e0a7b191195b7667bb4f64bcb8e2121380fd1d9d46ad2d92d2d15605093924cceaf74c4861eff62abf69b9291ed0a340e113be11e6a7d3113e92484cf7045cc7")]
diff --git a/test/DotNetWorkerTests/FunctionsWorkerApplicationBuilderTests.cs b/test/DotNetWorkerTests/FunctionsWorkerApplicationBuilderTests.cs
@@ -2,7 +2,6 @@
 // Licensed under the MIT License. See License.txt in the project root for license information.
 
 using System;
-using Microsoft.Azure.Functions.Worker.Configuration;
 using Microsoft.Extensions.DependencyInjection;
 using Microsoft.Extensions.Hosting;
 using Microsoft.Extensions.Options;
diff --git a/test/DotNetWorkerTests/TestFunctionContext.cs b/test/DotNetWorkerTests/TestFunctionContext.cs
@@ -42,7 +42,7 @@ public TestFunctionContext(FunctionDefinition functionDefinition, FunctionInvoca
 
         public override IInvocationFeatures Features { get; } = new InvocationFeatures(Enumerable.Empty<IInvocationFeatureProvider>());
 
-        public override string Id => _invocation.Id;
+        public override string InvocationId => _invocation.Id;
 
         public override string FunctionId => _invocation.FunctionId;
 
diff --git a/test/DotNetWorkerTests/WorkerHostBuilderExtensionsTests.cs b/test/DotNetWorkerTests/WorkerHostBuilderExtensionsTests.cs
@@ -0,0 +1,36 @@
+﻿// Copyright (c) .NET Foundation. All rights reserved.
+// Licensed under the MIT License. See License.txt in the project root for license information.
+
+using System.Collections.Generic;
+using Microsoft.Extensions.Configuration;
+using Microsoft.Extensions.Hosting;
+using Xunit;
+
+namespace Microsoft.Azure.Functions.Worker.Tests
+{
+    public class WorkerHostBuilderExtensionsTests
+    {
+        [Theory]
+        [InlineData("/home/usr/", "\"/home/usr/\"")]
+        [InlineData(null, "--host")]
+        public void QuoteFirstArg(string firstArg, string expected)
+        {
+            var cmdLineList = new List<string> { "--host", "127.0.0.1" };
+
+            if (firstArg != null)
+            {
+                cmdLineList.Insert(0, firstArg);
+            }
+
+            var cmdLine = cmdLineList.ToArray();
+
+            var configBuilder = new ConfigurationBuilder();
+            WorkerHostBuilderExtensions.RegisterCommandLine(configBuilder, cmdLine);
+
+            Assert.Equal(expected, cmdLine[0]);
+
+            var config = configBuilder.Build();
+            Assert.Equal("127.0.0.1", config["host"]);
+        }
+    }
+}
diff --git a/test/E2ETests/E2EApps/E2EApp/Program.cs b/test/E2ETests/E2EApps/E2EApp/Program.cs
@@ -2,7 +2,6 @@
 // Licensed under the MIT License. See License.txt in the project root for license information.
 
 using System.Threading.Tasks;
-using Microsoft.Extensions.Configuration;
 using Microsoft.Extensions.Hosting;
 
 namespace Microsoft.Azure.Functions.Worker.E2EApps.CosmosApp
@@ -12,10 +11,6 @@ class Program
         static async Task Main(string[] args)
         {
             var host = new HostBuilder()
-                .ConfigureAppConfiguration(c =>
-                {
-                    c.AddCommandLine(args);
-                })
                 .ConfigureFunctionsWorkerDefaults()
                 .Build();
 

Original file line number	Diff line number	Diff line change
`@@ -6,7 +6,7 @@`
`6`	`6`	`namespace Microsoft.Azure.Functions.Worker`
`7`	`7`	`{`
`8`	`8`	`/// <summary>`
`9`		`- /// Exposes binding infomation for a given funcion context.`
	`9`	`+ /// Exposes binding infomation for a given function context.`
`10`	`10`	`/// </summary>`
`11`	`11`	`public abstract class BindingContext`
`12`	`12`	`{`
Original file line number	Diff line number	Diff line change
`@@ -26,7 +26,7 @@ public DefaultFunctionContext(IServiceScopeFactory serviceScopeFactory, IInvocat`
`26`	`26`	`}`
`27`	`27`
`28`	`28`
`29`		`- public override string Id => _invocation.Id;`
	`29`	`+ public override string InvocationId => _invocation.Id;`
`30`	`30`
`31`	`31`	`public override string FunctionId => _invocation.FunctionId;`
`32`	`32`
Original file line number	Diff line number	Diff line change
`@@ -17,7 +17,7 @@ private static class Log`
`17`	`17`
`18`	`18`	`public static void ModelBindingFeatureUnavailable(ILogger<DefaultFunctionExecutor> logger, FunctionContext context)`
`19`	`19`	`{`
`20`		`- _modelBindingFeatureUnavailable(logger, context.Id, context.FunctionId, null);`
	`20`	`+ _modelBindingFeatureUnavailable(logger, context.InvocationId, context.FunctionId, null);`
`21`	`21`	`}`
`22`	`22`	`}`
`23`	`23`	`}`
Original file line number	Diff line number	Diff line change
`@@ -2,7 +2,7 @@`
`2`	`2`	`// Licensed under the MIT License. See License.txt in the project root for license information.`
`3`	`3`
`4`	`4`	`using System.Threading.Tasks;`
`5`		`-using Microsoft.Azure.Functions.Worker.Pipeline;`
	`5`	`+using Microsoft.Azure.Functions.Worker.Middleware;`
`6`	`6`
`7`	`7`	`namespace Microsoft.Azure.Functions.Worker.OutputBindings`
`8`	`8`	`{`