Merge pull request #1658 from Azure/dev

Merging dev into main for 2.4.1 release

Author: amdeel

.github/ISSUE_TEMPLATE/new-release-template.md

@@ -3,21 +3,34 @@ name: New release template
 about: Template for creating new releases of Durable Functions
 title: ''
 labels: ''
-assignees: cgillum
+assignees: comcmaho, amdeel, davidmrdavid, bachuv
 
 ---
 
-As part of a release, the following items need to be taken care of. For any items that are not applicable, they should be crossed out using the `~~ ~~` markdown syntax with an explanation.
+**Prep Release: (assigned to:)**
+_Due: <3-business-days-before-release>_
+- [ ] Merge all features and fixes into the `dev` branch
+- [ ] Publish updated versions of DurableTask.Core and DurableTask.AzureStorage to app-service MyGet feed
+- [ ] Update dependencies and increment extension version in the `dev` branch.
+- [ ] Publish signed version of Microsoft.Azure.WebJobs.Extensions.DurableTask to app-service MyGet feed
+- [ ] Close out or punt remaining GitHub issues for the current milestone
+
+
+**Validation (assigned to: )**
+_Due: <2-business-days-before-release>_
+- [ ] Run private performance tests and ensure no regressions
+- [ ] Smoke test Functions V1 and Functions V3 .NET apps
+- [ ] Smoke test JavaScript and Python apps
+- [ ] Check for package size, make sure it's not surprisingly heavier than a previous release
 
-- [ ] Run private scale tests and ensure no regressions
-- [ ] Publish updated versions of [DurableTask.Core](https://www.nuget.org/packages/Microsoft.Azure.DurableTask.Core/) and [DurableTask.AzureStorage](https://www.nuget.org/packages/Microsoft.Azure.DurableTask.AzureStorage/) to nuget.org
-- [ ] Merge all features and fixes into the `master` branch
-- [ ] Update .NET API docs at https://azure.github.io/azure-functions-durable-extension
-- [ ] Publish signed version of [Microsoft.Azure.WebJobs.Extensions.DurableTask](https://www.nuget.org/packages/Microsoft.Azure.WebJobs.Extensions.DurableTask/) to nuget.org
-- [ ] Update samples to point to the latest nuget packages
+
+** Release Completion (assigned to: )**:
+_Due: <release-deadline>_
+- [ ] Push staged package on MyGet to Nuget.org (for Durable Task Framework, you may need to manually update them)
 - [ ] Create a PR in the [Azure Functions templates repo](https://github.com/Azure/azure-functions-templates) to update templates to the latest version
 - [ ] Create a PR in the [Azure Functions bundles repo](https://github.com/Azure/azure-functions-extension-bundles) to update bundles to the latest version
-- [ ] Close out or punt remaining GitHub issues for the current milestone
-- [ ] Update official docs under https://docs.microsoft.com/en-us/azure/azure-functions/durable ([private docs repo for Microsoft employees](http://github.com/MicrosoftDocs/azure-docs-pr))
-- [ ] Publish release notes
+- [ ] Merge all pending PR docs from `pending_docs.md`
+- [ ] Reset `pending_docs.md` and `release_notes.md` in the `dev` branch. You will want to save `release_notes.md` somewhere for when you publish release notes.
+- [ ] Merge `dev` into `main`
+- [ ] Publish release notes from the pre-reset `release_notes.md`
 - [ ] Post announcement on [App Service Announcements GitHub repo](https://github.com/Azure/app-service-announcements) and Twitter.

.github/pull_request_template.md

@@ -0,0 +1,19 @@
+<-- Start the PR description with some context for the change. -->
+
+
+<-- Make sure to delete the markdown comments and the below sections when squash merging -->
+### Issue describing the changes in this PR
+
+resolves #issue_for_this_pr
+
+### Pull request checklist
+
+* [ ] My changes **do not** require documentation changes
+    * [ ] Otherwise: Documentation PR is ready to merge and referenced in `pending_docs.md`
+* [ ] My changes **should not** be added to the release notes for the next release
+    * [ ] Otherwise: I've added my notes to `release_notes.md`
+* [ ] My changes **do not** need to be backported to a previous version
+    * [ ] Otherwise: Backport tracked by issue/PR #issue_or_pr
+* [ ] I have added all required tests (Unit tests, E2E tests)
+
+

pending_docs.md

@@ -0,0 +1,2 @@
+<-- Please include a link to your pending docs PR below. https://docs.microsoft.com/en-us/azure/azure-functions/durable ([private docs repo for Microsoft employees](http://github.com/MicrosoftDocs/azure-docs-pr)). 
+Your code PR should not be merged until your docs PR has been signed off. -->

release_notes.md

@@ -0,0 +1,16 @@
+<!-- Please put your changes into the appropriate category (or categories) below. -->
+
+## New Features
+- Exposed IServiceCollection extension methods AddDurableTaskFactory() for net461 releases so classic .NET Framework apps using the .NET Core model of dependency injection can create their own Durable Clients. (#1653)
+
+## Bug fixes
+- Remove incorrect information from C# docs summary for IDurableEntityClient.ReadEntityStateAsync() regarding states large than 16KB (#1637)
+- Fix a NullReferenceException in IDurableClient.SignalClient() for IDurableClient objects created by the new DurabilityClientFactory (#1644)
+
+## Breaking changes
+
+
+## Dependency Changes 
+- Microsoft.Azure.WebJobs.Extensions.DurableTask.Analyzers --> 0.4.0
+
+Removed dependency on Mono.Posix.NETStandard by instead relying on P/Invoke to generate inotify signals in Linux; reducing the size of the package (#1643)

samples/VSSample.Tests/VSSample.Tests.csproj

@@ -6,7 +6,7 @@
   </PropertyGroup>
 
   <ItemGroup>
-    <PackageReference Include="Microsoft.Azure.WebJobs.Extensions.DurableTask" Version="2.3.*" />
+    <PackageReference Include="Microsoft.Azure.WebJobs.Extensions.DurableTask" Version="2.4.*" />
     <PackageReference Include="Microsoft.NET.Test.Sdk" Version="15.9.0" />
     <PackageReference Include="Moq" Version="4.8.1" />
     <PackageReference Include="xunit" Version="2.4.1" />

samples/correlation-csharp/FunctionAppCorrelation/FunctionAppCorrelation.csproj

@@ -6,12 +6,9 @@
     <RunAnalyzersDuringBuild>true</RunAnalyzersDuringBuild>
   </PropertyGroup>
   <ItemGroup>
-    <PackageReference Include="Microsoft.Azure.WebJobs.Extensions.DurableTask.Telemetry" Version="2.2.0-alpha" />
-    <PackageReference Include="Microsoft.NET.Sdk.Functions" Version="3.0.5" />
-    <PackageReference Include="StyleCop.Analyzers" Version="1.1.118">
-      <PrivateAssets>all</PrivateAssets>
-      <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
-    </PackageReference>
+    <PackageReference Include="Microsoft.Azure.WebJobs.Extensions.DurableTask" Version="2.4.0" />
+    <PackageReference Include="Microsoft.NET.Sdk.Functions" Version="3.0.*" />
+    <PackageReference Include="StyleCop.Analyzers" Version="1.1.118" PrivateAssets="All"/>
   </ItemGroup>
   <ItemGroup>
     <AdditionalFiles Include="..\..\..\.stylecop\stylecop.json" />

samples/correlation-csharp/FunctionAppCorrelation/SimpleCorrelationDemo.cs

@@ -7,7 +7,6 @@
 using System.Linq;
 using System.Net;
 using System.Net.Http;
-using System.Text;
 using System.Threading.Tasks;
 using DurableTask.Core;
 using Microsoft.ApplicationInsights;
@@ -37,7 +36,7 @@ public SimpleCorrelationDemo(TelemetryConfiguration telemetryConfiguration, Http
         public async Task<List<string>> Orchestration_W3C(
            [OrchestrationTrigger] IDurableOrchestrationContext context)
         {
-            if (!CorrelationTraceContext.Current is W3CTraceContext correlationContext)
+            if (!(CorrelationTraceContext.Current is W3CTraceContext correlationContext))
             {
                 throw new InvalidOperationException($"This sample expects a correlation trace context of {nameof(W3CTraceContext)}, but the context isof type {CorrelationTraceContext.Current.GetType()}");
             }
@@ -63,7 +62,6 @@ await context.CallActivityAsync<string>(nameof(this.Hello_W3C), "London"),
         public string Hello_W3C([ActivityTrigger] string name, ILogger log)
         {
             // Send Custom Telemetry
-            var currentActivity = Activity.Current;
             this.telemetryClient.TrackTrace($"Message from Activity: {name}.");
 
             log.LogInformation($"Saying hello to {name}.");

samples/correlation-csharp/FunctionAppCorrelation/SimpleOrchestration.cs

@@ -1,17 +1,12 @@
 // Copyright (c) .NET Foundation. All rights reserved.
 // Licensed under the MIT License. See LICENSE in the project root for license information.
 
-using System;
 using System.Collections.Generic;
-using System.Diagnostics;
-using System.Net.Http;
-using System.Text;
 using System.Threading.Tasks;
 using Microsoft.AspNetCore.Http;
 using Microsoft.AspNetCore.Mvc;
 using Microsoft.Azure.WebJobs;
 using Microsoft.Azure.WebJobs.Extensions.DurableTask;
-using Microsoft.Azure.WebJobs.Extensions.DurableTask.Correlation;
 using Microsoft.Azure.WebJobs.Extensions.Http;
 using Microsoft.Extensions.Logging;
 
@@ -36,7 +31,6 @@ public static async Task<List<string>> SimpleOrchestrator(
         [FunctionName(nameof(SayHello))]
         public static string SayHello([ActivityTrigger] string name, ILogger log)
         {
-            var currentActivity = Activity.Current;
             log.LogInformation($"Saying hello to {name}.");
             return $"Hello {name}!";
         }

samples/correlation-csharp/FunctionAppCorrelation/host.json

@@ -1,17 +1,22 @@
 {
+  "version": "2.0",
   "extensions": {
     "durableTask": {
+      "hubName": "CorrelationTesting",
       "tracing": {
-        "DistributedTracingProtocol": "W3CTraceContext"
+        "distributedTracingEnabled": true,
+        "distributedTracingProtocol": "W3CTraceContext"
       }
     }
   },
   "logging": {
     "applicationInsights": {
+      "samplingSettings": {
+        "isEnabled": false
+      },
       "httpAutoCollectionOptions": {
         "enableW3CDistributedTracing": true
-      } 
+      }
     }
-  },
-  "version": "2.0"
+  }
 }

samples/correlation-csharp/configuration.md

@@ -1,21 +1,21 @@
-# Configuration 
+# Configuration
 
 ## host.json
 
 ### durableTask
 
 #### tracing
 
-| property | Default | Description |
+| Property | Default | Description |
 | -------- | ------- | ----------- |
-| DistributedTracingEnabled  | true | Make it true if you don't need Distributed Tracing for Durable Functions |
-| DistributedTracingProtocol  | HttpCorrelationProtocol | Set Protocol of Distributed Tracing. Possible values are HttpCorrelationProtocol and W3CTraceContext |
+| distributedTracingEnabled  | `false` | When set to `true`, enables the Distributed Tracing feature. |
+| distributedTracingProtocol  | HttpCorrelationProtocol | Sets the protocol used by the Distributed Tracing feature. Possible values are `HttpCorrelationProtocol` and `W3CTraceContext` |
 
 **NOTE:** You need to specify the same protocol as `logging.applicationInsights.httpAutoCollectionOptions.enableW3CDistributedTracing`
 
 ### Sample
 
-Enable Distributed Tracing with W3C Trace Context. 
+The following example host.json file enables distributed tracing with the W3C trace context protocol.
 
 _host.json_
 
@@ -24,15 +24,16 @@ _host.json_
   "extensions": {
     "durableTask": {
       "tracing": {
-        "DistributedTracingProtocol": "W3CTraceContext"
+        "distributedTracingEnabled": true,
+        "distributedTracingProtocol": "W3CTraceContext"
       }
     }
   },
   "logging": {
     "applicationInsights": {
       "httpAutoCollectionOptions": {
         "enableW3CDistributedTracing": true
-      } 
+      }
     }
   },
   "version": "2.0"
@@ -41,18 +42,17 @@ _host.json_
 
 ## AppSettings
 
-You need to specify the Application Insights Instrumentation key on AppSettings or local.settings.json or Environment Variables. 
-
+You need to specify the Application Insights instrumentation key in your app settings, local.settings.json, or environment variables. The name of the setting is `APPINSIGHTS_INSTRUMENTATIONKEY`.
 
 _local.settings.json_ 
 
 ```json
 {
-    "IsEncrypted": false,
+  "IsEncrypted": false,
   "Values": {
     "AzureWebJobsStorage": "UseDevelopmentStorage=true",
     "FUNCTIONS_WORKER_RUNTIME": "dotnet",
-    "APPINSIGHTS_INSTRUMENTATIONKEY": "<YOUR_INSTRUMENTATIONKEY>"
+    "APPINSIGHTS_INSTRUMENTATIONKEY": "<YOUR_INSTRUMENTATION_KEY>"
   }
 }
 ```