Merge branch 'main' into sburckha/dts-entities

# Conflicts:
#	eng/proto
#	src/Worker/Grpc/GrpcDurableTaskWorker.Processor.cs

Author: sebastianburckhardt

.github/workflows/validate-build.yml

@@ -14,16 +14,14 @@ on:
 
 env:
   solution: Microsoft.DurableTask.sln
-  config: Release
+  config: release
 
 jobs:
   build:
-    runs-on: ubuntu-latest
+    runs-on: windows-latest
 
     steps:
     - uses: actions/checkout@v3
-      with:
-        submodules: true
 
     - name: Setup .NET 6.0
       uses: actions/setup-dotnet@v3
@@ -36,19 +34,19 @@ jobs:
         global-json-file: global.json
 
     - name: Restore dependencies
-      run: dotnet restore $solution
+      run: dotnet restore $env:solution
 
     - name: Build
-      run: dotnet build $solution --configuration $config --no-restore -p:FileVersionRevision=$GITHUB_RUN_NUMBER -p:ContinuousIntegrationBuild=true
+      run: dotnet build $env:solution --configuration $env:config --no-restore -p:FileVersionRevision=$env:GITHUB_RUN_NUMBER
 
     - name: Test
-      run: dotnet test $solution --configuration $config --no-build --verbosity normal
+      run: dotnet test $env:solution --configuration $env:config --no-build --verbosity normal
 
     - name: Pack
-      run: dotnet pack $solution --configuration $config --no-build
+      run: dotnet pack $env:solution --configuration $env:config --no-build
 
     - name: Upload
-      uses: actions/upload-artifact@v3
+      uses: actions/upload-artifact@v4
       with:
         name: pkg
         path: out/pkg

.gitmodules

@@ -9,6 +9,12 @@
 ### Microsoft.DurableTask.Worker
 
 - Add new `IDurableTaskWorkerBuilder AddDurableTaskWorker(IServiceCollection, string?)` API
+- Add support for work item history streaming
+
+### Microsoft.DurableTask.Grpc
+
+- Replace submodule for proto files with download script for easier maintenance
+- Update to latest proto files
 
 ## v1.5.0
 

CHANGELOG.md

@@ -36,4 +36,9 @@
     <StrongNamePublicKey>00240000048000009400000006020000002400005253413100040000010001000505410141442095e0b0466df68ac32d158abdf0bd9cf26407d7a9d20b93656530556f23979f20b067628b9baee75fc6bba5c349519585a2852c1843bc61d74c4cbf9d80429cbdcbf609ea70fd62061eb65f40a6c9d505dd71cb119ef51f589a014d3b56159abbc38825fafbd119b6e97ebd9a5f3862a5c06220c680a6ac9eec</StrongNamePublicKey>
   </PropertyGroup>
 
+  <PropertyGroup Condition="'$(ContinuousIntegrationBuild)' == ''">
+    <ContinuousIntegrationBuild Condition="'$(CI)' == 'true'">true</ContinuousIntegrationBuild> <!-- GitHub actions -->
+    <ContinuousIntegrationBuild Condition="'$(TF_BUILD)' == 'true'">true</ContinuousIntegrationBuild> <!-- Azure Devops -->
+  </PropertyGroup>
+
 </Project>

Directory.Build.props

@@ -167,9 +167,7 @@ There are also several features that aren't yet available:
 
 ## Obtaining the Protobuf definitions
 
-This project utilizes git submodules to obtain Protobuf definitions from [durabletask-protobuf](https://github.com/microsoft/durabletask-protobuf). You will need to obtain these to build the project.
-
-To get the definitions, run `git submodule update --init --recursive`
+This project utilizes protobuf definitions from [durabletask-protobuf](https://github.com/microsoft/durabletask-protobuf), which are copied (vendored) into this repository under the `src/Grpc` directory. See the corresponding [README.md](./src/Grpc/README.md) for more information about how to update the protobuf definitions.
 
 ## Contributing
 

README.md

@@ -28,7 +28,6 @@ variables:
 
 steps:
 - checkout: self
-  submodules: true
 
 - task: UseDotNet@2
   displayName: 'Install .NET 6 SDK (ESRP)' # This is needed for ESRP.

azure-pipelines-release.yml

@@ -24,7 +24,6 @@ jobs:
 
       steps:
         - checkout: self
-          submodules: true
 
         - task: UseDotNet@2
           displayName: 'Install .NET 6 SDK (ESRP)' # This is needed for ESRP.

eng/templates/build.yml

@@ -9,26 +9,20 @@ namespace Microsoft.DurableTask.Client;
 /// <summary>
 /// Default builder for <see cref="IDurableTaskClientBuilder" />.
 /// </summary>
-public class DefaultDurableTaskClientBuilder : IDurableTaskClientBuilder
+/// <remarks>
+/// Initializes a new instance of the <see cref="DefaultDurableTaskClientBuilder"/> class.
+/// </remarks>
+/// <param name="name">The name of the builder.</param>
+/// <param name="services">The service collection.</param>
+public class DefaultDurableTaskClientBuilder(string? name, IServiceCollection services) : IDurableTaskClientBuilder
 {
     Type? buildTarget;
 
-    /// <summary>
-    /// Initializes a new instance of the <see cref="DefaultDurableTaskClientBuilder"/> class.
-    /// </summary>
-    /// <param name="name">The name of the builder.</param>
-    /// <param name="services">The service collection.</param>
-    public DefaultDurableTaskClientBuilder(string? name, IServiceCollection services)
-    {
-        this.Name = name ?? Options.DefaultName;
-        this.Services = services;
-    }
-
     /// <inheritdoc/>
-    public string Name { get; }
+    public string Name { get; } = name ?? Options.DefaultName;
 
     /// <inheritdoc/>
-    public IServiceCollection Services { get; }
+    public IServiceCollection Services { get; } = services;
 
     /// <inheritdoc/>
     public Type? BuildTarget

src/Client/Core/DependencyInjection/DefaultDurableTaskClientBuilder.cs

@@ -11,6 +11,7 @@ namespace Microsoft.DurableTask.Client;
 public class DurableTaskClientOptions
 {
     DataConverter dataConverter = JsonDataConverter.Default;
+    bool enableEntitySupport;
 
     /// <summary>
     /// Gets or sets the data converter. Default value is <see cref="JsonDataConverter.Default" />.
@@ -50,7 +51,15 @@ public DataConverter DataConverter
     /// Gets or sets a value indicating whether this client should support entities. If true, all instance ids starting with '@' are reserved for entities,
     /// and validation checks are performed where appropriate.
     /// </summary>
-    public bool EnableEntitySupport { get; set; }
+    public bool EnableEntitySupport
+    {
+        get => this.enableEntitySupport;
+        set
+        {
+            this.enableEntitySupport = value;
+            this.EntitySupportExplicitlySet = true;
+        }
+    }
 
     /// <summary>
     /// Gets a value indicating whether <see cref="DataConverter" /> was explicitly set or not.
@@ -63,6 +72,11 @@ public DataConverter DataConverter
     /// </remarks>
     internal bool DataConverterExplicitlySet { get; private set; }
 
+    /// <summary>
+    /// Gets a value indicating whether <see cref="EnableEntitySupport" /> was explicitly set or not.
+    /// </summary>
+    internal bool EntitySupportExplicitlySet { get; private set; }
+
     /// <summary>
     /// Applies these option values to another.
     /// </summary>
@@ -72,8 +86,15 @@ internal void ApplyTo(DurableTaskClientOptions other)
         if (other is not null)
         {
             // Make sure to keep this up to date as values are added.
-            other.DataConverter = this.DataConverter;
-            other.EnableEntitySupport = this.EnableEntitySupport;
+            if (!other.DataConverterExplicitlySet)
+            {
+                other.DataConverter = this.DataConverter;
+            }
+
+            if (!other.EntitySupportExplicitlySet)
+            {
+                other.EnableEntitySupport = this.EnableEntitySupport;
+            }
         }
     }
 }

src/Client/Core/DurableTaskClientOptions.cs

@@ -11,21 +11,15 @@ namespace Microsoft.DurableTask.Client.Entities;
 /// Represents entity metadata.
 /// </summary>
 /// <typeparam name="TState">The type of state held by the metadata.</typeparam>
+/// <remarks>
+/// Initializes a new instance of the <see cref="EntityMetadata{TState}"/> class.
+/// </remarks>
+/// <param name="id">The ID of the entity.</param>
 [JsonConverter(typeof(EntityMetadataConverter))]
-public class EntityMetadata<TState>
+public class EntityMetadata<TState>(EntityInstanceId id)
 {
     readonly TState? state;
 
-    /// <summary>
-    /// Initializes a new instance of the <see cref="EntityMetadata{TState}"/> class.
-    /// </summary>
-    /// <param name="id">The ID of the entity.</param>
-    public EntityMetadata(EntityInstanceId id)
-    {
-        this.Id = Check.NotDefault(id);
-        this.IncludesState = false;
-    }
-
     /// <summary>
     /// Initializes a new instance of the <see cref="EntityMetadata{TState}"/> class.
     /// </summary>
@@ -41,7 +35,7 @@ public EntityMetadata(EntityInstanceId id, TState? state)
     /// <summary>
     /// Gets the ID for this entity.
     /// </summary>
-    public EntityInstanceId Id { get; }
+    public EntityInstanceId Id { get; } = Check.NotDefault(id);
 
     /// <summary>
     /// Gets the time the entity was last modified.
@@ -64,9 +58,9 @@ public EntityMetadata(EntityInstanceId id, TState? state)
     /// <remarks>
     /// Queries can exclude the state of the entity from the metadata that is retrieved.
     /// </remarks>
-    [MemberNotNullWhen(true, "State")]
-    [MemberNotNullWhen(true, "state")]
-    public bool IncludesState { get; }
+    [MemberNotNullWhen(true, nameof(State))]
+    [MemberNotNullWhen(true, nameof(state))]
+    public bool IncludesState { get; } = false;
 
     /// <summary>
     /// Gets the state for this entity.
@@ -96,16 +90,13 @@ public TState State
 /// <summary>
 /// Represents the metadata for a durable entity instance.
 /// </summary>
+/// <remarks>
+/// Initializes a new instance of the <see cref="EntityMetadata"/> class.
+/// </remarks>
+/// <param name="id">The ID of the entity.</param>
+/// <param name="state">The state of this entity.</param>
 [JsonConverter(typeof(EntityMetadataConverter))]
-public sealed class EntityMetadata : EntityMetadata<SerializedData>
+public sealed class EntityMetadata(EntityInstanceId id, SerializedData? state = null)
+    : EntityMetadata<SerializedData>(id, state)
 {
-    /// <summary>
-    /// Initializes a new instance of the <see cref="EntityMetadata"/> class.
-    /// </summary>
-    /// <param name="id">The ID of the entity.</param>
-    /// <param name="state">The state of this entity.</param>
-    public EntityMetadata(EntityInstanceId id, SerializedData? state = null)
-        : base(id, state)
-    {
-    }
 }