Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit c5fb19c

Browse files
erik-krogherik-krogh
committed
update the JS API-graph labels toString() to print the predicate calls on the API-graphs
1 parent 57c39e9 commit c5fb19c

29 files changed

Lines changed: 97 additions & 83 deletions

File tree

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

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1151,28 +1151,28 @@ module API {
11511151
/** Gets the EntryPoint associated with this label. */
11521152
API::EntryPoint getEntryPoint() { result = e }
11531153

1154-
override string toString() { result = e }
1154+
override string toString() { result = "getASuccessor(Label::entryPoint(\"" + e + "\"))" }
11551155
}
11561156

11571157
/** A label that gets a promised value. */
11581158
class LabelPromised extends ApiLabel {
11591159
LabelPromised() { this = MkLabelPromised() }
11601160

1161-
override string toString() { result = "promised" }
1161+
override string toString() { result = "getPromised()" }
11621162
}
11631163

11641164
/** A label that gets a rejected promise. */
11651165
class LabelPromisedError extends ApiLabel {
11661166
LabelPromisedError() { this = MkLabelPromisedError() }
11671167

1168-
override string toString() { result = "promisedError" }
1168+
override string toString() { result = "getPromisedError()" }
11691169
}
11701170

11711171
/** A label that gets the return value of a function. */
11721172
class LabelReturn extends ApiLabel {
11731173
LabelReturn() { this = MkLabelReturn() }
11741174

1175-
override string toString() { result = "return" }
1175+
override string toString() { result = "getReturn()" }
11761176
}
11771177

11781178
/** A label for a module. */
@@ -1184,14 +1184,15 @@ module API {
11841184
/** Gets the module associated with this label. */
11851185
string getMod() { result = mod }
11861186

1187-
override string toString() { result = "module " + mod }
1187+
// moduleImport is not neccesarilly the predicate to use, but it's close enough for most cases.
1188+
override string toString() { result = "moduleImport(\"" + mod + "\")" }
11881189
}
11891190

11901191
/** A label that gets an instance from a `new` call. */
11911192
class LabelInstance extends ApiLabel {
11921193
LabelInstance() { this = MkLabelInstance() }
11931194

1194-
override string toString() { result = "instance" }
1195+
override string toString() { result = "getInstance()" }
11951196
}
11961197

11971198
/** A label for the member named `prop`. */
@@ -1203,14 +1204,14 @@ module API {
12031204
/** Gets the property associated with this label. */
12041205
string getProperty() { result = prop }
12051206

1206-
override string toString() { result = "member " + prop }
1207+
override string toString() { result = "getMember(\"" + prop + "\")" }
12071208
}
12081209

12091210
/** A label for a member with an unknown name. */
12101211
class LabelUnknownMember extends ApiLabel {
12111212
LabelUnknownMember() { this = MkLabelUnknownMember() }
12121213

1213-
override string toString() { result = "member *" }
1214+
override string toString() { result = "getUnknownMember()" }
12141215
}
12151216

12161217
/** A label for parameter `i`. */
@@ -1219,15 +1220,15 @@ module API {
12191220

12201221
LabelParameter() { this = MkLabelParameter(i) }
12211222

1222-
override string toString() { result = "parameter " + i }
1223+
override string toString() { result = "getParameter(" + i + ")" }
12231224

12241225
/** Gets the index of the parameter for this label. */
12251226
int getIndex() { result = i }
12261227
}
12271228

12281229
/** A label for the receiver of call, that is, the value passed as `this`. */
12291230
class LabelReceiver extends ApiLabel, MkLabelReceiver {
1230-
override string toString() { result = "receiver" }
1231+
override string toString() { result = "getReceiver()" }
12311232
}
12321233
}
12331234
}

‎javascript/ql/test/ApiGraphs/VerifyAssertions.qll‎

Lines changed: 28 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,11 @@
11
/**
22
* A test query that verifies assertions about the API graph embedded in source-code comments.
33
*
4-
* An assertion is a comment of the form `def <path>` or `use <path>`, and asserts that
5-
* there is a def/use feature reachable from the root along the given path (described using
6-
* s-expression syntax), and its associated data-flow node must start on the same line as the
7-
* comment.
4+
* An assertion is a comment of the form `def=<path>` or `use=<path>`, and asserts that
5+
* there is a def/use feature reachable from the root along the given path, and its
6+
* associated data-flow node must start on the same line as the comment.
87
*
9-
* We also support negative assertions of the form `!def <path>` or `!use <path>`, which assert
8+
* We also support negative assertions of the form `MISSING: def <path>` or `MISSING: use <path>`, which assert
109
* that there _isn't_ a node with the given path on the same line.
1110
*
1211
* The query only produces output for failed assertions, meaning that it should have no output
@@ -39,44 +38,55 @@ private string getLoc(DataFlow::Node nd) {
3938
* An assertion matching a data-flow node against an API-graph feature.
4039
*/
4140
class Assertion extends Comment {
42-
string polarity;
4341
string expectedKind;
4442
string expectedLoc;
43+
string path;
44+
string polarity;
4545

4646
Assertion() {
4747
exists(string txt, string rex |
4848
txt = this.getText().trim() and
49-
rex = "(!?)(def|use) .*"
49+
rex = ".*?((?:MISSING: )?)(def|use)=([\\w\\(\\)\"\\.\\-\\/\\@\\:]*).*"
5050
|
5151
polarity = txt.regexpCapture(rex, 1) and
5252
expectedKind = txt.regexpCapture(rex, 2) and
53+
path = txt.regexpCapture(rex, 3) and
5354
expectedLoc = this.getFile().getAbsolutePath() + ":" + this.getLocation().getStartLine()
5455
)
5556
}
5657

57-
string getEdgeLabel(int i) { result = this.getText().regexpFind("(?<=\\()[^()]+", i, _).trim() }
58+
string getEdgeLabel(int i) {
59+
// matches a single edge. E.g. `getParameter(1)` or `getMember("foo")`.
60+
// The lookbehind/lookahead ensure that the boundary is correct, that is
61+
// either the edge is next to a ".", or it's the end of the string.
62+
result = path.regexpFind("(?<=\\.|^)([\\w\\(\\)\"\\-\\/\\@\\:]+)(?=\\.|$)", i, _).trim()
63+
}
5864

5965
int getPathLength() { result = max(int i | exists(this.getEdgeLabel(i))) + 1 }
6066

67+
predicate isNegative() { polarity = "MISSING: " }
68+
6169
API::Node lookup(int i) {
62-
i = this.getPathLength() and
70+
i = 0 and
6371
result = API::root()
6472
or
6573
result =
66-
this.lookup(i + 1)
67-
.getASuccessor(any(API::Label::ApiLabel label | label.toString() = this.getEdgeLabel(i)))
74+
this.lookup(i - 1)
75+
.getASuccessor(any(API::Label::ApiLabel label |
76+
label.toString() = this.getEdgeLabel(i - 1)
77+
))
6878
}
6979

70-
predicate isNegative() { polarity = "!" }
80+
API::Node lookup() { result = this.lookup(this.getPathLength()) }
7181

72-
predicate holds() { getLoc(getNode(this.lookup(0), expectedKind)) = expectedLoc }
82+
predicate holds() { getLoc(getNode(this.lookup(), expectedKind)) = expectedLoc }
7383

7484
string tryExplainFailure() {
7585
exists(int i, API::Node nd, string prefix, string suffix |
7686
nd = this.lookup(i) and
77-
i > 0 and
78-
not exists(this.lookup([0 .. i - 1])) and
79-
prefix = nd + " has no outgoing edge labelled " + this.getEdgeLabel(i - 1) + ";" and
87+
i < getPathLength() and
88+
not exists(this.lookup([i + 1 .. getPathLength()])) and
89+
prefix = nd + " has no outgoing edge labelled " + this.getEdgeLabel(i) + ";" and
8090
if exists(nd.getASuccessor())
8191
then
8292
suffix =
@@ -91,13 +101,13 @@ class Assertion extends Comment {
91101
result = prefix + " " + suffix
92102
)
93103
or
94-
exists(API::Node nd, string kind | nd = this.lookup(0) |
104+
exists(API::Node nd, string kind | nd = this.lookup() |
95105
exists(getNode(nd, kind)) and
96106
not exists(getNode(nd, expectedKind)) and
97107
result = "Expected " + expectedKind + " node, but found " + kind + " node."
98108
)
99109
or
100-
exists(DataFlow::Node nd | nd = getNode(this.lookup(0), expectedKind) |
110+
exists(DataFlow::Node nd | nd = getNode(this.lookup(), expectedKind) |
101111
not getLoc(nd) = expectedLoc and
102112
result = "Node not found on this line (but there is one on line " + min(getLoc(nd)) + ")."
103113
)

‎javascript/ql/test/ApiGraphs/argprops/index.js‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
const assert = require("assert");
22

33
let o = {
4-
foo: 23 /* def (member foo (parameter 0 (member equal (member exports (module assert))))) */
4+
foo: 23 // def=moduleImport("assert").getMember("exports").getMember("equal").getParameter(0).getMember("foo")
55
};
66
assert.equal(o, o);

‎javascript/ql/test/ApiGraphs/async-await/index.js‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
const fs = require('fs-extra');
22

33
module.exports.foo = async function foo() {
4-
return await fs.copy('/tmp/myfile', '/tmp/mynewfile'); /* use (promised (return (member copy (member exports (module fs-extra))))) */ /* def (promised (return (member foo (member exports (module async-await))))) */
4+
return await fs.copy('/tmp/myfile', '/tmp/mynewfile'); /* use=moduleImport("fs-extra").getMember("exports").getMember("copy").getReturn().getPromised()*/ /* def=moduleImport("async-await").getMember("exports").getMember("foo").getReturn().getPromised() */
55
};

‎javascript/ql/test/ApiGraphs/async-await/tst.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,5 +5,5 @@ async function readFileUtf8(path: string): Promise<string> {
55
}
66

77
async function test(path: string) {
8-
await readFileUtf8(path); /* use (promised (return (member readFile (member exports (module fs/promises))))) */
8+
await readFileUtf8(path); /* use=moduleImport("fs/promises").getMember("exports").getMember("readFile").getReturn() */
99
}

‎javascript/ql/test/ApiGraphs/bound-args/index.js‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,24 @@
11
import bar from 'foo';
22

33
let boundbar = bar.bind(
4-
"receiver", // def (receiver (member default (member exports (module foo))))
5-
"firstarg" // def (parameter 0 (member default (member exports (module foo))))
4+
"receiver", // def=moduleImport("foo").getMember("exports").getMember("default").getReceiver()
5+
"firstarg" // def=moduleImport("foo").getMember("exports").getMember("default").getParameter(0)
66
);
77
boundbar(
8-
"secondarg" // def (parameter 1 (member default (member exports (module foo))))
8+
"secondarg" // def=moduleImport("foo").getMember("exports").getMember("default").getParameter(1)
99
)
1010

1111
let boundbar2 = boundbar.bind(
12-
"ignored", // !def (receiver (member default (member exports (module foo))))
13-
"othersecondarg" // def (parameter 1 (member default (member exports (module foo))))
12+
"ignored", // MISSING: def=moduleImport("foo").getMember("exports)".getMember("default").getReceiver()
13+
"othersecondarg" // def=moduleImport("foo").getMember("exports").getMember("default").getParameter(1)
1414
)
1515
boundbar2(
16-
"thirdarg" // def (parameter 2 (member default (member exports (module foo))))
16+
"thirdarg" // def=moduleImport("foo").getMember("exports").getMember("default").getParameter(2)
1717
)
1818

1919
let bar2 = bar;
2020
for (var i = 0; i < 2; ++i)
2121
bar2 = bar2.bind(
2222
null,
23-
i /* def (parameter 1 (member default (member exports (module foo)))) */ /* def (parameter 9 (member default (member exports (module foo)))) */
23+
i /* def=moduleImport("foo").getMember("exports").getMember("default").getParameter(1) */ /* def=moduleImport("foo").getMember("exports").getMember("default").getParameter(9) */
2424
);

‎javascript/ql/test/ApiGraphs/branching-flow/index.js‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,5 +3,5 @@ const fs = require('fs');
33
exports.foo = function (cb) {
44
if (!cb)
55
cb = function () { };
6-
cb(fs.readFileSync("/etc/passwd")); /* def (parameter 0 (parameter 0 (member foo (member exports (module branching-flow))))) */
6+
cb(fs.readFileSync("/etc/passwd")); /* def=moduleImport("branching-flow").getMember("exports").getMember("foo").getParameter(0).getParameter(0) */
77
};

‎javascript/ql/test/ApiGraphs/classes/classes.js‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,19 +9,19 @@ util.inherits(MyStream, EventEmitter);
99

1010
MyStream.prototype.write = (data) => this.emit('data', data);
1111

12-
function MyOtherStream() { /* use (instance (member MyOtherStream (member exports (module classes)))) */
12+
function MyOtherStream() { /* use=moduleImport("classes").getMember("exports").getMember("MyOtherStream").getInstance() */
1313
EventEmitter.call(this);
1414
}
1515

1616
util.inherits(MyOtherStream, EventEmitter);
1717

18-
MyOtherStream.prototype.write = function (data) { /* use (instance (member MyOtherStream (member exports (module classes)))) */
18+
MyOtherStream.prototype.write = function (data) { /* use=moduleImport("classes").getMember("exports").getMember("MyOtherStream").getInstance() */
1919
this.emit('data', data);
2020
return this;
2121
};
2222

23-
MyOtherStream.prototype.instanceProp = 1; /* def (member instanceProp (instance (member MyOtherStream (member exports (module classes))))) */
23+
MyOtherStream.prototype.instanceProp = 1; /* def=moduleImport("classes").getMember("exports").getMember("MyOtherStream").getInstance().getMember("instanceProp") */
2424

25-
MyOtherStream.classProp = 1; /* def (member classProp (member MyOtherStream (member exports (module classes)))) */
25+
MyOtherStream.classProp = 1; /* def=moduleImport("classes").getMember("exports").getMember("MyOtherStream").getMember("classProp") */
2626

2727
module.exports.MyOtherStream = MyOtherStream;

‎javascript/ql/test/ApiGraphs/ctor-arg/index.js‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
export class A {
2-
constructor(x) { /* use (parameter 0 (member A (member exports (module ctor-arg)))) */
2+
constructor(x) { /* use=moduleImport("ctor-arg").getMember("exports").getMember("A").getParameter(0) */
33
console.log(x);
44
}
55
}

‎javascript/ql/test/ApiGraphs/custom-entry-point/index.js‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
module.exports = CustomEntryPoint.foo; /* use (member foo (CustomEntryPoint)) */
1+
module.exports = CustomEntryPoint.foo; /* use=getASuccessor(Label::entryPoint("CustomEntryPoint")) */

0 commit comments

Comments
 (0)