ArgConverter::SetValue: invalid pointer for a JS number or boolean in an object slot, and a leaked adapter for a plain object from an unowned method

Ouverte
#572 0 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Les mainteneurs répondent en général sous 1 jour

Personne n'a encore pris cette issue.

Évaluation

Difficulté
4/5
Temps estimé
3-5 jours
Accessibilité débutants
45/100
Type d'issue
Bug
Clarté
Clairement spécifiée
Activité
Active
Stack technique
cpp, ios, javascript, objective-c
Domaine
mobile-dev

Piste de recherche

Start at ArgConverter::SetValue and its caller, then read ArgConverter::RetainOwnedResult and the boxing path in Interop::SetFFIParams; compare with the owned-return handling added in #569. Reproduce the table cases with a native caller and add the four tests from the issue, running them under AddressSanitizer. Done when object-typed slots always hold a valid NSNumber, NSString or nil and the WeakRef test clears after the autorelease pool drains.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Description

Summary

ArgConverter::SetValue writes the result of a JS-implemented method, getter or block into the native return slot. For some combinations of JS value and native return type it writes nothing, or writes something that is not a valid value of that type, and native code then reads it.

JS result Native return type What is written
number object (id, a class, instancetype) nothing: the slot keeps whatever it held
true object the integer 1, which native code treats as an object pointer
false object 0, which reads as nil
string instancetype nothing

A string returned for an id or class-typed result is converted to an NSString, and null/undefined zero the slot; those are fine.

const X = NSObject.extend({
  description() { return 42; },   // NSString* expected: the slot is not written
});

The caller then messages a garbage pointer, or 0x1. This is a mistake in the JS implementation, but the runtime should fail predictably and not hand native code an arbitrary pointer.

A plain JS object from a method that doesn't own its return leaks its adapter

A related gap in the same function. For a plain JS object (or an array, function or Date) returned where an object is expected, SetValue creates a DictionaryAdapter with alloc/init and writes it at +1. A CFAutorelease(adapter) next to it is commented out.

That +1 is right when the method owns its return (the copy, mutableCopy and new families, initializers), and since #569 those are balanced. For any other method the native caller doesn't own the result and never releases it, so the adapter is never freed and its Persistent keeps the JS object alive:

const X = NSObject.extend({ makeThing() { return {}; } }, {
  exposedMethods: { makeThing: { returns: NSObject } },
});
// a native caller of -makeThing: the adapter and the object it wraps are never freed

Seen with a WeakRef on the returned object, which never clears after a native performSelector: call.

The fix is to hand the adapter over at +0 (autoreleased) when the method doesn't own its return. SetValue already reports whether it wrote an object the caller doesn't own; it would need to distinguish "wrote a +1 object" from "wrote nothing" so the caller can autorelease in the unowned case.

Suggested fix

In ArgConverter::SetValue, for object return types:

  • box a JS number or boolean as an NSNumber, as argument marshalling already does for a number passed to an object parameter (Interop::SetFFIParams), or write nil if boxing is not wanted there;
  • convert a string for instancetype as for id, or write nil;
  • in every other case that has no conversion, zero the slot.

The function has a TODO about reusing Interop::SetFFIParams; sharing that logic would fix all of these at once.

Whatever is boxed is returned at +0, so it also has to go through the owned-result retain added in #569 (ArgConverter::RetainOwnedResult), which today only recognises wrapped objects and strings.

Tests to add

  • A JS method declared to return an object that returns a number, true, and false: a native caller gets an NSNumber (or nil), never an invalid pointer. Run under AddressSanitizer.
  • A JS initializer (instancetype) that returns a string: the native caller gets nil or an NSString, not an unwritten slot.
  • The same through an owned-return method (copyWithZone:), checking the count of the boxed result.
  • A JS method that doesn't own its return, returning a fresh plain object to a native caller: a WeakRef on the object clears once the caller's autorelease pool drains.

Found while reviewing #569; not reproduced in a spec yet, because in Debug builds some of these paths assert first.

Langage dominant
JavaScript
Étoiles
154
Forks
46
Merge moyen
4 j 2 h
PR mergées (30 j)
30

Préparer son environnement

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Autres issues de NativeScript/ios

Toutes les issues de NativeScript/ios

Issues similaires

Plus d'issues JavaScript

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.