Encode SDK_VERSION in a Java class instead of looking up a ResouceBun… (#609)

Author: bretthoerner

CHANGES

@@ -1,7 +1,7 @@
 Version 1.7.9
 -------------
 
--
+- Encode SDK_VERSION in a Java class instead of looking up a ResouceBundle.
 
 Version 1.7.8
 -------------

sentry/pom.xml

@@ -98,6 +98,19 @@
             </resource>
         </resources>
         <plugins>
+            <plugin>
+                <groupId>org.codehaus.mojo</groupId>
+                <artifactId>templating-maven-plugin</artifactId>
+                <version>1.0.0</version>
+                <executions>
+                    <execution>
+                        <id>filtering-java-templates</id>
+                        <goals>
+                            <goal>filter-sources</goal>
+                        </goals>
+                    </execution>
+                </executions>
+            </plugin>
             <plugin>
                 <groupId>org.codehaus.mojo</groupId>
                 <artifactId>buildnumber-maven-plugin</artifactId>

sentry/src/main/java-templates/io/sentry/environment/Version.java

@@ -0,0 +1,9 @@
+package io.sentry.environment;
+
+public final class Version {
+    public static final String SDK_VERSION = "${buildNumber}";
+
+    private Version() {
+
+    }
+}

sentry/src/main/java/io/sentry/environment/SentryEnvironment.java

@@ -3,7 +3,6 @@
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
-import java.util.ResourceBundle;
 import java.util.concurrent.atomic.AtomicInteger;
 
 /**
@@ -20,7 +19,7 @@ public final class SentryEnvironment {
     /**
      * Version of this SDK.
      */
-    public static final String SDK_VERSION = ResourceBundle.getBundle("sentry-build").getString("build.name");
+    public static final String SDK_VERSION = Version.SDK_VERSION;
     /**
      * Indicates whether the current thread is managed by sentry or not.
      */

sentry/src/test/java/io/sentry/SentryTest.java

@@ -6,6 +6,7 @@
 import io.sentry.context.ContextManager;
 import io.sentry.context.SingletonContextManager;
 import io.sentry.dsn.Dsn;
+import io.sentry.environment.Version;
 import io.sentry.event.Event;
 import io.sentry.event.EventBuilder;
 import io.sentry.event.helper.EventBuilderHelper;
@@ -141,7 +142,7 @@ public void testInitStringDsn() throws Exception {
         assertThat(sentryUrl.getPath(), equalTo("/api/1/store/"));
 
         String authHeader = getField(connection, "authHeader");
-        assertThat(authHeader, equalTo("Sentry sentry_version=6,sentry_client=sentry-java/test,sentry_key=public,sentry_secret=private"));
+        assertThat(authHeader, equalTo("Sentry sentry_version=6,sentry_client=sentry-java/" + Version.SDK_VERSION + ",sentry_key=public,sentry_secret=private"));
     }
 
     @Test
@@ -157,7 +158,7 @@ public void testInitStringDsnAndFactory() throws Exception {
         assertThat(sentryUrl.getPath(), equalTo("/api/1/store/"));
 
         String authHeader = getField(connection, "authHeader");
-        assertThat(authHeader, equalTo("Sentry sentry_version=6,sentry_client=sentry-java/test,sentry_key=public,sentry_secret=private"));
+        assertThat(authHeader, equalTo("Sentry sentry_version=6,sentry_client=sentry-java/" + Version.SDK_VERSION + ",sentry_key=public,sentry_secret=private"));
     }
 
     @Test

sentry/src/test/java/io/sentry/connection/AbstractConnectionTest.java

@@ -1,6 +1,7 @@
 package io.sentry.connection;
 
 import io.sentry.BaseTest;
+import io.sentry.environment.Version;
 import io.sentry.time.FixedClock;
 import mockit.*;
 import io.sentry.event.Event;
@@ -40,7 +41,7 @@ public void testAuthHeader() throws Exception {
         String authHeader = abstractConnection.getAuthHeader();
 
         assertThat(authHeader, is("Sentry sentry_version=6,"
-                + "sentry_client=sentry-java/test,"
+                + "sentry_client=sentry-java/" + Version.SDK_VERSION + ","
                 + "sentry_key=" + publicKey + ","
                 + "sentry_secret=" + secretKey));
     }

src/checkstyle/suppressions.xml

@@ -5,4 +5,5 @@
 
 <suppressions>
     <suppress files="io.sentry/util/CircularFifoQueue\.java" checks=".*"/>
+    <suppress files="io.sentry/environment/Version\.java" checks=".*"/>
 </suppressions>