Cap the project releases Atom feed and JSON list

Leaminn Marequested to merge
cap-project-releases-index into master

What does this MR do and why?

Context

The project releases Atom feed (/-/releases.atom) and JSON list (/-/releases.json) load every release of the project, with evidences, milestones and links that neither format reads. Their cost grows with the number of releases, and the Atom feed also looks up a commit and renders Markdown for each one. The figures and the agreed approach are in https://gitlab.com/gitlab-org/gitlab/-/work_items/638260#note_4198617884.

This MR

  • The Atom feed lists only the newest 100 releases and preloads only each release's author and project.
  • The JSON list returns only the newest 1,000 releases, with no preloads. Its UI callers, the Release filters on the merge request and work item lists, use only each release's tag.
  • Both keep the newest-first order, and each cap has its own feature flag, so one can be rolled back without the other. The Releases API still lists every release, and the docs now say so under "Track releases with an RSS feed".
  • The Changelog entry comes with each flag-removal MR.

This keeps the cost of both requests bounded however many releases a project has.

Feature Flag: project_releases_atom_limit

Feature Flag: project_releases_json_limit

References

Database queries

See MR comments.

How to set up and validate locally

  1. In a Rails console, give a project more releases than the caps, using smaller caps so it stays quick: 
    project = Project.find_by_full_path('<your-project>')
user = project.first_owner
5.times { |i| Release.create!(project: project, author: user, tag: "v0.0.#{i}", name: "v0.0.#{i}", sha: project.commit.id, released_at: i.days.ago) }
  2. Open http://gdk.test:3000/<your-project>/-/releases.atom and http://gdk.test:3000/<your-project>/-/releases.json. Both list every release, newest first.
  3. In app/controllers/projects/releases_controller.rb, set ATOM_RELEASES_LIMIT = 2 and JSON_RELEASES_LIMIT = 3. In a Rails console, run Feature.enable(:project_releases_atom_limit) and Feature.enable(:project_releases_json_limit), and wait a minute.
  4. Reload both URLs. The feed lists the newest 2 releases and the JSON list the newest 3, and log/development.log shows ORDER BY "releases"."released_at" DESC LIMIT 2 for the feed and LIMIT 3 for the JSON list, and no release_links queries for either.

MR acceptance checklist

Evaluate this MR against the MR acceptance checklist. It helps you analyze changes to reduce risks in quality, performance, reliability, security, and maintainability.

Edited by Leaminn Ma

Merge request reports