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

Removed dependency on Prism.Core (Fixes #872) #875

Merged
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
1 change: 0 additions & 1 deletion .build/dependencies.props
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,6 @@
<NUnit3TestAdapterPackageVersion>3.17.0</NUnit3TestAdapterPackageVersion>
<NUnitPackageVersion>3.13.1</NUnitPackageVersion>
<OpenNLPNETPackageVersion>1.9.1.1</OpenNLPNETPackageVersion>
<PrismCorePackageVersion>7.2.0.1422</PrismCorePackageVersion>
<RandomizedTestingGeneratorsPackageVersion>2.7.8</RandomizedTestingGeneratorsPackageVersion>
<SharpZipLibPackageVersion>1.1.0</SharpZipLibPackageVersion>
<Spatial4nPackageVersion>0.4.1.1</Spatial4nPackageVersion>
Expand Down
1 change: 1 addition & 0 deletions .rat-excludes
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@ psake/*
KStemData\d+\.cs
Snowball/*
Egothor.Stemmer/*
Events/*
Sax/*
JaspellTernarySearchTrie\.cs
RectangularArrays\.cs
Expand Down
8 changes: 4 additions & 4 deletions src/Lucene.Net.Facet/Taxonomy/CachedOrdinalsReader.cs
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
using Lucene.Net.Support.Threading;
using Lucene.Net.Util;
#if !FEATURE_CONDITIONALWEAKTABLE_ENUMERATOR
using Prism.Events;
using Lucene.Net.Util.Events;
#endif
using System;
using System.Collections.Generic;
Expand Down Expand Up @@ -103,7 +103,7 @@ private CachedOrds GetCachedOrds(AtomicReaderContext context)
ordsCache.Add(cacheKey, ords);
#if !FEATURE_CONDITIONALWEAKTABLE_ENUMERATOR
// LUCENENET specific: Add weak event handler for .NET Standard 2.0 and .NET Framework, since we don't have an enumerator to use
context.Reader.SubscribeToGetCacheKeysEvent(eventAggregator.GetEvent<Events.GetCacheKeysEvent>());
context.Reader.SubscribeToGetCacheKeysEvent(eventAggregator.GetEvent<WeakEvents.GetCacheKeysEvent>());
#endif
}
return ords;
Expand Down Expand Up @@ -229,8 +229,8 @@ public virtual long RamBytesUsed()
// we use a weak event to retrieve the CachedOrds instances. We look each of these up here to avoid the need
// to attach events to the CachedOrds instances themselves (thus using the existing IndexReader.Dispose()
// method to detach the events rather than using a finalizer in CachedOrds to ensure they are cleaned up).
var e = new Events.GetCacheKeysEventArgs();
eventAggregator.GetEvent<Events.GetCacheKeysEvent>().Publish(e);
var e = new WeakEvents.GetCacheKeysEventArgs();
eventAggregator.GetEvent<WeakEvents.GetCacheKeysEvent>().Publish(e);
foreach (var key in e.CacheKeys)
if (ordsCache.TryGetValue(key, out CachedOrds value))
cachedOrdsList.Add(value);
Expand Down
43 changes: 43 additions & 0 deletions src/Lucene.Net.Tests/Support/Util/Events/MockDelegateReference.cs
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
// Source: https://github.com/PrismLibrary/Prism/blob/7f0b1680bbe754da790274f80851265f808d9bbf

#region Copyright .NET Foundation, Licensed under the MIT License (MIT)
// The MIT License (MIT)
//
// Copyright(c).NET Foundation
//
// All rights reserved. Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
// documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use,
// copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software
// is furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
// OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
// LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR
// IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
#endregion

#if !FEATURE_CONDITIONALWEAKTABLE_ENUMERATOR

using System;

namespace Lucene.Net.Util.Events
{
class MockDelegateReference : IDelegateReference
{
public Delegate Target { get; set; }

public MockDelegateReference()
{

}

public MockDelegateReference(Delegate target)
{
Target = target;
}
}
}

#endif
Original file line number Diff line number Diff line change
@@ -0,0 +1,91 @@
// Source: https://github.com/PrismLibrary/Prism/blob/7f0b1680bbe754da790274f80851265f808d9bbf

#region Copyright .NET Foundation, Licensed under the MIT License (MIT)
// The MIT License (MIT)
//
// Copyright(c).NET Foundation
//
// All rights reserved. Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
// documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use,
// copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software
// is furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
// OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
// LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR
// IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
#endregion

#if !FEATURE_CONDITIONALWEAKTABLE_ENUMERATOR

using NUnit.Framework;
using System;
using System.Threading;
using Assert = Lucene.Net.TestFramework.Assert;

namespace Lucene.Net.Util.Events
{
[TestFixture]
public class TestBackgroundEventSubscription
{
[Test]
public void ShouldReceiveDelegateOnDifferentThread()
{
ManualResetEvent completeEvent = new ManualResetEvent(false);
SynchronizationContext.SetSynchronizationContext(new SynchronizationContext());
SynchronizationContext calledSyncContext = null;
Action<object> action = delegate
{
calledSyncContext = SynchronizationContext.Current;
completeEvent.Set();
};

IDelegateReference actionDelegateReference = new MockDelegateReference() { Target = action };
IDelegateReference filterDelegateReference = new MockDelegateReference() { Target = (Predicate<object>)delegate { return true; } };

var eventSubscription = new BackgroundEventSubscription<object>(actionDelegateReference, filterDelegateReference);


var publishAction = eventSubscription.GetExecutionStrategy();

Assert.NotNull(publishAction);

publishAction.Invoke(null);

completeEvent.WaitOne(5000);

Assert.AreNotEqual(SynchronizationContext.Current, calledSyncContext);
}

[Test]
public void ShouldReceiveDelegateOnDifferentThreadNonGeneric()
{
var completeEvent = new ManualResetEvent(false);
SynchronizationContext.SetSynchronizationContext(new SynchronizationContext());
SynchronizationContext calledSyncContext = null;
Action action = delegate
{
calledSyncContext = SynchronizationContext.Current;
completeEvent.Set();
};

IDelegateReference actionDelegateReference = new MockDelegateReference() { Target = action };

var eventSubscription = new BackgroundEventSubscription(actionDelegateReference);

var publishAction = eventSubscription.GetExecutionStrategy();

Assert.NotNull(publishAction);

publishAction.Invoke(null);

completeEvent.WaitOne(5000);

Assert.AreNotEqual(SynchronizationContext.Current, calledSyncContext);
}
}
}

#endif
214 changes: 214 additions & 0 deletions src/Lucene.Net.Tests/Support/Util/Events/TestDelegateReference.cs
Original file line number Diff line number Diff line change
@@ -0,0 +1,214 @@
// Source: https://github.com/PrismLibrary/Prism/blob/7f0b1680bbe754da790274f80851265f808d9bbf

#region Copyright .NET Foundation, Licensed under the MIT License (MIT)
// The MIT License (MIT)
//
// Copyright(c).NET Foundation
//
// All rights reserved. Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
// documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use,
// copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software
// is furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
// OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
// LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR
// IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
#endregion

#if !FEATURE_CONDITIONALWEAKTABLE_ENUMERATOR

using NUnit.Framework;
using System;
using System.Threading.Tasks;
using Assert = Lucene.Net.TestFramework.Assert;

namespace Lucene.Net.Util.Events
{
[TestFixture]
public class TestDelegateReference
{
[Test]
public void KeepAlivePreventsDelegateFromBeingCollected()
{
var delegates = new SomeClassHandler();
var delegateReference = new DelegateReference((Action<string>)delegates.DoEvent, true);

delegates = null;
GC.Collect();

Assert.NotNull(delegateReference.Target);
}

[Test]
public async Task NotKeepAliveAllowsDelegateToBeCollected()
{
var delegates = new SomeClassHandler();
var delegateReference = new DelegateReference((Action<string>)delegates.DoEvent, false);

delegates = null;
await Task.Delay(100);
GC.Collect();

Assert.Null(delegateReference.Target);
}

[Test]
public async Task NotKeepAliveKeepsDelegateIfStillAlive()
{
var delegates = new SomeClassHandler();
var delegateReference = new DelegateReference((Action<string>)delegates.DoEvent, false);

GC.Collect();

Assert.NotNull(delegateReference.Target);

GC.KeepAlive(delegates); //Makes delegates ineligible for garbage collection until this point (to prevent oompiler optimizations that may release the referenced object prematurely).
delegates = null;
await Task.Delay(100);
GC.Collect();

Assert.Null(delegateReference.Target);
}

[Test]
public void TargetShouldReturnAction()
{
var classHandler = new SomeClassHandler();
Action<string> myAction = new Action<string>(classHandler.MyAction);

var weakAction = new DelegateReference(myAction, false);

((Action<string>)weakAction.Target)("payload");
Assert.AreEqual("payload", classHandler.MyActionArg);
}

[Test]
public async Task ShouldAllowCollectionOfOriginalDelegate()
{
var classHandler = new SomeClassHandler();
Action<string> myAction = new Action<string>(classHandler.MyAction);

var weakAction = new DelegateReference(myAction, false);

var originalAction = new WeakReference(myAction);
myAction = null;
await Task.Delay(100);
GC.Collect();
Assert.False(originalAction.IsAlive);

((Action<string>)weakAction.Target)("payload");
Assert.AreEqual("payload", classHandler.MyActionArg);
}

[Test]
public async Task ShouldReturnNullIfTargetNotAlive()
{
SomeClassHandler handler = new SomeClassHandler();
var weakHandlerRef = new WeakReference(handler);

var action = new DelegateReference((Action<string>)handler.DoEvent, false);

handler = null;
await Task.Delay(100);
GC.Collect();
Assert.False(weakHandlerRef.IsAlive);

Assert.Null(action.Target);
}

[Test]
public void WeakDelegateWorksWithStaticMethodDelegates()
{
var action = new DelegateReference((Action)SomeClassHandler.StaticMethod, false);

Assert.NotNull(action.Target);
}

[Test]
public void TargetEqualsActionShouldReturnTrue()
{
var classHandler = new SomeClassHandler();
Action<string> myAction = new Action<string>(classHandler.MyAction);

var weakAction = new DelegateReference(myAction, false);

Assert.True(weakAction.TargetEquals(new Action<string>(classHandler.MyAction)));
}

[Test]
public async Task TargetEqualsNullShouldReturnTrueIfTargetNotAlive()
{
SomeClassHandler handler = new SomeClassHandler();
var weakHandlerRef = new WeakReference(handler);

var action = new DelegateReference((Action<string>)handler.DoEvent, false);

handler = null;

// Intentional delay to encourage Garbage Collection to actually occur
await Task.Delay(100);
GC.Collect();
Assert.False(weakHandlerRef.IsAlive);

Assert.True(action.TargetEquals(null));
}

[Test]
public void TargetEqualsNullShouldReturnFalseIfTargetAlive()
{
SomeClassHandler handler = new SomeClassHandler();
var weakHandlerRef = new WeakReference(handler);

var action = new DelegateReference((Action<string>)handler.DoEvent, false);

Assert.False(action.TargetEquals(null));
Assert.True(weakHandlerRef.IsAlive);
GC.KeepAlive(handler);
}

[Test]
public void TargetEqualsWorksWithStaticMethodDelegates()
{
var action = new DelegateReference((Action)SomeClassHandler.StaticMethod, false);

Assert.True(action.TargetEquals((Action)SomeClassHandler.StaticMethod));
}

//todo: fix
//[Test]
//public void NullDelegateThrows()
//{
// Assert.ThrowsException<ArgumentNullException>(() =>
// {
// var action = new DelegateReference(null, true);
// });
//}

public class SomeClassHandler
{
public string MyActionArg;

public void DoEvent(string value)
{
string myValue = value;
}

public static void StaticMethod()
{
#pragma warning disable 0219
int i = 0;
#pragma warning restore 0219
}

public void MyAction(string arg)
{
MyActionArg = arg;
}
}
}
}

#endif
Loading