Skip to content

fix: prevent JS function to native block leak #223

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

Merged
merged 2 commits into from
Sep 1, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
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
7 changes: 5 additions & 2 deletions NativeScript/runtime/Interop.mm
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@
.dispose = [](JSBlock* block) {
if (block->descriptor == &JSBlock::kJSBlockDescriptor) {
MethodCallbackWrapper* wrapper = static_cast<MethodCallbackWrapper*>(block->userData);
if (wrapper->isolateWrapper_.IsValid()) {
if (Runtime::IsAlive(wrapper->isolateWrapper_.Isolate()) && wrapper->isolateWrapper_.IsValid()) {
Isolate* isolate = wrapper->isolateWrapper_.Isolate();
v8::Locker locker(isolate);
Isolate::Scope isolate_scope(isolate);
Expand Down Expand Up @@ -80,6 +80,8 @@

*blockPointer = {
.isa = nullptr,
// this block is created with a refcount of 1
// this means we "own" it and need to free it
.flags = JSBlock::BLOCK_HAS_COPY_DISPOSE | JSBlock::BLOCK_NEEDS_FREE | (1 /* ref count */ << 1),
.reserved = 0,
.invoke = (void*)result.first,
Expand All @@ -90,7 +92,8 @@

object_setClass((__bridge id)blockPointer, objc_getClass("__NSMallocBlock__"));

return blockPointer;
// transfer ownership back to ARC (see refcount comment above)
return CFBridgingRelease(blockPointer);
}

Local<Value> Interop::CallFunction(CMethodCall& methodCall) {
Expand Down
5 changes: 5 additions & 0 deletions TestFixtures/Marshalling/TNSObjCTypes.h
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ CFTypeRef TNSFunctionWithCreateCFTypeRefReturn() CF_RETURNS_RETAINED;
typedef int (^NumberReturner)(int, int, int);

@interface TNSObjCTypes : NSObject
@property (nonatomic, copy) void (^retainedBlock)(void);
+ (void)methodWithComplexBlock:(id (^)(int, id, SEL, NSObject*, TNSOStruct))block;
+ (id)methodWithObject:(id)x;

Expand All @@ -22,6 +23,10 @@ typedef int (^NumberReturner)(int, int, int);
- (void)methodWithSimpleBlock:(void (^)(void))block;
- (void)methodWithComplexBlock:(id (^)(int, id, SEL, NSObject*, TNSOStruct))block;

- (void)methodRetainingBlock:(void (^)(void))block;
- (void)methodCallRetainingBlock;
- (void)methodReleaseRetainingBlock;

- (NumberReturner)methodWithBlockScope:(int)number;
- (id)methodReturningBlockAsId:(int)number;

Expand Down
10 changes: 10 additions & 0 deletions TestFixtures/Marshalling/TNSObjCTypes.m
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,16 @@ - (void)methodWithSimpleBlock:(void (^)(void))block {
block();
}

- (void)methodRetainingBlock:(void (^)(void))block {
_retainedBlock = block;
}
- (void)methodCallRetainingBlock {
_retainedBlock();
}
- (void)methodReleaseRetainingBlock {
_retainedBlock = NULL;
}

- (void)methodWithComplexBlock:(id (^)(int, id, SEL, NSObject*, TNSOStruct))block {
TNSOStruct str = { 5, 6, 7 };
id result = block(1, @2, @selector(init), @[@3, @4], str);
Expand Down
45 changes: 45 additions & 0 deletions TestRunner/app/tests/Marshalling/ObjCTypesTests.js
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,51 @@ describe(module.id, function () {
expect(actual).toBe("simple block called");
});

it("Block releases after call", function (done) {
const functionRef = new WeakRef(function () {
TNSLog('simple block called');
});
TNSObjCTypes.alloc().init().methodWithSimpleBlock(functionRef.deref());

var actual = TNSGetOutput();
expect(actual).toBe("simple block called");
gc();
setTimeout(() => {
gc();
expect(!!functionRef.deref()).toBe(false);
done();
});
});

it("Block retains and releases", function (done) {
const functionRef = new WeakRef(function () {
TNSLog('simple block called');
});
const instance = TNSObjCTypes.alloc().init();
instance.methodRetainingBlock(functionRef.deref());
function verifyBlockCall() {
instance.methodCallRetainingBlock();
var actual = TNSGetOutput();
expect(actual).toBe("simple block called");
TNSClearOutput();
}
verifyBlockCall();

gc();
setTimeout(() => {
gc();
expect(!!functionRef.deref()).toBe(true);
verifyBlockCall();
instance.methodReleaseRetainingBlock();
gc();
setTimeout(() => {
gc();
expect(!!functionRef.deref()).toBe(false);
done();
})
});
});

it("InstanceComplexBlock", function () {
function block(i, id, sel, obj, str) {
expect(i).toBe(1);
Expand Down