Skip to content

[Admin] Deprecate unused sylius_admin_customer_orders_statistics route#17667

Merged
NoResponseMate merged 1 commit intoSylius:2.1from
GSadee:deprecate-customer-order-statistics-route
Feb 11, 2025
Merged

[Admin] Deprecate unused sylius_admin_customer_orders_statistics route#17667
NoResponseMate merged 1 commit intoSylius:2.1from
GSadee:deprecate-customer-order-statistics-route

Conversation

@GSadee
Copy link
Copy Markdown
Member

@GSadee GSadee commented Feb 11, 2025 •
edited
Loading

Q A
Branch? 2.1
Bug fix? no
New feature? no
BC breaks? no
Deprecations? yes
Related tickets fixes #17640
License MIT

Summary by CodeRabbit

  • Documentation

    • Updated the upgrade guide to inform users about changes in administrative customer order statistics.

  • Chores

    • Deprecated an older administrative route for customer order statistics, with removal planned for a future release.

@GSadee GSadee added the Admin AdminBundle related issues and PRs. label Feb 11, 2025
@GSadee GSadee requested review from a team as code owners February 11, 2025 11:22
@probot-autolabeler probot-autolabeler bot added the Maintenance CI configurations, READMEs, releases, etc. label Feb 11, 2025
@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Feb 11, 2025 •
edited
Loading

Walkthrough

The pull request deprecates the sylius_admin_customer_orders_statistics route. An upgrade note is added in the UPGRADE-2.1.md file, and the same deprecation is documented in the routing configuration file. The deprecation indicates that the route is no longer recommended for use since version 2.0 and is scheduled for removal in version 3.0, while the functionality of other routes remains unchanged.

Changes

Files Change Summary
UPGRADE-2.1.md, src/.../routing/customer.yml Marked the sylius_admin_customer_orders_statistics route as deprecated, noting its transition from version 2.0 with planned removal in 3.0.

Assessment against linked issues

Objective Addressed Explanation
Deprecate or remove sylius_admin_customer_orders_statistics route [#17640] ✅

Poem

I’m a rabbit with a hopping beat,
Skipping old routes off my feet.
Deprecated paths now fade away,
Welcoming fresh code in bright array.
Hoppy changes light up my day!
🐰✨

📜 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 8f0b742 and 4c7fb44.

📒 Files selected for processing (2)
  • UPGRADE-2.1.md (1 hunks)
  • src/Sylius/Bundle/AdminBundle/Resources/config/routing/customer.yml (1 hunks)
✅ Files skipped from review due to trivial changes (1)
  • UPGRADE-2.1.md
⏰ Context from checks skipped due to timeout of 90000ms (2)
  • GitHub Check: Static checks / PHP 8.3, Symfony ^7.1
  • GitHub Check: Static checks / PHP 8.2, Symfony ^6.4
🔇 Additional comments (1)
src/Sylius/Bundle/AdminBundle/Resources/config/routing/customer.yml (1)

25-34: LGTM! The deprecation notice is clear and follows standard format.

The deprecation notice clearly indicates when the route will be removed.

Let's verify the route usage and potential impact:

Could you also clarify if there's an alternative route that should be used instead? This would help users migrate away from the deprecated route.

✅ Verification successful

🏁 Script executed:

#!/bin/bash
# Description: Check for route usage in templates and controllers

# Search for route references in twig templates
echo "Checking twig templates for route usage..."
rg "sylius_admin_customer_orders_statistics" -g "*.twig"

# Search for route references in PHP files
echo "Checking PHP files for route usage..."
rg "sylius_admin_customer_orders_statistics" -g "*.php"

# Search for route references in JavaScript files
echo "Checking JavaScript files for route usage..."
rg "sylius_admin_customer_orders_statistics" -g "*.js"

Length of output: 446

Deprecation Notice and Route Usage Verified

The deprecation notice is clear, and our search across Twig, PHP, and JavaScript files showed no references to sylius_admin_customer_orders_statistics. Please clarify if an alternative route needs to be provided for migration or if this deprecation is solely for removal in Sylius 3.0.

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
🪧 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.

@github-actions
Copy link
Copy Markdown

github-actions bot commented Feb 11, 2025 •
edited
Loading

❌ Preview Environment deleted from Bunnyshell

Available commands:

  • 🚀 /bns:deploy to redeploy the environment

@NoResponseMate NoResponseMate merged commit d4b9b15 into Sylius:2.1 Feb 11, 2025
23 of 26 checks passed
@GSadee GSadee deleted the deprecate-customer-order-statistics-route branch February 11, 2025 14:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@NoResponseMate NoResponseMate NoResponseMate approved these changes

Assignees

No one assigned

Labels

Admin AdminBundle related issues and PRs. Maintenance CI configurations, READMEs, releases, etc.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

[2.0][Admin] Route sylius_admin_customer_orders_statistics still exists, but no longer in use

2 participants

@GSadee @NoResponseMate