SourceLocations can be turned off (graphql-java#2439)

bbakerman · web-flow · commit 632876d9348d · 2021-07-15T12:16:43.000+10:00
* Made a ParserOptions class so we can have more options later

* SourceLocations can be turned off
diff --git a/src/main/java/graphql/language/SourceLocation.java b/src/main/java/graphql/language/SourceLocation.java
@@ -9,6 +9,8 @@
 @PublicApi
 public class SourceLocation implements Serializable {
 
+    public static final SourceLocation EMPTY = new SourceLocation(-1, -1);
+
     private final int line;
     private final int column;
     private final String sourceName;
@@ -37,13 +39,21 @@ public String getSourceName() {
 
     @Override
     public boolean equals(Object o) {
-        if (this == o) return true;
-        if (o == null || getClass() != o.getClass()) return false;
+        if (this == o) {
+            return true;
+        }
+        if (o == null || getClass() != o.getClass()) {
+            return false;
+        }
 
         SourceLocation that = (SourceLocation) o;
 
-        if (line != that.line) return false;
-        if (column != that.column) return false;
+        if (line != that.line) {
+            return false;
+        }
+        if (column != that.column) {
+            return false;
+        }
         return Objects.equals(sourceName, that.sourceName);
     }
 
diff --git a/src/main/java/graphql/parser/GraphqlAntlrToLanguage.java b/src/main/java/graphql/parser/GraphqlAntlrToLanguage.java
@@ -849,14 +849,18 @@ protected Description newDescription(GraphqlParser.DescriptionContext descriptio
         return new Description(content, sourceLocation, multiLine);
     }
 
-    protected SourceLocation getSourceLocation(Token token) {
-        return AntlrHelper.createSourceLocation(multiSourceReader, token);
-    }
-
     protected SourceLocation getSourceLocation(ParserRuleContext parserRuleContext) {
         return getSourceLocation(parserRuleContext.getStart());
     }
 
+    protected SourceLocation getSourceLocation(Token token) {
+        if (parserOptions.isCaptureSourceLocation()) {
+            return AntlrHelper.createSourceLocation(multiSourceReader, token);
+        } else {
+            return SourceLocation.EMPTY;
+        }
+    }
+
     protected List<Comment> getComments(ParserRuleContext ctx) {
         Token start = ctx.getStart();
         if (start != null) {
@@ -885,7 +889,12 @@ protected List<Comment> getCommentOnChannel(List<Token> refChannel) {
             int column = refTok.getCharPositionInLine();
             // graphql spec says line numbers start at 1
             int line = sourceAndLine.getLine() + 1;
-            comments.add(new Comment(text, new SourceLocation(line, column, sourceAndLine.getSourceName())));
+
+            SourceLocation sourceLocation = SourceLocation.EMPTY;
+            if (parserOptions.isCaptureSourceLocation()) {
+                sourceLocation = new SourceLocation(line, column, sourceAndLine.getSourceName());
+            }
+            comments.add(new Comment(text, sourceLocation));
         }
         return comments.build();
     }
diff --git a/src/main/java/graphql/parser/ParserOptions.java b/src/main/java/graphql/parser/ParserOptions.java
@@ -9,7 +9,10 @@
 @PublicApi
 public class ParserOptions {
 
-    private static ParserOptions defaultJvmParserOptions = newParserOptions().captureIgnoredChars(false).build();
+    private static ParserOptions defaultJvmParserOptions = newParserOptions()
+            .captureIgnoredChars(false)
+            .captureSourceLocation(true)
+            .build();
 
     /**
      * By default the Parser will not capture ignored characters.  A static holds this default
@@ -21,6 +24,7 @@ public class ParserOptions {
      * @return the static default value on whether to capture ignored chars
      *
      * @see graphql.language.IgnoredChar
+     * @see graphql.language.SourceLocation
      */
     public static ParserOptions getDefaultParserOptions() {
         return defaultJvmParserOptions;
@@ -38,15 +42,18 @@ public static ParserOptions getDefaultParserOptions() {
      * @param options - the new default JVM parser options
      *
      * @see graphql.language.IgnoredChar
+     * @see graphql.language.SourceLocation
      */
     public static void setDefaultParserOptions(ParserOptions options) {
         defaultJvmParserOptions = Assert.assertNotNull(options);
     }
 
     private final boolean captureIgnoredChars;
+    private final boolean captureSourceLocation;
 
     private ParserOptions(Builder builder) {
         this.captureIgnoredChars = builder.captureIgnoredChars;
+        this.captureSourceLocation = builder.captureSourceLocation;
     }
 
     /**
@@ -59,19 +66,38 @@ public boolean isCaptureIgnoredChars() {
         return captureIgnoredChars;
     }
 
+
+    /**
+     * Memory savings can be made if we do NOT set {@link graphql.language.SourceLocation}s
+     * on AST nodes,  especially in SDL parsing.
+     *
+     * @return true if {@link graphql.language.SourceLocation}s are captured in AST nodes
+     *
+     * @see graphql.language.SourceLocation
+     */
+    public boolean isCaptureSourceLocation() {
+        return captureSourceLocation;
+    }
+
     public static Builder newParserOptions() {
         return new Builder();
     }
 
     public static class Builder {
 
         private boolean captureIgnoredChars = false;
+        private boolean captureSourceLocation = true;
 
         public Builder captureIgnoredChars(boolean captureIgnoredChars) {
             this.captureIgnoredChars = captureIgnoredChars;
             return this;
         }
 
+        public Builder captureSourceLocation(boolean captureSourceLocation) {
+            this.captureSourceLocation = captureSourceLocation;
+            return this;
+        }
+
         public ParserOptions build() {
             return new ParserOptions(this);
         }
diff --git a/src/test/groovy/graphql/parser/ParserTest.groovy b/src/test/groovy/graphql/parser/ParserTest.groovy
@@ -1051,4 +1051,24 @@ triple3 : """edge cases \\""" "" " \\"" \\" edge cases"""
         InvalidSyntaxException e = thrown(InvalidSyntaxException)
         e.message == "Invalid Syntax : Invalid unicode - trailing surrogate must be preceded with a leading surrogate - offending token '\\uDC00' at line 3 column 24"
     }
+
+    def "source locations are on by default but can be turned off"() {
+        when:
+        def options = ParserOptions.getDefaultParserOptions()
+
+        def document = new Parser().parseDocument("{ f }")
+        then:
+        options.isCaptureSourceLocation()
+        document.getSourceLocation() == new SourceLocation(1, 1)
+        document.getDefinitions()[0].getSourceLocation() == new SourceLocation(1, 1)
+
+        when:
+        options = ParserOptions.newParserOptions().captureSourceLocation(false).build()
+        document = new Parser().parseDocument("{ f }", options)
+
+        then:
+        !options.isCaptureSourceLocation()
+        document.getSourceLocation() == SourceLocation.EMPTY
+        document.getDefinitions()[0].getSourceLocation() == SourceLocation.EMPTY
+    }
 }
