mirror of
https://github.com/discourse/discourse.git
synced 2026-08-07 13:19:19 +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.
73 lines
2.1 KiB
Ruby
Vendored
73 lines
2.1 KiB
Ruby
Vendored
# frozen_string_literal: true
|
|
|
|
require_relative "../mixins/github_body"
|
|
require_relative "../mixins/github_api"
|
|
|
|
module Onebox
|
|
module Engine
|
|
class GithubRepoOnebox
|
|
include Engine
|
|
include LayoutSupport
|
|
include JSON
|
|
include Onebox::Mixins::GithubApi
|
|
|
|
matches_domain("github.com", "www.github.com")
|
|
always_https
|
|
|
|
def self.matches_path(path)
|
|
path.match?(%r{^/[^/]+/[^/]+/?$})
|
|
end
|
|
|
|
def url
|
|
"https://api.github.com/repos/#{match[:org]}/#{match[:repository]}"
|
|
end
|
|
|
|
def inline_data
|
|
return unless github_token?
|
|
|
|
result = raw
|
|
title = "GitHub - #{result["full_name"]}"
|
|
title += " - #{Onebox::Helpers.truncate(result["description"])}" if result[
|
|
"description"
|
|
].present?
|
|
{ title: title }
|
|
rescue StandardError => e
|
|
Rails.logger.warn("Inline GitHub repo onebox error for #{@url}: #{e.message}")
|
|
nil
|
|
end
|
|
|
|
private
|
|
|
|
def match
|
|
@match ||= @url.match(%r{github\.com/(?<org>[^/]+)/(?<repository>[^/]+)})
|
|
end
|
|
|
|
def data
|
|
result = raw.clone
|
|
result["link"] = link
|
|
description = result["description"]
|
|
title = "GitHub - #{result["full_name"]}"
|
|
|
|
if description.blank?
|
|
description = I18n.t("onebox.github.no_description", repo: result["full_name"])
|
|
else
|
|
title += ": #{Onebox::Helpers.truncate(description)}"
|
|
end
|
|
|
|
result["description"] = description
|
|
result["title"] = title
|
|
result["is_private"] = result["private"]
|
|
|
|
# The SecureRandom part of this doesn't matter, it's just used for caching the
|
|
# repo thumbnail which is generated on the fly by GitHub. There isn't detail
|
|
# in https://github.blog/2021-06-22-framework-building-open-graph-images/,
|
|
# but this SO answer https://stackoverflow.com/a/69043743 suggests this is
|
|
# how it works and testing confirms it.
|
|
result[
|
|
"thumbnail"
|
|
] = "https://opengraph.githubassets.com/#{SecureRandom.hex}/#{match[:org]}/#{match[:repository]}"
|
|
result
|
|
end
|
|
end
|
|
end
|
|
end
|
