commit 1bd33e313201517bbc70e4d24d9a690595eabff1
author Patrick Hiesel <hiesel@google.com> Tue Aug 29 08:50:53 2017 +0200
committer Patrick Hiesel <hiesel@google.com> Tue Aug 29 10:28:47 2017 +0200
tree d7cd8492eed95b1d64ed8c8c1dd7ae8ea5ad93cf
parent b84c35c9cf6a8f1103a3ecfb4496120247bf5bec

Use ~ instead of - as delimiter for local comments

Projects can contain dashes as part of their name which confuses the
local comments storage. By using tilde instead, we can work around this
issue because it is part of the invalid strings collection that prevents
creation of new projects containing any of those strings.

Once deployed, we start neglecting local comments that use the old
delimiter. Since comments are synced to the server immediately if the
user is online, there should be almost no cases where comments are lost.
In addition, a comment would still be in the browser's local storage and
retrievable from there manually.

Change-Id: Ibb18635e359a3b338b04e6a0e95637f699d2ebef

gerrit-gwtui/src/main/java/com/google/gerrit/client/change/LocalComments.java

diff --git a/gerrit-gwtui/src/main/java/com/google/gerrit/client/change/LocalComments.java b/gerrit-gwtui/src/main/java/com/google/gerrit/client/change/LocalComments.java
index 392dc01..44652cf 100644
--- a/gerrit-gwtui/src/main/java/com/google/gerrit/client/change/LocalComments.java
+++ b/gerrit-gwtui/src/main/java/com/google/gerrit/client/change/LocalComments.java
@@ -128,7 +128,7 @@
   }
 
   private String getReplyCommentName() {
-    return "savedReplyComment-" + PageLinks.toChangeId(project, changeId);
+    return "savedReplyComment~" + PageLinks.toChangeId(project, changeId);
   }
 
   public static void saveInlineComments() {
@@ -194,9 +194,9 @@
   }
 
   private static boolean isInlineComment(String key) {
-    return key.startsWith("patchCommentEdit-")
-        || key.startsWith("patchReply-")
-        || key.startsWith("patchComment-");
+    return key.startsWith("patchCommentEdit~")
+        || key.startsWith("patchReply~")
+        || key.startsWith("patchComment~");
   }
 
   private static InlineComment getInlineComment(String key) {
@@ -206,9 +206,9 @@
     CommentRange range;
     StorageBackend storage = new StorageBackend();
 
-    String[] elements = key.split("-");
+    String[] elements = key.split("~");
     int offset = 1;
-    if (key.startsWith("patchReply-") || key.startsWith("patchCommentEdit-")) {
+    if (key.startsWith("patchReply~") || key.startsWith("patchCommentEdit~")) {
       offset = 2;
     }
     ProjectChangeId id = ProjectChangeId.create(elements[offset + 0]);
@@ -232,9 +232,9 @@
     }
     CommentInfo info = CommentInfo.create(path, side, line, range, false);
     info.message(storage.getItem(key));
-    if (key.startsWith("patchReply-")) {
+    if (key.startsWith("patchReply~")) {
       info.inReplyTo(elements[1]);
-    } else if (key.startsWith("patchCommentEdit-")) {
+    } else if (key.startsWith("patchCommentEdit~")) {
       info.id(elements[1]);
     }
     InlineComment inlineComment = new InlineComment(id.getProject(), psId, info);
@@ -245,22 +245,22 @@
     if (psId == null) {
       return null;
     }
-    String result = "patchComment-";
+    String result = "patchComment~";
     if (comment.id() != null) {
-      result = "patchCommentEdit-" + comment.id() + "-";
+      result = "patchCommentEdit~" + comment.id() + "~";
     } else if (comment.inReplyTo() != null) {
-      result = "patchReply-" + comment.inReplyTo() + "-";
+      result = "patchReply~" + comment.inReplyTo() + "~";
     }
 
     result += PageLinks.toChangeId(project, changeId);
-    result += "-" + psId.getId() + "-" + btoa(comment.path()) + "-" + comment.side() + "-";
+    result += "~" + psId.getId() + "~" + btoa(comment.path()) + "~" + comment.side() + "~";
     if (comment.hasRange()) {
       result +=
           "R"
               + comment.range().startLine()
               + ","
               + comment.range().startCharacter()
-              + "-"
+              + "~"
               + comment.range().endLine()
               + ","
               + comment.range().endCharacter();