Bug 1473569 - fix faulty errors in formatCommand; r=nchevobbe

MozReview-Commit-ID: 9PeQySBxWyx

--HG--
extra : rebase_source : 09ea09170531c0f7fa14e37ecb1e9dd2423ca4b3

devtools/server/actors/webconsole/commands.js

@@ -158,14 +158,24 @@ function checkLastChar(string, testChar) {
   return lastChar === testChar;
 }
 
-function hasUnexpectedChar(value, char, rightOffset, leftOffset) {
+function hasUnescapedChar(value, char, rightOffset, leftOffset) {
   const lastPos = value.length - 1;
-  value.slice(rightOffset, lastPos - leftOffset).includes(char);
+  const string = value.slice(rightOffset, lastPos - leftOffset);
+  const index = string.indexOf(char);
+  if (index === -1) {
+    return false;
+  }
+  const prevChar = index > 0 ? string[index - 1] : null;
+  // return false if the unexpected character is escaped, true if it is not
+  return prevChar !== "\\";
 }
 
 function collectString(token, tokens, index) {
   const firstChar = token.value[0];
   const isString = isStringChar(firstChar);
+  const UNESCAPED_CHAR_ERROR = segment =>
+    `String has unescaped \`${firstChar}\` in [${segment}...],` +
+    " may miss a space between arguments";
   let value = token.value;
 
   // the test value is not a string, or it is a string but a complete one
@@ -174,8 +184,8 @@ function collectString(token, tokens, index) {
     return { value, offset: 0 };
   }
 
-  if (hasUnexpectedChar(value, firstChar, 1, 0)) {
-    throw Error(`String contains unexpected ${firstChar} character`);
+  if (hasUnescapedChar(value, firstChar, 1, 0)) {
+    throw Error(UNESCAPED_CHAR_ERROR(value));
   }
 
   let offset = null;
@@ -186,14 +196,15 @@ function collectString(token, tokens, index) {
 
     const nextToken = tokens[i];
     if (nextToken.type !== ARG) {
-      throw Error(`String does not terminate before flag ${nextToken.value}`);
-    }
-
-    if (hasUnexpectedChar(nextToken.value, firstChar, 0, 1)) {
-      throw Error(`String contains unexpected ${firstChar} character`);
+      throw Error(`String does not terminate before flag "${nextToken.value}"`);
     }
 
     value = `${value} ${nextToken.value}`;
+
+    if (hasUnescapedChar(nextToken.value, firstChar, 0, 1)) {
+      throw Error(UNESCAPED_CHAR_ERROR(value));
+    }
+
     if (checkLastChar(nextToken.value, firstChar)) {
       offset = i - index;
       break;

devtools/server/tests/unit/test_format_command.js

@@ -70,21 +70,20 @@ const edgecases = [
   { input: ":screenshot --", expectedError: /invalid flag/ },
   {
     input: ":screenshot \"fo\"o bar",
-    // XXX Bug 1473569 - this should be: /String contains unexpected `\"` character/
-    expectedError: /String does not terminate/
+    expectedError:
+      /String has unescaped `"` in \["fo"o\.\.\.\], may miss a space between arguments/
   },
   {
     input: ":screenshot \"foo b\"ar",
-    // XXX Bug 1473569 - this should be: /String contains unexpected `\"` character/
-    expectedError: /String does not terminate/
+    expectedError:
+      // eslint-disable-next-line max-len
+      /String has unescaped `"` in \["foo b"ar\.\.\.\], may miss a space between arguments/
   },
   { input: ": screenshot", expectedError: /'' is not a valid command/ },
   { input: ":screenshot \"file name", expectedError: /String does not terminate/ },
   {
     input: ":screenshot \"file name --clipboard",
-    // XXX Bug 1473569 - this should be:
-    // /String does not terminate before flag \"clipboard\"/
-    expectedError: /String does not terminate before flag clipboard/
+    expectedError: /String does not terminate before flag "clipboard"/
   },
   { input: "::screenshot", expectedError: /':screenshot' is not a valid command/ }
 ];