Add fallback getDescription method for MW < 1.41 compat #192

alistair3149 · 2025-04-24T21:56:07Z

Fixes: #191

Summary by CodeRabbit

Bug Fixes
- Improved compatibility with different MediaWiki versions for export-related descriptions, ensuring correct display across versions 1.41 and above as well as earlier versions.

coderabbitai · 2025-04-24T21:58:24Z

📝 Walkthrough

"""

Walkthrough

The changes update the getDescription() methods in both SpecialWikibaseExport and SpecialWikibaseExportConfig classes to provide compatibility with different MediaWiki versions. The methods now conditionally return either a Message object or an escaped string, depending on whether the MediaWiki version is 1.41 or higher. This is achieved by checking the MW_VERSION constant at runtime. The explicit return type declarations in the method signatures have been removed, replaced with docblocks indicating the dual return types.

Changes

Files	Change Summary
src/EntryPoints/SpecialWikibaseExport.php src/EntryPoints/SpecialWikibaseExportConfig.php	Updated `getDescription()` methods to return `string` or `Message` based on MediaWiki version; removed return type declarations; added docblocks; added runtime version checks.
phpstan-baseline.neon	Added suppressions for "If condition is always true." errors in `SpecialWikibaseExport.php` and `SpecialWikibaseExportConfig.php`.

Assessment against linked issues

Objective	Addressed	Explanation
Fix compatibility with MediaWiki 1.39 to prevent errors on Special:SpecialPages (Issue #191)	✅
"""

📜 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 af7fa76 and 1bfab97.

📒 Files selected for processing (3)

phpstan-baseline.neon (1 hunks)
src/EntryPoints/SpecialWikibaseExport.php (1 hunks)
src/EntryPoints/SpecialWikibaseExportConfig.php (2 hunks)

✅ Files skipped from review due to trivial changes (1)

phpstan-baseline.neon

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

src/EntryPoints/SpecialWikibaseExportConfig.php
src/EntryPoints/SpecialWikibaseExport.php

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

GitHub Check: Static Analysis: MW REL1_43, PHP 8.3
GitHub Check: Static Analysis: MW REL1_43, PHP 8.3

✨ Finishing Touches

📝 Generate Docstrings

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

🪧 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.
@coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
@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 (2)

src/EntryPoints/SpecialWikibaseExport.php (1)
41-49: Implementation looks good with a minor suggestion

The changes correctly implement version-specific behavior for MediaWiki 1.41 compatibility. The docblock clearly explains the dual return types.

Consider simplifying the condition by using the null coalesce operator to handle cases where MW_VERSION might not be defined:
-	if ( defined( 'MW_VERSION' ) && version_compare( MW_VERSION, '1.41', '>=' ) ) {
+	if ( defined( 'MW_VERSION' ) && version_compare( MW_VERSION ?? '0.0', '1.41', '>=' ) ) {
🧰 Tools

🪛 GitHub Check: Static Analysis: MW REL1_43, PHP 8.3

[failure] 45-45:
Right side of && is always true.
src/EntryPoints/SpecialWikibaseExportConfig.php (1)
31-39: Implementation is consistent with SpecialWikibaseExport

The changes correctly implement version-specific behavior for MediaWiki 1.41 compatibility, maintaining consistency with the SpecialWikibaseExport class.

Similar to the suggestion for the other file, consider handling cases where MW_VERSION might not be defined:
-	if ( defined( 'MW_VERSION' ) && version_compare( MW_VERSION, '1.41', '>=' ) ) {
+	if ( defined( 'MW_VERSION' ) && version_compare( MW_VERSION ?? '0.0', '1.41', '>=' ) ) {
🧰 Tools

🪛 GitHub Check: Static Analysis: MW REL1_43, PHP 8.3

[failure] 35-35:
Right side of && is always true.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 702d6e4 and 52611a5.

📒 Files selected for processing (2)

src/EntryPoints/SpecialWikibaseExport.php (1 hunks)
src/EntryPoints/SpecialWikibaseExportConfig.php (2 hunks)

🧰 Additional context used

🧬 Code Graph Analysis (2)

src/EntryPoints/SpecialWikibaseExportConfig.php (1)

src/EntryPoints/SpecialWikibaseExport.php (1)

getDescription (44-50)

src/EntryPoints/SpecialWikibaseExport.php (1)

src/EntryPoints/SpecialWikibaseExportConfig.php (1)

getDescription (34-40)

🪛 GitHub Check: Static Analysis: MW REL1_43, PHP 8.3

src/EntryPoints/SpecialWikibaseExportConfig.php

[failure] 35-35:
Right side of && is always true.

src/EntryPoints/SpecialWikibaseExport.php

[failure] 45-45:
Right side of && is always true.

🔇 Additional comments (1)

src/EntryPoints/SpecialWikibaseExportConfig.php (1)

7-7: Correct import of the Message class

Appropriate addition of the Message class import to support the new return type.

Fixes: #191

JeroenDeDauw · 2025-04-25T13:25:52Z

Released

coderabbitai bot reviewed Apr 24, 2025

View reviewed changes

alistair3149 force-pushed the fix-191 branch from 52611a5 to af7fa76 Compare April 24, 2025 21:59

Add fallback getDescription method for MW < 1.41 compat

1bfab97

Fixes: #191

alistair3149 force-pushed the fix-191 branch from af7fa76 to 1bfab97 Compare April 24, 2025 22:02

alistair3149 requested a review from JeroenDeDauw April 24, 2025 22:06

JeroenDeDauw merged commit 542c1b8 into master Apr 25, 2025
17 checks passed

JeroenDeDauw deleted the fix-191 branch April 25, 2025 13:22

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Add fallback getDescription method for MW < 1.41 compat #192

Add fallback getDescription method for MW < 1.41 compat #192

Uh oh!

alistair3149 commented Apr 24, 2025 •

edited by coderabbitai bot

Loading

Uh oh!

coderabbitai bot commented Apr 24, 2025 •

edited

Loading

Walkthrough

Changes

Assessment against linked issues

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

Uh oh!

coderabbitai bot left a comment

Uh oh!

Uh oh!

JeroenDeDauw commented Apr 25, 2025

Uh oh!

Uh oh!

Add fallback getDescription method for MW < 1.41 compat #192

Add fallback getDescription method for MW < 1.41 compat #192

Uh oh!

Conversation

alistair3149 commented Apr 24, 2025 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary by CodeRabbit

Uh oh!

coderabbitai bot commented Apr 24, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Assessment against linked issues

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

JeroenDeDauw commented Apr 25, 2025

Uh oh!

Uh oh!

alistair3149 commented Apr 24, 2025 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Apr 24, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)