Merge pull request #87 from classmethod/feature/mdc-set-request-before-logbookfilter

MDC の情報を request scope から設定する Filter 追加

Author: katagiri-kazumune

spar-wings-aws-logging/src/main/java/jp/xet/sparwings/aws/ec2/MDCInsertingForRequestServletFilter.java

@@ -0,0 +1,106 @@
+/*
+ * Copyright 2015-2016 the original author or authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file 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 jp.xet.sparwings.aws.ec2;
+
+import java.io.IOException;
+import java.util.Map;
+
+import javax.servlet.Filter;
+import javax.servlet.FilterChain;
+import javax.servlet.ServletException;
+import javax.servlet.ServletRequest;
+import javax.servlet.ServletResponse;
+
+import org.slf4j.MDC;
+
+/**
+ * MDC の情報を request scope から設定する Filter.
+ * 
+ * <p>
+ * 経緯は以下の通り
+ * 1. Springでコントローラーから例外をスローすると2週目のフィルターチェーンが動く
+ * 2. FilterでMDCを操作する際にdoFilterの後MDCをクリアすると、2週目のフィルターチェーンでMDCがクリアされている、という状況になる
+ * 3. 1リクエストに対して1回だけMDCに何かを登録したい場合、OncePerRequestFilterで一度だけMDCにを操作したい
+ *   - つまり、1つのトランザクションに対して1度だけMDCを操作したい場合、同じトランザクションの2回目以降のフィルターチェーンでもMDCを参照したい
+ * 4. 初回のフィルターチェーンでMDCをリクエストスコープにコピー &amp; 2回目以降のフィルターチェーンで
+ *    リクエストスコープにコピーしたMDCをThreadLocalのMDCにセットすることで、
+ *    1回目に組み立てたMDCを2回目以降のフィルターチェーンでも使い回せるようにする
+ * 
+ * 本 Filter は、LogbookFilter の直前に登録する必要があります。
+ * DispatcherType には REQUEST, ASYNC, ERROR を含めてください。
+ * </p>
+ */
+public class MDCInsertingForRequestServletFilter implements Filter {
+	
+	static final String STORED_MDC_KEY =
+			MDCInsertingForRequestServletFilter.class.getName() + "_STORED_MDC_KEY";
+	
+	
+	/**
+	 * filter 処理.
+	 * 
+	 * <p>
+	 * 初回リクエストの場合、以下を行う
+	 * 
+	 * - request scope に MDC の値をコピー
+	 * - 後続の filter 呼び出し
+	 * 
+	 * 2回目以降のリクエストの場合、以下を行う
+	 * 
+	 * - request scope から MDC の値を設定
+	 * - 後続の filter 呼び出し
+	 * - MDC の値をクリア
+	 * 
+	 * </p>
+	 * @param request request
+	 * @param response response
+	 * @param chain chain
+	 * @throws IOException 例外
+	 * @throws ServletException 例外
+	 */
+	@Override
+	public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain)
+			throws IOException, ServletException {
+		
+		@SuppressWarnings("unchecked")
+		Map<String, String> storedMdc = (Map<String, String>) request.getAttribute(STORED_MDC_KEY);
+		if (storedMdc == null) {
+			// request scope に未設定の場合、初回扱い
+			firstTimeDoFilter(request, response, chain);
+		} else {
+			// request scope に設定済みの場合、2回目以降の呼び出し
+			afterSecondTimeDoFilter(request, response, chain, storedMdc);
+		}
+	}
+	
+	private void firstTimeDoFilter(ServletRequest request, ServletResponse response, FilterChain chain)
+			throws IOException, ServletException {
+		// request scope に mdc の値をコピー
+		request.setAttribute(STORED_MDC_KEY, MDC.getCopyOfContextMap());
+		chain.doFilter(request, response);
+	}
+	
+	private void afterSecondTimeDoFilter(ServletRequest request, ServletResponse response, FilterChain chain,
+			Map<String, String> storedMdc) throws IOException, ServletException {
+		// request scope の mdc を MDC に展開
+		MDC.setContextMap(storedMdc);
+		try {
+			chain.doFilter(request, response);
+		} finally {
+			MDC.clear();
+		}
+	}
+}

spar-wings-aws-logging/src/test/java/.gitkeep

@@ -0,0 +1,100 @@
+/*
+ * Copyright 2015-2016 the original author or authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file 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 jp.xet.sparwings.aws.ec2;
+
+import static org.mockito.ArgumentMatchers.any;
+import static org.mockito.ArgumentMatchers.anyString;
+import static org.mockito.ArgumentMatchers.eq;
+import static org.mockito.Mockito.doNothing;
+import static org.mockito.Mockito.never;
+import static org.mockito.Mockito.verify;
+import static org.mockito.Mockito.when;
+
+import java.io.IOException;
+import java.util.HashMap;
+import java.util.Map;
+
+import javax.servlet.FilterChain;
+import javax.servlet.ServletException;
+import javax.servlet.ServletRequest;
+import javax.servlet.ServletResponse;
+
+import org.junit.Test;
+import org.junit.runner.RunWith;
+import org.mockito.Mock;
+import org.mockito.junit.MockitoJUnitRunner;
+
+/**
+ * Test for {@link MDCInsertingForRequestServletFilter}.
+ */
+@RunWith(MockitoJUnitRunner.class)
+public class MDCInsertingForRequestServletFilterTest {
+	
+	@Mock
+	ServletRequest request;
+	
+	@Mock
+	ServletResponse response;
+	
+	@Mock
+	FilterChain chain;
+	
+	
+	/**
+	 * request scope に MDC が存在しない時のテスト.
+	 */
+	@Test
+	public void testDoFilter_FirstTimeDoFilter() throws IOException, ServletException {
+		// setup
+		when(request.getAttribute(anyString())).thenReturn(null);
+		doNothing().when(request).setAttribute(anyString(), any());
+		doNothing().when(chain).doFilter(any(), any());
+		
+		// exercise
+		MDCInsertingForRequestServletFilter sut = new MDCInsertingForRequestServletFilter();
+		sut.doFilter(request, response, chain);
+		
+		// verify
+		verify(request).getAttribute(MDCInsertingForRequestServletFilter.STORED_MDC_KEY);
+		verify(request).setAttribute(eq(MDCInsertingForRequestServletFilter.STORED_MDC_KEY), any()); // 呼べていれば良い
+		verify(chain).doFilter(request, response);
+	}
+	
+	/**
+	 * request scope に MDC が存在する時のテスト.
+	 */
+	@Test
+	public void testDoFilter_AfterSecondTimeDoFilter() throws IOException, ServletException {
+		// setup
+		Map<String, String> storedMdc = new HashMap<>();
+		storedMdc.put("foo", "foo1");
+		storedMdc.put("bar", "bar1");
+		storedMdc.put("baz", "baz1");
+		when(request.getAttribute(anyString())).thenReturn(storedMdc);
+		doNothing().when(chain).doFilter(any(), any());
+		
+		// exercise
+		MDCInsertingForRequestServletFilter sut = new MDCInsertingForRequestServletFilter();
+		sut.doFilter(request, response, chain);
+		
+		// verify
+		verify(request).getAttribute(MDCInsertingForRequestServletFilter.STORED_MDC_KEY);
+		verify(chain).doFilter(request, response);
+		
+		verify(request, never()).setAttribute(any(), any());
+	}
+	
+}