Driving side unnamed on withPoint functions

[cvvergara]

Fixes #2919

Changes proposed in this pull request:
For each with Points function

• src & SQL code modification to convert driving side to unnamed positional
  Removal of signatures with named driving_side with default value.
• pgtap tests modification
  • New test for testing "flags/parameters" (currently tests only the unnamed positional driving side
• Documentation queries adjusted to the change
• Documentation updated

Other changes

• More work on reorganizing the release notes.
• With Points functions that were in proposed section now are moved to official section

Removed signatures

• pgr_trspvia_withpoints(text,text,text,anyarray,boolean,boolean,boolean,character,boolean)
• pgr_trsp_withpoints(text,text,text,anyarray,anyarray,boolean,character,boolean)
• pgr_trsp_withpoints(text,text,text,anyarray,bigint,boolean,character,boolean)
• pgr_trsp_withpoints(text,text,text,bigint,anyarray,boolean,character,boolean)
• pgr_trsp_withpoints(text,text,text,bigint,bigint,boolean,character,boolean)
• pgr_trsp_withpoints(text,text,text,text,boolean,character,boolean)
• pgr_withpointscostmatrix(text,text,anyarray,boolean,character)
• pgr_withpointscost(text,text,anyarray,anyarray,boolean,character)
• pgr_withpointscost(text,text,anyarray,bigint,boolean,character)
• pgr_withpointscost(text,text,bigint,anyarray,boolean,character)
• pgr_withpointscost(text,text,bigint,bigint,boolean,character)
• pgr_withpointscost(text,text,text,boolean,character)
• pgr_withpoints(text,text,anyarray,anyarray,boolean,character,boolean)
• pgr_withpoints(text,text,anyarray,bigint,boolean,character,boolean)
• pgr_withpoints(text,text,bigint,anyarray,boolean,character,boolean)
• pgr_withpoints(text,text,bigint,bigint,boolean,character,boolean)
• pgr_withpoints(text,text,text,boolean,character,boolean)
• pgr_withpointsvia(text,text,anyarray,boolean,boolean,boolean,character,boolean)

Removed internal functions

• _pgr_trspvia_withpoints(text,text,text,anyarray,boolean,boolean,boolean,character,boolean)
• _pgr_trsp_withpoints(text,text,text,anyarray,anyarray,boolean,character,boolean)
• _pgr_trsp_withpoints(text,text,text,text,boolean,character,boolean)
• _pgr_withpointsvia(text,text,anyarray,boolean,boolean,boolean,character,boolean)

@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

@cvvergara I'll gather the PR information and provide both the summary and review you requested.

---

🏁 Script executed:

#!/bin/bash
# Get PR information including title, description, and changed files
echo "=== PR Information ==="
gh pr view 2922 --json title,body,author,createdAt,headRefName,baseRefName

echo -e "\n=== Changed Files ==="
gh pr view 2922 --json files --jq '.files[].path'

echo -e "\n=== PR Diff ==="
gh pr diff 2922

Length of output: 265018

---

Summary

This PR implements major breaking changes for pgRouting 4.0.0, focusing on the withPoints function family. The primary change converts the driving_side parameter from a named optional parameter to a positional unnamed compulsory parameter across all withPoints functions.

Key Changes:

Function Promotions to Official Status

• pgr_trsp and pgr_trspVia functions
• pgr_trsp_withPoints and pgr_trspVia_withPoints
• All pgr_withPoints* family functions (withPoints, withPointsCost, withPointsCostMatrix, withPointsDD, withPointsKSP, withPointsVia)

Breaking Changes

• Driving side parameter now compulsory and positional for all withPoints functions
  • Directed graphs: 'r'/'R' (right) or 'l'/'L' (left)
  • Undirected graphs: 'b'/'B' (both)
• Removed 50+ deprecated function signatures including many internal functions
• Output standardization to consistent column formats

Documentation & Testing Updates

• Comprehensive updates to all documentation files
• Updated all pgtap tests to use new signatures
• Revised query examples throughout docqueries
• Updated release notes in NEWS.md

Review

✅ Strengths:

• Comprehensive scope: All related components (docs, tests, examples) updated consistently
• Clear breaking change documentation: Well-documented in NEWS.md with complete lists of removed signatures
• Systematic approach: Consistent pattern applied across all withPoints functions
• Backward compatibility consideration: Clear migration path documented

⚠️ Considerations:

• Major breaking change: This will require significant updates for existing users
• Large PR scope: While comprehensive, the size makes detailed review challenging
• Parameter validation: Ensure proper validation of driving_side values in implementation

🔍 Technical Review:

• Documentation updates are thorough and consistent
• Test updates properly cover the new signatures
• Query examples demonstrate correct usage patterns
• Function signature changes follow logical consistency

Recommendation: ✅ Approve - This is a well-executed major version release that properly handles breaking changes with comprehensive documentation and testing updates. The scope is appropriate for a 4.0.0 release.

🐰 (◕‿◕)♡ Impressive work on coordinating such a comprehensive release!