Add update info to MDC context (#2259)

Author: Quinn-With-Two-Ns

temporal-sdk/src/main/java/io/temporal/internal/logging/LoggerTag.java

@@ -38,4 +38,6 @@ private LoggerTag() {}
   public static final String SIDE_EFFECT_ID = "SideEffectId";
   public static final String CHILD_WORKFLOW_ID = "ChildWorkflowId";
   public static final String ATTEMPT = "Attempt";
+  public static final String UPDATE_ID = "UpdateId";
+  public static final String UPDATE_NAME = "UpdateName";
 }

temporal-sdk/src/main/java/io/temporal/internal/sync/SyncWorkflow.java

@@ -32,6 +32,7 @@
 import io.temporal.common.context.ContextPropagator;
 import io.temporal.common.converter.DataConverter;
 import io.temporal.common.converter.DefaultDataConverter;
+import io.temporal.internal.logging.LoggerTag;
 import io.temporal.internal.replay.ReplayWorkflow;
 import io.temporal.internal.replay.ReplayWorkflowContext;
 import io.temporal.internal.replay.WorkflowContext;
@@ -47,6 +48,7 @@
 import javax.annotation.Nullable;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
+import org.slf4j.MDC;
 
 /**
  * SyncWorkflow supports workflows that use synchronous blocking code. An instance is created per
@@ -166,6 +168,8 @@ public void handleUpdate(
         () -> {
           try {
             workflowContext.setCurrentUpdateInfo(updateInfo);
+            MDC.put(LoggerTag.UPDATE_ID, updateInfo.getUpdateId());
+            MDC.put(LoggerTag.UPDATE_NAME, updateInfo.getUpdateName());
             // Skip validator on replay
             if (!callbacks.isReplaying()) {
               try {

temporal-sdk/src/test/java/io/temporal/workflow/LoggerTest.java

@@ -36,6 +36,8 @@
 import java.util.ArrayList;
 import java.util.List;
 import java.util.UUID;
+import java.util.concurrent.CompletableFuture;
+import java.util.concurrent.ExecutionException;
 import org.junit.After;
 import org.junit.Before;
 import org.junit.Test;
@@ -71,13 +73,21 @@ public void tearDown() throws Exception {
 
   @WorkflowInterface
   public interface TestWorkflow {
+    @UpdateMethod
+    void update(String id);
+
     @WorkflowMethod
     void execute(String id);
   }
 
   public static class TestLoggingInWorkflow implements LoggerTest.TestWorkflow {
     private final Logger workflowLogger = Workflow.getLogger(TestLoggingInWorkflow.class);
 
+    @Override
+    public void update(String id) {
+      workflowLogger.info("Updating workflow {}.", id);
+    }
+
     @Override
     public void execute(String id) {
       workflowLogger.info("Start executing workflow {}.", id);
@@ -107,7 +117,7 @@ public void executeChild(String id) {
   }
 
   @Test
-  public void testWorkflowLogger() {
+  public void testWorkflowLogger() throws ExecutionException, InterruptedException {
     Worker worker = env.newWorker(taskQueue);
     worker.registerWorkflowImplementationTypes(
         TestLoggingInWorkflow.class, TestLoggerInChildWorkflow.class);
@@ -122,14 +132,18 @@ public void testWorkflowLogger() {
     LoggerTest.TestWorkflow workflow =
         workflowClient.newWorkflowStub(LoggerTest.TestWorkflow.class, options);
     String wfId = UUID.randomUUID().toString();
-    workflow.execute(wfId);
-
-    assertEquals(1, matchingLines(String.format("Start executing workflow %s.", wfId)));
-    assertEquals(1, matchingLines(String.format("Executing child workflow %s.", wfId)));
-    assertEquals(1, matchingLines(String.format("Done executing workflow %s.", wfId)));
+    CompletableFuture<Void> result = WorkflowClient.execute(workflow::execute, wfId);
+    workflow.update(wfId);
+    result.get();
+
+    assertEquals(1, matchingLines(String.format("Start executing workflow %s.", wfId), false));
+    assertEquals(1, matchingLines(String.format("Executing child workflow %s.", wfId), false));
+    assertEquals(1, matchingLines(String.format("Done executing workflow %s.", wfId), false));
+    // Assert the update log is present
+    assertEquals(1, matchingLines(String.format("Updating workflow %s.", wfId), true));
   }
 
-  private int matchingLines(String message) {
+  private int matchingLines(String message, boolean isUpdateMethod) {
     int i = 0;
     // Make copy to avoid ConcurrentModificationException
     List<ILoggingEvent> list = new ArrayList<>(listAppender.list);
@@ -139,6 +153,10 @@ private int matchingLines(String message) {
         assertTrue(event.getMDCPropertyMap().containsKey(LoggerTag.WORKFLOW_TYPE));
         assertTrue(event.getMDCPropertyMap().containsKey(LoggerTag.RUN_ID));
         assertTrue(event.getMDCPropertyMap().containsKey(LoggerTag.TASK_QUEUE));
+        if (isUpdateMethod) {
+          assertTrue(event.getMDCPropertyMap().containsKey(LoggerTag.UPDATE_ID));
+          assertTrue(event.getMDCPropertyMap().containsKey(LoggerTag.UPDATE_NAME));
+        }
         i++;
       }
     }