Merge pull request #20 from jop-software/extension-configuration

[FEATURE] Extension Configuration

Classes/Service/ConfigurationService.php

@@ -2,25 +2,51 @@
 
 namespace Jops\TYPO3\Sentry\Service;
 
+use TYPO3\CMS\Core\Configuration\Exception\ExtensionConfigurationExtensionNotConfiguredException;
+use TYPO3\CMS\Core\Configuration\Exception\ExtensionConfigurationPathDoesNotExistException;
+use TYPO3\CMS\Core\Configuration\ExtensionConfiguration;
+use TYPO3\CMS\Core\Utility\GeneralUtility;
+
 class ConfigurationService
 {
+	/**
+	 * @param string $path
+	 * @return string
+	 * @throws ExtensionConfigurationExtensionNotConfiguredException
+	 * @throws ExtensionConfigurationPathDoesNotExistException
+	 */
+	protected static function getExtensionConfiguration(string $path): string
+	{
+		/** @var ExtensionConfiguration $extensionConfiguration */
+		$extensionConfiguration = GeneralUtility::makeInstance(ExtensionConfiguration::class);
+		return strval($extensionConfiguration->get('typo3_sentry_client', $path));
+	}
+
 	public static function getDsn(): string
 	{
-		return getenv("SENTRY_DSN") ?: "";
+		return getenv("SENTRY_DSN")
+			?: self::getExtensionConfiguration("dsn");
 	}
 
 	public static function getRelease(): string
 	{
-		return getenv("SENTRY_RELEASE") ?: "";
+		return getenv("SENTRY_RELEASE")
+			?: self::getExtensionConfiguration("release")
+				?: "1.0.0";
 	}
 
 	public static function getEnvironment(): string
 	{
-		return getenv("SENTRY_ENVIRONMENT") ?: "";
+		// TODO: Update the environment so its for sure compatible with sentry.
+		return getenv("SENTRY_ENVIRONMENT")
+			?: self::getExtensionConfiguration("environment")
+				?: "Production";
 	}
 
 	public static function getTracesSampleRate(): float
 	{
-		return floatval(getenv("SENTRY_TRACES_SAMPLE_RATE")) ?: 0.5;
+		return floatval(getenv("SENTRY_TRACES_SAMPLE_RATE"))
+			?: floatval(self::getExtensionConfiguration("traces_sample_rate"))
+				?: 0.5;
 	}
 }

Readme.md

@@ -20,6 +20,10 @@ SetEnv SENTRY_TRACES_SAMPLE_RATE 1.0
 SetEnv SENTRY_RELEASE 9.10.19
 ###< jop-software/typo3-sentry-client
 ```
+
+You can also configure the extension from the TYPO3 backend. You can set the same settings as you can with environment variables.  
+Keep in mind that environment variables get prioritized over extension configuration. 
+
 Add the `productionExceptionHandler` / `debugExceptionHandler` to your `LocalConfiguration.php` or `AdditionalConfiguration.php`file.
 ```php
 $GLOBALS['TYPO3_CONF_VARS']['SYS']['productionExceptionHandler'] = 'Jops\TYPO3\Sentry\Handler\ProductionExceptionHandler';

Tests/Unit/ConfigurationServiceTest.php

@@ -7,18 +7,8 @@
 
 class ConfigurationServiceTest extends UnitTestCase
 {
-	public function testDSNIsEmptyWithoutEnvironmentVariable()
+	public function testPlaceholder(): void
 	{
-		$this->assertEquals("", ConfigurationService::getDsn());
-	}
-
-	public function testEnvironmentIsEmptyWithoutEnvironmentVariable()
-	{
-		$this->assertEquals("", ConfigurationService::getEnvironment());
-	}
-
-	public function testReleaseIsEmptyWithoutEnvironmentVariable()
-	{
-		$this->assertEquals("", ConfigurationService::getRelease());
+		$this->assertTrue(true);
 	}
 }

ext_conf_template.txt

@@ -0,0 +1,8 @@
+# cat=General; type=string; label=Sentry DSN
+dsn =
+# cat=General; type=string; label=Sentry Environment
+environment =
+# cat=General; type=string; label=Sentry Release
+release =
+# cat=General; type=string; label=Sentry Traces Sample Rate (0.0-1.0)
+traces_sample_rate =