Skip to content

bitbucketserver: Document rate limit change and rationale

Warren Gifford requested to merge sg/rv-tsenert into master

Created by: slimsag

This PR documents the change made in #9038.

@tsenart in this commit you increased the Bitbucket Server rate limit, which is OK, but:

  1. There isn't a CHANGELOG entry. Telling folks we plan to make up to 4x the number of requests to their Bitbucket instance (and why we think this isn't an issue) is important, especially because many customers are aware of us in the past having issues with taking down / causing harm to code hosts due to excessive API requests.
  2. Even if we don't believe this will cause issues (which seems reasonable to me), we should have some documented form of recourse. This can be as simple as "If you encounter issues, please downgrade and contact support." in the CHANGELOG entry.
  3. You removed the comment explaining how we chose these limits. Anyone reading this code will feel it is arbitrary, and anyone looking at the history will think we went from something logical ("same as bitbucket cloud") to something arbitrary (explanation removed).
  4. You removed the // 120/min or 7200/hr comment, which is helpful when linking customers/users to this code as an explanation of the max we will do.

Note: I know I could've just fixed these for you more easily, my hope is this clarifies why I think this is important to communicate to our consumers.

Merge request reports