-
Notifications
You must be signed in to change notification settings - Fork 465
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
tools: add tool to check for N-API modules #346
Changes from 1 commit
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,96 @@ | ||
// Descend into a directory structure and, for each file matching *.node, output | ||
// based on the imports found in the file whether it's an N-API module or not. | ||
|
||
const fs = require('fs'); | ||
const path = require('path'); | ||
const child_process = require('child_process'); | ||
|
||
// Read the output of the command, break it into lines, and use the reducer to | ||
// decide whether the file is an N-API module or not. | ||
function checkFile(file, command, arguments, reducer) { | ||
const child = child_process.spawn(command, arguments, { | ||
stdio: ['inherit', 'pipe', 'inherit'] | ||
}); | ||
let leftover = ''; | ||
let isNapi = undefined; | ||
child.stdout.on('data', (chunk) => { | ||
if (isNapi === undefined) { | ||
chunk = leftover + chunk.toString(); | ||
const haveLeftover = !!chunk.match(/[\r\n]+$/); | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I think this can be removed as it is not used. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Is the chunk guaranteed to end on a line boundary? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Oh, NM. You meant the variable, not the rest of the logic. You're right. |
||
chunk = chunk.split(/[\r\n]+/); | ||
leftover = chunk.pop(); | ||
isNapi = chunk.reduce(reducer, isNapi); | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. At this point, we can kill the child process if |
||
} | ||
}); | ||
child.on('exit', (code, signal) => { | ||
if ((code === null && signal !== null) || (code !== 0)) { | ||
console.log( | ||
command + ' exited with code: ' + code + ' and signal: ' + signal); | ||
} else { | ||
console.log( | ||
'\033[' + (isNapi ? '42' : '41') + 'm' + | ||
(isNapi ? ' N-API' : 'Not N-API') + | ||
'\033[0m: ' + file); | ||
} | ||
}); | ||
} | ||
|
||
// Use nm -a to list symbols. | ||
function checkFileUNIX(file) { | ||
checkFile(file, 'nm', ['-a', file], (soFar, line) => { | ||
if (soFar === undefined) { | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Nit: Indentation is not consistent in this and the other two functions as well. |
||
line = line.match(/([0-9a-f]*)? ([a-zA-Z]) (.*$)/); | ||
line.shift(); | ||
if (line[1] === 'U') { | ||
if (line[2].match(/^napi/)) { | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Wouldn't returning from here and changing the condition at 41 to There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Also, if we don't want to get the matches but need to check if the string matches the format, then I believe There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I don't like having The reason I don't have There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Fair enough 👍 |
||
soFar = true; | ||
} | ||
} | ||
} | ||
return soFar; | ||
}); | ||
} | ||
|
||
// Use dumpbin /imports to list symbols. | ||
function checkFileWin32(file) { | ||
checkFile(file, 'dumpbin', ['/imports', file], (soFar, line) => { | ||
if (soFar === undefined) { | ||
line = line.match(/([0-9a-f]*)? +([a-zA-Z0-9]) (.*$)/); | ||
if (line && line[line.length - 1].match(/^napi/)) { | ||
soFar = true; | ||
} | ||
} | ||
return soFar; | ||
}); | ||
} | ||
|
||
// Descend into a directory structure and pass each file ending in '.node' to | ||
// one of the above checks, depending on the OS. | ||
function recurse(top) { | ||
fs.readdir(top, (error, items) => { | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Nit: This error is ignored. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Fixed. |
||
items.forEach((item) => { | ||
item = path.join(top, item); | ||
fs.stat(item, ((item) => (error, stats) => { | ||
if (!error) { | ||
if (stats.isDirectory()) { | ||
recurse(item); | ||
} else if (item.match(/[.]node$/) && | ||
// Explicitly ignore files called 'nothing.node' because they are | ||
// artefacts of node-addon-api having identified a version of | ||
// Node.js that ships with a correct implementation of N-API. | ||
path.basename(item) !== 'nothing.node') { | ||
process.platform === 'win32' ? | ||
checkFileWin32(item) : | ||
checkFileUNIX(item); | ||
} | ||
} else { | ||
throw ("error about " + item + ": " + error); | ||
} | ||
})(item)); | ||
}); | ||
}); | ||
} | ||
|
||
// Start with the directory given on the command line or the current directory | ||
// if nothing was given. | ||
recurse(process.argv.length > 3 ? process.argv[2] : '.'); |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nit: Generally strict mode is preferred.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@thefourtheye fixed, and a good thing too, because it had implications for the rest of the code. Thanks!