RecursiveTextProcessor: Fix "Automatic conversion of false to array is deprecated"

[paladox]

Fixes #6007

Summary by CodeRabbit

• Bug Fixes
  • Enhanced the precision of conditions in the text processing method to ensure correct handling of specific entries.

[coderabbitai]

Walkthrough

The pull request modifies the releaseAnnotationBlock method in the RecursiveTextProcessor class. The condition that checks the $track variable before unsetting an entry has been changed from if ( $track !== [] ) to if ( isset( $track[$this->uniqid] ) ). This alteration ensures that the unset operation is only performed if the specific entry associated with $this->uniqid exists in the $track array, addressing a deprecation warning related to automatic conversion of false to an array in PHP 8.1.

Changes

File	Change Summary
src/Parser/RecursiveTextProcessor.php	Modified releaseAnnotationBlock method to change condition for unsetting an entry in $track variable

Assessment against linked issues

Objective	Addressed	Explanation
Resolve deprecation warning for false to array conversion [#6007]	✅

Possibly related PRs

• SMW_Infolink: Fix "explode(): Passing null to parameter #2 ($string) of type string is deprecated" #5928: Similar type safety enhancement for string parameter.
• FeedExportPrinter: Fix "Optional parameter $title declared before required parameter $text" #5973: Enforcing method parameter type requirements.
• CJKSimpleCharacterRegExTokenizer: Fix "preg_split(): Passing null to parameter #3 ($limit) of type int is deprecated" #5998: Ensuring valid integer type for function parameter.

Suggested reviewers

• JeroenDeDauw
• jaideraf
• gesinn-it-gea
• gesinn-it-ilm

Poem

🐰 In the realm of code, a rabbit's delight,
Type safety springs with algorithmic might!
False to array, no more a wild ride,
Explicit checks now safely reside.
Hop, hop, hurray for cleaner design! 🌟

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 771c537 and 430df68.

📒 Files selected for processing (1)

• src/Parser/RecursiveTextProcessor.php (1 hunks)

🚧 Files skipped from review as they are similar to previous changes (1)

• src/Parser/RecursiveTextProcessor.php

⏰ Context from checks skipped due to timeout of 90000ms (6)

• GitHub Check: build (1.43, 8.2, mysql, mariadb:11.2, false, true)
• GitHub Check: build (1.42, 8.2, mysql, mariadb:11.2, false, true)
• GitHub Check: build (1.41, 8.1, mysql, mariadb:11.2, true, true)
• GitHub Check: build (1.40, 8.1, mysql, mariadb:11.2, false, false)
• GitHub Check: build (1.39, 8.1, mysql, mysql:8, false, false)
• GitHub Check: build (1.39, 8.1, mysql, mariadb:11.2, false, false)

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (1)

src/Parser/RecursiveTextProcessor.php (1)

Line range hint 141-162: Consider adding type hints for better type safety.

Since this code deals with type-sensitive operations, consider adding return type hints to getExtensionData calls and type hints for the $track variable. This would make the type safety requirements more explicit and help catch potential issues at development time.

Example improvement:

- $track = $parserOutput->getExtensionData( ParserData::ANNOTATION_BLOCK );
+ /** @var array|false $track */
+ $track = $parserOutput->getExtensionData( ParserData::ANNOTATION_BLOCK );

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between b7b86d5 and 771c537.

📒 Files selected for processing (1)

• src/Parser/RecursiveTextProcessor.php (1 hunks)

⏰ Context from checks skipped due to timeout of 90000ms (6)

• GitHub Check: build (1.43, 8.2, mysql, mariadb:11.2, false, true)
• GitHub Check: build (1.42, 8.2, mysql, mariadb:11.2, false, true)
• GitHub Check: build (1.41, 8.1, mysql, mariadb:11.2, true, true)
• GitHub Check: build (1.40, 8.1, mysql, mariadb:11.2, false, false)
• GitHub Check: build (1.39, 8.1, mysql, mysql:8, false, false)
• GitHub Check: build (1.39, 8.1, mysql, mariadb:11.2, false, false)

🔇 Additional comments (1)

src/Parser/RecursiveTextProcessor.php (1)

150-152: LGTM! Good fix for the PHP 8.1 deprecation warning.

The added is_array check properly handles the case when getExtensionData returns false, preventing the deprecation warning about automatic conversion of false to array.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 56.90%. Comparing base (b7b86d5) to head (430df68).
Report is 4 commits behind head on master.

Additional details and impacted files

@@            Coverage Diff            @@
##             master    #6009   +/-   ##
=========================================
  Coverage     56.90%   56.90%           
  Complexity    18953    18953           
=========================================
  Files           942      942           
  Lines         66914    66914           
=========================================
  Hits          38079    38079           
  Misses        28835    28835           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[jaideraf]

Thanks @paladox for addressing this! It is fine to me, but I will let an experienced developer to respond to your question or merge it as is.