created a failing test case for bug 4414

Change-Id: I3704c291498f98dccbb37554c8e7385f12c27afd

java/com.sap.sailing.domain.racelogtrackingadapter/META-INF/MANIFEST.MF

@@ -32,5 +32,6 @@ Import-Package: com.google.zxing;version="3.1.0",
  org.osgi.framework;version="1.6.0",
  org.osgi.util.tracker;version="1.5.1"
 Export-Package: com.sap.sailing.domain.racelogtracking,
- com.sap.sailing.domain.racelogtracking.impl;x-friends:="com.sap.sailing.domain.racelogtrackingadapter.testsupport,com.sap.sailing.gwt.ui.test,com.sap.sailing.mongodb.test"
+ com.sap.sailing.domain.racelogtracking.impl;x-friends:="com.sap.sailing.domain.racelogtrackingadapter.testsupport,com.sap.sailing.gwt.ui.test,com.sap.sailing.mongodb.test",
+ com.sap.sailing.domain.racelogtracking.impl.fixtracker;x-friends:="com.sap.sailing.domain.test"
 Bundle-Activator: com.sap.sailing.domain.racelogtracking.impl.Activator

java/com.sap.sailing.domain.test/META-INF/MANIFEST.MF

@@ -20,6 +20,12 @@ Require-Bundle: com.sap.sailing.domain,
  com.sap.sse.common,
  com.sap.sse.replication,
  com.sap.sse,
- com.sap.sse.shared.android
+ com.sap.sse.shared.android,
+ com.sap.sailing.domain.racelogtrackingadapter,
+ com.sap.sailing.server,
+ com.sap.sailing.server.testsupport,
+ com.sap.sailing.domain.persistence,
+ com.sap.sse.filestorage
 Export-Package: com.sap.sailing.domain.test,
  com.sap.sailing.domain.test.mock
+Import-Package: org.osgi.util.tracker

java/com.sap.sailing.domain.test/src/com/sap/sailing/domain/test/TestDeadlockInRegattaListener.java

@@ -0,0 +1,120 @@
+package com.sap.sailing.domain.test;
+
+import static org.mockito.Mockito.mock;
+import static org.mockito.Mockito.when;
+
+import java.util.UUID;
+import java.util.concurrent.BrokenBarrierException;
+import java.util.concurrent.CyclicBarrier;
+import java.util.function.Consumer;
+
+import org.junit.Rule;
+import org.junit.Test;
+import org.junit.rules.MethodRule;
+import org.junit.rules.Timeout;
+import org.osgi.util.tracker.ServiceTracker;
+
+import com.sap.sailing.domain.base.Regatta;
+import com.sap.sailing.domain.base.impl.BoatClassImpl;
+import com.sap.sailing.domain.base.impl.RegattaImpl;
+import com.sap.sailing.domain.common.RegattaAndRaceIdentifier;
+import com.sap.sailing.domain.common.RegattaNameAndRaceName;
+import com.sap.sailing.domain.leaderboard.impl.LowPoint;
+import com.sap.sailing.domain.racelogtracking.impl.fixtracker.RegattaLogFixTrackerRegattaListener;
+import com.sap.sailing.domain.ranking.OneDesignRankingMetric;
+import com.sap.sailing.domain.regattalog.impl.EmptyRegattaLogStore;
+import com.sap.sailing.domain.tracking.DynamicTrackedRegatta;
+import com.sap.sailing.domain.tracking.RaceTracker;
+import com.sap.sailing.domain.tracking.TrackedRace;
+import com.sap.sailing.domain.tracking.impl.DynamicTrackedRaceImpl;
+import com.sap.sailing.domain.tracking.impl.DynamicTrackedRegattaImpl;
+import com.sap.sailing.server.RacingEventService;
+import com.sap.sailing.server.impl.RacingEventServiceImpl;
+
+public class TestDeadlockInRegattaListener {
+    @Rule
+    public MethodRule globalTimeout = new Timeout(5000); // fail after 1s
+
+    @Test
+    public void testDeadlockInRegattaListener() throws InterruptedException, BrokenBarrierException {
+        CyclicBarrier latch = new CyclicBarrier(2);
+        CyclicBarrier monitorOnRegattaListenerLatch = new CyclicBarrier(2);
+        @SuppressWarnings("unchecked")
+        ServiceTracker<RacingEventService, RacingEventService> racingEventServiceTracker =
+                (ServiceTracker<RacingEventService, RacingEventService>) mock(ServiceTracker.class);
+        final String regattaName = "Test Regatta";
+        final RegattaImpl regatta = new RegattaImpl(
+                /* raceLogStore */ null, EmptyRegattaLogStore.INSTANCE, regattaName,
+                new BoatClassImpl("49er", true), /* startDate */ null, /* endDate */ null,
+                /* trackedRegattaRegistry */ null, new LowPoint(), UUID.randomUUID(),
+                /* courseArea */ null, /* controlTrackingFromStartAndFinishTimes */ true,
+                OneDesignRankingMetric::new);
+        DynamicTrackedRegatta trackedRegatta = new DynamicTrackedRegattaImpl(regatta) {
+            private static final long serialVersionUID = -3599667964201700780L;
+
+            @Override
+            protected void notifyListenersAboutTrackedRaceRemoved(TrackedRace trackedRace) {
+                try {
+                    latch.await();
+                } catch (InterruptedException | BrokenBarrierException e) {
+                    throw new RuntimeException(e);
+                }
+                super.notifyListenersAboutTrackedRaceRemoved(trackedRace);
+            }
+        };
+        RacingEventServiceImpl racingEventService = new RacingEventServiceImpl() {
+            @Override
+            public void getRaceTrackerByRegattaAndRaceIdentifier(RegattaAndRaceIdentifier raceIdentifier,
+                    Consumer<RaceTracker> callback) {
+                // called by RegattaLogFixTrackerRegattaListener.onRaceAdded while in synchronized block of RegattaListener
+                try {
+                    monitorOnRegattaListenerLatch.await(); // allow controller to stop us here, thus waiting until we own the RegattaListener monitor
+                    latch.await(); // wait until TrackedRegattaImpl, holding its trackedRacesLock's write lock, tries to notify its listeners about
+                    // the tracked race's removal
+                } catch (InterruptedException | BrokenBarrierException e) {
+                    throw new RuntimeException(e);
+                }
+                getExistingTrackedRace(new RegattaNameAndRaceName(regattaName, "b")); // no matter which; it requests the read lock on TrackedRegattaImpl.trackedRacesLock
+            }
+            
+            @Override
+            public DynamicTrackedRegatta getOrCreateTrackedRegatta(Regatta r) {
+                if (r == regatta) {
+                    return trackedRegatta;
+                } else {
+                    return super.getOrCreateTrackedRegatta(r);
+                }
+            }
+        };
+        when(racingEventServiceTracker.getService()).thenReturn(racingEventService);
+        RegattaLogFixTrackerRegattaListener listener = new RegattaLogFixTrackerRegattaListener(
+                racingEventServiceTracker, null);
+
+        racingEventService.addRegattaWithoutReplication(trackedRegatta.getRegatta());
+        TrackedRace trackedRace1 = mock(DynamicTrackedRaceImpl.class);
+        TrackedRace trackedRace2 = mock(DynamicTrackedRaceImpl.class);
+        String raceName1 = "R1";
+        String raceName2 = "R2";
+        when(trackedRace1.getRaceIdentifier()).thenReturn(new RegattaNameAndRaceName(regattaName, raceName1));
+        when(trackedRace2.getRaceIdentifier()).thenReturn(new RegattaNameAndRaceName(regattaName, raceName2));
+        listener.regattaAdded(trackedRegatta);
+        new Thread(()->{
+            try {
+                monitorOnRegattaListenerLatch.await(); // let the first addTrackedRace pass through
+                latch.await();
+            } catch (InterruptedException | BrokenBarrierException e) {
+                throw new RuntimeException(e);
+            }
+        }).start();
+        trackedRegatta.addTrackedRace(trackedRace1);
+        // the following runs into RacingEventService.getRaceTrackerByRegattaAndRaceIdentifier
+        // which waits for the latch based on the override above while in synchronized RegattaListener.raceAdded
+        new Thread(()->trackedRegatta.addTrackedRace(trackedRace2)).start();
+        monitorOnRegattaListenerLatch.await();
+        // the following awaits the latch in TrackedRegattaImpl.notifyListenersAboutTrackedRaceRemoved
+        // after the write lock has been obtained but before the synchronized RegattaListener.raceRemoved method
+        // is called. Before the fix for bug4414 the TrackedRegattaImpl.removeTrackedRace method calls the
+        // listeners while still holding the write lock. 
+        trackedRegatta.removeTrackedRace(trackedRace1);
+    }
+}

java/com.sap.sailing.domain/src/com/sap/sailing/domain/tracking/impl/TrackedRegattaImpl.java

@@ -122,24 +122,28 @@ public class TrackedRegattaImpl implements TrackedRegatta {
     
     @Override
     public void removeTrackedRace(RaceDefinition raceDefinition) {
-        LockUtil.lockForWrite(trackedRacesLock);
+        lockTrackedRacesForWrite();
         try {
             trackedRaces.remove(raceDefinition);
         } finally {
-            LockUtil.unlockAfterWrite(trackedRacesLock);
+            unlockTrackedRacesAfterWrite();
         }
     }
     
     @Override
     public void removeTrackedRace(TrackedRace trackedRace) {
-        LockUtil.lockForWrite(trackedRacesLock);
+        lockTrackedRacesForWrite();
         try {
             trackedRaces.remove(trackedRace.getRace());
-            for (RaceListener listener : raceListeners.keySet()) {
-                listener.raceRemoved(trackedRace);
-            }
+            notifyListenersAboutTrackedRaceRemoved(trackedRace);
         } finally {
-            LockUtil.unlockAfterWrite(trackedRacesLock);
+            unlockTrackedRacesAfterWrite();
+        }
+    }
+
+    protected void notifyListenersAboutTrackedRaceRemoved(TrackedRace trackedRace) {
+        for (RaceListener listener : raceListeners.keySet()) {
+            listener.raceRemoved(trackedRace);
         }
     }
 

java/com.sap.sailing.server/META-INF/MANIFEST.MF

@@ -48,7 +48,8 @@ Export-Package: com.sap.sailing.server,
    com.sap.sailing.gwt.ui.test,
    com.sap.sailing.server.replication.test,
    com.sap.sailing.domain.racelogtrackingadapter.test,
-   com.sap.sailing.server.testsupport",
+   com.sap.sailing.server.testsupport,
+   com.sap.sailing.domain.test",
  com.sap.sailing.server.impl.preferences.model,
  com.sap.sailing.server.masterdata,
  com.sap.sailing.server.operationaltransformation,