Fixes 2927 standardize sequential vertex coloring

[cvvergara]

Fixes #2927 .

Changes proposed in this pull request:

• Updating NEWS about pgr_sequentialVertexColoring
• pgr_sequentialVertexColoring: updating documentation
• Standardizing output columns pgr_sequentialVertexColoring to (node,color)

@pgRouting/admins

[coderabbitai]

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

✨ Finishing Touches

🧪 Generate Unit Tests

• Create PR with Unit Tests
• Post Copyable Unit Tests in Comment

---

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

• 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.
  • Explain this complex logic.
  • 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 explain this code block.
  • @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 explain its main purpose.
  • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 auto-generate unit tests to generate unit tests for 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.

[cvvergara]

@coderabbitai summary
@coderabbitai review

[coderabbitai]

Tip

For best results, initiate chat on the files or code changes.

🧩 Analysis chain

🏁 Script executed:

#!/bin/bash
# Get PR information including title, description, and changed files
gh pr view 2929 --json title,body,files,additions,deletions,changedFiles

# Get the diff to understand what changed
gh pr diff 2929

Length of output: 14110

---

@cvvergara Here's the summary and review for PR #2929:

Summary

Title: Fixes 2927 standardize sequential vertex coloring

Purpose: This PR standardizes the output columns of pgr_sequentialVertexColoring function to maintain consistency with other pgRouting functions.

Key Changes:

• Breaking Change: Output columns changed from (vertex_id, color_id) to (node, color)
• Function Simplification: Converted from PL/pgSQL to SQL implementation
• Comprehensive Updates: Updated 12 files including documentation, tests, migration guides, and build scripts

Statistics: 70 additions, 74 deletions across 12 files

Review

✅ Strengths

1. Comprehensive Approach: The PR addresses all aspects of the breaking change systematically:

   • Core function implementation
   • Complete test suite updates
   • Documentation and migration guides
   • Build/upgrade scripts

2. Function Simplification: The change from PL/pgSQL to SQL is an improvement:

   -- Simplified from complex PL/pgSQL block to clean SQL
   SELECT vertex_id, color_id
   FROM _pgr_sequentialVertexColoring(_pgr_get_statement($1));

3. Proper Version Management: Correctly updated version checks in tests to v4.0.0 and included proper upgrade handling.

4. Documentation Quality: Well-structured documentation updates with clear migration instructions showing before/after column mappings.

5. Test Coverage: All test files properly updated to use new column names, maintaining test integrity.

🔍 Areas for Consideration

1. Breaking Change Impact: This is a significant breaking change that will require users to update their queries. The migration documentation is good, but consider if additional communication is needed.

2. Backward Compatibility: The upgrade script properly handles the function dropping, which is necessary for the signature change.

📋 Summary of Changes by File Type

• Core Function: sql/coloring/sequentialVertexColoring.sql - Signature change and simplification
• Documentation: 4 files updated with new column references and migration guides
• Tests: 3 test files updated for new column names and version checks
• Build: Upgrade script updated to handle the breaking change
• News: Proper changelog entries added

✅ Overall Assessment

This is a well-executed breaking change that improves consistency across the pgRouting API. The comprehensive approach to updating all related components demonstrates good software engineering practices. The change is necessary for API standardization and is properly documented and handled.

Recommendation: ✅ Approve - This PR successfully addresses the standardization requirements with proper handling of the breaking change.

[sanak]

LGTM!