Skip to content

Commit e7e1e83

Browse files
committed
[ISSUE #7981] Fix dynamic match cache eligibility
1 parent 862f5e3 commit e7e1e83

2 files changed

Lines changed: 97 additions & 4 deletions

File tree

‎shenyu-plugin/shenyu-plugin-base/src/main/java/org/apache/shenyu/plugin/base/AbstractShenyuPlugin.java‎

Lines changed: 21 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -195,6 +195,23 @@ private void cacheRuleData(final String path, final RuleData ruleData) {
195195
}
196196
}
197197

198+
private boolean canCacheSelectorMatch(final Collection<SelectorData> selectors) {
199+
return selectors.stream()
200+
.filter(selector -> Boolean.TRUE.equals(selector.getEnabled()))
201+
.allMatch(selector -> hasOnlyUriConditions(selector.getConditionList()));
202+
}
203+
204+
private boolean canCacheRuleMatch(final Collection<RuleData> rules) {
205+
return rules.stream()
206+
.filter(rule -> Boolean.TRUE.equals(rule.getEnabled()))
207+
.allMatch(rule -> hasOnlyUriConditions(rule.getConditionDataList()));
208+
}
209+
210+
private boolean hasOnlyUriConditions(final Collection<ConditionData> conditions) {
211+
return CollectionUtils.isNotEmpty(conditions)
212+
&& conditions.stream().allMatch(condition -> URI_CONDITION_TYPE.equals(condition.getParamType()));
213+
}
214+
198215
private RuleData defaultRuleData(final SelectorData selectorData) {
199216
RuleData ruleData = new RuleData();
200217
ruleData.setSelectorId(selectorData.getId());
@@ -292,13 +309,13 @@ private SelectorData defaultMatchSelector(final ServerWebExchange exchange, fina
292309
SelectorData selectorData = matchSelectorPair.getRight();
293310
if (Objects.nonNull(selectorData)) {
294311
// cache selector data
295-
if (matchSelectorPair.getLeft()) {
312+
if (matchSelectorPair.getLeft() && canCacheSelectorMatch(selectors)) {
296313
cacheSelectorData(path, selectorData);
297314
}
298315
return selectorData;
299316
} else {
300317
// if not match selector, cache empty selector data.
301-
if (matchSelectorPair.getLeft()) {
318+
if (matchSelectorPair.getLeft() && canCacheSelectorMatch(selectors)) {
302319
SelectorData emptySelectorData = SelectorData.builder().pluginName(named()).build();
303320
cacheSelectorData(path, emptySelectorData);
304321
}
@@ -311,13 +328,13 @@ private RuleData defaultMatchRule(final ServerWebExchange exchange, final List<R
311328
RuleData ruleData = matchRulePair.getRight();
312329
if (Objects.nonNull(ruleData)) {
313330
// cache rule data
314-
if (matchRulePair.getLeft()) {
331+
if (matchRulePair.getLeft() && canCacheRuleMatch(rules)) {
315332
cacheRuleData(path, ruleData);
316333
}
317334
return ruleData;
318335
} else {
319336
// if not match rule, cache empty rule data.
320-
if (matchRulePair.getLeft()) {
337+
if (matchRulePair.getLeft() && canCacheRuleMatch(rules)) {
321338
RuleData emptyRuleData = RuleData.builder().pluginName(named()).build();
322339
cacheRuleData(path, emptyRuleData);
323340
}

‎shenyu-plugin/shenyu-plugin-base/src/test/java/org/apache/shenyu/plugin/base/AbstractShenyuPluginTest.java‎

Lines changed: 76 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,8 @@
4545

4646
import static org.junit.jupiter.api.Assertions.assertEquals;
4747
import static org.junit.jupiter.api.Assertions.assertTrue;
48+
import static org.mockito.ArgumentMatchers.any;
49+
import static org.mockito.ArgumentMatchers.argThat;
4850
import static org.mockito.Mockito.mock;
4951
import static org.mockito.Mockito.spy;
5052
import static org.mockito.Mockito.verify;
@@ -202,6 +204,73 @@ public void executeSelectorManyMatch() {
202204
verify(testShenyuPlugin).doExecute(exchange, shenyuPluginChain, selectorData, ruleData);
203205
}
204206

207+
@Test
208+
public void selectorCacheShouldNotShadowDynamicCandidate() {
209+
ConditionData uriCondition = new ConditionData();
210+
uriCondition.setOperator("match");
211+
uriCondition.setParamName("/");
212+
uriCondition.setParamType("uri");
213+
uriCondition.setParamValue("/http/**");
214+
ConditionData headerCondition = new ConditionData();
215+
headerCondition.setOperator("=");
216+
headerCondition.setParamName("X-Tenant");
217+
headerCondition.setParamType("header");
218+
headerCondition.setParamValue("a");
219+
SelectorData genericSelector = SelectorData.builder()
220+
.id("generic").pluginName("SHENYU").enabled(true).continued(false).logged(false)
221+
.matchMode(0).sort(2).conditionList(Collections.singletonList(uriCondition))
222+
.type(SelectorTypeEnum.CUSTOM_FLOW.getCode()).build();
223+
SelectorData tenantSelector = SelectorData.builder()
224+
.id("tenant").pluginName("SHENYU").enabled(true).continued(false).logged(false)
225+
.matchMode(0).sort(1).conditionList(List.of(uriCondition, headerCondition))
226+
.type(SelectorTypeEnum.CUSTOM_FLOW.getCode()).build();
227+
BaseDataCache.getInstance().cachePluginData(pluginData);
228+
BaseDataCache.getInstance().cacheSelectData(genericSelector);
229+
BaseDataCache.getInstance().cacheSelectData(tenantSelector);
230+
231+
ServerWebExchange ordinaryExchange = exchangeWithTenant("b");
232+
StepVerifier.create(testShenyuPlugin.execute(ordinaryExchange, shenyuPluginChain)).verifyComplete();
233+
ServerWebExchange tenantExchange = exchangeWithTenant("a");
234+
StepVerifier.create(testShenyuPlugin.execute(tenantExchange, shenyuPluginChain)).verifyComplete();
235+
236+
verify(testShenyuPlugin).doExecute(any(), any(), argThat(selector -> "tenant".equals(selector.getId())), any());
237+
}
238+
239+
@Test
240+
public void ruleCacheShouldNotShadowDynamicCandidate() {
241+
ConditionData uriCondition = new ConditionData();
242+
uriCondition.setOperator("match");
243+
uriCondition.setParamName("/");
244+
uriCondition.setParamType("uri");
245+
uriCondition.setParamValue("/http/**");
246+
ConditionData headerCondition = new ConditionData();
247+
headerCondition.setOperator("=");
248+
headerCondition.setParamName("X-Tenant");
249+
headerCondition.setParamType("header");
250+
headerCondition.setParamValue("a");
251+
this.selectorData.setContinued(true);
252+
this.selectorData.setMatchMode(0);
253+
this.selectorData.setLogged(false);
254+
this.selectorData.setConditionList(Collections.singletonList(uriCondition));
255+
RuleData genericRule = RuleData.builder()
256+
.id("generic").pluginName("SHENYU").selectorId("1").enabled(true).logged(false)
257+
.matchMode(0).sort(2).conditionDataList(Collections.singletonList(uriCondition)).build();
258+
RuleData tenantRule = RuleData.builder()
259+
.id("tenant").pluginName("SHENYU").selectorId("1").enabled(true).logged(false)
260+
.matchMode(0).sort(1).conditionDataList(List.of(uriCondition, headerCondition)).build();
261+
BaseDataCache.getInstance().cachePluginData(pluginData);
262+
BaseDataCache.getInstance().cacheSelectData(selectorData);
263+
BaseDataCache.getInstance().cacheRuleData(genericRule);
264+
BaseDataCache.getInstance().cacheRuleData(tenantRule);
265+
266+
ServerWebExchange ordinaryExchange = exchangeWithTenant("b");
267+
StepVerifier.create(testShenyuPlugin.execute(ordinaryExchange, shenyuPluginChain)).verifyComplete();
268+
ServerWebExchange tenantExchange = exchangeWithTenant("a");
269+
StepVerifier.create(testShenyuPlugin.execute(tenantExchange, shenyuPluginChain)).verifyComplete();
270+
271+
verify(testShenyuPlugin).doExecute(any(), any(), any(), argThat(rule -> "tenant".equals(rule.getId())));
272+
}
273+
205274
@Test
206275
public void executeRuleManyMatch() {
207276
List<ConditionData> conditionDataList = Collections.singletonList(conditionData);
@@ -382,6 +451,13 @@ private void mockShenyuConfig() {
382451
SpringBeanUtils.getInstance().setApplicationContext(context);
383452
}
384453

454+
private ServerWebExchange exchangeWithTenant(final String tenant) {
455+
ServerWebExchange result = MockServerWebExchange.from(MockServerHttpRequest.get("/http/SHENYU/SHENYU")
456+
.header("X-Tenant", tenant).build());
457+
result.getAttributes().put(Constants.CONTEXT, mock(ShenyuContext.class));
458+
return result;
459+
}
460+
385461
static class TestShenyuPlugin extends AbstractShenyuPlugin {
386462

387463
@Override

0 commit comments

Comments
 (0)