src: add AsyncWorker destruction suppression #407

gabrielschulhof · 2018-12-07T21:24:03Z

Add method SuppressDestruct() to AsyncWorker, which will cause an
instance of the class to remain allocated even after the OnOK
callback fires. Such an instance must be explicitly delete-ed from
user code.

Re: #231
Re: nodejs/abi-stable-node#353

gabrielschulhof · 2018-12-07T21:25:00Z

@ebickle PTAL

gabrielschulhof · 2019-01-23T18:35:09Z

Whoops! I accidentally closed this.

mhdawson

LGTM

NickNaso

LGTM

ebickle · 2019-01-24T01:23:03Z

LGTM

gabrielschulhof · 2019-02-08T16:40:04Z

CI:

version	job
v6	https://ci.nodejs.org/job/node-test-node-addon-api/1513/
v7	https://ci.nodejs.org/job/node-test-node-addon-api/1514/
v8	https://ci.nodejs.org/job/node-test-node-addon-api/1515/
v9	https://ci.nodejs.org/job/node-test-node-addon-api/1516/
v10	https://ci.nodejs.org/job/node-test-node-addon-api/1517/
v11	https://ci.nodejs.org/job/node-test-node-addon-api/1518/
v12 nightly	https://ci.nodejs.org/job/node-test-node-addon-api/1519/

Fails on OSX 😕✗

NickNaso · 2019-02-08T17:11:37Z

@gabrielschulhof Does it fail on every version of Node.js or one in the specific?

gabrielschulhof · 2019-02-08T17:16:23Z

@NickNaso all.

gabrielschulhof · 2019-02-08T18:07:13Z

OK. This is weird. It looks like OSX merges data symbols from different .node files!

Running test 'asyncworker-persistent'
Assigning current_worker@0x102b51d00: 0x1029291c0
0x1029291c0: Setting _suppress_destruct to true
Assigning current_worker@0x102b51d00: 0x10292bad0
0x10292bad0: Setting _suppress_destruct to true

The location of current_worker (the address following the @) is the same for both the has-exceptions and no-exceptions module!

gabrielschulhof · 2019-02-12T21:14:11Z

New CI:

version	job
v6.x	https://ci.nodejs.org/job/node-test-node-addon-api/1556/

gabrielschulhof · 2019-02-12T21:15:15Z

Still dies on OSX 😕

gabrielschulhof · 2019-02-13T23:32:37Z

CI:

version	job
v6.x	https://ci.nodejs.org/job/node-test-node-addon-api/1563/
v7.x	https://ci.nodejs.org/job/node-test-node-addon-api/1564/
v8.x	https://ci.nodejs.org/job/node-test-node-addon-api/1565/
v9.x	https://ci.nodejs.org/job/node-test-node-addon-api/1566/
v10.x	https://ci.nodejs.org/job/node-test-node-addon-api/1567/
v11.x	https://ci.nodejs.org/job/node-test-node-addon-api/1568/
v12.x	https://ci.nodejs.org/job/node-test-node-addon-api/1569/

Gonna add the rest if the first one is OK 🙂

gabrielschulhof · 2019-02-13T23:50:23Z

@mhdawson @NickNaso the moral of the story is that we need to add the condition

['OS!="windows"', {
  'cflags+': ['-fvisibility=hidden'],
  'xcode_settings': {
    'OTHER_CFLAGS': ['-fvisibility=hidden']
  }
}]

to test/binding.gyp to make sure that symbols produced in binding.node and binding_noexcept.node are not exported, otherwise they seem to "overlap" on OSX 😕

Thus, could you please have another look at the PR? The implementation hasn't changed, but I cleaned up the test a little.

gabrielschulhof · 2019-02-13T23:54:51Z

Made another small change, so here's a new set of CI:

version	job
v6.x	https://ci.nodejs.org/job/node-test-node-addon-api/1570/
v7.x	https://ci.nodejs.org/job/node-test-node-addon-api/1571/
v8.x	https://ci.nodejs.org/job/node-test-node-addon-api/1572/
v9.x	https://ci.nodejs.org/job/node-test-node-addon-api/1573/
v10.x	https://ci.nodejs.org/job/node-test-node-addon-api/1574/
v11.x	https://ci.nodejs.org/job/node-test-node-addon-api/1575/
v12.x-nightly	https://ci.nodejs.org/job/node-test-node-addon-api/1576/

gabrielschulhof · 2019-02-13T23:55:49Z

@mhdawson @NickNaso ... and I added the condition to test/binding.gyp.

Add method `SuppressDestruct()` to `AsyncWorker`, which will cause an instance of the class to remain allocated even after the `OnOK` callback fires. Such an instance must be explicitly `delete`-ed from user code. Re: nodejs#231 Re: nodejs/abi-stable-node#353

gabrielschulhof · 2019-02-14T00:02:35Z

Argh! Need to flip the rule to apply only to OSX. Here we go again:

version	job	status
v6.x	https://ci.nodejs.org/job/node-test-node-addon-api/1578/	✓
v7.x	https://ci.nodejs.org/job/node-test-node-addon-api/1579/	✓
v8.x	https://ci.nodejs.org/job/node-test-node-addon-api/1580/	✓
v9.x	https://ci.nodejs.org/job/node-test-node-addon-api/1581/	✓
v10.x	https://ci.nodejs.org/job/node-test-node-addon-api/1582/	✓
v11.x	https://ci.nodejs.org/job/node-test-node-addon-api/1583/	✓
v12.x-nightly	https://ci.nodejs.org/job/node-test-node-addon-api/1584/	✓

I'll start the other jobs once one completes.

NickNaso

LGTM

mhdawson · 2019-03-04T19:18:29Z

Discussed in most recent N-API team meetings. My understanding is that we are going to try out some other options so will mark as request changes until we do that.

mhdawson

Discussed in most recent N-API team meetings. My understanding is that we are going to try out some other options so will mark as request changes until we do that.

gabrielschulhof · 2019-03-20T17:34:29Z

@mhdawson @NickNaso since we have sufficient approval of nodejs/node-gyp#1689 (1 collaborator approval + 7 days) and since it introduces the same change as this PR (to add -fvisibility=hidden on OSX) to the build system, and since changes from node-gyp will take a long time to arrive in all supported Node.js versions, I believe it would be OK to land this PR.

We should also document that we recommend that folks add -fvisibility=hidden to their own binding.gyps if they support OSX. I can open an issue for that.

NickNaso · 2019-03-20T20:27:38Z

@gabrielschulhof I'm ok with your idea and I think that we need to update the documentation in the setup section https://github.com/nodejs/node-addon-api/blob/master/doc/setup.md#installation-and-usage.

mhdawson · 2019-03-20T21:28:11Z

@gabrielschulhof sounds good to me.

mhdawson

LGTM

Add method `SuppressDestruct()` to `AsyncWorker`, which will cause an instance of the class to remain allocated even after the `OnOK` callback fires. Such an instance must be explicitly `delete`-ed from user code. Re: #231 Re: nodejs/abi-stable-node#353 PR-URL: #407 Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com> Reviewed-By: NickNaso <nicoladelgobbo@gmail.com>

mhdawson · 2019-03-20T21:51:24Z

Landed as b0f6b60

Add method `SuppressDestruct()` to `AsyncWorker`, which will cause an instance of the class to remain allocated even after the `OnOK` callback fires. Such an instance must be explicitly `delete`-ed from user code. Re: nodejs/node-addon-api#231 Re: nodejs/abi-stable-node#353 PR-URL: nodejs/node-addon-api#407 Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com> Reviewed-By: NickNaso <nicoladelgobbo@gmail.com>

gabrielschulhof force-pushed the suppress-async-worker-destruct branch from bd39b76 to d1e9315 Compare December 13, 2018 18:03

gabrielschulhof closed this Dec 27, 2018

gabrielschulhof deleted the suppress-async-worker-destruct branch December 27, 2018 18:01

gabrielschulhof restored the suppress-async-worker-destruct branch December 28, 2018 20:27

gabrielschulhof reopened this Jan 23, 2019

gabrielschulhof requested review from NickNaso and mhdawson January 23, 2019 18:35

gabrielschulhof mentioned this pull request Jan 23, 2019

How to delete an AsyncWorker pointer? #430

Closed

mhdawson approved these changes Jan 23, 2019

View reviewed changes

NickNaso approved these changes Jan 24, 2019

View reviewed changes

gabrielschulhof force-pushed the suppress-async-worker-destruct branch from 03b319b to 7679068 Compare February 13, 2019 23:28

gabrielschulhof force-pushed the suppress-async-worker-destruct branch from 7679068 to 3b3a482 Compare February 13, 2019 23:48

gabrielschulhof force-pushed the suppress-async-worker-destruct branch from 3b3a482 to 1cdfc87 Compare February 13, 2019 23:59

NickNaso approved these changes Feb 14, 2019

View reviewed changes

clean up test

8a1c6a7

mhdawson requested changes Mar 4, 2019

View reviewed changes

This was referenced Mar 4, 2019

Time for a new release? nodejs/abi-stable-node#364

Closed

Time for a new release? #454

Closed

mhdawson approved these changes Mar 20, 2019

View reviewed changes

mhdawson closed this Mar 20, 2019

gabrielschulhof deleted the suppress-async-worker-destruct branch December 17, 2019 01:36

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

src: add AsyncWorker destruction suppression #407

src: add AsyncWorker destruction suppression #407

gabrielschulhof commented Dec 7, 2018 •

edited

Loading

gabrielschulhof commented Dec 7, 2018

gabrielschulhof commented Jan 23, 2019

mhdawson left a comment

NickNaso left a comment

ebickle commented Jan 24, 2019

gabrielschulhof commented Feb 8, 2019

NickNaso commented Feb 8, 2019 •

edited

Loading

gabrielschulhof commented Feb 8, 2019

gabrielschulhof commented Feb 8, 2019

gabrielschulhof commented Feb 12, 2019

gabrielschulhof commented Feb 12, 2019

gabrielschulhof commented Feb 13, 2019 •

edited

Loading

gabrielschulhof commented Feb 13, 2019

gabrielschulhof commented Feb 13, 2019

gabrielschulhof commented Feb 13, 2019

gabrielschulhof commented Feb 14, 2019 •

edited

Loading

NickNaso left a comment

mhdawson commented Mar 4, 2019

mhdawson left a comment

gabrielschulhof commented Mar 20, 2019

NickNaso commented Mar 20, 2019

mhdawson commented Mar 20, 2019

mhdawson left a comment

mhdawson commented Mar 20, 2019

src: add AsyncWorker destruction suppression #407

src: add AsyncWorker destruction suppression #407

Conversation

gabrielschulhof commented Dec 7, 2018 • edited Loading

gabrielschulhof commented Dec 7, 2018

gabrielschulhof commented Jan 23, 2019

mhdawson left a comment

Choose a reason for hiding this comment

NickNaso left a comment

Choose a reason for hiding this comment

ebickle commented Jan 24, 2019

gabrielschulhof commented Feb 8, 2019

NickNaso commented Feb 8, 2019 • edited Loading

gabrielschulhof commented Feb 8, 2019

gabrielschulhof commented Feb 8, 2019

gabrielschulhof commented Feb 12, 2019

gabrielschulhof commented Feb 12, 2019

gabrielschulhof commented Feb 13, 2019 • edited Loading

gabrielschulhof commented Feb 13, 2019

gabrielschulhof commented Feb 13, 2019

gabrielschulhof commented Feb 13, 2019

gabrielschulhof commented Feb 14, 2019 • edited Loading

NickNaso left a comment

Choose a reason for hiding this comment

mhdawson commented Mar 4, 2019

mhdawson left a comment

Choose a reason for hiding this comment

gabrielschulhof commented Mar 20, 2019

NickNaso commented Mar 20, 2019

mhdawson commented Mar 20, 2019

mhdawson left a comment

Choose a reason for hiding this comment

mhdawson commented Mar 20, 2019

gabrielschulhof commented Dec 7, 2018 •

edited

Loading

NickNaso commented Feb 8, 2019 •

edited

Loading

gabrielschulhof commented Feb 13, 2019 •

edited

Loading

gabrielschulhof commented Feb 14, 2019 •

edited

Loading