Merge pull request #8254 from asgerf/ruby/mad-prototype

Ruby: initial prototype of models-as-data

Author: asgerf

config/identical-files.json

@@ -515,5 +515,9 @@
     "java/ql/lib/semmle/code/java/dataflow/internal/AccessPathSyntax.qll",
     "javascript/ql/lib/semmle/javascript/frameworks/data/internal/AccessPathSyntax.qll",
     "ruby/ql/lib/codeql/ruby/dataflow/internal/AccessPathSyntax.qll"
+  ],
+  "ApiGraphModels": [
+    "javascript/ql/lib/semmle/javascript/frameworks/data/internal/ApiGraphModels.qll",
+    "ruby/ql/lib/codeql/ruby/frameworks/data/internal/ApiGraphModels.qll"
   ]
 }

javascript/ql/lib/semmle/javascript/ApiGraphs.qll

@@ -371,8 +371,12 @@ module API {
   /**
    * An API entry point.
    *
-   * Extend this class to define additional API entry points other than modules.
-   * Typical examples include global variables.
+   * By default, API graph nodes are only created for nodes that come from an external
+   * library or escape into an external library. The points where values are cross the boundary
+   * between codebases are called "entry points".
+   *
+   * Imports and exports are considered entry points by default, but additional entry points may
+   * be added by extending this class. Typical examples include global variables.
    */
   abstract class EntryPoint extends string {
     bindingset[this]
@@ -385,7 +389,10 @@ module API {
     abstract DataFlow::Node getARhs();
 
     /** Gets an API-node for this entry point. */
-    API::Node getNode() { result = root().getASuccessor(Label::entryPoint(this)) }
+    API::Node getANode() { result = root().getASuccessor(Label::entryPoint(this)) }
+
+    /** DEPRECATED. Use `getANode()` instead. */
+    deprecated API::Node getNode() { result = this.getANode() }
   }
 
   /**

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

@@ -23,7 +23,7 @@ module D3 {
     or
     result = API::moduleImport("d3-node").getInstance().getMember("d3")
     or
-    result = any(D3GlobalEntry i).getNode()
+    result = any(D3GlobalEntry i).getANode()
   }
 
   /**

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

@@ -17,7 +17,7 @@ module History {
    * Gets a reference to the [`history`](https://npmjs.org/package/history) library.
    */
   private API::Node history() {
-    result = [API::moduleImport("history"), any(HistoryGlobalEntry h).getNode()]
+    result = [API::moduleImport("history"), any(HistoryGlobalEntry h).getANode()]
   }
 
   /**

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

@@ -27,7 +27,7 @@ private module Immutable {
   API::Node immutableImport() {
     result = API::moduleImport("immutable")
     or
-    result = any(ImmutableGlobalEntry i).getNode()
+    result = any(ImmutableGlobalEntry i).getANode()
   }
 
   /**

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

@@ -45,7 +45,7 @@ private module Console {
    */
   private API::Node console() {
     result = API::moduleImport("console") or
-    result = any(ConsoleGlobalEntry e).getNode()
+    result = any(ConsoleGlobalEntry e).getANode()
   }
 
   /**

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

@@ -151,7 +151,7 @@ module NestJS {
   private API::Node validationPipe() {
     result = nestjs().getMember("ValidationPipe")
     or
-    result = any(ValidationNodeEntry e).getNode()
+    result = any(ValidationNodeEntry e).getANode()
   }
 
   /**

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

@@ -1111,7 +1111,7 @@ module Redux {
 
     /** A heuristic call to `connect`, recognized by it taking arguments named `mapStateToProps` and `mapDispatchToProps`. */
     private class HeuristicConnectFunction extends ConnectCall {
-      HeuristicConnectFunction() { this = any(HeuristicConnectEntryPoint e).getNode().getACall() }
+      HeuristicConnectFunction() { this = any(HeuristicConnectEntryPoint e).getANode().getACall() }
 
       override API::Node getMapStateToProps() {
         result = getAParameter() and

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

@@ -19,7 +19,7 @@ module TrustedTypes {
     override DataFlow::Node getARhs() { none() }
   }
 
-  private API::Node trustedTypesObj() { result = any(TrustedTypesEntry entry).getNode() }
+  private API::Node trustedTypesObj() { result = any(TrustedTypesEntry entry).getANode() }
 
   /** A call to `trustedTypes.createPolicy`. */
   class PolicyCreation extends API::CallNode {

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

@@ -35,7 +35,7 @@ module Vue {
   API::Node vueLibrary() {
     result = API::moduleImport("vue")
     or
-    result = any(GlobalVueEntryPoint e).getNode()
+    result = any(GlobalVueEntryPoint e).getANode()
   }
 
   /**
@@ -51,7 +51,7 @@ module Vue {
     or
     result = vueLibrary().getMember("component").getReturn()
     or
-    result = any(VueFileImportEntryPoint e).getNode()
+    result = any(VueFileImportEntryPoint e).getANode()
   }
 
   /**