test: add duplicate symbol test

On OSX symbols are exported by default, and they overlap if two different copies of the same symbol appear in a process. This change ensures that, on OSX, symbols are hidden by default. Re: nodejs/node-addon-api#456 Fixes: nodejs/node#26765 PR-URL: #1689 Reviewed-By: Ben Noordhuis <[email protected]> Reviewed-By: Refael Ackermann <[email protected]>
nodejs · Jun 20, 2019 · 34d22b7 · 34d22b7
1 parent 1cfdb28
commit 34d22b7
Show file tree

Hide file tree

Showing 8 changed files with 120 additions and 0 deletions.
diff --git a/addon.gypi b/addon.gypi
@@ -90,10 +90,14 @@
 
     'conditions': [
       [ 'OS=="mac"', {
+        'cflags': [
+          '-fvisibility=hidden'
+        ],
         'defines': [
           '_DARWIN_USE_64_BIT_INODE=1'
         ],
         'xcode_settings': {
+          'GCC_SYMBOLS_PRIVATE_EXTERN': 'YES', # -fvisibility=hidden
           'DYLIB_INSTALL_NAME_BASE': '@rpath'
         },
       }],

diff --git a/test/node_modules/duplicate_symbols/binding.cc b/test/node_modules/duplicate_symbols/binding.cc
diff --git a/test/node_modules/duplicate_symbols/binding.gyp b/test/node_modules/duplicate_symbols/binding.gyp
diff --git a/test/node_modules/duplicate_symbols/common.h b/test/node_modules/duplicate_symbols/common.h
diff --git a/test/node_modules/duplicate_symbols/extra.cc b/test/node_modules/duplicate_symbols/extra.cc
diff --git a/test/node_modules/duplicate_symbols/index.js b/test/node_modules/duplicate_symbols/index.js
diff --git a/test/node_modules/duplicate_symbols/package.json b/test/node_modules/duplicate_symbols/package.json
diff --git a/test/test-addon.js b/test/test-addon.js
@@ -19,6 +19,16 @@ function runHello(hostProcess) {
   return execFileSync(hostProcess, ['-e', testCode], { cwd: __dirname }).toString()
 }
 
+function runDuplicateBindings() {
+  const hostProcess = process.execPath;
+  var testCode =
+    "console.log((function(bindings) {" +
+    "return bindings.pointerCheck1(bindings.pointerCheck2());" +
+    "})(require('duplicate_symbols')))"
+  console.log('running ', hostProcess);
+  return execFileSync(hostProcess, ['-e', testCode], { cwd: __dirname }).toString()
+}
+
 function getEncoding() {
   var code = 'import locale;print locale.getdefaultlocale()[1]'
   return execFileSync('python', ['-c', code]).toString().trim()
@@ -52,6 +62,21 @@ test('build simple addon', function (t) {
   proc.stderr.setEncoding('utf-8')
 })
 
+test('make sure addon symbols do not overlap', function (t) {
+  t.plan(3)
+
+  var addonPath = path.resolve(__dirname, 'node_modules', 'duplicate_symbols')
+  // Set the loglevel otherwise the output disappears when run via 'npm test'
+  var cmd = [nodeGyp, 'rebuild', '-C', addonPath, '--loglevel=verbose']
+  execFile(process.execPath, cmd, function (err, stdout, stderr) {
+    var logLines = stderr.trim().split(/\r?\n/)
+    var lastLine = logLines[logLines.length-1]
+    t.strictEqual(err, null)
+    t.strictEqual(lastLine, 'gyp info ok', 'should end in ok')
+    t.strictEqual(runDuplicateBindings().trim(), 'not equal')
+  })
+})
+
 test('build simple addon in path with non-ascii characters', function (t) {
   t.plan(1)