Skip to content
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

Closed
wants to merge 3 commits into from
Closed
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
squash! add doc and address nits
Gabriel Schulhof committed Sep 20, 2018
commit 63193525c65e9eeafd6684cad78b46bcf7ee73fe
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -57,6 +57,7 @@ to ideas specified in the **ECMA262 Language Specification**.
- [node-gyp](doc/node-gyp.md)
- [cmake-js](doc/cmake-js.md)
- [Conversion tool](doc/conversion-tool.md)
- [Checker tool](doc/checker-tool.md)
- [Generator](doc/generator.md)

<a name="api"></a>
32 changes: 32 additions & 0 deletions doc/checker-tool.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
# Checker Tool

**node-addon-api** provides a [checker tool][] that will inspect a given
directory tree, identifying all Node.js native addons therein, and further
indicating for each addon whether it is an N-API addon.

## To use the checker tool:

1. Install the application with `npm install`.

2. If the application does not depend on **node-addon-api**, copy the
checker tool into the application's directory.

3. If the application does not depend on **node-addon-api**, run the checker
tool from the application's directory:

```sh
node ./check-napi.js
```

Otherwise, the checker tool can be run from the application's
`node_modules/` subdirectory:
```sh
node ./node_modules/node-addon-api/tools/check-napi.js
```
The tool accepts the root directory from which to start checking for Node.js
native addons as a single optional command line parameter. If ommitted it will
start checking from the current directory (`.`).
[checker tool]: ../tools/check-napi.js
64 changes: 34 additions & 30 deletions tools/check-napi.js
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
'use strict';
// 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.

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.

Copy link
Contributor Author

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!

@@ -7,8 +8,8 @@ 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, {
function checkFile(file, command, argv, reducer) {
const child = child_process.spawn(command, argv, {
stdio: ['inherit', 'pipe', 'inherit']
});
let leftover = '';
@@ -28,64 +29,67 @@ function checkFile(file, command, arguments, reducer) {
console.log(
command + ' exited with code: ' + code + ' and signal: ' + signal);
} else {
// Green if it's a N-API module, red otherwise.
console.log(
'\033[' + (isNapi ? '42' : '41') + 'm' +
'\x1b[' + (isNapi ? '42' : '41') + 'm' +
(isNapi ? ' N-API' : 'Not N-API') +
'\033[0m: ' + file);
'\x1b[0m: ' + file);
}
});
}

// Use nm -a to list symbols.
function checkFileUNIX(file) {
checkFile(file, 'nm', ['-a', file], (soFar, line) => {
if (soFar === undefined) {
line = line.match(/([0-9a-f]*)? ([a-zA-Z]) (.*$)/);
if (line[2] === 'U') {
if (/^napi/.test(line[3])) {
soFar = true;
}
if (soFar === undefined) {
line = line.match(/([0-9a-f]*)? ([a-zA-Z]) (.*$)/);
if (line[2] === 'U') {
if (/^napi/.test(line[3])) {
soFar = true;
}
}
return soFar;
}
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 && /^napi/.test(line[line.length - 1])) {
soFar = true;
}
if (soFar === undefined) {
line = line.match(/([0-9a-f]*)? +([a-zA-Z0-9]) (.*$)/);
if (line && /^napi/.test(line[line.length - 1])) {
soFar = true;
}
return soFar;
}
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) => {

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nit: This error is ignored.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed.

if (error) {
throw ("error reading directory " + top + ": " + error);
}
items.forEach((item) => {
item = path.join(top, item);
fs.stat(item, ((item) => (error, stats) => {
if (!error) {
if (stats.isDirectory()) {
recurse(item);
} else if (/[.]node$/.test(item) &&
// 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 {
if (error) {
throw ("error about " + item + ": " + error);
}
if (stats.isDirectory()) {
recurse(item);
} else if (/[.]node$/.test(item) &&
// 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);
}
})(item));
});
});