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 old debug UI #6478

Draft
wants to merge 3 commits into
base: dev-2.x
Choose a base branch
from

Conversation

VillePihlava
Copy link
Contributor

@VillePihlava VillePihlava commented Feb 21, 2025

Summary

This PR removes the old debug UI (application/src/client/classic-debug). I also removed and changed some related documentation.

Issue

N/A

Unit tests

N/A

Documentation

I changed doc/user/Troubleshooting-Routing.md and doc/user/Frontends.md to indicate of this change. I did a quick search for more references of the old debug UI but could not find any. However, there might still be some references left in the documentation.

@VillePihlava VillePihlava requested a review from a team as a code owner February 21, 2025 10:10
Copy link

codecov bot commented Feb 21, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 70.10%. Comparing base (a7c5aec) to head (da4d1ef).
Report is 46 commits behind head on dev-2.x.

Additional details and impacted files
@@            Coverage Diff             @@
##             dev-2.x    #6478   +/-   ##
==========================================
  Coverage      70.10%   70.10%           
+ Complexity     18269    18267    -2     
==========================================
  Files           2077     2077           
  Lines          77659    77659           
  Branches        7828     7828           
==========================================
  Hits           54439    54439           
- Misses         20439    20440    +1     
+ Partials        2781     2780    -1     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@leonardehrenfried
Copy link
Member

You're also deleting the new debug UI and GraphiQL. Both of those we want to keep. :)

Deleting classic-debug is enough.

@VillePihlava
Copy link
Contributor Author

You're also deleting the new debug UI and GraphiQL. Both of those we want to keep. :)

Deleting classic-debug is enough.

My mistake, thanks for pointing this out :D

@optionsome optionsome requested a review from t2gran February 25, 2025 09:37
@optionsome optionsome marked this pull request as draft February 27, 2025 09:37
@optionsome
Copy link
Member

optionsome commented Feb 27, 2025

I converted this to draft since I was informed there still exist some debug layer related instructions for some OSM editors in Finland that haven't been yet updated to be about the new debug UI. Hopefully soon we can get rid of this.

@VillePihlava VillePihlava added the OTP Debug UI The OTP bundled client label Feb 27, 2025
@t2gran t2gran added this to the 2.8 (next release) milestone Mar 12, 2025

On the other hand, **production frontends** are intended to be a component of larger public-facing deployments of OTP, with a more polished appearance and user experience. They generally do not work "out of the box", and require a significant amount of configuration and coordination with external components such as map tile servers and geocoders. They are designed to be components of a large professionally maintained and managed OTP deployment, and present a simpler view of OpenTripPlanner options and results to a non-technical audience of end users.

## Debug Frontends

The main OpenTripPlanner repository currently contains two debug web frontends:
The main OpenTripPlanner repository currently contains one debug web frontend:
Copy link
Member

@t2gran t2gran Mar 21, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
The main OpenTripPlanner repository currently contains one debug web frontend:

I merged this into the next suggestion, see below

Comment on lines +21 to +22
- the new frontend that is still being improved can be found at [`/client`](https://github.com/opentripplanner/OpenTripPlanner/tree/dev-2.x/client)
- the classic one previously located at `/application/src/client/classic-debug/` has been removed
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- the new frontend that is still being improved can be found at [`/client`](https://github.com/opentripplanner/OpenTripPlanner/tree/dev-2.x/client)
- the classic one previously located at `/application/src/client/classic-debug/` has been removed
OpenTripPlanner comes with one integrated debug web frontend. The frontend source code can be found at
[`/client`](https://github.com/opentripplanner/OpenTripPlanner/tree/dev-2.x/client).

We should aim for writing doc that is correct in 2 yers time. We do not need to include more than one paragraph about the old UI - that it is removed. That is done on line 13. In the rest of this doc we should fokus on the new UI. There is no need to say "is still being improved", since we are constantly improving everything.

Comment on lines +27 to +29
The **classic debug client** was a jQuery and Backbone based UI whose history could be traced back over a decade to the first days of the OTP project.
It connected to the OTP Java backend via a REST API using the GTFS vocabulary. Historically this was the default OTP interface available at the root URL.
It has been permanently removed.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
The **classic debug client** was a jQuery and Backbone based UI whose history could be traced back over a decade to the first days of the OTP project.
It connected to the OTP Java backend via a REST API using the GTFS vocabulary. Historically this was the default OTP interface available at the root URL.
It has been permanently removed.

@VillePihlava VillePihlava mentioned this pull request Mar 27, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
OTP Debug UI The OTP bundled client
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants