Check if lock owner is finished on lock acquisition

Sometimes requests "die" suddenly, without going through catch/finally blocks.
If this happens, any lock they own will remain locked until it times out (which
can take hours in some cases).

This cl implicitly unlocks any lock if the owner of the lock isn't running
anymore.

-------------
Created by MOE: https://github.com/google/moe
MOE_MIGRATED_REVID=168880938

javatests/google/registry/model/BUILD

@@ -38,6 +38,7 @@ java_library(
         "@joda_time",
         "@junit",
         "@org_joda_money",
+        "@org_mockito_all",
     ],
 )
 

javatests/google/registry/model/schema.txt

@@ -876,6 +876,7 @@ class google.registry.model.server.KmsSecretRevision {
 }
 class google.registry.model.server.Lock {
   @Id java.lang.String lockId;
+  java.lang.String requestLogId;
   org.joda.time.DateTime expirationTime;
 }
 class google.registry.model.server.ServerSecret {

javatests/google/registry/model/server/LockTest.java

@@ -15,13 +15,18 @@
 package google.registry.model.server;
 
 import static com.google.common.truth.Truth.assertThat;
+import static org.mockito.Mockito.mock;
+import static org.mockito.Mockito.when;
 
+import com.google.common.base.Optional;
 import google.registry.model.ofy.Ofy;
 import google.registry.testing.AppEngineRule;
 import google.registry.testing.ExceptionRule;
 import google.registry.testing.FakeClock;
 import google.registry.testing.InjectRule;
+import google.registry.util.RequestStatusChecker;
 import org.joda.time.Duration;
+import org.junit.Before;
 import org.junit.Rule;
 import org.junit.Test;
 import org.junit.runner.RunWith;
@@ -34,6 +39,7 @@ public class LockTest {
   private static final String RESOURCE_NAME = "foo";
   private static final Duration ONE_DAY = Duration.standardDays(1);
   private static final Duration TWO_MILLIS = Duration.millis(2);
+  private static final RequestStatusChecker requestStatusChecker = mock(RequestStatusChecker.class);
 
   @Rule
   public final AppEngineRule appEngine = AppEngineRule.builder()
@@ -46,49 +52,68 @@ public class LockTest {
   @Rule
   public final ExceptionRule thrown = new ExceptionRule();
 
+  private Optional<Lock> acquire(String tld, Duration leaseLength) {
+    return Lock.acquire(RESOURCE_NAME, tld, leaseLength, requestStatusChecker);
+  }
+
+  @Before public void setUp() {
+    when(requestStatusChecker.getLogId()).thenReturn("current-request-id");
+    when(requestStatusChecker.isRunning("current-request-id")).thenReturn(true);
+  }
+
   @Test
   public void testReleasedExplicitly() throws Exception {
-    Lock lock = Lock.acquire(RESOURCE_NAME, "", ONE_DAY);
-    assertThat(lock).isNotNull();
+    Optional<Lock> lock = acquire("", ONE_DAY);
+    assertThat(lock).isPresent();
     // We can't get it again at the same time.
-    assertThat(Lock.acquire(RESOURCE_NAME, "", ONE_DAY)).isNull();
+    assertThat(acquire("", ONE_DAY)).isAbsent();
     // But if we release it, it's available.
-    lock.release();
-    assertThat(Lock.acquire(RESOURCE_NAME, "", ONE_DAY)).isNotNull();
+    lock.get().release();
+    assertThat(acquire("", ONE_DAY)).isPresent();
   }
 
   @Test
   public void testReleasedAfterTimeout() throws Exception {
     FakeClock clock = new FakeClock();
     inject.setStaticField(Ofy.class, "clock", clock);
-    assertThat(Lock.acquire(RESOURCE_NAME, "", TWO_MILLIS)).isNotNull();
+    assertThat(acquire("", TWO_MILLIS)).isPresent();
     // We can't get it again at the same time.
-    assertThat(Lock.acquire(RESOURCE_NAME, "", TWO_MILLIS)).isNull();
+    assertThat(acquire("", TWO_MILLIS)).isAbsent();
     // A second later we still can't get the lock.
     clock.advanceOneMilli();
-    assertThat(Lock.acquire(RESOURCE_NAME, "", TWO_MILLIS)).isNull();
+    assertThat(acquire("", TWO_MILLIS)).isAbsent();
     // But two seconds later we can get it.
     clock.advanceOneMilli();
-    assertThat(Lock.acquire(RESOURCE_NAME, "", TWO_MILLIS)).isNotNull();
+    assertThat(acquire("", TWO_MILLIS)).isPresent();
+  }
+
+  @Test
+  public void testReleasedAfterRequestFinish() throws Exception {
+    assertThat(acquire("", ONE_DAY)).isPresent();
+    // We can't get it again while request is active
+    assertThat(acquire("", ONE_DAY)).isAbsent();
+    // But if request is finished, we can get it.
+    when(requestStatusChecker.isRunning("current-request-id")).thenReturn(false);
+    assertThat(acquire("", ONE_DAY)).isPresent();
   }
 
   @Test
   public void testTldsAreIndependent() throws Exception {
-    Lock lockA = Lock.acquire(RESOURCE_NAME, "a", ONE_DAY);
-    assertThat(lockA).isNotNull();
+    Optional<Lock> lockA = acquire("a", ONE_DAY);
+    assertThat(lockA).isPresent();
     // For a different tld we can still get a lock with the same name.
-    Lock lockB = Lock.acquire(RESOURCE_NAME, "b", ONE_DAY);
-    assertThat(lockB).isNotNull();
+    Optional<Lock> lockB = acquire("b", ONE_DAY);
+    assertThat(lockB).isPresent();
     // We can't get lockB again at the same time.
-    assertThat(Lock.acquire(RESOURCE_NAME, "b", ONE_DAY)).isNull();
+    assertThat(acquire("b", ONE_DAY)).isAbsent();
     // Releasing lockA has no effect on lockB (even though we are still using the "b" tld).
-    lockA.release();
-    assertThat(Lock.acquire(RESOURCE_NAME, "b", ONE_DAY)).isNull();
+    lockA.get().release();
+    assertThat(acquire("b", ONE_DAY)).isAbsent();
   }
 
   @Test
   public void testFailure_emptyResourceName() throws Exception {
     thrown.expect(IllegalArgumentException.class, "resourceName cannot be null or empty");
-    Lock.acquire("", "", TWO_MILLIS);
+    Lock.acquire("", "", TWO_MILLIS, requestStatusChecker);
   }
 }

javatests/google/registry/request/lock/BUILD

@@ -0,0 +1,36 @@
+package(
+    default_testonly = 1,
+    default_visibility = ["//java/google/registry:registry_project"],
+)
+
+licenses(["notice"])  # Apache 2.0
+
+load("//java/com/google/testing/builddefs:GenTestRules.bzl", "GenTestRules")
+
+java_library(
+    name = "lock",
+    srcs = glob(["*.java"]),
+    resources = glob(["testdata/*"]),
+    deps = [
+        "//java/google/registry/model",
+        "//java/google/registry/request/lock",
+        "//javatests/google/registry/testing",
+        "//third_party/java/objectify:objectify-v4_1",
+        "@com_google_appengine_api_1_0_sdk//:testonly",
+        "@com_google_appengine_tools_appengine_gcs_client",
+        "@com_google_appengine_tools_sdk",
+        "@com_google_code_findbugs_jsr305",
+        "@com_google_guava",
+        "@com_google_truth",
+        "@javax_servlet_api",
+        "@joda_time",
+        "@junit",
+        "@org_mockito_all",
+    ],
+)
+
+GenTestRules(
+    name = "GeneratedTestRules",
+    test_files = glob(["*Test.java"]),
+    deps = [":lock"],
+)

javatests/google/registry/request/lock/LockHandlerImplTest.java

@@ -0,0 +1,132 @@
+// Copyright 2017 The Nomulus Authors. All Rights Reserved.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+package google.registry.request.lock;
+
+import static com.google.common.truth.Truth.assertThat;
+import static org.junit.Assert.fail;
+import static org.mockito.Mockito.mock;
+import static org.mockito.Mockito.times;
+import static org.mockito.Mockito.verify;
+
+import com.google.common.base.Optional;
+import google.registry.model.server.Lock;
+import google.registry.testing.AppEngineRule;
+import google.registry.testing.ExceptionRule;
+import java.util.concurrent.Callable;
+import javax.annotation.Nullable;
+import org.joda.time.Duration;
+import org.junit.Before;
+import org.junit.Rule;
+import org.junit.Test;
+import org.junit.runner.RunWith;
+import org.junit.runners.JUnit4;
+
+/** Unit tests for {@link LockHandler}. */
+@RunWith(JUnit4.class)
+public final class LockHandlerImplTest {
+
+  private static final Duration ONE_DAY = Duration.standardDays(1);
+
+  @Rule
+  public final AppEngineRule appEngine = AppEngineRule.builder()
+      .build();
+
+  @Rule
+  public final ExceptionRule thrown = new ExceptionRule();
+
+  private static class CountingCallable implements Callable<Void> {
+    int numCalled = 0;
+
+    @Override
+    public Void call() {
+      numCalled += 1;
+      return null;
+    }
+  }
+
+  private static class ThrowingCallable implements Callable<Void> {
+    Exception exception;
+
+    ThrowingCallable(Exception exception) {
+      this.exception = exception;
+    }
+
+    @Override
+    public Void call() throws Exception {
+      throw exception;
+    }
+  }
+
+  private boolean executeWithLocks(Callable<Void> callable, final @Nullable Lock acquiredLock) {
+    LockHandler lockHandler = new LockHandlerImpl() {
+      private static final long serialVersionUID = 0L;
+      @Override
+      Optional<Lock> acquire(String resourceName, String tld, Duration leaseLength) {
+        assertThat(resourceName).isEqualTo("resourceName");
+        assertThat(tld).isEqualTo("tld");
+        assertThat(leaseLength).isEqualTo(ONE_DAY);
+        return Optional.fromNullable(acquiredLock);
+      }
+    };
+
+    return lockHandler.executeWithLocks(callable, "tld", ONE_DAY, "resourceName");
+  }
+
+  @Before public void setUp() {
+  }
+
+  @Test
+  public void testLockSucceeds() throws Exception {
+    Lock lock = mock(Lock.class);
+    CountingCallable countingCallable = new CountingCallable();
+    assertThat(executeWithLocks(countingCallable, lock)).isTrue();
+    assertThat(countingCallable.numCalled).isEqualTo(1);
+    verify(lock, times(1)).release();
+  }
+
+  @Test
+  public void testLockSucceeds_uncheckedException() throws Exception {
+    Lock lock = mock(Lock.class);
+    Exception expectedException = new RuntimeException("test");
+    try {
+      executeWithLocks(new ThrowingCallable(expectedException), lock);
+      fail("Expected RuntimeException");
+    } catch (RuntimeException exception) {
+      assertThat(exception).isSameAs(expectedException);
+    }
+    verify(lock, times(1)).release();
+  }
+
+  @Test
+  public void testLockSucceeds_checkedException() throws Exception {
+    Lock lock = mock(Lock.class);
+    Exception expectedException = new Exception("test");
+    try {
+      executeWithLocks(new ThrowingCallable(expectedException), lock);
+      fail("Expected RuntimeException");
+    } catch (RuntimeException exception) {
+      assertThat(exception).hasCauseThat().isSameAs(expectedException);
+    }
+    verify(lock, times(1)).release();
+  }
+
+  @Test
+  public void testLockFailed() throws Exception {
+    Lock lock = null;
+    CountingCallable countingCallable = new CountingCallable();
+    assertThat(executeWithLocks(countingCallable, lock)).isFalse();
+    assertThat(countingCallable.numCalled).isEqualTo(0);
+  }
+}