You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@rocketmq.apache.org by "Aias00 (via GitHub)" <gi...@apache.org> on 2026/08/03 09:27:28 UTC

[PR] [ISSUE #838] Redact settings JSON from toString [rocketmq-dashboard]

Aias00 opened a new pull request, #839:
URL: https://github.com/apache/rocketmq-dashboard/pull/839

   ### Summary
   - Exclude persisted settings JSON from RmqSettings.toString
   - Keep safe metadata such as id and updatedAt visible
   - Add unit coverage that API keys embedded in the JSON are not exposed
   
   ### Tests
   - JAVA_HOME=/Users/aias/Library/Java/JavaVirtualMachines/openjdk-21.0.2/Contents/Home mvn -Dtest=RmqSettingsTest test
   
   Closes #838


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@rocketmq.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [PR] [ISSUE #838] Redact settings JSON from toString [rocketmq-dashboard]

Posted by "Aias00 (via GitHub)" <gi...@apache.org>.
Aias00 commented on PR #839:
URL: https://github.com/apache/rocketmq-dashboard/pull/839#issuecomment-5174154987

   Superseded by consolidated PR #928, which contains this change and has passing checks. Closing this narrower PR to keep review focused.


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@rocketmq.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [PR] [ISSUE #838] Redact settings JSON from toString [rocketmq-dashboard]

Posted by "Aias00 (via GitHub)" <gi...@apache.org>.
Aias00 closed pull request #839: [ISSUE #838] Redact settings JSON from toString
URL: https://github.com/apache/rocketmq-dashboard/pull/839


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@rocketmq.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [PR] [ISSUE #838] Redact settings JSON from toString [rocketmq-dashboard]

Posted by "Copilot (via GitHub)" <gi...@apache.org>.
Copilot commented on code in PR #839:
URL: https://github.com/apache/rocketmq-dashboard/pull/839#discussion_r3702860008


##########
server/src/test/java/org/apache/rocketmq/studio/persistence/entity/RmqSettingsTest.java:
##########
@@ -0,0 +1,41 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements.  See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License.  You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.apache.rocketmq.studio.persistence.entity;
+
+import org.junit.jupiter.api.Test;
+
+import java.time.LocalDateTime;
+
+import static org.assertj.core.api.Assertions.assertThat;
+
+class RmqSettingsTest {
+
+    @Test
+    void toStringShouldNotExposePersistedSettingsJson() {
+        RmqSettings settings = new RmqSettings();
+        settings.setId("settings");
+        settings.setJson("{\"apiKey\":\"sk-secret\",\"model\":\"gpt-4o\"}");
+        settings.setUpdatedAt(LocalDateTime.of(2026, 8, 3, 12, 0));
+
+        String text = settings.toString();
+
+        assertThat(text).contains("id=settings");
+        assertThat(text).contains("updatedAt=2026-08-03T12:00");
+        assertThat(text).doesNotContain("json");

Review Comment:
   Asserting `doesNotContain(\"json\")` is a bit broad and could become brittle if some unrelated portion of the string later contains that substring. Consider tightening the assertion to something more specific to the Lombok output (e.g., `doesNotContain(\"json=\")`) and/or asserting the full JSON payload is not present.



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@rocketmq.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org