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

[Java.Interop] Add JniRuntime.JniValueManager.GetPeer() #1295

Merged
merged 4 commits into from
Jan 30, 2025
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
24 changes: 23 additions & 1 deletion src/Java.Interop/Java.Interop/JniRuntime.JniValueManager.cs
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ partial class CreationOptions {
public JniValueManager? ValueManager {get; set;}
}

JniValueManager? valueManager;
internal JniValueManager? valueManager;
public JniValueManager ValueManager {
get => valueManager ?? throw new NotSupportedException ();
}
Expand Down Expand Up @@ -271,6 +271,28 @@ static Type GetPeerType ([DynamicallyAccessedMembers (Constructors)] Type type)
return type;
}

public IJavaPeerable? GetPeer (
JniObjectReference reference,
[DynamicallyAccessedMembers (Constructors)]
Type? targetType = null)
{
if (disposed) {
throw new ObjectDisposedException (GetType ().Name);
}

if (!reference.IsValid) {
return null;
}

var peeked = PeekPeer (reference);
if (peeked != null &&
(targetType == null ||
targetType.IsAssignableFrom (peeked.GetType ()))) {
return peeked;
}
return CreatePeer (ref reference, JniObjectReferenceOptions.Copy, targetType);
}
Comment on lines +274 to +294
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I was able to update Java.Lang.Object.GetObject() to use this method:

var p = JNIEnvInit.ValueManager!.GetPeer (new JniObjectReference (handle), type);
JNIEnv.DeleteRef (handle, transfer);
return p;

After merging this, we can try it in a new version of:


public virtual IJavaPeerable? CreatePeer (
ref JniObjectReference reference,
JniObjectReferenceOptions transfer,
Expand Down
1 change: 1 addition & 0 deletions src/Java.Interop/PublicAPI.Unshipped.txt
Original file line number Diff line number Diff line change
Expand Up @@ -5,5 +5,6 @@ virtual Java.Interop.JniRuntime.OnEnterMarshalMethod() -> void
virtual Java.Interop.JniRuntime.OnUserUnhandledException(ref Java.Interop.JniTransition transition, System.Exception! e) -> void
Java.Interop.JavaException.JavaException(ref Java.Interop.JniObjectReference reference, Java.Interop.JniObjectReferenceOptions transfer, Java.Interop.JniObjectReference throwableOverride) -> void
Java.Interop.JavaException.SetJavaStackTrace(Java.Interop.JniObjectReference peerReferenceOverride = default(Java.Interop.JniObjectReference)) -> void
Java.Interop.JniRuntime.JniValueManager.GetPeer(Java.Interop.JniObjectReference reference, System.Type? targetType = null) -> Java.Interop.IJavaPeerable?
Java.Interop.JniTypeSignatureAttribute.InvokerType.get -> System.Type?
Java.Interop.JniTypeSignatureAttribute.InvokerType.set -> void
2 changes: 2 additions & 0 deletions tests/Java.Interop-Tests/Java.Interop-Tests.csproj
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@
<PropertyGroup>
<TargetFramework>$(DotNetTargetFramework)</TargetFramework>
<IsPackable>false</IsPackable>
<SignAssembly>true</SignAssembly>
<AssemblyOriginatorKeyFile>..\..\product.snk</AssemblyOriginatorKeyFile>
<AllowUnsafeBlocks>true</AllowUnsafeBlocks>
<DefineConstants>$(DefineConstants);NO_MARSHAL_MEMBER_BUILDER_SUPPORT;NO_GC_BRIDGE_SUPPORT</DefineConstants>
</PropertyGroup>
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,297 @@
#nullable enable

using System;
using System.Collections.Generic;
using System.Linq;
using System.Reflection;
using System.Threading;

using Java.Interop;

using NUnit.Framework;

namespace Java.InteropTests {

// Android doesn't support `[NonParallelizable]`, but runs tests sequentially by default.
#if !__ANDROID__
// Modifies JniRuntime.valueManager instance field; can't be done in parallel
[NonParallelizable]
#endif // !__ANDROID__
public abstract class JniRuntimeJniValueManagerContract : JavaVMFixture {

protected abstract Type ValueManagerType {
get;
}

protected virtual JniRuntime.JniValueManager CreateValueManager ()
{
var manager = Activator.CreateInstance (ValueManagerType) as JniRuntime.JniValueManager;
return manager ?? throw new InvalidOperationException ($"Could not create instance of `{ValueManagerType}`!");
}

#pragma warning disable CS8618
JniRuntime.JniValueManager systemManager;
JniRuntime.JniValueManager valueManager;
#pragma warning restore CS8618

[SetUp]
public void CreateVM ()
{
systemManager = JniRuntime.CurrentRuntime.valueManager!;
valueManager = CreateValueManager ();
valueManager.OnSetRuntime (JniRuntime.CurrentRuntime);
JniRuntime.CurrentRuntime.valueManager = valueManager;
}

[TearDown]
public void DestroyVM ()
{
JniRuntime.CurrentRuntime.valueManager = systemManager;
systemManager = null!;
valueManager?.Dispose ();
valueManager = null!;
}

[Test]
public void AddPeer ()
{
}

int GetSurfacedPeersCount ()
{
return valueManager.GetSurfacedPeers ().Count;
}

[Test]
public void AddPeer_NoDuplicates ()
{
int startPeerCount = GetSurfacedPeersCount ();
using (var v = new MyDisposableObject ()) {
// MyDisposableObject ctor implicitly calls AddPeer();
Assert.AreEqual (startPeerCount + 1, GetSurfacedPeersCount (), DumpPeers ());
valueManager.AddPeer (v);
Assert.AreEqual (startPeerCount + 1, GetSurfacedPeersCount (), DumpPeers ());
}
}

[Test]
public void ConstructPeer_ImplicitViaBindingConstructor_PeerIsInSurfacedPeers ()
{
int startPeerCount = GetSurfacedPeersCount ();

var g = new GetThis ();
var surfaced = valueManager.GetSurfacedPeers ();
Assert.AreEqual (startPeerCount + 1, surfaced.Count);

var found = false;
foreach (var pr in surfaced) {
if (!pr.SurfacedPeer.TryGetTarget (out var p))
continue;
if (object.ReferenceEquals (g, p)) {
found = true;
}
}
Assert.IsTrue (found);

var localRef = g.PeerReference.NewLocalRef ();
g.Dispose ();
Assert.AreEqual (startPeerCount, GetSurfacedPeersCount ());
Assert.IsNull (valueManager.PeekPeer (localRef));
JniObjectReference.Dispose (ref localRef);
}

[Test]
public void ConstructPeer_ImplicitViaBindingMethod_PeerIsInSurfacedPeers ()
{
int startPeerCount = GetSurfacedPeersCount ();

var g = new GetThis ();
var surfaced = valueManager.GetSurfacedPeers ();
Assert.AreEqual (startPeerCount + 1, surfaced.Count);

var found = false;
foreach (var pr in surfaced) {
if (!pr.SurfacedPeer.TryGetTarget (out var p))
continue;
if (object.ReferenceEquals (g, p)) {
found = true;
}
}
Assert.IsTrue (found);

var localRef = g.PeerReference.NewLocalRef ();
g.Dispose ();
Assert.AreEqual (startPeerCount, GetSurfacedPeersCount ());
Assert.IsNull (valueManager.PeekPeer (localRef));
JniObjectReference.Dispose (ref localRef);
}


[Test]
public void CollectPeers ()
{
// TODO
}

[Test]
public void CreateValue ()
{
using (var o = new JavaObject ()) {
var r = o.PeerReference;
var x = (IJavaPeerable) valueManager.CreateValue (ref r, JniObjectReferenceOptions.Copy)!;
Assert.AreNotSame (o, x);
x.Dispose ();

x = valueManager.CreateValue<IJavaPeerable> (ref r, JniObjectReferenceOptions.Copy);
Assert.AreNotSame (o, x);
x!.Dispose ();
}
}

[Test]
public void GetValue_ReturnsAlias ()
{
var local = new JavaObject ();
local.UnregisterFromRuntime ();
Assert.IsNull (valueManager.PeekValue (local.PeerReference));
// GetObject must always return a value (unless handle is null, etc.).
// However, since we called local.UnregisterFromRuntime(),
// JniRuntime.PeekObject() is null (asserted above), but GetObject() must
// **still** return _something_.
// In this case, it returns an _alias_.
// TODO: "most derived type" alias generation. (Not relevant here, but...)
var p = local.PeerReference;
var alias = JniRuntime.CurrentRuntime.ValueManager.GetValue<IJavaPeerable> (ref p, JniObjectReferenceOptions.Copy);
Assert.AreNotSame (local, alias);
alias!.Dispose ();
local.Dispose ();
}

[Test]
public void GetValue_ReturnsNullWithNullHandle ()
{
var r = new JniObjectReference ();
var o = valueManager.GetValue (ref r, JniObjectReferenceOptions.Copy);
Assert.IsNull (o);
}

[Test]
public void GetValue_ReturnsNullWithInvalidSafeHandle ()
{
var invalid = new JniObjectReference ();
Assert.IsNull (valueManager.GetValue (ref invalid, JniObjectReferenceOptions.CopyAndDispose));
}

[Test]
public unsafe void GetValue_FindBestMatchType ()
{
#if !NO_MARSHAL_MEMBER_BUILDER_SUPPORT
using (var t = new JniType (TestType.JniTypeName)) {
var c = t.GetConstructor ("()V");
var o = t.NewObject (c, null);
using (var w = valueManager.GetValue<IJavaPeerable> (ref o, JniObjectReferenceOptions.CopyAndDispose)) {
Assert.AreEqual (typeof (TestType), w!.GetType ());
Assert.IsTrue (((TestType) w).ExecutedActivationConstructor);
}
}
#endif // !NO_MARSHAL_MEMBER_BUILDER_SUPPORT
}

[Test]
public void PeekPeer ()
{
Assert.IsNull (valueManager.PeekPeer (new JniObjectReference ()));

using (var v = new MyDisposableObject ()) {
Assert.IsNotNull (valueManager.PeekPeer (v.PeerReference));
Assert.AreSame (v, valueManager.PeekPeer (v.PeerReference));
}
}

[Test]
public void PeekValue ()
{
JniObjectReference lref;
using (var o = new JavaObject ()) {
lref = o.PeerReference.NewLocalRef ();
Assert.AreSame (o, valueManager.PeekValue (lref));
}
// At this point, the Java-side object is kept alive by `lref`,
// but the wrapper instance has been disposed, and thus should
// be unregistered, and thus unfindable.
Assert.IsNull (valueManager.PeekValue (lref));
JniObjectReference.Dispose (ref lref);
}

[Test]
public void PeekValue_BoxedObjects ()
{
var marshaler = valueManager.GetValueMarshaler<object> ();
var ad = AppDomain.CurrentDomain;

var proxy = marshaler.CreateGenericArgumentState (ad);
Assert.AreSame (ad, valueManager.PeekValue (proxy.ReferenceValue));
marshaler.DestroyGenericArgumentState (ad, ref proxy);

var ex = new InvalidOperationException ("boo!");
proxy = marshaler.CreateGenericArgumentState (ex);
Assert.AreSame (ex, valueManager.PeekValue (proxy.ReferenceValue));
marshaler.DestroyGenericArgumentState (ex, ref proxy);
}

void AllNestedRegistrationScopeTests ()
{
AddPeer ();
AddPeer_NoDuplicates ();
ConstructPeer_ImplicitViaBindingConstructor_PeerIsInSurfacedPeers ();
CreateValue ();
GetValue_FindBestMatchType ();
GetValue_ReturnsAlias ();
GetValue_ReturnsNullWithInvalidSafeHandle ();
GetValue_ReturnsNullWithNullHandle ();
PeekPeer ();
PeekValue ();
PeekValue_BoxedObjects ();
}

string DumpPeers ()
{
return DumpPeers (valueManager.GetSurfacedPeers ());
}

static string DumpPeers (IEnumerable<JniSurfacedPeerInfo> peers)
{
return string.Join ("," + Environment.NewLine, peers);
}


// also test:
// Singleton scenario
// Types w/o "activation" constructors -- need to support checking parent scopes
// nesting of scopes
// Adding an instance already added in a previous scope?
}

public abstract class JniRuntimeJniValueManagerContract<T> : JniRuntimeJniValueManagerContract {

protected override Type ValueManagerType => typeof (T);
}

#if !__ANDROID__
#if !NETCOREAPP
[TestFixture]
public class JniRuntimeJniValueManagerContract_Mono : JniRuntimeJniValueManagerContract {
static Type MonoRuntimeValueManagerType = Type.GetType ("Java.Interop.MonoRuntimeValueManager, Java.Runtime.Environment", throwOnError:true)!;

protected override Type ValueManagerType => MonoRuntimeValueManagerType;
}
#endif // !NETCOREAPP

[TestFixture]
public class JniRuntimeJniValueManagerContract_NoGCIntegration : JniRuntimeJniValueManagerContract {
static Type ManagedValueManagerType = Type.GetType ("Java.Interop.ManagedValueManager, Java.Runtime.Environment", throwOnError:true)!;

protected override Type ValueManagerType => ManagedValueManagerType;
}
#endif // !__ANDROID__
}
2 changes: 2 additions & 0 deletions tests/TestJVM/TestJVM.csproj
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@
<TargetFramework>$(DotNetTargetFramework)</TargetFramework>
<Nullable>enable</Nullable>
<IsPackable>false</IsPackable>
<SignAssembly>true</SignAssembly>
<AssemblyOriginatorKeyFile>..\..\product.snk</AssemblyOriginatorKeyFile>
</PropertyGroup>

<Import Project="..\..\TargetFrameworkDependentValues.props" />
Expand Down