Upgrade parser, unicode strings, catch Panic (#444)

* Handle catch clauses with Panic

* Add support for unicode strings

* Upgrade parser

* Check coverage threshold on CI

Author: fvictorio

.travis.yml

@@ -7,4 +7,4 @@ node_js:
   - '13'
 script:
   - npm run lint
-  - npm test
+  - npm run test:all

jest.config.js

@@ -8,6 +8,14 @@ module.exports = {
     '!src/prettier-comments/**/*.js'
   ],
   coverageDirectory: './coverage/',
+  coverageThreshold: {
+    global: {
+      branches: 100,
+      functions: 100,
+      lines: 100,
+      statements: 100
+    }
+  },
   setupFiles: ['<rootDir>/tests_config/run_spec.js'],
   snapshotSerializers: ['<rootDir>/tests_config/raw-serializer.js'],
   testEnvironment: 'node',

package-lock.json

@@ -72,7 +72,7 @@
     "jest-watch-typeahead": "^0.6.1"
   },
   "dependencies": {
-    "@solidity-parser/parser": "^0.11.0",
+    "@solidity-parser/parser": "^0.12.0",
     "dir-to-object": "^2.0.0",
     "emoji-regex": "^9.2.1",
     "escape-string-regexp": "^4.0.0",

package.json

@@ -9,7 +9,7 @@ const printSeparatedList = require('./print-separated-list');
 const parameters = (node, path, print) =>
   node.parameters
     ? concat([
-        node.isReasonStringType ? 'Error' : '',
+        node.kind || '',
         '(',
         printSeparatedList(path.map(print, 'parameters')),
         ') '

src/nodes/CatchClause.js

@@ -7,7 +7,15 @@ const { printString } = require('../prettier-comments/common/util');
 
 const StringLiteral = {
   print: ({ node, options }) => {
-    const list = node.parts.map((part) => printString(part, options));
+    const list = node.parts.map((part, index) =>
+      printString(part, {
+        ...options,
+        // node.isUnicode is an array of the same length as node.parts
+        // that indicates if that string fragment has the unicode prefix
+        isUnicode: node.isUnicode[index]
+      })
+    );
+
     return join(line, list);
   }
 };

src/nodes/StringLiteral.js

@@ -475,11 +475,12 @@ function printString(rawContent, options) {
       options.parser === "css" ||
       options.parser === "less" ||
       options.parser === "scss"
-    )
+    ),
+    options.isUnicode
   );
 }
 
-function makeString(rawContent, enclosingQuote, unescapeUnnecessaryEscapes) {
+function makeString(rawContent, enclosingQuote, unescapeUnnecessaryEscapes, isUnicode) {
   const otherQuote = enclosingQuote === '"' ? "'" : '"';
 
   // Matches _any_ escape and unescaped quotes (both single and double).
@@ -514,7 +515,7 @@ function makeString(rawContent, enclosingQuote, unescapeUnnecessaryEscapes) {
       : "\\" + escaped;
   });
 
-  return enclosingQuote + newContent + enclosingQuote;
+  return (isUnicode ? "unicode" : "") + enclosingQuote + newContent + enclosingQuote;
 }
 
 function printNumber(rawNumber) {

src/prettier-comments/common/util.js

@@ -74,4 +74,30 @@ contract FeedConsumer {
                 errorCount++;
                 return (0, false);
               } }
+
+    function rate4(address token) public returns (uint value, bool success) {
+        // Permanently disable the mechanism if there are
+        // more than 10 errors.
+        require(errorCount < 10);
+        try feed.getData(token) returns (uint v) {
+            return (v, true);
+        } catch Error(string memory /*reason*/) {
+            // This is executed in case
+            // revert was called inside getData
+            // and a reason string was provided.
+            errorCount++;
+            return (0, false);
+        } catch Panic(uint /*errorCode*/) {
+            // This is executed in case of a panic,
+            // i.e. a serious error like division by zero
+            // or overflow. The error code can be used
+            // to determine the kind of error.
+            errorCount++;
+            return (0, false);
+        } catch (bytes memory /*lowLevelData*/) {
+            // This is executed in case revert() was used.
+            errorCount++;
+            return (0, false);
+        }
+    }
 }

tests/TryCatch/TryCatch.sol

@@ -77,6 +77,32 @@ contract FeedConsumer {
                 errorCount++;
                 return (0, false);
               } }
+
+    function rate4(address token) public returns (uint value, bool success) {
+        // Permanently disable the mechanism if there are
+        // more than 10 errors.
+        require(errorCount < 10);
+        try feed.getData(token) returns (uint v) {
+            return (v, true);
+        } catch Error(string memory /*reason*/) {
+            // This is executed in case
+            // revert was called inside getData
+            // and a reason string was provided.
+            errorCount++;
+            return (0, false);
+        } catch Panic(uint /*errorCode*/) {
+            // This is executed in case of a panic,
+            // i.e. a serious error like division by zero
+            // or overflow. The error code can be used
+            // to determine the kind of error.
+            errorCount++;
+            return (0, false);
+        } catch (bytes memory /*lowLevelData*/) {
+            // This is executed in case revert() was used.
+            errorCount++;
+            return (0, false);
+        }
+    }
 }
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 pragma solidity ^0.6.0;
@@ -171,6 +197,38 @@ contract FeedConsumer {
             return (0, false);
         }
     }
+
+    function rate4(address token) public returns (uint256 value, bool success) {
+        // Permanently disable the mechanism if there are
+        // more than 10 errors.
+        require(errorCount < 10);
+        try feed.getData(token) returns (uint256 v) {
+            return (v, true);
+        } catch Error(
+            string memory /*reason*/
+        ) {
+            // This is executed in case
+            // revert was called inside getData
+            // and a reason string was provided.
+            errorCount++;
+            return (0, false);
+        } catch Panic(
+            uint256 /*errorCode*/
+        ) {
+            // This is executed in case of a panic,
+            // i.e. a serious error like division by zero
+            // or overflow. The error code can be used
+            // to determine the kind of error.
+            errorCount++;
+            return (0, false);
+        } catch (
+            bytes memory /*lowLevelData*/
+        ) {
+            // This is executed in case revert() was used.
+            errorCount++;
+            return (0, false);
+        }
+    }
 }
 
 `;

tests/TryCatch/__snapshots__/jsfmt.spec.js.snap

@@ -16,4 +16,9 @@ contract Foo {
   string escapeDoubleQuotes = "The \"quick\" brown fox";
   string hex1 = hex'DeadBeef';
   string hex2 = hex"DeadBeef";
+  string withUnicode1 = unicode'hello 🦄 world';
+  string withUnicode2 = unicode"hello 🦄 world";
+  string multiPartAndUnicode1 = unicode'hello 🦄' ' world';
+  string multiPartAndUnicode2 = 'hello ' unicode' 🦄world';
+  string multiPartAndUnicode3 = unicode'hello 🦄' unicode' world 🦄';
 }