Skip to content

Refactor to avoid possible null pointer dereference in YamlModelRepositoryImpl #4788

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

Merged
merged 3 commits into from
May 18, 2025
Merged

Refactor to avoid possible null pointer dereference in YamlModelRepositoryImpl #4788

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
04d78e9
Refactor to avoid possible null pointer dereference in YamlModelRepos…
jimtng May 4, 2025
5485aac
add null check
jimtng May 6, 2025
a459a79
address more null warnings
jimtng May 6, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
54 changes: 34 additions & 20 deletions ...odel.yaml/src/main/java/org/openhab/core/model/yaml/internal/YamlModelRepositoryImpl.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -285,25 +285,37 @@ public synchronized void processWatchEvent(Kind kind, Path fullPath) {

// remove removed elements
if (modelVersion == 1) {
model.getNodesV1().keySet().stream().filter(e -> !newElementNames.contains(e))
.forEach(removedElement -> {
List<JsonNode> removedNodes = model.getNodesV1().remove(removedElement);
getElementListeners(removedElement, modelVersion).forEach(listener -> {
List removedElements = parseJsonNodesV1(removedNodes, listener.getElementClass(),
null, null);
listener.removedModel(modelName, removedElements);
});
model.getNodesV1().entrySet().removeIf(e -> {
String elementName = e.getKey();
if (newElementNames.contains(elementName)) {
return false;
}

List<JsonNode> removedNodes = e.getValue();
Copy link
Contributor

@lolodomo lolodomo May 6, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please check that removedNodes is not null before calling parseJsonNodesV1. parseJsonNodesV1 expects a non nullable list as parameter.
It generates an error in Eclipse if not for a good reason.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've added a null check here

if (removedNodes != null) {
getElementListeners(elementName, modelVersion).forEach(listener -> {
List removedElements = parseJsonNodesV1(removedNodes, listener.getElementClass(), null,
null);
listener.removedModel(modelName, removedElements);
});
}
return true;
});
} else {
model.getNodes().keySet().stream().filter(e -> !newElementNames.contains(e))
.forEach(removedElement -> {
JsonNode removedNode = model.getNodes().remove(removedElement);
getElementListeners(removedElement, modelVersion).forEach(listener -> {
List removedElements = parseJsonMapNode(removedNode, listener.getElementClass(),
null, null);
listener.removedModel(modelName, removedElements);
});
});
model.getNodes().entrySet().removeIf(e -> {
String elementName = e.getKey();
if (newElementNames.contains(elementName)) {
return false;
}

JsonNode removedNode = e.getValue();
getElementListeners(elementName, modelVersion).forEach(listener -> {
List removedElements = parseJsonMapNode(removedNode, listener.getElementClass(), null,
null);
listener.removedModel(modelName, removedElements);
});
return true;
});
}

checkElementNames(modelName, model);
Expand All @@ -315,6 +327,7 @@ public synchronized void processWatchEvent(Kind kind, Path fullPath) {
}
}

@SuppressWarnings({ "rawtypes", "unchecked" })
private void removeModel(String modelName) {
YamlModelWrapper removedModel = modelCache.remove(modelName);
if (removedModel == null) {
Expand Down Expand Up @@ -349,7 +362,8 @@ private void removeModel(String modelName) {
public void addYamlModelListener(YamlModelListener<? extends YamlElement> listener) {
Class<? extends YamlElement> elementClass = listener.getElementClass();
String elementName = getElementName(elementClass);
elementListeners.computeIfAbsent(elementName, k -> new CopyOnWriteArrayList<>()).add(listener);
Objects.requireNonNull(elementListeners.computeIfAbsent(elementName, k -> new CopyOnWriteArrayList<>()))
.add(listener);

// iterate over all models and notify the new listener of already existing models with this type
modelCache.forEach((modelName, model) -> {
Expand Down Expand Up @@ -424,8 +438,8 @@ public void addElementToModel(String modelName, YamlElement element) {
List<JsonNode> addedNodes = new ArrayList<>();
JsonNode mapAddedNode = null;
if (model.getVersion() == 1) {
List<JsonNode> modelNodes = model.getNodesV1().computeIfAbsent(elementName,
k -> new CopyOnWriteArrayList<>());
List<JsonNode> modelNodes = Objects
.requireNonNull(model.getNodesV1().computeIfAbsent(elementName, k -> new CopyOnWriteArrayList<>()));
JsonNode newNode = objectMapper.convertValue(element, JsonNode.class);
modelNodes.add(newNode);
addedNodes.add(newNode);
Expand Down