Add new strictTracePropagation option (#1834)

Author: cleptric

phpstan-baseline.neon

@@ -265,6 +265,11 @@ parameters:
 			count: 1
 			path: src/Options.php
 
+		-
+			message: "#^Method Sentry\\\\Options\\:\\:isStrictTracePropagationEnabled\\(\\) should return bool but returns mixed\\.$#"
+			count: 1
+			path: src/Options.php
+
 		-
 			message: "#^Method Sentry\\\\Options\\:\\:shouldAttachMetricCodeLocations\\(\\) should return bool but returns mixed\\.$#"
 			count: 1

src/Options.php

@@ -668,6 +668,26 @@ public function setTracePropagationTargets(array $tracePropagationTargets): self
         return $this;
     }
 
+    /**
+     * Returns whether strict trace propagation is enabled or not.
+     */
+    public function isStrictTracePropagationEnabled(): bool
+    {
+        return $this->options['strict_trace_propagation'];
+    }
+
+    /**
+     * Sets if strict trace propagation should be enabled or not.
+     */
+    public function enableStrictTracePropagation(bool $strictTracePropagation): self
+    {
+        $options = array_merge($this->options, ['strict_trace_propagation' => $strictTracePropagation]);
+
+        $this->options = $this->resolver->resolve($options);
+
+        return $this;
+    }
+
     /**
      * Gets a list of default tags for events.
      *
@@ -1186,6 +1206,7 @@ private function configureOptions(OptionsResolver $resolver): void
                 return null;
             },
             'trace_propagation_targets' => null,
+            'strict_trace_propagation' => false,
             'tags' => [],
             'error_types' => null,
             'max_breadcrumbs' => self::DEFAULT_MAX_BREADCRUMBS,
@@ -1234,6 +1255,7 @@ private function configureOptions(OptionsResolver $resolver): void
         $resolver->setAllowedTypes('ignore_exceptions', 'string[]');
         $resolver->setAllowedTypes('ignore_transactions', 'string[]');
         $resolver->setAllowedTypes('trace_propagation_targets', ['null', 'string[]']);
+        $resolver->setAllowedTypes('strict_trace_propagation', 'bool');
         $resolver->setAllowedTypes('tags', 'string[]');
         $resolver->setAllowedTypes('error_types', ['null', 'int']);
         $resolver->setAllowedTypes('max_breadcrumbs', 'int');

src/functions.php

@@ -57,6 +57,7 @@
  *     server_name?: string,
  *     spotlight?: bool,
  *     spotlight_url?: string,
+ *     strict_trace_propagation?: bool,
  *     tags?: array<string>,
  *     trace_propagation_targets?: array<string>|null,
  *     traces_sample_rate?: float|int|null,

tests/OptionsTest.php

@@ -278,6 +278,13 @@ static function (): void {},
             'setTracePropagationTargets',
         ];
 
+        yield [
+            'strict_trace_propagation',
+            true,
+            'isStrictTracePropagationEnabled',
+            'enableStrictTracePropagation',
+        ];
+
         yield [
             'before_breadcrumb',
             static function (): void {},