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

Removed /xmlrpc endpoint #198

Merged
merged 1 commit into from
Jun 25, 2024
Merged

Removed /xmlrpc endpoint #198

merged 1 commit into from
Jun 25, 2024

Conversation

bmispelon
Copy link
Member

This endpoint doesn't seem to be used in practice (3 hits in the access logs in the past ~2 months). It also introduces a maintenance burden, and the instructions it gives don't actually work.

This endpoint doesn't seem to be used in practice (3 hits in the access
logs in the past ~2 months). It also introduces a maintenance burden,
and the instructions it gives don't actually work.
@claudep
Copy link
Member

claudep commented Jun 9, 2024

I would be OK for this change. However, it would be great to know what motivated its introduction in the first place to ensure the use case is now obsolete. Did you find anything in its history?

@bmispelon
Copy link
Member Author

I would be OK for this change. However, it would be great to know what motivated its introduction in the first place to ensure the use case is now obsolete. Did you find anything in its history?

As far as I can tell, the xmlrpc plugin has been installed since initial release of the site. I did find a page on the wiki (last edited 11 years ago) that mentions it: https://code.djangoproject.com/wiki/OpenData#trac-s-rpc-interface
So it seems it may have been installed as a way to give the community access to the trac data (I contacted Jacob a few months back to get some details but haven't heard back).

I think having a regular database dump would be a better way. It's something I've had in the back of my TODO list for a few months, but it's not as straightforward as I'd hoped (mostly because some of the data needs to be anonymized/sanitized before we can make it public).

Copy link
Member

@claudep claudep left a comment

Choose a reason for hiding this comment

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

Thanks, then I think it is the good move, and we can always revert if we realize at some point that the functionality is essential to some service.

@bmispelon bmispelon merged commit 93bbd0b into django:main Jun 25, 2024
5 checks passed
@laymonage
Copy link

Hey y'all. Looks like the same XmlRpcPlugin is also responsible for the JSON RPC (/jsonrpc endpoint). The endpoint seems useful for extracting data to gain insights, e.g.

Shall we revert this?

If a regular DB dump is preferred, I'm happy too. As long as there's a way to get a recent-ish snapshot... 😄

@glasnt
Copy link
Member

glasnt commented Oct 7, 2024

If memory serves, I originally got this code from Rixx's gist. It's entirely possible we were the only two consumers of this endpoint.

If there is an alternative interface, I'd be happy to migrate.

@bmispelon bmispelon deleted the bye-bye-xmlrpc branch October 8, 2024 10:01
@bmispelon
Copy link
Member Author

Instead of restoring the old API, I'd like to propose creating our own: django/djangoproject.com#1656 (draft PR)

This would allow retrieving multiple (all?) tickets at once and would let us control the output better (the previous API was leaking some potential minimally sensitive data).

What do you think?

@pauloxnet
Copy link
Member

Since this PR is merged, can we create a new issue to track the problem and the new implementation or the revert? Otherwise it is very difficult to find.

@laymonage
Copy link

laymonage commented Oct 8, 2024

@pauloxnet good point! I've created an issue: django/djangoproject.com#1657

@bmispelon If it's not too much work, I think creating our own API would be great! I'll have a look at the PR this weekend. Thank you 🤗

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants