Page MenuHomePhabricator

Give administrators better tools for managing Conduit API changes
Closed, ResolvedPublic

Description

We have upcoming changes to Conduit which will deprecate a number of old methods (see T9964). For example, paste.create is being replaced with paste.edit, and paste.query is being replaced with paste.search.

Currently, administrators have poor tools to understand and manage existing callers. We give them a nagging setup issue about any deprecated call in the last 30 days, but I don't think this is very useful or a good long-term solution (I've ignored it on every install it has ever cropped up on).

The importance of moving away from calls also depends heavily on an install's upgrade schedule, which may be different than the upstream's release schedule. This limits our ability to ever provide meaningful automatic advice, and tends to mean any automatic warnings we issue are going to be kind of flaky/useless. I'd rather see things work like this:

  • When we say "x.y is changing" in the Changelog, link to a document helping administrators manage these changes.
  • Primarily, this document should walk them through using the Call Log console to find relevant offenders and notify or correct them.
  • The Call Log console should be useful for doing this, and useful to point users at so they can fix their own stuff (e.g., admins should just be able to shoot a mail to the 5 users calling old.bad.deprecated and say "go here to see the calls you've made to this").
  • Get rid of the annoying setup issue.

Technically, I plan to make these changes:

  • Make the call log data more useful.
  • Make the call log modern and filterable (with ApplicationSearch).
  • Make the admin and user experiences more reasonable.
  • Write a document explaining how to use it to help manage API changes.
  • Remove the setup issue.
  • Point to the management document in the future when announcing API changes.

Event Timeline

epriestley claimed this task.
epriestley raised the priority of this task from to Normal.
epriestley updated the task description. (Show Details)
epriestley changed the edit policy from "All Users" to "Community (Project)".
epriestley added a project: Conduit.
epriestley added subscribers: epriestley, nickz.

This feels like we're in much better shape, now. We can refine it if more stuff comes up once the new endpoints start to land.