JS: Remove hasLocationInfo()

Removing this from DataFlow::Node is a breaking change, but we can't prevent its evaluation any other way.

Author: asgerf

javascript/ql/lib/semmle/javascript/Routing.qll

@@ -83,14 +83,17 @@ module Routing {
     /** Gets a textual representation of this element. */
     string toString() { none() } // Overridden in subclass
 
+    /** Gets the location of this node. */
+    Location getLocation() { none() } // Overriden in subclass
+
     /**
      * Holds if this element is at the specified location.
      * The location spans column `startcolumn` of line `startline` to
      * column `endcolumn` of line `endline` in file `filepath`.
      * For more information, see
      * [Locations](https://codeql.github.com/docs/writing-codeql-queries/providing-locations-in-codeql-queries).
      */
-    predicate hasLocationInfo(
+    deprecated predicate hasLocationInfo(
       string filepath, int startline, int startcolumn, int endline, int endcolumn
     ) {
       none()
@@ -418,11 +421,7 @@ module Routing {
 
       override string toString() { result = range.toString() }
 
-      override predicate hasLocationInfo(
-        string filepath, int startline, int startcolumn, int endline, int endcolumn
-      ) {
-        range.hasLocationInfo(filepath, startline, startcolumn, endline, endcolumn)
-      }
+      override Location getLocation() { result = range.getLocation() }
 
       override Node getAChild() { result = range.getChild(_) }
 
@@ -659,11 +658,7 @@ module Routing {
 
       override string toString() { result = range.toString() }
 
-      override predicate hasLocationInfo(
-        string filepath, int startline, int startcolumn, int endline, int endcolumn
-      ) {
-        range.hasLocationInfo(filepath, startline, startcolumn, endline, endcolumn)
-      }
+      override Location getLocation() { result = range.getLocation() }
 
       override Node getAChild() { result = range.getChild(_) }
 
@@ -721,11 +716,7 @@ module Routing {
             [container.(Function).describe(), container.(TopLevel).getFile().getRelativePath()]
       }
 
-      override predicate hasLocationInfo(
-        string filepath, int startline, int startcolumn, int endline, int endcolumn
-      ) {
-        router.hasLocationInfo(filepath, startline, startcolumn, endline, endcolumn)
-      }
+      override Location getLocation() { result = router.getLocation() }
 
       private RouteSetup::Base getARouteSetup() {
         result.isInstalledAt(router, any(ControlFlowNode cfg | cfg.getContainer() = container))

javascript/ql/lib/semmle/javascript/dataflow/Configuration.qll

@@ -1708,7 +1708,7 @@ deprecated class PathNode extends TPathNode {
   predicate hasLocationInfo(
     string filepath, int startline, int startcolumn, int endline, int endcolumn
   ) {
-    nd.hasLocationInfo(filepath, startline, startcolumn, endline, endcolumn)
+    nd.getLocation().hasLocationInfo(filepath, startline, startcolumn, endline, endcolumn)
   }
 
   /**

javascript/ql/lib/semmle/javascript/dataflow/DataFlow.qll

@@ -150,19 +150,6 @@ module DataFlow {
       CallGraph::getABoundFunctionReference(result, boundArgs, _).flowsTo(this)
     }
 
-    /**
-     * Holds if this element is at the specified location.
-     * The location spans column `startcolumn` of line `startline` to
-     * column `endcolumn` of line `endline` in file `filepath`.
-     * For more information, see
-     * [Locations](https://codeql.github.com/docs/writing-codeql-queries/providing-locations-in-codeql-queries/).
-     */
-    final predicate hasLocationInfo(
-      string filepath, int startline, int startcolumn, int endline, int endcolumn
-    ) {
-      this.getLocation().hasLocationInfo(filepath, startline, startcolumn, endline, endcolumn)
-    }
-
     /** Gets the location of this node. */
     cached
     Location getLocation() { none() }
@@ -171,16 +158,16 @@ module DataFlow {
     File getFile() { none() } // overridden in subclasses
 
     /** Gets the start line of this data flow node. */
-    int getStartLine() { this.hasLocationInfo(_, result, _, _, _) }
+    int getStartLine() { result = this.getLocation().getStartLine() }
 
     /** Gets the start column of this data flow node. */
-    int getStartColumn() { this.hasLocationInfo(_, _, result, _, _) }
+    int getStartColumn() { result = this.getLocation().getStartColumn() }
 
     /** Gets the end line of this data flow node. */
-    int getEndLine() { this.hasLocationInfo(_, _, _, result, _) }
+    int getEndLine() { result = this.getLocation().getEndLine() }
 
     /** Gets the end column of this data flow node. */
-    int getEndColumn() { this.hasLocationInfo(_, _, _, _, result) }
+    int getEndColumn() { result = this.getLocation().getEndColumn() }
 
     /** Gets a textual representation of this element. */
     cached

javascript/ql/lib/semmle/javascript/dataflow/internal/DataFlowNode.qll

@@ -121,7 +121,7 @@ private module Cached {
       DataFlowImplCommon::forceCachingInSameStage() or
       exists(any(DataFlow::Node node).toString()) or
       exists(any(DataFlow::Node node).getContainer()) or
-      any(DataFlow::Node node).hasLocationInfo(_, _, _, _, _) or
+      exists(any(DataFlow::Node node).getLocation()) or
       exists(any(Content c).toString())
     }
   }

javascript/ql/lib/semmle/javascript/frameworks/Vue.qll

@@ -138,14 +138,17 @@ module Vue {
     /** Gets a textual representation of this element. */
     string toString() { none() } // overridden in subclasses
 
+    /** Gets the location of this component. */
+    Location getLocation() { none() } // overridden in subclasses
+
     /**
      * Holds if this element is at the specified location.
      * The location spans column `startcolumn` of line `startline` to
      * column `endcolumn` of line `endline` in file `filepath`.
      * For more information, see
      * [locations](https://codeql.github.com/docs/writing-codeql-queries/providing-locations-in-codeql-queries/).
      */
-    predicate hasLocationInfo(
+    deprecated predicate hasLocationInfo(
       string filepath, int startline, int startcolumn, int endline, int endcolumn
     ) {
       filepath = "" and
@@ -350,11 +353,7 @@ module Vue {
 
     override string toString() { result = def.toString() }
 
-    override predicate hasLocationInfo(
-      string filepath, int startline, int startcolumn, int endline, int endcolumn
-    ) {
-      def.hasLocationInfo(filepath, startline, startcolumn, endline, endcolumn)
-    }
+    override Location getLocation() { result = def.getLocation() }
 
     override API::Node getComponentRef() {
       // The Vue.extend call is made in the Vue framework; there is no explicit reference
@@ -383,11 +382,7 @@ module Vue {
 
     override string toString() { result = extend.toString() }
 
-    override predicate hasLocationInfo(
-      string filepath, int startline, int startcolumn, int endline, int endcolumn
-    ) {
-      extend.hasLocationInfo(filepath, startline, startcolumn, endline, endcolumn)
-    }
+    override Location getLocation() { result = extend.getLocation() }
 
     override API::Node getComponentRef() { result = extend.getReturn() }
 
@@ -412,11 +407,7 @@ module Vue {
 
     override string toString() { result = def.toString() }
 
-    override predicate hasLocationInfo(
-      string filepath, int startline, int startcolumn, int endline, int endcolumn
-    ) {
-      def.hasLocationInfo(filepath, startline, startcolumn, endline, endcolumn)
-    }
+    override Location getLocation() { result = def.getLocation() }
 
     override API::Node getComponentRef() {
       // The component can be obtained via 1-argument calls to `Vue.component()` with the
@@ -477,15 +468,7 @@ module Vue {
       )
     }
 
-    override predicate hasLocationInfo(
-      string filepath, int startline, int startcolumn, int endline, int endcolumn
-    ) {
-      filepath = file.getAbsolutePath() and
-      startline = 0 and
-      startcolumn = 0 and
-      endline = 0 and
-      endcolumn = 0
-    }
+    override Location getLocation() { result = file.getLocation() }
 
     /** Gets the module defined by the `script` tag in this .vue file, if any. */
     Module getModule() { result = getModuleFromVueFile(file) }
@@ -622,11 +605,7 @@ module Vue {
 
       HtmlElement() { this = MkHtmlElement(elem) }
 
-      override predicate hasLocationInfo(
-        string filepath, int startline, int startcolumn, int endline, int endcolumn
-      ) {
-        elem.getLocation().hasLocationInfo(filepath, startline, startcolumn, endline, endcolumn)
-      }
+      Location getLocation() { result = elem.getLocation() }
 
       override string getName() { result = elem.getName() }
 

javascript/ql/lib/utils/test/ConsistencyChecking.qll

@@ -94,15 +94,18 @@ deprecated private DataFlow::Node alerts(Conf conf) {
 deprecated private DataFlow::Node getAlert(File file, int line, Conf conf) {
   result = alerts(conf) and
   result.getFile() = file and
-  (result.hasLocationInfo(_, _, _, line, _) or result.hasLocationInfo(_, line, _, _, _))
+  (
+    result.getLocation().hasLocationInfo(_, _, _, line, _) or
+    result.getLocation().hasLocationInfo(_, line, _, _, _)
+  )
   or
   // The comment can be right above the result, so an alert also counts for the line above.
   not exists(Expr e |
     e.getFile() = file and [e.getLocation().getStartLine(), e.getLocation().getEndLine()] = line
   ) and
   result = alerts(conf) and
   result.getFile() = file and
-  result.hasLocationInfo(_, line + 1, _, _, _)
+  result.getLocation().hasLocationInfo(_, line + 1, _, _, _)
 }
 
 /**

javascript/ql/src/LanguageFeatures/InconsistentNew.ql

@@ -88,7 +88,8 @@ predicate whitelistedCall(DataFlow::CallNode call) {
 DataFlow::InvokeNode getFirstInvocation(Function f, boolean isNew) {
   result =
     min(DataFlow::InvokeNode invk, string path, int line, int col |
-      f = getALikelyCallee(invk, isNew) and invk.hasLocationInfo(path, line, col, _, _)
+      f = getALikelyCallee(invk, isNew) and
+      invk.getLocation().hasLocationInfo(path, line, col, _, _)
     |
       invk order by path, line, col
     )

javascript/ql/src/LanguageFeatures/SpuriousArguments.ql

@@ -79,7 +79,7 @@ class SpuriousArguments extends Expr {
     exists(DataFlow::Node lastArg |
       lastArg = max(DataFlow::Node arg, int i | arg = invk.getArgument(i) | arg order by i)
     |
-      lastArg.hasLocationInfo(_, _, _, endline, endcolumn)
+      lastArg.getLocation().hasLocationInfo(_, _, _, endline, endcolumn)
     )
   }
 }

javascript/ql/test/ApiGraphs/VerifyAssertions.qll

@@ -29,7 +29,7 @@ private DataFlow::Node getNode(API::Node nd, string kind) {
 
 private string getLoc(DataFlow::Node nd) {
   exists(string filepath, int startline |
-    nd.hasLocationInfo(filepath, startline, _, _, _) and
+    nd.getLocation().hasLocationInfo(filepath, startline, _, _, _) and
     result = filepath + ":" + startline
   )
 }

javascript/ql/test/library-tests/TypeTracking/TypeTracking.ql

@@ -6,7 +6,7 @@ DataFlow::SourceNode trackNamedNode(DataFlow::TypeTracker t, string name) {
   exists(Comment c, string f, int l |
     f = c.getFile().getAbsolutePath() and
     l = c.getLocation().getStartLine() and
-    result.hasLocationInfo(f, l, _, _, _) and
+    result.getLocation().hasLocationInfo(f, l, _, _, _) and
     name = c.getText().regexpFind("(?<=name: )\\S+", _, _)
   )
   or