Merge pull request #1872 from steve-community/1871-close-websocket-connection-if-any-after-deletion-of-a-charging-station

Close websocket connection (if any) after deletion of a charging station

Author: goekay

src/main/java/de/rwth/idsg/steve/ocpp/ws/SessionContextStore.java

@@ -38,6 +38,8 @@ public interface SessionContextStore {
 
     WebSocketSession getSession(String chargeBoxId);
 
+    void closeSessions(String chargeBoxId);
+
     int getSize(String chargeBoxId);
 
     int getNumberOfChargeBoxes();

src/main/java/de/rwth/idsg/steve/ocpp/ws/SessionContextStoreImpl.java

@@ -28,6 +28,7 @@
 import org.joda.time.DateTime;
 import org.springframework.web.socket.WebSocketSession;
 
+import java.io.IOException;
 import java.util.ArrayDeque;
 import java.util.Collections;
 import java.util.Deque;
@@ -132,6 +133,31 @@ public WebSocketSession getSession(String chargeBoxId) {
         }
     }
 
+    @Override
+    public void closeSessions(String chargeBoxId) {
+        Lock l = locks.get(chargeBoxId);
+        l.lock();
+        try {
+            Deque<SessionContext> endpointDeque = lookupTable.get(chargeBoxId);
+            if (endpointDeque == null) {
+                return;
+            }
+
+            // To prevent a ConcurrentModificationException, iterate over a copy of
+            // endpointDeque when closing sessions. The close() operation can trigger an event
+            // that modifies the deque, causing an error.
+            for (SessionContext sessionContext : new ArrayDeque<>(endpointDeque)) {
+                try {
+                    sessionContext.getSession().close();
+                } catch (IOException e) {
+                    log.error("Error while closing web socket session for chargeBoxId '{}'", chargeBoxId, e);
+                }
+            }
+        } finally {
+            l.unlock();
+        }
+    }
+
     @Override
     public int getSize(String chargeBoxId) {
         Deque<SessionContext> endpointDeque = lookupTable.get(chargeBoxId);

src/main/java/de/rwth/idsg/steve/service/ChargePointService.java

@@ -108,7 +108,16 @@ public void updateChargePoint(ChargePointForm form) {
     }
 
     public void deleteChargePoint(int chargeBoxPk) {
+        var details = getDetails(chargeBoxPk);
+        var chargeBoxId = details.getChargeBox().getChargeBoxId();
+
         chargePointRepository.deleteChargePoint(chargeBoxPk);
+        log.info("Deleted charge point with chargeBoxPk={} and chargeBoxId={}", chargeBoxPk, chargeBoxId);
+
+        // https://github.com/steve-community/steve/issues/1871
+        var version = OcppProtocol.fromCompositeValue(details.getChargeBox().getOcppProtocol()).getVersion();
+        log.info("Closing all WebSocket sessions of chargeBoxPk={} and chargeBoxId={}", chargeBoxPk, chargeBoxId);
+        sessionContextStoreHolder.getOrCreate(version).closeSessions(chargeBoxId);
     }
 
     // -------------------------------------------------------------------------
@@ -281,8 +290,13 @@ private static void appendList(Map<String, Deque<SessionContext>> map, List<Ocpp
             for (SessionContext ctx : endpointDeque) {
                 DateTime openSince = ctx.getOpenSince();
 
+                Integer chargeBoxPk = primaryKeyLookup.get(chargeBoxId);
+                if (chargeBoxPk == null) {
+                    log.warn("Could not find chargeBoxPk for chargeBoxId={}", chargeBoxId);
+                }
+
                 OcppJsonStatus status = OcppJsonStatus.builder()
-                    .chargeBoxPk(primaryKeyLookup.get(chargeBoxId))
+                    .chargeBoxPk(chargeBoxPk)
                     .chargeBoxId(chargeBoxId)
                     .connectedSinceDT(openSince)
                     .connectedSince(DateTimeUtils.humanize(openSince))

src/main/java/de/rwth/idsg/steve/service/OcppTagService.java

@@ -148,7 +148,9 @@ public void updateOcppTag(OcppTagForm form) {
     }
 
     public void deleteOcppTag(int ocppTagPk) {
+        var details = getRecord(ocppTagPk);
         ocppTagRepository.deleteOcppTag(ocppTagPk);
+        log.info("Deleted Ocpp Tag with ocppTagPk={} and ocppTagId={}", ocppTagPk, details.getIdTag());
     }
 
     // -------------------------------------------------------------------------

src/main/java/de/rwth/idsg/steve/service/UserService.java

@@ -88,7 +88,9 @@ public void update(UserForm form) {
     }
 
     public void delete(int userPk) {
+        var details = getDetails(userPk);
         userRepository.delete(userPk);
+        log.info("Deleted user with userPk={} and email={}", userPk, details.getUserRecord().getEMail());
     }
 
     /**

src/main/java/de/rwth/idsg/steve/web/dto/OcppJsonStatus.java

@@ -32,7 +32,7 @@
 @Builder
 @ToString
 public final class OcppJsonStatus {
-    private final int chargeBoxPk;
+    private final Integer chargeBoxPk;
     private final String chargeBoxId, connectedSince;
     private final String connectionDuration;
     private final OcppVersion version;

src/main/webapp/WEB-INF/views/ocppJsonStatus.jsp

@@ -43,7 +43,17 @@ Connection Status for JSON Charge Points
         </thead>
         <tbody>
         <c:forEach items="${ocppJsonStatusList}" var="s">
-            <tr><td><a href="${ctxPath}/manager/chargepoints/details/${s.chargeBoxPk}">${s.chargeBoxId}</a></td>
+            <tr>
+                <td>
+                    <c:choose>
+                      <c:when test="${not empty s.chargeBoxPk}">
+                        <a href="${ctxPath}/manager/chargepoints/details/${s.chargeBoxPk}">${s.chargeBoxId}</a>
+                      </c:when>
+                      <c:otherwise>
+                        ${s.chargeBoxId}
+                      </c:otherwise>
+                    </c:choose>
+                </td>
                 <td>${s.version.value}</td>
                 <td data-sort-value="${s.connectedSinceDT.millis}">${s.connectedSince}</td>
                 <td>${s.connectionDuration}</td>