Skip to content

Commit 0da1ac4

Browse files
author
Esben Sparre Andreasen
committed
JS: naming and documentation cleanup for NodeJS file system accesses
1 parent 64b0d39 commit 0da1ac4

File tree

1 file changed

+14
-12
lines changed

1 file changed

+14
-12
lines changed

javascript/ql/src/semmle/javascript/frameworks/NodeJSLib.qll

Lines changed: 14 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -401,17 +401,19 @@ module NodeJSLib {
401401
)
402402
}
403403

404-
405404
/**
406405
* A call to a method from module `fs`, `graceful-fs` or `fs-extra`.
407406
*/
408-
private class NodeJSFileSystemAccessCall extends FileSystemAccess, DataFlow::CallNode {
407+
private class NodeJSFileSystemAccess extends FileSystemAccess, DataFlow::CallNode {
409408
string methodName;
410409

411-
NodeJSFileSystemAccessCall() {
410+
NodeJSFileSystemAccess() {
412411
this = fsModuleMember(methodName).getACall()
413412
}
414413

414+
/**
415+
* Gets the name of the called method.
416+
*/
415417
string getMethodName() {
416418
result = methodName
417419
}
@@ -422,9 +424,9 @@ module NodeJSLib {
422424
}
423425
}
424426

425-
/** Only NodeJSSystemFileAccessCalls that write data to 'fs' */
426-
private class NodeJSFileSystemAccessWriteCall extends FileSystemWriteAccess, NodeJSFileSystemAccessCall {
427-
NodeJSFileSystemAccessWriteCall () {
427+
/** A write to the file system. */
428+
private class NodeJSFileSystemAccessWrite extends FileSystemWriteAccess, NodeJSFileSystemAccess {
429+
NodeJSFileSystemAccessWrite () {
428430
methodName = "appendFile" or
429431
methodName = "appendFileSync" or
430432
methodName = "write" or
@@ -449,9 +451,9 @@ module NodeJSLib {
449451

450452
}
451453

452-
/** Only NodeJSSystemFileAccessCalls that read data from 'fs' */
453-
private class NodeJSFileSystemAccessReadCall extends FileSystemReadAccess, NodeJSFileSystemAccessCall {
454-
NodeJSFileSystemAccessReadCall () {
454+
/** A file system read. */
455+
private class NodeJSFileSystemAccessRead extends FileSystemReadAccess, NodeJSFileSystemAccess {
456+
NodeJSFileSystemAccessRead () {
455457
methodName = "read" or
456458
methodName = "readSync" or
457459
methodName = "readFile" or
@@ -478,11 +480,11 @@ module NodeJSLib {
478480
}
479481

480482
/**
481-
* A write to the file system using a stream.
483+
* A read from the file system.
482484
*/
483485
private class FileStreamWrite extends FileSystemWriteAccess, DataFlow::CallNode {
484486

485-
NodeJSFileSystemAccessCall stream;
487+
NodeJSFileSystemAccess stream;
486488

487489
FileStreamWrite() {
488490
stream.getMethodName() = "createWriteStream" and
@@ -507,7 +509,7 @@ module NodeJSLib {
507509
*/
508510
private class FileStreamRead extends FileSystemReadAccess, DataFlow::CallNode {
509511

510-
NodeJSFileSystemAccessCall stream;
512+
NodeJSFileSystemAccess stream;
511513

512514
string method;
513515

0 commit comments

Comments
 (0)