mirror of
https://github.com/discourse/discourse.git
synced 2026-08-04 10:39:43 +08:00
36a8a51ef0GitHub oneboxes and the discourse-github plugin talked to GitHub's REST
and
GraphQL API with no rate-limit awareness. On busy instances this
exhausted
GitHub's limits (60 requests/hour unauthenticated, 5000 authenticated),
and
because there was no backoff every render kept hitting GitHub and
re-failing
-- which GitHub's docs warn can get an integration banned. The recently
added PR-status onebox multiplied the number of calls and made it far
worse.
GitHub access was also fragmented: the core onebox engines used OpenURI,
the
discourse-github plugin used Octokit, and the discourse-ai bot tools
used
FinalDestination::HTTP -- three HTTP stacks, three tokens, and
inconsistent
(or entirely missing) error and rate-limit handling.
This introduces a single client, Discourse::GithubApi, that every GitHub
data-API request now flows through. It is built on Faraday with the
SSRF-safe
FinalDestination adapter and:
- authenticates per token (Bearer) and returns plain string-keyed Hashes
(get/post) or raw bodies (raw_get) -- one response shape, no
Octokit/Sawyer
- only ever sends the access token to api.github.com and
raw.githubusercontent.com, rejecting any other absolute URL, so a
user-derived path can never leak a token to an arbitrary host
- backs off on rate limits both reactively (403/429) and proactively
(when
X-RateLimit-Remaining hits 0), honouring Retry-After /
X-RateLimit-Reset,
via a shared Redis flag (GithubRateLimit) keyed per token so each
token's
budget and the shared unauthenticated/IP budget back off independently
- short-circuits while backing off without ever sleeping, so onebox
rendering
and post baking degrade to a plain link instead of blocking a request
- caches ETags and sends If-None-Match, so unchanged resources return
304s
that do not count against the rate limit
Every caller was moved onto it:
- the 6 core GitHub onebox engines, via a slimmed
Onebox::Mixins::GithubApi
adapter that keeps their public methods and translates client errors
back
to the OpenURI::HTTPError vocabulary they already rescue (engines
unchanged)
- the github_blob raw.githubusercontent.com fetch
- the discourse-github plugin (badges, linkback, permalinks, token
validator),
which no longer uses the octokit and sawyer gems (they stay in the
Gemfile for
the discourse-code-review official plugin, which still depends on them)
- the discourse-ai bot's GitHub tools (search code, diff, file content,
search files)
Also adds a GithubOneboxBackoff admin problem check that surfaces while
one of
the onebox token identities is backing off -- scoped to the tokens
resolved by
Onebox::GithubAccess (each configured github_onebox_access_tokens entry
plus the
unauthenticated client) so a backoff on the AI bot or linkback token is
not
misattributed to onebox. Its message points admins at the relevant
setting with
the {{setting:...}} link marker, which problem-check messages now expand
too.
Onebox token resolution is centralised in Onebox::GithubAccess, and the
onebox
cache TTL for transient GitHub failures is shortened so they recover
quickly.
GitHub OAuth login, theme git-clone, the inbound webhook, and the
Oneboxer
FinalDestination URL-resolution special-cases for github.com are
intentionally
out of scope -- they are different concerns, not the rate-limited data
API.
56 lines
1.9 KiB
Ruby
Vendored
56 lines
1.9 KiB
Ruby
Vendored
# frozen_string_literal: true
|
|
|
|
# name: discourse-github
|
|
# about: Allows staff to assign badges to users based on GitHub contributions, and allows users to create Github Linkbacks and Permalinks
|
|
# meta_topic_id: 99895
|
|
# version: 0.3
|
|
# authors: Robin Ward, Sam Saffron
|
|
# url: https://github.com/discourse/discourse/tree/main/plugins/discourse-github
|
|
|
|
# Site setting validators must be loaded before initialize
|
|
require_relative "app/lib/github_badges_repo_setting_validator"
|
|
require_relative "app/lib/github_linkback_access_token_setting_validator"
|
|
|
|
enabled_site_setting :enable_discourse_github_plugin
|
|
|
|
register_svg_icon "fab-github"
|
|
register_asset "stylesheets/common/github-pr-status.scss"
|
|
|
|
after_initialize do
|
|
require_relative "app/controllers/discourse_github/webhooks_controller"
|
|
require_relative "app/jobs/regular/rebake_github_pr_posts"
|
|
|
|
Discourse::Application.routes.append do
|
|
post "/discourse-github/webhooks/github" => "discourse_github/webhooks#github"
|
|
end
|
|
|
|
%w[
|
|
../app/models/github_commit.rb
|
|
../app/models/github_repo.rb
|
|
../app/lib/github_linkback.rb
|
|
../app/lib/github_badges.rb
|
|
../app/lib/github_permalinks.rb
|
|
../app/lib/commits_populator.rb
|
|
../app/jobs/regular/create_github_linkback.rb
|
|
../app/jobs/scheduled/grant_github_badges.rb
|
|
../app/jobs/regular/replace_github_non_permalinks.rb
|
|
].each { |path| require File.expand_path(path, __FILE__) }
|
|
|
|
on(:post_created) do |post|
|
|
if SiteSetting.github_linkback_enabled? && SiteSetting.enable_discourse_github_plugin?
|
|
GithubLinkback.new(post).enqueue
|
|
end
|
|
end
|
|
|
|
on(:post_edited) do |post|
|
|
if SiteSetting.github_linkback_enabled? && SiteSetting.enable_discourse_github_plugin?
|
|
GithubLinkback.new(post).enqueue
|
|
end
|
|
end
|
|
|
|
on(:before_post_process_cooked) do |doc, post|
|
|
if SiteSetting.github_permalinks_enabled? && SiteSetting.enable_discourse_github_plugin?
|
|
GithubPermalinks.replace_github_non_permalinks(post)
|
|
end
|
|
end
|
|
end
|
