Format text blocks + Intellij reflows strings (#1419)

Format text blocks + Intellij reflows strings

Author: crogoz

debugger/.gitignore

@@ -4,6 +4,8 @@
 /node_modules
 /.pnp
 .pnp.js
+yarn.lock
+package-lock.json
 
 # testing
 /coverage

debugger/README.md

@@ -1,3 +1,11 @@
+React App that helps Debugging a javaInput's AST.
+
+1. Run only one test from [FormatterIntegrationTest](https://github.com/palantir/palantir-java-format/blob/0ad916e4f27b5aab3870d633a16c50192b6e54cc/palantir-java-format/src/test/java/com/palantir/javaformat/java/FormatterIntegrationTest.java#L66) with ["debugOutput" = true](https://github.com/palantir/palantir-java-format/blob/0ad916e4f27b5aab3870d633a16c50192b6e54cc/palantir-java-format/src/test/java/com/palantir/javaformat/java/FormatterIntegrationTest.java#L66)
+2. Run `cd debugger && NODE_OPTIONS=--openssl-legacy-provider yarn start` that will open the app in the browser (<code>localhost:3000</code>)
+
+
+-----
+
 This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).
 
 ## Available Scripts

debugger/package.json

@@ -3,16 +3,16 @@
   "version": "0.1.0",
   "private": true,
   "dependencies": {
+    "@blueprintjs/core": "^3.20.0",
     "@types/jest": "24.0.23",
     "@types/node": "12.12.7",
     "@types/react": "16.9.11",
     "@types/react-dom": "16.9.4",
     "react": "^16.11.0",
     "react-dom": "^16.11.0",
-    "react-scripts": "3.2.0",
-    "typescript": "3.7.2",
-    "@blueprintjs/core": "^3.20.0",
-    "react-treebeard": "^3.2.4"
+    "react-scripts": "^3.2.0",
+    "react-treebeard": "^3.2.4",
+    "typescript": "3.7.2"
   },
   "scripts": {
     "start": "react-scripts start",

debugger/yarn.lock

@@ -45,6 +45,7 @@ public NativeImageFormatterService(Path nativeImagePath) {
 
     @Override
     public ImmutableList<Replacement> getFormatReplacements(String input, Collection<Range<Integer>> ranges) {
+        Optional<String> output = Optional.empty();
         try {
             FormatterNativeImageArgs command = FormatterNativeImageArgs.builder()
                     .nativeImagePath(nativeImagePath)
@@ -53,14 +54,15 @@ public ImmutableList<Replacement> getFormatReplacements(String input, Collection
                             ranges.stream().map(RangeUtils::toStringRange).collect(Collectors.toList()))
                     .build();
 
-            Optional<String> output = FormatterCommandRunner.runWithStdin(
+            output = FormatterCommandRunner.runWithStdin(
                     command.toArgs(), input, Optional.ofNullable(nativeImagePath.getParent()));
             if (output.isEmpty() || output.get().isEmpty()) {
                 return ImmutableList.of();
             }
             return MAPPER.readValue(output.get(), new TypeReference<>() {});
         } catch (IOException e) {
-            throw new UncheckedIOException("Error running the native image command", e);
+            throw new UncheckedIOException(
+                    String.format("Error running the native image command; received output: %s", output), e);
         }
     }
 

palantir-java-format-jdk-bootstrap/src/main/java/com/palantir/javaformat/bootstrap/NativeImageFormatterService.java

@@ -50,6 +50,18 @@
       "type": "com.google.common.collect.RegularImmutableList",
       "allDeclaredFields": true
     },
+    {
+      "type": "java.util.ImmutableCollections$AbstractImmutableList",
+      "allDeclaredFields": true
+    },
+    {
+      "type": "java.util.ImmutableCollections$AbstractImmutableCollection",
+      "allDeclaredFields": true
+    },
+    {
+      "type": "java.util.ImmutableCollections$List12",
+      "allDeclaredFields": true
+    },
     {
       "type": "com.google.common.collect.SingletonImmutableList",
       "allDeclaredFields": true

palantir-java-format-native/src/main/resources/META-INF/native-image/reachability-metadata.json

@@ -24,6 +24,7 @@
 import com.palantir.javaformat.Input;
 import com.palantir.javaformat.Op;
 import com.palantir.javaformat.Output;
+import com.palantir.javaformat.java.StringWrapper;
 import java.util.Optional;
 
 /** A leaf {@link Doc} for a token. */
@@ -106,6 +107,11 @@ public void add(DocBuilder builder) {
 
     @Override
     protected float computeWidth() {
+        if (token.getTok().getOriginalText().startsWith(StringWrapper.TEXT_BLOCK_DELIMITER)) {
+            // Palantir-specific: The size of a text block should not impact line length. This ensures that methods
+            // applied to text blocks remain on the same line and are not split into multiple lines.
+            return StringWrapper.TEXT_BLOCK_DELIMITER.length();
+        }
         return token.getTok().length();
     }
 
@@ -123,6 +129,11 @@ protected Range<Integer> computeRange() {
     public State computeBreaks(
             CommentsHelper commentsHelper, int maxWidth, State state, Obs.ExplorationNode observationNode) {
         String text = token.getTok().getOriginalText();
+        if (text.startsWith(StringWrapper.TEXT_BLOCK_DELIMITER)) {
+            // Palantir-specific: The size of a text block should not impact line length. This ensures that methods
+            // applied to text blocks remain on the same line and are not split into multiple lines.
+            return state.withColumn(state.column() + StringWrapper.TEXT_BLOCK_DELIMITER.length());
+        }
         return state.withColumn(state.column() + text.length());
     }
 

palantir-java-format/src/main/java/com/palantir/javaformat/doc/Token.java

@@ -18,17 +18,18 @@
 import com.fasterxml.jackson.databind.ObjectMapper;
 import com.fasterxml.jackson.databind.json.JsonMapper;
 import com.fasterxml.jackson.datatype.guava.GuavaModule;
-import com.google.common.collect.ImmutableList;
 import com.google.common.collect.Range;
 import com.google.common.collect.RangeSet;
 import com.google.common.collect.TreeRangeSet;
 import com.palantir.javaformat.Utils;
 import java.io.UncheckedIOException;
+import java.util.List;
+import java.util.Set;
 import java.util.concurrent.Callable;
 
 /** Encapsulates information about a file to be formatted, including which parts of the file to format. */
 class FormatFileCallable implements Callable<String> {
-    private final ObjectMapper MAPPER =
+    private static final ObjectMapper MAPPER =
             JsonMapper.builder().addModule(new GuavaModule()).build();
 
     private final String input;
@@ -49,14 +50,29 @@ public String call() throws FormatterException {
 
         Formatter formatter = Formatter.createFormatter(options);
         if (parameters.outputReplacements()) {
-            return formatReplacements(formatter);
+            RangeSet<Integer> characterRanges = characterRanges(input);
+            Set<Range<Integer>> rangesToChange = characterRanges.asRanges();
+            List<Replacement> replacements = formatter.getFormatReplacements(input, rangesToChange);
+            if (parameters.reflowLongStrings()) {
+                String formattedText = Utils.applyReplacements(input, replacements);
+                // avoid trying to wrap the input unless the lines needing wrapping are part of the "characterRanges"
+                if (!StringWrapper.linesNeedWrapping(options.maxLineLength(), formattedText, characterRanges)) {
+                    return writeFormatReplacements(replacements);
+                }
+                String wrappedFormattedText = StringWrapper.wrap(options.maxLineLength(), formattedText, formatter);
+                // if no wrapping change happened, return the initial replacements
+                if (wrappedFormattedText.equals(formattedText)) {
+                    return writeFormatReplacements(replacements);
+                }
+                return writeFormatReplacements(List.of(Replacement.create(0, input.length(), wrappedFormattedText)));
+            } else {
+                return writeFormatReplacements(replacements);
+            }
         }
         return formatFile(formatter);
     }
 
-    private String formatReplacements(Formatter formatter) throws FormatterException {
-        ImmutableList<Replacement> replacements =
-                formatter.getFormatReplacements(input, characterRanges(input).asRanges());
+    String writeFormatReplacements(List<Replacement> replacements) throws FormatterException {
         try {
             return MAPPER.writeValueAsString(replacements);
         } catch (JsonProcessingException e) {

palantir-java-format/src/main/java/com/palantir/javaformat/java/FormatFileCallable.java

@@ -2725,17 +2725,32 @@ void visitDot(ExpressionTree node0) {
                 scan(getArrayBase(node), null);
                 token(".");
             } else {
+                boolean isTextBlock = false;
+                // Special case for text blocks: if the node is a string literal that ends with """,
+                // don't add a break after it
+                if (node instanceof LiteralTree && node.getKind() == Tree.Kind.STRING_LITERAL) {
+                    String sourceForNode = getSourceForNode(node, getCurrentPath());
+                    isTextBlock = sourceForNode.trim().endsWith(StringWrapper.TEXT_BLOCK_DELIMITER);
+                }
+
                 builder.open(OpenOp.builder()
                         .debugName("visitDot")
                         .plusIndent(plusFour)
-                        .breakBehaviour(BreakBehaviours.preferBreakingLastInnerLevel(true))
+                        .breakBehaviour(
+                                isTextBlock
+                                        ? BreakBehaviours.breakOnlyIfInnerLevelsThenFitOnOneLine(false)
+                                        : BreakBehaviours.preferBreakingLastInnerLevel(true))
                         .breakabilityIfLastLevel(
-                                LastLevelBreakability.ACCEPT_INLINE_CHAIN_IF_SIMPLE_OTHERWISE_CHECK_INNER)
+                                isTextBlock
+                                        ? LastLevelBreakability.ACCEPT_INLINE_CHAIN
+                                        : LastLevelBreakability.ACCEPT_INLINE_CHAIN_IF_SIMPLE_OTHERWISE_CHECK_INNER)
                         .columnLimitBeforeLastBreak(METHOD_CHAIN_COLUMN_LIMIT)
                         .isSimple(false)
                         .build());
                 scan(getArrayBase(node), null);
-                builder.breakOp();
+                if (!isTextBlock) {
+                    builder.breakOp();
+                }
                 needDot = true;
             }
             formatArrayIndices(getArrayIndices(node));