Core Tools OOP Host

src/Azure.Functions.Cli/Actions/HostActions/StartHostAction.cs

@@ -7,6 +7,7 @@
 using System.Net;
 using System.Runtime.InteropServices;
 using System.Security.Cryptography.X509Certificates;
+using System.Text.Json;
 using System.Text.RegularExpressions;
 using System.Threading.Tasks;
 using Azure.Functions.Cli.Common;
@@ -18,12 +19,14 @@
 using Azure.Functions.Cli.NativeMethods;
 using Colors.Net;
 using Fclp;
+using Microsoft.AspNetCore.DataProtection;
 using Microsoft.AspNetCore.Hosting;
 using Microsoft.Azure.WebJobs.Extensions.Http;
 using Microsoft.Azure.WebJobs.Script;
 using Microsoft.Azure.WebJobs.Script.Configuration;
 using Microsoft.Azure.WebJobs.Script.Description;
 using Microsoft.Azure.WebJobs.Script.WebHost;
+using Microsoft.CodeAnalysis.CSharp.Syntax;
 using Microsoft.Extensions.Configuration;
 using Microsoft.Extensions.DependencyInjection;
 using Microsoft.Extensions.Logging;
@@ -44,6 +47,7 @@ internal class StartHostAction : BaseAction
  private const string WindowsExecutableName = "func.exe";
  private const string LinuxExecutableName = "func";
  private const string InProc8DirectoryName = "in-proc8";
+ private const string OutOfProcDirectoryName = "out-of-proc";
  private readonly ISecretsManager _secretsManager;
  private readonly IProcessManager _processManager;
  private IConfigurationRoot _hostJsonConfig;
@@ -81,6 +85,8 @@ internal class StartHostAction : BaseAction
 
  public string JsonOutputFile { get; set; }
 
+ public string? SetHostRuntime { get; set; }
+
  public StartHostAction(ISecretsManager secretsManager, IProcessManager processManager)
  {
  _secretsManager = secretsManager;
@@ -176,6 +182,11 @@ public override ICommandLineParserResult ParseArgs(string[] args)
  .WithDescription("If provided, a path to the file that will be used to write the output when using --enable-json-output.")
  .Callback(jsonOutputFile => JsonOutputFile = jsonOutputFile);
 
+ Parser
+ .Setup<string>("runtime")
+ .WithDescription("If provided, determines which version of the host to start.")
+ .Callback(startHostAction => SetHostRuntime = startHostAction);
+
  var parserResult = base.ParseArgs(args);
  bool verboseLoggingArgExists = parserResult.UnMatchedOptions.Any(o => o.LongName.Equals("verbose", StringComparison.OrdinalIgnoreCase));
  // Input args do not contain --verbose flag
@@ -418,15 +429,104 @@ private async Task<JObject> GetLocalSettingsJsonAsJObjectAsync()
  public override async Task RunAsync()
  {
  await PreRunConditions();
+ var isVerbose = VerboseLogging.HasValue && VerboseLogging.Value;
 
  var isCurrentProcessNet6Build = RuntimeInformation.FrameworkDescription.Contains(Net6FrameworkDescriptionPrefix);
- if (isCurrentProcessNet6Build && ShouldLaunchInProcNet8AsChildProcess() && await IsInProcNet8Enabled())
+ if (SetHostRuntime != null)
+ {
+ if (SetHostRuntime == "default")
+ {
+ if (isCurrentProcessNet6Build)
+ {
+ if (isVerbose)
+ {
+ ColoredConsole.WriteLine(VerboseColor("Selected out-of-process host"));
+ }
+ await StartHostAsChildProcessAsync(true);
+ return;
+ }
+ }
+ else if (SetHostRuntime == "inproc8")
+ {
+ if (isCurrentProcessNet6Build && ShouldLaunchInProcNet8AsChildProcess() && await IsInProcNet8Enabled())
+ {
+ if (isVerbose)
+ {
+ ColoredConsole.WriteLine(VerboseColor("Selected inproc8 host"));
+ }
+ await StartHostAsChildProcessAsync(false);
+ return;
+ }
+
+ }
+ else if (SetHostRuntime == "inproc6")
+ {
+ if (isVerbose)
+ {
+ ColoredConsole.WriteLine(VerboseColor("Selected inproc6 host"));
+ }
+ if (!isCurrentProcessNet6Build)
+ {
+ throw new CliException($"Cannot set host runtime to '{SetHostRuntime}' for the current process. The current process is not a .NET 6 build.");
+ }
+ }
+ else
+ {
+ throw new CliException($"Invalid host runtime '{SetHostRuntime}'. Valid values are 'default', 'in-proc8', 'in-proc6'.");
+ }
+ }
+ else
  {
- await StartInProc8AsChildProcessAsync();
- return;
+ // We should try to infer if we run inproc6 host, inproc8 host, or OOP host (default)
+ var functionAppRoot = ScriptHostHelpers.GetFunctionAppRootDirectory(Environment.CurrentDirectory);
+
+ // Get the WorkerRuntime
+ var workerRuntime = GlobalCoreToolsSettings.CurrentWorkerRuntime;
+ string targetFramework = "";
+
+ string projectFilePath = ProjectHelpers.FindProjectFile(functionAppRoot);
+ if (projectFilePath != null)
+ {
+ targetFramework = await DotnetHelpers.DetermineTargetFramework(Path.GetDirectoryName(projectFilePath));
+ }
+
+ bool shouldLaunchOopProcess = true;
+
+ // Check if the app is in-proc
+ if (workerRuntime == WorkerRuntime.dotnet)
+ {
+ // Start .NET 8 child process if InProc8 is enabled and if TFM of function app is .NET 8
+ if (isCurrentProcessNet6Build && ShouldLaunchInProcNet8AsChildProcess() && await IsInProcNet8Enabled() && targetFramework == "net8.0")
+ {
+ if (isVerbose)
+ {
+ ColoredConsole.WriteLine(VerboseColor("Selected inproc8 host"));
+ }
+ await StartHostAsChildProcessAsync(false);
+ return;
+ }
+ // Start .NET 6 process if TFM of function app is .NET 6
+ else if (isCurrentProcessNet6Build && targetFramework == "net6.0")
+ {
+ if (isVerbose)
+ {
+ ColoredConsole.WriteLine(VerboseColor("Selected inproc6 host"));
+ }
+ shouldLaunchOopProcess = false;
+ }
+ }
+ // If the above conditions fail, the default should be OOP host
+ if (isCurrentProcessNet6Build && shouldLaunchOopProcess)
+ {
+ if (isVerbose)
+ {
+ ColoredConsole.WriteLine(VerboseColor("Selected out-of-process host"));
+ }
+ await StartHostAsChildProcessAsync(true);
+ return;
+ }
  }
 
- var isVerbose = VerboseLogging.HasValue && VerboseLogging.Value;
  if (isVerbose || EnvironmentHelper.GetEnvironmentVariableAsBool(Constants.DisplayLogo))
  {
  Utilities.PrintLogo();
@@ -488,23 +588,31 @@ private static string GetInProcNet8ExecutablePath()
  return Path.Combine(funcExecutableDirectory, InProc8DirectoryName, executableName);
  }
 
- private Task StartInProc8AsChildProcessAsync()
+ private static string GetOutOfProcExecutablePath()
+ {
+ var funcExecutableDirectory = Path.GetDirectoryName(typeof(StartHostAction).Assembly.Location)!;
+ var executableName = RuntimeInformation.IsOSPlatform(OSPlatform.Windows) ? WindowsExecutableName : LinuxExecutableName;
+
+ return Path.Combine(funcExecutableDirectory, OutOfProcDirectoryName, executableName);
+ }
+
+ private Task StartHostAsChildProcessAsync(bool isOutOfProc)
  {
  if (VerboseLogging == true)
  {
- ColoredConsole.WriteLine(VerboseColor($"Starting child process for in-process model host."));
+ ColoredConsole.WriteLine(VerboseColor($"Starting child process for  {(isOutOfProc ? "out-of-process" : "in-process")} model host."));
  }
 
  var commandLineArguments = string.Join(" ", Environment.GetCommandLineArgs().Skip(1));
  var tcs = new TaskCompletionSource();
 
- var inProc8FuncExecutablePath = GetInProcNet8ExecutablePath();
+ var funcExecutablePath = isOutOfProc? GetOutOfProcExecutablePath(): GetInProcNet8ExecutablePath();
 
- EnsureNet8FuncExecutablePresent(inProc8FuncExecutablePath);
+ EnsureNet8FuncExecutablePresent(funcExecutablePath);
 
- var inprocNet8ChildProcessInfo = new ProcessStartInfo
+ var childProcessInfo = new ProcessStartInfo
  {
- FileName = inProc8FuncExecutablePath,
+ FileName = funcExecutablePath,
  Arguments = $"{commandLineArguments} --no-build",
  WorkingDirectory = Environment.CurrentDirectory,
  UseShellExecute = false,
@@ -515,7 +623,7 @@ private Task StartInProc8AsChildProcessAsync()
 
  try
  {
- var childProcess = Process.Start(inprocNet8ChildProcessInfo);
+ var childProcess = Process.Start(childProcessInfo);
  if (VerboseLogging == true)
  {
  ColoredConsole.WriteLine(VerboseColor($"Started child process with ID: {childProcess.Id}"));
@@ -546,7 +654,7 @@ private Task StartInProc8AsChildProcessAsync()
  }
  catch (Exception ex)
  {
- throw new CliException($"Failed to start the in-process model host. {ex.Message}");
+ throw new CliException($"Failed to start the {(isOutOfProc ? "out-of-process" : "in-process")} model host. {ex.Message}");
  }
 
  return tcs.Task;

src/Azure.Functions.Cli/Actions/LocalActions/CreateFunctionAction.cs

@@ -13,7 +13,6 @@
 using Azure.Functions.Cli.Interfaces;
 using Colors.Net;
 using Fclp;
-using ImTools;
 using Microsoft.Azure.AppService.Proxy.Common.Context;
 using Microsoft.Azure.WebJobs.Extensions.Http;
 using Microsoft.Azure.WebJobs.Script;

src/Azure.Functions.Cli/Azure.Functions.Cli.csproj

@@ -1,4 +1,4 @@
-<Project Sdk="Microsoft.NET.Sdk" InitialTargets="ExcludeWorkersFromReadyToRun">
+<Project Sdk="Microsoft.NET.Sdk" InitialTargets="ExcludeWorkersFromReadyToRun">
  <PropertyGroup>
  <OutputType>Exe</OutputType>
  <TargetFrameworks>net6.0;net8.0</TargetFrameworks>
@@ -40,6 +40,9 @@
  <PropertyGroup Condition="'$(SkipInProcessHost)' == 'True'">
  <DefineConstants>SkipInProcessHost</DefineConstants>
  </PropertyGroup>
+ <PropertyGroup>
+ <PublishOutofProcessHost>True</PublishOutofProcessHost>
+ </PropertyGroup>
  <PropertyGroup Condition="'$(RuntimeIdentifier)' == 'win-x64' OR '$(RuntimeIdentifier)' == 'win-x86'">
  <PublishReadyToRun>false</PublishReadyToRun>
  <PublishReadyToRunShowWarnings>false</PublishReadyToRunShowWarnings>
@@ -274,46 +277,65 @@
  <ItemGroup>
  <PackageReference Include="Autofac" Version="4.6.2" />
  <PackageReference Include="Azure.Identity" Version="1.11.4" />
- <PackageReference Include="Azure.Security.KeyVault.Secrets" Version="4.2.0" />
+ <PackageReference Include="Azure.Security.KeyVault.Secrets" Version="4.6.0" />
  <PackageReference Include="Colors.Net" Version="1.1.0" />
  <PackageReference Include="AccentedCommandLineParser" Version="2.0.0" />
- <PackageReference Include="DotNetZip" Version="1.13.3" />
+ <PackageReference Include="DotNetZip" Version="1.16.0" />
  <PackageReference Include="Microsoft.ApplicationInsights" Version="2.22.0" />
  <PackageReference Include="Microsoft.AspNetCore.DataProtection" Version="2.2.0" />
  <PackageReference Include="Microsoft.Azure.DurableTask.AzureStorage.Internal" Version="1.4.0" />
- <PackageReference Include="Microsoft.Azure.WebJobs.Script.WebHost" Version="4.35.4" />
  <PackageReference Include="Microsoft.Build" Version="17.0.0" />
  <PackageReference Include="Microsoft.Identity.Client" Version="4.61.3" />
  <PackageReference Include="Newtonsoft.Json" Version="13.0.3" />
  <PackageReference Include="NuGet.Packaging" Version="5.11.6" />
  <PackageReference Include="System.Formats.Asn1" Version="6.0.1" />
  <PackageReference Include="WindowsAzure.Storage" Version="9.3.1" />
- <PackageReference Include="YamlDotNet" Version="6.0.0" />
+ <PackageReference Include="YamlDotNet" Version="6.0.0" />
+ </ItemGroup>
+ <ItemGroup Condition="'$(TargetFramework)' == 'net8.0' AND '$(PublishOutofProcessHost)'=='True'">
+ <PackageReference Include="Microsoft.Azure.WebJobs.Script.WebHost" Version="4.1036.1" />
+ </ItemGroup>
+ <ItemGroup Condition="'$(TargetFramework)'=='net6.0' OR ('$(TargetFramework)'=='net8.0' AND '$(PublishOutofProcessHost)'=='False')">
+ <PackageReference Include="Microsoft.Azure.WebJobs.Script.WebHost" Version="4.35.3" />
  </ItemGroup>
  <ItemGroup Condition="'$(NoWorkers)' != 'true'">
- <PackageReference Include="Microsoft.Azure.Functions.JavaWorker" Version="2.14.0" />
+ <PackageReference Include="Microsoft.Azure.Functions.JavaWorker" Version="20240410.1.0-v4" />
  <PackageReference Include="Microsoft.Azure.Functions.NodeJsWorker" Version="3.10.0" />
  <PackageReference Include="Microsoft.Azure.Functions.PowerShellWorker.PS7.0" Version="4.0.3148" />
- <PackageReference Include="Microsoft.Azure.Functions.PowerShellWorker.PS7.2" Version="4.0.3220" />
- <PackageReference Include="Microsoft.Azure.Functions.PowerShellWorker.PS7.4" Version="4.0.3219" />
- <PackageReference Include="Microsoft.Azure.Functions.PythonWorker" Version="4.29.0" />
+ <PackageReference Include="Microsoft.Azure.Functions.PowerShellWorker.PS7.2" Version="4.0.4020" />
+ <PackageReference Include="Microsoft.Azure.Functions.PowerShellWorker.PS7.4" Version="4.0.4021" />
+ <PackageReference Include="Microsoft.Azure.Functions.PythonWorker" Version="4.31.0" />
  </ItemGroup>
  <Target Name="ExcludeWorkersFromReadyToRun">
  <CreateItem Include="%(None.Filename)%(None.Extension)" Condition="$([System.String]::new('%(None.TargetPath)').StartsWith('workers'))" PreserveExistingMetadata="false">
  <Output TaskParameter="Include" ItemName="PublishReadyToRunExclude" />
  </CreateItem>
  </Target>
+ <!-- Build/Publish for OOP host as well-->
+ <Target Name="BuildOutOfProc" AfterTargets="Build" Condition="'$(TargetFramework)'=='net6.0' AND '$(PublishOutofProcessHost)'=='True'">
+ <PropertyGroup>
+ <RuntimeIdentifierOption Condition="'$(RuntimeIdentifier)' != ''">-r $(RuntimeIdentifier)</RuntimeIdentifierOption>
+ </PropertyGroup>
+ <Exec Command="dotnet publish -c $(Configuration) -f net8.0 --output $(OutputPath)/out-of-proc $(RuntimeIdentifierOption) -p:NoWorkers=True --self-contained" />
+ </Target>
+ <Target Name="PublishOutOfProc" AfterTargets="Publish" Condition="'$(TargetFramework)'=='net6.0' AND '$(PublishOutofProcessHost)'=='True'">
+ <PropertyGroup>
+ <RuntimeIdentifierOption Condition="'$(RuntimeIdentifier)' != ''">-r $(RuntimeIdentifier)</RuntimeIdentifierOption>
+ </PropertyGroup>
+ <Exec Command="dotnet publish -c $(Configuration) -f net8.0 --output $(PublishDir)/out-of-proc $(RuntimeIdentifierOption) -p:NoWorkers=True --self-contained" />
+ </Target>
+
  <!-- Build/Publish for net8.0 TFM as well-->
  <Target Name="BuildInProcNet8" AfterTargets="Build" Condition="'$(TargetFramework)'=='net6.0' AND '$(SkipInProcessHost)'!='True'">
-  <PropertyGroup>
-  <RuntimeIdentifierOption Condition="'$(RuntimeIdentifier)' != ''">-r $(RuntimeIdentifier)</RuntimeIdentifierOption>
-  </PropertyGroup>
- <Exec Command="dotnet publish -c $(Configuration) -f net8.0 --output $(OutputPath)/in-proc8 $(RuntimeIdentifierOption) -p:NoWorkers=True --self-contained" />
+  <PropertyGroup>
+  <RuntimeIdentifierOption Condition="'$(RuntimeIdentifier)' != ''">-r $(RuntimeIdentifier)</RuntimeIdentifierOption>
+  </PropertyGroup>
+ <Exec Command="dotnet publish -c $(Configuration) -f net8.0 --output $(OutputPath)/in-proc8 $(RuntimeIdentifierOption) -p:NoWorkers=True -p:PublishOutOfProcessHost=False --self-contained" />
  </Target>
  <Target Name="PublishInProcNet8" AfterTargets="Publish" Condition="'$(TargetFramework)'=='net6.0' AND '$(SkipInProcessHost)'!='True'">
-  <PropertyGroup>
-  <RuntimeIdentifierOption Condition="'$(RuntimeIdentifier)' != ''">-r $(RuntimeIdentifier)</RuntimeIdentifierOption>
-  </PropertyGroup>
- <Exec Command="dotnet publish -c $(Configuration) -f net8.0 --output $(PublishDir)/in-proc8 $(RuntimeIdentifierOption) -p:NoWorkers=True --self-contained" />
+  <PropertyGroup>
+  <RuntimeIdentifierOption Condition="'$(RuntimeIdentifier)' != ''">-r $(RuntimeIdentifier)</RuntimeIdentifierOption>
+  </PropertyGroup>
+ <Exec Command="dotnet publish -c $(Configuration) -f net8.0 --output $(PublishDir)/in-proc8 $(RuntimeIdentifierOption) -p:NoWorkers=True -p:PublishOutOfProcessHost=False --self-contained" />
  </Target>
 </Project>

test/Azure.Functions.Cli.Tests/Azure.Functions.Cli.Tests.csproj

@@ -24,6 +24,7 @@
  <PackageReference Include="xunit" Version="2.4.0" />
  <PackageReference Include="xunit.runner.visualstudio" Version="2.4.0" />
  <PackageReference Include="Xunit.SkippableFact" Version="1.3.6" />
+ <PackageReference Include="System.IO.Abstractions" Version="2.1.0.227" />
  </ItemGroup>
 
  <ItemGroup>
@@ -45,8 +46,11 @@
  <ItemGroup>
  <ProjectReference Include="..\..\src\Azure.Functions.Cli\Azure.Functions.Cli.csproj" />
  </ItemGroup>
- <!-- The "in-proc8" directory content is created using an msbuild target in "Azure.Functions.Cli" project and they don't automatically gets copied to the test project output directory -->
+ <!-- The "in-proc8" and "out-of-proc" directory content is created using an msbuild target in "Azure.Functions.Cli" project and they don't automatically gets copied to the test project output directory -->
  <Target Name="CopyInProc8" AfterTargets="Build" Condition="'$(TargetFramework)'=='net6.0'">
  <Exec Command="xcopy /Y /I /E &quot;$(MSBuildThisFileDirectory)..\..\src\Azure.Functions.Cli\bin\$(Configuration)\$(TargetFramework)\in-proc8\*&quot; &quot;$(OutDir)in-proc8\&quot;" />
  </Target>
+ <Target Name="CopyOutOfProc" AfterTargets="Build" Condition="'$(TargetFramework)'=='net6.0'">
+ <Exec Command="xcopy /Y /I /E &quot;$(MSBuildThisFileDirectory)..\..\src\Azure.Functions.Cli\bin\$(Configuration)\$(TargetFramework)\out-of-proc\*&quot; &quot;$(OutDir)out-of-proc\&quot;" />
+ </Target>
 </Project>