This repository has been archived by the owner on Aug 13, 2020. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 33
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #795 from CJSCommonPlatform/create-error-service
Create service for reporting event errors
- Loading branch information
Showing
9 changed files
with
339 additions
and
9 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,53 @@ | ||
<?xml version="1.0" encoding="UTF-8"?> | ||
<project xmlns="http://maven.apache.org/POM/4.0.0" | ||
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" | ||
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"> | ||
<parent> | ||
<artifactId>framework-system</artifactId> | ||
<groupId>uk.gov.justice.services</groupId> | ||
<version>6.5.0-SNAPSHOT</version> | ||
</parent> | ||
<modelVersion>4.0.0</modelVersion> | ||
|
||
<artifactId>framework-system-errors</artifactId> | ||
|
||
<dependencies> | ||
<dependency> | ||
<groupId>javax</groupId> | ||
<artifactId>javaee-api</artifactId> | ||
<scope>provided</scope> | ||
</dependency> | ||
<dependency> | ||
<groupId>uk.gov.justice.services</groupId> | ||
<artifactId>framework-system-persistence</artifactId> | ||
<version>${project.version}</version> | ||
</dependency> | ||
<dependency> | ||
<groupId>uk.gov.justice.framework-api</groupId> | ||
<artifactId>framework-api-system-errors</artifactId> | ||
<version>${framework-api.version}</version> | ||
</dependency> | ||
<dependency> | ||
<groupId>uk.gov.justice.framework-api</groupId> | ||
<artifactId>framework-api-core</artifactId> | ||
</dependency> | ||
<dependency> | ||
<groupId>uk.gov.justice.services</groupId> | ||
<artifactId>framework-utilities</artifactId> | ||
<version>${project.version}</version> | ||
</dependency> | ||
|
||
<!-- Test dependencies --> | ||
<dependency> | ||
<groupId>junit</groupId> | ||
<artifactId>junit</artifactId> | ||
<scope>test</scope> | ||
</dependency> | ||
<dependency> | ||
<groupId>org.mockito</groupId> | ||
<artifactId>mockito-core</artifactId> | ||
<scope>test</scope> | ||
</dependency> | ||
</dependencies> | ||
|
||
</project> |
71 changes: 71 additions & 0 deletions
71
.../main/java/uk/gov/justice/services/framework/system/errors/DefaultSystemErrorService.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,71 @@ | ||
package uk.gov.justice.services.framework.system.errors; | ||
|
||
import static java.lang.String.format; | ||
import static javax.transaction.Transactional.TxType.NOT_SUPPORTED; | ||
|
||
import uk.gov.justice.services.common.util.UtcClock; | ||
import uk.gov.justice.services.framework.system.errors.SystemErrorService; | ||
import uk.gov.justice.services.framework.utilities.exceptions.StackTraceProvider; | ||
import uk.gov.justice.services.messaging.JsonEnvelope; | ||
import uk.gov.justice.services.messaging.Metadata; | ||
import uk.gov.justice.services.system.domain.EventError; | ||
import uk.gov.justice.services.system.persistence.EventErrorLogRepository; | ||
|
||
import java.time.Clock; | ||
import java.util.Optional; | ||
import java.util.UUID; | ||
|
||
import javax.inject.Inject; | ||
import javax.transaction.Transactional; | ||
|
||
public class DefaultSystemErrorService implements SystemErrorService { | ||
|
||
private static final Long MISSING_EVENT_NUMBER = -1L; | ||
private static final String NO_COMMENT = ""; | ||
|
||
@Inject | ||
private EventErrorLogRepository eventErrorLogRepository; | ||
|
||
@Inject | ||
private StackTraceProvider stackTraceProvider; | ||
|
||
@Inject | ||
private UtcClock clock; | ||
|
||
@Override | ||
@Transactional(NOT_SUPPORTED) | ||
public void reportError( | ||
final String messageId, | ||
final String componentName, | ||
final JsonEnvelope jsonEnvelope, | ||
final Throwable exception) { | ||
|
||
final Metadata metadata = jsonEnvelope.metadata(); | ||
final UUID eventId = metadata.id(); | ||
final Optional<Long> eventNumber = metadata.eventNumber(); | ||
|
||
final EventError eventError = new EventError( | ||
eventId, | ||
eventNumber.orElse(MISSING_EVENT_NUMBER), | ||
componentName, | ||
messageId, | ||
metadata.asJsonObject().toString(), | ||
jsonEnvelope.payload().toString(), | ||
exception.getMessage(), | ||
stackTraceProvider.getStackTrace(exception), | ||
clock.now(), | ||
getComment(eventNumber) | ||
); | ||
|
||
eventErrorLogRepository.save(eventError); | ||
} | ||
|
||
private String getComment(final Optional<Long> eventNumberOptional) { | ||
|
||
if (eventNumberOptional.isPresent()) { | ||
return NO_COMMENT; | ||
} | ||
|
||
return format("Event number is missing from event. Setting to %d instead", MISSING_EVENT_NUMBER); | ||
} | ||
} |
162 changes: 162 additions & 0 deletions
162
...t/java/uk/gov/justice/services/framework/system/errors/DefaultSystemErrorServiceTest.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,162 @@ | ||
package uk.gov.justice.services.framework.system.errors; | ||
|
||
import static java.util.Optional.empty; | ||
import static java.util.Optional.of; | ||
import static java.util.UUID.randomUUID; | ||
import static org.hamcrest.CoreMatchers.is; | ||
import static org.hamcrest.CoreMatchers.nullValue; | ||
import static org.junit.Assert.assertThat; | ||
import static org.mockito.Mockito.mock; | ||
import static org.mockito.Mockito.verify; | ||
import static org.mockito.Mockito.when; | ||
|
||
import uk.gov.justice.services.common.util.UtcClock; | ||
import uk.gov.justice.services.framework.utilities.exceptions.StackTraceProvider; | ||
import uk.gov.justice.services.messaging.JsonEnvelope; | ||
import uk.gov.justice.services.messaging.Metadata; | ||
import uk.gov.justice.services.system.domain.EventError; | ||
import uk.gov.justice.services.system.persistence.EventErrorLogRepository; | ||
|
||
import java.time.ZonedDateTime; | ||
import java.util.UUID; | ||
|
||
import javax.json.JsonObject; | ||
import javax.json.JsonValue; | ||
|
||
import org.junit.Test; | ||
import org.junit.runner.RunWith; | ||
import org.mockito.ArgumentCaptor; | ||
import org.mockito.Captor; | ||
import org.mockito.InjectMocks; | ||
import org.mockito.Mock; | ||
import org.mockito.runners.MockitoJUnitRunner; | ||
|
||
@RunWith(MockitoJUnitRunner.class) | ||
public class DefaultSystemErrorServiceTest { | ||
|
||
private static final String AN_EMPTY_STRING = ""; | ||
|
||
@Mock | ||
private EventErrorLogRepository eventErrorLogRepository; | ||
|
||
@Mock | ||
private StackTraceProvider stackTraceProvider; | ||
|
||
@Mock | ||
private UtcClock clock; | ||
|
||
@InjectMocks | ||
private DefaultSystemErrorService defaultSystemErrorService; | ||
|
||
@Captor | ||
private ArgumentCaptor<EventError> eventErrorCaptor; | ||
|
||
@Test | ||
public void shouldCreateEventErrorAndPersist() throws Exception { | ||
|
||
final String messageId = "message id"; | ||
final String componentName = "EVENT_LISTENER"; | ||
final String errorMessage = "Help help we're all going to die"; | ||
final Throwable exception = new NullPointerException(errorMessage); | ||
final Long eventNumber = 239874L; | ||
final UUID eventId = randomUUID(); | ||
final String metadataJson = "{metadata: stuff}"; | ||
final String payloadJson = "{payload: stuff}"; | ||
final String stackTrace = "the stacktrace"; | ||
final ZonedDateTime erroredAt = new UtcClock().now(); | ||
|
||
final JsonEnvelope jsonEnvelope = mock(JsonEnvelope.class); | ||
final Metadata metadata = mock(Metadata.class); | ||
final JsonObject metadataJsonObject = mock(JsonObject.class); | ||
final JsonValue payload = mock(JsonValue.class); | ||
|
||
when(jsonEnvelope.metadata()).thenReturn(metadata); | ||
when(metadata.id()).thenReturn(eventId); | ||
when(metadata.eventNumber()).thenReturn(of(eventNumber)); | ||
|
||
when(metadata.asJsonObject()).thenReturn(metadataJsonObject); | ||
when(jsonEnvelope.payload()).thenReturn(payload); | ||
|
||
when(metadataJsonObject.toString()).thenReturn(metadataJson); | ||
when(payload.toString()).thenReturn(payloadJson); | ||
when(stackTraceProvider.getStackTrace(exception)).thenReturn(stackTrace); | ||
|
||
when(clock.now()).thenReturn(erroredAt); | ||
|
||
defaultSystemErrorService.reportError( | ||
messageId, | ||
componentName, | ||
jsonEnvelope, | ||
exception | ||
); | ||
|
||
verify(eventErrorLogRepository).save(eventErrorCaptor.capture()); | ||
|
||
final EventError eventError = eventErrorCaptor.getValue(); | ||
|
||
assertThat(eventError.getMessageId(), is(messageId)); | ||
assertThat(eventError.getComponent(), is(componentName)); | ||
assertThat(eventError.getErrorMessage(), is(errorMessage)); | ||
assertThat(eventError.getEventNumber(), is(eventNumber)); | ||
assertThat(eventError.getEventId(), is(eventId)); | ||
assertThat(eventError.getMetadata(), is(metadataJson)); | ||
assertThat(eventError.getPayload(), is(payloadJson)); | ||
assertThat(eventError.getStacktrace(), is(stackTrace)); | ||
assertThat(eventError.getErroredAt(), is(erroredAt)); | ||
assertThat(eventError.getComments(), is(AN_EMPTY_STRING)); | ||
} | ||
|
||
@Test | ||
public void shouldHandleMissingEventNumber() throws Exception { | ||
|
||
final String messageId = "message id"; | ||
final String componentName = "EVENT_LISTENER"; | ||
final String errorMessage = "Help help we're all going to die"; | ||
final Throwable exception = new NullPointerException(errorMessage); | ||
final UUID eventId = randomUUID(); | ||
final String metadataJson = "{metadata: stuff}"; | ||
final String payloadJson = "{payload: stuff}"; | ||
final String stackTrace = "the stacktrace"; | ||
final ZonedDateTime erroredAt = new UtcClock().now(); | ||
|
||
final JsonEnvelope jsonEnvelope = mock(JsonEnvelope.class); | ||
final Metadata metadata = mock(Metadata.class); | ||
final JsonObject metadataJsonObject = mock(JsonObject.class); | ||
final JsonValue payload = mock(JsonValue.class); | ||
|
||
when(jsonEnvelope.metadata()).thenReturn(metadata); | ||
when(metadata.id()).thenReturn(eventId); | ||
when(metadata.eventNumber()).thenReturn(empty()); | ||
|
||
when(metadata.asJsonObject()).thenReturn(metadataJsonObject); | ||
when(jsonEnvelope.payload()).thenReturn(payload); | ||
|
||
when(metadataJsonObject.toString()).thenReturn(metadataJson); | ||
when(payload.toString()).thenReturn(payloadJson); | ||
when(stackTraceProvider.getStackTrace(exception)).thenReturn(stackTrace); | ||
|
||
when(clock.now()).thenReturn(erroredAt); | ||
|
||
defaultSystemErrorService.reportError( | ||
messageId, | ||
componentName, | ||
jsonEnvelope, | ||
exception | ||
); | ||
|
||
verify(eventErrorLogRepository).save(eventErrorCaptor.capture()); | ||
|
||
final EventError eventError = eventErrorCaptor.getValue(); | ||
|
||
assertThat(eventError.getMessageId(), is(messageId)); | ||
assertThat(eventError.getComponent(), is(componentName)); | ||
assertThat(eventError.getErrorMessage(), is(errorMessage)); | ||
assertThat(eventError.getEventNumber(), is(-1L)); | ||
assertThat(eventError.getEventId(), is(eventId)); | ||
assertThat(eventError.getMetadata(), is(metadataJson)); | ||
assertThat(eventError.getPayload(), is(payloadJson)); | ||
assertThat(eventError.getStacktrace(), is(stackTrace)); | ||
assertThat(eventError.getErroredAt(), is(erroredAt)); | ||
assertThat(eventError.getComments(), is("Event number is missing from event. Setting to -1 instead")); | ||
} | ||
} |
22 changes: 22 additions & 0 deletions
22
...liquibase/framework-system-changesets/005-add-comment-column-to-event-error-log-table.xml
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,22 @@ | ||
<?xml version="1.0" encoding="UTF-8"?> | ||
<databaseChangeLog xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" | ||
xmlns="http://www.liquibase.org/xml/ns/dbchangelog" | ||
xsi:schemaLocation="http://www.liquibase.org/xml/ns/dbchangelog | ||
http://www.liquibase.org/xml/ns/dbchangelog/dbchangelog-3.3.xsd"> | ||
|
||
<changeSet | ||
id="framework-system-005" | ||
author="TechPod" | ||
logicalFilePath="005-add-comment-column-to-event-error-log-table.xml"> | ||
|
||
<addColumn tableName="event_error_log"> | ||
<column name="comments" type="TEXT"> | ||
<constraints nullable="true"/> | ||
</column> | ||
</addColumn> | ||
|
||
<rollback> | ||
<dropColumn tableName="event_error_log" columnName="comments"/> | ||
</rollback> | ||
</changeSet> | ||
</databaseChangeLog> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.