Escape / in release version (#371)

Author: VincentLanglet

src/DependencyInjection/Configuration.php

@@ -111,10 +111,14 @@ public function getConfigTreeBuilder(): TreeBuilder
             ->prototype('scalar');
         $optionsChildNodes->scalarNode('project_root');
 
-        $releaseNode = $optionsChildNodes->scalarNode('release')
+        $optionsChildNodes->scalarNode('release')
             ->info('Release version to be reported to sentry, see https://docs.sentry.io/workflow/releases/?platform=php')
-            ->example('my/application@ff11bb');
-        $releaseNode->defaultValue(PrettyVersions::getRootPackageVersion()->getPrettyVersion());
+            ->example('my-application@ff11bb')
+            ->beforeNormalization()
+            ->ifString()
+            ->then($this->escapeInvalidReleaseCharacters())
+            ->end()
+            ->defaultValue(PrettyVersions::getRootPackageVersion()->getPrettyVersion());
 
         $optionsChildNodes->floatNode('sample_rate')
             ->min(0.0)
@@ -177,6 +181,13 @@ public function getConfigTreeBuilder(): TreeBuilder
         return $treeBuilder;
     }
 
+    private function escapeInvalidReleaseCharacters(): \Closure
+    {
+        return static function ($str): string {
+            return str_replace('/', '-', $str);
+        };
+    }
+
     private function getTrimClosure(): \Closure
     {
         return static function ($str): ?string {

test/DependencyInjection/ConfigurationTest.php

@@ -137,6 +137,13 @@ public function optionValuesProvider(): array
         ];
     }
 
+    public function testReleaseValueEscaped(): void
+    {
+        $processed = $this->processConfiguration(['options' => ['release' => 'abc/123']]);
+
+        $this->assertContains(['options' => ['release' => 'abc-123']], $processed);
+    }
+
     /**
      * @dataProvider invalidValuesProvider
      */