Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fix StackOverflowError in SemanticsMetadataProvider #3748

Merged
merged 2 commits into from
Aug 12, 2023
Merged

Fix StackOverflowError in SemanticsMetadataProvider #3748

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0cf484f
Fix StackOverflowError in SemanticsMetadataProvider
J-N-K Aug 11, 2023
d0217ea
address review comments
J-N-K Aug 12, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
6 changes: 6 additions & 0 deletions bundles/org.openhab.core.semantics/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,12 @@
<artifactId>org.openhab.core</artifactId>
<version>${project.version}</version>
</dependency>
<dependency>
<groupId>org.openhab.core.bundles</groupId>
<artifactId>org.openhab.core.test</artifactId>
<version>${project.version}</version>
<scope>test</scope>
</dependency>
<dependency>
<groupId>org.ow2.asm</groupId>
<artifactId>asm</artifactId>
Expand Down
26 changes: 18 additions & 8 deletions ...emantics/src/main/java/org/openhab/core/semantics/internal/SemanticsMetadataProvider.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@
*/
package org.openhab.core.semantics.internal;

import java.util.ArrayList;
import java.util.Collection;
import java.util.Comparator;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
Expand All @@ -40,6 +40,8 @@
import org.osgi.service.component.annotations.Component;
import org.osgi.service.component.annotations.Deactivate;
import org.osgi.service.component.annotations.Reference;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

/**
* This {@link MetadataProvider} collects semantic information about items and provides them as metadata under the
Expand All @@ -56,6 +58,8 @@
public class SemanticsMetadataProvider extends AbstractProvider<Metadata>
implements ItemRegistryChangeListener, MetadataProvider {

private final Logger logger = LoggerFactory.getLogger(SemanticsMetadataProvider.class);

// the namespace to use for the metadata
public static final String NAMESPACE = "semantics";

Expand All @@ -65,12 +69,7 @@ public class SemanticsMetadataProvider extends AbstractProvider<Metadata>
private final Map<List<Class<? extends Tag>>, String> propertyRelations = new HashMap<>();

// local cache of the created metadata as a map from itemName->Metadata
private final Map<String, Metadata> semantics = new TreeMap<>(new Comparator<String>() {
@Override
public int compare(String s1, String s2) {
return s1.compareTo(s2);
}
});
private final Map<String, Metadata> semantics = new TreeMap<>(String::compareTo);

private final ItemRegistry itemRegistry;

Expand Down Expand Up @@ -106,6 +105,10 @@ public Collection<Metadata> getAll() {
* @param item the item to update the metadata for
*/
private void processItem(Item item) {
processItem(item, new ArrayList<>());
}

private void processItem(Item item, List<String> parentItems) {
MetadataKey key = new MetadataKey(NAMESPACE, item.getName());
Map<String, Object> configuration = new HashMap<>();
Class<? extends Tag> type = SemanticTags.getSemanticType(item);
Expand All @@ -127,8 +130,15 @@ private void processItem(Item item) {
}

if (item instanceof GroupItem groupItem) {
parentItems.add(item.getName());
for (Item memberItem : groupItem.getMembers()) {
processItem(memberItem);
if (parentItems.contains(memberItem.getName())) {
logger.error(
"Recursive group membership found: {} is both, a direct or indirect parent and a child of {}.",
memberItem.getName(), groupItem.getName());
} else {
processItem(memberItem, parentItems);
}
}
}
}
Expand Down
51 changes: 50 additions & 1 deletion ...tics/src/test/java/org/openhab/core/semantics/internal/SemanticsMetadataProviderTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,18 +36,20 @@
import org.openhab.core.items.Item;
import org.openhab.core.items.ItemRegistry;
import org.openhab.core.items.Metadata;
import org.openhab.core.library.items.NumberItem;
import org.openhab.core.library.items.SwitchItem;
import org.openhab.core.semantics.ManagedSemanticTagProvider;
import org.openhab.core.semantics.SemanticTagRegistry;
import org.openhab.core.semantics.model.DefaultSemanticTagProvider;
import org.openhab.core.test.java.JavaTest;

/**
* @author Simon Lamon - Initial contribution
*/
@NonNullByDefault
@ExtendWith(MockitoExtension.class)
@MockitoSettings(strictness = Strictness.LENIENT)
public class SemanticsMetadataProviderTest {
public class SemanticsMetadataProviderTest extends JavaTest {

private static final String ITEM_NAME = "switchItem";

Expand All @@ -61,6 +63,8 @@ public class SemanticsMetadataProviderTest {

@BeforeEach
public void beforeEach() throws Exception {
setupInterceptedLogger(SemanticsMetadataProvider.class, LogLevel.DEBUG);

when(managedSemanticTagProviderMock.getAll()).thenReturn(List.of());
SemanticTagRegistry semanticTagRegistry = new SemanticTagRegistryImpl(new DefaultSemanticTagProvider(),
managedSemanticTagProviderMock);
Expand Down Expand Up @@ -235,6 +239,51 @@ public void testGroupItemRemovedAfterMemberItemAdded() {
assertNull(metadata.getConfiguration().get("hasLocation"));
}

@Test
public void testRecursiveGroupMembershipDoesNotResultInStackOverflowError() {
GroupItem groupItem1 = new GroupItem("group1");
GroupItem groupItem2 = new GroupItem("group2");

groupItem1.addMember(groupItem2);
groupItem2.addMember(groupItem1);

assertDoesNotThrow(() -> semanticsMetadataProvider.added(groupItem1));

assertLogMessage(SemanticsMetadataProvider.class, LogLevel.ERROR,
"Recursive group membership found: group1 is both, a direct or indirect parent and a child of group2.");
}

@Test
public void testIndirectRecursiveMembershipDoesNotThrowStackOverflowError() {
GroupItem groupItem1 = new GroupItem("group1");
GroupItem groupItem2 = new GroupItem("group2");
GroupItem groupItem3 = new GroupItem("group3");

groupItem1.addMember(groupItem2);
groupItem2.addMember(groupItem3);
groupItem3.addMember(groupItem1);

assertDoesNotThrow(() -> semanticsMetadataProvider.added(groupItem1));

assertLogMessage(SemanticsMetadataProvider.class, LogLevel.ERROR,
"Recursive group membership found: group1 is both, a direct or indirect parent and a child of group3.");
}

@Test
public void testDuplicateMembershipOfPlainItemsDoesNotTriggerWarning() {
GroupItem groupItem1 = new GroupItem("group1");
GroupItem groupItem2 = new GroupItem("group2");
NumberItem numberItem = new NumberItem("number");

groupItem1.addMember(groupItem2);
groupItem1.addMember(numberItem);
groupItem2.addMember(numberItem);

semanticsMetadataProvider.added(groupItem1);

assertNoLogMessage(SemanticsMetadataProvider.class);
}

private @Nullable Metadata getMetadata(Item item) {
return semanticsMetadataProvider.getAll().stream() //
.filter(metadata -> metadata.getUID().getItemName().equals(item.getName())) //
Expand Down