Restore functions.metadata generation (#3246)

Reversed suppression of `functions.metadata` file generation in the SDK targets file, restoring default behavior.

Author: fabiocav

sdk/Sdk/Targets/Microsoft.Azure.Functions.Worker.Sdk.targets

@@ -48,9 +48,7 @@ WARNING:  DO NOT MODIFY this file unless you are knowledgeable about MSBuild and
     <FunctionsEnablePlaceholder Condition="'$(FunctionsEnablePlaceholder)' == ''">false</FunctionsEnablePlaceholder>
     <FunctionsEnableWorkerIndexing Condition="'$(FunctionsEnableWorkerIndexing)' == ''">true</FunctionsEnableWorkerIndexing>
     <FunctionsEnableMetadataSourceGen>$(FunctionsEnableWorkerIndexing)</FunctionsEnableMetadataSourceGen>
-    <FunctionsAutoRegisterGeneratedMetadataProvider>$(FunctionsEnableWorkerIndexing)</FunctionsAutoRegisterGeneratedMetadataProvider>
-    <FunctionsWriteMetadataJson Condition="'$(FunctionsWriteMetadataJson)' == '' AND '$(FunctionsEnableMetadataSourceGen)' == 'true'">false</FunctionsWriteMetadataJson>
-    <FunctionsWriteMetadataJson Condition="'$(FunctionsWriteMetadataJson)' == ''">true</FunctionsWriteMetadataJson>
+    <FunctionsAutoRegisterGeneratedMetadataProvider>$(FunctionsEnableWorkerIndexing)</FunctionsAutoRegisterGeneratedMetadataProvider> 
 
     <FunctionsEnableExecutorSourceGen Condition="'$(FunctionsEnableExecutorSourceGen)' == ''">true</FunctionsEnableExecutorSourceGen>
     <FunctionsAutoRegisterGeneratedFunctionsExecutor Condition="'$(FunctionsAutoRegisterGeneratedFunctionsExecutor)' == ''">true</FunctionsAutoRegisterGeneratedFunctionsExecutor>
@@ -193,10 +191,9 @@ WARNING:  DO NOT MODIFY this file unless you are knowledgeable about MSBuild and
       ReferencePaths="@(ReferencePath)"
       ExtensionsCsProjFilePath="$(ExtensionsCsProj)"
       AzureFunctionsVersion="$(AzureFunctionsVersion)"
-      WriteMetadataFile="$(FunctionsWriteMetadataJson)"
       TargetFrameworkIdentifier="$(TargetFrameworkIdentifier)"
       TargetFrameworkVersion="$(TargetFrameworkVersion)"
-      OutputPath="$(IntermediateOutputPath)" />
+      OutputPath="$(IntermediateOutputPath)"/>
   </Target>
 
   <!-- Generate worker.config.json. -->
@@ -250,8 +247,7 @@ WARNING:  DO NOT MODIFY this file unless you are knowledgeable about MSBuild and
 
     <!-- Hook all these files into CopyToOutputDirectory by appending to _NoneWithTargetPath. -->
     <ItemGroup>
-      <_FunctionsAdditionalFile Include="$(_FunctionsMetadataPath)" Condition="'$(FunctionsWriteMetadataJson)' == 'true'" />
-      <_FunctionsAdditionalFile Include="$(_FunctionsWorkerConfigPath);$(_FunctionsIntermediateExtensionUpdatedJsonPath)" />
+      <_FunctionsAdditionalFile Include="$(_FunctionsMetadataPath);$(_FunctionsWorkerConfigPath);$(_FunctionsIntermediateExtensionUpdatedJsonPath)" />
       <_FunctionsAdditionalFile Include="$(_FunctionsMetadataLoaderExtensionFile)" SubPath="$(_FunctionsExtensionsDirectory)/" />
       <_NoneWithTargetPath Include="@(_FunctionsAdditionalFile)"
         TargetPath="%(_FunctionsAdditionalFile.SubPath)%(Filename)%(Extension)"

sdk/Sdk/Tasks/GenerateFunctionMetadata.cs

@@ -26,8 +26,6 @@ public class GenerateFunctionMetadata : Task
 
         public string? ExtensionsCsProjFilePath { get; set; }
 
-        public bool WriteMetadataFile { get; set; } = true;
-
         [Required]
         public ITaskItem[]? ReferencePaths { get; set; }
 
@@ -69,18 +67,11 @@ public override bool Execute()
 
         private void WriteMetadataWithRetry(IEnumerable<SdkFunctionMetadata> functions)
         {
-            if (!WriteMetadataFile)
-            {
-                Log.LogMessage("Skipping writing function metadata file.");
-                return;
-            }
-
             int attempt = 0;
             while (attempt < 10)
             {
                 try
                 {
-                    Log.LogMessage($"Writing function metadata to {OutputPath} directory.");
                     FunctionMetadataJsonWriter.WriteMetadata(functions, OutputPath!);
                     break;
                 }

sdk/release_notes.md

@@ -4,9 +4,9 @@
 - My change description (#PR/#issue)
 -->
 
-### Microsoft.Azure.Functions.Worker.Sdk <version>
+### Microsoft.Azure.Functions.Worker.Sdk 2.0.7
 
-- <entry>
+- Reversal of change to suppress generation of functions.metadata file
 
 ### Microsoft.Azure.Functions.Worker.Sdk.Generators <version>
 

test/E2ETests/E2ETests/AspNetCore/CancellationEndToEndTests.cs

@@ -37,10 +37,10 @@ public async Task HttpTriggerFunctions_WithCancellationToken_BehaveAsExpected(st
             await TestUtility.RetryAsync(() =>
             {
                 invocationStartLog = _fixture.TestLogs.CoreToolsLogs.Where(p => p.Contains($"Executing 'Functions.{functionName}'"));
-                return Task.FromResult(invocationStartLog.Any());
+                return Task.FromResult(invocationStartLog.Count() >= 1);
             });
 
-            // The task should be cancelled before it completes, mimicking a client closing the connection.
+            // The task should be cancelled before it completes, mimicing a client closing the connection.
             // This should lead to the worker getting an InvocationCancel request from the functions host
             cts.Cancel();
             await Assert.ThrowsAsync<TaskCanceledException>(async () => await task);
@@ -49,13 +49,13 @@ await TestUtility.RetryAsync(() =>
             await TestUtility.RetryAsync(() =>
             {
                 invocationEndLog = _fixture.TestLogs.CoreToolsLogs.Where(p => p.Contains($"Executed 'Functions.{functionName}'"));
-                return Task.FromResult(invocationEndLog.Any());
+                return Task.FromResult(invocationEndLog.Count() >= 1);
             });
 
             Assert.Contains(_fixture.TestLogs.CoreToolsLogs, log => log.Contains(expectedMessage, StringComparison.OrdinalIgnoreCase));
 
             // TODO: 2/3 of the test invocations will fail until the host with the ForwarderProxy fix is released - uncomment this line when the fix is released
-            Assert.NotNull(invocationResult); // just here to 'use' invocationResult to avoid a warning.
+            Assert.NotEqual(null, invocationResult); // just here to 'use' invocationResult to avoid a warning.
             // Assert.Contains(_fixture.TestLogs.CoreToolsLogs, log => log.Contains($"'Functions.{functionName}' ({invocationResult}", StringComparison.OrdinalIgnoreCase));
         }
 

test/E2ETests/E2ETests/Fixtures/FunctionAppFixture.cs

@@ -17,11 +17,11 @@ namespace Microsoft.Azure.Functions.Tests.E2ETests
 {
     public class FunctionAppFixture : IAsyncLifetime
     {
-        private readonly string _testApp = Constants.TestAppNames.E2EApp;
         private readonly ILogger _logger;
         private bool _disposed;
         private Process _funcProcess;
         private JobObjectRegistry _jobObjectRegistry;
+        private string _testApp = Constants.TestAppNames.E2EApp;
 
         public FunctionAppFixture(IMessageSink messageSink)
         {
@@ -32,8 +32,7 @@ public FunctionAppFixture(IMessageSink messageSink)
             _logger = loggerFactory.CreateLogger<FunctionAppFixture>();
         }
 
-        internal FunctionAppFixture(IMessageSink messageSink, string testApp)
-            : this(messageSink)
+        internal FunctionAppFixture(IMessageSink messageSink, string testApp) : this(messageSink)
         {
             _testApp = testApp;
         }

test/Sdk.E2ETests/InnerBuildTests.cs

@@ -1,7 +1,6 @@
 // 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.IO;
 using System.Threading.Tasks;
 using Newtonsoft.Json.Linq;
@@ -10,27 +9,25 @@
 
 namespace Microsoft.Azure.Functions.Sdk.E2ETests
 {
-    public sealed class InnerBuildTests(ITestOutputHelper testOutputHelper) : IDisposable
+    public class InnerBuildTests
     {
-        private readonly ProjectBuilder _builder = new(
-            testOutputHelper,
-            Path.Combine(TestUtility.TestResourcesProjectsRoot, "FunctionApp01", "FunctionApp01.csproj"));
+        private readonly ITestOutputHelper _testOutputHelper;
 
-        [Theory]
-        [InlineData("", false)]
-        [InlineData("-p:FunctionsEnableWorkerIndexing=true", false)]
-        [InlineData("-p:FunctionsEnableWorkerIndexing=true -p:FunctionsWriteMetadataJson=false", false)]
-        [InlineData("-p:FunctionsEnableWorkerIndexing=true -p:FunctionsWriteMetadataJson=true", true)]
-        [InlineData("-p:FunctionsEnableWorkerIndexing=false", true)]
-        [InlineData("-p:FunctionsEnableWorkerIndexing=false -p:FunctionsWriteMetadataJson=false", false)]
-        [InlineData("-p:FunctionsEnableWorkerIndexing=false -p:FunctionsWriteMetadataJson=true", true)]
-        public async Task Build_ScansReferences(string parameters, bool metadataGenerated)
+        public InnerBuildTests(ITestOutputHelper testOutputHelper)
         {
-            await _builder.RestoreAsync();
-            await _builder.BuildAsync(parameters, restore: false);
+            _testOutputHelper = testOutputHelper;
+        }
+
+        [Fact]
+        public async Task Build_ScansReferences()
+        {
+            string outputDir = await TestUtility.InitializeTestAsync(_testOutputHelper, nameof(Build_ScansReferences));
+            string projectFileDirectory = Path.Combine(TestUtility.TestResourcesProjectsRoot, "FunctionApp01", "FunctionApp01.csproj");
+
+            await TestUtility.RestoreAndBuildProjectAsync(projectFileDirectory, outputDir, null, _testOutputHelper);
 
             // Verify extensions.json contents
-            string extensionsJsonPath = Path.Combine(_builder.OutputPath, "extensions.json");
+            string extensionsJsonPath = Path.Combine(outputDir, "extensions.json");
             Assert.True(File.Exists(extensionsJsonPath));
 
             JToken extensionsJsonContents = JObject.Parse(File.ReadAllText(extensionsJsonPath));
@@ -57,13 +54,8 @@ public async Task Build_ScansReferences(string parameters, bool metadataGenerate
             Assert.True(JToken.DeepEquals(expectedExtensionsJson, extensionsJsonContents));
 
             // Verify functions.metadata contents
-            string functionsMetadataPath = Path.Combine(_builder.OutputPath, "functions.metadata");
-            Assert.Equal(metadataGenerated, File.Exists(functionsMetadataPath));
-
-            if (!metadataGenerated)
-            {
-                return;
-            }
+            string functionsMetadataPath = Path.Combine(outputDir, "functions.metadata");
+            Assert.True(File.Exists(functionsMetadataPath));
 
             JToken functionsMetadataContents = JArray.Parse(File.ReadAllText(functionsMetadataPath));
             JToken expectedFunctionsMetadata = JArray.Parse(@"[
@@ -123,7 +115,5 @@ public async Task Build_ScansReferences(string parameters, bool metadataGenerate
 
             Assert.True(JToken.DeepEquals(expectedFunctionsMetadata, functionsMetadataContents));
         }
-
-        public void Dispose() => _builder.Dispose();
     }
 }

test/Sdk.E2ETests/ProcessWrapper.cs

@@ -6,27 +6,26 @@
 using System.Text;
 using System.Threading;
 using System.Threading.Tasks;
+using Xunit.Abstractions;
 
 namespace Microsoft.Azure.Functions.Sdk.E2ETests
 {
-    public static class ProcessWrapper
+    public class ProcessWrapper
     {
-        public static async Task<int?> RunProcessAsync(
-            string fileName, string arguments, string workingDirectory = null, Action<string> log = null)
+
+        public async Task<int?> RunProcess(string fileName, string arguments, string workingDirectory, ITestOutputHelper testOutputHelper = null)
         {
-            return await RunProcessInternalAsync(fileName, arguments, workingDirectory, log);
+            return await RunProcessInternal(fileName, arguments, workingDirectory, testOutputHelper);
         }
 
-        public static async Task<Tuple<int?, string>> RunProcessForOutputAsync(
-            string fileName, string arguments, string workingDirectory = null, Action<string> log = null)
+        public async Task<Tuple<int?, string>> RunProcessForOutput(string fileName, string arguments, string workingDirectory, ITestOutputHelper testOutputHelper = null)
         {
             StringBuilder processOutputStringBuilder = new StringBuilder();
-            var exitCode = await RunProcessInternalAsync(fileName, arguments, workingDirectory, log, processOutputStringBuilder);
+            var exitCode = await RunProcessInternal(fileName, arguments, workingDirectory, testOutputHelper, processOutputStringBuilder);
             return new Tuple<int?,string>(exitCode, processOutputStringBuilder.ToString());
         }
 
-        private static async Task<int?> RunProcessInternalAsync(
-            string fileName, string arguments, string workingDirectory = null, Action<string> log = null, StringBuilder processOutputBuilder = null)
+        private async Task<int?> RunProcessInternal(string fileName, string arguments, string workingDirectory, ITestOutputHelper testOutputHelper = null, StringBuilder processOutputBuilder = null)
         {
 
             SemaphoreSlim processExitSemaphore = new SemaphoreSlim(0, 1);
@@ -54,17 +53,23 @@ public static class ProcessWrapper
             {
                 if (o.Data != null)
                 {
-                    log?.Invoke($"[{DateTime.UtcNow:O}] Error: {o.Data}");
-                    processOutputBuilder?.AppendLine(o.Data);
+                    testOutputHelper.WriteLine($"[{DateTime.UtcNow:O}] Error: {o.Data}");
+                    if (processOutputBuilder != null)
+                    {
+                        processOutputBuilder.AppendLine(o.Data);
+                    }
                 }
             };
 
             testProcess.OutputDataReceived += (s, o) =>
             {
                 if (o.Data != null)
                 {
-                    log?.Invoke($"[{DateTime.UtcNow:O}] {o.Data}");
-                    processOutputBuilder?.AppendLine(o.Data);
+                    testOutputHelper.WriteLine($"[{DateTime.UtcNow:O}] {o.Data}");
+                    if (processOutputBuilder != null)
+                    {
+                        processOutputBuilder.AppendLine(o.Data);
+                    }
                 }
             };
 
@@ -76,7 +81,7 @@ public static class ProcessWrapper
             int wait = 3 * 60 * 1000;
             if (!await processExitSemaphore.WaitAsync(wait))
             {
-               log?.Invoke($"Process '{testProcess.Id}' did not exit in {wait}ms.");
+                testOutputHelper?.WriteLine($"Process '{testProcess.Id}' did not exit in {wait}ms.");
                 testProcess.Kill();
             }