-
Notifications
You must be signed in to change notification settings - Fork 1.1k
Remove deprecated relaxTransitSearchGeneralizedCostAtDestination
#6540
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 relaxTransitSearchGeneralizedCostAtDestination
#6540
Conversation
…tion This feature was an experiment and should not have been used in production. It was deprecated in 2023-12-20. We take away the parameter from the API now, and then if noone complains, then we will remove the feature implementation including Raptor code in a few weeks time.
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## dev-2.x #6540 +/- ##
=============================================
- Coverage 70.24% 70.24% -0.01%
- Complexity 18369 18370 +1
=============================================
Files 2087 2087
Lines 77381 77372 -9
Branches 7839 7839
=============================================
- Hits 54357 54348 -9
Misses 20249 20249
Partials 2775 2775 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
You know the consequences, so you have my approval.
What will happen if people continue to send this field on the API? Don't we have a policy that we shouldn't break compatibility at the API level? |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We aren't using this parameter at skånetrafiken, so it shouldn't cause any issues for us really.
But as @miklcct points out this does go against our decision records.
If we want to be able to do backwards incompatible changes I think we should have an explicit deprecation policy so that our users knows what they can expect. For example we could say that we keep deprecated fields for at least 4 releases, or we could have a specific policy for experimental fields. Currently we are implying that we will never break compatability.
What do you think about that @t2gran ?
In general I agree that we should not break backwards compatibility:
We should probably discuss how we want to cleanup on the API:
For the policy in our decision records I think we should clarify that some feature might be unstable during development. These features/parameters should be clearly documented. |
We should discuss the specifics but I agree with the idea that we can correct mistakes and carefully remove parts of the API that have been deprecated and had a replacement for many years. |
Summary
This PR removes the
relaxTransitSearchGeneralizedCostAtDestination
input field in the trip plan request in the Transmodel API.This feature was an experiment and should not have been used in production. It was deprecated in 2023-12-20. We take away the parameter from the API now, and then if noone complains, then we will remove the feature implementation
including Raptor code in a few weeks time.
I have not removed the implementation or the configuration for this - we are waiting to see if this will cause any problems. But, I will remove all code for this feature before I continue with the via Raptor improvements. There is a bit of work and risk when removing this, so we prefer to do it in 2 steps.
Issue
🟥 There is not issue for this.
Unit tests
✅ The API schema test is updated.
Documentation
✅ Doc on the feature is removed
Changelog
🟥 This feature was hopefully only used at Entur - it never worked in a good way. We do not need this in the change log.
Bumping the serialization version id
🟥 Not needed