[GEODE-8789] Inconsistent logging when using BaseCommand.writeRegionDestroyedEx() leads to region name being repeated.

• Type: Improvement
• Status: Closed
• Priority: Major
• Resolution: Fixed
• Affects Version/s: 1.12.0, 1.13.1, 1.14.0
• Fix Version/s: 1.12.1, 1.13.2, 1.14.0
• Component/s: logging
• Labels: pull-request-available
• Assignee: Donal Evans
• Reporter: Donal Evans
• Created: 14/Dec/20 22:23
• Updated: 26/Mar/21 22:25
• Resolved: 15/Dec/20 00:55

Description

The method BaseCommand.writeRegionDestroyedEx() takes a String "title" and String "regionName" and uses them to construct an exception message. However, some areas of code that call this method format the "title" String to already contain the region name, leading to the name being logged twice and potentially causing confusion. Calls to this method should be changed to not include the region name in the "title" String.

protected static void writeRegionDestroyedEx(Message msg, String regionName, String title,
      ServerConnection serverConnection) throws IOException {
    String reason = serverConnection.getName() + ": Region named " + regionName + title;
    RegionDestroyedException ex = new RegionDestroyedException(reason, regionName);
    if (serverConnection.getTransientFlag(REQUIRES_CHUNKED_RESPONSE)) {
      writeChunkedException(msg, ex, serverConnection);
    } else {
      writeException(msg, ex, false, serverConnection);
    }
  }

Issue Links

• links to: GitHub Pull Request #5850