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 SQL deprecated _pgr_drivingdistance #2735

Merged
merged 4 commits into from
Jan 27, 2025

Conversation

cvvergara
Copy link
Member

Changes proposed in this pull request:

  • delete from SQL _pgr_drivingdistance
  • add notice to C code
  • adjust pgtap tests

@pgRouting/admins

Copy link

coderabbitai bot commented Jan 27, 2025

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.


🪧 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

cvvergara commented Jan 27, 2025

@coderabbitai review
@coderabbitai summary

Copy link

coderabbitai bot commented Jan 27, 2025

@cvvergara I've reviewed the changes and they look good. The PR successfully:

  1. Removes the deprecated SQL function _pgr_drivingdistance
  2. Adds appropriate deprecation notice in C code with clear messaging
  3. Updates tests with proper version checks
  4. Documents the changes in NEWS.md

The implementation is thorough and maintains backward compatibility through version checks. I recommend these changes for approval.

🔗 Analysis chain

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Get PR details
gh pr view 2735 --json files,commits,body

# Look for files related to drivingdistance
rg -l "drivingdistance" --type sql --type c

# Look for test files
rg -l "drivingdistance" --type-add 'test:*.test' --type test

Length of output: 2585


Script:

#!/bin/bash
# Get the C code changes
git diff HEAD^..HEAD src/driving_distance/driving_distance.c

# Get the test changes
git diff HEAD^..HEAD pgtap/dijkstra/driving_distance/types_check.pg
git diff HEAD^..HEAD pgtap/dijkstra/driving_distance/inner_query.pg

# Get documentation changes
git diff HEAD^..HEAD NEWS.md

Length of output: 2282


Script:

#!/bin/bash
# Check the removed SQL file
cat sql/driving_distance/_drivingDistance.sql || echo "File has been removed"

# Get specific C code changes for the deprecation notice
git show d853b7262555285ccec4cde1ff2672809071d016

# Look at test adjustments
git show d35d35e3c3a1aa27fd9b44cea690f50db9d86b31

Length of output: 10988


✏️ Learnings added
Learnt from: cvvergara
URL: https://github.com/pgRouting/pgrouting/pull/2735

Timestamp: 2025-01-27T01:49:25.016Z
Learning: In pgRouting, when deprecating internal functions:
1. Add deprecation notice in C code using ereport with ERRCODE_FEATURE_NOT_SUPPORTED
2. Update tests with version checks (min_version, min_lib_version)
3. Document changes in NEWS.md under appropriate sections

Learnt from: cvvergara
URL: https://github.com/pgRouting/pgrouting/pull/2735

Timestamp: 2025-01-27T01:49:25.016Z
Learning: pgRouting version checks in tests:
- Use min_version() for SQL API changes
- Use min_lib_version() for C/C++ library changes
- Adjust test plans based on version conditions

Note: Learnings are effective only in the context of similar code segments. To apply general coding guidelines, please configure review instructions. You can manage existing learnings in the app.

✅ Actions performed

Comments resolved.

@cvvergara cvvergara merged commit 41e90fe into pgRouting:develop Jan 27, 2025
26 checks passed
@cvvergara cvvergara deleted the deprecate-_pgr_drivingdistance branch January 27, 2025 02:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant