Alert execution repository (#380)

* alert execution repository
* create a partition for the current date on initial migration
* generic integration tests
* hook into Ebean configuration using ServerConfigStartup
* use the API object mapper for EbeanServerHelper

app/com/arpnetworking/metrics/portal/alerts/AlertExecutionRepository.java

@@ -0,0 +1,34 @@
+/*
+ * Copyright 2020 Dropbox, Inc.
+ *
+ * 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 com.arpnetworking.metrics.portal.alerts;
+
+import com.arpnetworking.metrics.portal.scheduling.JobExecutionRepository;
+import models.internal.alerts.AlertEvaluationResult;
+import models.internal.scheduling.JobExecution;
+
+/**
+ * A repository for storing and retrieving {@link JobExecution}s for an alert.
+ *
+ * @author Christian Briones (cbriones at dropbox dot com)
+ *
+ * @apiNote
+ * This class is intended for use as a type-token so that Guice can reflectively instantiate
+ * the {@code JobExecutionRepository} at runtime. Scheduling code should be using a generic {@code JobExecutionRepository}.
+ */
+public interface AlertExecutionRepository extends JobExecutionRepository<AlertEvaluationResult> {
+}
+

app/com/arpnetworking/metrics/portal/alerts/impl/DatabaseAlertExecutionRepository.java

@@ -0,0 +1,194 @@
+/*
+ * Copyright 2020 Dropbox, Inc.
+ *
+ * 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 com.arpnetworking.metrics.portal.alerts.impl;
+
+import com.arpnetworking.metrics.portal.alerts.AlertExecutionRepository;
+import com.arpnetworking.metrics.portal.scheduling.JobExecutionRepository;
+import com.arpnetworking.metrics.portal.scheduling.impl.DatabaseExecutionHelper;
+import com.arpnetworking.steno.Logger;
+import com.arpnetworking.steno.LoggerFactory;
+import io.ebean.EbeanServer;
+import models.ebean.AlertExecution;
+import models.internal.Organization;
+import models.internal.alerts.Alert;
+import models.internal.alerts.AlertEvaluationResult;
+import models.internal.scheduling.JobExecution;
+
+import java.time.Instant;
+import java.util.NoSuchElementException;
+import java.util.Optional;
+import java.util.UUID;
+import java.util.concurrent.atomic.AtomicBoolean;
+import javax.inject.Inject;
+import javax.inject.Named;
+import javax.persistence.EntityNotFoundException;
+
+/**
+ * Implementation of {@link JobExecutionRepository} for {@link Alert} jobs using a SQL database.
+ *
+ * @author Christian Briones (cbriones at dropbox dot com)
+ */
+public final class DatabaseAlertExecutionRepository implements AlertExecutionRepository {
+
+    private static final Logger LOGGER = LoggerFactory.getLogger(DatabaseAlertExecutionRepository.class);
+
+    private final AtomicBoolean _isOpen = new AtomicBoolean(false);
+    private final EbeanServer _ebeanServer;
+    private final DatabaseExecutionHelper<AlertEvaluationResult, AlertExecution> _helper;
+
+    /**
+     * Public constructor.
+     *
+     * @param ebeanServer Play's {@code EbeanServer} for this repository.
+     */
+    @Inject
+    public DatabaseAlertExecutionRepository(@Named("metrics_portal") final EbeanServer ebeanServer) {
+        _ebeanServer = ebeanServer;
+        _helper = new DatabaseExecutionHelper<>(LOGGER, _ebeanServer, this::findOrCreateAlertExecution);
+
+    }
+
+    private AlertExecution findOrCreateAlertExecution(
+            final UUID jobId,
+            final Organization organization,
+            final Instant scheduled
+    ) {
+        final Optional<models.ebean.Organization> org = models.ebean.Organization.findByOrganization(_ebeanServer, organization);
+        if (!org.isPresent()) {
+            final String message = String.format(
+                    "Could not find org with organization.uuid=%s",
+                    organization.getId()
+            );
+            throw new EntityNotFoundException(message);
+        }
+        final Optional<AlertExecution> existingExecution = org.flatMap(r ->
+                _ebeanServer.createQuery(AlertExecution.class)
+                        .where()
+                        .eq("organization.uuid", org.get().getUuid())
+                        .eq("scheduled", scheduled)
+                        .findOneOrEmpty()
+        );
+        final AlertExecution newOrUpdatedExecution = existingExecution.orElseGet(AlertExecution::new);
+        newOrUpdatedExecution.setAlertId(jobId);
+        newOrUpdatedExecution.setOrganization(org.get());
+        newOrUpdatedExecution.setScheduled(scheduled);
+        return newOrUpdatedExecution;
+    }
+
+    @Override
+    public void open() {
+        assertIsOpen(false);
+        LOGGER.debug().setMessage("Opening DatabaseAlertExecutionRepository").log();
+        _isOpen.set(true);
+    }
+
+    @Override
+    public void close() {
+        assertIsOpen();
+        LOGGER.debug().setMessage("Closing DatabaseAlertExecutionRepository").log();
+        _isOpen.set(false);
+    }
+
+    @Override
+    public Optional<JobExecution<AlertEvaluationResult>> getLastScheduled(final UUID jobId, final Organization organization)
+            throws NoSuchElementException {
+        assertIsOpen();
+        return _ebeanServer.find(AlertExecution.class)
+                .where()
+                .eq("alert_id", jobId)
+                .eq("organization.uuid", organization.getId())
+                .setMaxRows(1)
+                .orderBy()
+                .desc("scheduled")
+                .findOneOrEmpty()
+                .map(DatabaseExecutionHelper::toInternalModel);
+    }
+
+    @Override
+    public Optional<JobExecution.Success<AlertEvaluationResult>> getLastSuccess(final UUID jobId, final Organization organization)
+            throws NoSuchElementException {
+        assertIsOpen();
+        final Optional<AlertExecution> row = _ebeanServer.find(AlertExecution.class)
+                .where()
+                .eq("alert_id", jobId)
+                .eq("organization.uuid", organization.getId())
+                .eq("state", AlertExecution.State.SUCCESS)
+                .setMaxRows(1)
+                .orderBy()
+                .desc("completed_at")
+                .findOneOrEmpty();
+        if (row.isPresent()) {
+            final JobExecution<AlertEvaluationResult> execution = DatabaseExecutionHelper.toInternalModel(row.get());
+            if (execution instanceof JobExecution.Success) {
+                return Optional.of((JobExecution.Success<AlertEvaluationResult>) execution);
+            }
+            throw new IllegalStateException(
+                    String.format("execution returned was not a success when specified by the query: %s", row.get())
+            );
+        }
+        return Optional.empty();
+    }
+
+    @Override
+    public Optional<JobExecution<AlertEvaluationResult>> getLastCompleted(final UUID jobId, final Organization organization)
+            throws NoSuchElementException {
+        assertIsOpen();
+        return _ebeanServer.find(AlertExecution.class)
+                .where()
+                .eq("alert_id", jobId)
+                .eq("organization.uuid", organization.getId())
+                .in("state", AlertExecution.State.SUCCESS, AlertExecution.State.FAILURE)
+                .setMaxRows(1)
+                .orderBy()
+                .desc("completed_at")
+                .findOneOrEmpty()
+                .map(DatabaseExecutionHelper::toInternalModel);
+    }
+
+    @Override
+    public void jobStarted(final UUID alertId, final Organization organization, final Instant scheduled) {
+        assertIsOpen();
+        _helper.jobStarted(alertId, organization, scheduled);
+    }
+
+    @Override
+    public void jobSucceeded(
+            final UUID alertId,
+            final Organization organization,
+            final Instant scheduled,
+            final AlertEvaluationResult result
+    ) {
+        assertIsOpen();
+        _helper.jobSucceeded(alertId, organization, scheduled, result);
+    }
+
+    @Override
+    public void jobFailed(final UUID alertId, final Organization organization, final Instant scheduled, final Throwable error) {
+        assertIsOpen();
+        _helper.jobFailed(alertId, organization, scheduled, error);
+    }
+
+    private void assertIsOpen() {
+        assertIsOpen(true);
+    }
+
+    private void assertIsOpen(final boolean expectedState) {
+        if (_isOpen.get() != expectedState) {
+            throw new IllegalStateException(String.format("DatabaseAlertExecutionRepository is not %s",
+                    expectedState ? "open" : "closed"));
+        }
+    }
+}

app/com/arpnetworking/metrics/portal/alerts/impl/NoAlertExecutionRepository.java

@@ -0,0 +1,108 @@
+/*
+ * Copyright 2020 Dropbox, Inc.
+ *
+ * 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 com.arpnetworking.metrics.portal.alerts.impl;
+
+import com.arpnetworking.metrics.portal.alerts.AlertExecutionRepository;
+import com.arpnetworking.steno.Logger;
+import com.arpnetworking.steno.LoggerFactory;
+import models.internal.Organization;
+import models.internal.alerts.AlertEvaluationResult;
+import models.internal.scheduling.JobExecution;
+
+import java.time.Instant;
+import java.util.NoSuchElementException;
+import java.util.Optional;
+import java.util.UUID;
+import java.util.concurrent.atomic.AtomicBoolean;
+
+/**
+ * An empty {@code AlertExecutionRepository}.
+ *
+ * @author Christian Briones (cbriones at dropbox dot com).
+ */
+public final class NoAlertExecutionRepository implements AlertExecutionRepository {
+    private static final Logger LOGGER = LoggerFactory.getLogger(NoAlertExecutionRepository.class);
+    private final AtomicBoolean _isOpen = new AtomicBoolean(false);
+
+    @Override
+    public void open() {
+        assertIsOpen(false);
+        LOGGER.debug().setMessage("Opening NoAlertExecutionRepository").log();
+        _isOpen.set(true);
+    }
+
+    @Override
+    public void close() {
+        assertIsOpen(true);
+        LOGGER.debug().setMessage("Closing NoAlertExecutionRepository").log();
+        _isOpen.set(false);
+    }
+
+    @Override
+    public Optional<JobExecution<AlertEvaluationResult>> getLastScheduled(final UUID jobId, final Organization organization) {
+        assertIsOpen();
+        return Optional.empty();
+    }
+
+    @Override
+    public Optional<JobExecution.Success<AlertEvaluationResult>> getLastSuccess(
+            final UUID jobId, final Organization organization
+    ) throws NoSuchElementException {
+        assertIsOpen();
+        return Optional.empty();
+    }
+
+    @Override
+    public Optional<JobExecution<AlertEvaluationResult>> getLastCompleted(
+            final UUID jobId,
+            final Organization organization
+    ) throws NoSuchElementException {
+        assertIsOpen();
+        return Optional.empty();
+    }
+
+    @Override
+    public void jobStarted(final UUID jobId, final Organization organization, final Instant scheduled) {
+        assertIsOpen();
+    }
+
+    @Override
+    public void jobSucceeded(
+            final UUID jobId,
+            final Organization organization,
+            final Instant scheduled,
+            final AlertEvaluationResult result
+    ) {
+        assertIsOpen();
+    }
+
+    @Override
+    public void jobFailed(final UUID jobId, final Organization organization, final Instant scheduled, final Throwable error) {
+        assertIsOpen();
+    }
+
+
+    private void assertIsOpen() {
+        assertIsOpen(true);
+    }
+
+    private void assertIsOpen(final boolean expectedState) {
+        if (_isOpen.get() != expectedState) {
+            throw new IllegalStateException(String.format("NoAlertExecutionRepository is not %s",
+                    expectedState ? "open" : "closed"));
+        }
+    }
+}

app/com/arpnetworking/metrics/portal/reports/impl/DatabaseReportExecutionRepository.java

@@ -115,16 +115,7 @@ public void close() {
         _isOpen.set(false);
     }
 
-    /**
-     * Get the most recently scheduled execution, if any.
-     * <p>
-     * This could possibly return an execution that's pending completion.
-     *
-     * @param jobId The UUID of the job that completed.
-     * @param organization The organization owning the job.
-     * @return The last successful execution.
-     * @throws NoSuchElementException if no job has the given UUID.
-     */
+    @Override
     public Optional<JobExecution<Report.Result>> getLastScheduled(final UUID jobId, final Organization organization)
             throws NoSuchElementException {
         assertIsOpen();

app/com/arpnetworking/metrics/portal/reports/impl/NoReportExecutionRepository.java

@@ -41,6 +41,11 @@ public void close() {
 
     }
 
+    @Override
+    public Optional<JobExecution<Report.Result>> getLastScheduled(final UUID jobId, final Organization organization) {
+        return Optional.empty();
+    }
+
     @Override
     public Optional<JobExecution.Success<Report.Result>> getLastSuccess(
             final UUID jobId,