Accept search attributes for dev server (#289)

Fixes #282

Author: cretz

src/Temporalio/Bridge/EphemeralServer.cs

@@ -40,12 +40,12 @@ private unsafe EphemeralServer(
         public bool HasTestService { get; private init; }
 
         /// <summary>
-        /// Start Temporalite.
+        /// Start dev server.
         /// </summary>
         /// <param name="runtime">Runtime to use.</param>
         /// <param name="options">Options to use.</param>
         /// <returns>Started server.</returns>
-        public static async Task<EphemeralServer> StartTemporaliteAsync(
+        public static async Task<EphemeralServer> StartDevServerAsync(
             Runtime runtime,
             Testing.WorkflowEnvironmentStartLocalOptions options)
         {

src/Temporalio/Bridge/OptionsExtensions.cs

@@ -352,6 +352,17 @@ public static unsafe Interop.DevServerOptions ToInteropOptions(
             // Use TargetHost to get IP + Port
             options.ParseTargetHost(out string? ip, out int? port);
             ip ??= "127.0.0.1";
+
+            // If there are search attributes, prepend them to the args
+            var args = options.DevServerOptions.ExtraArgs;
+            if (options.SearchAttributes is { } attrs && attrs.Count > 0)
+            {
+                args = attrs.
+                    SelectMany(v => new[] { "--search-attribute", $"{v.Name}={v.ValueType}" }).
+                    Concat(args ?? Enumerable.Empty<string>()).
+                    ToArray();
+            }
+
             return new Interop.DevServerOptions()
             {
                 test_server = scope.Pointer(
@@ -363,7 +374,7 @@ public static unsafe Interop.DevServerOptions ToInteropOptions(
                         download_version = scope.ByteArray(options.DevServerOptions.DownloadVersion),
                         download_dest_dir = scope.ByteArray(options.DownloadDirectory),
                         port = (ushort)(port ?? 0),
-                        extra_args = scope.NewlineDelimited(options.DevServerOptions.ExtraArgs),
+                        extra_args = scope.NewlineDelimited(args),
                     }),
                 namespace_ = scope.ByteArray(options.Namespace),
                 ip = scope.ByteArray(ip),

src/Temporalio/Testing/WorkflowEnvironment.cs

@@ -67,7 +67,7 @@ public static async Task<WorkflowEnvironment> StartLocalAsync(
         {
             options ??= new();
             var runtime = options.Runtime ?? TemporalRuntime.Default;
-            var server = await Bridge.EphemeralServer.StartTemporaliteAsync(
+            var server = await Bridge.EphemeralServer.StartDevServerAsync(
                 runtime.Runtime,
                 options).ConfigureAwait(false);
             return await StartEphemeralAsync(server, options).ConfigureAwait(false);

src/Temporalio/Testing/WorkflowEnvironmentStartLocalOptions.cs

@@ -1,3 +1,6 @@
+using System.Collections.Generic;
+using Temporalio.Common;
+
 namespace Temporalio.Testing
 {
     /// <summary>
@@ -18,6 +21,11 @@ public class WorkflowEnvironmentStartLocalOptions : Client.TemporalClientConnect
         /// </summary>
         public bool UI { get; set; }
 
+        /// <summary>
+        /// Gets or sets search attributes registered on the dev server on start.
+        /// </summary>
+        public IReadOnlyCollection<SearchAttributeKey>? SearchAttributes { get; set; }
+
         /// <summary>
         /// Gets or sets <b>unstable</b> dev server options.
         /// </summary>

tests/Temporalio.Tests/Testing/WorkflowEnvironmentTests.cs

@@ -7,6 +7,7 @@ namespace Temporalio.Tests.Testing;
 using Temporalio.Activities;
 using Temporalio.Api.Enums.V1;
 using Temporalio.Client;
+using Temporalio.Common;
 using Temporalio.Exceptions;
 using Temporalio.Testing;
 using Temporalio.Worker;
@@ -199,4 +200,54 @@ await env.Client.ExecuteWorkflowAsync(
             });
         });
     }
+
+    [Fact]
+    public async Task StartLocal_SearchAttributes_ProperlyRegistered()
+    {
+        // Prepare attrs
+        var attrBool = SearchAttributeKey.CreateBool("DotNetTemporalTestBool");
+        var attrDateTime = SearchAttributeKey.CreateDateTimeOffset("DotNetTemporalTestDateTime");
+        var attrDouble = SearchAttributeKey.CreateDouble("DotNetTemporalTestDouble");
+        var attrKeyword = SearchAttributeKey.CreateKeyword("DotNetTemporalTestKeyword");
+        var attrKeywordList = SearchAttributeKey.CreateKeywordList("DotNetTemporalTestKeywordList");
+        var attrLong = SearchAttributeKey.CreateLong("DotNetTemporalTestLong");
+        var attrText = SearchAttributeKey.CreateText("DotNetTemporalTestText");
+        var attrVals = new SearchAttributeCollection.Builder().
+            Set(attrBool, true).
+            Set(attrDateTime, new DateTimeOffset(2001, 1, 1, 0, 0, 0, TimeSpan.Zero)).
+            Set(attrDouble, 123.45).
+            Set(attrKeyword, "SomeKeyword").
+            Set(attrKeywordList, new[] { "SomeKeyword1", "SomeKeyword2" }).
+            Set(attrLong, 678).
+            Set(attrText, "SomeText").
+            ToSearchAttributeCollection();
+        var attrs = new SearchAttributeKey[]
+        {
+            attrBool, attrDateTime, attrDouble, attrKeyword, attrKeywordList, attrLong, attrText,
+        };
+
+        // Confirm that when used in env without SAs it fails
+        await using var env1 = await WorkflowEnvironment.StartLocalAsync();
+        var exc = await Assert.ThrowsAsync<RpcException>(
+            () => env1.Client.StartWorkflowAsync(
+                "my-workflow",
+                Array.Empty<object?>(),
+                new(id: $"wf-{Guid.NewGuid()}", taskQueue: $"tq-{Guid.NewGuid()}")
+                {
+                    TypedSearchAttributes = attrVals,
+                }));
+        Assert.Contains("no mapping defined", exc.Message);
+
+        // Confirm that when used in env with SAs it succeeds
+        await using var env2 = await WorkflowEnvironment.StartLocalAsync(
+            new() { SearchAttributes = attrs });
+        var handle = await env2.Client.StartWorkflowAsync(
+            "my-workflow",
+            Array.Empty<object?>(),
+            new(id: $"wf-{Guid.NewGuid()}", taskQueue: $"tq-{Guid.NewGuid()}")
+            {
+                TypedSearchAttributes = attrVals,
+            });
+        Assert.Equal(attrVals, (await handle.DescribeAsync()).TypedSearchAttributes);
+    }
 }