/** * @return A {@link BiFunction} that wraps the given original so that the <b>current thread's</b> tracing and MDC * information is registered with the thread and therefore available during execution and unregistered after * execution. * * <p>NOTE: The current thread's tracing and MDC info will be extracted using {@link * Tracer#getCurrentSpanStackCopy()} and {@link MDC#getCopyOfContextMap()}. */ default <T, U, R> BiFunction<T, U, R> biFunctionWithTracing(BiFunction<T, U, R> fn) { return new BiFunctionWithTracing<>(fn); }
/** * @return A {@link BiFunction} that wraps the given original so that the given distributed tracing and MDC * information is registered with the thread and therefore available during execution and unregistered after * execution. */ default <T, U, R> BiFunction<T, U, R> biFunctionWithTracing(BiFunction<T, U, R> fn, Deque<Span> spanStackToLink, Map<String, String> mdcContextMapToLink) { return new BiFunctionWithTracing<>(fn, spanStackToLink, mdcContextMapToLink); }
/** * @return A {@link BiFunction} that wraps the given original so that the given distributed tracing and MDC * information is registered with the thread and therefore available during execution and unregistered after * execution. You can pass in a {@link TracingState} for clearer less verbose code since it extends * {@code Pair<Deque<Span>, Map<String, String>>}. */ default <T, U, R> BiFunction<T, U, R> biFunctionWithTracing( BiFunction<T, U, R> fn, Pair<Deque<Span>, Map<String, String>> threadInfoToLink ) { return new BiFunctionWithTracing<>(fn, threadInfoToLink); }
/** * Equivalent to calling {@code new BiFunctionWithTracing(origBiFunction)} - this allows you to do a static method * import for cleaner looking code in some cases. This method ultimately extracts the current tracing and MDC * information from the current thread using {@link Tracer#getCurrentSpanStackCopy()} and {@link * MDC#getCopyOfContextMap()}. That tracing and MDC information will be associated with the thread when the given * operation is executed. * * <p>The operation you pass in cannot be null (an {@link IllegalArgumentException} will be thrown if you pass in * null for the operation). * * @return {@code new BiFunctionWithTracing(origBiFunction)}. * @see BiFunctionWithTracing#BiFunctionWithTracing(BiFunction) * @see BiFunctionWithTracing */ public static <T, U, R> BiFunctionWithTracing<T, U, R> withTracing(BiFunction<T, U, R> origBiFunction) { return new BiFunctionWithTracing<>(origBiFunction); }
/** * Equivalent to calling {@code * new BiFunctionWithTracing(origBiFunction, spanStackForExecution, mdcContextMapForExecution)} - * this allows you to do a static method import for cleaner looking code in some cases. This method uses the given * trace and MDC information, which will be associated with the thread when the given operation is executed. * * <p>The operation you pass in cannot be null (an {@link IllegalArgumentException} will be thrown if you pass in * null for the operation). * * <p>The trace and/or MDC info can be null and no error will be thrown, however any trace or MDC info that is null * means the corresponding info will not be available to the thread when the operation is executed. * * @return {@code new BiFunctionWithTracing(origBiFunction, spanStackForExecution, mdcContextMapForExecution)}. * @see BiFunctionWithTracing#BiFunctionWithTracing(BiFunction, Deque, Map) * @see BiFunctionWithTracing */ public static <T, U, R> BiFunctionWithTracing<T, U, R> withTracing(BiFunction<T, U, R> origBiFunction, Deque<Span> spanStackForExecution, Map<String, String> mdcContextMapForExecution) { return new BiFunctionWithTracing<>(origBiFunction, spanStackForExecution, mdcContextMapForExecution); }
/** * Equivalent to calling {@code new BiFunctionWithTracing(origBiFunction, originalThreadInfo)} - this allows you * to do a static method import for cleaner looking code in some cases. This method uses the given trace and MDC * information, which will be associated with the thread when the given operation is executed. * * <p>The operation you pass in cannot be null (an {@link IllegalArgumentException} will be thrown if you pass in * null for the operation). * * <p>The {@link Pair} can be null, or you can pass null for the left and/or right side of the pair, and no error * will be thrown. Any trace or MDC info that is null means the corresponding info will not be available to the * thread when the operation is executed however. * * <p>You can pass in a {@link TracingState} for clearer less verbose code since it extends * {@code Pair<Deque<Span>, Map<String, String>>}. * * @return {@code new BiFunctionWithTracing(origBiFunction, originalThreadInfo)}. * @see BiFunctionWithTracing#BiFunctionWithTracing(BiFunction, Pair) * @see BiFunctionWithTracing */ public static <T, U, R> BiFunctionWithTracing<T, U, R> withTracing( BiFunction<T, U, R> origBiFunction, Pair<Deque<Span>, Map<String, String>> originalThreadInfo ) { return new BiFunctionWithTracing<>(origBiFunction, originalThreadInfo); }
@Test public void constructors_throw_exception_if_passed_null_operator() { // given final Deque<Span> spanStackMock = mock(Deque.class); final Map<String, String> mdcInfoMock = mock(Map.class); // expect assertThat(catchThrowable(() -> new BiFunctionWithTracing(null))) .isInstanceOf(IllegalArgumentException.class); assertThat(catchThrowable(() -> withTracing(null))) .isInstanceOf(IllegalArgumentException.class); // and expect assertThat(catchThrowable(() -> new BiFunctionWithTracing(null, Pair.of(spanStackMock, mdcInfoMock)))) .isInstanceOf(IllegalArgumentException.class); assertThat(catchThrowable(() -> withTracing(null, Pair.of(spanStackMock, mdcInfoMock)))) .isInstanceOf(IllegalArgumentException.class); // and expect assertThat(catchThrowable(() -> new BiFunctionWithTracing(null, spanStackMock, mdcInfoMock))) .isInstanceOf(IllegalArgumentException.class); assertThat(catchThrowable(() -> withTracing(null, spanStackMock, mdcInfoMock))) .isInstanceOf(IllegalArgumentException.class); }
@DataProvider(value = { "true", "false" }) @Test public void kitchen_sink_constructor_sets_fields_as_expected(boolean useStaticFactory) { // given Deque<Span> spanStackMock = mock(Deque.class); Map<String, String> mdcInfoMock = mock(Map.class); // when BiFunctionWithTracing instance = (useStaticFactory) ? withTracing(biFunctionMock, spanStackMock, mdcInfoMock) : new BiFunctionWithTracing(biFunctionMock, spanStackMock, mdcInfoMock); // then assertThat(instance.origBiFunction).isSameAs(biFunctionMock); assertThat(instance.spanStackForExecution).isEqualTo(spanStackMock); assertThat(instance.mdcContextMapForExecution).isEqualTo(mdcInfoMock); }
@DataProvider(value = { "true", "false" }) @Test public void pair_constructor_sets_fields_as_expected_when_pair_is_null(boolean useStaticFactory) { // when BiFunctionWithTracing instance = (useStaticFactory) ? withTracing(biFunctionMock, (Pair)null) : new BiFunctionWithTracing(biFunctionMock, (Pair)null); // then assertThat(instance.origBiFunction).isSameAs(biFunctionMock); assertThat(instance.spanStackForExecution).isNull(); assertThat(instance.mdcContextMapForExecution).isNull(); }
@DataProvider(value = { "true | true | true", "true | false | true", "false | true | true", "false | false | true", "true | true | false", "true | false | false", "false | true | false", "false | false | false", }, splitBy = "\\|") @Test public void pair_constructor_sets_fields_as_expected( boolean nullSpanStack, boolean nullMdcInfo, boolean useStaticFactory ) { // given Deque<Span> spanStackMock = (nullSpanStack) ? null : mock(Deque.class); Map<String, String> mdcInfoMock = (nullMdcInfo) ? null : mock(Map.class); // when BiFunctionWithTracing instance = (useStaticFactory) ? withTracing(biFunctionMock, Pair.of(spanStackMock, mdcInfoMock)) : new BiFunctionWithTracing(biFunctionMock, Pair.of(spanStackMock, mdcInfoMock) ); // then assertThat(instance.origBiFunction).isSameAs(biFunctionMock); assertThat(instance.spanStackForExecution).isEqualTo(spanStackMock); assertThat(instance.mdcContextMapForExecution).isEqualTo(mdcInfoMock); }
@DataProvider(value = { "true", "false" }) @Test public void current_thread_info_constructor_sets_fields_as_expected(boolean useStaticFactory) { // given Tracer.getInstance().startRequestWithRootSpan("request-" + UUID.randomUUID().toString()); Deque<Span> spanStackMock = Tracer.getInstance().getCurrentSpanStackCopy(); Map<String, String> mdcInfoMock = MDC.getCopyOfContextMap(); // when BiFunctionWithTracing instance = (useStaticFactory) ? withTracing(biFunctionMock) : new BiFunctionWithTracing(biFunctionMock); // then assertThat(instance.origBiFunction).isSameAs(biFunctionMock); assertThat(instance.spanStackForExecution).isEqualTo(spanStackMock); assertThat(instance.mdcContextMapForExecution).isEqualTo(mdcInfoMock); }
Deque<Span> spanStack = Tracer.getInstance().getCurrentSpanStackCopy(); Map<String, String> mdcInfo = MDC.getCopyOfContextMap(); BiFunctionWithTracing instance = new BiFunctionWithTracing( biFunctionMock, spanStack, mdcInfo );