JS: introduce common class for Babel plugins

asger-semmle · asger-semmle · commit 3bd91bdf08f8 · 2018-10-26T12:55:37.000+01:00
diff --git a/javascript/ql/src/Declarations/UnusedVariable.ql b/javascript/ql/src/Declarations/UnusedVariable.ql
@@ -65,8 +65,8 @@ predicate isReactImportForJSX(UnusedLocal v) {
     or
     // JSX pragma from a .babelrc file
     exists (Babel::TransformReactJsxConfig plugin |
-      plugin.getConfig().getAContainerInScope() = is.getFile() and
-      plugin.getJSXFactoryVariableName() = v.getName())
+      plugin.appliesTo(is.getTopLevel()) and
+      plugin.getJsxFactoryVariableName() = v.getName())
   )
 }
 
diff --git a/javascript/ql/src/semmle/javascript/frameworks/Babel.qll b/javascript/ql/src/semmle/javascript/frameworks/Babel.qll
@@ -40,6 +40,50 @@ module Babel {
       not result.getAChildContainer() = any(PackageJSON pkg).getFile() and
       not result.getAChildContainer() = any(Config pkg).getFile()
     }
+
+    /**
+     * Holds if this configuration applies to `tl`.
+     */
+    predicate appliesTo(TopLevel tl) {
+      tl.getFile() = getAContainerInScope()
+    }
+  }
+
+  /**
+   * Configuration object for a Babel plugin.
+   */
+  class Plugin extends JSONValue {
+    Config cfg;
+    string pluginName;
+
+    Plugin() {
+      this = cfg.getPluginConfig(pluginName)
+    }
+
+    /** Gets the name of the plugin begin installed. */
+    string getPluginName() {
+      result = pluginName
+    }
+
+    /** Gets the enclosing Babel configuration object. */
+    Config getConfig() {
+      result = cfg
+    }
+
+    /** Gets the options value passed to the plugin, if any. */
+    JSONValue getOptions() {
+      result = this.(JSONArray).getElementValue(1)
+    }
+
+    /** Gets a named option from the option object, if present. */
+    JSONValue getOption(string name) {
+      result = getOptions().(JSONObject).getPropValue(name)
+    }
+
+    /** Holds if this plugin applies to `tl`. */
+    predicate appliesTo(TopLevel tl) {
+      cfg.appliesTo(tl)
+    }
   }
 
   /**
@@ -50,11 +94,9 @@ module Babel {
    * each path is of the form `{ "rootPathPrefix": "...", "rootPathSuffix": "..." }` and explicitly
    * specifies a mapping from a path prefix to a root.
    */
-  class RootImportConfig extends JSONArray {
-    Config cfg;
-
+  class RootImportConfig extends Plugin {
     RootImportConfig() {
-      this = cfg.getPluginConfig("babel-plugin-root-import")
+      pluginName = "babel-plugin-root-import"
     }
 
     /**
@@ -74,15 +116,16 @@ module Babel {
      */
     private JSONObject getARootPathSpec() {
       // ["babel-plugin-root-import", <spec>]
-      result = getElementValue(1) and
+      result = getOptions() and
       exists(result.getPropValue("rootPathSuffix"))
       or
       exists (JSONArray pathSpecs |
         // ["babel-plugin-root-import", [ <spec>... ] ]
-        pathSpecs = getElementValue(1)
+        pathSpecs = getOptions()
         or
         // ["babel-plugin-root-import", { "paths": [ <spec> ... ] }]
-        pathSpecs = getElementValue(1).(JSONObject).getPropValue("paths") |
+        pathSpecs = getOption("paths")
+        |
         result = pathSpecs.getElementValue(_)
       )
     }
@@ -107,37 +150,30 @@ module Babel {
     Folder getFolder() {
       result = getFile().getParentContainer()
     }
-
-    /**
-     * Holds if this configuration applies to `tl`.
-     */
-    predicate appliesTo(TopLevel tl) {
-      tl.getFile().getParentContainer+() = getFolder()
-    }
   }
 
   /**
    * An import path expression that may be transformed by `babel-plugin-root-import`.
    */
   private class BabelRootTransformedPathExpr extends PathExpr, Expr {
-    RootImportConfig cfg;
+    RootImportConfig plugin;
     string rawPath;
     string prefix;
     string mappedPrefix;
     string suffix;
 
     BabelRootTransformedPathExpr() {
       this instanceof PathExpr and
-      cfg.appliesTo(getTopLevel()) and
+      plugin.appliesTo(getTopLevel()) and
       rawPath = getStringValue() and
       prefix = rawPath.regexpCapture("(.)/(.*)", 1) and
       suffix = rawPath.regexpCapture("(.)/(.*)", 2) and
-      mappedPrefix = cfg.getRoot(prefix)
+      mappedPrefix = plugin.getRoot(prefix)
     }
 
     /** Gets the configuration that applies to this path. */
-    RootImportConfig getConfig() {
-      result = cfg
+    RootImportConfig getPlugin() {
+      result = plugin
     }
 
     override string getValue() {
@@ -146,7 +182,7 @@ module Babel {
 
     override Folder getSearchRoot(int priority) {
       priority = 0 and
-      result = cfg.getFolder()
+      result = plugin.getFolder()
     }
   }
 
@@ -161,7 +197,7 @@ module Babel {
     }
 
     override Folder getARootFolder() {
-      result = pathExpr.getConfig().getFolder()
+      result = pathExpr.getPlugin().getFolder()
     }
   }
 
@@ -171,26 +207,14 @@ module Babel {
    * The plugin option `{"pragma": xxx}` specifies a variable name used to instantiate
    * JSX elements.
    */
-  class TransformReactJsxConfig extends JSONArray {
-    Config cfg;
-
+  class TransformReactJsxConfig extends Plugin {
     TransformReactJsxConfig() {
-      this = cfg.getPluginConfig("transform-react-jsx")
-    }
-
-    /** Gets the Babel configuration object. */
-    Config getConfig() {
-      result = cfg
-    }
-
-    /** Gets the options passed to this plugin. */
-    JSONObject getOptions() {
-      result = getElementValue(1)
+      pluginName = "transform-react-jsx"
     }
 
     /** Gets the name of the variable used to create JSX elements. */
-    string getJSXFactoryVariableName() {
-      result = getOptions().getPropStringValue("pragma")
+    string getJsxFactoryVariableName() {
+      result = getOption("pragma").(JSONString).getValue()
     }
   }
 }

Original file line number	Diff line number	Diff line change
`@@ -65,8 +65,8 @@ predicate isReactImportForJSX(UnusedLocal v) {`
`65`	`65`	`or`
`66`	`66`	`// JSX pragma from a .babelrc file`
`67`	`67`	`exists (Babel::TransformReactJsxConfig plugin \|`
`68`		`- plugin.getConfig().getAContainerInScope() = is.getFile() and`
`69`		`- plugin.getJSXFactoryVariableName() = v.getName())`
	`68`	`+ plugin.appliesTo(is.getTopLevel()) and`
	`69`	`+ plugin.getJsxFactoryVariableName() = v.getName())`
`70`	`70`	`)`
`71`	`71`	`}`
`72`	`72`