Sentry configuration

exec/src/main/java/org/smartregister/fhir/gateway/MainApp.java

@@ -1,5 +1,6 @@
 package org.smartregister.fhir.gateway;
 
+import org.smartregister.fhir.gateway.plugins.SentryConfiguration;
 import org.springframework.boot.SpringApplication;
 import org.springframework.boot.autoconfigure.SpringBootApplication;
 import org.springframework.boot.web.servlet.ServletComponentScan;
@@ -9,11 +10,16 @@
  * plugins defined in "com.google.fhir.gateway.plugin" and "org.smartregister.fhir.gateway.plugins.
  */
 @SpringBootApplication(
-        scanBasePackages = {"org.smartregister.fhir.gateway", "com.google.fhir.gateway.plugin"})
+        scanBasePackages = {
+            "org.smartregister.fhir.gateway",
+            "com.google.fhir.gateway.plugin",
+            "org.smartregister.fhir.gateway.plugins"
+        })
 @ServletComponentScan({"org.smartregister.fhir.gateway.plugins", "com.google.fhir.gateway"})
 public class MainApp {
 
     public static void main(String[] args) {
+        SentryConfiguration.initialize();
         SpringApplication.run(MainApp.class, args);
     }
 }

plugins/application.yaml

@@ -0,0 +1,5 @@
+sentry:
+  dsn: ""
+  release:
+  environment: ""
+  enabled: true

plugins/pom.xml

@@ -48,6 +48,28 @@
       <version>1.0.0-SNAPSHOT</version>
       <scope>compile</scope>
     </dependency>
+    <dependency>
+      <groupId>org.springframework</groupId>
+      <artifactId>spring-context</artifactId>
+      <version>5.2.0.RELEASE</version>
+    </dependency>
+    <dependency>
+      <groupId>org.springframework.boot</groupId>
+      <artifactId>spring-boot-autoconfigure</artifactId>
+      <version>2.2.0.RELEASE</version>
+      <scope>compile</scope>
+    </dependency>
+    <dependency>
+      <groupId>jakarta.annotation</groupId>
+      <artifactId>jakarta.annotation-api</artifactId>
+      <version>2.1.1</version>
+      <scope>compile</scope>
+    </dependency>
+    <dependency>
+      <groupId>io.sentry</groupId>
+      <artifactId>sentry-logback</artifactId>
+      <version>7.3.0</version>
+    </dependency>
 
   </dependencies>
 

plugins/src/main/java/org/smartregister/fhir/gateway/plugins/SentryConfiguration.java

@@ -0,0 +1,90 @@
+package org.smartregister.fhir.gateway.plugins;
+
+import java.util.Map;
+
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+import org.springframework.beans.factory.annotation.Value;
+import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
+import org.springframework.context.annotation.Configuration;
+
+import com.google.common.annotations.VisibleForTesting;
+
+import io.sentry.Sentry;
+import io.sentry.SentryOptions;
+import jakarta.annotation.PostConstruct;
+
+@ConditionalOnProperty(
+        prefix = "sentry",
+        name = "enabled",
+        havingValue = "true",
+        matchIfMissing = false)
+@Configuration
+public class SentryConfiguration {
+
+    static final Logger logger = LoggerFactory.getLogger(SentryConfiguration.class);
+
+    private static String dsn;
+
+    private static String release;
+    private static String environment;
+    private static Map<String, String> tags;
+    private static boolean debug;
+
+    @Value("${sentry.dsn:}")
+    public void setDsn(String dsn) {
+        SentryConfiguration.dsn = dsn;
+    }
+
+    @Value("${sentry.release:}")
+    public void setRelease(String release) {
+        SentryConfiguration.release = release;
+    }
+
+    @Value("${sentry.environment:}")
+    public void setEnvironment(String environment) {
+        SentryConfiguration.environment = environment;
+    }
+
+    @Value("#{${sentry.tags: {}} ?: {}}")
+    public void setTags(Map<String, String> tags) {
+        SentryConfiguration.tags = tags;
+    }
+
+    @Value("${sentry.debug: false}")
+    public void setDebug(boolean debug) {
+        SentryConfiguration.debug = debug;
+    }
+
+    @PostConstruct
+    public static void initialize() {
+        if (dsn != null && !dsn.trim().isEmpty()) {
+            initializeSentry();
+        }
+    }
+
+    @VisibleForTesting
+    public static void initializeSentry() {
+        Sentry.init(
+                sentryOptions -> {
+                    sentryOptions.setDsn(dsn);
+                    sentryOptions.setRelease(release);
+                    sentryOptions.setEnvironment(environment);
+                    sentryOptions.setDebug(debug);
+                    populateTags(sentryOptions);
+                });
+    }
+
+    @VisibleForTesting
+    public static void populateTags(SentryOptions sentryOptions) {
+        try {
+            for (Map.Entry<String, String> extraTagsEntry : tags.entrySet()) {
+                String key = extraTagsEntry.getKey();
+                if (key != null && !key.trim().isEmpty())
+                    sentryOptions.setTag(extraTagsEntry.getKey(), extraTagsEntry.getValue());
+            }
+        } catch (Exception e) {
+            logger.error(e.getMessage());
+        }
+    }
+}

plugins/src/main/resources/logback.xml

@@ -0,0 +1,14 @@
+<configuration>
+    <appender name="Sentry" class="io.sentry.logback.SentryAppender">
+        <!-- Optionally change minimum Event level. Default for Events is ERROR -->
+        <minimumEventLevel>ERROR</minimumEventLevel>
+        <!-- Optionally change minimum Breadcrumbs level. Default for Breadcrumbs is INFO -->
+        <minimumBreadcrumbLevel>INFO</minimumBreadcrumbLevel>
+    </appender>
+
+    <!-- Enable the Console and Sentry appenders, Console is provided as an example
+    of a non-Sentry logger that is set to a different logging threshold -->
+    <root level="INFO">
+        <appender-ref ref="Sentry" />
+    </root>
+</configuration>

plugins/src/test/java/org/smartregister/fhir/gateway/plugins/SentryConfigurationTest.java

@@ -0,0 +1,65 @@
+package org.smartregister.fhir.gateway.plugins;
+
+import static org.mockito.Mockito.*;
+
+import java.util.HashMap;
+import java.util.Map;
+
+import org.junit.Before;
+import org.junit.Test;
+import org.junit.runner.RunWith;
+import org.powermock.api.mockito.PowerMockito;
+import org.powermock.core.classloader.annotations.PrepareForTest;
+import org.powermock.modules.junit4.PowerMockRunner;
+import org.powermock.reflect.internal.WhiteboxImpl;
+
+import io.sentry.Sentry;
+import io.sentry.SentryOptions;
+
+@RunWith(PowerMockRunner.class)
+@PrepareForTest(Sentry.class)
+public class SentryConfigurationTest {
+
+    private SentryConfiguration sentryConfiguration;
+
+    @Before
+    public void setUp() {
+        sentryConfiguration = spy(new SentryConfiguration());
+    }
+
+    @Test
+    public void testInitializeShouldNotInitializeSentryIfDsnIsEmpty() {
+        WhiteboxImpl.setInternalState(sentryConfiguration, "dsn", "");
+        sentryConfiguration.initialize();
+        verify(sentryConfiguration, never()).initializeSentry();
+    }
+
+    @Test
+    public void testInitializeShouldInitializeSentryIfDsnIsNotEmpty() {
+        PowerMockito.mockStatic(Sentry.class);
+        WhiteboxImpl.setInternalState(
+                sentryConfiguration, "dsn", "https://examplePublicKey.sdsd.w/0");
+        sentryConfiguration.initialize();
+        verify(sentryConfiguration, atMost(1)).initializeSentry();
+    }
+
+    @Test
+    public void testPopulateTagsShouldNotAddTagsIfNotPresent() {
+        WhiteboxImpl.setInternalState(sentryConfiguration, "tags", new HashMap<>());
+        SentryOptions sentryOptions = mock(SentryOptions.class);
+        sentryConfiguration.populateTags(sentryOptions);
+        verify(sentryOptions, never()).setTag(anyString(), anyString());
+    }
+
+    @Test
+    public void testPopulateTagsShouldAddTagsToSentryOptions() {
+        String releaseName = "release-name";
+        String release = "release-a";
+        Map<String, String> map = new HashMap<>();
+        map.put(releaseName, release);
+        WhiteboxImpl.setInternalState(sentryConfiguration, "tags", map);
+        SentryOptions sentryOptions = mock(SentryOptions.class);
+        sentryConfiguration.populateTags(sentryOptions);
+        verify(sentryOptions, only()).setTag(eq(releaseName), eq(release));
+    }
+}