Skip to content

Commit

Permalink
test: add tests for log level change in MapSyncRpcHandler (#13517) (#…
Browse files Browse the repository at this point in the history
…13534)

(cherry picked from commit ba2c87a)
  • Loading branch information
taefi committed Apr 14, 2022
1 parent e616032 commit 429d8cc
Show file tree
Hide file tree
Showing 2 changed files with 74 additions and 8 deletions.
@@ -1,5 +1,5 @@
/*
* Copyright 2000-2020 Vaadin Ltd.
* Copyright 2000-2022 Vaadin Ltd.
*
* 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
Expand Down Expand Up @@ -106,25 +106,27 @@ protected Optional<Runnable> handleNode(StateNode node,
return enqueuePropertyUpdate(node, invocationJson, feature,
property);
} else if (DisabledUpdateMode.ALWAYS.equals(updateMode)) {
LoggerFactory.getLogger(MapSyncRpcHandler.class)
.trace("Property update request for disabled element is received from the client side. "
LoggerFactory.getLogger(MapSyncRpcHandler.class).trace(
"Property update request for disabled element is received from the client side. "
+ "Change will be applied since the property '{}' always allows its update.",
property);
property);
return enqueuePropertyUpdate(node, invocationJson, feature,
property);
} else {
final Logger logger = LoggerFactory
.getLogger(MapSyncRpcHandler.class);
if (node.getFeatureIfInitialized(ElementPropertyMap.class)
.map(feat -> feat.getProperty(property))
.orElse(null) != null) {
Optional<Serializable> featureProperty = node
.getFeatureIfInitialized(ElementPropertyMap.class)
.map(feat -> feat.getProperty(property));
if (featureProperty.isPresent()) {
logger.warn(
"Property update request for disabled element is received from the client side. "
+ "The property is '{}'. Request is ignored.",
property);
} else {
logger.debug(
"Ignored property '{}' change for disabled element. Most likely client sent the default value as no value has been set for the property.",
"Ignored property '{}' change for disabled element. Most likely client sent the "
+ "default value as no value has been set for the property.",
property);
}
}
Expand Down
Expand Up @@ -16,6 +16,7 @@
package com.vaadin.flow.server.communication.rpc;

import java.io.Serializable;
import java.util.Optional;
import java.util.concurrent.atomic.AtomicInteger;
import java.util.concurrent.atomic.AtomicReference;

Expand All @@ -42,6 +43,17 @@
import elemental.json.Json;
import elemental.json.JsonObject;
import elemental.json.JsonValue;
import org.mockito.MockedStatic;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import static org.mockito.ArgumentMatchers.anyString;
import static org.mockito.Mockito.mock;
import static org.mockito.Mockito.mockStatic;
import static org.mockito.Mockito.spy;
import static org.mockito.Mockito.times;
import static org.mockito.Mockito.verify;
import static org.mockito.Mockito.when;

public class MapSyncRpcHandlerTest {

Expand Down Expand Up @@ -363,6 +375,58 @@ public <F extends NodeFeature> F getFeature(Class<F> featureType) {
Assert.assertEquals(TEST_PROPERTY, deferredKey.get());
}

@Test
public void handleNode_stateNodePropertyDefaultValueNotSet_doesNotWarnForUnsetDisabledPropertyChange() {

ElementPropertyMap map = mock(ElementPropertyMap.class);
when(map.getProperty(anyString())).thenReturn(null);
StateNode disabledNode = mock(StateNode.class);
when(disabledNode.getFeatureIfInitialized(ElementPropertyMap.class))
.thenReturn(Optional.of(map));
when(disabledNode.isEnabled()).thenReturn(false);

Logger logger = spy(Logger.class);
try (MockedStatic<LoggerFactory> mockedLoggerFactory = mockStatic(
LoggerFactory.class)) {
mockedLoggerFactory.when(
() -> LoggerFactory.getLogger(MapSyncRpcHandler.class))
.thenReturn(logger);

new MapSyncRpcHandler().handleNode(disabledNode,
createSyncPropertyInvocation(disabledNode, TEST_PROPERTY,
NEW_VALUE));

verify(logger, times(0)).warn(anyString(), anyString());
verify(logger, times(1)).debug(anyString(), anyString());
}
}

@Test
public void handleNode_stateNodePropertyDefaultValueSet_warnsForSetDisabledPropertyChange() {

ElementPropertyMap map = mock(ElementPropertyMap.class);
when(map.getProperty(anyString())).thenReturn(NEW_VALUE);
StateNode disabledNode = mock(StateNode.class);
when(disabledNode.getFeatureIfInitialized(ElementPropertyMap.class))
.thenReturn(Optional.of(map));
when(disabledNode.isEnabled()).thenReturn(false);

Logger logger = spy(Logger.class);
try (MockedStatic<LoggerFactory> mockedLoggerFactory = mockStatic(
LoggerFactory.class)) {
mockedLoggerFactory.when(
() -> LoggerFactory.getLogger(MapSyncRpcHandler.class))
.thenReturn(logger);

new MapSyncRpcHandler().handleNode(disabledNode,
createSyncPropertyInvocation(disabledNode, TEST_PROPERTY,
NEW_VALUE));

verify(logger, times(1)).warn(anyString(), anyString());
verify(logger, times(0)).debug(anyString(), anyString());
}
}

private static void sendSynchronizePropertyEvent(Element element, UI ui,
String eventType, Serializable value) throws Exception {
new MapSyncRpcHandler().handle(ui,
Expand Down

0 comments on commit 429d8cc

Please sign in to comment.