feat(selfop): add opt-in test query timing diagnostics
This commit is contained in:
+123
@@ -0,0 +1,123 @@
|
||||
package com.baiyue.lastleg.selfoperated.analytics.query.diagnostics;
|
||||
|
||||
import com.fasterxml.jackson.databind.ObjectMapper;
|
||||
import jakarta.servlet.ServletException;
|
||||
import org.apache.ibatis.cache.CacheKey;
|
||||
import org.apache.ibatis.executor.Executor;
|
||||
import org.apache.ibatis.executor.statement.StatementHandler;
|
||||
import org.apache.ibatis.mapping.*;
|
||||
import org.apache.ibatis.session.*;
|
||||
import org.junit.jupiter.api.*;
|
||||
import org.slf4j.MDC;
|
||||
import org.springframework.boot.test.context.runner.ApplicationContextRunner;
|
||||
import org.springframework.boot.web.servlet.FilterRegistrationBean;
|
||||
import org.springframework.mock.web.*;
|
||||
import java.sql.Statement;
|
||||
import java.util.*;
|
||||
import java.util.concurrent.*;
|
||||
import static org.junit.jupiter.api.Assertions.*;
|
||||
import static org.mockito.Mockito.*;
|
||||
import static org.mockito.ArgumentMatchers.*;
|
||||
|
||||
class QueryDiagnosticsTest {
|
||||
private static final String BASE="/api/platform/v1/last-leg/self-operated-analytics/";
|
||||
private static final String ID=QueryDiagnostics.PREFIX+"DashboardReadMapper.report";
|
||||
@AfterEach void cleanup() { QueryDiagnostics.CURRENT.remove(); MDC.clear(); }
|
||||
|
||||
@Test void onlyExplicitTestAndEnabledCreatesBeans() {
|
||||
var runner=new ApplicationContextRunner().withUserConfiguration(QueryDiagnosticsConfiguration.class);
|
||||
runner.run(c->assertEquals(0,c.getBeansOfType(QueryDiagnosticsInterceptor.class).size()));
|
||||
runner.withPropertyValues("DEPLOY_ENV=test").run(c->assertEquals(0,c.getBeansOfType(FilterRegistrationBean.class).size()));
|
||||
runner.withPropertyValues("DEPLOY_ENV=production","baiyue.self-operated-analytics.query-diagnostics.enabled=true")
|
||||
.run(c->assertEquals(0,c.getBeansOfType(QueryDiagnosticsInterceptor.class).size()));
|
||||
runner.withPropertyValues("baiyue.self-operated-analytics.query-diagnostics.enabled=true")
|
||||
.run(c->assertEquals(0,c.getBeansOfType(QueryDiagnosticsInterceptor.class).size()));
|
||||
runner.withPropertyValues("DEPLOY_ENV=test","baiyue.self-operated-analytics.query-diagnostics.enabled=true")
|
||||
.run(c->{assertEquals(1,c.getBeansOfType(QueryDiagnosticsInterceptor.class).size());assertEquals(1,c.getBeansOfType(FilterRegistrationBean.class).size());});
|
||||
}
|
||||
|
||||
@Test void pathsAndMethodsAreExactAndExceptionsCleanRequestState() throws Exception {
|
||||
List<String> lines=new ArrayList<>();var filter=new QueryDiagnosticsFilter(lines::add);
|
||||
for(String path:List.of("dashboard/extra","sku-daily-series","collection-status"))
|
||||
filter.doFilter(new MockHttpServletRequest("GET",BASE+path),new MockHttpServletResponse(),(a,b)->assertNull(QueryDiagnostics.CURRENT.get()));
|
||||
filter.doFilter(new MockHttpServletRequest("POST",BASE+"dashboard"),new MockHttpServletResponse(),(a,b)->assertNull(QueryDiagnostics.CURRENT.get()));
|
||||
assertTrue(lines.isEmpty());
|
||||
var failure=new ServletException("PRIVATE_TOKEN");
|
||||
var caught=assertThrows(ServletException.class,()->filter.doFilter(new MockHttpServletRequest("GET",BASE+"dashboard"),
|
||||
new MockHttpServletResponse(),(a,b)->{assertNotNull(QueryDiagnostics.CURRENT.get());throw failure;}));
|
||||
assertSame(failure,caught);assertNull(QueryDiagnostics.CURRENT.get());
|
||||
assertTrue(new ObjectMapper().readTree(lines.get(0)).get("escapedException").asBoolean());
|
||||
assertFalse(lines.get(0).contains("PRIVATE_TOKEN"));
|
||||
var badSink=new QueryDiagnosticsFilter(s->{throw new IllegalStateException("PRIVATE");});
|
||||
assertSame(failure,assertThrows(ServletException.class,()->badSink.doFilter(new MockHttpServletRequest("GET",BASE+"dashboard"),
|
||||
new MockHttpServletResponse(),(a,b)->{throw failure;})));
|
||||
assertNull(QueryDiagnostics.CURRENT.get());
|
||||
}
|
||||
|
||||
private static MappedStatement statement(String id) {
|
||||
var config=new Configuration();
|
||||
return new MappedStatement.Builder(config,id,p->new BoundSql(config,"SELECT PRIVATE_SQL",List.of(),p),SqlCommandType.SELECT).build();
|
||||
}
|
||||
|
||||
@Test void cacheHitCountsExecutorButNoStatementAndDoesNotExposeParameters() throws Exception {
|
||||
var plugin=new QueryDiagnosticsInterceptor();var executor=(Executor)plugin.plugin(mock(Executor.class));
|
||||
List<String> lines=new ArrayList<>();var filter=new QueryDiagnosticsFilter(lines::add);
|
||||
MDC.put("requestId","synthetic-request-1");
|
||||
var request=new MockHttpServletRequest("GET",BASE+"sku-sales-summary");request.setQueryString("sourceAccount=PRIVATE_ACCOUNT");
|
||||
request.addHeader("Authorization","PRIVATE_TOKEN");
|
||||
filter.doFilter(request,new MockHttpServletResponse(),(a,b)->{
|
||||
try { executor.query(statement(ID),Map.of("sku","PRIVATE_SKU"),RowBounds.DEFAULT,null); }
|
||||
catch(java.sql.SQLException e){throw new ServletException(e);}
|
||||
});
|
||||
var json=new ObjectMapper().readTree(lines.get(0));var timing=json.path("methods").path("DashboardReadMapper.report");
|
||||
assertEquals(1,timing.path("executor").path("calls").asInt());assertEquals(0,timing.path("statement").path("calls").asInt());
|
||||
assertEquals("synthetic-request-1",json.path("requestId").asText());assertEquals("SUMMARY",json.path("endpoint").asText());
|
||||
assertFalse(lines.get(0).contains("PRIVATE"));assertFalse(lines.get(0).contains("\n"));assertNull(QueryDiagnostics.CURRENT.get());
|
||||
}
|
||||
|
||||
@Test void nestedExecutorAndStatementAreNotDoubleCountedAndFailureIsPreserved() throws Exception {
|
||||
var plugin=new QueryDiagnosticsInterceptor();var delegate=mock(Executor.class);
|
||||
var executor=(Executor)plugin.plugin(delegate);var ms=statement(ID);var bound=ms.getBoundSql(null);
|
||||
var statementDelegate=mock(StatementHandler.class);var handler=(StatementHandler)plugin.plugin(statementDelegate);
|
||||
var state=new QueryDiagnostics.State();QueryDiagnostics.CURRENT.set(state);
|
||||
when(delegate.query(eq(ms),any(),eq(RowBounds.DEFAULT),isNull())).thenAnswer(i->
|
||||
executor.query(ms,i.getArgument(1),RowBounds.DEFAULT,null,new CacheKey(),bound));
|
||||
when(delegate.query(eq(ms),any(),eq(RowBounds.DEFAULT),isNull(),any(CacheKey.class),eq(bound)))
|
||||
.thenAnswer(i->handler.query(mock(Statement.class),null));
|
||||
var innerDelegate=mock(StatementHandler.class);var innerHandler=(StatementHandler)plugin.plugin(innerDelegate);
|
||||
when(innerDelegate.query(any(),isNull())).thenReturn(List.of());
|
||||
when(statementDelegate.query(any(),isNull())).thenAnswer(i->innerHandler.query(i.getArgument(0),null));
|
||||
executor.query(ms,Map.of("secret","PRIVATE"),RowBounds.DEFAULT,null);
|
||||
var timing=state.methods.get("DashboardReadMapper.report");
|
||||
assertEquals(1,timing.executor.calls);assertEquals(1,timing.statement.calls);assertTrue(state.frames.isEmpty());
|
||||
var failure=new java.sql.SQLException("PRIVATE_SQL_FAILURE");
|
||||
when(statementDelegate.query(any(),isNull())).thenThrow(failure);
|
||||
assertSame(failure,assertThrows(java.sql.SQLException.class,()->executor.query(ms,Map.of(),RowBounds.DEFAULT,null)));
|
||||
assertEquals(2,timing.executor.calls);assertEquals(2,timing.statement.calls);
|
||||
assertEquals(1,timing.executor.failures);assertEquals(1,timing.statement.failures);
|
||||
assertTrue(state.frames.isEmpty());assertEquals(0,state.statementDepth);
|
||||
executor.query(statement("other.Mapper.privateMethod"),Map.of(),RowBounds.DEFAULT,null);
|
||||
assertEquals(1,state.methods.size());
|
||||
}
|
||||
|
||||
@Test void concurrentRequestsHaveIndependentStateAndCleanup() throws Exception {
|
||||
var ready=new CyclicBarrier(2);var pool=Executors.newFixedThreadPool(2);
|
||||
try {
|
||||
List<Future<String>> futures=new ArrayList<>();
|
||||
for(int index=0;index<2;index++){final int n=index;futures.add(pool.submit(()->{
|
||||
List<String> lines=new ArrayList<>();MDC.put("requestId","request-"+n);
|
||||
try {
|
||||
new QueryDiagnosticsFilter(lines::add).doFilter(new MockHttpServletRequest("GET",BASE+"inventory-coverage"),new MockHttpServletResponse(),(a,b)->{
|
||||
var state=QueryDiagnostics.CURRENT.get();state.timing("AnalyticsReadMapper.inventoryPage").executor.add(n+1,false);
|
||||
try{ready.await(5,TimeUnit.SECONDS);}catch(Exception e){throw new ServletException(e);}
|
||||
assertSame(state,QueryDiagnostics.CURRENT.get());
|
||||
});
|
||||
assertNull(QueryDiagnostics.CURRENT.get());return lines.get(0);
|
||||
} finally {MDC.clear();}
|
||||
}));}
|
||||
for(int i=0;i<2;i++){var json=new ObjectMapper().readTree(futures.get(i).get(10,TimeUnit.SECONDS));
|
||||
assertEquals("request-"+i,json.path("requestId").asText());
|
||||
assertEquals(i+1,json.path("methods").path("AnalyticsReadMapper.inventoryPage").path("executor").path("nanos").asLong());}
|
||||
} finally {pool.shutdownNow();}
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user