Remove dangling spaces wherever found. (#127475) (#127608)

ankit--sethi · web-flow · commit 8b87b0178724 · 2025-05-01T12:53:15.000-05:00
* Remove dandling spaces wherever found. This PR addresses #117067 , a report about unexpected spaces breaking message parsers built by customers. I used the regex `(\. \")(?![A-Z(a-z_0-9-;<%\/\.+ \t\n]+)` to detect such instances and clean up. In one case, a minor code improvement helps add optional spaces as necessary for a multi-sentence error message. * fix test * Update docs/changelog/127475.yaml * correct logic * fix test * fix tests * fix tests * fix tests * Update docs/changelog/127475.yaml * Update x-pack/plugin/inference/src/main/java/org/elasticsearch/xpack/inference/action/TransportGetInferenceModelAction.java Co-authored-by: Slobodan Adamović <slobodanadamovic@users.noreply.github.com> * Update libs/x-content/src/main/java/org/elasticsearch/xcontent/ObjectParser.java Co-authored-by: Slobodan Adamović <slobodanadamovic@users.noreply.github.com> * correctly reference issue * Update docs/changelog/127475.yaml --------- Co-authored-by: Slobodan Adamović <slobodanadamovic@users.noreply.github.com> (cherry picked from commit 94854b3)
diff --git a/docs/changelog/127475.yaml b/docs/changelog/127475.yaml
@@ -0,0 +1,5 @@
+pr: 127475
+summary: Remove dangling spaces wherever found
+area: Security
+type: bug
+issues: []
diff --git a/libs/x-content/src/main/java/org/elasticsearch/xcontent/ObjectParser.java b/libs/x-content/src/main/java/org/elasticsearch/xcontent/ObjectParser.java
@@ -333,8 +333,11 @@ private void throwExpectedStartObject(XContentParser parser, XContentParser.Toke
 
     private static void throwMissingRequiredFields(List<String[]> requiredFields) {
         final StringBuilder message = new StringBuilder();
-        for (String[] fields : requiredFields) {
-            message.append("Required one of fields ").append(Arrays.toString(fields)).append(", but none were specified. ");
+        for (int i = 0; i < requiredFields.size(); i++) {
+            if (i > 0) {
+                message.append(" ");
+            }
+            message.append("Required one of fields ").append(Arrays.toString(requiredFields.get(i))).append(", but none were specified.");
         }
         throw new IllegalArgumentException(message.toString());
     }
diff --git a/libs/x-content/src/test/java/org/elasticsearch/xcontent/ObjectParserTests.java b/libs/x-content/src/test/java/org/elasticsearch/xcontent/ObjectParserTests.java
@@ -1004,7 +1004,7 @@ public void testMultipleRequiredFieldSet() throws IOException {
         IllegalArgumentException e = expectThrows(IllegalArgumentException.class, () -> objectParser.apply(parser, null));
         assertThat(
             e.getMessage(),
-            equalTo("Required one of fields [a, b], but none were specified. " + "Required one of fields [c, d], but none were specified. ")
+            equalTo("Required one of fields [a, b], but none were specified. " + "Required one of fields [c, d], but none were specified.")
         );
     }
 
diff --git a/server/src/main/java/org/elasticsearch/cluster/routing/allocation/shards/ShardsAvailabilityHealthIndicatorService.java b/server/src/main/java/org/elasticsearch/cluster/routing/allocation/shards/ShardsAvailabilityHealthIndicatorService.java
@@ -299,7 +299,7 @@ static void updateShardAllocationStatus(
         NAME,
         "increase_shard_limit_index_setting",
         "Elasticsearch isn't allowed to allocate some shards from these indices to any data nodes because each node has reached the index "
-            + "shard limit. ",
+            + "shard limit.",
         "Increase the values for the ["
             + INDEX_TOTAL_SHARDS_PER_NODE_SETTING.getKey()
             + "] index setting on each index or add more nodes to the target tiers.",
@@ -316,7 +316,7 @@ static void updateShardAllocationStatus(
                     "increase_shard_limit_index_setting:tier:" + tier,
                     "Elasticsearch isn't allowed to allocate some shards from these indices because each node in the ["
                         + tier
-                        + "] tier has reached the index shard limit. ",
+                        + "] tier has reached the index shard limit.",
                     "Increase the values for the ["
                         + INDEX_TOTAL_SHARDS_PER_NODE_SETTING.getKey()
                         + "] index setting on each index or add more nodes to the target tiers.",
@@ -347,7 +347,7 @@ static void updateShardAllocationStatus(
                     "increase_shard_limit_cluster_setting:tier:" + tier,
                     "Elasticsearch isn't allowed to allocate some shards from these indices because each node in the ["
                         + tier
-                        + "] tier has reached the cluster shard limit. ",
+                        + "] tier has reached the cluster shard limit.",
                     "Increase the values for the ["
                         + CLUSTER_TOTAL_SHARDS_PER_NODE_SETTING.getKey()
                         + "] cluster setting or add more nodes to the target tiers.",
@@ -395,7 +395,7 @@ static void updateShardAllocationStatus(
         NAME,
         "migrate_data_tiers_include_data",
         "Elasticsearch isn't allowed to allocate some shards from these indices to any nodes in the desired data tiers because the "
-            + "indices are configured with allocation filter rules that are incompatible with the nodes in this tier. ",
+            + "indices are configured with allocation filter rules that are incompatible with the nodes in this tier.",
         "Remove ["
             + INDEX_ROUTING_INCLUDE_GROUP_PREFIX
             + ".data] from the index settings or try migrating to data tiers by first stopping ILM [POST /_ilm/stop] and then using "
diff --git a/x-pack/plugin/core/src/main/java/org/elasticsearch/xpack/core/security/CommandLineHttpClient.java b/x-pack/plugin/core/src/main/java/org/elasticsearch/xpack/core/security/CommandLineHttpClient.java
@@ -277,7 +277,7 @@ public void checkClusterHealthWithRetriesWaitingForCluster(String username, Secu
                 checkClusterHealthWithRetriesWaitingForCluster(username, password, retries);
                 return;
             } else {
-                throw new IllegalStateException("Failed to determine the health of the cluster. ", e);
+                throw new IllegalStateException("Failed to determine the health of the cluster.", e);
             }
         }
         final int responseStatus = response.getHttpStatus();
diff --git a/x-pack/plugin/core/src/main/java/org/elasticsearch/xpack/core/security/authz/store/ReservedRolesStore.java b/x-pack/plugin/core/src/main/java/org/elasticsearch/xpack/core/security/authz/store/ReservedRolesStore.java
@@ -537,7 +537,7 @@ private static Map<String, RoleDescriptor> initializeReservedRoles() {
                         + "This role grants monitor_ml cluster privileges, read access to the .ml-notifications and .ml-anomalies* indices "
                         + "(which store machine learning results), and write access to .ml-annotations* indices. "
                         + "Machine learning users also need index privileges for source and destination indices "
-                        + "and roles that grant access to Kibana. "
+                        + "and roles that grant access to Kibana."
                 )
             ),
             entry(
diff --git a/x-pack/plugin/deprecation/src/main/java/org/elasticsearch/xpack/deprecation/NodeDeprecationChecks.java b/x-pack/plugin/deprecation/src/main/java/org/elasticsearch/xpack/deprecation/NodeDeprecationChecks.java
@@ -127,7 +127,7 @@ static DeprecationIssue checkMultipleDataPaths(
                 "Specifying multiple data paths is deprecated",
                 "https://ela.st/es-deprecation-7-multiple-paths",
                 "The [path.data] setting contains a list of paths. Specify a single path as a string. Use RAID or other system level "
-                    + "features to utilize multiple disks. If multiple data paths are configured, the node will fail to start in 8.0. ",
+                    + "features to utilize multiple disks. If multiple data paths are configured, the node will fail to start in 8.0.",
                 false,
                 null
             );
@@ -147,7 +147,7 @@ static DeprecationIssue checkDataPathsList(
                 "Multiple data paths are not supported",
                 "https://ela.st/es-deprecation-7-multiple-paths",
                 "The [path.data] setting contains a list of paths. Specify a single path as a string. Use RAID or other system level "
-                    + "features to utilize multiple disks. If multiple data paths are configured, the node will fail to start in 8.0. ",
+                    + "features to utilize multiple disks. If multiple data paths are configured, the node will fail to start in 8.0.",
                 false,
                 null
             );
diff --git a/x-pack/plugin/deprecation/src/test/java/org/elasticsearch/xpack/deprecation/NodeDeprecationChecksTests.java b/x-pack/plugin/deprecation/src/test/java/org/elasticsearch/xpack/deprecation/NodeDeprecationChecksTests.java
@@ -87,7 +87,7 @@ public void testMultipleDataPaths() {
             issue.getDetails(),
             equalTo(
                 "The [path.data] setting contains a list of paths. Specify a single path as a string. Use RAID or other system level "
-                    + "features to utilize multiple disks. If multiple data paths are configured, the node will fail to start in 8.0. "
+                    + "features to utilize multiple disks. If multiple data paths are configured, the node will fail to start in 8.0."
             )
         );
         String url = "https://ela.st/es-deprecation-7-multiple-paths";
@@ -112,7 +112,7 @@ public void testDataPathsList() {
             issue.getDetails(),
             equalTo(
                 "The [path.data] setting contains a list of paths. Specify a single path as a string. Use RAID or other system level "
-                    + "features to utilize multiple disks. If multiple data paths are configured, the node will fail to start in 8.0. "
+                    + "features to utilize multiple disks. If multiple data paths are configured, the node will fail to start in 8.0."
             )
         );
         String url = "https://ela.st/es-deprecation-7-multiple-paths";
diff --git a/x-pack/plugin/ent-search/src/test/java/org/elasticsearch/xpack/application/analytics/event/parser/event/AnalyticsEventParserTestCase.java b/x-pack/plugin/ent-search/src/test/java/org/elasticsearch/xpack/application/analytics/event/parser/event/AnalyticsEventParserTestCase.java
@@ -84,7 +84,7 @@ public void testParsingWithMissingRequiredField() throws IOException {
 
                 try (XContentParser xContentParser = createXContentParser(json)) {
                     Exception e = expectThrows(IllegalArgumentException.class, () -> parser().parse(xContentParser, context));
-                    assertEquals(Strings.format("Required one of fields [%s], but none were specified. ", field), e.getMessage());
+                    assertEquals(Strings.format("Required one of fields [%s], but none were specified.", field), e.getMessage());
                 }
             }
         }
diff --git a/x-pack/plugin/inference/src/main/java/org/elasticsearch/xpack/inference/action/TransportGetInferenceModelAction.java b/x-pack/plugin/inference/src/main/java/org/elasticsearch/xpack/inference/action/TransportGetInferenceModelAction.java
@@ -174,7 +174,7 @@ private void parseModels(List<UnparsedModel> unparsedModels, ActionListener<GetI
 
     private ElasticsearchStatusException serviceNotFoundException(String service, String inferenceId) {
         throw new ElasticsearchStatusException(
-            "Unknown service [{}] for inference endpoint [{}]. ",
+            "Unknown service [{}] for inference endpoint [{}].",
             RestStatus.INTERNAL_SERVER_ERROR,
             service,
             inferenceId
diff --git a/x-pack/plugin/security/cli/src/main/java/org/elasticsearch/xpack/security/cli/HttpCertificateCommand.java b/x-pack/plugin/security/cli/src/main/java/org/elasticsearch/xpack/security/cli/HttpCertificateCommand.java
@@ -817,7 +817,7 @@ private static boolean askCertSigningRequest(Terminal terminal) {
 
         terminal.println("A CSR is used when you want your certificate to be created by an existing");
         terminal.println("Certificate Authority (CA) that you do not control (that is, you don't have");
-        terminal.println("access to the keys for that CA). ");
+        terminal.println("access to the keys for that CA).");
         terminal.println("");
         terminal.println("If you are in a corporate environment with a central security team, then you");
         terminal.println("may have an existing Corporate CA that can generate your certificate for you.");
diff --git a/x-pack/plugin/security/src/main/java/org/elasticsearch/xpack/security/authc/TokenService.java b/x-pack/plugin/security/src/main/java/org/elasticsearch/xpack/security/authc/TokenService.java
@@ -1338,7 +1338,7 @@ private void innerRefresh(
                                 );
                         } else {
                             logger.info(
-                                "failed to update the original token document [{}] after all retries, the update result was [{}]. ",
+                                "failed to update the original token document [{}] after all retries, the update result was [{}].",
                                 tokenDoc.id(),
                                 updateResponse.getResult()
                             );
diff --git a/x-pack/plugin/security/src/main/java/org/elasticsearch/xpack/security/authc/esnative/tool/SetupPasswordTool.java b/x-pack/plugin/security/src/main/java/org/elasticsearch/xpack/security/authc/esnative/tool/SetupPasswordTool.java
@@ -398,7 +398,7 @@ void checkElasticKeystorePasswordValid(Terminal terminal, Environment env) throw
                 terminal.errorPrintln("");
                 throw new UserException(
                     ExitCodes.CONFIG,
-                    "Failed to establish SSL connection to elasticsearch at " + route.toString() + ". ",
+                    "Failed to establish SSL connection to elasticsearch at " + route.toString() + ".",
                     e
                 );
             } catch (IOException e) {
@@ -557,7 +557,7 @@ private void changeUserPassword(String user, SecureString password, Terminal ter
                     terminal.errorPrintln("* Try running this tool again.");
                     terminal.errorPrintln("* Try running with the --verbose parameter for additional messages.");
                     terminal.errorPrintln("* Check the elasticsearch logs for additional error details.");
-                    terminal.errorPrintln("* Use the change password API manually. ");
+                    terminal.errorPrintln("* Use the change password API manually.");
                     terminal.errorPrintln("");
                     throw new UserException(ExitCodes.TEMP_FAILURE, "Failed to set password for user [" + user + "].");
                 }
diff --git a/x-pack/plugin/security/src/main/java/org/elasticsearch/xpack/security/authc/oidc/OpenIdConnectAuthenticator.java b/x-pack/plugin/security/src/main/java/org/elasticsearch/xpack/security/authc/oidc/OpenIdConnectAuthenticator.java
@@ -235,7 +235,7 @@ public void authenticate(OpenIdConnectToken token, final ActionListener<JWTClaim
             // Don't wrap in a new ElasticsearchSecurityException
             listener.onFailure(e);
         } catch (Exception e) {
-            listener.onFailure(new ElasticsearchSecurityException("Failed to consume the OpenID connect response. ", e));
+            listener.onFailure(new ElasticsearchSecurityException("Failed to consume the OpenID connect response.", e));
         }
     }
 
diff --git a/x-pack/plugin/security/src/main/java/org/elasticsearch/xpack/security/authc/saml/SamlAuthenticator.java b/x-pack/plugin/security/src/main/java/org/elasticsearch/xpack/security/authc/saml/SamlAuthenticator.java
@@ -121,7 +121,7 @@ private SamlAttributes authenticateResponse(Element element, Collection<String>
             logger.debug(
                 "The Attribute Statements of SAML Response with ID [{}] contained no attributes and the SAML Assertion Subject "
                     + "did not contain a SAML NameID. Please verify that the Identity Provider configuration with regards to attribute "
-                    + "release is correct. ",
+                    + "release is correct.",
                 response.getID()
             );
             throw samlException("Could not process any SAML attributes in {}", response.getElementQName());
diff --git a/x-pack/plugin/security/src/main/java/org/elasticsearch/xpack/security/authz/store/FileRolesStore.java b/x-pack/plugin/security/src/main/java/org/elasticsearch/xpack/security/authz/store/FileRolesStore.java
@@ -295,7 +295,7 @@ static RoleDescriptor parseRoleDescriptor(
                     Validation.Error validationError = Validation.Roles.validateRoleName(roleName, false);
                     if (validationError != null) {
                         logger.error(
-                            "invalid role definition [{}] in roles file [{}]. invalid role name - {}. skipping role... ",
+                            "invalid role definition [{}] in roles file [{}]. invalid role name - {}. skipping role...",
                             roleName,
                             path.toAbsolutePath(),
                             validationError
@@ -382,7 +382,7 @@ private static RoleDescriptor checkDescriptor(
         Validation.Error validationError = Validation.Roles.validateRoleDescription(descriptor.getDescription());
         if (validationError != null) {
             logger.error(
-                "invalid role definition [{}] in roles file [{}]. invalid description - {}. skipping role... ",
+                "invalid role definition [{}] in roles file [{}]. invalid description - {}. skipping role...",
                 roleName,
                 path.toAbsolutePath(),
                 validationError
diff --git a/x-pack/plugin/security/src/main/java/org/elasticsearch/xpack/security/tool/BaseRunAsSuperuserCommand.java b/x-pack/plugin/security/src/main/java/org/elasticsearch/xpack/security/tool/BaseRunAsSuperuserCommand.java
@@ -213,7 +213,7 @@ private void checkClusterHealthWithRetries(
         try {
             response = client.execute("GET", clusterHealthUrl, username, password, () -> null, CommandLineHttpClient::responseBuilder);
         } catch (Exception e) {
-            throw new UserException(ExitCodes.UNAVAILABLE, "Failed to determine the health of the cluster. ", e);
+            throw new UserException(ExitCodes.UNAVAILABLE, "Failed to determine the health of the cluster.", e);
         }
         final int responseStatus = response.getHttpStatus();
         if (responseStatus != HttpURLConnection.HTTP_OK) {
diff --git a/x-pack/plugin/sql/sql-proto/src/main/java/org/elasticsearch/xpack/sql/proto/content/ObjectParser.java b/x-pack/plugin/sql/sql-proto/src/main/java/org/elasticsearch/xpack/sql/proto/content/ObjectParser.java
@@ -261,7 +261,7 @@ private void throwFailedToParse(JsonParser parser, String currentFieldName, Exce
     private static void throwMissingRequiredFields(List<String[]> requiredFields) {
         final StringBuilder message = new StringBuilder();
         for (String[] fields : requiredFields) {
-            message.append("Required one of fields ").append(Arrays.toString(fields)).append(", but none were specified. ");
+            message.append("Required one of fields ").append(Arrays.toString(fields)).append(", but none were specified.");
         }
         throw new ParseException(message.toString());
     }
diff --git a/x-pack/plugin/transform/src/main/java/org/elasticsearch/xpack/transform/action/TransportStopTransformAction.java b/x-pack/plugin/transform/src/main/java/org/elasticsearch/xpack/transform/action/TransportStopTransformAction.java
@@ -459,24 +459,31 @@ private void waitForTransformStopped(
                     return;
                 } else {
                     StringBuilder message = new StringBuilder();
+                    boolean lineAdded = false;
                     if (persistentTaskIds.size() - stillRunningTasks.size() - exceptions.size() > 0) {
+                        message.append(optionalSpace(lineAdded));
                         message.append("Successfully stopped [");
                         message.append(persistentTaskIds.size() - stillRunningTasks.size() - exceptions.size());
-                        message.append("] transforms. ");
+                        message.append("] transforms.");
+                        lineAdded = true;
                     }
 
                     if (exceptions.size() > 0) {
+                        message.append(optionalSpace(lineAdded));
                         message.append("Could not stop the transforms ");
                         message.append(exceptions.keySet());
-                        message.append(" as they were failed. Use force stop to stop the transforms. ");
+                        message.append(" as they were failed. Use force stop to stop the transforms.");
+                        lineAdded = true;
                     }
 
                     if (stillRunningTasks.size() > 0) {
+                        message.append(optionalSpace(lineAdded));
                         message.append("Could not stop the transforms ");
                         message.append(stillRunningTasks);
                         message.append(" as they timed out [");
                         message.append(timeout.toString());
                         message.append("].");
+                        lineAdded = true;
                     }
 
                     listener.onFailure(new ElasticsearchStatusException(message.toString(), RestStatus.REQUEST_TIMEOUT));
@@ -534,4 +541,8 @@ static ActionListener<Response> cancelTransformTasksListener(
             }
         });
     }
+
+    private static String optionalSpace(boolean spaceNeeded) {
+        return spaceNeeded ? " " : "";
+    }
 }

Original file line number	Diff line number	Diff line change
`@@ -333,8 +333,11 @@ private void throwExpectedStartObject(XContentParser parser, XContentParser.Toke`
`333`	`333`
`334`	`334`	`private static void throwMissingRequiredFields(List<String[]> requiredFields) {`
`335`	`335`	`final StringBuilder message = new StringBuilder();`
`336`		`- for (String[] fields : requiredFields) {`
`337`		`- message.append("Required one of fields ").append(Arrays.toString(fields)).append(", but none were specified. ");`
	`336`	`+ for (int i = 0; i < requiredFields.size(); i++) {`
	`337`	`+ if (i > 0) {`
	`338`	`+ message.append(" ");`
	`339`	`+ }`
	`340`	`+ message.append("Required one of fields ").append(Arrays.toString(requiredFields.get(i))).append(", but none were specified.");`
`338`	`341`	`}`
`339`	`342`	`throw new IllegalArgumentException(message.toString());`
`340`	`343`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1004,7 +1004,7 @@ public void testMultipleRequiredFieldSet() throws IOException {`
`1004`	`1004`	`IllegalArgumentException e = expectThrows(IllegalArgumentException.class, () -> objectParser.apply(parser, null));`
`1005`	`1005`	`assertThat(`
`1006`	`1006`	`e.getMessage(),`
`1007`		`- equalTo("Required one of fields [a, b], but none were specified. " + "Required one of fields [c, d], but none were specified. ")`
	`1007`	`+ equalTo("Required one of fields [a, b], but none were specified. " + "Required one of fields [c, d], but none were specified.")`
`1008`	`1008`	`);`
`1009`	`1009`	`}`
`1010`	`1010`
Original file line number	Diff line number	Diff line change
`@@ -277,7 +277,7 @@ public void checkClusterHealthWithRetriesWaitingForCluster(String username, Secu`
`277`	`277`	`checkClusterHealthWithRetriesWaitingForCluster(username, password, retries);`
`278`	`278`	`return;`
`279`	`279`	`} else {`
`280`		`- throw new IllegalStateException("Failed to determine the health of the cluster. ", e);`
	`280`	`+ throw new IllegalStateException("Failed to determine the health of the cluster.", e);`
`281`	`281`	`}`
`282`	`282`	`}`
`283`	`283`	`final int responseStatus = response.getHttpStatus();`
Original file line number	Diff line number	Diff line change
`@@ -537,7 +537,7 @@ private static Map<String, RoleDescriptor> initializeReservedRoles() {`
`537`	`537`	`+ "This role grants monitor_ml cluster privileges, read access to the .ml-notifications and .ml-anomalies* indices "`
`538`	`538`	`+ "(which store machine learning results), and write access to .ml-annotations* indices. "`
`539`	`539`	`+ "Machine learning users also need index privileges for source and destination indices "`
`540`		`- + "and roles that grant access to Kibana. "`
	`540`	`+ + "and roles that grant access to Kibana."`
`541`	`541`	`)`
`542`	`542`	`),`
`543`	`543`	`entry(`
Original file line number	Diff line number	Diff line change
`@@ -84,7 +84,7 @@ public void testParsingWithMissingRequiredField() throws IOException {`
`84`	`84`
`85`	`85`	`try (XContentParser xContentParser = createXContentParser(json)) {`
`86`	`86`	`Exception e = expectThrows(IllegalArgumentException.class, () -> parser().parse(xContentParser, context));`
`87`		`- assertEquals(Strings.format("Required one of fields [%s], but none were specified. ", field), e.getMessage());`
	`87`	`+ assertEquals(Strings.format("Required one of fields [%s], but none were specified.", field), e.getMessage());`
`88`	`88`	`}`
`89`	`89`	`}`
`90`	`90`	`}`