Merge pull request #887 from asger-semmle/jsdoc-accessors

semmle-qlci · web-flow · commit b8be66ec48ea · 2019-02-06T16:30:48.000Z
Approved by xiemaisi
diff --git a/javascript/ql/src/semmle/javascript/Expr.qll b/javascript/ql/src/semmle/javascript/Expr.qll
@@ -29,7 +29,10 @@ class ExprOrType extends @exprortype, Documentable {
       not exists(getOwnDocumentation()) and
       if getParent() instanceof Property
       then result = getParent().(Property).getDocumentation()
-      else result = getEnclosingStmt().getDocumentation()
+      else
+        if getParent() instanceof MethodDeclaration
+        then result = getParent().(MethodDeclaration).getDocumentation()
+        else result = getEnclosingStmt().getDocumentation()
     )
   }
 
diff --git a/javascript/ql/src/semmle/javascript/Variables.qll b/javascript/ql/src/semmle/javascript/Variables.qll
@@ -585,6 +585,13 @@ class Parameter extends BindingPattern {
   int getNumDecorator() { result = count(getADecorator()) }
 
   override predicate isLValue() { any() }
+
+  /**
+   * Gets the JSDoc tag describing this parameter, if any.
+   */
+  JSDocTag getJSDocTag() {
+    none() // overridden in SimpleParameter
+  }
 }
 
 /** A parameter declaration that is not an object or array pattern. */
@@ -601,6 +608,15 @@ class SimpleParameter extends Parameter, VarDecl {
       result = ssa.getVariable().getAUse()
     )
   }
+
+  override JSDocTag getJSDocTag() {
+    exists(Function fun |
+      this = fun.getAParameter() and
+      result = fun.getDocumentation().getATag() and
+      result.getTitle() = "param" and
+      result.getName() = getName()
+    )
+  }
 }
 
 /**
diff --git a/javascript/ql/test/library-tests/JSDoc/Function_getDocumentation.expected b/javascript/ql/test/library-tests/JSDoc/Function_getDocumentation.expected
@@ -37,3 +37,7 @@
 | tst.js:343:12:343:36 | functio ... rn a; } | tst.js:338:1:342:3 | /**\\n *  ... e T\\n */ |
 | tst.js:354:1:354:16 | function f(x) {} | tst.js:351:1:353:3 | /**\\n *  ... ger\\n */ |
 | tst.js:360:1:360:27 | functio ...  fn) {} | tst.js:356:1:359:3 | /**\\n *  ... ion\\n */ |
+| tst.js:366:18:366:31 | function(p) {} | tst.js:363:3:365:5 | /**\\n    ... p\\n   */ |
+| tst.js:371:14:371:19 | (p) {} | tst.js:368:3:370:5 | /**\\n    ... p\\n   */ |
+| tst.js:378:14:378:19 | (p) {} | tst.js:375:3:377:5 | /**\\n    ... p\\n   */ |
+| tst.js:383:14:383:19 | (p) {} | tst.js:380:3:382:5 | /**\\n    ... p\\n   */ |
diff --git a/javascript/ql/test/library-tests/JSDoc/JSDoc.expected b/javascript/ql/test/library-tests/JSDoc/JSDoc.expected
@@ -65,3 +65,7 @@
 | tst.js:349:1:349:31 | /** @ty ... ned} */ |  | tst.js:349:1:349:31 | /** @ty ... ned} */ |
 | tst.js:351:1:353:3 | /**\\n *  ... ger\\n */ |  | tst.js:351:1:353:3 | /**\\n *  ... ger\\n */ |
 | tst.js:356:1:359:3 | /**\\n *  ... ion\\n */ |  | tst.js:356:1:359:3 | /**\\n *  ... ion\\n */ |
+| tst.js:363:3:365:5 | /**\\n    ... p\\n   */ |  | tst.js:363:3:365:5 | /**\\n    ... p\\n   */ |
+| tst.js:368:3:370:5 | /**\\n    ... p\\n   */ |  | tst.js:368:3:370:5 | /**\\n    ... p\\n   */ |
+| tst.js:375:3:377:5 | /**\\n    ... p\\n   */ |  | tst.js:375:3:377:5 | /**\\n    ... p\\n   */ |
+| tst.js:380:3:382:5 | /**\\n    ... p\\n   */ |  | tst.js:380:3:382:5 | /**\\n    ... p\\n   */ |
diff --git a/javascript/ql/test/library-tests/JSDoc/JSDocTag.expected b/javascript/ql/test/library-tests/JSDoc/JSDocTag.expected
@@ -100,3 +100,7 @@
 | tst.js:352:4:352:9 | @param | param | tst.js:351:1:353:3 | /**\\n *  ... ger\\n */ | 0 | [int] an integer | (none) | (none) |
 | tst.js:357:4:357:9 | @param | param | tst.js:356:1:359:3 | /**\\n *  ... ion\\n */ | 0 | the array to sort\n | array | Array.<number> |
 | tst.js:358:4:358:9 | @param | param | tst.js:356:1:359:3 | /**\\n *  ... ion\\n */ | 1 | the comparator function | fn | function (x: !number, y: !number): number |
+| tst.js:364:6:364:11 | @param | param | tst.js:363:3:365:5 | /**\\n    ... p\\n   */ | 0 | (none) | p | T1 |
+| tst.js:369:6:369:11 | @param | param | tst.js:368:3:370:5 | /**\\n    ... p\\n   */ | 0 | (none) | p | T2 |
+| tst.js:376:6:376:11 | @param | param | tst.js:375:3:377:5 | /**\\n    ... p\\n   */ | 0 | (none) | p | T3 |
+| tst.js:381:6:381:11 | @param | param | tst.js:380:3:382:5 | /**\\n    ... p\\n   */ | 0 | (none) | p | T4 |
diff --git a/javascript/ql/test/library-tests/JSDoc/JSDocTypeExpr.expected b/javascript/ql/test/library-tests/JSDoc/JSDocTypeExpr.expected
@@ -51,6 +51,10 @@
 | T | @return | 0 |
 | T | @return | 0 |
 | T | @return | 0 |
+| T1 | @param | 0 |
+| T2 | @param | 0 |
+| T3 | @param | 0 |
+| T4 | @param | 0 |
 | U | A.<U> | 0 |
 | X | @extends | 0 |
 | X | Foo.<X> | 0 |
diff --git a/javascript/ql/test/library-tests/JSDoc/getParameterTag.expected b/javascript/ql/test/library-tests/JSDoc/getParameterTag.expected
@@ -0,0 +1,15 @@
+| tst.js:146:37:146:44 | groupNum | groupNum | tst.js:142:4:142:9 | @param | groupNum | number |
+| tst.js:146:47:146:50 | term | term | tst.js:143:4:143:9 | @param | term | (string\|number\|null) |
+| tst.js:166:59:166:65 | element | element | tst.js:163:4:163:9 | @param | element | Element |
+| tst.js:220:28:220:28 | x | x | tst.js:219:5:219:10 | @param | x | goog.NumberLike |
+| tst.js:256:30:256:30 | t | t | tst.js:255:5:255:10 | @param | t | T |
+| tst.js:266:16:266:16 | t | t | tst.js:262:4:262:9 | @param | t | T |
+| tst.js:295:22:295:25 | fooY | fooY | tst.js:294:5:294:10 | @param | fooY | Foo.<Y> |
+| tst.js:307:31:307:31 | t | t | tst.js:306:5:306:10 | @param | t | T |
+| tst.js:343:21:343:21 | a | a | tst.js:339:4:339:9 | @param | a | T |
+| tst.js:360:15:360:19 | array | array | tst.js:357:4:357:9 | @param | array | Array.<number> |
+| tst.js:360:22:360:23 | fn | fn | tst.js:358:4:358:9 | @param | fn | function (x: !number, y: !number): number |
+| tst.js:366:27:366:27 | p | p | tst.js:364:6:364:11 | @param | p | T1 |
+| tst.js:371:15:371:15 | p | p | tst.js:369:6:369:11 | @param | p | T2 |
+| tst.js:378:15:378:15 | p | p | tst.js:376:6:376:11 | @param | p | T3 |
+| tst.js:383:15:383:15 | p | p | tst.js:381:6:381:11 | @param | p | T4 |
diff --git a/javascript/ql/test/library-tests/JSDoc/getParameterTag.ql b/javascript/ql/test/library-tests/JSDoc/getParameterTag.ql
@@ -0,0 +1,5 @@
+import javascript
+
+from Parameter param, JSDocTag tag
+where tag = param.getJSDocTag()
+select param, param.getName(), tag, tag.getName(), tag.getType()
diff --git a/javascript/ql/test/library-tests/JSDoc/next_token.expected b/javascript/ql/test/library-tests/JSDoc/next_token.expected
@@ -85,3 +85,7 @@
 | tst.js:349:1:349:31 | /** @ty ... ned} */ | tst.js:349:33:349:35 | var |
 | tst.js:351:1:353:3 | /**\\n *  ... ger\\n */ | tst.js:354:1:354:8 | function |
 | tst.js:356:1:359:3 | /**\\n *  ... ion\\n */ | tst.js:360:1:360:8 | function |
+| tst.js:363:3:365:5 | /**\\n    ... p\\n   */ | tst.js:366:3:366:15 | classicMethod |
+| tst.js:368:3:370:5 | /**\\n    ... p\\n   */ | tst.js:371:3:371:13 | fancyMethod |
+| tst.js:375:3:377:5 | /**\\n    ... p\\n   */ | tst.js:378:3:378:13 | constructor |
+| tst.js:380:3:382:5 | /**\\n    ... p\\n   */ | tst.js:383:3:383:13 | classMethod |
diff --git a/javascript/ql/test/library-tests/JSDoc/tst.js b/javascript/ql/test/library-tests/JSDoc/tst.js
@@ -358,3 +358,27 @@ function f(x) {}
  * @param {function(x:!number, y:!number):number} fn - the comparator function
  */
 function sort(array, fn) {}
+
+var literalWithMethods = {
+  /**
+   * @param {T1} p
+   */
+  classicMethod: function(p) {},
+  
+  /**
+   * @param {T2} p
+   */
+  fancyMethod(p) {}
+};
+
+class C {
+  /**
+   * @param {T3} p
+   */
+  constructor(p) {}
+
+  /**
+   * @param {T4} p
+   */
+  classMethod(p) {}
+}

Original file line number	Diff line number	Diff line change
`@@ -29,7 +29,10 @@ class ExprOrType extends @exprortype, Documentable {`
`29`	`29`	`not exists(getOwnDocumentation()) and`
`30`	`30`	`if getParent() instanceof Property`
`31`	`31`	`then result = getParent().(Property).getDocumentation()`
`32`		`- else result = getEnclosingStmt().getDocumentation()`
	`32`	`+ else`
	`33`	`+ if getParent() instanceof MethodDeclaration`
	`34`	`+ then result = getParent().(MethodDeclaration).getDocumentation()`
	`35`	`+ else result = getEnclosingStmt().getDocumentation()`
`33`	`36`	`)`
`34`	`37`	`}`
`35`	`38`