[#1962] Add newCallbackExecutor to interceptors and override for OpenTracing #2366
+353
−9
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,144 @@ | ||
| /* | ||
| * Copyright (C) 2022 Temporal Technologies, Inc. All Rights Reserved. | ||
| * | ||
| * Copyright (C) 2012-2016 Amazon.com, Inc. or its affiliates. All Rights Reserved. | ||
| * | ||
| * Modifications copyright (C) 2017 Uber Technologies, Inc. | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this material except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
|
|
||
| package io.temporal.opentracing; | ||
|
|
||
| import static org.junit.Assert.assertEquals; | ||
|
|
||
| import io.opentracing.Scope; | ||
| import io.opentracing.Span; | ||
| import io.opentracing.mock.MockSpan; | ||
| import io.opentracing.mock.MockTracer; | ||
| import io.opentracing.util.ThreadLocalScopeManager; | ||
| import io.temporal.activity.ActivityInterface; | ||
| import io.temporal.activity.ActivityMethod; | ||
| import io.temporal.activity.ActivityOptions; | ||
| import io.temporal.client.WorkflowClient; | ||
| import io.temporal.client.WorkflowClientOptions; | ||
| import io.temporal.client.WorkflowOptions; | ||
| import io.temporal.testing.internal.SDKTestWorkflowRule; | ||
| import io.temporal.worker.WorkerFactoryOptions; | ||
| import io.temporal.workflow.*; | ||
| import java.time.Duration; | ||
| import org.junit.After; | ||
| import org.junit.Rule; | ||
| import org.junit.Test; | ||
|
|
||
| public class CallbackContextTest { | ||
|
|
||
| private static final MockTracer mockTracer = | ||
| new MockTracer(new ThreadLocalScopeManager(), MockTracer.Propagator.TEXT_MAP); | ||
|
|
||
| private final OpenTracingOptions OT_OPTIONS = | ||
| OpenTracingOptions.newBuilder().setTracer(mockTracer).build(); | ||
|
|
||
| @Rule | ||
| public SDKTestWorkflowRule testWorkflowRule = | ||
| SDKTestWorkflowRule.newBuilder() | ||
| .setWorkflowClientOptions( | ||
| WorkflowClientOptions.newBuilder() | ||
| .setInterceptors(new OpenTracingClientInterceptor(OT_OPTIONS)) | ||
| .validateAndBuildWithDefaults()) | ||
| .setWorkerFactoryOptions( | ||
| WorkerFactoryOptions.newBuilder() | ||
| .setWorkerInterceptors(new OpenTracingWorkerInterceptor(OT_OPTIONS)) | ||
| .validateAndBuildWithDefaults()) | ||
| .setWorkflowTypes(WorkflowImpl.class) | ||
| .setActivityImplementations(new ActivityImpl()) | ||
| .build(); | ||
|
|
||
| @After | ||
| public void tearDown() { | ||
| mockTracer.reset(); | ||
| } | ||
|
|
||
| @ActivityInterface | ||
| public interface TestActivity { | ||
| @ActivityMethod | ||
| boolean activity(); | ||
| } | ||
|
|
||
| @WorkflowInterface | ||
| public interface TestWorkflow { | ||
| @WorkflowMethod | ||
| String workflow(); | ||
| } | ||
|
|
||
| public static class ActivityImpl implements TestActivity { | ||
| @Override | ||
| public boolean activity() { | ||
| try { | ||
| Thread.sleep(1000); | ||
| } catch (InterruptedException e) { | ||
| throw new RuntimeException(e); | ||
| } | ||
| return true; | ||
| } | ||
| } | ||
|
|
||
| public static class WorkflowImpl implements TestWorkflow { | ||
| private final TestActivity activity = | ||
| Workflow.newActivityStub( | ||
| TestActivity.class, | ||
| ActivityOptions.newBuilder() | ||
| .setStartToCloseTimeout(Duration.ofMinutes(1)) | ||
| .validateAndBuildWithDefaults()); | ||
|
|
||
| @Override | ||
| public String workflow() { | ||
| String workflowSpanId = mockTracer.activeSpan().context().toSpanId(); | ||
| return Async.function(activity::activity) | ||
| .thenCompose( | ||
| (r) -> { | ||
| Span activeSpan = mockTracer.activeSpan(); | ||
ghaskins marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| if (activeSpan != null) { | ||
| String promiseSpanId = activeSpan.context().toSpanId(); | ||
| if (promiseSpanId.equals(workflowSpanId)) { | ||
| return Workflow.newPromise(activeSpan.context().toTraceId()); | ||
| } else { | ||
| return Workflow.newPromise("bad-span"); | ||
| } | ||
| } else { | ||
| return Workflow.newPromise("not-found"); | ||
| } | ||
| }) | ||
| .get(); | ||
| } | ||
| } | ||
|
|
||
| @Test | ||
| public void testCallbackContext() { | ||
| MockSpan span = mockTracer.buildSpan("ClientFunction").start(); | ||
|
|
||
| WorkflowClient client = testWorkflowRule.getWorkflowClient(); | ||
| try (Scope scope = mockTracer.scopeManager().activate(span)) { | ||
| TestWorkflow workflow = | ||
| client.newWorkflowStub( | ||
| TestWorkflow.class, | ||
| WorkflowOptions.newBuilder() | ||
| .setTaskQueue(testWorkflowRule.getTaskQueue()) | ||
| .validateBuildWithDefaults()); | ||
| assertEquals(span.context().toTraceId(), workflow.workflow()); | ||
| } finally { | ||
| span.finish(); | ||
| } | ||
| } | ||
| } | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We can remove this executor and the interceptor for it now since it is not needed
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yeah, I was debating that too. My thought was leaving it would mean any Promise could benefit from the wrapping. Still, my primary concern is supporting propagation to Activity/LocalActivity, so I am happy either way and can remove this. This decision can always be revisited in a later PR if generalizing propagation to any Promise becomes a desired feature.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We can never remove an extension point after we add it. So if it is not needed to solve this problem we shouldn't add it. We can always add it later if the need arises.