Skip to content

1.x: fix replay() retaining reference to the child Subscriber #4229

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.

Sign up for GitHub

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 1 commit into from
Jul 23, 2016
Merged

1.x: fix replay() retaining reference to the child Subscriber #4229

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
26 changes: 21 additions & 5 deletions src/main/java/rx/internal/operators/OperatorReplay.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -410,6 +410,7 @@ boolean add(InnerProducer<T> producer) {
* Atomically removes the given producer from the producers array.
* @param producer the producer to remove
*/
@SuppressWarnings("unchecked")
void remove(InnerProducer<T> producer) {
if (terminated) {
return;
Expand All @@ -419,6 +420,9 @@ void remove(InnerProducer<T> producer) {
return;
}
producers.remove(producer);
if (producers.isEmpty()) {
producersCache = EMPTY;
}
producersVersion++;
}
}
Expand Down Expand Up @@ -643,7 +647,7 @@ static final class InnerProducer<T> extends AtomicLong implements Producer, Subs
*/
final ReplaySubscriber<T> parent;
/** The actual child subscriber. */
final Subscriber<? super T> child;
Subscriber<? super T> child;
/**
* Holds an object that represents the current location in the buffer.
* Guarded by the emitter loop.
Expand Down Expand Up @@ -784,6 +788,8 @@ public void unsubscribe() {
// the others had non-zero. By removing this 'blocking' child, the others
// are now free to receive events
parent.manageRequests(this);
// break the reference
child = null;
}
}
}
Expand Down Expand Up @@ -878,20 +884,25 @@ public void replay(InnerProducer<T> output) {
Integer destIndexObject = output.index();
int destIndex = destIndexObject != null ? destIndexObject : 0;

Subscriber<? super T> child = output.child;
if (child == null) {
return;
}

long r = output.get();
long e = 0L;

while (e != r && destIndex < sourceIndex) {
Object o = get(destIndex);
try {
if (nl.accept(output.child, o)) {
if (nl.accept(child, o)) {
return;
}
} catch (Throwable err) {
Exceptions.throwIfFatal(err);
output.unsubscribe();
if (!nl.isError(o) && !nl.isCompleted(o)) {
output.child.onError(OnErrorThrowable.addValueAsLastCause(err, nl.getValue(o)));
child.onError(OnErrorThrowable.addValueAsLastCause(err, nl.getValue(o)));
}
return;
}
Expand Down Expand Up @@ -1066,6 +1077,11 @@ public final void replay(InnerProducer<T> output) {
return;
}

Subscriber<? super T> child = output.child;
if (child == null) {
return;
}

long r = output.get();
long e = 0L;

Expand All @@ -1074,7 +1090,7 @@ public final void replay(InnerProducer<T> output) {
if (v != null) {
Object o = leaveTransform(v.value);
try {
if (nl.accept(output.child, o)) {
if (nl.accept(child, o)) {
output.index = null;
return;
}
Expand All @@ -1083,7 +1099,7 @@ public final void replay(InnerProducer<T> output) {
Exceptions.throwIfFatal(err);
output.unsubscribe();
if (!nl.isError(o) && !nl.isCompleted(o)) {
output.child.onError(OnErrorThrowable.addValueAsLastCause(err, nl.getValue(o)));
child.onError(OnErrorThrowable.addValueAsLastCause(err, nl.getValue(o)));
}
return;
}
Expand Down
82 changes: 82 additions & 0 deletions src/test/java/rx/internal/operators/OperatorReplayTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@
import static org.mockito.Matchers.*;
import static org.mockito.Mockito.*;

import java.lang.management.*;
import java.util.*;
import java.util.concurrent.*;
import java.util.concurrent.atomic.*;
Expand Down Expand Up @@ -1495,4 +1496,85 @@ public void timeSizeDefaultScheduler() {
ts.assertNoErrors();
ts.assertCompleted();
}

void replayNoRetention(Func1<Observable<Integer>, ConnectableObservable<Integer>> replayOp) throws InterruptedException {
System.gc();

Thread.sleep(500);

MemoryMXBean memoryMXBean = ManagementFactory.getMemoryMXBean();
MemoryUsage memHeap = memoryMXBean.getHeapMemoryUsage();
long initial = memHeap.getUsed();

System.out.printf("Starting: %.3f MB%n", initial / 1024.0 / 1024.0);

PublishSubject<Integer> ps = PublishSubject.create();

ConnectableObservable<Integer> co = replayOp.call(ps);

Subscription s = co.subscribe(new Action1<Integer>() {
int[] array = new int[1024 * 1024 * 32];

@Override
public void call(Integer t) {
System.out.println(array.length);
}
});

co.connect();
ps.onNext(1);

memHeap = memoryMXBean.getHeapMemoryUsage();
long middle = memHeap.getUsed();

System.out.printf("Starting: %.3f MB%n", middle / 1024.0 / 1024.0);

s.unsubscribe();
s = null;

System.gc();

Thread.sleep(500);

memHeap = memoryMXBean.getHeapMemoryUsage();
long finish = memHeap.getUsed();

System.out.printf("After: %.3f MB%n", finish / 1024.0 / 1024.0);

if (finish > initial * 5) {
fail(String.format("Leak: %.3f -> %.3f -> %.3f", initial / 1024 / 1024.0, middle / 1024 / 1024.0, finish / 1024 / 1024d));
}

}

@Test
public void replayNoRetentionUnbounded() throws Exception {
replayNoRetention(new Func1<Observable<Integer>, ConnectableObservable<Integer>>() {
@Override
public ConnectableObservable<Integer> call(Observable<Integer> o) {
return o.replay();
}
});
}

@Test
public void replayNoRetentionSizeBound() throws Exception {
replayNoRetention(new Func1<Observable<Integer>, ConnectableObservable<Integer>>() {
@Override
public ConnectableObservable<Integer> call(Observable<Integer> o) {
return o.replay(1);
}
});
}

@Test
public void replayNoRetentionTimebound() throws Exception {
replayNoRetention(new Func1<Observable<Integer>, ConnectableObservable<Integer>>() {
@Override
public ConnectableObservable<Integer> call(Observable<Integer> o) {
return o.replay(1, TimeUnit.DAYS);
}
});
}

}