Add version to sentryClientName used in auth header (#2596)

adinauer · web-flow · commit dd03aa12caba · 2023-03-10T08:19:27.000+01:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -9,6 +9,7 @@
 ### Fixes
 
 - Deprecate reportFullDisplayed in favor of reportFullyDisplayed ([#2585](https://github.com/getsentry/sentry-java/pull/2585))
+- Add version to sentryClientName used in auth header ([#2596](https://github.com/getsentry/sentry-java/pull/2596))
 
 ## 6.15.0
 
diff --git a/sentry-log4j2/src/main/java/io/sentry/log4j2/SentryAppender.java b/sentry-log4j2/src/main/java/io/sentry/log4j2/SentryAppender.java
@@ -121,7 +121,8 @@ public void start() {
               if (debug != null) {
                 options.setDebug(debug);
               }
-              options.setSentryClientName(BuildConfig.SENTRY_LOG4J2_SDK_NAME);
+              options.setSentryClientName(
+                  BuildConfig.SENTRY_LOG4J2_SDK_NAME + "/" + BuildConfig.VERSION_NAME);
               options.setSdkVersion(createSdkVersion(options));
               if (contextTags != null) {
                 for (final String contextTag : contextTags) {
diff --git a/sentry-logback/src/main/java/io/sentry/logback/SentryAppender.java b/sentry-logback/src/main/java/io/sentry/logback/SentryAppender.java
@@ -50,7 +50,8 @@ public void start() {
     if (!Sentry.isEnabled()) {
       if (options.getDsn() == null || !options.getDsn().endsWith("_IS_UNDEFINED")) {
         options.setEnableExternalConfiguration(true);
-        options.setSentryClientName(BuildConfig.SENTRY_LOGBACK_SDK_NAME);
+        options.setSentryClientName(
+            BuildConfig.SENTRY_LOGBACK_SDK_NAME + "/" + BuildConfig.VERSION_NAME);
         options.setSdkVersion(createSdkVersion(options));
         Optional.ofNullable(transportFactory).ifPresent(options::setTransportFactory);
         try {
diff --git a/sentry-spring-boot-starter-jakarta/src/main/java/io/sentry/spring/boot/jakarta/SentryAutoConfiguration.java b/sentry-spring-boot-starter-jakarta/src/main/java/io/sentry/spring/boot/jakarta/SentryAutoConfiguration.java
@@ -115,7 +115,8 @@ static class HubConfiguration {
             }
           });
 
-      options.setSentryClientName(BuildConfig.SENTRY_SPRING_BOOT_JAKARTA_SDK_NAME);
+      options.setSentryClientName(
+          BuildConfig.SENTRY_SPRING_BOOT_JAKARTA_SDK_NAME + "/" + BuildConfig.VERSION_NAME);
       options.setSdkVersion(createSdkVersion(options));
       addPackageAndIntegrationInfo();
       if (options.getTracesSampleRate() == null && options.getEnableTracing() == null) {
diff --git a/sentry-spring-boot-starter-jakarta/src/test/kotlin/io/sentry/spring/boot/jakarta/SentryAutoConfigurationTest.kt b/sentry-spring-boot-starter-jakarta/src/test/kotlin/io/sentry/spring/boot/jakarta/SentryAutoConfigurationTest.kt
@@ -244,7 +244,7 @@ class SentryAutoConfigurationTest {
     fun `sets sentryClientName property on SentryOptions`() {
         contextRunner.withPropertyValues("sentry.dsn=http://key@localhost/proj")
             .run {
-                assertThat(it.getBean(SentryOptions::class.java).sentryClientName).isEqualTo("sentry.java.spring-boot${optionalJakartaPrefix()}")
+                assertThat(it.getBean(SentryOptions::class.java).sentryClientName).isEqualTo("sentry.java.spring-boot.jakarta/${BuildConfig.VERSION_NAME}")
             }
     }
 
@@ -924,11 +924,4 @@ class SentryAutoConfigurationTest {
         val userFilter = this.getBean("sentryUserFilter", FilterRegistrationBean::class.java).filter as SentryUserFilter
         return userFilter.sentryUserProviders
     }
-
-    private fun optionalJakartaPrefix(): String {
-        if (this.javaClass.packageName.endsWith("jakarta")) {
-            return ".jakarta"
-        }
-        return ""
-    }
 }
diff --git a/sentry-spring-boot-starter/src/main/java/io/sentry/spring/boot/SentryAutoConfiguration.java b/sentry-spring-boot-starter/src/main/java/io/sentry/spring/boot/SentryAutoConfiguration.java
@@ -115,7 +115,8 @@ static class HubConfiguration {
             }
           });
 
-      options.setSentryClientName(BuildConfig.SENTRY_SPRING_BOOT_SDK_NAME);
+      options.setSentryClientName(
+          BuildConfig.SENTRY_SPRING_BOOT_SDK_NAME + "/" + BuildConfig.VERSION_NAME);
       options.setSdkVersion(createSdkVersion(options));
       addPackageAndIntegrationInfo();
       if (options.getTracesSampleRate() == null && options.getEnableTracing() == null) {
diff --git a/sentry-spring-boot-starter/src/test/kotlin/io/sentry/spring/boot/SentryAutoConfigurationTest.kt b/sentry-spring-boot-starter/src/test/kotlin/io/sentry/spring/boot/SentryAutoConfigurationTest.kt
@@ -244,7 +244,7 @@ class SentryAutoConfigurationTest {
     fun `sets sentryClientName property on SentryOptions`() {
         contextRunner.withPropertyValues("sentry.dsn=http://key@localhost/proj")
             .run {
-                assertThat(it.getBean(SentryOptions::class.java).sentryClientName).isEqualTo("sentry.java.spring-boot${optionalJakartaPrefix()}")
+                assertThat(it.getBean(SentryOptions::class.java).sentryClientName).isEqualTo("sentry.java.spring-boot/${BuildConfig.VERSION_NAME}")
             }
     }
 
@@ -924,11 +924,4 @@ class SentryAutoConfigurationTest {
         val userFilter = this.getBean("sentryUserFilter", FilterRegistrationBean::class.java).filter as SentryUserFilter
         return userFilter.sentryUserProviders
     }
-
-    private fun optionalJakartaPrefix(): String {
-        if (this.javaClass.packageName.endsWith("jakarta")) {
-            return ".jakarta"
-        }
-        return ""
-    }
 }

Original file line number	Diff line number	Diff line change
`@@ -115,7 +115,8 @@ static class HubConfiguration {`
`115`	`115`	`}`
`116`	`116`	`});`
`117`	`117`
`118`		`- options.setSentryClientName(BuildConfig.SENTRY_SPRING_BOOT_JAKARTA_SDK_NAME);`
	`118`	`+ options.setSentryClientName(`
	`119`	`+ BuildConfig.SENTRY_SPRING_BOOT_JAKARTA_SDK_NAME + "/" + BuildConfig.VERSION_NAME);`
`119`	`120`	`options.setSdkVersion(createSdkVersion(options));`
`120`	`121`	`addPackageAndIntegrationInfo();`
`121`	`122`	`if (options.getTracesSampleRate() == null && options.getEnableTracing() == null) {`
Original file line number	Diff line number	Diff line change
`@@ -244,7 +244,7 @@ class SentryAutoConfigurationTest {`
`244`	`244`	fun `sets sentryClientName property on SentryOptions`() {
`245`	`245`	`contextRunner.withPropertyValues("sentry.dsn=http://key@localhost/proj")`
`246`	`246`	`.run {`
`247`		`- assertThat(it.getBean(SentryOptions::class.java).sentryClientName).isEqualTo("sentry.java.spring-boot${optionalJakartaPrefix()}")`
	`247`	`+ assertThat(it.getBean(SentryOptions::class.java).sentryClientName).isEqualTo("sentry.java.spring-boot.jakarta/${BuildConfig.VERSION_NAME}")`
`248`	`248`	`}`
`249`	`249`	`}`
`250`	`250`
`@@ -924,11 +924,4 @@ class SentryAutoConfigurationTest {`
`924`	`924`	`val userFilter = this.getBean("sentryUserFilter", FilterRegistrationBean::class.java).filter as SentryUserFilter`
`925`	`925`	`return userFilter.sentryUserProviders`
`926`	`926`	`}`
`927`		`-`
`928`		`- private fun optionalJakartaPrefix(): String {`
`929`		`- if (this.javaClass.packageName.endsWith("jakarta")) {`
`930`		`- return ".jakarta"`
`931`		`- }`
`932`		`- return ""`
`933`		`- }`
`934`	`927`	`}`