Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove deprecated internal function _pgr_withPointsVia #2742

Conversation

cvvergara
Copy link
Member

@cvvergara cvvergara commented Feb 6, 2025

Fixes #2741

Changes proposed in this pull request:

  • Removes the deprecated _pgr_withPointsVia signature
  • Documents the removal

@pgRouting/admins

Summary by CodeRabbit

  • New Features

    • Officially promoted key routing and pathfinding functions, providing a more stable and enhanced API.
    • Introduced a new, simplified SQL interface for handling point-based routing.
  • Refactor

    • Removed deprecated and legacy functions to streamline functionality and clarity.
  • Documentation

    • Updated release notes to reflect these interface improvements and removals.

@cvvergara cvvergara added Deprecation Remove rm of deprecated function or internal function labels Feb 6, 2025
@cvvergara cvvergara added this to the Release 4.0.0 milestone Feb 6, 2025
@cvvergara cvvergara requested a review from robe2 February 6, 2025 16:39
Copy link

coderabbitai bot commented Feb 6, 2025

Walkthrough

This PR updates the pgRouting library by promoting several SQL functions and signatures to official status while removing deprecated and legacy functions. Documentation files have been refreshed to reflect these changes, and the SQL function for handling points via routing has been streamlined with a new parameter set. Additionally, updates in the signature file remove the deprecated internal function and introduce an updated version for point routing.

Changes

File(s) Change Summary
NEWS.md, doc/.../release_notes.rst Updated release notes and documentation to list promoted functions (e.g., pgr_trsp, pgr_withPointsVia, etc.) and signatures (e.g., pgr_aStar(Combinations), pgr_dijkstra(Combinations), etc.). Also documents removal of deprecated SQL and internal functions.
sql/.../pgrouting--4.0.sig Modified function signatures by removing the deprecated _pgr_withpointsvia(text,bigint[],double precision,boolean) and adding a new signature pgr_withpointsvia(text,text,anyarray,boolean,boolean,boolean,character,boolean), updating the available routing functions for enhanced flexibility.
sql/withPoints/withPointsVia.sql Completely rewritten the SQL function pgr_withPointsVia with a streamlined interface. The old implementation _pgr_withPointsVia has been removed in favor of a new version accepting refined parameters, reducing internal complexity and simplifying error handling.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant SQL_Function as pgr_withPointsVia
    participant DBEngine as Database Engine

    User->>SQL_Function: Execute pgr_withPointsVia(TEXT, TEXT, ANYARRAY, ... )
    SQL_Function->>DBEngine: Process routing query with provided parameters
    DBEngine-->>SQL_Function: Return route records
    SQL_Function-->>User: Respond with result set
Loading

Assessment against linked issues

Objective Addressed Explanation
Deprecated internal SQL function _pgr_withPointsVia (#2741)

Possibly related PRs

Suggested labels

Code Cleanup, Documentation, Enhancement

Suggested reviewers

  • robe2

Poem

I hopped through lines of code tonight,
Deprecated paths vanish out of sight,
New functions spring with fresh delight,
With routes refined and queries bright,
A rabbit’s cheer for clean code’s flight! 🐰✨

Tip

🌐 Web search-backed reviews and chat
  • We have enabled web search-based reviews and chat for all users. This feature allows CodeRabbit to access the latest documentation and information on the web.
  • You can disable this feature by setting web_search: false in the knowledge_base settings.
  • Please share any feedback in the Discord discussion.

📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 54dc6d8 and 99b4f25.

📒 Files selected for processing (4)
  • NEWS.md (1 hunks)
  • doc/src/release_notes.rst (1 hunks)
  • sql/sigs/pgrouting--4.0.sig (0 hunks)
  • sql/withPoints/withPointsVia.sql (0 hunks)

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

@cvvergara
Copy link
Member Author

@coderabbitai review
@coderabbitai summary

Copy link

coderabbitai bot commented Feb 6, 2025

🧩 Analysis chain

🏁 Script executed:

#!/bin/bash
# Get the PR diff
gh pr diff 2742

# Search for files containing the deprecated function name
rg "_pgr_withPointsVia" -l

# Search for any documentation updates
fd -e rst -e md

Length of output: 13298


🏁 Script executed:

#!/bin/bash
# Search for any references to the deprecated function
rg "_pgr_withPointsVia" -A 2

Length of output: 663


@cvvergara The changes look good! The PR successfully:

  1. Removes the deprecated internal function _pgr_withPointsVia
  2. Updates documentation in NEWS.md and release_notes.rst
  3. Updates function signatures in pgrouting--4.0.sig

The removal is safe as the new implementation is already in place and being used. I recommend merging these changes.

✅ Actions performed

Comments resolved.


Summary regeneration triggered.

@cvvergara cvvergara merged commit c4cd95c into pgRouting:develop Feb 6, 2025
12 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Deprecation Remove rm of deprecated function or internal function
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants