From 3f773a58481e72e951cb3e4c54f6607394c82e79 Mon Sep 17 00:00:00 2001
From: Chad Retz <chad@temporal.io>
Date: Thu, 27 Jun 2024 12:18:36 -0500
Subject: [PATCH] Update to use new Semaphore and change name to "Safe"

---
 Directory.Build.props                                |  8 ++++----
 README.md                                            |  2 +-
 TemporalioSamples.sln                                | 12 ++++++------
 .../ClusterManagerActivities.cs                      |  2 +-
 .../ClusterManagerWorkflow.workflow.cs               |  8 +++-----
 .../Program.cs                                       |  2 +-
 .../README.md                                        |  6 +++---
 .../TemporalioSamples.SafeMessageHandlers.csproj}    |  0
 .../ClusterManagerWorkflowTests.cs                   |  4 ++--
 tests/TemporalioSamples.Tests.csproj                 |  2 +-
 10 files changed, 22 insertions(+), 24 deletions(-)
 rename src/{AtomicMessageHandlers => SafeMessageHandlers}/ClusterManagerActivities.cs (96%)
 rename src/{AtomicMessageHandlers => SafeMessageHandlers}/ClusterManagerWorkflow.workflow.cs (97%)
 rename src/{AtomicMessageHandlers => SafeMessageHandlers}/Program.cs (98%)
 rename src/{AtomicMessageHandlers => SafeMessageHandlers}/README.md (67%)
 rename src/{AtomicMessageHandlers/TemporalioSamples.AtomicMessageHandlers.csproj => SafeMessageHandlers/TemporalioSamples.SafeMessageHandlers.csproj} (100%)
 rename tests/{AtomicMessageHandlers => SafeMessageHandlers}/ClusterManagerWorkflowTests.cs (96%)

diff --git a/Directory.Build.props b/Directory.Build.props
index 59f801a..b823259 100644
--- a/Directory.Build.props
+++ b/Directory.Build.props
@@ -19,10 +19,10 @@
   </PropertyGroup>
 
   <ItemGroup>
-    <PackageReference Include="Temporalio" Version="1.1.2" />
-    <PackageReference Include="Temporalio.Extensions.DiagnosticSource" Version="1.1.2" />
-    <PackageReference Include="Temporalio.Extensions.Hosting" Version="1.1.2" />
-    <PackageReference Include="Temporalio.Extensions.OpenTelemetry" Version="1.1.2" />
+    <PackageReference Include="Temporalio" Version="1.2.0" />
+    <PackageReference Include="Temporalio.Extensions.DiagnosticSource" Version="1.2.0" />
+    <PackageReference Include="Temporalio.Extensions.Hosting" Version="1.2.0" />
+    <PackageReference Include="Temporalio.Extensions.OpenTelemetry" Version="1.2.0" />
     <!--
     Can also reference the SDK downloaded to a local directory:
     <ProjectReference Include="$(MSBuildThisFileDirectory)..\temporal-sdk-dotnet\src\Temporalio\Temporalio.csproj" />
diff --git a/README.md b/README.md
index f233dfa..00add92 100644
--- a/README.md
+++ b/README.md
@@ -15,7 +15,6 @@ Prerequisites:
 * [ActivityHeartbeatingCancellation](src/ActivityHeartbeatingCancellation) - How to use heartbeating and cancellation handling in an activity.
 * [ActivitySimple](src/ActivitySimple) - Simple workflow that runs simple activities.
 * [ActivityWorker](src/ActivityWorker) - Use .NET activities from a workflow in another language.
-* [AtomicMessageHandlers](src/AtomicMessageHandlers) - Use `SemaphoreSlim` to ensure operations are atomically processed in a workflow.
 * [AspNet](src/AspNet) - Demonstration of a generic host worker and an ASP.NET workflow starter.
 * [ClientMtls](src/ClientMtls) - How to use client certificate authentication, e.g. for Temporal Cloud.
 * [ContextPropagation](src/ContextPropagation) - Context propagation via interceptors.
@@ -23,6 +22,7 @@ Prerequisites:
 * [Encryption](src/Encryption) - End-to-end encryption with Temporal payload codecs.
 * [Mutex](src/Mutex) - How to implement a mutex as a workflow. Demonstrates how to avoid race conditions or parallel mutually exclusive operations on the same resource.
 * [Polling](src/Polling) - Recommended implementation of an activity that needs to periodically poll an external resource waiting its successful completion.
+* [SafeMessageHandlers](src/SafeMessageHandlers) - Use `Semaphore` to ensure operations are atomically processed in a workflow.
 * [Saga](src/Saga) - Demonstrates how to implement a saga pattern.
 * [Schedules](src/Schedules) - How to schedule workflows to be run at specific times in the future.
 * [SignalsQueries](src/SignalsQueries) - A loyalty program using Signals and Queries.
diff --git a/TemporalioSamples.sln b/TemporalioSamples.sln
index c59810c..3299e81 100644
--- a/TemporalioSamples.sln
+++ b/TemporalioSamples.sln
@@ -55,7 +55,7 @@ Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "TemporalioSamples.WorkflowU
 EndProject
 Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "TemporalioSamples.ContextPropagation", "src\ContextPropagation\TemporalioSamples.ContextPropagation.csproj", "{7B797D20-485F-441D-8E71-AF7E315FA9CF}"
 EndProject
-Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "TemporalioSamples.AtomicMessageHandlers", "src\AtomicMessageHandlers\TemporalioSamples.AtomicMessageHandlers.csproj", "{5E497499-F87C-4DC6-B5DC-F508F31EA172}"
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "TemporalioSamples.SafeMessageHandlers", "src\SafeMessageHandlers\TemporalioSamples.SafeMessageHandlers.csproj", "{FAF5984A-5B1C-4686-B056-A4F2AC0E8EB7}"
 EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution
@@ -151,10 +151,10 @@ Global
 		{7B797D20-485F-441D-8E71-AF7E315FA9CF}.Debug|Any CPU.Build.0 = Debug|Any CPU
 		{7B797D20-485F-441D-8E71-AF7E315FA9CF}.Release|Any CPU.ActiveCfg = Release|Any CPU
 		{7B797D20-485F-441D-8E71-AF7E315FA9CF}.Release|Any CPU.Build.0 = Release|Any CPU
-		{5E497499-F87C-4DC6-B5DC-F508F31EA172}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
-		{5E497499-F87C-4DC6-B5DC-F508F31EA172}.Debug|Any CPU.Build.0 = Debug|Any CPU
-		{5E497499-F87C-4DC6-B5DC-F508F31EA172}.Release|Any CPU.ActiveCfg = Release|Any CPU
-		{5E497499-F87C-4DC6-B5DC-F508F31EA172}.Release|Any CPU.Build.0 = Release|Any CPU
+		{FAF5984A-5B1C-4686-B056-A4F2AC0E8EB7}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{FAF5984A-5B1C-4686-B056-A4F2AC0E8EB7}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{FAF5984A-5B1C-4686-B056-A4F2AC0E8EB7}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{FAF5984A-5B1C-4686-B056-A4F2AC0E8EB7}.Release|Any CPU.Build.0 = Release|Any CPU
 	EndGlobalSection
 	GlobalSection(SolutionProperties) = preSolution
 		HideSolutionNode = FALSE
@@ -184,6 +184,6 @@ Global
 		{B79F07F7-3429-4C58-84C3-08587F748B2D} = {1A647B41-53D0-4638-AE5A-6630BAAE45FC}
 		{B3DB7B8C-7BD3-4A53-A809-AB6279B1A630} = {1A647B41-53D0-4638-AE5A-6630BAAE45FC}
 		{7B797D20-485F-441D-8E71-AF7E315FA9CF} = {1A647B41-53D0-4638-AE5A-6630BAAE45FC}
-		{5E497499-F87C-4DC6-B5DC-F508F31EA172} = {1A647B41-53D0-4638-AE5A-6630BAAE45FC}
+		{FAF5984A-5B1C-4686-B056-A4F2AC0E8EB7} = {1A647B41-53D0-4638-AE5A-6630BAAE45FC}
 	EndGlobalSection
 EndGlobal
diff --git a/src/AtomicMessageHandlers/ClusterManagerActivities.cs b/src/SafeMessageHandlers/ClusterManagerActivities.cs
similarity index 96%
rename from src/AtomicMessageHandlers/ClusterManagerActivities.cs
rename to src/SafeMessageHandlers/ClusterManagerActivities.cs
index 2de96f3..578102d 100644
--- a/src/AtomicMessageHandlers/ClusterManagerActivities.cs
+++ b/src/SafeMessageHandlers/ClusterManagerActivities.cs
@@ -1,4 +1,4 @@
-namespace TemporalioSamples.AtomicMessageHandlers;
+namespace TemporalioSamples.SafeMessageHandlers;
 
 using Microsoft.Extensions.Logging;
 using Temporalio.Activities;
diff --git a/src/AtomicMessageHandlers/ClusterManagerWorkflow.workflow.cs b/src/SafeMessageHandlers/ClusterManagerWorkflow.workflow.cs
similarity index 97%
rename from src/AtomicMessageHandlers/ClusterManagerWorkflow.workflow.cs
rename to src/SafeMessageHandlers/ClusterManagerWorkflow.workflow.cs
index 1f1fc28..6e28117 100644
--- a/src/AtomicMessageHandlers/ClusterManagerWorkflow.workflow.cs
+++ b/src/SafeMessageHandlers/ClusterManagerWorkflow.workflow.cs
@@ -1,11 +1,11 @@
-namespace TemporalioSamples.AtomicMessageHandlers;
+namespace TemporalioSamples.SafeMessageHandlers;
 
 using Microsoft.Extensions.Logging;
 using Temporalio.Exceptions;
 using Temporalio.Workflows;
 
 [Workflow]
-public sealed class ClusterManagerWorkflow : IDisposable
+public class ClusterManagerWorkflow
 {
     public record State
     {
@@ -29,7 +29,7 @@ public record Result(
         int MaxAssignedNodes,
         int NumAssignedNodes);
 
-    private readonly SemaphoreSlim nodesLock = new(1, 1);
+    private readonly Semaphore nodesLock = new(1);
     private readonly int maxHistoryLength;
     private readonly TimeSpan sleepInterval;
 
@@ -167,8 +167,6 @@ await Workflow.ExecuteActivityAsync(
         }
     }
 
-    public void Dispose() => nodesLock.Dispose();
-
     private int NumAssignedNodes =>
         CurrentState.Nodes.Count(kvp => kvp.Value is { } val && val != "BAD!");
 
diff --git a/src/AtomicMessageHandlers/Program.cs b/src/SafeMessageHandlers/Program.cs
similarity index 98%
rename from src/AtomicMessageHandlers/Program.cs
rename to src/SafeMessageHandlers/Program.cs
index 4fa488f..a0dd21d 100644
--- a/src/AtomicMessageHandlers/Program.cs
+++ b/src/SafeMessageHandlers/Program.cs
@@ -2,7 +2,7 @@
 using Temporalio.Api.Enums.V1;
 using Temporalio.Client;
 using Temporalio.Worker;
-using TemporalioSamples.AtomicMessageHandlers;
+using TemporalioSamples.SafeMessageHandlers;
 
 // Create a client to localhost on default namespace
 using var loggerFactory = LoggerFactory.Create(builder =>
diff --git a/src/AtomicMessageHandlers/README.md b/src/SafeMessageHandlers/README.md
similarity index 67%
rename from src/AtomicMessageHandlers/README.md
rename to src/SafeMessageHandlers/README.md
index 3efafe3..f0924a2 100644
--- a/src/AtomicMessageHandlers/README.md
+++ b/src/SafeMessageHandlers/README.md
@@ -1,7 +1,7 @@
-# Atomic Message Handlers
+# Safe Message Handlers
 
-This sample shows a workflow using `SemaphoreSlim` to atomically process certain blocks of workflow code to prevent data
-race issues. The sample code demonstrates assigning cluster nodes to jobs atomically.
+This sample shows a workflow using `Temporalio.Workflows.Semaphore` to atomically process certain blocks of workflow
+code to prevent data race issues. The sample code demonstrates assigning cluster nodes to jobs atomically.
 
 To run, first see [README.md](../../README.md) for prerequisites. Then, run the following from this directory
 in a separate terminal to start the worker:
diff --git a/src/AtomicMessageHandlers/TemporalioSamples.AtomicMessageHandlers.csproj b/src/SafeMessageHandlers/TemporalioSamples.SafeMessageHandlers.csproj
similarity index 100%
rename from src/AtomicMessageHandlers/TemporalioSamples.AtomicMessageHandlers.csproj
rename to src/SafeMessageHandlers/TemporalioSamples.SafeMessageHandlers.csproj
diff --git a/tests/AtomicMessageHandlers/ClusterManagerWorkflowTests.cs b/tests/SafeMessageHandlers/ClusterManagerWorkflowTests.cs
similarity index 96%
rename from tests/AtomicMessageHandlers/ClusterManagerWorkflowTests.cs
rename to tests/SafeMessageHandlers/ClusterManagerWorkflowTests.cs
index 94a2301..00e2e00 100644
--- a/tests/AtomicMessageHandlers/ClusterManagerWorkflowTests.cs
+++ b/tests/SafeMessageHandlers/ClusterManagerWorkflowTests.cs
@@ -1,8 +1,8 @@
-namespace TemporalioSamples.AtomicMessageHandlers;
+namespace TemporalioSamples.Tests.SafeMessageHandlers;
 
 using Temporalio.Client;
 using Temporalio.Worker;
-using TemporalioSamples.Tests;
+using TemporalioSamples.SafeMessageHandlers;
 using Xunit;
 using Xunit.Abstractions;
 
diff --git a/tests/TemporalioSamples.Tests.csproj b/tests/TemporalioSamples.Tests.csproj
index e19a86b..a13ca8e 100644
--- a/tests/TemporalioSamples.Tests.csproj
+++ b/tests/TemporalioSamples.Tests.csproj
@@ -21,10 +21,10 @@
   <ItemGroup>
     <ProjectReference Include="..\src\ActivitySimple\TemporalioSamples.ActivitySimple.csproj" />
     <ProjectReference Include="..\src\ActivityWorker\TemporalioSamples.ActivityWorker.csproj" />
-    <ProjectReference Include="..\src\AtomicMessageHandlers\TemporalioSamples.AtomicMessageHandlers.csproj" />
     <ProjectReference Include="..\src\ContextPropagation\TemporalioSamples.ContextPropagation.csproj" />
     <ProjectReference Include="..\src\Encryption\Codec\TemporalioSamples.Encryption.Codec.csproj" />
     <ProjectReference Include="..\src\Encryption\CodecServer\TemporalioSamples.Encryption.CodecServer.csproj" />
+    <ProjectReference Include="..\src\SafeMessageHandlers\TemporalioSamples.SafeMessageHandlers.csproj" />
     <ProjectReference Include="..\src\WorkflowUpdate\TemporalioSamples.WorkflowUpdate.csproj" />
   </ItemGroup>