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

Add ObjectWrapperReportedMemberTypes to Options #1947

Merged
merged 3 commits into from
Aug 17, 2024
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
64 changes: 63 additions & 1 deletion Jint.Tests/Runtime/InteropTests.cs
Original file line number Diff line number Diff line change
Expand Up @@ -3483,4 +3483,66 @@ void Debug(object o)
Assert.Equal("KeyValuePair`2: [test, val]", result[2]);
Assert.Equal("String: test", result[3]);
}
}

private class ClrMembersVisibilityTestClass
{
public int A { get; set; } = 10;

public int F()
{
return 4;
}
}

[Fact]
public void ShouldNotSeeClrMethods()
{
var engine = new Engine(opt =>
{
opt.Interop.ObjectWrapperReportedMemberTypes = MemberTypes.Field | MemberTypes.Property;
});

engine.SetValue("clrInstance", new ClrMembersVisibilityTestClass());

var val = engine.GetValue("clrInstance");

var obj = val.AsObject();
var props = obj.GetOwnProperties().Select(x => x.Key.ToString()).ToList();

props.Should().BeEquivalentTo(["A"]);
}

[Fact]
public void ShouldSeeClrMethods()
{
var engine = new Engine();

engine.SetValue("clrInstance", new ClrMembersVisibilityTestClass());

var val = engine.GetValue("clrInstance");
var obj = val.AsObject();
var props = obj.GetOwnProperties().Select(x => x.Key.ToString()).ToList();

props.Should().BeEquivalentTo(["A", "F"]);
}

private class ClrMembersVisibilityTestClass2
{
public int Get_A { get; set; } = 5;
}

[Fact]
public void ShouldSeeClrMethods2()
{
var engine = new Engine();

engine.SetValue("clrInstance", new ClrMembersVisibilityTestClass2());

var val = engine.GetValue("clrInstance");

var obj = val.AsObject();
var props = obj.GetOwnProperties().Select(x => x.Key.ToString()).ToList();

props.Should().BeEquivalentTo(["Get_A"]);
}
}
7 changes: 7 additions & 0 deletions Jint/Options.cs
Original file line number Diff line number Diff line change
Expand Up @@ -364,6 +364,13 @@ public class InteropOptions
/// Whether the engine should throw an error when a member is not found on a CLR object. Defaults to false.
/// </summary>
public bool ThrowOnUnresolvedMember { get; set; }

/// <summary>
/// Types of CLR members reported by <see cref="ObjectWrapper"/> when enumerating properties/serializing <see cref="ObjectWrapper.ToObject"/>.
/// Supported values are: <see cref="MemberTypes.Field"/>, <see cref="MemberTypes.Property"/>, <see cref="MemberTypes.Method"/>.
/// All other values are ignored.
/// </summary>
public MemberTypes ObjectWrapperReportedMemberTypes { get; set; } = MemberTypes.Field | MemberTypes.Property | MemberTypes.Method;
}

public class ConstraintOptions
Expand Down
45 changes: 31 additions & 14 deletions Jint/Runtime/Interop/ObjectWrapper.cs
Original file line number Diff line number Diff line change
Expand Up @@ -225,7 +225,7 @@ public override IEnumerable<KeyValuePair<JsValue, PropertyDescriptor>> GetOwnPro
yield return new KeyValuePair<JsValue, PropertyDescriptor>(key, GetOwnProperty(key));
}
}

private IEnumerable<JsValue> EnumerateOwnPropertyKeys(Types types)
{
// prefer object order, add possible other properties after
Expand All @@ -235,8 +235,7 @@ private IEnumerable<JsValue> EnumerateOwnPropertyKeys(Types types)
var keys = (ICollection<string>) _typeDescriptor.KeysAccessor!.GetValue(Target)!;
foreach (var key in keys)
{
var jsString = JsString.Create(key);
yield return jsString;
yield return JsString.Create(key);
}
}
else if (includeStrings && Target is IDictionary dictionary)
Expand All @@ -248,28 +247,46 @@ private IEnumerable<JsValue> EnumerateOwnPropertyKeys(Types types)
if (stringKey is not null
|| _engine.TypeConverter.TryConvert(key, typeof(string), CultureInfo.InvariantCulture, out stringKey))
{
var jsString = JsString.Create((string) stringKey!);
yield return jsString;
yield return JsString.Create((string) stringKey!);
}
}
}
else if (includeStrings)
{
// we take public properties and fields
foreach (var p in ClrType.GetProperties(BindingFlags.Static | BindingFlags.Instance | BindingFlags.Public))
// we take public properties, fields and methods
const BindingFlags BindingFlags = BindingFlags.Static | BindingFlags.Instance | BindingFlags.Public;

if ((_engine.Options.Interop.ObjectWrapperReportedMemberTypes & MemberTypes.Property) == MemberTypes.Property)
{
foreach (var p in ClrType.GetProperties(BindingFlags))
{
var indexParameters = p.GetIndexParameters();
if (indexParameters.Length == 0)
{
yield return JsString.Create(p.Name);
}
}
}

if ((_engine.Options.Interop.ObjectWrapperReportedMemberTypes & MemberTypes.Field) == MemberTypes.Field)
{
var indexParameters = p.GetIndexParameters();
if (indexParameters.Length == 0)
foreach (var f in ClrType.GetFields(BindingFlags | BindingFlags.DeclaredOnly))
{
var jsString = JsString.Create(p.Name);
yield return jsString;
yield return JsString.Create(f.Name);
}
}

foreach (var f in ClrType.GetFields(BindingFlags.Static | BindingFlags.Instance | BindingFlags.Public))
if ((_engine.Options.Interop.ObjectWrapperReportedMemberTypes & MemberTypes.Method) == MemberTypes.Method)
{
var jsString = JsString.Create(f.Name);
yield return jsString;
foreach (var m in ClrType.GetMethods(BindingFlags | BindingFlags.DeclaredOnly))
{
if (m.IsSpecialName)
{
continue;
}

yield return JsString.Create(m.Name);
}
}
}
}
Expand Down