Test on PHP 8.4

.github/workflows/ca.yml

@@ -20,6 +20,7 @@ jobs:
       matrix:
         php-version:
           - "7.4"
+          - "8.1"
 
     steps:
       - uses: actions/checkout@v3

.github/workflows/cs.yml

@@ -20,6 +20,7 @@ jobs:
       matrix:
         php-version:
           - "7.4"
+          - "8.1"
 
     steps:
       - uses: actions/checkout@v3

.github/workflows/example.yml

@@ -20,7 +20,7 @@ jobs:
     strategy:
       matrix:
         php-version:
-          - "7.4"
+          - "8.1"
 
     defaults:
       run:

.github/workflows/mt.yml

@@ -17,7 +17,7 @@ jobs:
     strategy:
       matrix:
         php-version:
-          - "8.2"
+          - "8.4"
 
     steps:
       - uses: actions/checkout@v3

.github/workflows/php.yml

@@ -22,6 +22,7 @@ jobs:
           - "8.1"
           - "8.2"
           - "8.3"
+          - "8.4"
 
     steps:
       - uses: actions/checkout@v3

.php-cs-fixer.dist.php

@@ -66,6 +66,7 @@
         'blank_line_after_opening_tag' => false,
         'linebreak_after_opening_tag' => false,
         'blank_line_between_import_groups' => false,
+        'nullable_type_declaration_for_default_null_value' => true,
     ])
     ->setFinder(
         PhpCsFixer\Finder::create()

example/src/Automattic/MyAwesomeReader/StreamBuilder/Trending/Streams/TrendingTopicStream.php

@@ -48,8 +48,8 @@ public function __construct(string $identity)
     /** @inheritDoc */
     protected function _enumerate(
         int $count,
-        StreamCursor $cursor = null,
-        StreamTracer $tracer = null,
+        ?StreamCursor $cursor = null,
+        ?StreamTracer $tracer = null,
         ?EnumerationOptions $option = null
     ): StreamResult {
         if (!$cursor instanceof TrendingTopicStreamCursor) {

extras/phpcs/TumblrApp/ruleset.xml

@@ -202,6 +202,7 @@
         </properties>
     </rule>
     <rule ref="SlevomatCodingStandard.PHP.ShortList" />
+    <rule ref="SlevomatCodingStandard.TypeHints.NullableTypeForNullDefaultValue" />
     <rule ref="SlevomatCodingStandard.TypeHints.DeclareStrictTypes">
         <properties>
             <property name="declareOnFirstLine" value="true"/>

lib/Tumblr/StreamBuilder/Codec/Codec.php

@@ -75,7 +75,7 @@ abstract class Codec
      * @param CacheProvider|null $cache_provider The cache provider used to deserialize a template.
      * @see @StreamContext, there are stuff from stream are cached during the to_template process.
      */
-    public function __construct(CacheProvider $cache_provider = null)
+    public function __construct(?CacheProvider $cache_provider = null)
     {
         $this->cache_provider = $cache_provider;
     }

lib/Tumblr/StreamBuilder/Exceptions/InvalidStreamArrayException.php

@@ -30,7 +30,7 @@ class InvalidStreamArrayException extends \InvalidArgumentException
     /**
      * @param array|null $stream_array The stream_array which is sent to the deserializer
      */
-    public function __construct(array $stream_array = null)
+    public function __construct(?array $stream_array = null)
     {
         parent::__construct(sprintf(
             'Invalid stream array: %s',

lib/Tumblr/StreamBuilder/Exceptions/TemplateNotFoundException.php

@@ -32,7 +32,7 @@ class TemplateNotFoundException extends \InvalidArgumentException
      * @param int $code The exception code.
      * @param \Throwable $previous The previous exception.
      */
-    public function __construct($message = "Template not found", $code = 404, \Throwable $previous = null)
+    public function __construct($message = "Template not found", $code = 404, ?\Throwable $previous = null)
     {
         parent::__construct($message, $code, $previous);
     }

lib/Tumblr/StreamBuilder/FencepostRanking/FencepostCursor.php

@@ -79,8 +79,8 @@ public function __construct(
         int $fencepost_timestamp_ms,
         int $region,
         int $head_offset,
-        StreamCursor $tail_cursor = null,
-        StreamCursor $inject_cursor = null
+        ?StreamCursor $tail_cursor = null,
+        ?StreamCursor $inject_cursor = null
     ) {
         if ($region !== self::REGION_INJECT && is_null($tail_cursor)) {
             throw new \InvalidArgumentException('Head or Tail region must contains tail_cursor');

lib/Tumblr/StreamBuilder/FencepostRanking/FencepostRankedStream.php

@@ -166,8 +166,8 @@ abstract protected function get_fence_id_str(): string;
      */
     protected function _enumerate(
         int $count,
-        StreamCursor $cursor = null,
-        StreamTracer $tracer = null,
+        ?StreamCursor $cursor = null,
+        ?StreamTracer $tracer = null,
         ?EnumerationOptions $option = null
     ): StreamResult {
         if (!(is_null($cursor) || ($cursor instanceof FencepostCursor))) {
@@ -195,7 +195,7 @@ protected function _enumerate(
      * @param EnumerationOptions|null $option The option on enumeration
      * @return array [Fencepost|null, FencepostRankedStreamCursor|null]
      */
-    private function setup_enumeration(FencepostCursor $in_cursor = null, StreamTracer $tracer = null, ?EnumerationOptions $option = null)
+    private function setup_enumeration(?FencepostCursor $in_cursor = null, ?StreamTracer $tracer = null, ?EnumerationOptions $option = null)
     {
         if (!is_null($in_cursor)) {
             // you already have a cursor, try to turn it into a fencepost:
@@ -287,7 +287,7 @@ private function setup_enumeration_from_existing_fencepost(
     private function setup_enumeration_from_new_fencepost(
         ?StreamTracer $tracer,
         int $now_ms,
-        int $latest_ms = null,
+        ?int $latest_ms = null,
         ?EnumerationOptions $option = null
     ): array {
         $fencepost = $this->commit_new_fencepost($now_ms, $latest_ms, $tracer, $option);
@@ -558,7 +558,7 @@ private function enumerate_rec_head(
     protected function enumerate_final(
         int $count,
         FencepostCursor $cursor,
-        StreamTracer $tracer = null,
+        ?StreamTracer $tracer = null,
         ?EnumerationOptions $option = null
     ): StreamResult {
         StreamBuilder::getDependencyBag()->getLog()
@@ -580,7 +580,7 @@ protected function enumerate_final_inner(
         int $count,
         ?StreamCursor $cursor,
         ?int $fencepost_timestamp_ms,
-        StreamTracer $tracer = null,
+        ?StreamTracer $tracer = null,
         ?EnumerationOptions $option = null
     ): StreamResult {
         $inner_result = $this->inner->enumerate($count, $cursor, $tracer, $option);
@@ -608,8 +608,8 @@ protected function enumerate_final_inner(
      */
     protected function commit_new_fencepost(
         int $current_ms,
-        int $previous_fencepost_ms = null,
-        StreamTracer $tracer = null,
+        ?int $previous_fencepost_ms = null,
+        ?StreamTracer $tracer = null,
         ?EnumerationOptions $option = null
     ) {
         // we are building a new fencepost between $current_ms and $previous_fencepost_ms.
@@ -659,8 +659,8 @@ protected function enumerate_inner_between(
         int $before_ms_inclusive,
         ?int $after_ms_exclusive,
         int $count,
-        StreamCursor $inner_cursor = null,
-        StreamTracer $tracer = null
+        ?StreamCursor $inner_cursor = null,
+        ?StreamTracer $tracer = null
     ): StreamResult {
         $option = new EnumerationOptions($before_ms_inclusive, $after_ms_exclusive);
         $result = $this->inner->enumerate($count, $inner_cursor, $tracer, $option);
@@ -701,7 +701,7 @@ public function can_enumerate_with_time_range(): bool
     public function log_commit_new_fence_stats(
         StreamResult $unranked_candidates,
         int $current_ms,
-        int $previous_fencepost_ms = null
+        ?int $previous_fencepost_ms = null
     ): void {
         $ps_gap_in_seconds = ($current_ms - ($previous_fencepost_ms ?? 0)) / 1000;
         // Track when last_ts is missing, putting 1 second as a placeholder

lib/Tumblr/StreamBuilder/InjectionAllocatorResult.php

@@ -39,7 +39,7 @@ final class InjectionAllocatorResult
      * @param array|null $state The injector state to coordinate between different pages.
      * @throws TypeMismatchException If position is not an int.
      */
-    public function __construct(array $out, array $state = null)
+    public function __construct(array $out, ?array $state = null)
     {
         foreach ($out as $position) {
             if (!is_int($position)) {

lib/Tumblr/StreamBuilder/InjectionAllocators/ExpectedValueInjectionAllocator.php

@@ -72,7 +72,7 @@ public static function from_template(StreamContext $context): self
     /**
      * @inheritDoc
      */
-    public function allocate(int $page_size, array $state = null): InjectionAllocatorResult
+    public function allocate(int $page_size, ?array $state = null): InjectionAllocatorResult
     {
         $expected_value = $page_size * $this->slot_injection_probability;
         $count = floor($expected_value);

lib/Tumblr/StreamBuilder/InjectionAllocators/GlobalFixedInjectionAllocator.php

@@ -32,7 +32,7 @@ class GlobalFixedInjectionAllocator extends FixedInjectionAllocator
     /**
      * @inheritDoc
      */
-    public function allocate(int $page_size, array $state = null): InjectionAllocatorResult
+    public function allocate(int $page_size, ?array $state = null): InjectionAllocatorResult
     {
         $pos_base = $state['pos_base'] ?? 0;
         $out = [];

lib/Tumblr/StreamBuilder/InjectionAllocators/InjectionAllocator.php

@@ -36,5 +36,5 @@ abstract class InjectionAllocator extends Templatable
      * @param array|null $state The state of the injector.
      * @return InjectionAllocatorResult .
      */
-    abstract public function allocate(int $page_size, array $state = null): InjectionAllocatorResult;
+    abstract public function allocate(int $page_size, ?array $state = null): InjectionAllocatorResult;
 }

lib/Tumblr/StreamBuilder/InjectionAllocators/LocalFixedInjectionAllocator.php

@@ -31,7 +31,7 @@ class LocalFixedInjectionAllocator extends FixedInjectionAllocator
     /**
      * @inheritDoc
      */
-    public function allocate(int $page_size, array $state = null): InjectionAllocatorResult
+    public function allocate(int $page_size, ?array $state = null): InjectionAllocatorResult
     {
         $out = [];
         foreach ($this->positions as $p) {

lib/Tumblr/StreamBuilder/InjectionAllocators/ProbabilisticInjectionAllocator.php

@@ -61,7 +61,7 @@ public static function from_template(StreamContext $context): self
     /**
      * @inheritDoc
      */
-    public function allocate(int $page_size, array $state = null): InjectionAllocatorResult
+    public function allocate(int $page_size, ?array $state = null): InjectionAllocatorResult
     {
         $out = [];
         $mt_randmax = mt_getrandmax();

lib/Tumblr/StreamBuilder/InjectionAllocators/UniformInjectionAllocator.php

@@ -71,7 +71,7 @@ public static function from_template(StreamContext $context): self
     /**
      * @inheritDoc
      */
-    public function allocate(int $page_size, array $state = null): InjectionAllocatorResult
+    public function allocate(int $page_size, ?array $state = null): InjectionAllocatorResult
     {
         $out = [];
         // If there's no next_offset is set, we use remainder, most likely in the first page.

lib/Tumblr/StreamBuilder/InjectionPlan.php

@@ -47,7 +47,7 @@ class InjectionPlan
      * @param array|null $injector_state An array representing the state of the injector, if any, after injection.
      * @throws TypeMismatchException If some value in the provided array is not a StreamInjection.
      */
-    public function __construct(array $index_to_injection, array $injector_state = null)
+    public function __construct(array $index_to_injection, ?array $injector_state = null)
     {
         foreach ($index_to_injection as $j) {
             if (!($j instanceof StreamInjection)) {

lib/Tumblr/StreamBuilder/SignalFetchers/CompositeSignalFetcher.php

@@ -53,7 +53,7 @@ public function __construct(array $fetchers, string $identity)
     /**
      * @inheritDoc
      */
-    protected function fetch_inner(array $stream_elements, StreamTracer $tracer = null): SignalBundle
+    protected function fetch_inner(array $stream_elements, ?StreamTracer $tracer = null): SignalBundle
     {
         $bundles = [];
         foreach ($this->fetchers as $fetcher) {

lib/Tumblr/StreamBuilder/SignalFetchers/SignalFetcher.php

@@ -40,7 +40,7 @@ abstract class SignalFetcher extends Templatable
      * @throws TypeMismatchException If some element is not a StreamElement.
      * @throws \Exception If the signal fetcher fails for some other reason.
      */
-    final public function fetch(array $stream_elements, StreamTracer $tracer = null): SignalBundle
+    final public function fetch(array $stream_elements, ?StreamTracer $tracer = null): SignalBundle
     {
         foreach ($stream_elements as $stream_element) {
             if (!($stream_element instanceof StreamElement)) {
@@ -72,7 +72,7 @@ final public function fetch(array $stream_elements, StreamTracer $tracer = null)
      * @param StreamTracer|null $tracer Tracer to use for metrics and logging of signal fetching process.
      * @return SignalBundle
      */
-    abstract protected function fetch_inner(array $stream_elements, StreamTracer $tracer = null): SignalBundle;
+    abstract protected function fetch_inner(array $stream_elements, ?StreamTracer $tracer = null): SignalBundle;
 
     /**
      * Get the string representation of the current signal fetcher.

lib/Tumblr/StreamBuilder/SignalFetchers/TimestampFetcher.php

@@ -35,7 +35,7 @@ final class TimestampFetcher extends SignalFetcher
     /**
      * @inheritDoc
      */
-    protected function fetch_inner(array $stream_elements, StreamTracer $tracer = null): SignalBundle
+    protected function fetch_inner(array $stream_elements, ?StreamTracer $tracer = null): SignalBundle
     {
         $builder = new SignalBundleBuilder();
         foreach ($stream_elements as $stream_element) {

lib/Tumblr/StreamBuilder/StreamCursors/ConcatenatedStreamCursor.php

@@ -39,7 +39,7 @@ class ConcatenatedStreamCursor extends StreamCursor
      * @param StreamCursor $source_cursor The original cursor of element
      * @throws \InvalidArgumentException If source index is not an int.
      */
-    public function __construct(int $source_index, StreamCursor $source_cursor = null)
+    public function __construct(int $source_index, ?StreamCursor $source_cursor = null)
     {
         $this->source_index = $source_index;
         $this->source_cursor = $source_cursor;

lib/Tumblr/StreamBuilder/StreamCursors/FilteredStreamCursor.php

@@ -42,7 +42,7 @@ final class FilteredStreamCursor extends StreamCursor
      * @param StreamCursor|null $cursor The inner cursor tracking pagination state of the inner stream to be filtered.
      * @param StreamFilterState|null $filter_state The filter state.
      */
-    public function __construct(StreamCursor $cursor = null, StreamFilterState $filter_state = null)
+    public function __construct(?StreamCursor $cursor = null, ?StreamFilterState $filter_state = null)
     {
         $this->cursor = $cursor;
         $this->filter_state = $filter_state;
@@ -83,7 +83,7 @@ public static function from_template(StreamContext $context): self
      * @param StreamFilterState|null $filter_state The filter state.
      * @return FilteredStreamCursor
      */
-    public function with_filter_state(StreamFilterState $filter_state = null): FilteredStreamCursor
+    public function with_filter_state(?StreamFilterState $filter_state = null): FilteredStreamCursor
     {
         return new self($this->cursor, $filter_state);
     }

lib/Tumblr/StreamBuilder/StreamCursors/InjectedStreamCursor.php

@@ -43,7 +43,7 @@ final class InjectedStreamCursor extends StreamCursor
      * @param StreamCursor $inner_cursor    The cursor for the inner stream.
      * @param array|null $injector_state    The injector state.
      */
-    public function __construct(StreamCursor $inner_cursor = null, array $injector_state = null)
+    public function __construct(?StreamCursor $inner_cursor = null, ?array $injector_state = null)
     {
         $this->inner_cursor = $inner_cursor;
         $this->injector_state = $injector_state;

lib/Tumblr/StreamBuilder/StreamCursors/MultiCursor.php

@@ -41,7 +41,7 @@ final class MultiCursor extends StreamCursor
      * @param array $stream_to_cursor Mapping from stream ids (strings) to StreamCursor objects
      * @param array|null $injector_state State of injector, if any.
      */
-    public function __construct(array $stream_to_cursor, array $injector_state = null)
+    public function __construct(array $stream_to_cursor, ?array $injector_state = null)
     {
         $this->stream_to_cursor = $stream_to_cursor;
         $this->injector_state = $injector_state;
@@ -115,7 +115,7 @@ public function get_injector_state()
      * @param array|null $injector_state State of injector, if any.
      * @return MultiCursor
      */
-    public function with_injector_state(array $injector_state = null): self
+    public function with_injector_state(?array $injector_state = null): self
     {
         return new MultiCursor($this->stream_to_cursor, $injector_state);
     }

lib/Tumblr/StreamBuilder/StreamCursors/StreamCursor.php

@@ -60,7 +60,7 @@ abstract class StreamCursor extends Templatable
      * @param StreamCursor|null $other The other cursor.
      * @return bool True, iff the cursors can combine.
      */
-    final public function can_combine_with(StreamCursor $other = null): bool
+    final public function can_combine_with(?StreamCursor $other = null): bool
     {
         return is_null($other) || $this->_can_combine_with($other);
     }
@@ -73,7 +73,7 @@ final public function can_combine_with(StreamCursor $other = null): bool
      * @throws UncombinableCursorException If the provided cursor cannot be combined
      * with this cursor.
      */
-    final public function combine_with(StreamCursor $other = null): self
+    final public function combine_with(?StreamCursor $other = null): self
     {
         if (is_null($other)) {
             return $this;
@@ -158,7 +158,7 @@ public static function encode(
         string $secret,
         string $encrypt_key,
         string $initial_vector_seed = '',
-        CacheProvider $cache_provider = null,
+        ?CacheProvider $cache_provider = null,
         int $cache_size_threshold = self::DEFAULT_CACHE_SIZE_THRESHOLD,
         ?string $context = null,
         ?string $current_user_id = null
@@ -220,7 +220,7 @@ public static function decode(
         array $encrypt_keys,
         ?string $current_user_id = null,
         array $encrypt_seeds = [],
-        CacheProvider $cache_provider = null
+        ?CacheProvider $cache_provider = null
     ): ?self {
         if (empty(trim($cursor_string))) {
             return null;

lib/Tumblr/StreamBuilder/StreamFilterState.php

@@ -34,7 +34,7 @@ abstract class StreamFilterState extends Templatable
      * @param StreamFilterState|null $other The other state.
      * @return bool True, iff the states can merge.
      */
-    final public function can_merge_with(StreamFilterState $other = null): bool
+    final public function can_merge_with(?StreamFilterState $other = null): bool
     {
         return is_null($other) || $this->_can_merge_with($other);
     }
@@ -52,7 +52,7 @@ abstract protected function _can_merge_with(StreamFilterState $other): bool;
      * @return StreamFilterState The combined state.
      * @throws UnmergeableFilterStateException If the provided state cannot be merged with this state.
      */
-    final public function merge_with(StreamFilterState $other = null): StreamFilterState
+    final public function merge_with(?StreamFilterState $other = null): StreamFilterState
     {
         if (is_null($other)) {
             return $this;